UPDATE CONNECTION (Update a cloud connection)

Use this command to update a connection from the IBM Spectrum® Protect server to a cloud provider.

Privilege class

To issue this command, you must have system privilege or unrestricted storage privilege.

Syntax

Read syntax diagramSkip visual syntax diagram UPDate CONNection connection_name CLOUDUrl=cloud_urlBUCKETName=bucket_name1IDentity=cloud_identity2PAssword=passwordDESCription=description
Notes:
  • 1 For cloud types of Azure, do not specify the BUCKETNAME parameter.
  • 2 For cloud types of Azure, do not specify the IDENTITY parameter.

Parameters

connection_name (Required)
Specifies the name of the connection to the cloud provider. This parameter is required.
CLOUDUrl
Specifies the URL of the cloud environment where you are configuring the associated storage pool. Based on your cloud provider, you can use a region endpoint URL, an Accesser® IP address, a public authentication endpoint, or a similar value for this parameter. Be sure to include the protocol, such as https:// or http://, at the beginning of the URL. The maximum length of the web address is 870 characters. The CLOUDURL parameter is not validated until the first backup begins.
.
Tip: To optimize performance, use multiple Accessers. To use more than one IBM® Cloud Object Storage Accesser, list the Accesser IP addresses separated by a vertical bar (|), with no spaces, enclosed in quotation marks, as in the following example:
cloudurl="accesser_ur1|accesser_url2|accesser_url3"
BUCKETName
Specifies the name of an Amazon Web Services (AWS) bucket or IBM Cloud Object Storage vault to use with this connection. This parameter is optional and is valid only for cloud types of S3. Follow the naming restrictions for your cloud provider. Review the permissions for the bucket or vault and ensure that the credentials for the associated storage pool have permissions to read, write, list, and delete objects in this bucket or vault.
IDentity
Specifies the user ID for the cloud that is specified in the CLOUDURL parameter. The IDENTITY parameter is valid only for cloud types of S3. Based on your cloud provider, you can use an access key ID, a user name, a tenant name and user name, or a similar value for this parameter, which is optional. The maximum length of the user ID is 255 characters.
PAssword
Specifies the password for the cloud that is specified in the CLOUDURL parameter. This parameter is optional. Based on your cloud provider, you can use a shared access signature (SAS) token, secret access key, an API key, a password, or a similar value. The maximum length of the password is 256 characters. The IDENTITY and PASSWORD parameters are not validated until the first backup operation begins.
DESCription
Specifies a description of the connection. This parameter is optional. The maximum length of the description is 255 characters. Enclose the description in quotation marks if it contains blank characters. To remove an existing description, specify a null string ("").

Example: Update a cloud connection to specify a new password

Update the CLDCONN1 cloud connection and specify a new password that is named ClOuD!w0rd.
update connection cldconn1 password=ClOuD!w0rd
Table 1. Commands related to UPDATE CONNECTION
Command Description
DEFINE CONNECTION Defines a connection to back up the server database to a cloud provider.
DELETE CONNECTION Deletes a connection to a cloud provider.
QUERY CONNECTION Displays information about connections to a cloud provider.