Cluster attributes

Table: Cluster attributes lists the cluster attributes.

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

AutoAddSystemtoCSG

(user-defined)

Indicates whether the newly joined or added systems in cluster become part of the SystemList of the ClusterService service group if the service group is configured. The value 1 (default) indicates that the new systems are added to SystemList of ClusterService. The value 0 indicates that the new systems are not added to SystemList of ClusterService.

  • Type and dimension: integer-scalar

  • Default: 1

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.

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

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 used for VCS notification. VCS sends notifications to persons designated in this attribute when an event occurs related to the cluster. 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 be sent to ClusterOwner or to at least one recipient defined in the SmtpRecipients attribute of the NotifierMngr agent.

  • Type and dimension: string-scalar

  • Default: ""

  • Example: "jdoe@example.com"

ClusterRecipients

(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 cluster 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 ClusterRecipients 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.

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

CounterMissAction

(user-defined)

Specifies the action that must be performed when the GlobalCounter is not updated for CounterMissTolerance times the CounterInterval. Possible values are LogOnly and Trigger. If you set CounterMissAction to LogOnly, the system logs the message in Engine Log and Syslog. If you set CounterMissAction to Trigger, the system invokes a trigger which has default action of collecting the comms tar file.

  • Type and dimension: string-scalar

  • Default: LogOnly

CounterMissTolerance

(user-defined)

Specifies the time interval that can lapse since the last update of GlobalCounter before VCS reports an issue. If the GlobalCounter does not update within CounterMissTolerance times CounterInterval, VCS reports the issue. Depending on the CounterMissAction.value, appropriate action is performed.

  • Type and dimension: integer-scalar

  • Default: 20

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 or dumping the configuration to disk.

  • Type and dimension: vector

  • Default: Not applicable.

EngineClass

(user-defined)

The scheduling class for the VCS engine (HAD).

The attribute can take the following values:

RT, TS

where RT = realtime and TS = timeshare. For information on the significance of these values, see the operating system documentation.

  • Type and dimension: string-scalar

  • Default: RT

EnableFFDC

(user-defined)

Enables or disables FFDC logging. By default, FFDC logging is enabled.

  • Type and dimension: boolean-scalar

  • Default: 1

EnableVMAutoDiscovery

(user-defined)

Enables or disables auto discovery of virtual machines. By default, auto discovery of virtual machines is disabled.

  • Type and dimension: integer-scalar

  • Default: 0

EnginePriority

(user-defined)

The priority in which HAD runs. Generally, a greater priority value indicates higher scheduling priority. A range of priority values is assigned to each scheduling class. For more information on the range of priority values, see the operating system documentation.

  • 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

FipsMode

(system use only)

Indicates whether FIPS mode is enabled for the cluster. The value depends on the mode of the broker on the system. If FipsMode is set to 1, FIPS mode is enabled. If FipsMode is set to 0, FIPS mode is disabled.

  • Type and dimension: integer -scalar

  • Default: Not applicable

You can verify the value of FipsMode as follows:

# haclus -value FipsMode

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

HostAvailableMeters

(System use only)

Lists the meters that are available for measuring system resources. You cannot configure this attribute in main.cf.

  • Type and dimension: string-association

    Keys are the names of parameters and values are the names of meter libraries.

  • Default: HostAvailableMeters = { CPU = "libmeterhost_cpu.so", Mem = "libmeterhost_mem.so", Swap = "libmeterhost_swap.so"}

HostMeters

(user-defined)

Indicates the parameters (CPU, Mem, or Swap) that are currently metered in the cluster.

  • Type and dimension: string-keylist

  • Default: HostMeters = {"CPU", "Mem", "Swap"}

    You can configure this attribute in main.cf. The keys must be one or more from CPU, Mem, and Swap. You cannot modify the value at run time.

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

LogClusterUUID

(user-defined)

Enables or disables logging of the cluster UUID in each log message. By default, cluster UUID is not logged.

  • Type and dimension: boolean-scalar

  • Default: 0

LogSize

(user-defined)

Indicates the size of engine log files in bytes.

Minimum value is = 65536 (equal to 64KB)

Maximum value = 134217728 (equal to 128MB)

  • Type and dimension: integer-scalar

  • Default: 33554432

MeterControl

(user-defined)

Indicates the intervals at which metering and forecasting for the system attribute AvailableCapacity are done for the keys specified in HostMeters.

  • Type and dimension: integer-association

    This attribute includes the following keys:

    • MeterInterval

      Frequency in seconds at which metering is done by the HostMonitor agent. The value for this key can equal or exceed 30. The default value is 120 indicating that the HostMonitor agent meters available capacity and updates the System attribute AvailableCapacity every 120 seconds. The HostMonitor agent checks for changes in the avaliable capacity for every monitoring cycle and when there is a change, the HostMonitor agent updates the values in the same monitoring cycle . The MeterInterval value applies only if Statistics is set to Enabled or MeterHostOnly.

    • ForecastCycle

      The number of metering cycles after which forecasting of available capacity is done. The value for this key can equal or exceed 1. The default value is 3 indicating that forecasting of available capacity is done after every 3 metering cycles. Assuming the default MeterInterval value of 120 seconds, forecasting is done after 360 seconds or 6 minutes. The ForecastCycle value applies only if Statistics is set to Enabled.

You can configure this attribute in main.cf. You cannot modify the value at run time. The values of MeterInterval and ForecastCycle apply to all keys of HostMeters.

MeterUnit

Represents units for parameters that are metered.

  • Type and dimension: string-association

  • Default: CPU=CPU, Mem = MB, Swap = MB}

