NAME | SYNOPSIS | DESCRIPTION | SUBCOMMANDS | OPTIONS | EXTENDED DESCRIPTION | EXIT STATUS | ATTRIBUTES | SEE ALSO
Associating a new plug-in to a heartbeat.
geohb add-plugin heartbeat-name plugin-name --property property-setting [--property...]Creating a heartbeat mechanism.
geohb create heartbeat-name --remote-cluster cluster-list [--property property-setting] [--property...]Deleting a heartbeat.
geohb delete heartbeat-namePrinting heartbeat configuration.
geohb list heartbeat-name ...Changing the configuration on a heartbeat or heartbeat plug-in.
geohb modify-plugin heartbeat-name plugin-name --property property-setting [--property...]Removing a heartbeat plug-in.
geohb remove-plugin heartbeat-name plugin-nameChanging the properties of a heartbeat.
geohb set-prop heartbeat-name --property property-setting [--property...]Printing version information.
geohb --versionDisplaying help information.
geohb --helpThe geohb command enables you to configure and manage the heartbeat mechanism.
A heartbeat is a monitor between two clusters: a requester cluster and a responder cluster. Creating a partnership establishes two heartbeats, one in each direction. For example, a partnership between a primary cluster, cluster-paris, and a secondary cluster, cluster-newyork, contains two heartbeats. One heartbeat has cluster cluster-paris as the requester and cluster cluster-newyork as the responder. The other heartbeat has cluster cluster-newyork as the requester and cluster cluster-newyork as the responder.
The Sun Cluster Geographic Edition software provides a default heartbeat mechanism that is based on the TCP/UDP plug-in as the primary source and the ping plug-in as backup. The geohb command enables you to configure and maintain heartbeats. You can perform the following tasks:
Configuring a heartbeat between clusters that participate in a partnership. Configuring a heartbeat includes the configuration of associated plug-ins.
Creating or deleting a heartbeat setting.
Adding, modifying, and removing plug-ins that are associated with a heartbeat setting.
Retrieving the current configuration of a heartbeat and its associated plug-ins.
Use the geohb command on a cluster that has been enabled for partnership.
To use the geohb command to configure and manage the heartbeat mechanism, you must be assigned the proper role-based access control (RBAC) rights profile.
If you have root access, you have permissions to perform any operation. If you do not have root access, the following RBAC rights apply:
Basic Solaris User. You can read information about Sun Cluster Geographic Edition entities by using commands such as geoadm list, geohb list, and geops list.
Geo Management. You can perform all the read operations that someone with Basic Solaris User access can perform. You can also perform administrative and configuration tasks such as geohb add, geopg switchover, geoadm start, and geoadm stop.
For more information, see the rbac(5) man page and “Sun Cluster Geographic Edition Software and RBAC” in Sun Cluster Geographic Edition System Administration Guide.
To create a heartbeat that is named paris-to-newyork, use the following:
# geohb create paris-to-newyork -r cluster-newyork |
To create a heartbeat plug-in that is named command1, use the following:
# geohb add paris-to-newyork -g command1 -p Query_cmd=/usr/bin/hb/ |
Subcommands specify the actions that are performed by the command. Only one subcommand is allowed on the command line.
The following subcommands are supported:
Associates a heartbeat with a plug-in. If you specify a custom plug-in, you must also specify the path to your custom plug-in command by using the Query_cmd property.
Creates a heartbeat. You can monitor heartbeat status by using the geoadm(1M) command. You must configure the remote cluster to make the heartbeat operational.
Deletes a heartbeat.
Displays existing configuration information.
Modifies heartbeat plug-in properties.
Removes a heartbeat plug-in.
Modifies heartbeat properties.
The following options are supported:
Specifies an identifier for the heartbeat setting on the local cluster. If you are trying to create a new heartbeat, and the specified identifier already exists, the geohb create command fails.
Specifies the properties of a heartbeat or heartbeat plug-in.
A heartbeat property is assigned a value by using a name=statement pair. Multiple properties might be set at one time by using multiple statements.
The value for these properties are assigned at creation and tunable at runtime.
See the EXTENDED DESCRIPTION section for currently defined properties.
Specifies the name of the heartbeat plug-in.
Specifies the name of a remote cluster with which the local cluster should establish heartbeat monitoring.
Displays version information. This option stops interpretation of subsequent arguments.
Displays help information. This option stops interpretation of subsequent arguments.
The question mark might be interpreted as a special character by some shells. Use quotes (-"?") or an escape character to avoid pattern-matching.
The following sections list the heartbeat and heartbeat plug-in properties.
You can specify the following heartbeat property:
Specifies the delay in seconds between heartbeat status requests. The plug-in will enter emergency mode if three Query_interval periods pass without response. The plug-in times out and goes into error mode if a further Query_interval period passes with no response.
Optional property.
Type: Integer.
Tuning recommendations: The value of this property is assigned at creation and tunable at runtime.
Default value: 120 seconds.
Heartbeat plug-in properties determine how a heartbeat functions.
Specifies a property string that is specific to the plug-in.
Optional property.
Type: String.
Tuning recommendations: The value of this property is assigned at creation and tunable at runtime.
Default value: None except for heartbeats that use the default heartbeat plug-ins, tcp_udp_plugin and ping-plugin.
For the tcp_udp_plugin plug-in, the format of this string is predefined as remote_IP_address/UDP/8765[[/ipsec]],remote_IP_address/TCP/8765[[/ipsec]]. The remote_IP_address argument specifies the IP address of the partner cluster. The optional /ipsec string indicates that the plug-in uses IPsec.
For the ping-plugin, the format of this string is predefined as remote_IP_address, where remote_IP_address specifies the IP address of the partner cluster.
Specifies the path to the command for a heartbeat status request.
Required property if the plug-in does not specify a predefined plug-in.
Type: String.
Tuning recommendations: The value of this property is assigned at creation and tunable at runtime.
Default value: None.
Specifies the absolute path to requester agent.
Optional property.
Type: String.
Tuning recommendations: The value of this property for the default plug-in should not be tuned except for testing purposes.
Default value: None.
Specifies the absolute path to the responder agent.
Optional property.
Type: String.
Tuning recommendations: The value of this property for the default plug-in should not be tuned except for testing purposes.
Default value: None.
Specifies the type of plug-in. Set to either Primary or Backup.
Required property.
Type: Enum.
Tuning recommendations: The value of this property is assigned at creation and tunable at runtime.
Default value: None, except for heartbeats with default heartbeat name ping_plugin. In this case, the default value is Backup.
The following exit values are returned:
The command executed successfully, indicating that the remote cluster is alive.
An error has occurred, meaning that the remote cluster did not respond to the heartbeat check.
See attributes(5) for descriptions of the following attributes:
ATTRIBUTE TYPE |
ATTRIBUTE VALUE |
---|---|
Architecture |
SPARC |
Availability |
SUNWscgctl |
Interface Stability |
Evolving |
NAME | SYNOPSIS | DESCRIPTION | SUBCOMMANDS | OPTIONS | EXTENDED DESCRIPTION | EXIT STATUS | ATTRIBUTES | SEE ALSO