Attribute argument details

The agent's attribute information is described by several arguments. The following table describes them. Refer also to the previous XML file example for the FileOnOff agent and see how the PathName attribute information is included in the file.

Table: Description of attribute argument details in XML file

Argument

Description

type

Possible values for attribute type, such as "str" for strings.

See Attribute data types.

dimension

Values for the attribute dimension, such as "Scalar;"

See About attributes.

editable

Possible Values = "True" or "False"

Indicates if the attribute is editable or not. In most cases, the resource attributes are editable.

important

Possible Values = "True" or "False"

Indicates whether or not the attribute is important enough to display. In most cases, the value is True.

mustconfigure

Possible Values = "True" or "False"

Indicates whether the attribute must be configured to bring the resource online. The GUI displays such attributes with a special indication.

If no value is specified for an attribute where the mustconfigure argument is true, the resource state becomes "UNKNOWN" in the first monitor cycle. Example of such attributes are Address for the IP agent, Device for the NIC agent, and FsckOpt for the Mount agent).

unique

Possible Values = "True" or "False"

Indicates if the attribute value must be unique in the configuration; that is, whether or not two resources of same resource type may have the same value for this attribute. Example of such an attribute is Address for the IP agent. Not used in the GUI.

persistent

Possible Values = "True". This argument should always be set to "True"; it is reserved for future use.

range

Defines the acceptable range of the attribute value. GUI or any other client can use this value for attribute value validation.

Value Format: The range is specified in the form {a,b} or [a,b]. Square brackets indicate that the adjacent value is included in the range. The curly brackets indicate that the adjacent value is not included in the range. For example, {a,b] indicates that the range is from a to b, contains b, and excludes a. In cases where the range is greater than "a" and does not have an upper limit, it can be represented as {a,] and, similarly, as {,b] when there is no minimum value.

default

It indicates the default value of attribute

displayname

It is used by GUI or clients to show the attribute in user friendly manner. For example, for FsckOpt its value could be "fsck option".