CoreGroupPolicyManagement

Use the Jython scripting language to administer policies for high availability groups with the wsadmin tool. Use the commands 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
• createMOfNPolicy
• createNoOpPolicy
• createOneOfNPolicy
• createStaticPolicy
• deletePolicy
• modifyPolicy

createAllActivePolicy

Create 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. The policy name cannot end with a space character.

-matchCriteria

One or more name and value pairs the system uses to associate this policy with a high availability group. These pairs must match attributes 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 cannot 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 governed by this policy. If a group member has failed, the server on which the group member resides is restarted. The default is 0. (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 used to protect resources that are shared across members of the group in the event of a failure. Quorum is an advanced hardware function. Do not enable this function unless you properly understand how to use this function. If not used properly, this function can cause data corruption. The default is false. (Boolean, optional)

Return value: The command does not return output.

Batch mode example usage

• Use Jython string:
  AdminTask.createAllActivePolicy('-coreGroupName myCoreGroup -policyName myPolicy -matchCriteria "[ [type WSAF_SIB][WSAF_SIB_BUS MyBus] ]" -quorum true -isAlive 100')

• Use Jython list:
  AdminTask.createAllActivePolicy('-coreGroupName', 'myCoreGroup', '-policyName', 'myPolicy', '-matchCriteria', "[ [type WSAF_SIB][WSAF_SIB_BUS MyBus] ]")

Interactive mode example usage

• Use Jython:
  AdminTask.createAllActivePolicy('-interactive')

createMOfNPolicy

Creates a high availability group policy that allows us 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)

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. The policy name cannot end with a space character.

-matchCriteria

One or more name and value pairs the system uses to associate this policy with a high availability group. These pairs must match attributes 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 cannot 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 governed by this policy. If a group member has failed, the server on which the group member resides is restarted. The default is 0.(Integer, optional)

-quorum

