Configure the Keyfactor Command Server 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 Client Success representative. 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 the Main Keyfactor Command Components on the Keyfactor Command Server(s)). Keyfactor strongly recommends using a password to protect production files.

• 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.

To configure Keyfactor Command from the command line:

1. Install the Keyfactor Command software using one of these methods:
   • Follow the initial instructions for Install the Main Keyfactor Command Components on the Keyfactor Command Server(s) except on the final installation wizard page, uncheck the Launch the Configuration Wizard now box and click Finish. The configuration wizard should not open.

   • Open an administrative command prompt and execute a command similar to the following:

     start /wait msiexec /i <full path to install file>\KeyfactorPlatform.msi /Live <path for msiexec logs> /Quiet

     This will install the default components of Keyfactor Command in a non-interactive way (/Quiet), output log information to a file (/Live), and wait to return to the command prompt until the installation is complete (start /wait).

     If you wish to install a set of features other than the default features, you can add the ADDLOCAL parameter A parameter or argument is a value that is passed into a function in an application. and specify the features you wish to install. For example, the following command will install the Orchestrator Service API and Windows Services features:

     start /wait msiexec /i <full path to install file>\KeyfactorPlatform.msi ADDLOCAL=AgentServicesFeature,ServiceFeature /Live <path for msiexec logs> /Quiet

     The following features are available:

     • AgentServicesFeature

       This installs the Orchestrator Keyfactor orchestrators perform a variety of functions, including managing certificate stores and SSH key stores. Service API 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. feature.

     • ConfigurationFeature

       This installs the configuration wizard and is required for all installations.

     • ServiceFeature

       This installs the Windows Services feature, which includes the Keyfactor Command Service (a.k.a. the timer service).

     • VCRedistFeature

       This installs the Microsoft Visual C++ Redistributable and is required for all installations unless it has been separately installed.

     • vSCEPValidationFeature

       This installs the vSCEP Validation Service feature. It is not included in the default features.

     • WebApiFeature

       This installs the WebAPI feature, which includes both the Keyfactor API and the Classic API.

     • WebConsoleFeature

       This installs the Management Portal feature, which includes the Keyfactor Command Management Portal and the Keyfactor API.

     The features you decide to install will depend on the role the server will be playing in your Keyfactor Command implementation. Table 759: Features Required for Each Server Role shows the minimum features that need to be installed for each of the server roles shown in the table columns. If you're installing all the required features on a single server, you need everything except vSCEPValidationFeature, which is only required for customers needing to validate SCEP requests, and WebApiFeature, which is only required for customers wishing to use the Classic API (see Classic API). If you don't intend to use any orchestrators (see Installing Orchestrators), you do not need to install the AgentServicesFeature.

     Table 759: Features Required for Each Server Role

     ADDLOCAL Parameter	Single Server	Management Portal	Windows Services	WebAPI	Orchestrator Service API	vSCEP Validation Service
     ConfigurationFeature
     VCRedistFeature
     WebConsoleFeature
     ServiceFeature
     WebApiFeature
     AgentServicesFeature
     vSCEPValidationFeature

2. Acquire a Keyfactor Command configuration file from your Keyfactor Client Success representative or create one by installing and configuring Keyfactor Command on a test machine. It's not practical to attempt to generate this file manually, though a file can be edited once generated (other than password-protected fields).

3. Create an input parameters file. See Table 760: Input Parameters XML File Fields. A sample file can be found in the Configuration directory under the directory in which you installed Keyfactor Command. By default, this is:

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

4. Open an administrative command prompt, change to the Configuration directory under the directory in which you installed Keyfactor Command (by default this is C:\Program Files\Keyfactor\Keyfactor Platform\Configuration), and execute a command similar to the following, referencing your input parameters file and using the appropriate parameters for the ConfigurationWizardConsole tool (see Table 761: ConfigurationWizardConsole.exe Options):

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