Installing the Smart Hub and Smart Hub Gateway silently

The silent installation involves running the Smart Hub installer from a command line. 

NEW IN 20.02.01 The Smart Hub installer includes an additional optional component called the Smart Hub Gateway. If you want to manage the servers in private networks (in on-premises or cloud environments such as AWS) where inbound connectivity with the RSCD Agents is not available, you must install the Smart Hub Gateway.

Prerequisites

Before installing the Smart Hub and Smart Hub Gateway, ensure the following:

  • The systems requirements as specified in the Supported-platforms are met.
  • The following software applications are installed:
    • (Windows) Microsoft .NET Framework 4.0 or later
    • (Linux) OpenSSL 1.01e or later
  • The Smart Hub and Smart Hub Gateway installer files (SMARTHUB<version>-<os>.zip) are downloaded. These files are located in the Optional components. For more information, see Downloading-the-installation-files.

  • (Windows) A Redis server is installed in your environment. For information about the supported Redis server versions, see Supported-platforms.

    Important

    A Redis server being used for an already running Smart Hub instance cannot be used for other Smart Hub instances. You need to have a separate Redis server instance.

  • To install the Smart Hub and Smart Hub Gateway on a Windows system in a directory containing spaces in its name with the 8dot3 name disabled, do the following:

    1. Log in to the Windows system where you want to install the Smart Hub.
    2. At the command prompt, create short names for the directory with spaces in its name. For example:
      fsutil file setshortname "Smart Hub" Smart~1
      Note: If you encounter a permission-related error, open the command prompt with elevated privileges (For example, "Run as administrator"), and run the specified command again.

To install the Smart Hub and Smart Hub Gateway silently

Do the following:

  1. Log in to the system where you want to install the Smart Hub and Smart Hub Gateway (optional).
    • (Windows) Log in as an administrator.
    • (UNIX and Linux) Log in as a root user.
  2. Extract the Smart Hub and Smart Hub Gateway installer files to a directory of your choice.
    • (Windows) Extract SMARTHUB<version>-WIN64.zip
    • (Linux) Extract SMARTHUB<version>-LIN64.zip
  3. Navigate to the directory that contains the Smart Hub and Smart Hub Gateway installation files.

  4. Run the following command:

    • (Windows) 

      .\setup.bat --silent --port <value> --redis --redis-host <value> --redis-port <value> --redis-password <value>
      --ssk <value> --install-dir <value> --upgrade --install-upgrade-smarthub-gateway
      --smarthub-gateway-port <value> --ca-cert-subject <value> --server-cert-subject <value>

      Example:

      .\setup.bat --silent --port 443 --redis -redis-password admin123 --ssk ABCD1234abcd1234 --install-dir /opt/bmc/smarthub  
      --install-upgrade-smarthub-gateway --smarthub-gateway-port 1080 --ca-cert-subject /C=US/ST=TX/L=Austin/O=Calbro Software/OU=root/CN=Smart Hub CA:%HOST% --server-cert-subject /C=US/ST=TX/L=Houston/O=BMC Software/OU=server/CN=%HOST%

    • (UNIX and Linux)

      ./setup.sh --silent --port <value> --redis --redis-host <value> --redis-port <value> --redis-password <value>
      --ssk <value> --install-dir <value> --upgrade ---install-upgrade-smarthub-gateway --smarthub-gateway-port <value>
      --ca-cert-subject <value> --server-cert-subject <value>

      Example:

      ./setup.sh --silent --port 443 --redis --redis-password root123 --ssk ABCD1234abcd1234 --install-dir /opt/bmc/smarthub
      --install-upgrade-smarthub-gateway --smarthub-gateway-port 1080 --ca_cert_subject /C=US/ST=TX/L=Austin/O=Calbro Software/OU=root/CN=Smart Hub CA:%HOST% --server_cert_subject /C=US/ST=TX/L=Houston/O=BMC Software/OU=server/CN=%HOST%

    where, 
    port (optional) – Indicates the listener port of the Smart Hub. The default is 443.
    redis (required when using the packaged Redis Server) – Indicates that you want to use the packaged Redis Server.
    redis-host (required when using an external Redis Server) – Indicates the name of the Redis Server host. The default is localhost.
    redis-port (required when using an external Redis Server) – Indicates the port where the Redis Server runs. The default is 6379.
    redis-password (required when using the packaged Redis Server) – Indicates the password for the Redis Server host. For an external Redis Server, enter this password if it has been provided for the host. 
    ssk (required) – Indicates the shared secret key that is used for authentication. Ensure that the specified ssk is at least 15 characters long with mixed case alphanumeric characters.
    install-dir (optional) – Indicates the directory where the Smart Hub binary and configuration files are saved. The default is C:\Program Files\BMC Software\SmartHub (Windows) and /opt/bmc/smarthub (UNIX).
    install-upgrade-smarthub-gateway (optional) – Indicates that you want to install or upgrade the Smart Hub Gateway. The Smart Hub Gateway is upgraded when the previously installed Smart Hub Gateway version is lower than the current Smart Hub Gateway version. 
    smarthub-gateway-port (required if you are using install-upgrade-smarthub-gateway) – Indicates the port where the the Smart Hub Gateway runs. The default is 1084.
    ca-cert-subject (optional) – Indicates the values used for generating the CA-signer certificate. Use the following format:  
    /C=<Country>/ST=<State|Province>/L=<Locality>/O=<Organization>/OU=<OrganizationalUnit>/CN=<CommonName>/emailAddress=<EmailAddress>
    server-cert-subject (optional) – Indicates the values used to generating the Smart Hub server certificate. Use the following format: 
    /C=<Country>/ST=<State|Province>/L=<Locality>/O=<Organization>/OU=<OrganizationalUnit>/CN=<CommonName>/emailAddress=<EmailAddress>

    For Redis Server host and Redis Server port parameters, we recommend using only the supported versions of Redis Server. For the list of supported versions, see Supported-platforms.

    If you do not specify any values for the ca-cert-subject and server-cert-subject parameters, default values are used for the certificates. We recommend providing some meaningful values that help identify these certificates.

    Important

    • If the values provided for the ca-cert-subject and server-cert-subject parameters match, installation is aborted. To resolve the issue, run the command with different values for these parameters.
    • A Redis server being used for an already running Smart Hub instance cannot be used for other Smart Hub instances. You need to have a separate Redis server instance.
  5. (Optional) Copy the Smart Hub CA root certificate (smartHubCA.crt) to the Application Server with which you will be registering this Smart Hub. This certificate (also called as CA bundle) is needed by an Application Server or Smart Agent to verify the legitimacy of a Smart Hub and Smart Hub Gateway. You need to provide the location of the CA bundle on the Application Server as an input while registering the Smart Hub with the Application Server. The CA bundle is typically located in the following directory:
    • (Windows) C:\Program Files\BMC Software\SmartHub\certs
    • (Linux) /opt/bmc/smarthub/certs
    Important
    • BMC recommends copying the CA bundle to the Application Server. If you do not copy the CA bundle and provide its path as the input while registering the Smart Hub, the Application Server or the Smart Agent won’t verify the server certificate of Smart Hub and Smart Hub Gateway.
    • Once the Smart Hub is registered with the Application Server, you can delete the copied CA bundle from the Application Server.
  6. Verify that the Smart Hub and Smart Hub Gateway is up and running:
    • (Windows)
      1. On the search bar, enter services.msc.
      2. Verify that the following services are running:
        • TrueSight Server Automation Smart Hub
        • TrueSight Server Automation Smart Hub Gateway
    • (Linux) Run the following commands to view the status of Smart Hub and Smart Hub Gateway:
      • systemctl status smarthub.service
      • systemctl status smarthub.gateway.service

