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

Sun Cluster Geographic Edition Reference Manual

geoadm(1M)

NAME

geoadm– enable or disable the Sun Cluster Geographic Edition infrastructure on the local cluster

SYNOPSIS

/usr/cluster/bin/geoadm

subcommand

-?

/usr/cluster/bin/geoadm

-V

/usr/cluster/bin/geoadm show

/usr/cluster/bin/geoadm start

/usr/cluster/bin/geoadm status

/usr/cluster/bin/geoadm stop

-f

-i

DESCRIPTION

The geoadm command enables or disables the Sun Cluster Geographic Edition infrastructure on the local cluster. You can also use this command to check whether the Sun Cluster Geographic Edition software is enabled on the cluster.

After installation, the Sun Cluster Geographic Edition product must be enabled by running the command geoadm start. This command enables the cluster to participate in partnerships and to host protection groups. The geoadm start command configures the highly available infrastructure that unlocks the Sun Cluster Geographic Edition module on the cluster.

The geoadm stop command stops the highly available infrastructure that leaves the Sun Cluster Geographic Edition module locked on the cluster. Run the geoadm stop command before you remove product packages.

Note –

The geoadm stop command can successfully disable the Sun Cluster Geographic Edition module on a cluster only under one condition. All local states of the protection groups in which the cluster is involved must be Offline or Unknown.

Running the geoadm start or the geoadm stop command on one node of the cluster affects the entire cluster.

To use the geoadm command to enable or disable the Sun Cluster Geographic Edition infrastructure, 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.

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:

