<Parameter> element

The <Parameter> element defines a configuration parameter.

Syntax

The following attributes are supported:

Table 1. Attributes
Attribute	Required	Type	Description
name	yes	string	Specifies the name of the parameter. This name must be unique within a catalog.
value	no	string	Value of the parameter, if it is defined.
applyType	no	string	Specifies whether the runtime or next boot value of the parameter must be retrieved or set if no flag is specified. Default value is `runtime`.
reboot	no	boolean	When `true`, indicates that a reboot is required before a value change is effective. Default value is `false`.
readOnly	no	boolean	Specifies whether the value of the parameter cannot be set. Default: value is `false`.
disruptive	no	boolean	Specifies whether the method used to set the parameter implies disruptive constraints. Default value is `false`.
setDiscover	no	boolean	Specifies whether the set method must be set to the value for all discovered instances of a target class. Default value is `false`.

The following child elements are supported

Table 2. Child Elements
Child element	Required	Number	Description
<Value>	no	0 - 1	Value of the parameter.
<Target>	no	0 - any	Target to which the parameter applies.
<Description>	no	0 - 1	Description of the parameter.
<Property>	no	0 - any	Property of the parameter.

Attributes

Table 3. Attributes
Attribute	Description
name	The name of the parameter is the only required attribute of the <Parameter> element. Along with the catalog name specified in the parent <Catalog> element, the parameter name uniquely identifies a parameter definition in the catalog file.
value	The value of the parameter can be specified either as an attribute or as a child element.
applyType	The applyType attribute can take the values `runtime` (the default value) or `nextboot`. This attribute determines the command that is used to handle the parameter. For set operations, applyType=`runtime` indicates that the <Set type=“permanent”> command from the catalog file should be used to set the parameter. The applyType=`nextboot` indicates that the <Set type=“nextboot”> command should be used instead. For get operations, when the –p flag is used, applyType=`runtime` indicates that the <Get type=“current”> command from the catalog file must be used to obtain the parameter. The <applyType>=`nextboot` indicates that the <Get type=“nextboot”> command should be used instead. The applyType attribute must be set to `nextboot` if the reboot attribute is set to true.
reboot	This attribute has a default value of false. When set to true, it means that the system must be rebooted before any change to the parameter is effective. This attribute must match the reboot attribute defined in the corresponding <ParameterDef> element of the catalog file. When this attribute is set to true, the applyType attribute must be set to `nextboot`. When you set a parameter that has the reboot attribute set, a warning is displayed to the user, stating that a reboot operation is needed: `0590-206 A manual post-operation is required for the changes to take effect Please reboot the system` Only set the reboot attribute to true when a change to the parameter value will not be effective until after the next reboot.
readOnly	This attribute indicates that the value of the parameter can be read by the artexget command, but that it will not be set using the artexset command, nor taken into account in a comparison operation with live values by using the artexdiff commands. The default value is false. A few situations that can warrant setting the readOnly attribute to true follow: The parameter is static and its value cannot be modified (e.g. the memory_frames parameter in the vmo command). Access to the parameter is restricted and it is not recommended for the user to modify it in automatic procedures. In this case, the set configuration methods should be defined for this parameter in the catalog file, but a system administrator must remove manually the readOnly attribute from the profile to be able to set the parameter.
setDiscover	The setDiscover attribute, when set to true indicates that, when the artexset command is called with the –d flag, the discover command must be called to discover all instances of the target, and set all to the value stored in the profile. The setDiscover default value is false. A value of true only makes sense if the parameter has target classes defined in the catalog file. Do not specify this attribute when creating a sample profile. Advanced users must add this attribute manually when deemed necessary.

Other attributes

The type and disruptive attributes are informative attributes that are automatically set by the artextget command when it is called with the -i flag. Do not include these attributes when you are creating a sample profile.

Examples

The following example is an excerpt from the vmoProfile.xml sample catalog, showcasing the use of various optional attributes:

<Profile origin="reference" readOnly="true" version="2.0.0">
  <Catalog id="vmoParam" version="2.1">
    <Parameter name="nokilluid"/>
    <Parameter name="memory_frames" readOnly="true"/>
    <Parameter name="kernel_heap_psize" reboot="true" applyType="nextboot"/>
  </Catalog>
</Profile>

If you run the artexget –r command on the profile from example 1 the following profile is displayed:

<Profile origin="get" version="2.0.1" date="2011-03-24T13:41:01Z">
  <Catalog id="vmoParam" version="2.1">
    <Parameter name="nokilluid" value="0"/>
    <Parameter name="memory_frames" value="393216" readOnly="true"/>
    <Parameter name="kernel_heap_psize" value="4096" applyType="nextboot" reboot="true"/>
  </Catalog>
</Profile>

Related information

The Parameter values topic.

The <ParameterDef> element.