Submit a ticketCall us

Webinar: Web Help Desk for HR, Facilities and Accounting Departments
This webinar will focus on use cases for HR, Facilities and Accounting.

Having a unified ticketing and asset management system for all the departments in your company can provide end-users with a seamless experience and make things easier for your IT team. Yet, with different business tasks and objectives, many departments don’t fully understand the capabilities of Web Help Desk and how the software can be customized for effective use in their departments.
Register Now.

Home > Success Center > Network Configuration Manager (NCM) > NCM 7.7 Administrator Guide > Config change template details > Set up the parameters

Set up the parameters

Created by Caroline Juszczak, last modified by Anthony.Rinaldi_ret on Oct 03, 2016

Views: 25 Votes: 0 Revisions: 5

The parameters of a script define and label the variables for which a user of the template must provide appropriate values when the template is executed.

The script of every config change template includes at least five parameters. Only one, PARAMETER_LABEL, can recur in a single template and each instance requires user input to determine the value of a specific variable.

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 variable(s) and 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 variable(s) 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.

PARAMETER_LABEL @<variable_name>

Each instance of this parameter in a config change template is associated with a specific variable. The template's run-time wizard requires the user to provide the value for each parameter variable.

By providing the input parameters for executing a template, PARAMETER_LABEL delimits the data that a template can use. Think of PARAMETER_LABEL as simultaneously making a variable available for user input and providing the metadata 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 node(s) that will be 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 needed for the template.

PARAMETER_DESCRIPTION

This parameter holds the explanatory text for an input field and always appears after PARAMETER_LABEL.

For example, the PARAMETER_DESCRIPTION for the input field labeled NCM Node 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 Parameters

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

 

Last modified
14:08, 3 Oct 2016

Tags

Classifications

Public