Configuring the Open Snap Store Manager instance

Edit online

On the IBM Storage® Protect server, use a wizard to configure the Open Snap Store Manager (OSSM) instance. The wizard guides you to configure the OSSM component by using either the graphical user interface (GUI) or the command-line interface (CLI).

Before you begin

Ensure that the following prerequisites are met:

  • The OSSM component must be installed on the same system where IBM Storage Protect server is installed.
  • Ensure that the OSSM server and the IBM Storage Protect server are on the same level.
  • To configure the OSSM instance on the IBM Storage Protect server, you must have root user privileges.
  • The IBM Storage Protect server must be running.
Important: On Linux® systems, to run the OSSM central and VADP proxy services, you cannot be a root user or part of root user group.

Procedure

To configure the OSSM instance, complete the following steps on the IBM Storage Protect server.

  1. As a root user, on the server where IBM Storage Protect and the OSSM component are installed, change to the following directory:
    <installation_directory>/ossm/bin
    where <installation_directory> represents the directory where OSSM is installed.
    For example, run the following command:
    cd /opt/tivoli/tsm/ossm/bin
  2. To start the OSSM instance configuration wizard, run the following command:
    ./ossmcfg.bin

    This opens the Open Snap Store Manager (OSSM) Instance Configuration Wizard screen.

    Important: By default, the OSSM instance configuration wizard runs in the GUI mode. Alternatively, to run the OSSM instance configuration wizard specifically in CLI or GUI mode, issue one of the following commands:
    • To run the OSSM instance configuration wizard in console or CLI mode, issue the following command:
      ./ossmcfg.bin -i console
    • To run the OSSM instance configuration wizard in GUI mode, issue the following command:
      ./ossmcfg.bin -i gui
  3. Select a language of your preference from the drop-down list, and click OK.
  4. On the OSSM Database Configuration screen, you can click the provided links for more information. Click Next to continue.
  5. On the OSSM Configuration Modes screen, select one of the following configuration modes that you want to complete:
    Important: If you are configuring the OSSM instance for the first time, you must first select the Create a new OSSM instance option and follow the steps to create the OSSM instance.

Create a new OSSM instance

Edit online

Use this option to create a new OSSM instance on the primary OSSM server.

About this task

With this option you can complete the following actions:
  • Create and start the OSSM service
  • Update the IBM Storage Protect server instance user with the OSSM server
  • Create and display the newly created registration key
  • If required, update the firewall rule settings

Complete the following steps to create a new OSSM instance:

Procedure

  1. On the Open Snap Store Manager Instance Configuration screen, complete the following fields, and then click Next:
    IBM Storage Protect server instance user
    Select the IBM Storage Protect instance user ID from the drop-down list. The listed instance user IDs in the drop-down list are the same as the IDs defined with IBM Storage Protect server instance.
    OSSM listening port
    Specify the port number that is used by the OSSM server to communicate with the IBM Storage Protect Plus server. If the firewalld services are active on the system where OSSM is installed, the port is added to the firewall rules. The default port number is 3337.

    Depending on the firewall service that you are using, you might need to open the ports manually. For more information, see Prerequisites for creating a VADP proxy.

  2. On the IBM Storage Protect Server Connection screen, complete the following fields, and then click Next:
    Server address
    Provide the fully qualified domain name (FQDN) of the IBM Storage Protect server.
    Server administrative ID
    Provide any server administrative ID with system level authority. The ID is not exclusive for OSSM. The control agent temporarily uses this ID to register its own administrative ID.
    Server administrator password
    Provide the IBM Storage Protect server administrator password.
    Important: If the IBM Storage Protect server administrative ID uses the multifactor authentication (MFA), you must provide the MFA password to update the password.
    Port
    Specify the IBM Storage Protect server instance port number. The port must use the Secure Socket Layer (SSL) protocol.
  3. On the Preview screen, review the specified settings, and then click Configure.

    Installation begins and the Installing OSSM Instance Configuration Wizard screen takes few minutes to complete the installation.

  4. On the Storage Protect Plus Registration Key screen, copy the OSSM registration key and save to a secure location. Click Next to continue.
    Important: The key is required to register the OSSM instance with the IBM Storage Protect Plus server.
  5. On the Successful Configuration of OSSM screen, review the OSSM service that is created and started on the IBM Storage Protect server, and then click Done to close the wizard.

What to do next

Navigate to the link provided at the end of the configuration wizard for the next steps to connect with the IBM Storage Protect Plus server. Before you perform the next steps, ensure that the prerequisites are met to create a VADP proxy. For instructions, see Prerequisites for creating a VADP proxy.

Synchronize the IBM Storage Protect server administrator

Edit online

Use this option to synchronize the IBM Storage Protect server administrator password with the OSSM server.

