› KCM Installation Guide › Obtain information from a KCM installation

Obtain information from a KCM installation

KCM has several CLI tools that you can use to obtain information from a running KCM installation.

ListKCMPackages.exe

Displays all KCM installations on the server.

The output lists both active and inactive installations.

This tool does not have any parameters.

InfoKCM.exe

Gives an overview of the current KCM installation.

The output displays the following information:

  • The version of KCM, including the installed service packs and fix packs.

  • Whether or not the KCM installation is active.

  • The components of the KCM installation. The possible components are:

    • Contract Manager

    • KCM instances

    • Batch & Output Management

    • KCM Control Center

  • The current status of each component. Possible statuses are:

    • Not yet configured. The component has been added, but has not yet been started for the first time. The first start is needed for essential configuration.

    • Running. The component has been started with the corresponding Start tool.

    • Stopped. The component has been stopped with the corresponding Stop tool.

  • Optionally displays the server API key.

Parameters

The following table lists and describes the InfoKCM.exe tool parameters.

Parameter Required / Optional Description
Services!Password Optional

The password of the KCM services user account. Determines whether or not the server API key is shown.

InfoContractManager.exe

Shows the status of the Contract Manager of the current KCM installation, if any.

The output displays the following information:

  • Whether it is running, or not. The Contract Manager is running when it has been started with StartContractManager.exe, and it is not running when it has been stopped with StopContractManager.exe.

  • Whether application authentication is enabled, disabled, or not yet configured*

  • Whether the LDAP mode is enabled, disabled, or not yet configured*

* Not yet configured indicates that the Contract Manager has not yet been started for the first time.

This tool does not have any parameters.

InfoInstance.exe

Shows the status of a single KCM instance of the current KCM installation.

The output displays the following information:

  • Whether it is running, or not. The KCM instance is running when it has been started with StartInstance.exe, and it is not running when it has been stopped with StopInstance.exe.
  • The license validity and expiration date, when it has been configured*.
  • The database that is used for the KCM/Repository, when it has been configured*.
  • The contract with which the KCM instance is registered on the Contract Manager, when it has been configured*.
  • The Contract Manager with which the instance is registered.
  • The example web application that was created for the instance.

* License, database and registration are not configured until the instance has been started for the first time.

Parameters

The following table lists and describes the InfoInstance.exe tool parameters.

Parameter Required / Optional Description
Instance!Number Required

The number of the instance to get information for.

InfoOutputManagement.exe

Shows the status of the Batch & Output Management of the current KCM installation, if any.

The output displays the following information:

  • Whether it is running, or not. Output Management is running when it has been started with StartOutputManagement.exe, and it is not running when it has been stopped with StopOutputManagement.exe.

  • The database that is used for the repository, when it has been configured*.

  • The names of the systems in the repository, when it has been configured*.

* The repository database is not configured until Batch & Output Management has been started for the first time.

This tool does not have any parameters.

InfoControlCenter.exe

Shows the status of KCM Control Center of the current KCM installation, if any.

The output displays the following information:

  • Whether KCM Control Center is running or not. It is running when it has been started with StartControlCenter.exe, and it is not running when it has been stopped with StopControlCenter.exe.
  • The OAuth2 configuration of KCM Control Center. The configured secret is shown only when the Services!Password has been provided.

Parameters

The following table lists and describes the InfoControlCenter.exe tool parameters.

Parameter Required / Optional Description
Services!Password Optional

The password of the KCM services user account. Determines whether or not the secret of the OAuth2 configuration is shown.

InfoPorts.exe

Shows the ports that are currently in use by the current KCM installation.

The ports are enumerated and categorized by the component(s) that use them.

The tool also writes an XML file to disk that in detail describes which port is used for which purpose.

For more information about ports, refer to the Ports section of the Kofax Communications Manager Installation Guide.

Parameters

The following table lists and describes the InfoInstance.exe tool parameters.

Parameter Required / Optional Description
Info!PortsXmlFile Optional

Name of the XML file to write. Must be a full path. The file will be overwritten if it already exists. Defaults to <deploy root>\KCM\Work\<Version>\Management\ports.xml when omitted.

InfoResources.exe

Shows which resources have been configured for the KCM installation and which resources have not yet been configured.

This tool does not have any parameters.