geops(1M) (Sun Cluster Geographic Edition Reference Manual)

Sun Cluster Geographic Edition Reference Manual

geops(1M)

NAME

geops – create, configure, and manage partnerships between clusters

SYNOPSIS

/usr/cluster/bin/geops [subcommand] -?

/usr/cluster/bin/geops -V

/usr/cluster/bin/geops add-trust -c remotepartnerclustername

/usr/cluster/bin/geops create -c remotepartnerclustername
 partnershipname [-h heartbeatname] [-p property [,...]]

/usr/cluster/bin/geops join-partnership remoteclustername
 partnershipname [-h heartbeatname]

/usr/cluster/bin/geops leave-partnership partnershipname

/usr/cluster/bin/geops list partnershipname

/usr/cluster/bin/geops remove-trust -c remotepartnerclustername

/usr/cluster/bin/geops set-prop partnershipname
  -p property [,...]

/usr/cluster/bin/geops update partnershipname

/usr/cluster/bin/geops verify-trust [-c remotepartnerclustername]

Description

The geops command enables you to create, configure, and manage the partnerships that are defined between clusters. A partnership is a pair of clusters that define a cluster infrastructure on which an application might be protected against disaster.

Two clusters must be configured to trust each other before you create a partnership between two clusters.

A partnership requires a running heartbeat between clusters. Partner clusters monitor each other with heartbeats.

The Sun Cluster Geographic Edition software notifies all remote partners of changes in the partnership configuration.

Run the geops command on a cluster that has been enabled for partnership.

To run the geops command to create, configure, and manage the partnerships, 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 running commands such as geopg 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 create, geopg switchover, geoadm start, and geoadm stop.

Note –

You must have root access to run the following subcommands:

geops add-trust
geops remove-trust
geops verify-trust

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.

The general form of this command is as follows:

