Tag: <parameter>s - Connection Critical Configuration

!! note This configuration is now legacy and has been replaced by the :ref:tag-connection-parameter tag. Parameters tags are still used for task inputs.

Definition

The <parameter> tag is used for two purposes:

  • Defining connection critical parameters that the PxM Platform needs to know so that it can connect to a device.
  • Defining fixed and selection drop-down lists for use in custom user tasks.

The attributes of the <parameter> tag have slightly different means depending its use. This page describes using the <parameter> tag for connection critical parameters.

To see how to use the <parameter> tag for task input parameters see this page: :ref:tag-parameter-task-input

The tag sits inside a group tag of <parameters>. You can define multiple <parameters> tags to hold each parameter or you can add <parameter> tags to other existing <parameters> tags.

This tag has the following attributes:

Parameters

  • connectioncritical (yes, no) : This defines if the parameter must have a value entered before the Pxm Platform can make any connections to the device.

  • display_name (str) : This is the display string used in the Web Management Interface when presenting the parameter. When the parameter is a task input, it is not seen by any users running the task. The display name seen by the user running the task is set on the task input.

  • fieldname (ip, string, hostname, password) : The name of the parameter. This is used to link to this parameter from a task input or for connection critical, it is used by the connection proxy inside the PxM Platform.

  • fieldtype (ip, string, hostname, password) : This defines the compdef type of the parameter.

  • ondevice (yes, no) : This tells the PxM Platform whether the parameter is directly associated with a configuration parameter on a device. If the parameter is to be used as a task input then this value should be no.

  • ordering (int) : This sets the order in which the parameters are listed in the Web Management interface.

Connection critical parameters must be filled in, in order to provision a new device. When provisioning a new device, after you have selected the template the Test connection window is shown. This is where the values for the connection critical parameters are filled in. This window looks like this:

Provision connection critical parameters

Note

Some compdefs have default values that will appear in the parameters input box, like the ssh port of 22 shown above.

Example: Command Line Device

A typical connection critical configuration for a command line device, like a switch or a Linux server would be like this:

1
2
3
4
5
<parameters>
   <parameter connectioncritical='yes' display_name='Hostname' fieldname='hostname' fieldtype='hostname' ondevice='no' ordering='1'/>
   <parameter connectioncritical='yes' display_name='IP Address' fieldname='ip_address' fieldtype='ip' ondevice='no' ordering='2'/>
   <parameter connectioncritical='yes' display_name='SSH Port' fieldname='ssh_port' fieldtype='sshport' ondevice='no' ordering='3'/>
</parameters>

This would produce the connection critical input screen shown above.

Example: Web Interface Device

A device with a web interface would have a http or https port and would be defined like this:

1
2
3
4
5
<parameters>
   <parameter connectioncritical='yes' display_name='Hostname' fieldname='hostname' fieldtype='hostname' ondevice='no' ordering='1'/>
   <parameter connectioncritical='yes' display_name='IP Address' fieldname='ip_address' fieldtype='ip' ondevice='no' ordering='2'/>
   <parameter connectioncritical='yes' display_name='HTTPS Port' fieldname='https_port' fieldtype='httpsport' ondevice='no' ordering='3'/>
   </parameters>

Parent Tags

Child Tags

  • None