N1 Service Provisioning System 4.1 Reference Guide

The param Element

The <param> element is a child of the <paramList> element and is used to declare a parameter including name and default value. The default value is used only if the caller does not explicitly pass a value for this parameter. If the default value is unspecified and the caller does not explicitly pass a value for this parameter, a preflight error is raised at plan runtime.

The param element includes optional prompt and displayMode attributes for use when the containing install/uninstall/control block is invoked directly by the client rather than from a plan or another component.

param Element attributes

Name	Type	Required	Configurable	Description
name	identifier	Yes	No	The name of the parameter. The name must be unique among every other local variable and parameter declared by the enclosing element.
prompt	String	No	No	The UI text to display when prompting for the value of the parameter. If unspecified, name is used by default.
default	String	No	Yes	The default value of the parameter, which may include references to component variables, target host attributes, and installed component variables, but not other parameters.
display Mode	One of: PASSWORD CLEAR BOOLEAN	No	No	The display mode of the parameter. If unspecified, CLEAR is used by default. If PASSWORD, the client-entered value will be hidden (e.g. not shown or replaced with ***). If BOOLEAN, the parameter is entered using a checkbox. Otherwise if CLEAR or BOOLEAN, it is safe for the value to be displayed as entered.