DEFINE CONNECTION (Define a cloud connection)
Use this command to define a connection to back up the IBM Spectrum® Protect database to a cloud provider. The connection can also be used to restore the database.
Privilege class
To issue this command, you must have system privilege or unrestricted storage privilege.
Syntax
Parameters
- connection_name (Required)
- Specifies the connection to define. This parameter is required. The maximum length of the name is 30 characters.
- CLOUDType
- Specifies the type of cloud environment for your connection. This parameter is optional. If you
do not specify the parameter, the default value, S3, is used.
- AZure
- Specifies that the connection uses a Microsoft Azure cloud computing system.
- S3
- Specifies that the connection uses a cloud computing system with the Simple Storage Service (S3) protocol, such as IBM® Cloud Object Storage or Amazon Web Services (AWS) S3.
- CLOUDUrl (Required)
- Specifies the URL of the cloud environment connection. 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. 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. 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 AWS S3 bucket or an IBM Cloud Object Storage vault to use with this connection. This parameter is required and is valid only if you specify CLOUDTYPE=S3. If you specified CLOUDTYPE=Azure, do not specify the BUCKETNAME parameter. Follow the naming restrictions for your cloud provider when you specify this parameter. Ensure that the credentials for this storage pool include permission to read, write, list, and delete objects in this bucket or vault. If you cannot change or view the permissions, and data is not yet written to this storage pool, use the UPDATE CONNECTION command. In that command, specify the BUCKETNAME parameter to select a bucket or vault in a storage pool that has the required permission.
- IDentity
- Specifies the user ID for the cloud that is specified in the CLOUDURL
parameter. This parameter is required and is valid only if you specify
CLOUDTYPE=S3. If you specified 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. The maximum length of
the user ID is 255 characters.Tip: To specify a tenant name and user name, use the following format:
tenant_name.user_name - PAssword (Required)
- Specifies the password for the cloud that is specified in the CLOUDURL parameter. 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. This parameter is required. 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. The parameter is optional. The maximum length of the description is 255 characters. Enclose the description in quotation marks if it contains blank characters.
Example: Define a connection
Define a cloud connection that is named CLDCONN1.define connection cldconn1 cloudtype=s3
cloudurl=http://123.234.123.234 bucketn=cloudbucket
identity=admin:admin password=protect8991| Command | Description |
|---|---|
| DELETE CONNECTION | Deletes a connection to a cloud provider. |
| QUERY CONNECTION | Displays information about connections to a cloud provider. |
| UPDATE CONNECTION | Updates a connection to a cloud provider. |