Documentation forNetwork Configuration Manager

Parameters for NCM config change templates

The parameters of a config change template define and label the variables that hold information about the template.

The script of every config change template includes at least five parameters. Only PARAMETER_LABEL and PARAMETER_DESCRIPTION can occur more than once in a template. The script includes one pair of PARAMETER_LABEL and PARAMETER_DESCRIPTION variables for each value that the user must enter when the config change template runs.

Required Parameters

CHANGE_TEMPLATE_DESCRIPTION

This parameter appears at the top of the script and briefly explains the purpose of the template. It does not have any associated variables, and it is not exposed in the run-time wizard.

CHANGE_TEMPLATE_TAGS

This parameter holds the tags that NCM uses to provide grouping options in the Config Change Template resource. It does not have any associated variables and is not exposed in the run-time wizard.

PLATFORM DESCRIPTION

This parameter defines the type of NCM device for which the template is designed. It does not have any associated variables and is not exposed in the run-time wizard.

PARAMETER_LABEL @<variable_name>

The PARAMETER_LABEL parameters define the input data that the template requires. They make the variable available to the user at run-time, and they provide metadata (the variable name) so that the user knows what the variable is holding a place for.

For example, PARAMETER_LABEL is used in every template with @ContextNode. The user sets the value by selecting the NCM nodes that are targeted for config change. An instance of the parameter appears in a script as follows:

.PARAMETER_LABEL @ContextNode NCM Node

In this case, NCM Node is the actual label that appears under the field where the NCM nodes are selected in the template's run-time wizard.

A config change template may have as many instances of PARAMETER_LABEL as needed to support the user input required for the template.

PARAMETER_DESCRIPTION @<variable_name>

This parameter holds the explanatory text for an input field. It always appears after the corresponding PARAMETER_LABEL and includes the same variable name.

For example, .PARAMETER_DESCRIPTION @ContextNode NCM Node corresponds to the input field labeled NCM Node. The value might be something like:

The NCM nodes the template will operate on. Target nodes are selected during the first part of the wizard and cannot be changed when defining values of variables.

Optional Parameter

PARAMETER_DISPLAY_TYPE

This parameter creates a list of options. The format for using this parameter is as follows. The vertical bar character (|) divides the items in the list.

PARAMETER_DISPLAY_TYPE @VariableName

Listbox:1=String1|2=String2|3=String3