chcloudaccountazure

Use the chcloudaccountazure command to modify the parameters or mode of an existing cloud account that uses Microsoft Azure cloud storage.

Syntax

Read syntax diagramSkip visual syntax diagram chcloudaccountazure -namenew_name-mode importnormal-importsystem import_system_id-clustercluster_id_or_name-storageaccountnameazure_storage_account_name-storageaccountkeyazure_storage_account_access_key-upbandwidthmbits upbandwidth_limit_in_mb-downbandwidthmbits downbandwidth_limit_in_mb-resetusagehistory-certificatepath_to_certificate -nocertificate-refresh-ignorefailurescloud_account_idcloud_account_name

Parameters

-name new_name
(Optional) Specifies the new or modified cloud account name.
Note: Before you change the name of the storage account, make a copy of existing data that uses the Azure specific method in the target storage account.
-mode import | normal
(Optional) Specifies the new or modified cloud account mode. The values are import or normal.
Note:
  • The -mode parameter can only be changed if the account is not used by any system volumes.
  • To change the mode, the account must be online and the system must be able to communicate with the cloud.
-importsystem import_system_id
(Optional) Specifies that the system's data be imported.
Note: You must first specify -mode import.
-cluster cluster_id_or_name
(Optional) Specifies the name or ID of the Microsoft Azure cluster.
-storageaccountname azure_storage_account_name
(Optional) Specifies the name of the Microsoft Azure storage account that the system uses to access cloud storage. The value must be 3 - 24 characters long and can contain lowercase letters and numbers only. The storage account name is the first part (public) of the Microsoft Azure storage credential system, which provides a unique namespace in Microsoft Azure for your data objects. Every object that is stored in Microsoft Azure storage has an address that includes your unique storage account name.
-storageaccountkey azure_storage_account_key
(Optional) Specifies the account access key that the system uses to access the cloud storage. The value must be 88 characters long, base64-encoded, and can contain uppercase letters, lowercase letters, numbers, or slashes only. The storage account key is the second part (secret) of the Microsoft Azure storage credential system that comes with two 512-bit storage account access keys for that storage account.
-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.
-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.
-resetusagehistory
(Optional) Specifies to reset the usage history. This can reset the usage history to zero including the current day usage.
-certificate path_to_certificate
(Optional) Specifies the file path to an SSL CA certificate for Microsoft Azure storage. This certificate must be in base64-encoded PEM format. The value must be 1 - 255 characters long and can contain alphanumeric and special characters (. / - _) only. If periods are used, they must not be placed adjacent to each other or at the start or end of the prefix.
Note: The -certificate parameter is only required if Microsoft Azure storage updates its certificates to be incompatible with the IBM Java 8 CA certificate bundle or if you don't want to use that certificate bundle.
-nocertificate
(Optional) Specifies to stop using the custom SSL certificate to authenticate the cloud storage.
-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.
-ignorefailures
(Optional) Specify changes to the access key even if the specified access key does not work. If invalid credentials are provided with the -ignorefailures parameter then an online account becomes offline. An error in the log describes the authentication failure.

Description

The mklcloudaccountazure command modifies the parameters for the cloud account that uses Microsoft Azure cloud storage.
Note: At least one optional parameter must be specified for the command to be executed successfully.
The following parameters can be set at any time:
  • -name
  • -upbandwidthmbits
  • -downbandwidthmbits
  • -resetusagehistory
This command fails and no changes are made if the supplied credentials do not provide authentication. The Credentials group consists of following parameters:
  • -storageaccountname
  • -storageaccountkey
  • -ignorefailures
  • -certificate or -nocertificate

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.

Setting 0 to upbandwidthmbits and downbandwidthmbits means that no limit was configured to be consistent with chthrottle CLI.

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.

An invocation example

chcloudaccountazure -name myazure0 cloudaccount0

The resulting output:

No feedback.

An invocation example

chcloudaccountazure -mode import -importsystem 000002009C50D708 0

The resulting output:

No feedback.