Specifies whether quorum checking is enabled for a group governed by this policy. Quorum is a mechanism used to protect resources that are shared across members of the group in the event of a failure. Quorum is an advanced hardware function. Do not enable this function unless you properly understand how to use this function. If not used properly, this function can cause data corruption. The default is false.(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. The default is false. (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. The default is false. (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. The default is 1. (Integer, optional)

Return value. The command does not return output.

Batch mode example usage

• Use Jython string:
  AdminTask.createMOfNPolicy('-coreGroupName myCoreGroup -policyName myPolicy -matchCriteria "[ [type WSAF_SIB][WSAF_SIB_BUS MyBus] ]" -quorum true -isAlive 100 -preferredOnly false -numActive2')

• Use Jython list:
  AdminTask.createMOfNPolicy('-coreGroupName', 'myCoreGroup', '-policyName', 'myPolicy', '-matchCriteria', "[ [type WSAF_SIB][WSAF_SIB_BUS MyBus] ]")

Interactive mode example usage

• Use Jython:
  AdminTask.createMOfNPolicy('-interactive')

createNoOpPolicy

Create 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)

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. The policy name cannot end with a space character.

-matchCriteria

One or more name and value pairs the system uses to associate this policy with a high availability group. These pairs must match attributes 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 cannot 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 governed by this policy. If a group member has failed, the server on which the group member resides is restarted. The default is 0.(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 used to protect resources that are shared across members of the group in the event of a failure. Quorum is an advanced hardware function. Do not enable this function unless you properly understand how to use this function. If not used properly, this function can cause data corruption. The default is false. (Boolean, optional)

Return value. The command does not return output.

Batch mode example usage

• Use Jython string:
  AdminTask.createNoOpPolicy('-coreGroupName myCoreGroup -policyName myPolicy -matchCriteria "[ [type WSAF_SIB][WSAF_SIB_BUS MyBus] ]"')

• Use Jython list:
  AdminTask.createNoOpPolicy('-coreGroupName', 'myCoreGroup', '-policyName', 'myPolicy', '-matchCriteria', '"[ [type WSAF_SIB][WSAF_SIB_BUS MyBus] ]"')

Interactive mode example usage

• Use Jython:
  AdminTask.createNoOpPolicy('-interactive')

createOneOfNPolicy

Create a high availability group policy that keeps one member of the high availability group active at all times. This is used by groups that want 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)

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. The policy name cannot end with a space character.

-matchCriteria

One or more name and value pairs the system uses to associate this policy with a high availability group. These pairs must match attributes 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 cannot 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 governed by this policy. If a group member has failed, the server on which the group member resides is restarted. The default is 0. (Integer, optional)

-quorum

Specifies whether quorum checking is enabled for a group governed by this policy. Quorum is a mechanism used to protect resources that are shared across members of the group in the event of a failure. Quorum is an advanced hardware function. Do not enable this function unless you properly understand how to use this function. If not used properly, this function can cause data corruption. The default is false. (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. The default is false. (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. The default is false. (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

• Use Jython string:
  AdminTask.createOneOfNPolicy('[-coreGroupName DefaultCoreGroup -policyName MySIBusPolicy -matchCriteria "[ [type WSAF_SIB][WSAF_SIB_BUS MyBus] ]" -isAlive 120 -serversList WASnode01/server1;WASnode02/server2]')

• Use Jython list:
  AdminTask.createOneOfNPolicy(['-coreGroupName', 'DefaultCoreGroup', '-policyName', 'MySIBusPolicy', '-matchCriteria', '"[ [type WSAF_SIB][WSAF_SIB_BUS MyBus] ]"', '-isAlive', '120', '-serversList', 'WASnode01/server1;WASnode02/server2'])

Interactive mode example usage

• Use Jython:
  AdminTask.createOneOfNPolicy('-interactive')

createStaticPolicy

Create a high availability group policy that allows us to statically define 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)

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. The policy name cannot end with a space character.

-matchCriteria

One or more name and value pairs the system uses to associate this policy with a high availability group. These pairs must match attributes 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 cannot be null or empty.

-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 governed by this policy. If a group member has failed, the server on which the group member resides is restarted. The default is 0. (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 used to protect resources that are shared across members of the group in the event of a failure. Quorum is an advanced hardware function. Do not enable this function unless you properly understand how to use this function. If not used properly, this function can cause data corruption. The default is false. (Boolean, optional)

Return value. The command does not return output.

Batch mode example usage

• Use Jython string:
  AdminTask.createStaticPolicy('[-coreGroupName myCoreGroup -policyName myPolicy -matchCriteria "[[criteria1 value1][criteria2 value2]]" -serversList node/server1;node/server2;node/server3]')

• Use Jython list:
  AdminTask.createStaticPolicy(['-coreGroupName', 'myCoreGroup', '-policyName', 'myPolicy', '-matchCriteria', '"[[criteria1 value1][criteria2 value2]]"', '-serversList', 'node/server1;node/server2;node/server3'])

Interactive mode example usage

• Use Jython:
  AdminTask.createStaticPolicy('-interactive')

deletePolicy

Delete 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

• Use Jython string:
  AdminTask.deletePolicy('-coreGroupName myCoreGroup -policyName myPolicy')

• Use Jython list:
  AdminTask.deletePolicy('-coreGroupName', 'myCoreGroup', '-policyName', 'myPolicy')

Interactive mode example usage

• Use Jython:
  AdminTask.deletePolicy('-interactive')

modifyPolicy

Modify a specific core group policy of interest. 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)

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. The policy name cannot end with a space character.

Optional parameters:

-newPolicyName

Nameew name for the policy of interest. (String, optional)

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. The policy name cannot end with a space character.

-matchCriteria

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

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 cannot be null or empty.

-isAlive

Specifies, in seconds, the interval of time at which the high availability manager checks the health of the active group members 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 used to protect resources that are shared across members of the group in the event of a failure. Quorum is an advanced hardware function. Do not enable this function unless you properly understand how to 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

• Use Jython string:
  AdminTask.modifyPolicy('-coreGroupName myCoreGroup -policyName myPolicy -newPolicyName myPolicyRenamed')

• Use Jython list:
  AdminTask.modifyPolicy('-coreGroupName', 'myCoreGroup', '-policyName', 'myPolicy', '-newPolicyName', 'myPolicyRenamed')

Interactive mode example usage

• Use Jython:
  AdminTask.modifyPolicy('-interactive')

Configure a core group policy for messaging engines

Configure a Static policy for service integration

Configure a One of N policy for service integration

Configure a 'No operation' policy for service integration

Core group policies

Core group policy settings