st_volume_set_ports
The contents of an archive volume can be accessed using http(s)/ftp(s)/sftp by configuring port numbers for the desired protocols (so that, for instance, the contents can be browsed using an FTP client on the configured ftp_port, subject to the access restrictions imposed by the volume owner and permissions).
This job configures those port numbers which are provided as arguments, and unsets all others; for instance, adding an ftp_port can be undone by calling this job again without the ftp_port parameter.
Mandatory parameters
| Parameter name | Data type | Description |
|---|---|---|
| vid | integer | ID of an existing achive volume |
Optional parameters
| Parameter name | Data type | Description |
|---|---|---|
| vname | string | Name of an existing volume |
| http_port | integer | HTTP port, on which the archive volume should be accessible. |
| https_port | integer | HTTPS port, on which the archive volume should be accessible. |
| ftp_port | integer | FTP port, on which the archive volume should be accessible. |
| ftps_port | integer | FTPS port, on which the archive volume should be accessible. |
| sftp_port | integer | SFTP port, on which the archive volume should be accessible. |
Substitute parameters
The following table describes what parameters can be substituted for another parameter.
| Parameter name | Substitute parameter |
|---|---|
| vid | vname |
| vname | vid |
Allowed users
There are no defined allowed users.
Allowed groups
The following groups are allowed to run this job:
- root
- exaadm
- exadbadm
Examples
The following examples show how to run this job in a Python program using XML-RPC or on the command line using confd_client.
Python using XML-RPC