util utility functions

The following table describes the util utility functions:

Function

Description

-export

Exports job processing definitions, such as calendars, Control-M data, etc from the Control-M/EM database to an ASCII text file.

The data in the mentioned file is separated by field and record delimiters. For more information, see Configure the util utility to recognize different delimiters.

Usage: Specify the following command:

util <DB_ARGS> -export [-silent] [-cdbg <1 - 5>] {-type <all | def | cal | sys |dc | user | alert | gc | maint | collect | view |filter | report | hier | audit | history | bim_forecast | statistics | workload | active_nets | mft | [wcm]>} {-type net {-name {<name>}}} [-file <file> | -file - | -dir <dir>] [-without_def_history]

NOTE: If the database is exported to a file, you are prompted for a filename. The file that is created is a flat file.

  • If you use FTP to transfer the exported file, use binary mode.
  • If -type all is specified, the job’s running information history is not returned. Specify -type history separately if it is required.
  • -type def includes site standard and site customization definitions.
  • If -without_def_history is specified, only the current version of the job’s definition is exported. This option is relevant when version management mode is selected (default). For more information, see Using Control-M.

-import

Imports job processing definitions, such as calendars, Control-M data, etc, from an ASCII text file to the Control-M/EM database.

The data in the mentioned file is separated by field and record delimiters. For more information, see Configure the util utility to recognize different delimiters.

Usage: Specify the following command:

util <DB_ARGS> -import [-silent] [-replace] [-cdbg {1-5l}] {-type <all | def | cal | sys |dc | user | alert |gc | maint | collect | view |filter | report | hier | audit |history | bim_forecast | statistics | workload | active_nets | mft | wcm>>} {-type net {-name {<name>}}} [-file <file> | -file - | -dir <dir> | -dir <fileList>] [-without_def_history]

NOTE:

  • If the database is imported from a file, you are prompted for a filename. Only .exp files are accepted.
  • If you use FTP to transfer the imported file, use binary mode.
  • Stop all Control‑M/EM components before doing this operation.
  • If -type all is specified, the job’s running information history is not returned. Specify -type history separately if it is required.
  • -type def includes site standard and site customization definitions.
  • If -without_def_history is specified, only the current version of the job’s definition is imported. This option is relevant when version management mode is selected (default). For more information, see Version management

    Gateway(s) should not be running.

    If -replace is specified, your data may be destroyed. Use -replace with extreme caution. Any database element that is replaced is overwritten with data that you supply in the input file. If -replace is not specified and the database attempts to write data that already exists, the utility terminates and a rollback is performed on data written during the write operation.

-delete

Deletes the specified database folder.

Usage: Specify the following command:

util <DB_ARGS> -delete [-silent] [-cdbg {1-5}]{-name {<name>}}

NOTE: Stop all Control‑M/EM components before doing this operation.

-clean_database

Deletes all database folders.

Usage: Specify the following command:

util <DB_ARGS> -clean_database [-silent] [-cdbg <1-5>]

NOTE:

  • Stop all Control‑M/EM components before doing this operation.
  • This utility completely deletes database folders. Use it only with extreme caution. BMC recommends that you backup the database before issuing this command.

-build_schema

Builds the Control-M/EMdatabase. It defines the structure and the type of contents of each data element in the database.

Usage: Specify the following command:

util <DB_ARGS> -build_schema [-cdbg <1-5>]

NOTE:

  • Stop all Control‑M/EM components before doing this operation.
  • To load default data to the Control-M/EM database, run the loader utility.

-defexport

Exports the specified definition folder to an ASCII text file.

The data in the mentioned file is separated by field and record delimiters. For more information, see Configuring the util utility to recognize different delimiters below.

Usage: Specify the following command:

util <DB_ARGS> -defexport [-cdbg <1-5>] -table <outermost folder name> -dcname <newDc> [-library <newLibrary>] -file <file> [-without_def_history]

NOTE:

  • If the database is exported to a file, you are prompted for a file name.
  • If you use FTP to transfer the exported file, use binary mode.
  • -type def includes site standard and site customization definitions.
  • If -without_def_history is specified, only the current version of the definition folder is exported. This option is relevant when version management mode is enabled (default). For more information, see the Using Control-M.

-defimport

Imports the specified Control-M/EM database definition folder from an ASCII text file to a specified database folder.

The data in the mentioned file is separated by field and record delimiters. For more information, see Configuring the util utility to recognize different delimiters below.

Usage: Specify the following command:

util <DB_ARGS> -defimport -replace [-cdbg <1-5>] [-table <outermost folder name>] [-dcname <newDc>] [-library <newLibrary>] -file <file> [-without_def_history]

 

  • If you use FTP to transfer the imported file, use binary mode.
  • -type def includes site standard and site customization definitions.
  • If -without_def_history is specified, only the current version of the definition folder is imported. This option is relevant when version management mode is enabled (default). For more information, see the Using Control-M.

Parent Topic

util