You can configure this attribute in main.cf, if configured in main.cf then it must contain units for all the keys as specified in HostMeters. You cannot modify the value at run time.

When Statistics is set to Enabled then service group attribute Load, and the following system attributes are represented in corresponding units for parameters such as CPU, Mem or Swap:

  • AvailableCapacity

  • HostAvailableForecast

  • Capacity

  • ReservedCapacity

The values of keys such as Mem and Swap can be represented in MB or GB, and CPU can be represented in CPU, MHz or GHz.

MeterWeight

(user-defined)

Indicates the default meter weight for the service groups in the cluster. You can configure this attribute in main.cf but you cannot modify the value at run time. If the attribute is defined in main.cf, it must have at least one key defined. The weight for the key must be in the range of 0 to 10. Only keys from HostAvailableMeters are allowed in this attribute.

  • Type and dimension: integer-association

  • Default: {CPU = 10, Mem = 5, Swap=1}

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.

OpenExternalCommunicationPort

(user-defined)

Indicates whether communication over the external communication port for VCS is allowed or not. By default, the external communication port for VCS is 14141.

  • Type and dimension: string-scalar

  • Valid values: YES, NO

  • Default: YES

  • YES: The external communication port for VCS is open.

  • NO: The external communication port for VCS is not open.

Note:

When the external communication port for VCS is not open, RemoteGroup resources created by the RemoteGroup agent cannot access VCS.

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

PreferredFencingPolicy

The I/O fencing race policy to determine the surviving subcluster in the event of a network partition. Valid values are Disabled, System, Group, or Site.

Disabled: Preferred fencing is disabled. The fencing driver favors the subcluster with maximum number of nodes during the race for coordination points.

System: The fencing driver gives preference to the system that is more powerful than others in terms of architecture, number of CPUs, or memory during the race for coordination points. VCS uses the system-level attribute FencingWeight to calculate the node weight.

Group: The fencing driver gives preference to the node with higher priority service groups during the race for coordination points. VCS uses the group-level attribute Priority to determine the node weight.

Site: The fencing driver gives preference to the node with higher site priority during the race for coordination points. VCS uses the site-level attribute Preference to determine the node weight.

See About preferred fencing.

  • Type and dimension: string-scalar

  • Default: "Disabled"

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

(user-defined)

Enables creation of secure passwords, when the SecInfo attribute is added to the main.cf file with the security key as the value of the attribute.

  • Type and dimension: string-scalar

  • Default: ""

See Encrypting agent passwords.

SecInfoLevel

(user-defined)

Denotes the password encryption privilege level.

  • Type and dimension: string-scalar

  • Default: R

See Encrypting agent passwords.

SecureClus

(user-defined)

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

  • Type and dimension: boolean-scalar

  • Default: 0

SiteAware

(user-defined)

Indicates whether sites are configured for a cluster or not.

  • Type and dimension: boolean-scalar

  • Default: 0

    Possible values are:

    • 1: Sites are configured.

    • 0: Sites are not configured.

You can configure a site from Veritas Operations Manager. This attribute will be automatically set to 1 when configured using Veritas Operations Manager. If site information is not configured for some nodes in the cluster, those nodes are placed under a default site that has the lowest preference.

See Site attributes.

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.

Statistics

(user-defined)

Indicates if statistics gathering is enabled and whether the FailOverPolicy can be set to BiggestAvailable. You need to manually configure this attribute by adding Statistics = Enabled in the main.cf file.

  • Type and dimension: string-scalar

  • Default: Enabled

    You cannot modify the value at run time.

    Possible values are:

    • Enabled: The HostMonitor agent meters host utilization and forecasts the available capacity for the systems in the cluster. With this value set, FailOverPolicy for any service group cannot be set to Load.

    • MeterHostOnly: The HostMonitor agent meters host utilization but it does not forecast the available capacity for the systems in the cluster. The service group attribute FailOverPolicy cannot be set to BiggestAvailable.

    • Disabled: The HostMonitor agent is not started. Both metering of host utilization and forecasting of available capacity are disabled. The service group attribute FailOverPolicy cannot be set to BiggestAvailable.

See Service group attributes.

Stewards

(user-defined)

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

  • Type and dimension: string-keylist

  • {}

SystemRebootAction

(user-defined)

Determines whether frozen service groups are ignored on system reboot.

  • Type and dimension: string-keylist

  • Default: ""

If the SystemRebootAction value is IgnoreFrozenGroup , VCS ignores service groups that are frozen (TFrozen and Frozen) and takes the remaining service groups offline. If the frozen service groups have firm dependencies or hard dependencies on any other service groups which are not frozen, VCS gives an error.

If the SystemRebootAction value is "", VCS tries to take all service groups offline. Because VCS cannot be gracefully stopped on a node where a frozen service group is online, applications on the node might get killed.

Note:

The SystemRebootAction attribute applies only on system reboot and system shutdown.

TypeLimit

(user-defined)

Maximum number of resource types.

  • Type and dimension: integer-scalar

  • Default: 100

UseFence

(user-defined)

Indicates whether the cluster uses SCSI-3 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 use either.

  • Type and dimension: string-scalar

  • Default: NONE

UserNames

(user-defined)

List of VCS users. The installer 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 VCSMode 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

More Information

Scheduling automatic backups for VCS configuration files

About VCS event notification