VALIDATE CLOUD (Validate cloud credentials)

Before you define a storage pool, use this command to ensure that the credentials for a cloud-container storage pool are valid and that the necessary permissions are granted to the user.

Privilege class

Any administrator can issue this command.

Syntax

Notes:

¹ If you specify CLOUDTYPE=AZURE, do not specify the IDENTITY parameter.
² The BUCKETNAME parameter is valid only if you specify CLOUDTYPE=S3.

Parameters

CLOUDType

Specifies the type of cloud environment where you are configuring the storage pool.

You can specify one of the following values:

AZure: Specifies that the storage pool uses a Microsoft Azure cloud computing system.
S3: Specifies that the storage pool uses a cloud computing system with the Simple Storage Service (S3) protocol, such as IBM® Cloud Object Storage or Amazon Web Services (AWS) S3.
IBMCloudswift: Specifies that the storage pool uses an IBM Cloud cloud computing system with an OpenStack Swift cloud computing system.
SWift: Specifies that the storage pool uses an OpenStack Swift cloud computing system. This value also specifies that the storage pool uses Version 2 of the protocol for authentication to the cloud. The URL of the cloud usually contains the version number of the protocol that it is using.
V1Swift: Specifies that the storage pool uses an OpenStack Swift cloud computing system. This value also specifies that the storage pool uses Version 1 of the protocol for authentication to the cloud. The URL of the cloud usually contains the version number of the protocol that it is using.

This parameter is optional. If you do not specify the parameter, the default value, SWIFT, is used.

CLOUDUrl (Required)

Specifies the URL of the cloud environment where you configure the storage pool. Based on your cloud provider, you can use a blob service endpoint, region endpoint URL, an accesser IP address, a public authentication endpoint, or a similar value for this parameter. Ensure that you 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 validated when the first backup begins.

IDentity (Required)

Specifies the user ID for the cloud. This parameter is required for all supported cloud computing systems except Azure. If you specify CLOUDTYPE=AZURE, do not specify the IDENTITY parameter. 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. The maximum length of the user ID is 255 characters.

PAssword (Required)

Specifies the password for the cloud. 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 for this parameter. This parameter is required. The maximum length of the password is 255 characters.

BUCKETName

Specifies the name for an AWS S3 bucket or a IBM Cloud Object Storage vault to use with this storage pool, instead of using the default bucket name or vault name. This parameter is optional, and is valid only if you specify CLOUDTYPE=S3. If a bucket or vault exists with the name that you specify, that bucket or vault is tested to ensure that the proper permissions are set. If the bucket or vault does not exist, the parameter verifies only that a bucket or vault with that name does not exist. Follow the naming restrictions for your cloud provider when you specify this parameter. Review the permissions for the bucket or vault and make sure that the credentials have permission to read, write, list, and delete objects in this bucket or vault.

Tip: If you do not specify the BUCKETNAME parameter, the Replication Globally Unique ID is used as the default bucket name. The default is

ibmsp guid

where guid is the REPLICATION GLOBALLY UNIQUE ID value, minus the periods, in the output of the QUERY REPLSERVER command. For example, if the Replication Globally Unique ID is 52.82.39.20.64.d0.11.e6.9d.77.0a.00.27.00.00.00, the default bucket name is ibmsp.5282392064d011e69d770a0027000000.

Example: Verify the credentials of an S3 cloud-container storage pool

Validate the credentials of the cloud-container storage pool.

validate cloud 
cloudtype=s3 cloudurl=http://123.234.123.234:5000/v2.0
password=protect8991 bucketname=ibmsp.5282392064d011e69d770a0027000000

Related commands

Table 1. Commands related to VALIDATE CLOUD
Command	Description
DEFINE STGPOOL (cloud-container)	Define a cloud-container storage pool.
QUERY REPLSERVER	Displays information about replicating servers.
UPDATE STGPOOL (cloud-container)	Update a cloud-container storage pool.