geohb - configure and manage the heartbeat mechanism
/usr/cluster/bin/geohb [subcommand] -?
/usr/cluster/bin/geohb -V
/usr/cluster/bin/geohb add-plugin plugin heartbeat -p property [-p…]
/usr/cluster/bin/geohb create -r cluster-list [-p property [-p…]] heartbeat
/usr/cluster/bin/geohb delete heartbeat
/usr/cluster/bin/geohb list
/usr/cluster/bin/geohb modify-plugin -p property [-p…] plugin heartbeat
/usr/cluster/bin/geohb remove-plugin plugin heartbeat
/usr/cluster/bin/geohb set-prop -p property [-p…] heartbeat …
/usr/cluster/bin/geohb show [heartbeat[,…]]
/usr/cluster/bin/geohb status [heartbeat[,…]]
The 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-paris as the requester and cluster-newyork as the responder. The other heartbeat has cluster-newyork as the requester and cluster-newyork as the responder.
The Oracle Solaris Cluster disaster recovery framework software (formerly called Geographic Edition) provides a default heartbeat mechanism that is based on the TCP/UDP plug-in as the primary plug-in and the ping plug-in as backup.
Run the geohb command on a cluster that has been enabled for partnership.
To run the geohb command to configure and manage the heartbeat mechanism, you must be assigned the proper rights profile.
If you have root access, you have permissions to perform any operation. If you do not have root access, the following rights apply:
Basic Solaris User. You can read information about Oracle Solaris Cluster disaster recovery framework entities by running commands such as geohb 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 create, geohb delete, and geoadm set-prop.
For more information, see the rbac(7) man page and Planning Security in Installing and Configuring the Disaster Recovery Framework for Oracle Solaris Cluster 4.4.
The general form of this command is as follows:
geohb [subcommand] [options] [operands]
You can omit subcommand only if options specifies the option –?, –o, –V, or –v.
Each option of this command has a long form and a short form. Both forms of each option are given with the description of the option in the OPTIONS section of this man page.
The following subcommands are supported:
Add a plug-in to an existing heartbeat. 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.
Create a heartbeat. You can monitor heartbeat status by running the geoadm(8) command. You must configure the remote cluster to make the heartbeat operational.
Delete a heartbeat.
List the heartbeats that are configured on the cluster.
Modify heartbeat plug-in properties.
Remove a plug-in from a heartbeat.
Modify heartbeat properties.
Display existing configuration information for one or more heartbeats. Use a comma-separated list to specify multiple heartbeats.
Display status information for one or more heartbeats. Use a comma-separated list to specify multiple heartbeats.
The following options are supported:
Displays help information.
You can specify this option without a subcommand or with a subcommand.
If you specify this option without a subcommand, the list of subcommands for this command is displayed.
If you specify this option with a subcommand, the usage options for the subcommand are displayed.
The question mark might be interpreted as a special character by some shells. Use quotes (–"?") or an escape character to avoid pattern matching.
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 values for these properties are assigned at creation and tunable at runtime.
See the EXTENDED DESCRIPTION section for currently defined properties.
Specifies the name of a remote cluster with which the local cluster should establish heartbeat monitoring.
Displays the version of the command.
Do not specify this option with subcommands, operands, or other options. The subcommands, operands, or other options are ignored. The –V option only displays the version of the command. No other operations are performed.
The following operands are supported:
Specifies an identifier for the heartbeat 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 name of the heartbeat plug-in.
The following sections list the heartbeat and heartbeat plug-in properties.
You can specify the following heartbeat property:
Specifies the frequency between heartbeat status requests in seconds. The plug-in enters emergency mode if three Query_interval periods pass without response. The plug-in times out and enters 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.
Minimum value: 20 seconds
Maximum value: 300 seconds
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/2084/ ipsec,remote-IP-address/TCP/2084/ 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 completed successfully, indicating that the remote cluster is alive.
An error has occurred, meaning that the remote cluster did not respond to the heartbeat check.
The following geohb command creates a heartbeat that is named paris-to-newyork, which communicates between the local cluster and the cluster cluster-newyork.
# geohb create -r cluster-newyork paris-to-newyorkExample 2 Creating a Heartbeat Plug-in
The following geohb command creates a heartbeat plug-in that is named command1 for the heartbeat paris-to-newyork.
# geohb add-plugin command1 -p Query_cmd=/usr/bin/hb paris-to-newyorkExample 3 Modifying a Heartbeat
The following geohb command modifies the properties for the default heartbeat between cluster-paris and cluster-newyork.
# geohb set-prop -p Query_interval=60 hb_cluster-paris~cluster-newyorkExample 4 Deleting a Plug-in From a Heartbeat
The following geohb command deletes the plug-in that is named command1, from the heartbeat that is named paris-to-newyork.
# geohb remove-plugin command1 paris-to-newyork
See attributes(7) for descriptions of the following attributes.
|