You can use the following administrative tasks to create, delete, and manage health policies.
Argument | Description |
---|---|
name (required) | Specifies a name for the health policy that is unique in the cell. |
description | Specifies a description for the health policy. |
reactionMode | Specifies if runtime tasks are created before taking actions on a health policy, or if actions are automatic. The value can be SUPERVISE or AUTOMATIC. |
Argument | Description |
---|---|
type (required) | Specifies the condition type. The value can be CUSTOM, AGE, WORKLOAD, MEMORY_LEAK, EXCESSIVE_MEMORY, EXCESSIVE_RESPONSE_TIME, EXCESSIVE_REQUEST_TIMEOUT, STORM_DRAIN or GC_PERCENTAGE. Each value has different parameters that you must specify. |
expression | If you are using a custom condition, then specify a subexpression to evaluate. |
params |
|
Argument | Description |
---|---|
type (required) | Specifies the action type. The value can be CUSTOM, HEAPDUMP, THREADDUMP, RESTART_SERVER, SET_MAINT_MODE, MAINT_MODE_BREAK, or MAINT_MODE_STOP. |
stepNum (required) | Specifies the order in which to take the actions. Step 1 is completed first, and so on. |
action | Specifies the name of a custom action. Use the createHealthAction command to create a custom action. This parameter is only required for custom actions. |
node | Specifies the node on which to take the action. This parameter is only required for custom actions. Valid options are a node name or the empty string "". |
server | Specifies the server on
which to take the action. This parameter is required only for custom actions. Valid options are a server name or one of the following strings: "Sick server" or "Node agent of the sick server". If either of these strings are used, the valid node value is the empty string, "". |
Argument | Description |
---|---|
type (required) | Specifies the type of member. The value can be CELL, CLUSTER, DYNAMIC_CLUSTER, SERVER, or ODR. |
name (required) | Specifies the name of the member. |
node | Specifies the name of the node. The node name is required if you select the SERVER type. |
Interactive mode example usage:
$AdminTask createHealthPolicy {-interactive}
AdminTask.createHealthPolicy ('[-interactive]')
Batch mode example usage:
The following command creates a health policy with one of the predefined health conditions:
$AdminTask createHealthPolicy { -name myHealthPolicy -description "My Health Policy" -reactionMode SUPERVISE -addCondition { -type AGE -params {{maxAge 12} {ageUnits HOURS}} } -addAction {{HEAPDUMP 1}{CUSTOM 2 myAction myNode myServer} } -addMember {{SERVER myServer1 myNode1}{SERVER myServer2 mynode2}}
The following command creates a health policy with a custom condition:
$AdminTask createHealthPolicy { -name myHealthPolicy -description "My Health Policy" -reactionMode SUPERVISE -addCondition { -type CUSTOM -expression "ODRServerMetric_FromServerStart$errors > 100L" } -addAction {{HEAPDUMP 1}{CUSTOM 2 myAction myNode myServer} } -addMember {{SERVER myServer1 myNode1}{SERVER myServer2 mynode2}}Put the expression for your custom condition in quotes.
Argument | Description |
---|---|
name (required) | Specifies the name of the health policy that you want to change. |
reactionMode | Specifies if runtime tasks are created before taking actions on a health policy, or if actions are automatic. The value can be SUPERVISE or AUTOMATIC. |
Argument | Description |
---|---|
type | Specifies the condition type. The value can be CUSTOM, AGE, WORKLOAD, MEMORY_LEAK, EXCESSIVE_MEMORY, EXCESSIVE_RESPONSE_TIME, EXCESSIVE_REQUEST_TIMEOUT, STORM_DRAIN or GC_PERCENTAGE. Each value has different parameters that you must specify. |
expression | If you are using a custom condition, then specify a subexpression to evaluate. |
params |
|
Argument | Description |
---|---|
name | Specifies the name of the health action to remove. The name parameter is only used for custom actions. |
type (required) | Specifies the action type. The value can be CUSTOM, HEAPDUMP, THREADDUMP, RESTART_SERVER, SET_MAINT_MODE, MAINT_MODE_BREAK, or MAINT_MODE_STOP. |
Argument | Description |
---|---|
type (required) | Specifies the action type. The value can be CUSTOM, HEAPDUMP, THREADDUMP, RESTART_SERVER, SET_MAINT_MODE, MAINT_MODE_BREAK, or MAINT_MODE_STOP. |
action | Specifies the name of the health action. Use the createHealthAction command to create a custom action. This parameter is only required for custom actions. |
node | Specifies the node on which to take the action. This parameter is only required for custom actions. Valid options are a node name or the empty string "". |
server | Specifies the server on
which to take the action. This parameter is required only for custom actions. Valid options are a server name or one of the following strings: "Sick server" or "Node agent of the sick server". If either of these strings are used, the valid node value is the empty string, "". |
stepNum (required) | Specifies the order in which to take the actions. Step 1 is completed first, and so on. |
Argument | Description |
---|---|
name | Specifies the name of the health action. The name parameter is only used for custom actions. |
type | Specifies the action type. The value can be CUSTOM, HEAPDUMP, THREADDUMP, RESTART_SERVER, SET_MAINT_MODE, MAINT_MODE_BREAK, or MAINT_MODE_STOP. |
stepNum (required) | Specifies the order in which to take the actions. Step 1 is completed first, and so on. |
Argument | Description |
---|---|
type (required) | Specifies the type of member. The value can be CELL, CLUSTER, DYNAMIC_CLUSTER, SERVER, or ODR. |
name (required) | Specifies the name of the member. |
node | Specifies the name of the node. The node name is required if you select the SERVER type. |
Interactive mode example usage:
$AdminTask modifyHealthPolicy {-interactive}
AdminTask.modifyHealthPolicy ('[-interactive]')
Batch mode example usage:
$AdminTask modifyHealthPolicy { -name myHealthPolicy -removeAction { -type HEAPDUMP } }
Argument | Description |
---|---|
name (required) | Specifies the health policy name to delete. |
Batch mode example usage:
$AdminTask deleteHealthPolicy {-name MyHealthPolicy}
AdminTask.deleteHealthPolicy('MyHealthPolicy')
Interactive mode example usage:
$AdminTask deleteHealthPolicy {-interactive}
AdminTask.deleteHealthPolicy ('[-interactive]')
$AdminTask listHealthPolicies
AdminTask.listHealthPolicies
Argument | Description |
---|---|
name (required) | Specifies a name for the health action. |
Argument | Description |
---|---|
executable | Specifies the executable file path. This argument is required if you specify a nonJava step argument. |
executableArgs | Specifies a string array of arguments to pass to the executable file. |
osNames | Specifies a comma-delimited list of operating systems. Specify null to have the action apply for each operating system. The valid operating system names include: windows, unix, and zos. |
workingDir | Specifies the location in the file system from where the command is invoked. This argument is required if you specify a nonJava step argument. |
usernameVar | Specifies a variable for the user name. |
userNameVal | Specifies the value of the user name variable. |
passwordVar | Specifies a variable for the password. |
passwordVal | Specifies the value of the password variable. |
Argument | Description |
---|---|
javaDir | Specifies the location of your Java executable file, for example, ${JAVA_HOME}. You can specify a variable or a path. |
executableTargetType | Specifies the file type that you are using for your Java executable file. The value can be EXECUTABLE_JAR or JAVA_CLASS. |
executable | Specifies the executable file path. This argument is required if you specify a Java step argument. |
exectuableArgs | Specifies a string array of arguments to pass to the executable file. |
osNames | Specifies a comma-delimited list of operating systems. Specify null to have the action apply for each operating system. The valid operating system names include: windows, unix, and zos. |
pidVarName | Specifies the Java process id variable name. |
workingDir | Specifies the location in the file system from where the command is invoked. This argument is required if you specify a Java step argument. |
usernameVar | Specifies a variable for the user name. |
usernameVal | Specifies the value of the user name variable. |
passwordVar | Specifies a variable for the password. |
passwordVal | Specifies the value of the password variable. |
Batch mode example usage:
$AdminTask createHealthAction { -name myAction -java { -javaDir c:\java\bin -executableTargetType EXECUTABLE_JAR -executable test.jar -executableArgs "{arg1}{arg2a arg2b}" -osNames "windows, unix" -pidVarName pvn -workingDir c:\workingDir } }
Interactive mode example usage:
$AdminTask createHealthAction {-interactive}
AdminTask.createHealthAction('[-interactive]')
Argument | Description |
---|---|
name (required) | Specifies a name for the health action that you want to modify. |
Argument | Description |
---|---|
executable | Specifies the executable file path. |
executableArgs | Specifies a string array of arguments to pass to the executable file. |
workingDir | Specifies the location in the file system from where the command is invoked. |
usernameVar | Specifies a variable for the user name. |
usernameVal | Specifies the value of the user name variable. |
passwordVar | Specifies a variable for the password. |
passwordVal | Specifies the value of the password variable. |
Argument | Description |
---|---|
javaDir | Specifies the location of your Java executable file, for example, ${JAVA_HOME}. You can specify a variable or a path. |
executableTargetType | Specifies the file type that you are using for your Java executable file. The value can be EXECUTABLE_JAR or JAVA_CLASS. |
executable | Specifies the executable file path. |
executableArgs | Specifies a string array of arguments to pass to the executable file. |
pidVarName | Specifies the Java process id variable name. |
usernameVar | Specifies a variable for the user name. |
usernameVal | Specifies the value of the user name variable. |
passwordVar | Specifies a variable for the password. |
passwordVal | Specifies the value of the password variable. |
workingDir | Specifies the location in the file system from where the command is invoked. |
Batch mode example usage:
$AdminTask modifyHealthAction { -name myAction -java { -javaDir c:\java\bin -executableTargetType EXECUTABLE_JAR -executable test.jar -executableArgs "{arg1}{arg2a arg2b}" -pidVarName pvn -workingDir c:\workingDir } }
Interactive mode example usage:
$AdminTask modifyHealthAction {-interactive}
AdminTask.modifyHealthAction('[-interactive]')
Argument | Description |
---|---|
name (required) | Specifies a name for the health action. |
Batch mode example usage:
$Admintask deleteHealthAction {-name myHealthAction}
AdminTask.deleteHealthAction('-name myHealthAction')
Batch mode example usage:
$Admintask listHealthActions
AdminTask.listHealthActions
Argument | Description |
---|---|
name (required) | Specifies the name of the health action that you want to run. |
node (required) | Specifies the node on which to take the action. This parameter is only required for custom actions. Valid options are a node name or the empty string "". |
server (required) | Specifies the server on which to take the action. |
cell | Specifies the cell on which to run the health action. |
timeout | Specifies a timeout value for running the health action. |
variables | Specifies java.util.Properties values of variables. |
Batch mode example usage:
$AdminTask executeHealthAction {-name myHealthAction -node myNode -server myServer}
AdminTask.executeHealthAction ('[-name myHealthAction -node myNode -server myServer]')
Interactive mode example usage:
$AdminTask executeHealthAction {-interactive}
AdminTask.executeHealthAction ('[-interactive]')