NAME | SYNOPSIS | DESCRIPTION | SUBCOMMANDS | OPTIONS | OPERANDS | EXTENDED DESCRIPTION | EXIT STATUS | EXAMPLES | ATTRIBUTES | SEE ALSO
The geopg command enables you to configure and maintain protection groups. You can perform the following tasks:
Configuring a protection group between clusters that participate in a partnership. This task includes the configuration of associated data replication parameters.
Adding or removing resource groups and data-replication disk device groups.
Adding, modifying, and removing data replication parameters that are associated with a protection group property.
Retrieving the current configuration of a specific protection group or all defined protection groups.
Activating a protection group.
Deactivating a protection group.
Switching over the role of a protection group.
Taking over the primary role of a protection group.
Before you can create a protection group, the clusters that will be hosting the protection group must already be in a partnership.
To run the geopg command to create, modify, or delete a protection group, or a data-replication disk device group, 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:
geopg [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 geopg start command activates the protection group on both the primary and the secondary clusters. This activation starts the Sun Cluster Geographic Edition management of the resource groups in the protection group. Depending on the form of the command that you use and on the cluster where you issue the command, activating the protection group might not start the resource groups on that cluster. The resource groups start, or are brought online, only on the primary cluster.
The -e option defines the scope of the geopg start command. If you specify -e local, the geopg start command runs on the cluster where you issue the command. If you specify -e global, the geopg start command runs on both clusters in the partnership.
The different forms of the command have the following effects:
geopg start -e local run on the primary cluster and geopg start -e global run on either cluster: the Sun Cluster Geographic Edition software activates the protection group on both clusters in the partnership. The software brings online resource groups on the primary cluster only. The resource groups are put in the managed state.
geopg start -e local run on the secondary cluster: the Sun Cluster Geographic Edition software activates the protection group on the secondary cluster only. Resource groups are not started on the secondary cluster. The resource groups are put in the unmanaged state.
The following subcommands are supported:
Enable a data-replication disk device group to be part of a protection group.
Enable an application resource group to be part of a protection group.
If the resource group you are adding is online, then the protection group must also be active before you add the resource group. The geopg add command fails when a protection group is inactive and the resource group that is being added is online.
If a protection group has already been started at the time that you add a resource group that is offline, the resource group remains offline. To start the offline resource group, run the command geopg start.
Create a protection group or create a data-replication disk device group.
When you create a protection group, the management module updates the local configuration and notifies remote clusters of configuration changes.
Delete a protection group.
Create the local configuration for a protection group that has already been created on a partner cluster.
The configuration of an existing protection group is propagated to the partner cluster that hosts the protection group if the partner clusters are connected. If you create a protection group while partner clusters are disconnected or before the partner has joined the partnership, you must run the geopg get command to propagate the configuration.
Display the following information about the protection group:
Defined protection groups
Resource groups that are wrapped into protection groups
Operation status information
Modify the properties of a data-replication disk device group.
Remove data-replication disk device groups from a protection group.
Removing a data-replication device group does not stop data replication or change the data-replication status for that data-replication device group.
Remove resource groups from a protection group.
Removing an application resource group does not change the application resource group to the Offline state.
Modify the properties of a protection group.
Activate a protection group. After the subcommand is activated, the role of the protection group on a cluster is the role you assigned to the cluster when you configured the protection group.
The start subcommand uses Sun Cluster commands to bring resources and resource groups online.
You can activate a protection group on the following levels:
On all clusters where the protection group has been configured.
On either the primary cluster or the secondary cluster.
For more details about activating a protection group and the effects on the resource groups in that protection group, see “Understanding How Protection Groups Start” in the DESCRIPTION section of this man page
Activation of a protection group enables the following events to occur:
The protection group configuration can be validated.
Clusters can determine whether an operation has been completed.
Data replication can be started, depending on the data replication that you use.
When using Sun StorageTek Availability Suite software, you can start data replication from the primary cluster only. When using Hitachi TrueCopy or EMC Symmetrix Remote Data Facility software,you can start data replication from either the primary or the secondary cluster.
For all supported data replication software, you must not specify the -n option when using this form of the command.s
Protected applications can be started.
If the partner can be reached, the partner cluster can be notified of the protection group activation.
Protection groups referred to as “online” are active protection groups.
Deactivate a protection group. You can deactivate a protection group on the following levels:
On all clusters where the protection group has been configured.
On either the primary cluster or the secondary cluster.
Stopping a protection group enables the following events to occur:
The protection group becomes inactive.
Depending on the data replication you are using, data replication stops. You can prevent data replication from stopping by removing the resource group from the protection group before stopping the protection group.
When using SunStorageTek Availability Suite software, you can stop data replication from the primary cluster only. When using Hitachi TrueCopy or EMC Symmetrix Remote Data Facility software ,you can stop data replication from either the primary or the secondary cluster.
For all supported data replication software,you must not specify the -D option when using this form of the command.
Protected applications stop.
If the partner cluster is reachable,the partner cluster is notified that the protection group has been stopped.
Switch the assigned role of a cluster in the protection group.
Force a cluster to become the PRIMARY cluster without considering the partner cluster state.
If you issue a takeover from the secondary cluster and the cluster is able to communicate with the partner cluster, the Sun Cluster Geographic Edition software switches the role of the partner cluster so that the partner cluster becomes the new secondary. This operation is not the same as a switchover. The protection group is deactivated on the new secondary.
After successful completion of the geopg takeover command, reactivating the protection group on the secondary cluster might require data recovery and actions to synchronize data.
When possible, run the geopg switchover command instead of the geopg takeover command to coordinate between partner clusters to avoid loss of replicated data.
Run the geopg takeover command only in situations that require a new primary urgently. The situation must justify a potential loss of data and the time required to repaire and to reactivate the protection group on the secondary cluster.
Resynchronize the configuration information of the local protection group with the partner's configuration information.
Validate a protection group on the local cluster by performing a sanity check of the dynamic values.
The following options are supported:
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.
Specifies that only the data replication should be deactivated, leaving the protection group active. If you do not use this option, the entire protection group is deactivated. To stop a protection group that has already had its data replication subsystem stopped, you must run the geopg stop command again and omit this option.
Specifies the data replication mechanism for data replication between the clusters of the protection group.
The datareptype must be one of the following strings:
Specifies that the data replication mechanism is Sun StorageTek Availability Suite Remote Mirror Release, with patches.
Specifies that the data replication mechanism is the dynamic EMC Symmetrix Remote Data Facility.
Specifies that the data replication mechanism is Hitachi TrueCopy.
Specifies whether the command operates only on the local cluster (local) or on both clusters where the protection group has been configured (global).
Forces the command to perform the operation without asking the user for confirmation.
Specifies the name of the cluster that is to be the primary cluster for the protection group.
Specifies that data replicaiton should not be used for this protection group. If this option is omitted, data replication starts at the same time as the protection group.
Specifies the role of the local cluster as either PRIMARY or SECONDARY when used with the create subcommand. You can change the role of a cluster by running the geopg switchover command.
Sets the properties of a protection group.
A protection group property is assigned a value by using a name=statement pair statement. You can set multiple properties one time by using multiple statements.
See the EXTENDED DESCRIPTION section for defined properties.
Specifies the name of the partnership that includes the cluster on which this protection group can be activated.
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 operand is supported:
Specifies the name of the disk device group that is to be created.
Specifies the name of the protection group. The create subcommand fails if the protection group that is specified with this option already exists. The modify subcommand fails if the specified protection group is not valid.
Specifies a comma-separated list of resource groups to add to or delete from the protection group. The specified resource groups must already be defined.
The protection group must be active before you add a resource group. The geopg add-resource-group command fails when a protection group is inactive and the resource group that is being added is online.
If a protection group has already been started at the time that you add a resource group, the resource group remains offline. You must start the resource group manually by running the geopg start command.
The following tables list the properties. The values of these properties are assigned at creation. The property values, such as true and false, are not case sensitive. Specific information about when you can tune the properties is provided in the property description.
Describes the protection group.
Optional property.
Type: string.
Default value: none.
Tuning recommendations: Assigned at creation and tunable at runtime.
Specifies a string that follows system-defined arguments at the end of the command line when the role-change callback command runs.
Optional property.
Type: string.
Default value: none.
Tuning recommendations: Assigned at creation and tunable at runtime.
Specifies the absolute path to the executable command to run when the primary cluster of the protection group changes. This path should be valid on all partner clusters that host the protection group.
Optional property.
Type: string.
Default value: none.
Tuning recommendations: Assigned at creation and tunable at runtime.
Specifies in seconds the longest time the Sun Cluster Geographic Edition software waits for a response after a geopg command runs, such as start, stop, switchover, and takeover. If the command does not return within the timeout period, the Sun Cluster Geographic Edition software reports the operation as timed out, even if the underlying command that was run eventually completes successfully.
The timeout period applies to operations on a per-cluster basis. An operation with a local scope times out if the operation does not complete after the specified timeout period.
An operation with a global scope consists of an action on the local cluster and an action on the remote cluster. The local and remote action are timed separately. So, an operation with a global scope times out if the local operation does not complete after the specified timeout period or if the remote operation does not complete after the specified timeout period.
For example, the following operation is launched with a local scope:
# geopg start -e local protectiongroupname |
If the timeout property is set to 200 seconds, then the geopg start operation times out if the operation does not complete after 200 seconds.
You can launch the same operation with a global scope as follows:
# geopg start -e global protectiongroupname |
If the timeout property is set to 200 seconds, then the geopg start operation times out if the operation does not complete on the local cluster after 200 seconds or if the operation does not complete on the remote cluster after 200 seconds. If the local action takes 150 seconds and the remote action takes 150 seconds, the operation does not time out.
The protection group timeout value is estimated. Not every operation on a protection group is timed against the timeout period. For example, the time taken to initialize the data structure and check for the precondition of the operation are not timed in the timeout period.
The timeout property has a maximum of 1,000,000 seconds.
Optional property.
Type: Integer. A minimum value of at least 20 is required.
Default value: 200 seconds.
Tuning recommendations: Assigned at creation and tunable at runtime.
Defines whether the volume sets that are defined in the file are enabled. Set to either True or False (case insensitive).
Optional property.
Type: Boolean.
Tuning recommendations: You cannot tune this property after the device group is added to a protection group.
Default value: False.
Defines the local logical hostname that is used for the replication of the disk device group. Do not use an underscore character (_) in the logical hostname.
Required property.
Type: string.
Tuning recommendations: You cannot tune this property after the device group is added to a protection group.
Default value: none.
Lists the hostnames of the machines that can be primary for the replication mechanism. This list is comma delimited.
Optional property.
Type: string array.
Tuning recommendations: You can tune this property only when the protection group is inactive.
Default value: empty.
Specifies the remote logical hostname that is used for the replication of the disk device group.
Required property.
Type: string.
Tuning recommendations: You cannot tune this property after the device group is added to a protection group.
Default value: none.
Lists the disk device groups where the data is written. The list is comma delimited.
Optional property.
Type: string array.
Tuning recommendations: You can tune this property only when the protection group is inactive on both partner clusters.
Default value: empty.
Defines the fence level that is used by the disk device group. The fence level determines the level of consistency among the primary and secondary volumes for that disk device group. Possible values are data, status, never, and async.
You can set this property to any valid Fence_level when the current pair state is SMPL.
To avoid application failure on the primary cluster, specify a Fence_level of never or async. If the Fence_level parameter is not set to never or async, data replication might not function properly when the secondary site goes down.
Do not use programs that would prevent the Fence_level parameter from being set to data or status because these values might be required in special circumstances.
If you have special requirements to use a Fence_level of data or status, consult your Sun representative.
Required property.
Type: enum.
Tuning recommendations: You can tune this property only when the protection group is inactive. For a Hitachi TrueCopy device group, if the pair has already been created, this property can be set only to the current Fence_level of the pair. If you want to change the Fence_level of an existing pair, modify the Fence_level by using the Hitachi TrueCopy CCI commands first, then tune the Fence_level property.
Default value: none.
Lists the hostnames of the machines that can be primary for the replication mechanism. This list is comma delimited.
Optional property.
Type: string array.
Tuning recommendations: You can tune this property only when the protection group is inactive.
Default value: empty.
Lists the disk device groups where the data is written. The list is comma delimited.
Optional property.
Type: string array.
Tuning recommendations: You can tune this property at any time.
Default value: empty.
Specifies the device group identifier as “SRDF Device Group.” You must set this property to DG.
Optional property.
Type: string.
Tuning recommendations: You can tune this property at any time.
Default value: DG.
Lists the hostnames of the machines that can be primary for the replication mechanism. This list is comma delimited.
Optional property.
Type: string array.
Tuning recommendations: You can tune this property only when the protection group is inactive.
Default value: empty.
Specifies the Symmetrix Remote Data Facility identification of the primary devices.
Required property.
Type: string array.
Tuning recommendations: You can tune this property at any time.
Default value: none.
Specifies the Symmetrix Remote Data Facility identification of the secondary devices.
Required property.
Type: string array.
Tuning recommendations: You can tune this property at any time.
Default value: none.
The following exit values are returned:
The command completed successfully.
An error has occurred.
The following geopg command creates a Sun StorageTek Availability Suite protection group on the primary cluster cluster-paris.
# geopg create -s paris-newyork-ps -d avs -o primary \ -p Nodelist=phys-paris-1,phys-paris-2 avspg |
The following geopg command creates a protection group that is configured to not use data replication.
# geopg create -s paris-newyork-ps -o primary example-pg |
The following geopg command keeps two application resource groups, apprg1 and apprg2, online while deleting their protection group, avspg. Remove the application resource groups from the protection group, then delete the protection group.
# geopg remove-resource-group apprg1,apprg2 avspg # geopg stop -e global avspg # geopg delete avspg |
The following geopg command modifies the timeout property of the protection group avspg.
# geopg set-prop -p Timeout=300 avspg |
The following geopg command dreates a Sun StorageTek Availability Suite data replication device group in the avspg protection group.
# geopg add-device-group -p Local_logical_host=lh-paris-1 \ -p Remote_logical_host=lh-newyork-1 avsdg avspg |
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 | OPERANDS | EXTENDED DESCRIPTION | EXIT STATUS | EXAMPLES | ATTRIBUTES | SEE ALSO