QUERY CONNECTION (Query a cloud connection)

Use this command to display information about one or more connections from an IBM Spectrum® Protect server to cloud providers.

Privilege class

Any administrator can issue this command.

Syntax

Parameters

connection_name

Specifies the connection to query. This parameter is optional. If you do not specify a value for this parameter, all connections are displayed.

Format

Specifies the level of detail of the query results. This parameter is optional. Specify one of the following values:

Standard: Specifies that a summary of the information is displayed. This value is the default.
Detailed: Specifies that detailed information is displayed.

Example: Display detailed information about a connection

Display details for a connection that is named CLDCONN1. See Field descriptions for field descriptions.

Tip: In the examples of detailed output, some fields are blank because the item does not apply in the specified cloud environment.

query connection cldconn1 format=detailed

      Connection Name: CLDCONN1
           Cloud Type: S3
            Cloud URL: HTTP://123.234.123.234
          Bucket Name: cloudbucket
       Cloud Identity: admin:admin
      Key Source File: 
          Description:

Field descriptions

Connection Name: The name of the connection.
Cloud Type: The type of cloud environment.
Cloud URL: The URL of the cloud environment connection.
Bucket Name: The name of the Amazon Web Services Simple Storage Service (S3) or Google bucket or an IBM® Cloud Object Storage vault. The BUCKETNAME parameter is valid only for cloud types of S3 or Google.
Cloud Identity: The user ID for the cloud that is specified in the CLOUDURL parameter. The IDENTITY parameter is valid only for cloud types of S3.
Key Source File: The location where the Google Cloud Storage service account key was uploaded.
Tip: To help ensure that you can restore the database and recover your storage environment after a disaster, save the key file and the path to the key file in a separate and secure location. Avoid moving the key file because the file might be required later to reestablish the connection between IBM Spectrum Protect and the cloud object storage.
Description: A description of the connection.

Table 1. Commands related to QUERY 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.
UPDATE CONNECTION	Updates a connection to a cloud provider.