geoadm [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:

show

Display whether the Sun Cluster Geographic Edition software is enabled on the cluster.

start

Configure and enable the Sun Cluster Geographic Edition infrastructure on the cluster.

status

Display the runtime status of the Sun Cluster Geographic Edition entities on the local cluster.

The Sun Cluster Geographic Edition software must be installed on the local cluster before you can run the status subcommand. You can run the status subcommand whether or not the cluster has been enabled for partnership.

The status subcommand displays the following information:

Whether the local cluster is enabled for partnership.
Whether the local cluster is involved in a partnership. If the cluster is involved in a partnership, the status subcommand lists all partnership members.
Heartbeat status.
Protection group status.
Status of ongoing transactions.

See the EXTENDED DESCRIPTION section for details about the possible values for each status.

stop

Disable the Sun Cluster Geographic Edition infrastructure and configuration on the cluster.

Caution –

All protection groups on the cluster must be in the Offline state to run the stop subcommand successfully.

The stop subcommand removes the cluster state and Sun Cluster Geographic Edition infrastructure resource groups on the cluster, but the stop subcommand does not remove data replication resource groups.

The Sun Cluster Geographic Edition infrastructure is enabled and configured again the first time you run the start subcommand after running the stop subcommand.

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.

-f --force

Indicates that you want to bypass the command confirmation questions while the Sun Cluster Geographic Edition infrastructure is being disabled.

-i --interactive

Indicates that you want to display the interactive command confirmation questions while the Sun Cluster Geographic Edition infrastructure is being disabled.

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

EXTENDED DESCRIPTION

The following sections list the status descriptions.

Partnership Status

Partnership status displays status for the local cluster only. The partnership status can be one of the following:

OK: The partner clusters are connected.
Error: The partner clusters are disconnected.

Synchronization Status

Synchronization status displays status for all the clusters in a partnership. The partnership synchronization status can be one of the following:

OK: The configuration is synchronized between partner clusters.
Error: The configuration on the partner clusters is different. You must synchronize the partnership again.
Mismatch: The partner clusters have been configured individually. Therefore, you must remove the configuration on one cluster and copy the configuration of the partner cluster.
Unknown: Information is not accessible because the partners are disconnected.

Intercluster Resource Management Connection Status

Intercluster Resource Management (ICRM) Connection status displays status for the cluster management agent that is running on the remote cluster. The ICRM connection status can be one of the following:

OK: The ICRM module on each of the partner clusters can communicate with each other.
Error: The ICRM module on the local cluster is unable to communicate with the ICRM module on the remote cluster.

Heartbeat Status

Heartbeat status displays status for the local cluster only. The heartbeat status can be one of the following:

OK: Heartbeat monitoring is enabled, and the partner cluster is responding within timeout and retry periods.
Error: Heartbeat monitoring is running, but the partner cluster is not responding and retries have timed out.
Offline: Heartbeat monitoring is offline.

Heartbeat Plug-in Status

Heartbeat plug-in status displays status for the local cluster only. The heartbeat plug-in status can be one of the following:

OK: The partner cluster is responding.
Inactive: The plug-in is not in use. It is a standby plug-in that is used for retrying if other plug-ins do not respond.
No-Response: The partner cluster is not responding.

Protection Group Status

Protection group status displays the overall status for all the clusters in the protection group. The overall protection group status can be one of the following:

OK: The protection group is online, application resource groups are online, and data replication is running.
Offline: The protection group is inactive.
Degraded: The protection group and the application resource groups are online, but data replication is either not running or is in a partial error state.
Error: The protection group is online, but at least one component of the partnership, such as configuration, data replication, or resource groups, is in an error state.
Unknown: The protection group is online, but the status for at least one component of the partnership, such as configuration, data replication, or resource groups, is unknown.

Configuration Status

The configuration status of a protection group displays the status for a single cluster only. The configuration status of a protection group can be one of the following:

OK: The protection group configuration has been validated without errors on the cluster.
Error: The validation of the protection group configuration resulted in an error. You must validate the protection group again.
Unknown: Information is not accessible because the partner clusters are disconnected.

Data Replication Status

Data replication status displays the status of data replication that has been configured for the protection group on a single cluster. The data replication status of a protection group can be one of the following:

OK: Data replication is configured, online, and running without errors.
Degraded: Data replication is either off or in a partial error state.
Error: Data replication is not operating because of an error.
None: Data replication has not been configured.
Unknown: Information is not accessible because the partners are disconnected.

Resource Groups Status

Resource group status displays the status of resource groups that have been configured for the protection group on a single cluster. The resource group status of a protection group can be one of the following:

OK: All resource groups are online on the primary cluster, and all resource groups are offline or unmanaged on the secondary cluster.
Error: Not all resource groups are online on the primary cluster, or not all resource groups are offline or unmanaged on the secondary cluster.
Unknown: Information is not accessible because the partners are disconnected.

EXIT STATUS

The following exit values are returned:

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

EXAMPLES

Example 1 Enabling the Sun Cluster Geographic Edition Infrastructure

The following geoadm command enables the Sun Cluster Geographic Edition control module on the local cluster.

# geoadm start

Example 2 Disabling the Sun Cluster Geographic Edition Infrastructure

The following geoadm command removes the infrastructure resource groups that were created when you enabled the Sun Cluster Geographic Edition infrastructure.

# geoadm stop

Example 3 Checking the Status of the Sun Cluster Geographic Edition Infrastructure

The following geoadm command displays whether the Sun Cluster Geographic Edition infrastructure is enabled on the local cluster and, if enable, the nodes on which the infrastructure is active.

# geoadm show
--- CLUSTER LEVEL INFORMATION ---
Sun Cluster Geographic Edition is active on:  
node phys-paris-2, cluster cluster-paris

Command execution successful
#

Example 4 Monitoring the Runtime Status of the Sun Cluster Geographic Edition Software

The following geoadm command displays the runtime status of the local Sun Cluster Geographic Edition enabled cluster.

# geoadm status
Cluster: cluster-paris

Partnership "paris-newyork-ps": OK
   Partner clusters    : cluster-newyork
   Synchronization     : OK
   ICRM Connection     :OK

   Heartbeat "paris-to-newyork" monitoring "cluster-newyork": OK        
      Heartbeat plug-in "ping_plugin"    : Inactive
      Heartbeat plug-in "tcp_udp_plugin" : OK

Protection group "tcpg"     : OK
   Partnership              : "paris-newyork-ps"
   Synchronization          : OK

   Cluster cluster-paris    : OK
   Role                     : Primary
   PG activation state      : Activated
   Configuration            : OK
   Data replication         : OK
   Resource groups          : OK

  Cluster cluster-newyork   : OK
     Role                   : Secondary
     PG activation state    : Activated
     Configuration          : OK
     Data replication       : OK
     Resource groups        : OK

Pending operations
Protection group "tcpg" : Start

ATTRIBUTES

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

ATTRIBUTE TYPE	ATTRIBUTE VALUE
Architecture	SPARC
Availability	SUNWscgctl
Interface Stability	Evolving