Importing the SOAR Platform license

Before you can start the SOAR Platform, you must import the license that you obtained from IBM Security®.

About this task

To import the license, use an SSH client, such as PuTTY, to log in to the SOAR system.

If you do not have the license, refer to the IBM Security Support page.

To import the license, complete the following.

Procedure

  1. Copy the license file that you received from IBM Security.
  2. Log in to the system with SSH as the user account you created in the previous section. You can use PuTTY or connect from a terminal client as follows.
    ssh <username>@<Platform hostname or IP Address>
    
  3. To import the license, enter the following command:
    sudo license-import -file <License File>
    

    A message, similar to the following message, appears on the screen, indicating successful import:

    Successfully imported license
    Customer name:  <customer>
    Expiration:  Not Defined
    US regulators enabled:  true
    CA regulators enabled:  true
    EU regulators enabled:  true
    APAC regulators enabled:  true
    Security module enabled:  true
    Actions framework enabled: true
    Users:  Not Defined
    To display information about the currently installed license, enter the following command:
    sudo resutil license
    The system displays the following information:
    • Customer name, which is the name of your company.
    • Expiration, which is the expiration date of the license.
    • US regulators enabled, which displays true or false.
    • CA regulators enabled, which displays true or false.
    • EU regulators enabled, which displays true or false.
    • APAC regulators enabled, which displays true or false.
    • Security module enabled, which displays true (default) or false.
    • Actions framework module enabled, which displays true (default) or false.
    • Users, which displays the number of users the license allows.

Results

If you do not have an installed license when you run this command, the system informs you that no license is installed.