test veritas logo


vxcloud(1M)

NAME

vxcloud - manage cloud volume operations

SYNOPSIS

vxcloud -g diskgroup addcloud cloud_vol host=host_address bucket=bucket_name access_key=access_key type={S3|BLOB|GOOGLE} [endpoint=account_name] [secret_key=secret_key] [https={true|false}] [sig_version={v4|v2}] [google_config=config.json_file_path]

vxcloud -g diskgroup rmcloud cloud_vol

vxcloud [-g diskgroup] listcloud

vxcloud addtarget name=target_name host=host_address bucket=bucket_name access_key=access_key type={S3|BLOB} [endpoint=account_name] [secret_key=secret_key] [https={true|false}] [sig_version={v4|v2}]

vxcloud edittarget target_name [host=host_address] [bucket=bucket_name] [access_key=access_key] [secret_key=secret_key] [https={true|false}] [sig_version={v4|v2}] [endpoint=account_name]

vxcloud rmtarget target_name

vxcloud listtargets

vxcloud -g diskgroup connect target_name volume obj_size

vxcloud -g diskgroup disconnect volume

vxcloud [-g diskgroup] list

vxcloud help

DESCRIPTION

The vxcloud utility performs administrative operations on cloud volumes. Operations include
o creating, listing, editing and deleting cloud targets
o connecting cloud volumes to the target
o listing the cloud-volume connections
 

KEYWORDS

addcloud Associates the cloud attributes with the given cloud volume where:
o host is the web or local address of the object storage node.
o bucket is a container for objects stored in the object store. The bucket must be created in the object store before running the command.
o type is the type of cloud storage. For ex, S3 or BLOB or GOOGLE.
o access_key is the access key obtained from the S3 or BLOB cloud vendor.
o secret_key is the secret key obtained from the S3 cloud vendor.
o endpoint is the account name obtained from the BLOB cloud vendor.
o https must be set to true or false. If you use HTTPS (recommended), specify true. The default value is true. Note that you do NOT need an SSL certificate to use https.
o sig_version can be set to signature version v2 or v4. The default value is v4.
o google_config is the path of config.json file. It is required for GOOGLE type only. config.json is a file that contains the private key, project_id, and client_email values for the Google service account. This file can be downloaded in the JSON format from the Service Accounts tab of the GCP Console.
 
Note: S3 provider that authenticate requests with signature version 2 or signature version 4 is supported.
rmcloud Disassociates cloud attribute information from a given cloud volume.
listcloud Lists cloud volumes and their corresponding cloud attribute information.
addtarget Creates a cloud target profile with the specified target name where:
o host is the web or local address of the object storage node.
o bucket is a container for objects stored in the object store. The bucket must be created in the object store before running the command.
o type is the type of cloud storage. For ex, S3 or BLOB or GOOGLE.
o access_key is the access key obtained from the S3 or BLOB cloud vendor.
o secret_key is the secret key obtained from the S3 cloud vendor.
o endpoint is the account name obtained from the BLOB cloud vendor.
o https must be set to true or false. If you use HTTPS (recommended), specify true. The default value is true. Note that you do NOT need an SSL certificate to use https.
o sig_version can be set to signature version v2 or v4. The default value is v4.
 
Note: S3 provider that authenticate requests with signature version 2 or signature version 4 is supported.
edittarget Edits a cloud target profile with the specified target name.
Note: The change is effective only after the vxvm-vxcloud service restarts.
rmtarget Removes a cloud target profile with the specified target name.
Note: The change is effective only after the vxvm-vxcloud service restarts.
listtargets
  Lists the cloud target profiles.
connect Connects a cloud volume with the specified cloud target name. After the volume is connected with the target, all I/Os on the cloud volume are redirected to the specified target. Multiple cloud volumes can be connected to the same cloud target. Use this command only with addtarget.
o obj_size is in bytes and should be equal to block size of file system. It should be less than 1048576 bytes(1M).
 
disconnect Disconnects a cloud volume from the specified cloud target which is created with addtarget.
Note: The change is effective only after the vxvm-vxcloud service restarts.
Note: In cluster environments, run the commands (addtarget, rmtarget, edittarget, connect, disconnect) manually on all the nodes in the cluster. It is recommended to use (addcloud, rmcloud) commands in the cluster environment, as these commands need to be run from single node in the cluster.
list
  Displays the cloud status of the volumes along with the cloud target details.

EXAMPLES

To associate cloud volume with AWS S3 bucket:

vxcloud -g testdg addcloud cloudvol host=s3.amazonaws.com bucket=images access_key=AKYIISDKFH secret_key=F/FvKpxvXOXd4+bPnz type=S3 https=true

To list the cloud volume and its cloud attributes:


vxcloud -g testdg listcloud VOLUME CLOUD TYPE HOST BUCKET HTTPS OBJECT TYPE cloudvol S3 s3.amazonaws.com images true VxFS

To disassociate AWS S3 bucket attributes from the cloud volume:


vxcloud -g testdg rmcloud cloudvol


VxVM 7.3.1 vxcloud(1M)