Error: Invalid spaceKey on retrieving a related space config.

Running the Configuration Check utility in silent mode

This mode provides a way of running the BMC Remedy Configuration Check utility by passing at least one argument to the configchecker.bat command on Microsoft Windows or the configchecker.sh command on UNIX. Based on the command that you enter, the utility then provides onscreen options to perform the required action.

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.

  •  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 BMC Remedy Configuration Check utility in silent mode

In the command line interface, you must pass at least one argument using the following command format:

  • (Microsoft Windows) configchecker.bat <Command Id> <Command Value>
  • (UNIX) configchecker.sh <Command Id> <Command Value>

Note

If you are using BMC Remedy Configuration Check utility on UNIX, before you run the utility, run the dos2unix command on the configchecker.sh file.

Provide the required inputs using the commands given in the following table:

 Click here for a list of commands and their descriptions.
CommandDescription
Execution Mode [m]

Executes the selected checks. The options are:

  • 0 — Run All. All checks are executed, and a result file is generated.
  • 1 — Run Failed. If an earlier result file is present, only failed checks from the earlier run are executed; if no earlier result file is present or no failed checks are found, no action is taken.
  • 2 — Run by name.
Check/Test Name [rid]

The name of the check that you want to run; for example, GetList Max Entries Check.

The following topics provide the names of the checks that you can run using the BMC Remedy Configuration Check utility:

Notes:

  • This option is applicable only when the value of the Execution Mode [m] command is 2.
  • You can specify the name of only one check at a time.

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.

AR Server Host [x]

The BMC Remedy AR System server host name

AR Server Port [o]

The port number for the BMC Remedy AR System server.

AR Server User [u]

The BMC Remedy AR System server user name.

AR Server Password [p]

The BMC Remedy AR System server password.

AR DB Name [ard]

The BMC Remedy AR System database name.

DB Type [dt]

Select the required database from the following options:

  • 1 — MS-SQL
  • 2 — Oracle

DB Host Name [d]

The BMC Remedy AR System database host name.

DB User [du]

The BMC Remedy AR System database user name.

DB Password [dp]

The BMC Remedy AR System database password.

DB TCP Port [do]

The port number for the BMC Remedy AR System database.

DB Instance Name [di]

The name of the database instance. Example: -di <DB instance name>

For Oracle databases, do any of the following:

  • If the database is configured with Oracle service ID [dsid]: Pass the value of dsid.
  • If the database is configured with Oracle service name [dsvc]: Pass the value of dsvc.

Note:
Enter the value for only one of the options. The value of dsid or dsvc denotes whether the database instance [di] is Oracle SID or service name. If you pass the value for [dsid], the database instance [di] is Oracle SID. If you pass the value for [dsvc], database instance [di] is the Oracle service name. The [di] option is used along with [dc] for database connection identifier.

Oracle Connection Id [dc]

The Oracle database connection identifier.

SQL Auth Type [sql]

Select one of the following options for authentication:

  • 0 — Windows Authentication
  • 1 — SQL Authentication

Unicode Char Set [uch]

Select one of the following options:

  • 0 — Non-Unicode Char Set
  • 1 — Unicode Char Set

Result File Path [rf]

(Optional) Allows changing the name and location of the result file. By default, the result file is created in the configchecker directory, with the name configcheckResult.xml.

Set Category [scat]

Select an option to set the category of checks to be performed:

  • 1 — Pre-upgrade checks
  • 2 — Configuration checks

Notes:

  • If you want to run both checks, pass the specified values, separated by a comma ( , ), to the command.
  • If you provide a value other than the specified values, the default category (Pre-upgrade checks) is used.
Set Plugin Types [spt]

Select the type of plug-in. The valid values are ARS, CMDB, ITSM, SRM, SLM, PD and UDM.

Note:
To set more than one plugin type, pass multiple values, separated by a semicolon ( ; ). For example, -spt ARS;CMDB;ITSM;SRM;SLM;PD;UDM

Set Report File Name [srf]

Set the name of the report file with the .html or .htm extension.

Note:
Do not provide the path of the file for this command. By default, the path is set to <Utility>\result\.

The following sample command is for Microsoft Windows and MS SQL database type:

configchecker.bat -u <AR Server User> -x <AR Server Host> -dt <DB Type> -d <DB Host Name> -du <AR DB User> -dp <AR DB Password> -do <DB TCP Port> -m <Execution Mode> -spt <Plugin Types>

For example:

configchecker.bat -u <UserName> -x <AR Server Name> -p <password> -o 0 -dt 1 -sql 1 -d <DB Host Name> -ard <DbName> -du <DB Admin User> -dp <DB Admin Password> -do <Db Port> -di <DB Instance>  -spt <Products> -scat 2 -f "<Path to configchecker_config.xml>" -rf "<Path to configchecker_result.xml>" -srf "<Path to configchecker_report Name.html>" -m 0

This command runs all the checks (-m 0).

For UNIX, you can run the configchecker.sh command by passing the same <Command Id> and <Command Value> parameters.

After you run the utility, an HTML report (configchecheckerOutput.html) is generated from the configuration check result file (configcheckResult.xml). The HTML report is located in the ./configchecker/result folder.

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 interactive command-line mode

Was this page helpful? Yes No Submitting... Thank you

Comments

  1. Sirisha Dabiru

    Hi,

    Here is the response for the following comment:

    CommentResponse
    I cannot seem to run the config checker with more than one plugin type at a time. For example I can use -spt ARS or -spt ITSM which both work fine however if I try to use -spt ARS;ITSM as described on this page I get back the error below: Xml Report generated - /var/tmp/configchecker/./result/configcheckResult.xml HTML Reported generated - /var/tmp/configchecker/./result/configchecheckerOutput.html -bash: ITSM: command not foundPlease contact BMC Support.


    Regards,

    Sirisha

    Mar 25, 2019 12:12