System attributes

Table: System attributes lists the system attributes.

Table: 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 the available capacity of the system.

The function of this attribute depends on the value of the cluster-level attribute Statistics. If the value of the Statistics is:

  • Enabled - Any change made to AvailableCapacity does not affect VCS behavior.

  • MeteringOnly or Disabled - This attribute is populated based on Capacity and DynamicLoad (system attributes) and Load (service group attribute) specified using the hasys -load command. The key for this value is Units.

You cannot configure this attribute in the main.cf file.

  • Type and dimension: float-association

  • Default: Not applicable

Capacity

(user-defined)

Represents total capacity of a system. The possible values are:

  • Enabled - The attribute Capacity is auto-populated by meters representing system capacity in absolute units. It has all the keys specified in HostMeters, such as CPU, Mem, and Swap. The values for keys are set in corresponding units as specified in the Cluster attribute MeterUnit.

    You cannot configure this attribute in the main.cf file if the cluster-level attribute Statistics is set to Enabled.

    If the cluster-level attribute Statistics is enabled, any change made to Capacity does not affect VCS behavior.

  • MeteringOnly or Disabled - Allows you to define a value for Capacity if the value of the cluster-level attribute Statistics is set to MeteringOnly or Disabled. This value is relative to other systems in the cluster and does not reflect any real value associated with a particular system. The key for this value is Units. The default value for this attribute is 100 Units.

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

    You can configure this attribute in the main.cf file and also modify the value at run time if Statistics is set to MeteringOnly or Disabled.

  • Type and dimension: float-association

  • Default: Depends on the value set for Statistics.

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

(system use only)

Directory containing the configuration files.

  • Type and dimension: string-scalar

  • Default: "/etc/VRTSvcs/conf/config"

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

CPUThresholdLevel

(user-defined)

Determines the threshold values for CPU utilization based on which various levels of logs are generated. The notification levels are Critical, Warning, Note, and Info, and the logs are stored in the file engine_A.log. If the Warning level is crossed, a notification is generated. The values are configurable at a system level in the cluster.

  • For example, the administrator may set the value of CPUThresholdLevel as follows:

  • CPUThresholdLevel={Critical=95, Warning=80, Note=75, Info=60}

  • Type and dimension: integer-association

  • Default: Critical=90, Warning=80, Note=70, Info=60

CPUUsage

(system use only)

This attribute is deprecated. VCS monitors system resources on startup.

CPUUsageMonitoring

This attribute is deprecated. VCS monitors system resources on startup.

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. When you specify the dynamic system load, VCS does not use the static group load.

  • Type and dimension: float-association

  • Default: "" (none)

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

EngineVersion

(system use only)

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

FencingWeight

(user-defined)

Indicates the system priority for preferred fencing. This value is relative to other systems in the cluster and does not reflect any real value associated with a particular system.

If the cluster-level attribute value for PreferredFencingPolicy is set to System, VCS uses this FencingWeight attribute to determine the node weight to ascertain the surviving subcluster during I/O fencing race.

See About preferred fencing.

  • Type and dimension: integer-scalar

  • Default: 0

Frozen

(system use only)

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: 0

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.

  • Type and dimension: string-scalar

  • Default: ""

HostAvailableForecast

(system use only)

Indicates the forecasted available capacities of the systems in a cluster based on the past metered AvailableCapacity.

The HostMonitor agent auto-populates values for this attribute, if the cluster attribute Statistics is set to Enabled. It has all the keys specified in HostMeters, such as CPU, Mem, and Swap. The values for keys are set in corresponding units as specified in the Cluster attribute MeterUnit.

You cannot configure this attribute in main.cf.

  • Type and dimension: float-association

  • Default: Not applicable

HostMonitor

(system use only)

List of host resources that the HostMonitor agent monitors. The values of keys such as Mem and Swap are measured in MB or GB, and CPU is measured in MHz or GHz.

  • Type and dimension: string-keylist

  • Default: { CPU, Mem, Swap }

HostUtilization

(system use only)

Indicates the percentage usage of the resources on the host as computed by the HostMonitor agent. This attribute populates all parameters specified in the cluster attribute HostMeters if Statistics is set to MeterHostOnly or Enabled.

  • Type and dimension: integer-association

  • Default: Not applicable

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.

Possible values include the following:

LinkHbStatus = { nic1 = UP, nic2 = DOWN }

Where the value UP for nic1 means there is at least one peer in the cluster that is visible on nic1.

Where the value DOWN for nic2 means no peer in the cluster is visible on nic2.

  • 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.

If the cluster-level attribute Statistics is enabled, any change made to LoadTimeCounter does not affect VCS behavior.

  • 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.

If the cluster-level attribute Statistics is enabled, any change made to LoadTimeThreshold does not affect VCS behavior.

  • 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.

