System attributes

System attributes lists the system attributes.

System attributes

System Attributes

Definition

AgentsStopped 

(system use only) 

This attribute is set to 1 on a system when all agents running on the system are stopped. 

  • Type and dimension: integer-scalar
  • Default: Not applicable

AvailableCapacity 

(system use only) 

Indicates system's available capacity when trigger is fired. If this value is negative, the argument contains the prefix % (percentage sign); for example, %-4. 

  • Type and dimension: integer-scalar
  • Default: Not applicable

Capacity 

(user-defined) 

Value expressing total system load capacity. This value is relative to other systems in the cluster and does not reflect any real value associated with a particular system. 

For example, the administrator may assign a value of 200 to a 16-processor machine and 100 to an 8-processor machine. 

  • Type and dimension: integer-scalar
  • Default: 100

ConfigBlockCount 

(system use only) 

Number of 512-byte blocks in configuration when the system joined the cluster. 

  • Type and dimension: integer-scalar
  • Default: Not applicable

ConfigCheckSum 

(system use only) 

Sixteen-bit checksum of configuration identifying when the system joined the cluster. 

  • Type and dimension: integer-scalar
  • Default: Not applicable

ConfigDiskState 

(system use only) 

State of configuration on the disk when the system joined the cluster. 

  • Type and dimension: integer-scalar
  • Default: Not applicable

ConfigFile 

(user-defined) 

Directory containing the configuration files. 

  • Type and dimension: string-scalar
  • Default: ""

ConfigInfoCnt 

(system use only) 

The count of outstanding config_info messages the local node expects from a new membership message. This attribute is non-zero for the brief period during which new membership is processed. When the value returns to 0, the state of all nodes in the cluster is determined. 

  • Type and dimension: integer-scalar
  • Default: Not applicable

ConfigModDate 

(system use only) 

Last modification date of configuration when the system joined the cluster. 

  • Type and dimension: integer-scalar
  • Default: Not applicable

CPUUsage 

(system use only) 

Indicates the system's CPU usage by CPU percentage utilization. This attribute's value is valid if the Enabled value in the CPUUsageMonitoring attribute (below) equals 1. The value of this attribute is updated when there is a change of five percent since the last indicated value. 

  • Type and dimension: integer-scalar
  • Default: Not applicable

CPUUsageMonitoring 

Monitors the system's CPU usage using various factors. 

The values for ActionTimeLimit and NotifiyTimeLimt represent the time in seconds. The values for ActionThreshold and NotifyThreshold represent the threshold in terms of CPU percentage utilization. 

See Monitoring CPU usage

  • Type and dimension: string-association
  • Default: Enabled = 0, NotifyThreshold = 0, NotifyTimeLimit = 0, ActionThreshold = 0, ActionTimeLimit = 0, Action = NONE.

CurrentLimits 

(system use only) 

System-maintained calculation of current value of Limits.  

CurrentLimits = Limits - (additive value of all service group Prerequisites). 

  • Type and dimension: integer-association
  • Default: Not applicable

DiskHbStatus 

(system use only) 

Deprecated attribute. Indicates status of communication disks on any system.  

  • Type and dimension: string-association
  • Default: Not applicable

DynamicLoad 

(user-defined) 

System-maintained value of current dynamic load. The value is set external to VCS with the hasys -load command. 

  • Type and dimension: integer-scalar
  • Default: 0

EngineRestarted 

(system use only) 

Indicates whether the VCS engine (HAD) was restarted by the hashadow process on a node in the cluster. The value 1 indicates that the engine was restarted; 0 indicates it was not restarted. 

  • Type and dimension: boolean-scalar
  • Default: 0

Frozen 

(user-defined) 

Indicates if service groups can be brought online on the system. Groups cannot be brought online if the attribute value is 1. 

  • Type and dimension: boolean-scalar
  • Default: False

EngineVersion 

 

Specifies the major, minor, maintenance-patch, and point-patch version of VCS. 

The value of EngineVersion attribute is in hexa-decimal format. To retrieve version information: 

Major Version: EngineVersion >> 24 & 0xff Minor Version: EngineVersion >> 16 & 0xff Maint Patch : EngineVersion >> 8 & 0xff Point Patch : EngineVersion & 0xff

  • Type and dimension: integer-scalar
  • Default: Not applicable

GUIIPAddr 

(user-defined) 

Determines the local IP address that VCS uses to accept connections. Incoming connections over other IP addresses are dropped. If GUIIPAddr is not set, the default behavior is to accept external connections over all configured local IP addresses. 

See User privileges for CLI commands

  • Type and dimension: string-scalar
  • Default: ""

LicenseType 

(system use only) 

Indicates the license type of the base VCS key used by the system. Possible values are:  

0—DEMO 

1—PERMANENT 

2—PERMANENT_NODE_LOCK 

3—DEMO_NODE_LOCK 

4—NFR 

5—DEMO_EXTENSION 

6—NFR_NODE_LOCK 

7—DEMO_EXTENSION_NODE_LOCK 

  • Type and dimension: integer-scalar
  • Default: Not applicable

Limits 

(user-defined) 

An unordered set of name=value pairs denoting specific resources available on a system. Names are arbitrary and are set by the administrator for any value. Names are not obtained from the system. 

