CoreGroupPolicyManagement


Use Jython to configure and administer policies for high availability groups with wsadmin. Use the commands and parameters in the CoreGroupPolicyManagement group to create, delete, and modify policies.

Use the following commands to define policies for high availability groups. Policies are defined at the core group level and apply only to matching high availability groups associated with the core group of interest.

 

createAllActivePolicy

The createAllActivePolicy command creates a high availability group policy that keeps each of the application components running on each server in the high availability group at all times.

Target object

None.

Required parameters

-coreGroupName

Name of the core group to associate with the new policy. (String, required)

-policyName

Name of the policy. (String, required)Use the following guidelines to specify the policyName parameter:

  • Specify valid characters, including numbers, letters, underscores, and spaces.

  • Begin the policy name with a number or a letter.

  • End the policy name with a number, letter, or underscore.

-matchCriteria

Specifies one or more name and value pairs that the system uses to associate this policy with a high availability group. These pairs must match attributes that are contained in the name of a high availability group before this policy is associated with that group. (java.util.Properties, required)Use the following guidelines to specify the matchCriteria parameter:

  • Do not begin the match criteria with the underscore or period characters.

  • Do not use the following characters: \/,#$@:;"*?<>|=+&%'

  • Specify a value. This parameter can not be null or empty.

Optional parameters

-isAlive

Specifies, in seconds, the interval of time at which the high availability manager checks the health of the active group members that are governed by this policy. If a group member has failed, the server on which the group member resides is restarted. (Integer, optional)

-description

Description for the core group policy. (String, optional)

-customProperties

Specifies additional custom properties for the core group policy. (java.util.Properties, optional)

-quorum

Specifies whether quorum checking is enabled for a group governed by this policy. Quorum is a mechanism that can be used to protect resources that are shared across members of the group in the event of a failure. Quorum is an advanced hardware function and should not be enabled unless you thoroughly understand how to properly use this function. If not used properly, this function can cause data corruption. (Boolean, optional)

Return value

The command does not return output.

Batch mode example usage

Interactive mode example usage

 

createMOfNPolicy

The createMOfNPolicy command creates a high availability group policy that allows you to specify the number (M) of high availability group members to keep active if it is possible to do so. The number of active members must be greater than one and less than or equal to the number of servers in the high availability group.

Target object

None.

Required parameters

-coreGroupName

Name of the core group to associate with the new policy. (String, required)

-policyName

Name of the policy. (String, required)

-matchCriteria

Specifies one or more name and value pairs that the system uses to associate this policy with a high availability group. These pairs must match attributes that are contained in the name of a high availability group before this policy is associated with that group. (java.util.Properties, required)

Optional parameters

-isAlive

Specifies, in seconds, the interval of time at which the high availability manager checks the health of the active group members that are governed by this policy. If a group member has failed, the server on which the group member resides is restarted. (Integer, optional)

-quorum

Specifies whether quorum checking is enabled for a group governed by this policy. Quorum is a mechanism that can be used to protect resources that are shared across members of the group in the event of a failure. Quorum is an advanced hardware function and should not be enabled unless you thoroughly understand how to properly use this function. If not used properly, this function can cause data corruption. (Boolean, optional)

-description

Description for the core group policy. (String, optional)

-customProperties

Specifies additional custom properties for the core group policy. (java.util.Properties, optional)

-failBack

Specifies whether work items assigned to the failing server are moved to the server that is designated as the most preferred server for the group if a failure occurs. This field only applies for M of N and One of N policies. (Boolean, optional)

-preferredOnly

Specifies whether group members are only activated on servers that are on the list of preferred servers for this group. This field only applies for M of N and One of N policies. (Boolean, optional)

-serversList

Members to prefer when activating a group member. The members must be part of the core group for which the policy applies. Specify the value of the serverList parameter in the format of node/server. (String[], optional)

-numActive

Number of the high availability group members to activate.

This field only applies for the M of N policy. (Integer, optional)

Return value

The command does not return output.

Batch mode example usage

Interactive mode example usage

 

createNoOpPolicy

The createNoOpPolicy command creates a high availability group policy that indicates that no high availability group members are made active.

Target object

None.

Required parameters

-coreGroupName

Name of the core group to associate with the new policy. (String, required)

-policyName

Name of the policy. (String, required)

-matchCriteria

Specifies one or more name and value pairs that the system uses to associate this policy with a high availability group. These pairs must match attributes that are contained in the name of a high availability group before this policy is associated with that group. (java.util.Properties, required)

Optional parameters

-isAlive

Specifies, in seconds, the interval of time at which the high availability manager checks the health of the active group members that are governed by this policy. If a group member has failed, the server on which the group member resides is restarted. (Integer, optional)

-description

Description for the core group policy. (String, optional)

-customProperties

Specifies additional custom properties for the core group policy. (java.util.Properties, optional)

-quorum

Specifies whether quorum checking is enabled for a group governed by this policy. Quorum is a mechanism that can be used to protect resources that are shared across members of the group in the event of a failure. Quorum is an advanced hardware function and should not be enabled unless you thoroughly understand how to properly use this function. If not used properly, this function can cause data corruption. (Boolean, optional)

Return value

The command does not return output.

Batch mode example usage

Interactive mode example usage

 

createOneOfNPolicy

The createOneOfNPolicy command creates a high availability group policy that keeps one member of the high availability group active at all times. This is used by groups that desire singleton failover. If a failure occurs, the high availability manager starts the singleton on another server.

Target object

None.

Required parameters

