Standard Geographic Edition Properties
This appendix provides the standard properties of Geographic Edition heartbeats, heartbeat plug-in,
partnerships, protection groups and data replication device groups, sites, and multigroups.
This appendix contains the following sections:
Note -
The property names and values, such as Query_interval,
True, and False, are not case
sensitive.
Heartbeat Properties
The following table describes the heartbeat properties that the Geographic Edition software
defines.
Table A-1 Geographic Edition Heartbeat Properties
|
|
|
Query_interval (integer)
|
Specifies the delay in seconds between heartbeat status requests.
Tuning recommendations: The value of this property is
assigned at creation and can be tuned at runtime.
Category: Optional
Default: 120 seconds
|
|
Heartbeat Plug-in Properties
The following table describes the heartbeat plug-in properties that the Geographic Edition software
defines.
Table A-2 Geographic Edition Heartbeat Plug-in Properties
|
|
|
Plugin_properties (string)
|
Specifies a property string specific to the plug-in.
Tuning recommendations: The value of this property is
assigned at creation and can be tuned at runtime.
Category: Optional
Default: 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 argument specifies if the plug-in uses IPsec with a
Boolean value of true or false.
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.
|
|
Query_cmd (string)
|
Specifies the path to the heartbeat status request command.
Tuning recommendations: The value of this property is
assigned at creation and can be tuned at runtime.
Category: Required property if the plug-in does not specify
a predefined plug-in.
Default: None
|
|
Requester_agent (string)
|
Specifies the absolute path to the requester agent.
Tuning recommendations: The value of this property is
assigned at creation and can be tuned at runtime. However, the Requester_agent
property of the default plug-in should never need to be tuned except for testing purposes.
Category: Optional
Default: None
|
|
Responder_agent (string)
|
Specifies the absolute path to the responder agent.
Tuning recommendations: The value is assigned at creation
and can be tuned at runtime. However, the Responder_agent property of the default
plug-in should never need to be tuned except for testing purposes.
Category: Optional
Default: None
|
|
Type (enum)
|
Designates the type of plug-in. Set to either primary or
backup.
Tuning recommendations: The value of this property is
assigned at creation and can be tuned at runtime.
Category: Required
Default: None, except for the default heartbeat that is
named ping_plugin. If using this plug-in, the default value is
backup.
|
|
Partnership Properties
The following table describes the partnership properties that the Geographic Edition software
defines.
Table A-3 Geographic Edition Partnership Properties
|
|
|
Description (string)
|
Describes the partnership.
Tuning recommendations: The value of this property is
assigned at creation and can be tuned at runtime.
Category: Optional
Default: Empty string
|
|
Notification_ActionCmd (string)
|
Provides the path to the action script that is triggered when heartbeat-loss notification is
issued.
Tuning recommendations: The value of this property is
assigned at creation and can be tuned at runtime.
Category: Optional
Default: Empty string
|
|
Notification_EmailAddrs (string array)
|
Lists the email addresses that are sent email when heartbeat-loss notification is issued. The
list is comma delimited.
Tuning recommendations: The value of this property is
assigned at creation and can be tuned at runtime.
Category: Optional
Default: Empty string
|
|
Protection Group Properties
The following table describes the protection group properties that the Geographic Edition software
defines.
Table A-4 Geographic Edition Protection Group Properties
|
|
|
Description (string)
|
Describes the protection group.
Tuning recommendations: This property can be tuned at any
time.
Category: Optional
Default: Empty string
|
|
External_Dependency_Allowed
(Boolean)
|
Allow dependencies between resource groups and resources that belong to this protection group
and resource groups and resources that do not belong to this protection group when set to
true.
Tuning recommendations: This property can be tuned at any
time.
Category: Optional
Default: false
|
|
RoleChange_ActionArgs (string)
|
Defines a string of arguments that are appended to the end of the command line when the
role-change action command, RoleChange_ActionCmd, is run.
Tuning recommendations: This property can be tuned at any
time.
Category: Optional
Default: Empty string
|
|
RoleChange_ActionCmd (string)
|
Specifies the path to an executable command. This script is invoked during a switchover or
takeover on the new primary cluster when the protection group is started on the new primary cluster.
The script is invoked on the new primary cluster after the data replication role changes from
secondary to primary and before the application resource groups are brought online. If the data
replication role change does not succeed, then the script is not called.
This file should be valid on all nodes of all partner clusters that can host the protection
group, and have execute permissions for the user that launches the script.
Tuning recommendations: This property can be tuned at any
time.
Category: Optional
Default: Empty string
|
|
Timeout (integer)
|
Specifies the timeout period for the protection group in seconds. The timeout period is the
longest time Geographic Edition waits for a response after you run a geopg command,
such as geopg start, geopg stop, geopg
switchover, and geopg takeover. If the command does not respond within
the timeout period, the Geographic Edition software reports the operation as timed out, even if the
underlying command eventually completes successfully.
You should identify the amount of time required to perform a role-reversal of the data
replication, and set the timeout value to 150% to 200% of that value to ensure enough time for the
role-reversal to complete.
To ensure that an operation has finished on the remote cluster, check system status after a
timeout before attempting the operation again. For more information, see Troubleshooting Migration Problems. 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 that an operation with a
global scope times out during one of the following conditions:
Tuning recommendations: This property can be tuned only
when the protection group is offline.
Category: Optional
Range: 20-1000000 seconds
Default: 200
|
|
Site Properties
The following table describes the site
properties that the Geographic Edition software defines.
Table A-5 Geographic Edition Site Properties
|
|
|
Description (string)
|
Describes the site. The system sets this property on the local cluster, then propagates the
value to the other clusters in the site.
Tuning recommendations: This property is assigned at
creation and tunable at runtime.
Category: Optional
Default: None
|
|
joinTimeout (integer)
|
Specifies, in seconds, the longest time that the JMX client, the site, waits for the
invocation of an MBean-server method to return. If a method does not return by the end of the
timeout period, the client moves to its next set of instructions and reports the operation as timed
out. By default, a client waits indefinitely for a method to return. If the MBean server is unable
to complete an invocation, the JMX client will hang indefinitely. The timeout period is site-wide
and applies to operations on a per-cluster basis.
The joinTimeout property is used when the join operation requires more time
to complete than the default setting allows before the geosite joincommand times
out.
Tuning recommendations: This property is assigned at
creation,but it is not tunable at runtime.
Category: Optional
Default: 30 seconds
Minimum: 20 seconds
Maximum: 3600 seconds
|
|
Query_interval (integer)
|
Specifies, in seconds, the frequency between heartbeat status requests used by the site
clusters. 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.
Tuning recommendations: This property is assigned at
creation and tunable at runtime.
Category: Optional
Default: 120 seconds
Minimum: 20 seconds
Maximum: 300 seconds
|
|
Timeout (integer)
|
Specifies, in seconds, the longest time that the JMX client, the site, waits for the
invocation of an MBean-server method to return. If a method does not return by the end of the
timeout period, the client moves to its next set of instructions and reports the operation as timed
out. By default, a client waits indefinitely for a method to return. If the MBean server is unable
to complete an invocation, the JMX client will hang indefinitely. The timeout period is site-wide
and applies to operations on a per-cluster basis.
Tuning recommendations: This property is assigned at
creation and tunable at runtime.
Category: Optional
Default: 30 seconds
Minimum: 30 seconds
Maximum: 3600 seconds
|
|
Multigroup Properties
The following table describes the multigroup properties that the Geographic Edition software
defines.
Table A-6 Geographic Edition Multigroup Properties
|
|
|
Description (string)
|
Describes the multigroup. The system sets this property on the local cluster, then propagates
the value to the other clusters in the site where the multigroup is defined.
Tuning recommendations: This property is assigned at
creation and tunable at runtime.
Category: Optional
Default: None
|
|
|
Specifies, in seconds, the longest time that the JMX client, the site, waits for the
invocation of an MBean-server method to return. If a method does not return by the end of the
timeout period, the client moves to its next set of instructions and reports the operation as timed
out. By default, a client waits indefinitely for a method to return. If the MBean server is unable
to complete an invocation, the JMX client will hang indefinitely. The timeout period is site-wide
and applies to operations on a per-cluster basis.
The timeout period applies to operations on a per-cluster basis. An operation with a local
scope times out if the operation is not completed 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 actions are timed separately. So, an operation with a
global scope times out if the local operation is not completed after the specified timeout period or
if the remote operation is not completed after the specified timeout period.
For example, the following command is started with a local scope:
# geomg start -e local multigroup
If you set the Timeout property to 3000 seconds, the geomg
start command times out if the operation does not complete after 3000 seconds.
You can start the same command with a global scope as follows:
# geomg start -e global multigroup
If the Timeout property is set to 3000 seconds, the geomg
start command times out if the operation is not completed on the local cluster after 3000
seconds or if the operation is not completed on the remote cluster after 3000 seconds. If the local
action takes 1500 seconds and the remote action takes 1500 seconds, the operation is not timed
out.
The multigroup timeout value is an estimated value that is applied to some sub-operations. The
timeout value does not apply to the entire operation, so not every operation on a protection group
is timed against the timeout period. For example, the time taken to initialize the data structure
and to check for the precondition of the operation are not timed in the timeout period.
Tuning recommendations: This property is assigned at
creation and tunable at runtime.
Category: Optional
Default: 30 seconds
Minimum: 20 seconds
Maximum: 3600 seconds
|
|