Cluster attributes

Cluster attributes lists the cluster attributes.

Cluster attributes

Cluster Attributes

Definition

AdministratorGroups 

(user-defined) 

List of operating system user account groups that have administrative privileges on the cluster.  

This attribute applies to clusters running in secure mode.  

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

Administrators 

(user-defined) 

Contains list of users with Administrator privileges.  

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

AutoStartTimeout 

(user-defined) 

If the local cluster cannot communicate with one or more remote clusters, this attribute specifies the number of seconds the VCS engine waits before initiating the AutoStart process for an AutoStart global service group. 

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

BackupInterval 

(user-defined) 

Time period in minutes after which VCS backs up the configuration files if the configuration is in read-write mode.  

The value 0 indicates VCS does not back up configuration files. Set this attribute to at least 3.  

See Scheduling automatic backups for VCS configuration files

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

CID 

(system defined) 

The CID provides universally unique identification for a cluster.  

VCS populates this attribute once the engine passes an hacf-generated snapshot to it. This happens when VCS is about to go to a RUNNING state from the LOCAL_BUILD state.  

Once VCS receives the snapshot from the engine, it reads the file /etc/vx/.uuids/clusuuid file. VCS uses the file's contents as the value for the CID attribute. The clusuuid file's first line must not be empty. If the file does not exists or is empty VCS then exits gracefully and throws an error. 

A node that joins a cluster in the RUNNING state receives the CID attribute as part of the REMOTE_BUILD snapshot. Once the node has joined completely, it receives the snapshot. The node reads the file /etc/vx/.uuids/clusuuid to compare the value that it received from the snapshot with value that is present in the file. If the value does not match or if the file does not exist, the joining node exits gracefully and does not join the cluster. 

To populate the /etc/vx/.uuids/clusuuid file, run the /opt/VRTSvcs/bin/uuidconfig.pl utility. 

See Configuring and unconfiguring the cluster UUID value  

See About the cluster UUID 

You cannot change the value of this attribute with the haclus -modify command.  

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

ClusState 

(system use only) 

Indicates the current state of the cluster. 

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

ClusterAddress 

(user-defined) 

Specifies the cluster's virtual IP address (used by a remote cluster when connecting to the local cluster). 

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

ClusterLocation 

(user-defined) 

Specifies the location of the cluster. 

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

ClusterName 

(user-defined) 

The name of cluster. 

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

ClusterOwner 

(user-defined) 

This attribute is used for VCS notification; specifically, VCS sends notifications to persons designated in this attribute when an event occurs related to the cluster.  

SeeAbout VCS event notification

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

ClusterTime 

(system use only) 

The number of seconds since January 1, 1970. This is defined by the lowest node in running state.  

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

ClusterUUID 

(system use only) 

Unique ID assigned to the cluster by Availability Manager. 

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

CompareRSM 

(system use only) 

Indicates if VCS engine is to verify that replicated state machine is consistent. This can be set by running the hadebug command. 

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

ConnectorState 

(system use only) 

Indicates the state of the wide-area connector (wac). If 0, wac is not running. If 1, wac is running and communicating with the VCS engine. 

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

CounterInterval 

(user-defined) 

Intervals counted by the attribute GlobalCounter indicating approximately how often a broadcast occurs that will cause the GlobalCounter attribute to increase.  

The default value of the GlobalCounter increment can be modified by changing CounterInterval. If you increase this attribute to exceed five seconds, consider increasing the default value of the ShutdownTimeout attribute. 

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

CredRenewFrequency 

(user-defined) 

The number of days after which the VCS engine renews its credentials with the authentication broker. For example, the value 5 indicates that credentials are renewed every 5 days; the value 0 indicates that credentials are not renewed.  

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

DeleteOnlineResource 

(user-defined) 

Defines whether you can delete online resources. Set this value to 1 to enable deletion of online resources. Set this value to 0 to disable deletion of online resources.  

You can override this behavior by using the -force option with the hares -delete command. 

  • Type and dimension: integer-scalar
  • Default = 1

DumpingMembership 

(system use only) 

Indicates that the engine is writing to disk. 

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

EngineClass 

(user-defined) 

The scheduling class for the VCS engine (HAD). 

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

EnginePriority 

(user-defined) 

The priority in which HAD runs. 

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

EngineShutdown 

(user-defined) 

Defines the options for the hastop command. The attribute can assume the following values: 

Enable—Process all hastop commands. This is the default behavior.  

Disable—Reject all hastop commands.  

DisableClusStop—Do not process the hastop -all command; process all other hastop commands.  

PromptClusStop—Prompt for user confirmation before running the hastop -all command; process all other hastop commands. 

PromptLocal—Prompt for user confirmation before running the hastop -local command; reject all other hastop commands. 

PromptAlways—Prompt for user confirmation before running any hastop command. 

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

GlobalCounter 

(system use only) 

This counter increases incrementally by one for each counter interval. It increases when the broadcast is received. 

