object_volume_add

Adds a new volume to EXAStorage pointing to a cloud storage.

Mandatory Parameters

Parameter Name Data Type Description
vol_type string The data volume type. For example, enter S3 for AWS.
name string The name of the new data volume.

Optional Parameters

Parameter Name Data Type Description
bucket string The name of an existing bucket you want to add to the data volume.
region string The encoded geographical region that stores the cloud resources. For example, Europe (Frankfurt) is eu-central-1.
prefix string The prefix of the storage area within the bucket where you want to add the data volume.
owner tuple, list Tuple of the database owner in type integer or (user name, user group name).
end_point string The gateway endpoint tag.
credentials string The type of credentials needed to access the data volume. Valid values are: root, IAM, and MFA.
permissions string The permissions for individual files within the data volume.
shared boolean Sets whether the data volume is shared. Valid values are True and False.
priority string The priority of the volume in terms of process scheduling priority. A higher number specifies a higher priority. For most cases, you can set the priority to a value of 10.
options string The volume options.
labels list A description of the new data volume.

Substitute Parameters

There are no substitute parameters.

Allowed Users

The following users are allowed to run this job:

  • root

Allowed Groups

The following groups are allowed to run this job:

  • root
  • exaadm
  • exastoradm

Examples

The following code snippets show how to use this job using both Python (via XML-RPC) and on the command-line using confd_client.

conn.job_exec('object_volume_add', {'params': {'vol_type': 's3', 'name': 'DataVolume2', 'bucket': 'Bucket1', 'region': 'eu-central-1', 'prefix': 'Europe/France/Nouvelle-Aquitaine/Bordeaux', 'owner': '500:500', 'end_point': 'Name:my-endpoint-01', 'credentials': 'root', 'priority': 10}})
confd_client object_volume_add vol_type: s3 name: DataVolume2 bucket: Bucket1 region: eu-central-1 prefix: Europe/France/Nouvelle-Aquitaine/Bordeaux owner: 500:500 end_point: Name:my-endpoint-01 credentials: root priority: 10