-coreGroupName

Name of the core group to associate with the new policy. (String, required)

-policyName

Name of the policy. (String, required)

-matchCriteria

Specifies one or more name and value pairs that the system uses to associate this policy with a high availability group. These pairs must match attributes that are contained in the name of a high availability group before this policy is associated with that group. (java.util.Properties, required)

Optional parameters

-isAlive

Specifies, in seconds, the interval of time at which the high availability manager checks the health of the active group members that are governed by this policy. If a group member has failed, the server on which the group member resides is restarted. (Integer, optional)

-quorum

Specifies whether quorum checking is enabled for a group governed by this policy. Quorum is a mechanism that can be used to protect resources that are shared across members of the group in the event of a failure. Quorum is an advanced hardware function and should not be enabled unless you thoroughly understand how to properly use this function. If not used properly, this function can cause data corruption. (Boolean, optional)

-description

Description for the core group policy. (String, optional)

-customProperties

Specifies additional custom properties for the core group policy. (java.util.Properties, optional)

-failBack

Specifies whether work items assigned to the failing server are moved to the server that is designated as the most preferred server for the group if a failure occurs. This field only applies for M of N and One of N policies. (Boolean, optional)

-preferredOnly

Specifies whether group members are only activated on servers that are on the list of preferred servers for this group. This field only applies for M of N and One of N policies. (Boolean, optional)

-serversList

Members to prefer when activating a group member. The members must be part of the core group for which the policy applies. Specify the value of the serverList parameter in the format of node/server. (String[], optional)

Return value

The command does not return output.

Batch mode example usage

Interactive mode example usage

 

createStaticPolicy

The createStaticPolicy command creates a high availability group policy that allows you to statically define or configure the active members of the high availability group.

Target object

None.

Required parameters

-coreGroupName

Name of the core group to associate with the new policy. (String, required)

-policyName

Name of the policy. (String, required)

-matchCriteria

Specifies one or more name and value pairs that the system uses to associate this policy with a high availability group. These pairs must match attributes that are contained in the name of a high availability group before this policy is associated with that group. (java.util.Properties, required)

-serversList

Members to prefer when activating a group member. The members must be part of the core group for which the policy applies. Specify the value of the serverList parameter in the format of node/server. (String[], optional)

Optional parameters

-isAlive

Specifies, in seconds, the interval of time at which the high availability manager checks the health of the active group members that are governed by this policy. If a group member has failed, the server on which the group member resides is restarted. (Integer, optional)

-description

Description for the core group policy. (String, optional)

-customProperties

Specifies additional custom properties for the core group policy. (java.util.Properties, optional)

-quorum

Specifies whether quorum checking is enabled for a group governed by this policy. Quorum is a mechanism that can be used to protect resources that are shared across members of the group in the event of a failure. Quorum is an advanced hardware function and should not be enabled unless you thoroughly understand how to properly use this function. If not used properly, this function can cause data corruption. (Boolean, optional)

Return value

The command does not return output.

Batch mode example usage

Interactive mode example usage

 

deletePolicy

The deletePolicy command deletes a specific core group policy from the configuration.

Target object

None.

Required parameters

-coreGroupName

Name of the core group from which the system removes the policy. (String, required)

-policyName

Name of the policy to delete. (String, required)

Return value

The command does not return output.

Batch mode example usage

Interactive mode example usage

 

modifyPolicy

The modifyPolicy command modifies a specific core group policy of interest. You can use the modifyPolicy command to change one or many policy settings.

Target object

None.

Required parameters

-coreGroupName

Name of the core group that the policy of interest is associated with. (String, required)

-policyName

Name of the policy to modify. (String, required)

Optional parameters

-newPolicyName

Specifies a new name for the policy of interest. (String, optional)

-matchCriteria

Specifies one or more name and value pairs that the system uses to associate this policy with a high availability group. These pairs must match attributes that are contained in the name of a high availability group before this policy is associated with that group. (java.util.Properties, optional)

-isAlive

Specifies, in seconds, the interval of time at which the high availability manager checks the health of the active group members that are governed by this policy. If a group member has failed, the server on which the group member resides is restarted. (Integer, optional)

-quorum

Specifies whether quorum checking is enabled for a group governed by this policy. Quorum is a mechanism that can be used to protect resources that are shared across members of the group in the event of a failure. Quorum is an advanced hardware function and should not be enabled unless you thoroughly understand how to properly use this function. If not used properly, this function can cause data corruption. (Boolean, optional)

-description

Description for the core group policy. (String, optional)

-customProperties

Specifies additional custom properties for the core group policy. (java.util.Properties, optional)

-numActive

Number of the high availability group members to activate.

This field only applies for the M of N policy. (Integer, optional)

-preferredOnly

Specifies whether group members are only activated on servers that are on the list of preferred servers for this group. This field only applies for M of N and One of N policies. (Boolean, optional)

-failBack

Specifies whether work items assigned to the failing server are moved to the server that is designated as the most preferred server for the group if a failure occurs. This field only applies for M of N and One of N policies. (Boolean, optional)

-serversList

Members to prefer when activating a group member. The members must be part of the core group for which the policy applies. Specify the value of the serverList parameter in the format of node/server. (String[], optional)

Return value

The command does not return output.

Batch mode example usage

Interactive mode example usage





 

Related tasks


Configuring a core group policy for messaging engines
Configuring a Static policy for service integration
Configuring a One of N policy for service integration
Configuring a 'No operation' policy for service integration

 

Related


Core group policies
Core group policy settings