Retrieve Key operation

Run this operation to retrieve the client private key, client key, cluster, and manager keys from a IBM Storage Scale configuration.

Procedure

Expand the Manage Keys section of the GPFS_Manager operations.
Expand the Retrieve Key node.
In the Key Type field, select the type of key to retrieve from the available list. For more information about IBM Storage Scale deployment keys, see the Related links.
Click Submit.
Click Confirm when asked to validate your request.

Results

The results of this operation depend on the type of key you are retrieving:

Retrieving a client private key:
When you run Retrieve Key and select the Client private key option, the result is a string that contains the IP address of the Primary Manager virtual machine and the client private key.

The client private key is used when you deploy an IBM® shared service for IBM Storage Scale instance and is the key that is used by the IBM Storage Scale Clients to communicate with the IBM Storage Scale Server deployment. Any IBM Storage Scale Client that is deployed in the same environment profile as this IBM shared service for IBM Storage Scale instance retrieves the IBM Storage Scale Manager IP address and private key information from the shared service, and uses that information to communicate with the IBM Storage Scale Manager virtual machine when it tries to authenticate with the IBM Storage Scale cluster.

This string can also be used when you deploy a new IBM Storage Scale client instance, if the instance specifies the client private key at deployment time. In this case, the information is not retrieved through a IBM Storage Scale shared service instance.

When you run this operation to retrieve the Client key for this configuration, a new entry is displayed under the Operation Execution Results list, with the name Retrieve Key. When the operation completes, the status of the operation changes from Active to Done, and the Return Value column displays the result of the operation, including the text string and client private key that is displayed as a link, similar to the following example: GPFS-Manager.11402320054789.GPFS_Manager: Client key successfully collected. : client private key. Click the client private key link to obtain a text string with the client private key information. Pass this string to an IBM shared service for IBM Storage Scale instance when it is deployed.

For more information about the IBM Storage Scale deployment key definition, see the Related reference section.
Retrieving a client key:
The client .tar file contains a private and public key pair. The public key is an SSH key that is installed on the IBM Storage Scale Manager virtual machine. The client key is used to retrieve both client keys so you can install them on another IBM Storage Scale configuration or to verify what is the content of the key used for the client to manager communication.

For more information about the IBM Storage Scale deployment key definition, see the Related reference section.
Retrieving a cluster key:
When you run this operation to retrieve the Cluster key for this configuration, a new entry is displayed under the Operation Execution Results list, with the name Retrieve Key. When completed, the status of the operation changes from Active to Done, and the Return Value column displays the result of the operation, including the name of a compressed key file, which is displayed as a link, similar to the following example:
```
GPFS-Manager.11402320054789.GPFS_Manager: cluster_key.tar.gz
```
Click the cluster_key.tar.gz link to download both the public and private keys. You can pass this file name to an Install Key operation (select the Cluster option) to install this key on a IBM Storage Scale Server deployment.

For more information about the IBM Storage Scale deployment key definition, see the Related reference section.
Retrieving a manager key:
When you run this operation, a new entry is displayed under the Operation Execution Results list, with the name Retrieve Key. When completed, the status of the operation changes from Active to Done, and the Return Value column displays the result of the operation, including the name of a compressed key file, which is displayed as a link, similar to the following example:
```
GPFS-Manager.11402320054789.GPFS_Manager: manager_key.tar.gz
```
Click the manager_key.tar.gz link to download both the public and private keys. You can pass this file name to an Install Key operation (select the Manager option) to install this key on a IBM Storage Scale Server deployment.

For more information about the IBM Storage Scale deployment key definition, see the Related reference section.