-ACTION

Indicates the action to be performed on the specified variable. The possible actions are:

LOAD

Loads variables from a file. When this option is used, parameter -filename is required. The format for each variable in the specified file is: %%[\<SMART folder>[\<job>]]\"%%\<variable name>"=<expression>

If the variable does not exist in the data center or the specified SMART Folder or job, it is created.

If the variable already exists, it is updated with the specified value.

SET

Defines a new variable. When this option is used, parameters -var and varexpr are required for each variable that you want to set.

If the variable does not exist in the data center or the specified SMART Folder or job, it is created.

If the variable already exists, it is updated with the specified value.

Following is the syntax to set variables:

ctmvar -action set -var "%%\<variable name>" -varexpr <variable value> -var "%%\<variable name>" -varexpr <variable value>

DELETE

Deletes a Global variable. When this option is used, the -var parameter is mandatory.

This action cannot be used for variables that have been defined for a specific job or SMART Folder.

LIST

Displays all Global variables for the data center or all variables for the specified SMART Folder specified in the -var parameter.

Following is syntax to display all Global variables in the data center:

ctmvar -action list "%%\<variable name>"

EXAMPLE:

ctmvar -action LIST

Displays all Global variables for the data center.

ctmvar -action LIST -var "%%\PAYROLL"

Displays all variables that are global for the PAYROLL SMART Folder.

Variable values can also be displayed using the ctmstvar utility. However, the ctmstvar utility resolves the current value of only a specified variable or function. The ctmvar utility displays all variables in the data center or the specified SMART Folder.

-VAR

Defines the name and location of the variable that the specified action should be applied to.

Valid formats:

• -var "%%\<variable name>": Defines a global variable for an entire data center.
• -var "%%\<SMART folder name>\<variable name>": Defines a local variable for every SMART Folder with the specified name.
• -var "%%\<folder name>\<job name>\<variable name>": Defines a local variable for a specified job in the relevant folder.

  NOTE: The <job name> must not belong to a Sub Folder.

  NOTE: This parameter cannot be specified together with -action LOAD. For more information about variables, see Control-M Variable facility.

  You cannot assign values to the following system variables: %%ODATE, %%$ODATE, %%GROUP_ORDID, %%$GROUP_ORDID, %%TABLE_ID, %%$TABLE_ID, %%FOLDER_ID, %%$FOLDER_ID, %%JOBNO, %%JOBID, %%ORDERID, %%SMART_ORDERID, %%$SMART_ORDERID

-VAREXPR

Value to be assigned to the specified variable. The specified value can be:

• A string (embedded in quotation)
• An integer (a numeric value)
• A Variable expression (for example, with an Variable function)
• Another (existing) global variable.

  NOTE: This parameter cannot be specified together with
  -action LOAD.For more information, see Control-M Variable facility.

-FILENAME

Path and name of the file containing the list of variables. The file must be accessible to Control-M/Server. This parameter is only valid when specified together with -action LOAD.

The syntax for each line in the specified file is %%[\<ctmvar>[\<job>]]\<varName>=<expression>

Specify the entire pathname in this parameter.

-QUIET

Suppresses the display of the results.

-DEBUG

Sets a debug level for the utility. This parameter is used for maintenance and troubleshooting purposes. The level, a numeric value from 0 to 5, must be used only if requested and specified by Technical Support.

Performance is somewhat slower and requires a larger number of resources when operating in debug mode. BMC recommends that you activate debug mode only when absolutely necessary and revert to normal mode as soon as possible.

-input_file

Name and full path of a file containing parameters for the utility. In this file, each parameter and its values (if any) are on a separate line with the same syntax they would have on the command line. Using the -input_file parameter enables you to:

• prepare and save files of utility parameters that can be reused.
• specify utility input longer than the number of characters allowed in the command line.

  EXAMPLE:

  -input_file ~<controlm_owner>/ctm_server/data/ctmvar_parms.txt

-POOL

Indicates the variable action to be performed in the specified named pool. The following are possible actions:

LOAD

Loads variable values from a specified file to pool. The file name is the path name of a text file containing the variable assignment statements.

This file must be accessible to Control‑M/Server. The file must contain a single assignment on each line.

Following is the syntax to load variable values from a file to a named pool:

ctmvar -pool load -poolname <pool name> -from <file name>

SETVAR

Defines new variables or updates existing variables in the specified named pool. When this option is used, parameters -var and value are required for each variable that you want to set.

If the variable does not exist in the data center, it is created.

If the variable already exists, it is updated with the specified value.

Following is the syntax to set variables in a named pool:

ctmvar -pool setvar -poolname <pool name> -var "%%<variable name>" -value <variable value> -var "%%<variable name>" -value <variable value>

DELETE

Deletes a named pool from the data center or variables from the specified named pool.

Following is the syntax to delete all of the variables in a named pool:

ctmvar -pool - delete -poolname <pool name>

Following is the syntax to delete specific variables in a named pool:

ctmvar -pool deletevar -poolname <pool name> -var "%%<variable name>" -var "%%<variable name>"

NOTE: You cannot use wildcards in the name of the named pool or variable that you want to delete.

LIST

Lists all named pools in the data center.

Following is the syntax to list all named pools:

ctmvar -pool list

VIEW

Displays the list of variables in the named pool or specific variables in the named pool.

Following is the syntax to view the variables in a named pool:

ctmvar -pool view -poolname <pool name>

Following is the syntax to view specific variables in the named pool:

ctmvar -pool -view -poolname <pool name> -var "<variable name>"

NOTE: You can use wildcards in the name of the named pool and variable that you want to view.