Installing ​BMC Helix Vault Adapter​

BMC Helix Vault Adapter is installed as a standalone service to enable secure retrieval of credentials from an enterprise vault for remote monitoring. It does not require a PATROL Agent to be installed on the same host. After installation, the BMC Helix Vault Adapter works with PATROL Agents to retrieve credentials at runtime. 

This topic describes how to install  BMC Helix Vault Adapter on supported platforms and prepare it for integration with BMC Helix Operations Management and the PATROL Agent.

Before you begin

• Make sure that you have the following permissions on the target computer where  BMC Helix Vault Adapter will be installed:
  • Windows: Local Administrator privileges
  • Linux: Root access or a sudo‑enabled account
    
    InformationOn Linux platforms, the BMC Helix Vault Adapter installation is supported only on the Red Hat Enterprise Linux distribution.
     
• Make sure that a Java Runtime Environment (JRE) is available on the target system before starting the installation.
• Before configuration, obtain the following information from the BeyondTrust vault administrator:
  • BeyondTrust vault server URL
  • Vault API key
  • Vault user credentials required for vault access

•  BMC Helix Vault Adapter uses port 8091 by default. If a different port is required, make sure that it is available and not blocked by the firewall or security policies.

To create deployable packages

1. In BMC Helix Operations Management, click the Administration > Repository > Deployable Packages tab.
2. Click Create.
3. Select the operating system and the platform for which you want to create a package.
   The list of platforms changes according to the operating system that you select.
4. Select the BMC Helix Vault Adapter component and click Next. 
5. Specify the directory where you want to install the BMC Helix Vault Adapter.
   The specified directory acts as the base installation directory for the BMC Helix Vault Adapter:
   1. For Windows: C:\Program Files\BMC Software\VaultAdapter
   2. For Linux: /opt/bmc/VaultAdapter
      Follow the instructions in the Important Instructions section of the wizard.
      Important: On Windows, you can select a custom installation directory. However, on Linux systems, the installer is RPM‑based and requires the /opt/bmc directory. The BMC Helix Vault Adapter is installed only under /opt/bmc, and custom installation paths are not supported on Linux.
6. (UNIX only): Enter the root credentials with root privileges. The root account is used to install one or more of the products you selected.
7. Click Next.
8. Provide the Name and Description of the package.
9. Select the file download format.
10. Select one of the following:
    • Save: Save the package for future installation on the current host or other hosts.
    • Save and Download: Save and download the package, and note the downloaded package location. You will need the downloaded package location details while deploying the
      package.

(Windows) To download and install the deployable package

1. In BMC Helix Operations Management, click Administration > Repository > Deployable Packages tab.
2. Locate the Vault Adapter package.
3. Click the More options (⋮) menu and select Copy install script.
4. Log in to the target Windows computer as an Administrator.
5. Open PowerShell as an administrator.
6. Paste the copied installation script into the PowerShell window and press Enter.
   The installation script creates the required subdirectories under the following location: C:\Program Files\BMC Software\VaultAdapter

7. To verify the installation, open Services and verify that the BMC Vault Adapter service exists and is running.

(Linux) To download and install the deployable package

1. In BMC Helix Operations Management, click Administration > Repository > Deployable Packages tab.
2. Locate the Vault Adapter package.
3. Click the More options (⋮) menu and select Copy install script.
4. Log in to the target Linux computer as the root user.
5. Open a terminal and paste the copied installation script and press Enter.
   The installation script creates the required subdirectories under the following location: /opt/bmc/VaultAdapter
   Information

   Important

   As the Linux installer is RPM‑based, the directory /opt/bmc must exist prior to installation. The Vault Adapter must be installed under /opt/bmc directory.

6. To verify the installation, check the service status by running the following command:
   systemctl status vault-adapter

Use the following commands to perform other operations:

• To start the service:
  systemctl start vault-adapter
• To stop the service:
  systemctl stop vault-adapter
• To restart the service:
  systemctl restart vault-adapter
• To view logs:
  journalctl -u vault-adapter -f