If the cluster-level attribute Statistics is enabled, any change made to LoadWarningLevel does not affect VCS behavior.

  • Type and dimension: integer-scalar

  • Default: 80

MemThresholdLevel

(user-defined)

Determines the threshold values for memory utilization based on which various levels of logs are generated. The notification levels are Critical, Warning, Note, and Info, and the logs are stored in the file engine_A.log. If the Warning level is crossed, a notification is generated. The values are configurable at a system level in the cluster.

For example, the administrator may set the value of MemThresholdLevel as follows:

  • MemThresholdLevel={Critical=95, Warning=80, Note=75, Info=60}

  • Type and dimension: integer-association

  • Default: Critical=90, Warning=80, Note=70, Info=60

MeterRecord

(system use only)

Acts as an internal system attribute with predefined keys. This attribute is updated only when the Cluster attribute AdpativePolicy is set to Enabled.

  • Type and dimension: integer-association

  • Default: Not applicable

Possible keys are:

  • AvailableGC: Stores the value of the cluster attribute GlobalCounter when the HostMonitor agent updates the system attribute AvailableCapacity.

    If the value of AvailableGC for a system in running state is older than the last 24 values of the cluster attribute GlobalCounter it indicates:

    • Values are not updated at the required frequency by the HostMonitor agent.

    • Values of system attributes AvailableCapacity and HostUtilization are stale.

  • ForecastGC: Stores cluster attribute GlobalCounter value when system HostAvailableForecast attribute is updated.

    If the value of ForecastGC for a system in running state is older than the last 72 values of the cluster attribute GlobalCounter it indicates :

    • HostMonitor agent is not forecasting the available capacity at the required frequency.

    • The values of the system attribute HostAvailableForecast are stale.

    • If any of the running systems in SystemList have stale value in HostAvailableForecast when FailOverPolicy is set to BiggestAvailable, then VCS does not apply BiggestAvailable policy. Instead, it considers Priority as the FailOverPolicy.

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).

This attribute's value is updated whenever a node joins (gets into RUNNING state) or leaves the cluster. This attribute cannot be set manually.

  • 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

ReservedCapacity

(system use only)

Indicates the reserved capacity on the systems for service groups which are coming online and with FailOverPolicy is set to BiggestAvailable. It has all of the keys specified in HostMeters, such as CPU, Mem, and Swap. The values for keys are set in corresponding units as specified in the Cluster attribute MeterUnit.

  • Type and dimension: float-association

  • Default: Not applicable

When the service group completes online transition and after the next forecast cycle, ReservedCapacity is updated.

You cannot configure this attribute in main.cf.

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. Symantec recommends that you set this attribute depending on the average time it takes to shut down the system.

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: 600 seconds

SourceFile

(user-defined)

File from which the configuration is read. Do not configure this attribute in main.cf.

Make sure the path exists on all nodes before running a command that configures this attribute.

  • Type and dimension: string-scalar

  • Default: ./main.cf

SwapThresholdLevel

(user-defined)

Determines the threshold values for swap space utilization based on which various levels of logs are generated. The notification levels are Critical, Warning, Note, and Info, and the logs are stored in the file engine_A.log. If the Warning level is crossed, a notification is generated. The values are configurable at a system level in the cluster.

  • For example, the administrator may set the value of SwapThresholdLevel as follows:

  • SwapThresholdLevel={Critical=95, Warning=80, Note=75, Info=60}

  • Type and dimension: integer-association

  • Default: Critical=90, Warning=80, Note=70, Info=60

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: ""

SystemOwner

(user-defined)

Use this attribute 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. Note that while VCS logs most events, not all events trigger notifications.

Make sure to set the severity level at which you want notifications to SystemOwner or to at least one recipient defined in the SmtpRecipients attribute of the NotifierMngr agent.

  • Type and dimension: string-scalar

  • Default: ""

  • Example: "unknown"

SystemRecipients

(user-defined)

This attribute is used for VCS email notification. VCS sends email notification to persons designated in this attribute when events related to the system occur and when the event's severity level is equal to or greater than the level specified in the attribute.

Make sure to set the severity level at which you want notifications to be sent to SystemRecipients or to at least one recipient defined in the SmtpRecipients attribute of the NotifierMngr agent.

  • Type and dimension: string-association

  • email id: The e-mail address of the person registered as a recipient for notification.

    severity: The minimum level of severity at which notifications must be sent.

TFrozen

(user-defined)

Indicates whether a service group can be brought online on a node. Service group cannot be brought online if the value of this attribute is 1.

  • 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:

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

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

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

Up (3): 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 integer values you want to use. VCS does not interpret the value of this attribute.

  • 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

Even though VCSFeatures attribute is an integer attribute, when you query the value with the hasys -value command or the hasys -display command, it displays as the string L10N for value 1 and DR for value 2.

  • Type and dimension: integer-scalar

  • Default: Not applicable

More Information

User privileges for CLI commands