Running the Configuration Check utility in interactive command-line mode

This mode provides an interactive way to run the BMC Remedy Configuration Check utility. Using the interactive command line mode, you can select required options when prompted, and run a sequence of commands. By using the available commands, you can set your configuration check preferences, select the components and checks, run the checks, and view the result. You can choose to view the result onscreen or generate an HTML report by running the appropriate command.

The following topics are provided:

Before you begin

• Ensure that the value of JAVA_HOME is set correctly. If you do not set the JAVA_HOME correctly, you may not be able to run the BMC Remedy Configuration Check utility outside of the installer to perform pre-upgrade and configuration checks.

  Use Java 8 update 45 or later.

  
  
• Extract the configcheckerversionNumber_buildNumber.zip file before running the utility. 
• Run the pre-upgrade checks by using the same version of Configuration Check utility as that of BMC Remedy AR System server to which you want to upgrade.

To run the Configuration Check utility in command-line mode

1. Run the following file from the configchecker folder:

   • (Microsoft Windows) configchecker.bat

   • (UNIX) configchecker.sh 

     Note

     For UNIX, provide executable permissions to the configchecker.sh file.

2. In the command-line window, provide the required inputs using the commands given in the following table:

    Click here for a list of commands and their descriptions

   Command	Description
   AR Login [log]	Enter the following BMC Remedy AR System configuration details: Auth String — The authentication string for BMC Remedy AR System server. User Name — The BMC Remedy AR System server user name. Password — The BMC Remedy AR System server password. AR Server — The BMC Remedy AR System server name. Port — The port number for the BMC Remedy AR System server. Note: This input required to run the majority of checks.
   DB Login [db]	Enter the following database compatibility information: MS-SQL (1), Oracle (2) — Select the required database from these options. Host Name — The BMC Remedy AR System server host name. TCP Port — The port number for the BMC Remedy AR System server. DB Instance Name — The name of the database instance. AR System DB Name — The BMC Remedy AR System database name. Windows Authentication or SQL Authentication — Select either of these options for authentication. Unicode — Select this option for a Unicode database. DB User — The BMC Remedy AR System server user name. Password — The BMC Remedy AR System server password.
   Encrypt Password [ep]	Enables you to encrypt the AR System server password or the database user password and display the encrypted string. The command enables you to add the encrypted string to the input configuration file manually.
   Get List Plugin Types [glt]	Displays all products for which the BMC Remedy Configuration Check utility plug-ins are configured. Note: Run the [lc] command before running the [glt] command.
   Get List Plugins [glp]	Displays a list of all the configured plug-ins. Note: Run the [lc] command before running the [glp] command.
   Input Config File [f]	Allows changing the name and location of the input configuration file that contains the framework configuration and information about the BMC Remedy Configuration Check utility plug-ins. By default, the value of this field is the name and location of the out-of-the-box (OOTB) configuration file. Recommendation: Run the utility with the default configuration file.
   Load Configuration [lc]	Loads the existing BMC Remedy Configuration Check utility configuration. This command is not required to run checks; however, the following commands have a dependency on the [lc] command: [glp] — To get the existing plug-in types (products). [glt] — To get the list of configured plug-in names. [run] — To run the checks, the BMC Remedy Configuration Check utility framework first loads the configuration and then runs the checks.
   Load Result File [lr]	Loads the existing result file, if present. If you do not provide a file path, the command searches for and loads the default file with the name configcheckResult.xml; otherwise the command is ignored. To rerun any failed check, you must load the existing result file first and then rerun the failed check.
   Path (AR/Temp) [path]	Allows changing the location of the following directories: Temporary (Optional) BMC Remedy AR System installation directory
   Report Mode [rmode]	Allows changing the report mode to one of the following modes: info — Displays all messages (informational, warnings, and errors) in the report. warning (default) — Displays warnings and errors. The info messages are ignored. error — Displays only errors, but not warnings, in the report. Based on the report mode, the error details are displayed.
   Result File [rf]	(Optional) Allows changing the name and location of the result file. By default, the BMC Remedy Configuration Check utility result file is created in the configchecker folder with the name configcheckResult.xml.
   Run Test [run]	Runs the selected checks. The following options are provided: 1 — Run Failed. If an earlier result file is present, only failed checks from the earlier run are run; if no earlier result file is present or no failed checks are found, no action is taken. 2 — Run by Name. Specific checks can be run. To view the configured plug-in names, run the Get List Plugin [glp] command.
   Set Categories [scat]	All checks are classified into the following categories that indicate when a particular check must be run: Pre-upgrade checks Configuration checks
   Set Plugin Type List [spt]	Allows setting product types. First, ensure that you run the Load Configuration ([lc]) command, so that the existing product list is displayed by the Set Plugin Type List ([spt]) command. Select any of the following products by entering 1, or deselect by entering  0: ARS — BMC Remedy AR System. CMDB — BMC Atrium Core. ITSM — BMC Remedy IT Service Management Suite. SLM — BMC Service Level Management. SRM — BMC Service Request Management. SSI — BMC Remedy ITSM Preconfigured Stack installer. UDM — Unified Data Management PD — BMC Remedy ITSM Process Designer
   Show Result [res]	Displays the result of the last run. The following options are displayed: 0 — If you select this option, the following suboptions are displayed on the screen: 0 — Displays the configuration check summary on the screen, including the name of the check, product, and status. 1 — Displays detailed information about all the failed checks. This information is the same as the output that is displayed on the Errors/Warning tab of the GUI. 2 — Displays the result of a specific check, by providing the name of the check. 1 — The utility generates an HTML report of the last run, and the file path is displayed on the screen. This report can also be generated from the GUI. Note: You must start the HTML report from the same folder in which it is created, because it has a dependency on the prechecker/etc directory.

3. Run the appropriate command to view the result on the screen, or generate an HTML report of the last run.

Where to go from here

Viewing configuration check reports

Viewing configuration check log files and changing logging level

Related Topics

Running the Configuration Check utility in GUI mode

Running the Configuration Check utility in silent mode