About this task

Synchronize the administrator password in the following situations:
  • When you restore the IBM Storage Protect server database to an earlier point in time, the secret store password that is associated with the OSSM control agent does not match with the IBM Storage Protect server credentials.
  • If the IBM-OSSM-ADMIN administrator ID is locked or its password changed, or another situation has otherwise blocked OSSM from logging in as IBM-OSSM-ADMIN.
Important: The OSSM service must be stopped before you perform this update.

For instructions about stopping the OSSM service, see Starting and stopping the OSSM service.

Procedure

Complete the following steps to synchronize the IBM Storage Protect server administrator password with the OSSM server:
  1. On the Synchronize IBM Storage Protect server administrator screen, complete the following fields, and then click Next:
    IBM Storage Protect server instance user
    Select the IBM Storage Protect instance user ID from the drop-down list. The listed instance user IDs in the drop-down list are the same as the IDs defined with IBM Storage Protect server instance.
    Server administrative ID
    Provide any server administrative ID with system level authority. The ID is not exclusive for OSSM. This ID will be used to reset the password for the IBM-OSSM-ADMIN that was created during configuration.
    Server administrator password
    Provide the IBM Storage Protect server administrator password.
    Important: If the IBM Storage Protect server administrative ID uses the multifactor authentication (MFA), you must provide the MFA password to update the password.
  2. On the Preview screen, review the specified settings, and then click Configure.

Generate a new registration key

Edit online

Complete the following steps to create a new OSSM registration key for a specific IBM Storage Protect server instance.

Before you begin

Important: The OSSM service must be running.

For instructions to determine whether the service is running, see Starting and stopping the OSSM service.

Procedure

  1. On the Generate a New Registration Key screen, complete the following fields, and then click Next:
    IBM Storage Protect server instance user
    Select the IBM Storage Protect instance user ID from the drop-down list. The listed instance user IDs in the drop-down list are the same as the IDs defined with IBM Storage Protect server instance.
    IBM Storage Protect server instance user password
    Provide the IBM Storage Protect server instance user password.
  2. On the Preview screen, review the specified settings, and then click Configure.
  3. On the Storage Protect Plus Registration Key screen, copy the OSSM registration key and save to a secure location. Click Next to continue.
    Important: The key is required to register the OSSM instance with the IBM Storage Protect Plus server.
  4. On the Successfully Generated Registration Key screen, read the information for additional actions that are required to perform on Storage Protect Plus server, and then click Done to close the wizard.

List API Keys

Edit online

Use this option to list all API keys for a specific IBM Storage Protect server instance and to verify that the keys have valid identifiers.

Before you begin

Important: The OSSM service must be running.

For instructions to determine whether the service is running, see Starting and stopping the OSSM service.

Tip: If the OSSM instance configuration wizard is running in the console mode, and you plan to Revoke an API key, copy the appropriate key here.

Procedure

  1. On the List API Keys screen, complete the following fields, and then click Next:
    IBM Storage Protect server instance user
    Select the IBM Storage Protect instance user ID from the drop-down list. The listed instance user IDs in the drop-down list are the same as the IDs defined with IBM Storage Protect server instance.
    IBM Storage Protect server instance user password
    Provide the IBM Storage Protect server instance user password.
  2. On the Preview screen, review the specified settings, and then click Configure.
  3. On the Successfully Listed API Keys screen, verify the API keys, and then click Done to close the wizard.

Revoke an API Key

Edit online

If the key is not recognized, becomes inactive, lost, or compromised, use this options to revoke an API key for the specific IBM Storage Protect server instance.

Before you begin

Important:
  • If the OSSM instance configuration wizard is running in the console mode, you must specify the exact key that you want to revoke. If necessary, run the wizard and choose the List API Keys option to discover the appropriate key, then return to the Revoke API Key option.
  • The OSSM service must be running.

    For instructions to determine whether the service is running, see Starting and stopping the OSSM service.

Procedure

  1. On the Revoke API Key screen, complete the following fields, and then click Next:
    IBM Storage Protect server instance user
    Select the IBM Storage Protect instance user ID from the drop-down list. The listed instance user IDs in the drop-down list are the same as the IDs defined with IBM Storage Protect server instance.
    IBM Storage Protect server instance user password
    Provide the IBM Storage Protect server instance user password, and then click Generate List of Existing Keys.
    Important: If the registration keys are not generated, ensure that the entered password is correct. For more information on the output from the commands, find the details in the /var/tivoli/tsm/ossmcfg.trc file.
    Registration Keys
    Select the key to revoke from the drop-down list.
  2. On the Preview screen, review the specified settings, and then click Configure.
  3. On the Successfully Revoked API Key screen, verify the revoked key, and then click Done to close the wizard.