The format for Limits is:
Limits = { Name=Value, Name2=Value2}. 

  • Type and dimension: integer-association
  • Default: ""

LinkHbStatus 

(system use only) 

Indicates status of private network links on any system. 

  • Type and dimension: string-association
  • Default: Not applicable

LLTNodeId 

(system use only) 

Displays the node ID defined in the file /etc/llttab. 

  • Type and dimension: integer-scalar
  • Default: Not applicable

LoadTimeCounter 

(system use only) 

System-maintained internal counter of how many seconds the system load has been above LoadWarningLevel. This value resets to zero anytime system load drops below the value in LoadWarningLevel.  

  • Type and dimension: integer-scalar
  • Default: Not applicable

LoadTimeThreshold 

(user-defined) 

How long the system load must remain at or above LoadWarningLevel before the LoadWarning trigger is fired. If set to 0 overload calculations are disabled. 

  • Type and dimension: integer-scalar
  • Default: 600

LoadWarningLevel 

(user-defined) 

A percentage of total capacity where load has reached a critical limit. If set to 0 overload calculations are disabled. 

For example, setting LoadWarningLevel = 80 sets the warning level to 80 percent. 

The value of this attribute can be set from 1 to 100. If set to 1, system load must equal 1 percent of system capacity to begin incrementing the LoadTimeCounter. If set to 100, system load must equal system capacity to increment the LoadTimeCounter. 

  • Type and dimension: integer-scalar
  • Default: 80

MajorVersion 

(system use only) 

Major version of system's join protocol. 

  • Type and dimension: integer-scalar
  • Default: Not applicable

MinorVersion 

(system use only) 

Minor version of system's join protocol. 

  • Type and dimension: integer-scalar
  • Default: Not applicable

NoAutoDisable 

(system use only) 

When set to 0, this attribute autodisables service groups when the VCS engine is taken down. Groups remain autodisabled until the engine is brought up (regular membership). 

Setting this attribute to 1 bypasses the autodisable feature. 

  • Type and dimension: boolean-scalar
  • Default: 0

NodeId 

(system use only) 

System (node) identification specified in /etc/llttab. 

  • Type and dimension: integer-scalar
  • Default: Not applicable

OnGrpCnt 

(system use only) 

Number of groups that are online, or about to go online, on a system. 

  • Type and dimension: integer-scalar
  • Default: Not applicable

ShutdownTimeout 

(user-defined) 

Determines whether to treat system reboot as a fault for service groups running on the system. 

On many systems, when a reboot occurs the processes are stopped first, then the system goes down. When the VCS engine is stopped, service groups that include the failed system in their SystemList attributes are autodisabled. However, if the system goes down within the number of seconds designated in ShutdownTimeout, service groups previously online on the failed system are treated as faulted and failed over. 

If you do not want to treat the system reboot as a fault, set the value for this attribute to 0. 

  • Type and dimension: integer-scalar
  • Default: 120 seconds

SourceFile 

(user-defined) 

File from which the configuration was read. Always set to ./main.cf. Make sure the path exists on all nodes before configuring this attribute.  

  • Type and dimension: string-scalar
  • Default: ./main.cf

SysInfo 

(system use only) 

Provides platform-specific information, including the name, version, and release of the operating system, the name of the system on which it is running, and the hardware type. 

  • Type and dimension: string-scalar
  • Default: Not applicable

SysName 

(system use only) 

Indicates the system name. 

  • Type and dimension: string-scalar
  • Default: Not applicable

SysState 

(system use only) 

Indicates system states, such as running, faulted, exited, etc. 

  • Type and dimension: integer-scalar
  • Default: Not applicable

SystemLocation 

(user-defined) 

Indicates the location of the system. 

  • Type and dimension: string-scalar
  • Default: Not applicable

SystemOwner 

(user-defined) 

This attribute is used for VCS email notification and logging. VCS sends email notification to the person designated in this attribute when an event occurs related to the system. VCS also logs the owner name when an event occurs. 

  • Type and dimension: string-scalar
  • Default: "unknown".

TFrozen 

(user-defined) 

Indicates if a group can be brought online or taken offline. 

  • Type and dimension: boolean-scalar
  • Default: 0

TRSE 

(system use only) 

Indicates in seconds the time to Regular State Exit. Time is calculated as the duration between the events of VCS losing port h membership and of VCS losing port a membership of GAB. 

  • Type and dimension: integer-scalar
  • Default: Not applicable

UpDownState 

(system use only) 

This attribute has four values: 

0 (down): System is powered off, or GAB and LLT are not running on the system. 

1 (Up but not in cluster membership): GAB and LLT are running but the VCS engine is not. 

  • The system is recognized through disk heartbeat only.

2 (up and in jeopardy): The system is up and part of cluster membership, but only one network link (LLT) remains. 

3 (up): The system is up and part of cluster membership, and has at least two links to the cluster. 

  • Type and dimension: integer-scalar
  • Default: Not applicable

UserInt 

(user-defined) 

Stores a system's integer value. 

  • Type and dimension: integer-scalar
  • Default: 0

VCSFeatures 

(system use only) 

Indicates which VCS features are enabled. Possible values are:  

0—No features enabled (VCS Simulator) 

1—L3+ is enabled 

2—Global Cluster Option is enabled 

  • Type and dimension: integer-scalar
  • Default: Not applicable