geops [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.

SUBCOMMANDS

The following subcommands are supported:

add-trust

Retrieve public keys of a remote cluster and add the keys to the truststore file on every node of the local cluster. The truststore file is at /etc/cacao/instances/default/security/jsse/truststore.

The new key is not added to the truststore file if an entry with the same alias already exists in the truststore file on a node. If the existing entry contains a key that is different from the new key, you must delete the entry from the truststore file before you add the new key.

create

Create a partnership between the local cluster and a remote cluster. The two clusters must be configured to trust each other.

join-partnership

Enable the local cluster to join an existing partnership.

Running the geops join-partnership command on a cluster that is already a member of a partnership causes the partnership configuration from the remote cluster to overwrite the partnership configuration of the local cluster.

leave-partnership

Remove the local cluster from a partnership. This subcommand deletes the partnership when the last participating cluster in the partnership leaves.

list

Display partnership configuration information.

remove-trust

Remove all keys for the remote cluster from the truststore file on the local node. You must remove all keys for the remote cluster from the local host before you can add a new key.

To remove a key from a cluster, dissolve the partnership between the two clusters (by running geops leave on each cluster) and run the remove-trust subcommand from each node of the cluster.

set-prop

Modify the properties of a partnership. This subcommand updates the local cluster configuration and notifies remote partner clusters of the configuration change.

update

Synchronize information with the partner cluster. The geops update command overwrites the configuration on the local cluster with the configuration from the remote partner cluster.

This subcommand cannot update a partnership while the cluster is disconnected from the partner cluster.

If the remote partner cluster is down, modifications to the local cluster might not be propagated to the remote partner cluster.

verify-trust

Retrieve node information on the remote cluster and establish a secure Java Management Extensions (JMX) connection from the local host to every node of the remote cluster. The verify-trust subcommand verifies that the certificates have been exchanged properly between the remote and the local clusters.

If you do not specify a remote cluster, the verify-trust subcommand verifies the connections between the local host and other nodes of the local cluster.

Options

The following options are supported:

-? --help

Displays help information. When this option is used, no other processing is performed.

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.

-c remoteclustername --cluster remoteclustername

Specifies the logical hostname of the cluster with which to form a partnership. The logical hostname is used by the Sun Cluster Geographic Edition software and maps to the name of the remote partner cluster. For example, a remote partner cluster name might resemble the following:

cluster-paris

When you use this option with the add-trust, remote-trust, or verify-trust subcommand, the option specifies the alias where the public keys on the remote cluster are stored. An alias for certificates on the remote cluster must have the following pattern:

remotepartnercluster.certificate[0-9]*

Keys and only keys that belong to the remote cluster should have their alias match this pattern.

Note –

The remove-trust subcommand removes only keys you have added with the add-trust subcommand, and keys with an alias that matches the following pattern:

remotepartnercluster.certificate[0-9]*.

-h heartbeatname --heartbeat-name heartbeatname

Specifies an identifier for the heartbeat on a partner cluster that the local cluster can use to monitor partner availability. You must create the heartbeat by running the geohb command before you specify the heartbeat in the geops command.

If this option is omitted, the Sun Cluster Geographic Edition software uses the default heartbeat mechanism between member clusters.

-p property --property property

Specifies the value of partnership properties. You can specify multiple properties at one time by using multiple statements.

See the EXTENDED DESCRIPTION section for a description of the properties.

-V --version

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.

Operands

The following operand is supported:

partnershipname: Specifies the name of the partnership

Extended Description

The following section lists the partnership properties. These properties are set at creation and tunable at runtime.

Partnership Properties

Description

Describes the partnership.

Optional property.

Type: String.

Default value: Empty string.

Notification_ActionCmd

Specifies the path to the script or command that is triggered when a heartbeat-loss notification is issued.

Optional property.

Type: String.

Default value: Empty string.

The Sun Cluster Geographic Edition software enables you to specify a command to run when a heartbeat-loss notification is issued. You can specify the path to the command by using the Notification_ActionCmd property. The command runs with root permissions, so the file must have root ownership and execution permissions. If both Notification_ActionCmd and Notification_EmailAddrs properties have been configured, an email is sent after the command that is specified in the Notification_ActionCmd property is run.

Caution –

A heartbeat loss indicates only a lost connection to a remote cluster and not the cause for the lost connection. A remote cluster that has lost a heartbeat connection might still be functioning even though the heartbeat monitoring has lost its connection.

Therefore, you must exercise caution in the script you specify for the Notification_actioncmd parameter. For example, if you specify a forced takeover or a switchover in the Notification_actioncmd script, a takeover or a switchover might be run even though one might not be necessary.

Notification_EmailAddrs

Specifies the email address to send messages to when a heartbeat-loss notification is issued. You can specify multiple email addresses by separating each email address with a comma.

Optional property.

Type: String array.

Default value: Empty string.

The Notification_EmailAddrs and the Notification_ActionCmd properties enable notification in heartbeat-loss events. Heartbeat-loss events are detected locally on each cluster of the partnership, and the notification is triggered locally on the cluster where the event is detected. The email addresses and the notification action path should be valid on each cluster in the partnership.

Exit Status

The following exit values are returned:

0: The command completed successfully.
nonzero: An error has occurred.

Examples

Example 1 Adding Trust Between Two Clusters

The following geops commands add trust between the clusters cluster-paris and cluster-newyork.

Add cluster cluster-newyork to the trust on the cluster cluster-paris.
cluster-paris# /usr/cluster/bin/geops add-trust -c cluster-newyork
Keys are stored on every node of cluster cluster-paris with alias cluster-newyork.certificatenumber.

Add cluster cluster-paris to the trust on the cluster cluster-newyork.

cluster-newyork# /usr/cluster/bin/geops add-trust -c cluster-paris

Verify trust between the two clusters.

cluster-paris# /usr/cluster/bin/geops verify-trust -c cluster-newyork

cluster-newyork# /usr/cluster/bin/geops verify-trust -c cluster-paris

Example 2 Creating a Partnership

The following geops command creates the partnership paris-newyork-ps, on the cluster cluster-paris.

cluster-paris# geops create -c cluster-newyork -p Description=Transatlantic \
-p Notification_emailaddrs=sysadmin@companyX.com paris-newyork-ps

Example 3 Joining a Partnership

The following geops command joins cluster-paris and cluster-newyork in the paris-newyork-ps partnership.

cluster-paris# geops join-partnership cluster-newyork paris-newyork-ps

Example 4 Modifying a Partnership

The following geops command modifies the notification email address for cluster-paris.

cluster-paris# geops set-prop -p Notification_emailaddrs=operations@companyX.com \
paris-newyork-ps

Example 5 Leaving a Partnership

The following geops command removes the cluster cluster-paris from the partnership paris-newyork-ps.

cluster-paris# geops leave-partnership paris-newyork-ps

Example 6 Resynchronizing a Partnership

The following geops command resynchronizes the partnership paris-newyork-ps.

The geops update command overwrites the configuration on the local cluster with the configuration from the remote partner cluster.

# geops update paris-newyork-ps

Attributes

See attributes(5) for descriptions of the following attributes.

ATTRIBUTE TYPE	ATTRIBUTE VALUE
Availability	SUNWscgctl
Interface Stability	Evolving

geops(1M)

NAME

SYNOPSIS

Description

SUBCOMMANDS

Options

Operands

Extended Description

Partnership Properties

Exit Status

Examples

Example 1 Adding Trust Between Two Clusters

Example 2 Creating a Partnership

Example 3 Joining a Partnership

Example 4 Modifying a Partnership

Example 5 Leaving a Partnership

Example 6 Resynchronizing a Partnership

Attributes

See Also