To install the Smart Hub Gateway silently if Smart Hub is already installed

Do the following:

  1. Log in to the system where you want to install the Smart Hub Gateway.
    • (Windows) Log in as an administrator.
    • (UNIX and Linux) Log in as a root user.
  2. Extract the Smart Hub Gateway installer files to a directory of your choice.
    • (Windows) Extract SMARTHUB<version>-WIN64.zip
    • (Linux) Extract SMARTHUB<version>-LIN64.zip
  3. Navigate to the directory that contains the Smart Hub Gateway installation files.

  4. Run the following command:

    • (Windows) 

      setup.bat --silent --port < Smart Hub Gateway port> --smarthub-host <Smart Hub host name> --smarthub-port <Smart Hub port> --ssk <Shared secret key> --install-dir <Installation directory> --upgrade

      Example:

      setup.bat --silent --port 1080 --smarthub-host localhost --smarthub-port 443 --ssk ABCD1234abcd1234 --install-dir "c:\Program Files\BMC Software" --upgrade

    • (UNIX and Linux)

      ./setup.sh --silent --port <Smart Hub Gateway port> --smarthub-host <Smart Hub host name> --smarthub-port <Smart Hub port> --ssk <Shared secret key> --install-dir <Installation directory> --upgrade

      Example:

      ./setup.sh --silent --port 1080 --smarthub-host localhost --smarthub-port 443 --ssk ABCD1234abcd1234 --install-dir "/opt/bmc" --upgrade

    where, 
    port (optional) – Indicates the listener port of the Smart Hub Gateway. The default is 1080.
    smarthub-host (optional) – Indicates the name of the Smart Hub host. The default is localhost.
    smarthub-port (optional) – Indicates the port where the Smart Hub runs. The default is 443.
    ssk (required) – Indicates the shared secret key that was used for authentication during Smart Hub installation.
    install-dir (optional) – Indicates the directory where the Smart Hub Gateway binary and configuration files are saved. The default is C:\Program Files\BMC Software (Windows) and /opt/bmc (UNIX).
    upgrade (optional) – Indicates that you want to upgrade the Smart Hub Gateway. The Smart Hub Gateway is upgraded when the previously installed Smart Hub Gateway version is lower than the current Smart Hub Gateway version.

  5. Verify that the Smart Hub Gateway is up and running:

    • (Windows)
      1. On the search bar, enter services.msc.
      2. Verify that the following service is running: TrueSight Server Automation Smart Hub Gateway
    • (Linux) Run the following command to view the status of Smart Hub Gateway:
      systemctl status smarthub.gateway.service

What's next

  1. Register the Smart Hub with the Application Server. For more information, see Configuring-the-Smart-Hub-and-Smart-Hub-Gateway.
  2. (For targets in the public cloud) Define the network routing rules. For more information, see Creating-rules-for-routing-to-remote-servers.
  3. Configure the Smart Agent to specify the host name of this Smart Hub. For more information, see Configuring-the-installation-parameters-for-the-NSH-or-the-RSCD-agent.
  4. (Mandatory step for Smart Hub Gateway) Configure the NSH proxy server. For details, see Setting-up-a-Network-Shell-proxy-server.
  5. (Optional) Customize values of the Smart Hub parameters. For more information, see Managing-the-Smart-Hub.

Related topics

Getting-started-with-Smart-Agents

Smart-Hub-to-Application-Server-and-Smart-Agent

Migrating-the-Smart-Hub-and-Redis-Server-data

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*