chcloudaccountawss3

Use the chcloudaccountawss3 command to modify the cloud account (that uses Amazon S3 storage) parameters or mode.

Syntax

Read syntax diagramSkip visual syntax diagram chcloudaccountawss3 -namename-accesskeyidaws_access_key_id-secretaccesskeyaws_secret_access_key-ignorefailures-mode importnormal-importsystem import_system_id-certificatepath_to_certificate-nocertificate -refresh -upbandwidthmbits upbandwidth_limit_in_mb-downbandwidthmbits downbandwidth_limit_in_mb-resetusagehistorycloud_account_idcloud_account_name

Parameters

-name name
(Optional) Specifies the new or modified cloud account name. The value must be an alphanumeric value.
-accesskeyid aws_access_key_id
(Optional) Specifies the value for the public part of the Amazon Web Services (AWS) access key. Use this access key to access cloud storage.
-secretaccesskey aws_secret_access_key
(Optional) Specifies the value for the private part of the Amazon Web Services (AWS) access key. This access key is for the AWS user that the system uses to access cloud storage.
-ignorefailures
(Optional) Changes the access key whether the new access key works.
-mode import | normal
(Optional) Specifies the new or modified cloud account mode. The values are import or normal.
-importsystem import_system_id
(Optional) Specifies that the system's data be imported.
Note: You must specify -mode import first.
-certificate path_to_certificate
(Optional) Specifies the path for the SSL certificate to use when you authenticate to the new or modified cloud account storage. The value must be an alphanumeric string of 1 - 255 characters (in base64-encoded PEM format).
-nocertificate
(Optional) Specifies that the custom SSL certificate that was used to authenticate to the new or modified cloud account storage is used to stop the system.
-refresh
(Optional) Specifies a refresh of the system import candidates. If the account is in import mode, this parameter specifies a refresh of the data available for import.
-downbandwidthmbits downbandwidth_limit_in_mb
(Optional) Specifies the download bandwidth limit in megabits per second (Mbps). The value must be a number 1 - 10240.
Note: No download bandwidth limit is set unless you specify this keyword.
-upbandwidthmbits upbandwidth_limit_in_mb
(Optional) Specifies the upload bandwidth limit in megabits per second (Mbps). The value must be a number 1 - 10240.
Note: No upload bandwidth limit is set unless you specify this keyword.
Note: Setting 0 to upbandwidthmbits and downbandwidthmbits means no limit has been configured and is for consistency with chthrottle CLI.
-resetusagehistory
(Optional) Resets the usage history (to 0). Storage consumption that reflects the space that is consumed on the cloud account is cumulative, which means that it remains in the current day row (the 0th row).
cloud_account_id | cloud_account_name
(Required) Specifies the cloud account ID or name to modify. The value for the ID must be a number and the value for the name must be an alphanumeric string.

Description

This command modifies the parameters for the cloud account (created by using mklcloudaccountawss3) that uses Amazon S3 storage.

The -mode parameter, the -refresh parameter, and any of the user credentials parameters groups are mutually exclusive.

This command fails and no changes are made if the supplied credentials do not provide authentication. Credentials include:
  • -accesskeyid
  • -secretaccesskey
  • -certificate or nocertificate

For example, if the network is down then the system cannot confirm that a new secret access key is valid, the command fails. Specify -ignorefailures to overwrite this feature. If you specify invalid credentials but you do specify -ignorefailures, an online account becomes offline and an error is generated in the error log that describes the authentication failure.

The secret access key is sensitive system information and is stored in encrypted form. It is not available in the system dumps and in the audit log it is replaced with six hash ("#") symbols.

If you specify this command against an offline account and these new details enable the account to start working (for example, you enter an expired password) the account becomes online.

You must change the mode if the account is not being used by any system volumes. A mode change requires the account to be online and the system be able to communicate with the cloud server.

Note: You can have a maximum of:
  • One cloud account per system.
  • 1024 volumes with cloud snapshots enabled.
  • 256 cloud snapshots per volume.
  • 512 volume groups.

An invocation example

chcloudaccountawss3 -name myamazon cloudaccount0

The resulting output:

No feedback