VCS uses the GlobalCounter attribute to measure the time it takes to shut down a system. By default, the GlobalCounter attribute is updated every five seconds. This default value, combined with the 600-second default value of the ShutdownTimeout attribute, means if system goes down within 120 increments of GlobalCounter, it is treated as a fault. Change the value of the CounterInterval attribute to modify the default value of GlobalCounter increment. 

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

Guests 

(user-defined) 

List of operating system user accounts that have Guest privileges on the cluster.  

This attribute is valid clusters running in secure mode.  

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

GroupLimit 

(user-defined) 

Maximum number of service groups. 

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

HacliUserLevel 

(user-defined) 

This attribute has two, case-sensitive values: 

none-hacli is disabled for all users regardless of role. 

commandroot-hacli is enabled for root only. 

Note   The command haclus -modify HacliUserLevel can be executed by root only.

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

HostMonLogLvl 

(user-defined) 

Controls the behavior of the HostMonitor feature.  

Configure this attribute when you start the cluster. You cannot modify this attribute in a running cluster.  

This attribute has the following possible values: 

ALL-The HostMonitor daemon logs messages engine log and to the agent log. 

HMAgentLog-The HostMonitor daemon does not log messages to the engine log; the daemon logs messages to the HostMonitor agent log. 

DisableHMAgent-Disables the HostMonitor feature. 

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

LockMemory 

(user-defined)  

 

Controls the locking of VCS engine pages in memory. This attribute has the following values. Values are case-sensitive: 

all: Locks all current and future pages. 

current: Locks current pages. 

none: Does not lock any pages. 

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

LogSize 

(user-defined) 

Indicates the size of engine log file in bytes. 

Minimum value is = 65536 (equal to 64KB) 

Maximum value = 134217728 (equal to 128MB) 

Default value = 33554432 (equal to 32MB) 

  • Type and dimensions: integer -scalar
  • Default value = 33554432

Notifier 

(system use only) 

Indicates the status of the notifier in the cluster; specifically: 

State—Current state of notifier, such as whether or not it is connected to VCS. 

Host—The host on which notifier is currently running or was last running. Default = None 

Severity—The severity level of messages queued by VCS for notifier. Values include Information, Warning, Error, and SevereError. Default = Warning 

Queue—The size of queue for messages queued by VCS for notifier. 

  • Type and dimension: string-association
  • Default: Different values for each parameter.

OperatorGroups 

(user-defined) 

List of operating system user groups that have Operator privileges on the cluster.  

This attribute is valid clusters running in secure mode.  

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

Operators 

(user-defined) 

List of users with Cluster Operator privileges.  

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

PanicOnNoMem 

(user-defined) 

  • Indicate the action that you want VCS engine (HAD) to take if it cannot receive messages from GAB due to low-memory.
  • If the value is 0, VCS exits with warnings. If the value is 1, VCS calls the GAB library routine to panic the system.
  • Default: 0

PrintMsg 

(user-defined) 

Enables logging TagM messages in engine log if set to 1. 

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

ProcessClass 

(user-defined) 

Indicates the scheduling class for processes created by the VCS engine. For example, triggers.  

  • Type and dimension: string-scalar
  • Default = TS

ProcessPriority 

(user-defined) 

The priority of processes created by the VCS engine, for example: triggers.  

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

ReadOnly 

(user-defined) 

Indicates that cluster is in read-only mode. 

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

ResourceLimit 

(user-defined) 

Maximum number of resources. 

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

SecInfo 

For future use. 

SecInfoLevel 

For future use. 

SecureClus 

(user-defined) 

Indicates whether the cluster runs in secure mode. The value 1 indicated the cluster runs in secure mode. This attribute cannot be modified when VCS is running. 

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

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: Not applicable.

Stewards 

(user-defined) 

The IP address and hostname of systems running the steward process. 

  • Type and dimension: string-keylist
  • Default: {}

TypeLimit 

(user-defined) 

Maximum number of resource types. 

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

UseFence 

(user-defined) 

Indicates whether the cluster uses I/O fencing.  

The value SCSI3 indicates that the cluster uses either disk-based or server-based I/O fencing; the value NONE indicates it does not. 

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

UserNames 

(user-defined) 

List of VCS users. 

Note   The installer program uses admin as the default user name.

  • Type and dimension: string-association
  • Default: {}

VCSFeatures 

(system use only) 

Indicates which VCS features are enabled. Possible values are:  

0—No features are enabled (VCS Simulator) 

1—L3+ is enabled 

2—Global Cluster Option is enabled 

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

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

VCSMode 

(system use only) 

Denotes the mode for which VCS is licensed. 

Even though the VCSFeatures is an integer attribute, when you query the value with the haclus -value command or the haclus -display command, it displays as the string UNKNOWN_MODE for value 0 and VCS for value 7. 

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

WACPort 

(user-defined) 

The TCP port on which the wac (Wide-Area Connector) process on the local cluster listens for connection from remote clusters. Type and dimension: integer-scalar 

  • Default: 14155