chcloudaccountswift

Use the chcloudaccountswift command to modify the cloud account (that uses OpenStack Swift storage) parameters or mode.

Syntax

Read syntax diagramSkip visual syntax diagram chcloudaccountswift -namename -keystone yes -endpointhttps_endpoint_URL-usernameuser_name-password'password'-certificatepath_to_certificate-nocertificate-ignorefailures-mode importnormal-importsystemimport_system_id -refresh -resetusagehistory-downbandwidthmbitsdownbandwidth_limit_in_mb-upbandwidthmbitsupbandwidth_limit_in_mbcloud_account_idcloud_account_name

Parameters

-name name
(Optional) Specifies the new or modified OpenStack name you must use to access cloud account storage. The value must be an alphanumeric value.
-keystone yes | no
(Required) Specifies that keystone authentication is used. Default value is yes.
-endpoint https_endpoint_URL
(Optional) Specifies the URL (that the system uses to access object storage) to change for the cloud account. If OpenStack Keystone authentication is used, the URL specified must be the URL for the Keystone authentication. If Keystone authentication is not used, the URL specified must be the URL for the Swift account. The value must be 8 - 128 characters and must be a valid URL address.
-username user_name
(Optional) Specifies the OpenStack user name that the system must use to access cloud account storage.
-password 'password'
(Optional) Specifies the password value to use to authenticate to cloud storage. For IBM Cloud® accounts, this password is the application programming interface (API) key. The value must be 1 - 64 alphanumeric characters and it must not begin or end with a space. You must enclose the password in single quotation marks.
-certificate path_to_certificate
(Optional) Specifies the path for the SSL certificate to use when you authenticate to 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.
-ignorefailures
(Optional) Specifies that the access key is changed whether or not 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.
-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 mklcloudaccountswift) that uses OpenStack Swift storage.

At least one parameter must be set.

The -mode parameter, the -refresh parameter, and any of the user credentials parameters groups are mutually exclusive. Credentials include:
  • -keystone
  • -endpoint
  • -username
  • -password
  • -certificate or nocertificate

The command fails if the supplied authentication credentials are unsuccessful. For example, if the network is down the system cannot confirm that the secretaccesskey is valid (and the command fails). Specify -ignorefailures to override this feature. If you specify incorrect credentials and the -ignorefailures parameter, an online account becomes offline and an error is generated in the log describing the authentication failure.

The password is treated as sensitive system information. It is stored in an encrypted form and not available in system dumps. In the audit log, it is replaced with six hash ("#") symbols.

If a certificate is supplied and the command succeeds, the certificate file is deleted from the local file system.

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

You can 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

chcloudaccountswift -certificate /tmp/new-cert.pem -ignorefailures myswift

The resulting output:

No feedback