CPM installation

This topic describes the CPM installation process.

Overview

The CPM installation process installs both the CPM and the Scanner. These components can be automatically installed using scripts, or installed by using the Installation wizard. We recommend that you use the automated scripts.

Install CPM using the script file

  1. In the CPM\InstallationAutomation\Installation folder, locate and open the InstallationConfig.xml file.

  2. In the InstallationConfig.xml file, specify the following parameters:

    Parameter

    Description

    Username

    The name of the user running the installation.

    Valid values: Username

    Default value: Windows User

    Company

    The name of the company running the installation.

    Valid values: Company name

    Default value: My Company

    CPMInstallDirectory

    The path where CPM is installed.

     

    If the path is more than 260 characters, enable the LongPathsEnabled setting.

    In the Registry Key settings, go to HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Filesystem > LongPathsEnabled, and change the value from 0 to 1. Reboot the machine to recognize the new key setting.

    Valid values: Pathname

    Default value: C:\Program Files (x86)\CyberArk\

    isUpgrade

    Whether this is a CPM upgrade or a new CPM installation.

    Valid values: True/False

    Default value: False

  3. In a PowerShell window, run the CPMInstallation.ps1 script as Administrator.

Registration

The registration process connects the CPM to the Vault.

  1. In the CPM\InstallationAutomation\Registration folder, locate and open the CPMRegisterComponentConfig.xml file.

  2. In the CPMRegisterComponentConfig.xml file, specify the following parameters.

    Parameter

    Description

    accepteula

    Acceptance of the end user License agreement.

    Valid values: Yes/No

    vaultIP

    The IP address or hostname of the Vault server.

    Valid values: IP address or hostname

    vaultport

    The Vault’s configured communication port.
    Recommended default Vault port: 1858

    Valid values: Port number

    vaultuser

    The name of the Vault user performing the installation.

    Valid values: Username

     

    We recommend using the Vault administrator user to install CPM as this user has the appropriate Vault authorizations, and is created in the appropriate location in the Vault hierarchy.

    For more information about the required authorizations, see Vault user authorizations.

    pocmode

    Whether or not CPM is installed in POC mode.

    Valid values: True/False

    installDirectory

    The path where CPM is installed.

    Specifiy the same value as the CPMInstallDirectory value in the InstallationConfig.xml file.

    Valid values: Pathname

    Default value: C:\Program Files (x86)\CyberArk\

    username

    Sets the CPM user name. CPM Safe names will be created according to the user name that you specify.

    If the user name is already in use, a sequence number will be added.

    Example: PasswordManager1, PasswordManager2 and so on.

    Default value: PasswordManager

    isUpgrade

    Indicates whether the registration is for a clean installation or an upgrade.

    Valid values: True\False

    Default value: False

  3. In a PowerShell window, run the CPMRegisterComponent.ps1 script as Administrator, and provide the Vault password in one of the following ways.

    Method

    Command

    As a secure string (recommended) 

    CD “<installation package Path>InstallationAutomation\Registration” .\CPMRegisterComponent.ps1 -spwdObj <vaultpassword>

    Use a Windows authentication window (recommended for manual runs)

    CD “<installation package Path>InstallationAutomation\Registration” .\CPMRegisterComponent.ps1

    As clear text (not recommended)

    CD “<installation package Path>InstallationAutomation\Registration” .\CPMRegisterComponent.ps1 -pwd <vaultpassword>

Install CPM using the Installation wizard

This installation process installs the CPM and connects to the Vault (registration).

 

Before you begin, make sure you have closed any open Windows applications.