Install Keyfactor Command on Windows Under IIS from the Command Line

The Keyfactor Command server can optionally be configured using a pair of configuration files and a command run from the command line. You may be provided one or both of these files by your Keyfactor Customer Success Manager. The configuration files for command-line configuration are:

• Keyfactor Command Configuration File

  This file, with an extension of .cmscfg, contains information in XML format to configure the Keyfactor Command database. This file can be generated by installing Keyfactor Command, running the configuration wizard and populating all the fields as desired, and then saving a copy of the configuration either with or without a password to encrypt sensitive information in the file (see Install Keyfactor Command on a Windows Server Under IIS). Keyfactor highly recommends using a strong password to protect the file. A file that has not been protected with a password will be missing the sensitive information that would be protected by the password encryption (for example, service account passwords).

• Input Parameters File

  This file, with an extension of .xml, contains information in XML format to connect to and configure SQL, open the Keyfactor Command configuration file, locate the Keyfactor Command license, and create application pools, if desired.

Install Keyfactor Command

You can install Keyfactor Command interactively using the installation wizard or non-interactively from a command shell or PowerShell session.

To install interactively, follow the instructions for Install Keyfactor Command on a Windows Server Under IIS except on the final installation wizard page, uncheck the Launch the Configuration Wizard now box and click Finish. The configuration wizard should not open.

Install Default Features from the Command Line

To install default features from a Command Prompt, in an administrative command prompt run:

start /wait msiexec /i <PATH_TO_INSTALL_FILE>\KeyfactorPlatform.msi /Live <PATH_FOR_OUTPUT_LOGS> /Quiet

To install default features from PowerShell, in an administrative PowerShell run:

Start-Process msiexec.exe -Wait -ArgumentList '/i', `
'<PATH_TO_INSTALL_FILE>\KeyfactorPlatform.msi', `
'/Live', '<PATH_FOR_OUTPUT_LOGS>', `
'/Quiet'

These commands perform a non-interactive installation (/Quiet), write installation logs to the specified location (/Live), and wait for the installation to complete before returning control to the shell.

Install Specific Features from the Command Line

To install only specific features, use the ADDLOCAL parameter A parameter or argument is a value that is passed into a function in an application. and provide a comma-separated list of feature names.

For example, the following command installs only the Orchestrator Services API and Windows Services features in a Command Prompt:

start /wait msiexec /i <PATH_TO_INSTALL_FILE>\KeyfactorPlatform.msi ADDLOCAL=AgentServicesFeature,ServiceFeature /Live <PATH_FOR_OUTPUT_LOGS> /Quiet

The following command installs all features in a PowerShell:

Start-Process msiexec.exe -Wait -ArgumentList '/i', `
'<PATH_TO_INSTALL_FILE>\KeyfactorPlatform.msi', `
'ADDLOCAL=AgentServicesFeature,CAConnectorAPIFeature,CommandBFFFeature,ConfigurationFeature,LogiFeature,ServiceFeature,VCRedistFeature,WebApiFeature,WebConsoleFeature', `
'/Live', '<PATH_FOR_OUTPUT_LOGS>', `
'/Quiet'

The features you install depend on the architecture of your Keyfactor Command deployment. Features can be installed together on a single server or distributed across multiple servers. Install the features required for the capabilities you plan to use and for the function each server performs within the deployment.

The following features are available:

• AgentServicesFeature

  Installs the Orchestrator Services API feature. Required only if you plan to use agents or orchestrators.

• CAConnectorAPIFeature

  Installs the CA Connector API feature. Not installed by default.

• CommandBFFFeature

  Installs the Command BFF feature.

• ConfigurationFeature

  Installs the Keyfactor Command Configuration Wizard. Required for all installations.

• LogiFeature

  Installs the Logi feature, which provides the legacy dashboards and reporting platform.

• ServiceFeature

  Installs the Windows Services feature, including the Keyfactor Command Service (timer service).

• VCRedistFeature

  Installs the Microsoft Visual C++ Redistributable. Required unless a supported version is already installed.

• WebApiFeature

  Installs the Web API feature, which hosts the Keyfactor API An API is a set of functions to allow creation of applications. Keyfactor offers the Keyfactor API, which allows third-party software to integrate with the advanced certificate enrollment and management features of Keyfactor Command..

• WebConsoleFeature

  Installs the Management Portal feature, which hosts the Keyfactor Command web interface and includes the Keyfactor API.

Configure Keyfactor Command

To configure Keyfactor Command from the command line, you must provide two configuration files:

• A Keyfactor Command configuration file.

  The Keyfactor Command configuration file can be obtained from your Keyfactor Customer Success Manager or generated by installing and configuring Keyfactor Command on a test system. This file is not intended to be created manually, although most settings can be edited after the file has been generated. Password-protected fields cannot be edited manually.

• An input parameters file.

  Create an input parameters file as described in Table 95: Input Parameters XML File Fields. A sample file can be found in the Configuration directory under the Keyfactor Command installation directory. By default, this file is located at:

  C:\Program Files\Keyfactor\Keyfactor Platform\Configuration\InputParameters.xml

After preparing both files, open an administrative Command Prompt and change to the Configuration directory under the Keyfactor Command installation directory (by default, C:\Program Files\Keyfactor\Keyfactor Platform\Configuration). Then run the ConfigurationWizardConsole tool, specifying your input parameters file and any required command-line options. SeeTable 96: ConfigurationWizardConsole.exe Options for details. For example:

.\ConfigurationWizardConsole.exe -p C:\Temp\InputParameters.xml -u

<ApplicationPoolsToCreate>
<!--Remove this section if none are to be created-->
   <WizardApplicationPool>
      <Name>KeyfactorPortalPool</Name>
      <Username>KEYEXAMPLE\svc_kyfpools</Username>
      <Password>MySecurePassword</Password>
      <FailIfExists>true</FailIfExists>
   </WizardApplicationPool>
   <WizardApplicationPool>
      <Name>KeyfactorAPIPool</Name>
      <Username>KEYEXAMPLE\svc_kyfpools</Username>
      <Password>MySecurePassword</Password>
      <FailIfExists>true</FailIfExists>
   </WizardApplicationPool>
   <WizardApplicationPool>
      <Name>KeyfactorAnalysisPool</Name>
      <Username>KEYEXAMPLE\svc_kyfpools</Username>
      <Password>MySecurePassword</Password>
      <FailIfExists>true</FailIfExists>
   </WizardApplicationPool>
   <WizardApplicationPool>
      <Name>KeyfactorAgentsPool</Name>
      <Username>KEYEXAMPLE\svc_kyfpools</Username>
      <Password>MySecurePassword</Password>
      <FailIfExists>true</FailIfExists>
   </WizardApplicationPool>
</ApplicationPoolsToCreate>