1. Preface

1.1. Who Should Use This Guide

EXPRESSCLUSTER® X Command Reference Guide for Cluster Configuration is intended for system engineers who introduce EXPRESSCLUSTER-based cluster systems, and system administrators who maintain and operate the introduced cluster systems. The guide describes how to create clp.conf (a cluster configuration data file) by using command lines.

1.2. How This Guide is Organized

1.3. EXPRESSCLUSTER X Documentation Set

The EXPRESSCLUSTER X manuals consist of the following four guides. The title and purpose of each guide is described below:

EXPRESSCLUSTER X Getting Started Guide

This guide is intended for all users. The guide covers topics such as product overview, system requirements, and known problems.

EXPRESSCLUSTER X Installation and Configuration Guide

This guide is intended for system engineers and administrators who want to build, operate, and maintain a cluster system. Instructions for designing, installing, and configuring a cluster system with EXPRESSCLUSTER are covered in this guide.

EXPRESSCLUSTER X Reference Guide

This guide is intended for system administrators. The guide covers topics such as how to operate EXPRESSCLUSTER, function of each module and troubleshooting. The guide is supplement to the Installation and Configuration Guide.

EXPRESSCLUSTER X Maintenance Guide

This guide is intended for administrators and for system administrators who want to build, operate, and maintain EXPRESSCLUSTER-based cluster systems. The guide describes maintenance-related topics for EXPRESSCLUSTER.

1.4. Conventions

In this guide, Note, Important, See also are used as follows:

Note

Used when the information given is important, but not related to the data loss and damage to the system and machine.

Important

Used when the information given is necessary to avoid the data loss and damage to the system and machine.

See also

Used to describe the location of the information given at the reference destination.

The following conventions are used in this guide.

Convention

Usage

Example

italic

Indicates that users should replace italicized part with values that they are actually working with.

clpcfadm.py add mon <Monitor resource type> <Monitor resource name>

1.5. Contacting NEC

For the latest product information, visit our website below:

https://www.nec.com/global/prod/expresscluster/

2. Command reference

2.1. clpcfadm.py command

This command generates clp.conf, a cluster configuration data file.

Command line
  • clpcfadm.py {create} clustername charset [-e encode] [-s serveros]

  • clpcfadm.py {add} srv servername priority

  • clpcfadm.py {add} hba servername id portnumber deviceid instanceid

  • clpcfadm.py {add} device servername type id info [extend]

  • clpcfadm.py {add} forcestop env

  • clpcfadm.py {add} hb lankhb deviceid priority

  • clpcfadm.py {add} hb witnesshb deviceid priority host

  • clpcfadm.py {add} np disknp deviceid priority extend

  • clpcfadm.py {add} np pingnp deviceid priority groupid listid ipaddress

  • clpcfadm.py {add} np httpnp deviceid priority [--host host]

  • clpcfadm.py {add} np majonp deviceid priority

  • clpcfadm.py {add} grp grouptype groupname

  • clpcfadm.py {add} rsc groupname resourcetype resourcename

  • clpcfadm.py {add} rscdep resourcetype resourcename dependresourcename

  • clpcfadm.py {add} mon monitortype resourcename

  • clpcfadm.py {del} srv servername

  • clpcfadm.py {del} hba servername id

  • clpcfadm.py {del} device servername id

  • clpcfadm.py {del} forcestop

  • clpcfadm.py {del} hb lankhb deviceid

  • clpcfadm.py {del} hb witnesshb deviceid

  • clpcfadm.py {del} np disknp deviceid

  • clpcfadm.py {del} np pingnp deviceid

  • clpcfadm.py {del} np httpnp deviceid

  • clpcfadm.py {del} np majonp deviceid

  • clpcfadm.py {del} grp groupname

  • clpcfadm.py {del} rsc groupname resourcetype resourcename

  • clpcfadm.py {del} rscdep resourcetype resourcename

  • clpcfadm.py {del} mon monitortype resourcename

  • clpcfadm.py {mod} -t [tagname] [--set parameter] [--delete] [--nocheck]

Option
  • --backup
    This option can be used with any of the above command lines.
    Using this option allows you to create clp.conf.bak (a backup of clp.conf before command execution) in the current directory.
    If clp.conf.bak already exists in the current directory, executing a command with this option overwrites the file.

    Note

    Not existing in the current directory, clp.conf.bak is created by executing a command with or without this option.

Return value

0

Success

Other than 0

Failure

System requirements

Software

Version

Remarks

Python

3.6.8 or later

Notes
  • Run the command as an administrator.

  • Run the command with clp.conf placed in the current directory.

  • This command generates only clp.conf among cluster configuration data files.
    You must manually create script files for such resources as script resources and custom monitor resources.
    Example

    For placing script files of a script resource (script1) belonging to a failover group (failover1), and of a custom monitor resource (genw1)

    scripts
     +--failover1
     |   +--script1
     |          start.bat
     |          stop.bat
     |
     +--monitor.s
         +--genw1
                genw.bat
    
  • This command does not automatically add monitor resources which are automatically added by adding group resources through Cluster WebUI or Cluster WebUI Offline.
    To add the monitor resources, see "Monitor resource that must be added" of the following table:

    Group resource

    Monitor resource that must be added

    Application resource

    Application monitor resource

    AWS DNS resource

    AWS AZ monitor resource

    AWS Elastic IP resource

    AWS Elastic IP monitor resource

    AWS Virtual IP resource

    AWS Virtual IP monitor resource

    Azure DNS resource

    Azure DNS monitor resource

    Azure probe port resource

    Azure load balance monitor resource
    Azure probe port monitor resource

    CIFS resource

    CIFS monitor resource

    Dynamic DNS resource

    Dynamic DNS monitor resource

    Floating IP resource

    Floating IP monitor resource

    Google Cloud Virtual IP resource

    Google Cloud load balance monitor resource
    Google Cloud Virtual IP monitor resource

    Hybrid disk resource

    Hybrid disk TUR monitor resource
    Hybrid disk monitor resource

    Mirror disk resource

    Mirror disk monitor resource

    Oracle Cloud DNS resource

    Oracle Cloud DNS monitor resource

    Oracle Cloud Virtual IP resource

    Oracle Cloud load balance monitor resource
    Oracle Cloud Virtual IP monitor resource

    Registry synchronization resource

    Registry synchronization monitor resource

    Disk resource

    Disk TUR monitor resource

    Service resource

    Service monitor resource

    Virtual computer name resource

    Virtual computer name monitor resource

    Virtual IP resource

    Virtual IP monitor resource

  • To apply the cluster configuration data file to an operating cluster, run the clpcfctrl command.

Error Messages

Message

Cause/Solution

Log in as Administrator.

Run the command as an administrator.

'%1' is not found.

The file (%1) is not found.

The specified object does not exist. '%1'

The specified object (%1) does not exist.

The specified element '%1' does not exist in '%2'.

The specified element (%1) does not exist in %2.

The specified path does not exist in a config file.

The specified path is not included in the cluster configuration data.

Invalid config file. Use the 'create' option.

Execute this command with the create option.

The config file already exists.

The cluster configuration data already exists.

Non-configurable elements specified.

The tag name cannot be specified.

Invalid value specified. Specify as follows: <resource type>@<resource name>

Specify a value in the form of <type of group resource>@<name of group resource>.

Invalid path specified.

The specified path is invalid.

Cannot register a '%1' any more.

%1 has already reached the upper limit of registration.

The following arguments are required :%1

Specify %1.

Argument %1: allowed only with argument '%2'

The %1 option is effective only with %2.

Argument %1: invalid choice: '%2' (choose from %3)

%2 specified in %1 is invalid. Choose a value from %3.

Argument %1: invalid value: '%2' (The value must be in the range [%3, %4])

%2 specified in %1 is invalid. Specify a numeric value between %3 and %4.

Argument %1: invalid value: '%2' (The length must be less than %3)

%2 specified in %1 is too long in the string. Shorten it to less than %3.

Argument %1: '%2' already exists.

%2 already exists in %1.

Argument %1: '%2' does not exist.

%2 does not exist in %1.

Argument %1: cannot specify a dependency to the same object.

%1 specifies dependency on the same object. Specify a different object.

Argument %1: does not appear to be an IPv4.

%1 is invalid. Specify it in IPv4 format.

Invalid value: '%1' (The value must be greater than 0)

%1 is invalid. Specify a numeric value greater than 0.

2.2. clpencrypt command

Encrypts a character string.

Command line
clpencrypt <password (plaintext)>
Return value

0

Success

Other than 0

Failure

Example of Execution
  • Encrypt a password string.

    Execute: clpencrypt <password (plaintext)>
    Output: <Encrypted password>
    
    Execution example: clpencrypt password
    Output example: 20220001111abaabdbb35c04
    
Error Messages

Message

Cause/Solution

Invalid parameter.

The parameter is invalid. Check if there is any error in its format or parameter.

2.3. clpdiskctrl command

This command sets or gets a GUID of or HBA information on a drive.

Command line
clpdiskctrl {set|--set} filter <Drive letter>
clpdiskctrl {get|--get} guid <Drive letter>
clpdiskctrl {get|--get} hda <Drive letter>
Return value

0

Success

Other than 0

Failure

Example of Execution
  • Set an HBA filter by specifying the drive.

    Execute: clpdiskctrl set filter <Drive letter>
    Output: Command succeeded.
    Execution example: clpdiskctrl set filter R:\
    Output example: Command succeeded.
  • Get a GUID by specifying the drive.

    Execute: clpdiskctrl get guid <Drive letter>
    Output: <GUID>
    
    Execution example: clpdiskctrl get guid R:\
    Output example: b7131c40-1f5a-46d0-ab51-57af15478ba3
  • Get HBA information by specifying the drive.

    Execute: clpdiskctrl get hba <Drive letter>
    Output: <Port Number> <HBA device ID> <HBA instance ID>
    
    Execution example: clpdiskctrl get hba R:\
    Output example: 4 ROOT\ISCSIPRT 0000
Notes

Run the command as an administrator.

Error Messages

Message

Cause/Solution

Log in as Administrator.

Run the command as an administrator.

Invalid parameter.

The parameter is invalid. Check if there is any error in its format or parameter.

Drive not found.

The specified drive is not found. Check if you have specified the right drive.

Device no info.

Failed to obtain the device data. Check if the disk functions normally.

Specify the data drive.

Specify other than the Windows system drive (usually C:).

Failed to set filter.

Failed to set the filter.

Internal error.

Check if the memory or OS resource is sufficient.

3. Creating a cluster

Be sure to set the following items. For details, see "Setting cluster properties".

Item (mandatory)

Cluster name

Language

Server settings 1

Interconnect settings 2

Monitor resource (user mode monitor) settings 3

# Create a cluster
clpcfadm.py create <Cluster name> <Language>

# Add a server
clpcfadm.py add srv <Server name> <Priority>

# Add an interconnect (kernel mode)
clpcfadm.py add hb lankhb <Device ID> <Priority>
clpcfadm.py add device <Server name> lan <Device ID> <IP Address>

# Add a monitor resource (user mode monitor: keepalive)
clpcfadm.py add mon userw userw
clpcfadm.py mod -t monitor/userw@userw/target --set "" 4
clpcfadm.py mod -t monitor/userw@userw/relation/name --set LocalServer --nocheck
clpcfadm.py mod -t monitor/userw@userw/relation/type --set cls --nocheck
1

For details, see "Adding a server".

2

For details, see "Interconnect".

3

For details, see "Adding a user mode monitor resource".

4

Note

In the path of a user mode monitor resource, always set an empty value.

Note

If you configure a cluster only with the above mandatory items, other parameters are set to their default values.

4. Setting cluster properties

4.1. Basic information

  • Cluster name (Within 31 bytes)

    clpcfadm.py mod -t cluster/name --set <Cluster name>
  • Comment (Within 127 bytes)

    clpcfadm.py mod -t cluster/comment --set <Comment>

    Note

    Enclose in double quotes a string including spaces (e.g., "Sample Comment").

  • Language

    Language

    Value

    English

    ASCII

    Japanese

    SJIS

    Chinese

    GB2312

    clpcfadm.py mod -t all/charset --set <Value>

4.2. Interconnect

Heartbeat I/F
Add

Important

Set at least one LAN heartbeat (kernel mode).

Note

With only one heartbeat interface, specify 0 for Priority.
With more than one heartbeat interface, specify consecutive numbers (e.g., 0, 1, 2...).
Kernel mode
clpcfadm.py add hb lankhb <Device ID> <Priority>
clpcfadm.py add device <Server name> lan <Device ID> <IP Address>

Note

With only one LAN heartbeat (kernel mode), specify 0 for Device ID.
With more than one LAN heartbeat (kernel mode), specify consecutive numbers (e.g., 0, 1, 2...).
Witness
clpcfadm.py add hb witnesshb <Witness device ID> <Priority> <IP Address : Port Number>
clpcfadm.py add device <Server name> witness <Device ID> <Use/Not use> <IP Address : Port Number>

Note

Set Use/Not use to 1(if you use the device) or 0 (if not).

Note

With only one Witness, specify 0 for Witness Device ID.
With more than one Witness, specify consecutive numbers (e.g., 0, 1, 2...).
  • Use SSL

    Use SSL

    Value

    Use

    1

    Do not use (default)

    0

    clpcfadm.py mod -t heartbeat/witnesshb@witnesshb1/ssl/use --set <Value>
  • Use Proxy

    Use Proxy

    Value

    Use

    1

    Do not use (default)

    0

    clpcfadm.py mod -t heartbeat/witnesshb@witnesshb1/proxy/use --set <Value>
  • HTTP Timeout (sec)

    Default, 10 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t heartbeat/witnesshb@witnesshb1/http_timeout --set <Value>
MDC

To configure an MDC, which is dedicated to mirroring communication, set as follows:

clpcfadm.py add device <Server name> mdc <Device ID> <IP Address>

Note

With only one MDC, specify 0 for Device ID.
With more than one MDC, specify consecutive numbers (e.g., 0, 1, 2...).
Delete
Kernel mode
clpcfadm.py del hb lankhb <Device ID>
clpcfadm.py del device <Server name> <Device ID>
Witness
clpcfadm.py del hb witnesshb <Device ID>
clpcfadm.py del device <Server name> <Device ID>

Important

For Device ID, specify the total of the following: 700 + the value specified in "Add" in this section.

# Add
clpcfadm.py add hb witnesshb 0 <Priority>
clpcfadm.py add device <Server name> witness 0 <Use/Not use> <Target IP address : Port Number>

# Delete
clpcfadm.py del hb witnesshb 700
clpcfadm.py del device <Server name> 700
MDC

To delete an MDC, which is dedicated to mirroring communication, set as follows:

clpcfadm.py del device <Server name> <Device ID>

Important

For Device ID, specify the total of the following: 400 + the value specified in "Add" in this section

# Add
clpcfadm.py add device <Server name> mdc 0 <IP Address>

# Delete
clpcfadm.py del device <Server name> 400
Server Down Notification
  • Server Down Notification

    Server Down Notification

    Value

    Notify (default)

    1

    Do not notify

    0

    clpcfadm.py mod -t cluster/downnotify --set <Value>
    Detailed Settings (Server Down Notification)
    • Server Reset Notification

      Server Reset Notification

      Value

      Notify

      1

      Do not notify (default)

      0

      clpcfadm.py mod -t cluster/dyingnotify/use --set <Value>

      Note

      Set as above with "Server Down Notification" set to "Notify".

      • Execute Server Alive Check

        Execute Server Alive Check

        Value

        Check

        1

        Do not check (default)

        0

        clpcfadm.py mod -t cluster/dyingnotify/precheck/use --set <Value>

        Note

        Set as above with "Server Reset Notification" set to "Notify".

        • Timeout (sec)

          Default, 1 (minimum, 1; maximum, 9999)

          clpcfadm.py mod -t cluster/dyingnotify/precheck/ping/timeout --set <Value>

          Note

          Set as above with "Execute Server Alive Check" set to "Check".

4.3. Fencing

4.3.1. NP resolution

Add

Note

With only one NP resolution, specify 0 for Priority.
With more than one NP resolution, specify consecutive numbers (e.g., 0, 1, 2...).
DISK
clpcfadm.py add np disknp <Device ID> <Priority>
clpcfadm.py add device <Server name> disknp <Device ID> <Volume ID> <Device path>

Note

With only one NP resolution (DISK), specify 0 for Device ID.
With more than one NP resolution (DISK), specify consecutive numbers (e.g., 0, 1, 2...).
  • IO Wait Time (sec)

    Default, 80 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t networkpartition/disknp@<disknp name(disknp1)>/iotimeout --set <Value>
Monitor
  • Interval (sec)

    Default, 60 (minimum, 1; maximum, 999)

    clpcfadm.py mod -t networkpartition/disknp@<disknp name(disknp1)>/interval --set <Value>
  • Timeout (sec)

    Default, 300 (minimum, 5; maximum, 999)

    clpcfadm.py mod -t networkpartition/disknp@<disknp name(disknp1)>/timeout --set <Value>
  • Retry Count

    Default, 0 (minimum, 0; maximum, 999)

    clpcfadm.py mod -t networkpartition/disknp@<disknp name(disknp1)>/count --set <Value>
Ping
clpcfset add np pingnp <Device ID> <Priority> <Group ID> <List ID> <IP Address>
clpcfadm.py add device <Server name> ping <Device ID> <Use/Not use>

Note

Set Use/Not use to 1(if you use the device) or 0 (if not).

Note

With only one NP resolution (Ping), specify 0 for Device ID.
With more than one NP resolution (Ping), specify consecutive numbers (e.g., 0, 1, 2...).

Note

With only one group, specify 0 for Group ID.
With more than one group, specify consecutive numbers (e.g., 0, 1, 2...).

Note

With only one IP address in the same group, specify 0 for List ID.
With more than one IP address in the same group, specify consecutive numbers (e.g., 0, 1, 2...).
Detailed Settings

Note

Specify the value of a heartbeat timeout to satisfy the following inequality:

Heartbeat timeout > Ping NP interval x Ping NP retry count + Ping NP timeout

  • Interval (sec)

    Default, 5 (minimum, 2; maximum, 999)

    clpcfadm.py mod -t networkpartition/pingnp@<pingnp name(pingnp1)>/interval --set <Value>
  • Timeout (sec)

    Default, 3 (minimum, 1; maximum, 999)

    clpcfadm.py mod -t networkpartition/pingnp@<pingnp name(pingnp1)>/timeout --set <Value>
  • Retry Count

    Default, 3 (minimum, 1; maximum, 999)

    clpcfadm.py mod -t networkpartition/pingnp@<pingnp name(pingnp1)>/count --set <Value>
HTTP
clpcfadm.py add np httpnp <Device ID> <Priority> --host <IP Address : Port Number>
clpcfadm.py add device <Server name> http <Device ID> <Use/Not use>

Note

Set Use/Not use to 1(if you use the device) or 0 (if not).

Note

With only one NP resolution (HTTP), specify 0 for Device ID.
With more than one NP resolution (HTTP), specify consecutive numbers (e.g., 0, 1, 2...).

Note

To use Witness HB resource settings, set as follows:

clpcfadm.py mod -t networkpartition/httpnp@<httpnp name(httpnp1)>/witnesshb/use --set 1
  • Target Host (Within 255 bytes)

    clpcfadm.py mod -t networkpartition/httpnp@<httpnp name(httpnp1)>/host --set <Target Host>
  • Request URI (Within 1023 bytes)

    Default: /

    clpcfadm.py mod -t networkpartition/httpnp@<httpnp name(httpnp1)>/requesturi --set <Request URI>
  • Service Port

    Default, 80 (minimum, 1; maximum, 65535)

    clpcfadm.py mod -t networkpartition/httpnp@<httpnp name(httpnp1)>/port --set <Value>
  • Use SSL

    Use SSL

    Value

    Use

    1

    Do not use (default)

    0

    clpcfadm.py mod -t networkpartition/httpnp@<httpnp name(httpnp1)>/ssl/use --set <Value>
  • Use Proxy

    Use Proxy

    Value

    Use

    1

    Do not use (default)

    0

    clpcfadm.py mod -t networkpartition/httpnp@<httpnp name(httpnp1)>/proxy/use --set <Value>
  • Interval (sec)

    Default, 5 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t networkpartition/httpnp@<httpnp name(httpnp1)>/interval --set <Value>
  • Timeout (sec)

    Default, 20 (minimum, 1; maximum, 99)

    clpcfadm.py mod -t networkpartition/httpnp@<httpnp name(httpnp1)>/timeout --set <Value>
  • HTTP Timeout (sec)

    Default, 10 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t networkpartition/httpnp@<httpnp name(httpnp1)>/http_timeout --set <Value>
Majority
clpcfadm.py add np majonp <Device ID> <Priority>
clpcfadm.py add device <Server name> majo <Device ID> <Use/Not use>

Note

Set Use/Not use to 1(if you use the device) or 0 (if not).

Note

With only one NP resolution (majority method), specify 0 for Device ID.
With more than one NP resolution (majority method), specify consecutive numbers (e.g., 0, 1, 2...).
Delete
DISK
clpcfadm.py del np disknp <Device ID>
clpcfadm.py del device <Server name> <Device ID>

Important

For Device ID, specify the total of the following: 10100 + the value specified in "Add" in this section.

# Add
clpcfadm.py add np disknp 0 <Priority>
clpcfadm.py add device <Server name> disknp 0 <Volume ID> <Device path>

# Delete
clpcfadm.py del np disknp 10100
clpcfadm.py del device <Server name> 10100
Ping
clpcfadm.py del np pingnp <Device ID>
clpcfadm.py del device <Server name> <Device ID>

Important

For Device ID, specify the total of the following: 10200 + the value specified in "Add" in this section.

# Add
clpcfadm.py add np pingnp 0 <Priority> <Group ID> <List ID> <IP Address>
clpcfadm.py add device <Server name> ping 0 <Use/Not use>

# Delete
clpcfadm.py del np pingnp 10200
clpcfadm.py del device <Server name> 10200
HTTP
clpcfadm.py del np httpnp <Device ID>
clpcfadm.py del device <Server name> <Device ID>

Important

For Device ID, specify the total of the following: 10700 + the value specified in "Add" in this section.

# Add
clpcfadm.py add np httpnp 0 <Priority>
clpcfadm.py add device <Server name> http 0 <Use/Not use>

# Delete
clpcfadm.py del np httpnp 10700
clpcfadm.py del device <Server name> 10700
Majority
clpcfadm.py del np majonp <Device ID>
clpcfadm.py del device <Server name> <Device ID>

Important

For Device ID, specify the total of the following: 10300 + the value specified in "Add" in this section.

# Add
clpcfadm.py add np majonp 0 <Priority>
clpcfadm.py add device <Server name> majo 0 <Use/Not use>

# Delete
clpcfadm.py del np majonp 10300
clpcfadm.py del device <Server name> 10300
Tuning
  • Action at NP Occurrence

    Action at NP Occurrence

    Value

    Stop the cluster service

    1

    Stop the cluster service and shutdown OS

    3

    Stop the cluster service and reboot OS

    4

    Emergency shutdown (default)

    2

    Generate an intentional stop error

    5

    Reset the hardware

    6

    clpcfadm.py mod -t cluster/networkpartition/npaction --set <Value>

4.3.2. Forced stop

Note

For a forced-stop configuration, configure two or more servers.

Add
BMC
clpcfadm.py add forcestop bmc
clpcfadm.py mod -t forcestop/bmc/server@<Server name>/parameters/ip --set <IP Address> --nocheck
clpcfadm.py mod -t forcestop/bmc/server@<Server name>/parameters/user --set <User Name> --nocheck
clpcfadm.py mod -t forcestop/bmc/server@<Server name>/parameters/password --set <Encrypted password> --nocheck
clpcfadm.py mod -t forcestop/bmc/server@<Server name>/use --set 1 --nocheck
Server List
  • IP Address

    clpcfadm.py mod -t forcestop/bmc/server@<Server name>/parameters/ip --set <IP Address> --nocheck
  • User Name (Within 255 bytes)

    clpcfadm.py mod -t forcestop/bmc/server@<Server name>/parameters/user --set <User Name> --nocheck
  • Password (Within 255 bytes)

    clpcfadm.py mod -t forcestop/bmc/server@<Server name>/parameters/password --set <Encrypted password> --nocheck

    Note

    Set an encrypted password string.
Forced Stop
  • Forced Stop Action

    Forced Stop Action

    Value

    BMC Power Off (default)

    poweroff

    BMC Power Cycle

    powercycle

    BMC Reset

    reset

    BMC NMI

    nmi

    clpcfadm.py mod -t forcestop/bmc/parameters/action --set <Value>
  • Forced Stop Timeout (sec)

    Default, 15 (minimum, 5; maximum, 999)

    clpcfadm.py mod -t forcestop/bmc/exec/timeout --set <Value>
  • Time to Wait for Stop to Be Completed (sec)

    Default, 15 (minimum, 5; maximum, 999)

    clpcfadm.py mod -t forcestop/bmc/wait/timeout --set <Value>

    Note

    Set as above with "Forced Stop Action" set to "BMC Power Off".

  • Lead Time between a Stop Request and a Failover Start (sec)

    Default, 15 (minimum, 0; maximum, 999)

    clpcfadm.py mod -t forcestop/bmc/wait/fodelay --set <Value>

    Note

    Set as above with "Forced Stop Action" set to "BMC Power Cycle", "BMC Reset", or "BMC NMI".

  • Disable Group Failover When Execution Fails

    Disable Group Failover When Execution Fails

    Value

    Suppress

    1

    Do not suppress (default)

    0

    clpcfadm.py mod -t forcestop/bmc/suppression --set <Value>
vCenter
clpcfadm.py add forcestop vcenter
clpcfadm.py mod -t forcestop/vcenter/parameters/ip --set <Host Name> --nocheck
clpcfadm.py mod -t forcestop/vcenter/parameters/user --set <User Name> --nocheck
clpcfadm.py mod -t forcestop/vcenter/parameters/password --set <Encrypted password> --nocheck
clpcfadm.py mod -t forcestop/vcenter/parameters/method --set <Method of performing forced stop>
clpcfadm.py mod -t forcestop/vcenter/server@<Server name>/parameters/vmname --set <Virtual Machine Name> --nocheck
clpcfadm.py mod -t forcestop/vcenter/server@<Server name>/parameters/datacenter --set <Data Center> --nocheck
clpcfadm.py mod -t forcestop/vcenter/server@<Server name>/parameters/commandpath --set "" --nocheck
clpcfadm.py mod -t forcestop/vcenter/server@<Server name>/parameters/perlpath --set "" --nocheck
clpcfadm.py mod -t forcestop/vcenter/server@<Server name>/use --set 1 --nocheck
Server List
  • Virtual Machine Name (Within 80 bytes)

    clpcfadm.py mod -t forcestop/vcenter/server@<Server name>/parameters/vmname --set <Virtual Machine Name> --nocheck
  • Data Center (Within 80 bytes)

    clpcfadm.py mod -t forcestop/vcenter/server@<Server name>/parameters/datacenter --set <Data Center> --nocheck
Forced Stop
  • Forced Stop Action

    Forced Stop Action

    Value

    Power Off (default)

    poweroff

    Reset

    reset

    clpcfadm.py mod -t forcestop/vcenter/parameters/action --set <Value>
  • Forced Stop Timeout (sec)

    Default, 10 (minimum, 5; maximum, 999)

    clpcfadm.py mod -t forcestop/vcenter/exec/timeout --set <Value>
  • Time to Wait for Stop to Be Completed (sec)

    Default, 10 (minimum, 5; maximum, 999)

    clpcfadm.py mod -t forcestop/vcenter/wait/timeout --set <Value>

    Note

    Set as above with "Forced Stop Action" set to "Power Off".

  • Lead Time between a Stop Request and a Failover Start (sec)

    Default, 10 (minimum, 0; maximum, 999)

    clpcfadm.py mod -t forcestop/vcenter/wait/fodelay --set <Value>

    Note

    Set as above with "Forced Stop Action" set to "Reset".

  • Disable Group Failover When Execution Fails

    Disable Group Failover When Execution Fails

    Value

    Suppress

    1

    Do not suppress (default)

    0

    clpcfadm.py mod -t forcestop/vcenter/suppression --set <Value>
vCenter
  • Method of performing forced stop

    Method of performing forced stop

    Value

    vSphere Automation API (default)

    restapi

    VMware vSphere CLI

    vcli

    clpcfadm.py mod -t forcestop/vcenter/parameters/method --set <Value>
  • VMware vSphere CLI Installation Path (Within 1023 bytes)

    VMware vSphere CLI Installation Path

    C:\Program Files (x86)\VMware\VMware vSphere CLI

    C:\Program Files\VMware\VMware vSphere CLI

    clpcfadm.py mod -t forcestop/vcenter/server@<Server name>/parameters/commandpath --set <VMware vSphere CLI Installation Path> --nocheck

    Note

    With "Method of performing forced stop" set to "vSphere Automation API", always set an empty value.

    Note

    Set the same path for all target servers.

    Note

    Set it according to the environment (e.g., installation folder).

  • Host Name (Within 255 bytes)

    clpcfadm.py mod -t forcestop/vcenter/parameters/ip --set <Host Name> --nocheck
  • User Name (Within 255 bytes)

    clpcfadm.py mod -t forcestop/vcenter/parameters/user --set <User Name> --nocheck
  • Password (Within 255 bytes)

    clpcfadm.py mod -t forcestop/vcenter/parameters/password --set <Encrypted password> --nocheck

    Note

    Set an encrypted password string.
  • Perl Path (Within 255 bytes)

    clpcfadm.py mod -t forcestop/vcenter/server@<Server name>/parameters/perlpath --set <Perl Path> --nocheck

    Note

    Set as above with "Method of performing forced stop" set to "VMware vSphere CLI".

AWS
clpcfadm.py add forcestop aws
clpcfadm.py mod -t forcestop/aws/server@<Server name>/parameters/id --set <Instance ID> --nocheck
clpcfadm.py mod -t forcestop/aws/server@<Server name>/use --set 1 --nocheck
Server List
  • Instance ID (Within 31 bytes)

    clpcfadm.py mod -t forcestop/aws/server@<Server name>/parameters/id --set <Instance ID> --nocheck
Forced Stop
  • Forced Stop Action

    Value

    stop (default)

    reboot

    clpcfadm.py mod -t forcestop/aws/parameters/action --set <Value>
  • Forced Stop Timeout (sec)

    Default, 10 (minimum, 5; maximum, 999)

    clpcfadm.py mod -t forcestop/aws/exec/timeout --set <Value>
  • Time to Wait for Stop to Be Completed (sec)

    Default, 180 (minimum, 5; maximum, 999)

    clpcfadm.py mod -t forcestop/aws/wait/timeout --set <Value>

    Note

    Set as above with "Forced Stop Action" set to "stop".

  • Lead Time between a Stop Request and a Failover Start (sec)

    Default, 120 (minimum, 0; maximum, 999)

    clpcfadm.py mod -t forcestop/aws/wait/fodelay --set <Value>

    Note

    Set as above with "Forced Stop Action" set to "reboot".

  • Disable Group Failover When Execution Fails

    Disable Group Failover When Execution Fails

    Value

    Suppress

    1

    Do not suppress (default)

    0

    clpcfadm.py mod -t forcestop/aws/suppression --set <Value>
Azure
clpcfadm.py add forcestop azure
clpcfadm.py mod -t forcestop/azure/parameters/useruri --set <User URI> --nocheck
clpcfadm.py mod -t forcestop/azure/parameters/tenantid --set <Tenant ID> --nocheck
clpcfadm.py mod -t forcestop/azure/parameters/certfile --set <File Path of Service Principal> --nocheck
clpcfadm.py mod -t forcestop/azure/parameters/rscgrp --set <Resource Group Name> --nocheck
clpcfadm.py mod -t forcestop/azure/server@<Server name>/parameters/vmname --set <Virtual Machine Name> --nocheck
clpcfadm.py mod -t forcestop/azure/server@<Server name>/use --set 1 --nocheck
Server List
  • Virtual Machine Name (Within 31 bytes)

    clpcfadm.py mod -t forcestop/azure/server@<Server name>/parameters/vmname --set <Virtual Machine Name> --nocheck
Forced Stop
  • Forced Stop Action

    Value

    stop and deallocate (default)

    stop only

    reboot

    clpcfadm.py mod -t forcestop/azure/parameters/action --set <Value>
  • Forced Stop Timeout (sec)

    Default, 15 (minimum, 5; maximum, 999)

    clpcfadm.py mod -t forcestop/azure/exec/timeout --set <Value>
  • Time to Wait for Stop to Be Completed (sec)

    Default, 180 (minimum, 5; maximum, 999)

    clpcfadm.py mod -t forcestop/azure/wait/timeout --set <Value>

    Note

    Set as above with "Forced Stop Action" set to "stop".

  • Lead Time between a Stop Request and a Failover Start (sec)

    Default, 120 (minimum, 0; maximum, 999)

    clpcfadm.py mod -t forcestop/azure/wait/fodelay --set <Value>

    Note

    Set as above with "Forced Stop Action" set to "reboot".

  • Disable Group Failover When Execution Fails

    Disable Group Failover When Execution Fails

    Value

    Suppress

    1

    Do not suppress (default)

    0

    clpcfadm.py mod -t forcestop/azure/suppression --set <Value>
Azure
  • User URI (Within 2048 bytes)

    clpcfadm.py mod -t forcestop/azure/parameters/useruri --set <User URI> --nocheck
  • Tenant ID (Within 36 bytes)

    clpcfadm.py mod -t forcestop/azure/parameters/tenantid --set <Tenant ID> --nocheck
  • File Path of Service Principal (Within 1024 bytes)

    clpcfadm.py mod -t forcestop/azure/parameters/certfile --set <File Path of Service Principal> --nocheck
  • Resource Group Name (Within 90 bytes)

    clpcfadm.py mod -t forcestop/azure/parameters/rscgrp --set <Resource Group Name> --nocheck
OCI
clpcfadm.py add forcestop oci
clpcfadm.py mod -t forcestop/oci/server@<Server name>/parameters/id --set <Instance ID> --nocheck
clpcfadm.py mod -t forcestop/oci/server@<Server name>/use --set 1 --nocheck
Server List
  • Instance ID (Within 31 bytes)

    clpcfadm.py mod -t forcestop/oci/server@<Server name>/parameters/id --set <Instance ID> --nocheck
Forced Stop
  • Forced Stop Action

    Value

    stop (default)

    reboot

    clpcfadm.py mod -t forcestop/oci/parameters/action --set <Value>
  • Forced Stop Timeout (sec)

    Default, 15 (minimum, 5; maximum, 999)

    clpcfadm.py mod -t forcestop/oci/exec/timeout --set <Value>
  • Time to Wait for Stop to Be Completed (sec)

    Default, 180 (minimum, 5; maximum, 999)

    clpcfadm.py mod -t forcestop/oci/wait/timeout --set <Value>

    Note

    Set as above with "Forced Stop Action" set to "stop".

  • Lead Time between a Stop Request and a Failover Start (sec)

    Default, 120 (minimum, 0; maximum, 999)

    clpcfadm.py mod -t forcestop/oci/wait/fodelay --set <Value>

    Note

    Set as above with "Forced Stop Action" set to "reboot".

  • Disable Group Failover When Execution Fails

    Disable Group Failover When Execution Fails

    Value

    Suppress

    1

    Do not suppress (default)

    0

    clpcfadm.py mod -t forcestop/oci/suppression --set <Value>
Custom
clpcfadm.py add forcestop custom
clpcfadm.py mod -t forcestop/custom/parameters/path --set forcestop.bat
clpcfadm.py mod -t forcestop/custom/parameters/account --set "" --nocheck
clpcfadm.py mod -t forcestop/custom/server@<Server name>/use --set 1 --nocheck
Forced Stop
  • Forced Stop Timeout (sec)

    Default, 10 (minimum, 5; maximum, 999)

    clpcfadm.py mod -t forcestop/custom/exec/timeout --set <Value>
  • Disable Group Failover When Execution Fails

    Disable Group Failover When Execution Fails

    Value

    Suppress

    1

    Do not suppress (default)

    0

    clpcfadm.py mod -t forcestop/custom/suppression --set <Value>
Script Settings
  • File type

    Script file type

    Value

    Script created with this product (default)

    1

    User Application

    0

    clpcfadm.py mod -t forcestop/custom/parameters/default --set <Value>

    Note

    If you change this parameter, change "Path".

  • Path (Within 1023 bytes)

    clpcfadm.py mod -t forcestop/custom/parameters/path --set <Path>

    Note

    If you specify "Script created with this product", specify forcestop.bat.

    clpcfadm.py mod -t forcestop/custom/parameters/path --set forcestop.bat
  • Exec User

    clpcfadm.py mod -t forcestop/custom/parameters/account --set <Exec User>
Delete (Do Not Use)
clpcfadm.py del forcestop

4.4. Timeout

  • Service Startup Delay Time (sec)

    Default, 0 (minimum, 0; maximum, 9999)

    clpcfadm.py mod -t cluster/startupdelay --set <Value>
  • Network initialization complete wait time (sec)

    Default, 180 (minimum, 0; maximum, 5940)

    clpcfadm.py mod -t cluster/networkcheck --set <Value>

    Note

    Specify a value in seconds (divisible by 60).

  • Server Sync Wait Time (sec)

    Default, 300 (minimum, 0; maximum, 5940)

    clpcfadm.py mod -t cluster/bootwait --set <Value>

    Note

    Specify a value in seconds (divisible by 60).

Heartbeat
  • Interval (msec)

    Default, 3000 (minimum, 1000; maximum, 99000)

    clpcfadm.py mod -t cluster/heartbeat/interval --set <Value>

    Note

    Specify a value in milliseconds (divisible by 1000).

  • Timeout (msec)

    Default, 30000 (minimum, 2000; maximum, 999000)

    clpcfadm.py mod -t cluster/heartbeat/timeout --set <Value>

    Note

    Specify a value in milliseconds (divisible by 1000).

  • Server Internal Timeout (sec)

    Default, 180 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t cluster/api/timeout --set <Value>

4.5. Port No.

TCP
  • Server Internal Port Number

    Default, 29001 (minimum, 1; maximum, 65535)

    clpcfadm.py mod -t cluster/api/port --set <Value>
  • Information Base Port Number

    Default, 29008 (minimum, 1; maximum, 65535)

    clpcfadm.py mod -t cluster/api/ibport --set <Value>
  • Data Transfer Port Number

    Default, 29002 (minimum, 1; maximum, 65535)

    clpcfadm.py mod -t cluster/trns/port --set <Value>
  • WebManager HTTP Port Number

    Default, 29003 (minimum, 1; maximum, 65535)

    clpcfadm.py mod -t webmgr/http/port --set <Value>
  • API HTTP Port Number

    Default, 29009 (minimum, 1; maximum, 65535)

    clpcfadm.py mod -t cluster/rstd/http/port --set <Value>
  • API Server Internal Port Number

    Default, 29010 (minimum, 1; maximum, 65535)

    clpcfadm.py mod -t cluster/rstd/service/port --set <Value>
  • Disk Agent Port Number

    Default, 29004 (minimum, 1; maximum, 65535)

    clpcfadm.py mod -t diskagent/port --set <Value> --nocheck
  • Mirror Driver Port Number

    Default, 29005 (minimum, 1; maximum, 65535)

    clpcfadm.py mod -t diskfltr/port --set <Value> --nocheck
UDP
  • Kernel Mode Heartbeat Port Number

    Default, 29106 (minimum, 1; maximum, 65535)

    clpcfadm.py mod -t cluster/heartbeat/khbport/recv --set <Value>
  • Alert Sync Port Number

    Default, 29003 (minimum, 1; maximum, 65535)

    clpcfadm.py mod -t webalert/daemon/udpport --set <Value>

4.6. Recovery

  • Action When the Cluster Service Process Is Failure

    Action When the Cluster Service Process Is Failure

    Value

    Emergency shutdown (default)

    5

    Generate an intentional stop error

    6

    Reset the hardware

    7

    clpcfadm.py mod -t pm/exec0/recover --set <Value>
    clpcfadm.py mod -t pm/exec1/recover --set <Value> --nocheck

    Note

    Set each of the <Value> fields to the same value.

Recovery Action for HA Agents
  • Max Restart Count

    Default, 3 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t rm/agent/retrynum --set <Value>
  • Recovery Action over Max Restart Count

    Recovery Action over Max Restart Count

    Value

    No operation (default)

    1

    Stop the cluster service

    3

    Stop the cluster service and shutdown OS

    4

    Stop the cluster service and reboot OS

    5

    clpcfadm.py mod -t rm/agent/action --set <Value>
  • Action at Group Resource Activation or Deactivation Stall

    Action at Group Resource Activation or Deactivation Stall

    Value

    Emergency shutdown (default)

    5

    Generate an intentional stop error

    6

    No operation (operates as an activity or deactivity failure)

    0

    clpcfadm.py mod -t cluster/rsctimeout/rsctoaction --set <Value>
Disable the Final Action when OS Stops Due to Failure Detection
  • Group Resource When Activation Failure Detected

    Final Action When OS Stops Due to All Server Shutdown

    Value

    Perform the final action

    1

    Do not perform the final action (default)

    0

    clpcfadm.py mod -t cluster/survive/rscact --set <Value>
  • Group Resource When Deactivation Failure Detected

    Final Action When OS Stops Due to All Server Shutdown

    Value

    Perform the final action

    1

    Do not perform the final action (default)

    0

    clpcfadm.py mod -t cluster/survive/rscdeact --set <Value>
  • Monitor Resource When Failure Detected

    Final Action When OS Stops Due to All Server Shutdown

    Value

    Perform the final action

    1

    Do not perform the final action (default)

    0

    clpcfadm.py mod -t cluster/survive/monitor --set <Value>
Disable Shutdown When Multi-Failover-Service Detected
  • Server Group Survives When Multi-Failover-Service Detected

    Server Group Survives When Multi-Failover-Service Detected

    Value

    Shut down (default)

    0

    Do not shut down

    1

    clpcfadm.py mod -t servergroup@<Server group name>/survive --set <Value>
  • Server Survives When Multi-Failover-Service Detected

    Server Survives When Multi-Failover-Service Detected

    Value

    Shut down (default)

    0

    Do not shut down

    1

    clpcfadm.py mod -t server@<Server name>/survive --set <Value>

4.7. Alert Service

  • Enable Alert Setting

    Enable Alert Setting

    Value

    Enable

    1

    Do not enable (default)

    0

    clpcfadm.py mod -t cluster/messages/use --set <Value>
    Add

    Note

    For details on "Module Type" and "Event ID", refer to "EXPRESSCLUSTER X Reference Guide" -> "Error messages" -> "Messages reported by event log and alert".

    • Destination

      Alert

      Value

      Set

      1

      Do not set

      0

      clpcfadm.py mod -t messages/types@<Module Type> --set "" --nocheck
      clpcfadm.py mod -t messages/<Module Type>@<Event ID>/alert --set <Value(Destination (Alert Logs))> --nocheck
      clpcfadm.py mod -t messages/<Module Type>@<Event ID>/altexec --set <Value(Destination (Alert Extension))> --nocheck
      clpcfadm.py mod -t messages/<Module Type>@<Event ID>/mail --set <Value(Destination (Mail Report))> --nocheck
      clpcfadm.py mod -t messages/<Module Type>@<Event ID>/trap --set <Value(Destination (SNMP Trap))> --nocheck
      clpcfadm.py mod -t messages/<Module Type>@<Event ID>/pubsub --set <Value(Destination (Message Topic))> --nocheck
      clpcfadm.py mod -t messages/<Module Type>@<Event ID>/syslog --set <Value(Destination (Event Log(DisableOnly)))> --nocheck

      Note

      Even when you change part of the destinations, specify settings for all destinations as shown above.

    • Command (Within 511 bytes)

      Add
      clpcfadm.py mod -t messages/<Module Type>@<Event ID>/cmd@<Command ID>/cmdline --set <Command> --nocheck

      Note

      Set as above with "Destination (Alert Extension)" set to "Set".

      Note

      With only one command, specify 0 for Command ID.
      With more than one command, specify consecutive numbers (e.g., 0, 1, 2...).
      Delete
      clpcfset del clsparam messages/<Module Type>@<Event ID>/cmd@<Command ID>
    Delete
    clpcfset del clsparam messages/<Module Type>@<Event ID>
    clpcfadm.py mod -t messages/types@<Module Type> --delete
Mail Report
  • E-mail Address (Within 255 bytes)

    clpcfadm.py mod -t cluster/mail/address --set <E-mail Address>
  • Subject (Within 127 bytes)

    clpcfadm.py mod -t cluster/mail/subject --set <Subject>
  • Mail Method

    Value

    SMTP (default)

    clpcfadm.py mod -t cluster/mail/sendtype --set <Value>
SMTP Settings
  • Mail Charset (Within 127 bytes)

    Mail Charset

    Shift_JIS

    ISO-2022-jp

    ISO-8859-1

    clpcfadm.py mod -t cluster/mail/smtp/charset --set <Mail Charset> --nocheck
  • Send Mail Timeout (sec)

    Default, 30 (minimum, 1; maximum, 999)

    clpcfadm.py mod -t cluster/mail/smtp/timeout --set <Value>
  • Subject Encode

    Subject Encode

    Value

    Encode

    1

    Do not encode (default)

    0

    clpcfadm.py mod -t cluster/mail/smtp/subencode --set <Value>
SMTP Server
Add

Note

With only one SMTP Server, specify 0 for ID.
With more than one SMTP Server, specify consecutive numbers (e.g., 0, 1, 2...).
  • Priority

    Default, None (minimum, 0; maximum, SMTP Server count - 1)

    clpcfadm.py mod -t cluster/mail/smtp/smtpsrv@<ID>/priority --set <Value> --nocheck
  • SMTP Server (Within 255 bytes)

    clpcfadm.py mod -t cluster/mail/smtp/smtpsrv@<ID>/srvname --set <SMTP Server> --nocheck
  • Use SSL

    Use SSL

    Value

    Use

    1

    Do not use

    0

    clpcfadm.py mod -t cluster/mail/smtp/smtpsrv@<ID>/ssl/use --set <Value> --nocheck
  • Connection Method

    Value

    SMTPS

    STARTTLS

    clpcfadm.py mod -t cluster/mail/smtp/smtpsrv@<ID>/ssl/method --set <Value> --nocheck

    Note

    Set as above with "Use SSL" set to "Use".

  • SMTP Port

    Default, None (minimum, 1; maximum, 65535)

    clpcfadm.py mod -t cluster/mail/smtp/smtpsrv@<ID>/port --set <Value> --nocheck
  • Sender Address (Within 255 bytes)

    clpcfadm.py mod -t cluster/mail/smtp/smtpsrv@<ID>/senderaddress --set <Sender Address> --nocheck
  • Enable SMTP Authentication

    Enable SMTP Authentication

    Value

    Enable

    1

    Do not enable

    0

    clpcfadm.py mod -t cluster/mail/smtp/smtpsrv@<ID>/auth --set <Value> --nocheck

Note

To set the following items, set "Enable SMTP Authentication" to "Enable" in advance.

  • Authentication Method

    Value

    CRAM-MD5

    LOGIN

    PLAIN

    clpcfadm.py mod -t cluster/mail/smtp/smtpsrv@<ID>/authmethod --set <Value> --nocheck
  • User Name (Within 255 bytes)

    clpcfadm.py mod -t cluster/mail/smtp/smtpsrv@<ID>/username --set <User Name> --nocheck
  • Password (Within 255 bytes)

    clpcfadm.py mod -t cluster/mail/smtp/smtpsrv@<ID>/passwd --set <Encrypted password> --nocheck

    Note

    Set an encrypted password string.
Delete
clpcfadm.py mod -t cluster/mail/smtp/smtpsrv@<ID> --delete
SNMP Trap
Destination Settings

Note

With only one SNMP Trap Destination Server, specify 0 for ID.
With more than one SNMP Trap Destination Server, specify consecutive numbers (e.g., 0, 1, 2...).
Add
clpcfadm.py mod -t cluster/trap/snmpsrv@<ID>/srvname --set <Destination Server> --nocheck
clpcfadm.py mod -t cluster/trap/snmpsrv@<ID>/port --set <SNMP Port> --nocheck
clpcfadm.py mod -t cluster/trap/snmpsrv@<ID>/snmpver --set <SNMP Version> --nocheck
clpcfadm.py mod -t cluster/trap/snmpsrv@<ID>/snmpcom --set <SNMP Community Name> --nocheck
  • Destination Server (Within 255 bytes)

    clpcfadm.py mod -t cluster/trap/snmpsrv@<ID>/srvname --set <Destination Server> --nocheck
  • SNMP Port

    Default, 162 (minimum, 1; maximum, 65535)

    clpcfadm.py mod -t cluster/trap/snmpsrv@<ID>/port --set <Value> --nocheck
  • SNMP Version

    Value

    v1

    v2c (default)

    clpcfadm.py mod -t cluster/trap/snmpsrv@<ID>/snmpver --set <Value> --nocheck
  • SNMP Community Name (Within 255 bytes)

    SNMP Community Name

    public (default)

    private

    clpcfadm.py mod -t cluster/trap/snmpsrv@<ID>/snmpcom --set <SNMP Community Name> --nocheck
Delete
clpcfadm.py mod -t cluster/trap/snmpsrv@<ID> --delete
  • Use Network Warning Light

    Use Network Warning Light

    Value

    Use

    1

    Do not use (default)

    0

    clpcfadm.py mod -t cluster/dn1000s/use --set <Value>

    Important

    Configure "Warning Light" of the server properties.

    Note

    For "Use", set as follows:

    clpcfadm.py mod -t alertservice/types@dn1000s --set "" --nocheck
    clpcfadm.py mod -t alertservice/dn1000s@dn1000s1 --set "" --nocheck
    clpcfadm.py mod -t alertservice/dn1000s@dn1000s1/priority --set 0 --nocheck
    clpcfadm.py mod -t alertservice/dn1000s@dn1000s1/device --set 20000 --nocheck
    clpcfadm.py mod -t alertservice/dn1000s@dn1000s1/kind --set nm --nocheck

    Note

    To change the setting for "Use Network Warning Light" from "Use" to "Do not use", set as follows:

    clpcfset del clsparam alertservice

4.8. WebManager

  • Enable WebManager Service

    Enable WebManager Service

    Value

    Enable (default)

    1

    Do not enable

    0

    clpcfadm.py mod -t webmgr/use --set <Value>

Note

To set the following items, set "Enable WebManager Service" to "Enable" in advance.

  • Communication Method

    Communication Method

    Value

    HTTP (default)

    0

    HTTPS

    1

    clpcfadm.py mod -t webmgr/server/encryption/method --set <Value>

    Important

    With "Communication Method" set to "HTTPS", configure "Encryption".

  • Number of sessions which can be established simultaneously

    Default, 64 (minimum, 10; maximum, 999)

    clpcfadm.py mod -t webmgr/server/maxclient --set <Value>
Control connection by using password
  • Password Method

    Password Method

    Value

    Cluster Password Method (default)

    0

    OS Authentication Method

    1

    clpcfadm.py mod -t webmgr/security/loginuser/use --set <Value>
    Cluster Password Method

    Note

    To set the following items, set "Password Method" to "Cluster Password Method" in advance.

    • Password for Operation

      clpcfadm.py mod -t webmgr/security/adminpwd --set <Encrypted password> --nocheck

      Note

      Set an encrypted password string.
    • Password for Reference

      clpcfadm.py mod -t webmgr/security/userpwd --set <Encrypted password> --nocheck

      Note

      Set an encrypted password string.
    OS Authentication Method

    Note

    To set the following items, set "Password Method" to "OS Authentication Method" in advance.

    • Authorized Group

      Add
      clpcfadm.py mod -t webmgr/security/loginuser/grouplist/ope@<Group Name> --set "" --nocheck
      Delete
      clpcfadm.py mod -t webmgr/security/loginuser/grouplist/ope@<Group Name> --delete
      
    • Login Session Lifetime Period (min)

      Default, 1440 (minimum, 0; maximum, 525600)

      clpcfadm.py mod -t webmgr/security/loginuser/duration --set <Value>
    • Automatic Logout Time Period (min)

      Default, 60 (minimum, 0; maximum, 99999)

      clpcfadm.py mod -t webmgr/security/loginuser/autologout/time --set <Value>
    • Lockout Threshold (time)

      Default, 0 (minimum, 0; maximum, 999)

      clpcfadm.py mod -t webmgr/security/loginuser/failure/count --set <Value>
    • Lockout Time (min)

      Default, 10 (minimum, 1; maximum, 99999)

      clpcfadm.py mod -t webmgr/security/loginuser/failure/duration --set <Value>
  • Control connection by using client IP address

    Control connection by using client IP address

    Value

    Control

    1

    Do not control (default)

    0

    clpcfadm.py mod -t webmgr/security/clientlist/iprest --set <Value>

    Note

    To set the following items, set "Control connection by using client IP addresses" to "Control" in advance.

    Add
    • IP Address (Operation privilege granted)

      clpcfadm.py mod -t webmgr/security/clientlist/ip@<IP Address> --set "" --nocheck
    • IP Address (Operation privilege not granted)

      clpcfadm.py mod -t webmgr/security/clientlist/ipro@<IP Address> --set "" --nocheck
    Delete
    • IP Address (Operation privilege granted)

      clpcfadm.py mod -t webmgr/security/clientlist/ip@<IP Address> --delete
    • IP Address (Operation privilege not granted)

      clpcfadm.py mod -t webmgr/security/clientlist/ipro@<IP Address> --delete
Cluster WebUI Operation Log
  • Output Cluster WebUI Operation Log

    Output Cluster WebUI Operation Log

    Value

    Output (default)

    1

    Do not output

    0

    clpcfadm.py mod -t webmgr/server/logopeuser/use --set <Value>
    • Log output path (Within 255 bytes) (Unless you specify a log output destination, the log is outputted to the default directory.)

      clpcfadm.py mod -t webmgr/server/logopeuser/path --set <Log output path>

      Note

      Use this setting if the "Output Cluster WebUI Operation Log" setting is "Output".

    • File Size (MB)

      Default, 1 (minimum, 1; maximum, 10)

      clpcfadm.py mod -t webmgr/server/logopeuser/size --set <Value>

      Note

      Use this setting if the "Output Cluster WebUI Operation Log" setting is "Output".

Integrated WebManager
Connection IP address
Add
clpcfadm.py mod -t server@<Server name>/device@<ID>/type --set public --nocheck
clpcfadm.py mod -t server@<Server name>/device@<ID>/info --set <IP Address> --nocheck

Note

With only one IP address to be added, specify 100 for ID.
With more than one IP address to be added, specify consecutive numbers (e.g., 100, 101, 102...). (Maximum: 199)
Delete
clpcfadm.py mod -t server@<Server name>/device@<ID> --delete
Tuning
  • Client Session Timeo

    Default, 30 (minimum, 1; maximum, 999)

    clpcfadm.py mod -t webmgr/server/timeout --set <Value>
  • Screen Data Refresh Interval (sec)

    Default, 90 (minimum, 0; maximum, 999)

    clpcfadm.py mod -t webmgr/client/pollinginterval --set <Value>
  • Mirror Agent Timeout (sec)

    Default, 150 (minimum, 1; maximum, 999)

    clpcfadm.py mod -t webmgr/server/mdagenttimeout --set <Value>
  • Time Limit For Keeping Log Files (sec)

    Default, 600 (minimum, 60; maximum, 43200)

    clpcfadm.py mod -t webmgr/server/logc/timeout/getfile --set <Value>
  • Use Time Information Display Function

    Use Time Information Display Function

    Value

    Use (default)

    1

    Do not use

    0

    clpcfadm.py mod -t cluster/timeinfo/use --set <Value>

4.9. API

  • Enable API Service

    Enable API Service

    Value

    Enable

    1

    Do not enable (default)

    0

    clpcfadm.py mod -t rstd/use --set <Value> --nocheck

    Important

    With "Enable API Service" set to "Enable", configure "Encryption".

    Note

    To set the following items, set "Enable API Service" to "Enable" in advance.

    • Communication Method

      Communication Method

      Value

      HTTP

      0

      HTTPS (default)

      1

      clpcfadm.py mod -t rstd/server/encryption/method --set <Value> --nocheck
    • Set a privilege per group

      Set a privilege per group

      Value

      Set

      1

      Do not set (default)

      0

      clpcfadm.py mod -t rstd/security/loginuser/use --set <Value> --nocheck

      Note

      To set the following items, set "Set a privilege per group" to "Set" in advance.

      Add
      • Operation privilege granted

      clpcfadm.py mod -t rstd/security/loginuser/grouplist/ope@<Group Name> --set "" --nocheck
      • Operation privilege not granted

      clpcfadm.py mod -t rstd/security/loginuser/grouplist/ref@<Group Name> --set "" --nocheck
      Delete
      • Operation privilege granted

      clpcfset del clsparam rstd/security/loginuser/grouplist/ope@<Group Name>
      • Operation privilege not granted

      clpcfset del clsparam rstd/security/loginuser/grouplist/ref@<Group Name>
    • Control connection by using client IP address

      Control connection by using client IP address

      Value

      Control

      1

      Do not control (default)

      0

      clpcfadm.py mod -t rstd/security/clientlist/iprest --set <Value> --nocheck
    Connection Permit Client IP Address

    Note

    To set the following items, set "Control connection by using client IP addresses" to "Control" in advance.

    Add
    • IP Address (Operation privilege granted)

      clpcfadm.py mod -t rstd/security/clientlist/ip@<IP Address> --set "" --nocheck
    • IP Address (Operation privilege not granted)

      clpcfadm.py mod -t rstd/security/clientlist/ipro@<IP Address> --set "" --nocheck
    Delete
    • IP Address (Operation privilege granted)

      clpcfset del clsparam rstd/security/clientlist/ip@<IP Address>
    • IP Address (Operation privilege not granted)

      clpcfset del clsparam rstd/security/clientlist/ipro@<IP Address>
    • Output API Service Operation Log

      Output API Service Operation Log

      Value

      Output (default)

      1

      Do not output

      0

      clpcfadm.py mod -t rstd/server/logopeuser/use --set <Value> --nocheck
    • Log output path (Within 255 bytes)

      clpcfadm.py mod -t rstd/server/logopeuser/path --set <Log output path> --nocheck

      Note

      Set as above with "Output API Service Operation Log" set to "Yes".

    • File Size (MB) (Unless you specify a log output destination, the log is outputted to the default directory.)

      Default, 1 (minimum, 1; maximum, 10)

      clpcfadm.py mod -t rstd/server/logopeuser/size --set <Value> --nocheck

      Note

      Set as above with "Output API Service Operation Log" set to "Yes".

    Tuning
    • Authentication Lockout Threshold (time)

      Default, 3 (minimum, 1; maximum, 5)

      clpcfadm.py mod -t rstd/security/authretry --set <Value> --nocheck
    • HTTP Server Start Retry Count (time)

      Default, 3 (minimum, 0; maximum, 99)

      clpcfadm.py mod -t rstd/communication/http/retry --set <Value> --nocheck
    • HTTP Server Start Interval (time)

      Default, 5 (minimum, 1; maximum, 99)

      clpcfadm.py mod -t rstd/communication/http/interval --set <Value> --nocheck

4.10. Encryption

  • Certificate File (Within 1023 bytes)

    clpcfadm.py mod -t webmgr/server/encryption/crtfile --set <Certificate File>
  • Private Key File (Within 1023 bytes)

    clpcfadm.py mod -t webmgr/server/encryption/keyfile --set <Private Key File>
  • SSL Library (Within 1023 bytes)

    SSL Library

    C:\OpenSSL-Win64\ssleay32.dll

    C:\Program Files\OpenSSL-Win64\libssl-1_1-x64.dll

    C:\Program Files\OpenSSL-Win64\libssl-3-x64.dll

    clpcfadm.py mod -t webmgr/server/encryption/ssllib --set <SSL Library>

    Note

    Set it according to the environment (e.g., installation folder).

  • Crypto Library (Within 1023 bytes)

    Crypto Library

    C:\OpenSSL-Win64\libeay32.dll

    C:\Program Files\OpenSSL-Win64\libcrypto-1_1-x64.dll

    C:\Program Files\OpenSSL-Win64\libcrypto-3-x64.dll

    clpcfadm.py mod -t webmgr/server/encryption/cryptolib --set <Crypto Library>

    Note

    Set it according to the environment (e.g., installation folder).

4.11. Alert Log

  • Enable Alert Service

    Enable Alert Service

    Value

    Enable (default)

    1

    Do not enable

    0

    clpcfadm.py mod -t webalert/use --set <Value>
  • Max. Number to Save Alert Records

    Default, 10000 (minimum, 1; maximum, 99999)

    clpcfadm.py mod -t webalert/main/alertlog/maxrecordcount --set <Value>
  • Enable a log file for investigation to be downloaded

    Enable a log file for investigation to be downloaded

    Value

    Enable (default)

    1

    Do not enable

    0

    clpcfadm.py mod -t telem/ecap/use --set <Value> --nocheck
Alert Sync
  • Method

    Method

    Value

    unicast (default)

    0

    clpcfadm.py mod -t webalert/daemon/method --set <Value>
  • Communication Timeout (sec)

    Default, 30 (minimum, 1; maximum, 300)

    clpcfadm.py mod -t webalert/daemon/timeout --set <Value>

4.12. Delay Warning

  • Heartbeat Delay Warning (%)

    Default, 80 (minimum, 1; maximum, 99)

    clpcfadm.py mod -t cluster/delaywarn/heartbeat --set <Value>

    Note

    To turn off "Heartbeat Delay Warning", set 100.

    clpcfadm.py mod -t cluster/delaywarn/heartbeat --set 100
  • Monitor Delay Warning (%)

    Default, 80 (minimum, 1; maximum, 99)

    clpcfadm.py mod -t cluster/delaywarn/monitor --set <Value>

    Note

    To turn off "Monitor Delay Warning", set 100.

    clpcfadm.py mod -t cluster/delaywarn/monitor --set 100

4.13. Disk

At Disk Disconnection Failure
  • Retry Interval (sec)

    Default, 3 (minimum, 1; maximum, 10)

    clpcfadm.py mod -t diskagent/deactsd/interval --set <Value> --nocheck
  • Retry Count

    Default, 10 (minimum, 0; maximum, 180)

    clpcfadm.py mod -t diskagent/deactsd/retry --set <Value> --nocheck

    Note

    To set "Retry Count" to "Unlimited", set 65535.

    clpcfadm.py mod -t diskagent/deactsd/retry --set 65535 --nocheck
  • Timeout (sec)

    Default, 1800 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t diskagent/deactsd/timeout --set <Value> --nocheck
  • Final Action

    Final Action

    Value

    Enforced Disconnection (default)

    1

    None

    0

    clpcfadm.py mod -t diskagent/deactsd/action --set <Value> --nocheck

4.14. Mirror Disk

  • Auto Mirror Initial Construction

    Auto Mirror Initial Construction

    Value

    Automatically execute initial mirror construction (default)

    1

    Do not automatically execute initial mirror construction

    0

    clpcfadm.py mod -t diskagent/autofullcopy --set <Value> --nocheck
  • Auto Mirror Recovery

    Auto Mirror Recovery

    Value

    Automatically recover a mirror (default)

    1

    Do not automatically recover a mirror

    0

    clpcfadm.py mod -t diskagent/autorecovery --set <Value> --nocheck
  • Difference Bitmap Size (KB)

    Default, 1024 (minimum, 1024; maximum, 5120)

    clpcfadm.py mod -t diskfltr/cpbitmapsize --set <Value> --nocheck

    Note

    Specify a value in KB (divisible by 1024).

  • History Recording Area Size in Asynchronous Mode (KB)

    Default, 102400 (minimum, 1024; maximum, 102400)

    clpcfadm.py mod -t diskfltr/cphistorysize --set <Value> --nocheck

    Note

    Specify a value in KB (divisible by 1024).

  • Allow failover on mirror break for specified time

    Allow failover on mirror break for specified time

    Value

    Allow

    1

    Do not allow (default)

    0

    clpcfadm.py mod -t diskagent/foaccept/use --set <Value> --nocheck
    • Timeout (sec)

      Default, 30 (minimum, 1; maximum, 600)

      clpcfadm.py mod -t diskagent/foaccept/timeout --set <Value> --nocheck

      Note

      Set as above with "Allow failover on mirror break for specified time" set to "Allow".

At Disk Disconnection Failure
  • Retry Interval (sec)

    Default, 3 (minimum, 1; maximum, 10)

    clpcfadm.py mod -t diskagent/deactmd/interval --set <Value> --nocheck
    clpcfadm.py mod -t diskagent/deacthd/interval --set <Value> --nocheck

    Note

    Set each of the <Value> fields to the same value.

  • Retry Count

    Default, 10 (minimum, 0; maximum, 180)

    clpcfadm.py mod -t diskagent/deactmd/retry --set <Value> --nocheck
    clpcfadm.py mod -t diskagent/deacthd/retry --set <Value> --nocheck

    Note

    Set each of the <Value> fields to the same value.

    Note

    To set "Retry Count" to "Unlimited", set 65535.

    clpcfadm.py mod -t diskagent/deactmd/retry --set 65535 --nocheck
    clpcfadm.py mod -t diskagent/deacthd/retry --set 65535 --nocheck
  • Timeout (sec)

    Default, 1800 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t diskagent/deactmd/timeout --set <Value> --nocheck
    clpcfadm.py mod -t diskagent/deacthd/timeout --set <Value> --nocheck

    Note

    Set each of the <Value> fields to the same value.

  • Final Action

    Final Action

    Value

    Enforced Disconnection (default)

    1

    None

    0

    clpcfadm.py mod -t diskagent/deactmd/action --set <Value> --nocheck
    clpcfadm.py mod -t diskagent/deacthd/action --set <Value> --nocheck

    Note

    Set each of the <Value> fields to the same value.

4.15. Account

Note

With only one account, specify 0 for ID.
With more than one account, specify consecutive numbers (e.g., 0, 1, 2...).
Add
clpcfadm.py mod -t cluster/account/list@<ID>/username --set <User Name> --nocheck
clpcfadm.py mod -t cluster/account/list@<ID>/password --set <Encrypted password> --nocheck

Note

Set an encrypted password string.
Delete
clpcfadm.py mod -t cluster/account/list@<ID> --delete

4.16. RIP (Legacy)

Note

With only one network address, specify 0 for ID.
With more than one network address, specify consecutive numbers (e.g., 0, 1, 2...).
Add
clpcfadm.py mod -t cluster/rip/list@<ID>/ip --set <Network Address> --nocheck
clpcfadm.py mod -t cluster/rip/list@<ID>/mask --set <Net Mask> --nocheck
Delete
clpcfadm.py mod -t cluster/rip/list@<ID> --delete

4.17. JVM Monitor

  • Java Installation Path (Within 255 bytes)

    clpcfadm.py mod -t jra/path/java --set <Java Installation Path> --nocheck
  • Maximum Java Heap Size (MB)

    Default, 16 (minimum, 7; maximum, 4096)

    clpcfadm.py mod -t jra/javaopt/xmx --set <Value> --nocheck
  • Java VM Additional Option (Within 1024 bytes)

    clpcfset add clsparam jra/javaopt/javaoptex <Java VM Additional Option>

    Note

    Enter a hyphen (-) as the first character of an additional option for Java VM.

Log Output Setting
  • Log Level

    Value

    DEBUG

    INFO (default)

    WARN

    ERROR

    FATAL

    clpcfadm.py mod -t jra/log/level --set <Value> --nocheck
  • Generation

    Default, 10 (minimum, 2; maximum, 100)

    clpcfadm.py mod -t jra/log/count --set <Value> --nocheck
Rotation Type
  • Rotation Type

    Rotation Type

    Value

    File size (default)

    1

    Time

    2

    clpcfadm.py mod -t jra/log/rotation/common --set <Value> --nocheck
  • Max Size (KB)

    Default, 3072 (minimum, 200; maximum, 2097151)

    clpcfadm.py mod -t jra/log/maxsize --set <Value> --nocheck

    Note

    Set as above with "Rotation Type" set to "File Size".

  • Start Time

    Default, 00:00 (00:00 to 23:59)

    clpcfadm.py mod -t jra/log/timerotation/point --set <Value> --nocheck

    Note

    Set as above with "Rotation Type" set to "Time".

  • Interval (hours)

    Default, 24 (minimum, 1; maximum, 8784)

    clpcfadm.py mod -t jra/log/timerotation/interval --set <Value> --nocheck

    Note

    Set as above with "Rotation Type" set to "Time".

Resource Measurement Setting
Common
  • Retry Count

    Default, 10 (minimum, 1; maximum, 1440)

    clpcfadm.py mod -t jra/measure/retry --set <Value> --nocheck
  • Failure Threshold (time)

    Default, 5 (minimum, 1; maximum, 10)

    clpcfadm.py mod -t jra/change/count --set <Value> --nocheck
Interval
  • Memory Usage,Active Threads (sec)

    Default, 60 (minimum, 15; maximum, 600)

    clpcfadm.py mod -t jra/measure/interval/value --set <Value> --nocheck
  • The time and count in Full GC (sec)

    Default, 120 (minimum, 15; maximum, 600)

    clpcfadm.py mod -t jra/measure/interval/gc --set <Value> --nocheck
WebLogic
  • Retry Count

    Default, 3 (minimum, 1; maximum, 5)

    clpcfadm.py mod -t jra/wl/queue/retry --set <Value> --nocheck
  • Failure Threshold (time)

    Default, 5 (minimum, 1; maximum, 10)

    clpcfadm.py mod -t jra/wl/queue/change/count --set <Value> --nocheck
Interval
  • The number of request (sec)

    Default, 60 (minimum, 15; maximum, 600)

    clpcfadm.py mod -t jra/wl/queue/measure/interval --set <Value> --nocheck
  • The average number of the request (sec)

    Default, 300 (minimum, 15; maximum, 600)

    clpcfadm.py mod -t jra/wl/queue/average/interval --set <Value> --nocheck

    Note

    For the interval for measuring the average, specify an integral multiple of the measured interval value for Requests.

Connection Setting
  • Management Port

    Default, 25500 (minimum, 1; maximum, 65535)

    clpcfadm.py mod -t jra/admin/port --set <Value> --nocheck
  • Retry Count

    Default, 3 (minimum, 1; maximum, 5)

    clpcfadm.py mod -t jra/connect/retry --set <Value> --nocheck
  • Waiting time for reconnection (sec)

    Default, 60 (minimum, 15; maximum, 60)

    clpcfadm.py mod -t jra/connect/wait --set <Value> --nocheck
  • Action Timeout (sec)

    Default, 60 (minimum, 30; maximum, 300)

    clpcfadm.py mod -t jra/action/wait --set <Value> --nocheck

4.18. Cloud

Amazon SNS
  • Enable Amazon SNS Linkage Function

    Enable Amazon SNS Linkage Function

    Value

    Enable

    1

    Do not enable (default)

    0

    clpcfadm.py mod -t cluster/cloud/aws/sns/use --set <Value>
  • TopicArn (Within 512 bytes)

    clpcfadm.py mod -t cluster/cloud/aws/sns/topicarn --set <TopicArn>

    Note

    Set as above with "Enable Amazon SNS Linkage Function" set to "Enable".

Amazon CloudWatch
  • Enable Amazon CloudWatch Linkage Function

    Enable Amazon CloudWatch Linkage Function

    Value

    Enable

    1

    Do not enable (default)

    0

    clpcfadm.py mod -t cluster/cloud/metrics/aws/cloudwatch/use --set <Value>
  • Namespace (Within 255 bytes)

    clpcfadm.py mod -t cluster/cloud/metrics/aws/cloudwatch/namespace --set <Namespace>

    Note

    Set as above with "Enable Amazon CloudWatch Linkage Function" set to "Enable".

  • Interval for Sending Metrics

    Default, 60 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t cluster/cloud/metrics/interval --set <Value>

    Note

    Set as above with "Enable Amazon CloudWatch Linkage Function" set to "Enable".

Command line options (AWS CLI)
AWS CLI Command line options
  • aws cloudwatch (Within 2047 bytes)

    clpcfadm.py mod -t cluster/cloud/aws/cmdopt/cloudwatch --set <Command line options>
  • aws ec2 (Within 2047 bytes)

    clpcfadm.py mod -t cluster/cloud/aws/cmdopt/ec2 --set <Command line options>
  • aws route53 (Within 2047 bytes)

    clpcfadm.py mod -t cluster/cloud/aws/cmdopt/route53 --set <Command line options>
  • aws sns (Within 2047 bytes)

    clpcfadm.py mod -t cluster/cloud/aws/cmdopt/sns --set <Command line options>
Environment variable
Environment variables at the time of performing AWS-related features
  • Add

    clpcfadm.py mod -t cluster/cloud/aws/envs/env@<ID>/name --set <Name> --nocheck
    clpcfadm.py mod -t cluster/cloud/aws/envs/env@<ID>/value --set <Value> --nocheck

    Note

    With only one environment variable, specify 0 for ID.
    With more than one environment variable, specify consecutive numbers (e.g., 0, 1, 2...).
  • Delete

    clpcfadm.py mod -t cluster/cloud/aws/envs/env@<ID> --delete

4.19. Statistics

Cluster Statistics
  • Heartbeat Resource

    Heartbeat Resource

    Value

    Enable (default)

    1

    Do not enable

    0

    clpcfadm.py mod -t cluster/perf/log/heartbeat/use --set <Value>
    • File Size (MB)

      Default, 50 (minimum, 1; maximum, 50)

      clpcfadm.py mod -t cluster/perf/log/heartbeat/size --set <Value>

      Note

      Set as above with "Heartbeat Resource" set to "Enable".

  • Group

    Group

    Value

    Enable (default)

    1

    Do not enable

    0

    clpcfadm.py mod -t cluster/perf/log/group/use --set <Value>
    • File Size (MB)

      Default, 1 (minimum, 1; maximum, 5)

      clpcfadm.py mod -t cluster/perf/log/group/size --set <Value>

      Note

      Set as above with "Group" set to "Enable".

  • Group Resource

    Group Resource

    Value

    Enable (default)

    1

    Do not enable

    0

    clpcfadm.py mod -t cluster/perf/log/resource/use --set <Value>
    • File Size (MB)

      Default, 1 (minimum, 1; maximum, 5)

      clpcfadm.py mod -t cluster/perf/log/resource/size --set <Value>

      Note

      Set as above with "Group Resource" set to "Enable".

  • Monitor Resource

    Monitor Resource

    Value

    Enable (default)

    1

    Do not enable

    0

    clpcfadm.py mod -t cluster/perf/log/monitor/use --set <Value>
    • File Size (MB)

      Default, 10 (minimum, 1; maximum, 10)

      clpcfadm.py mod -t cluster/perf/log/monitor/size --set <Value>

      Note

      Set as above with "Monitor Resource" set to "Enable".

Mirror Statistics
  • Collect Statistics

    Collect Statistics

    Value

    Collect (default)

    1

    Do not collect

    0

    clpcfadm.py mod -t diskperf/parameters/perfenable --set <Value> --nocheck
System Resource Statistics
  • Collect Statistics

    Collect Statistics

    Value

    Collect

    1

    Do not collect (default)

    0

    clpcfadm.py mod -t cluster/sysinfo/collect --set <Value>

4.20. Extension

Reboot Limitation
  • Max Reboot Count

    Default, 3 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t reg/rc/halt/count --set <Value> --nocheck
    clpcfadm.py mod -t reg/rm/halt/count --set <Value> --nocheck

    Note

    Set each of the <Value> fields to the same value.

    Note

    If you set "Max Reboot Count" to 0, the repetition of reboot is not limited.

    Note

    If you set "Max Reboot Count" to 0, the reboot count is not reset.

  • Max Reboot Count Reset Time (min)

    Default, 60 (minimum, 0; maximum, 999)

    clpcfadm.py mod -t reg/rc/halt/reset --set <Value> --nocheck
    clpcfadm.py mod -t reg/rm/halt/reset --set <Value> --nocheck

    Note

    Set each of the <Value> fields to the same value.

  • Auto Return

    Auto Return

    Value

    Yes (default)

    1

    No

    0

    clpcfadm.py mod -t cluster/autoreturn/common --set <Value>
  • Grace period of server group failover policy (msec)

    Default, 0 (minimum, 0; maximum, 99999000)

    clpcfadm.py mod -t cluster/heartbeat/fodelay --set <Value>

    Note

    Specify a value in milliseconds (divisible by 1000).

  • Change from OS Stop to OS Restart

    Change from OS Stop to OS Restart

    Value

    Yes

    1

    No (default)

    0

    clpcfadm.py mod -t cluster/override/finalaction --set <Value>
Disable Cluster Operation (Recommended for maintenance purposes)
  • Group Automatic Startup

    Group Automatic Startup

    Value

    Disable

    1

    Do not disable (default)

    0

    clpcfadm.py mod -t rc/autostart/group/disable --set <Value> --nocheck
  • Recovery Operation when Group Resource Activation Failure Detected

    Recovery Operation when Group Resource Activation Failure Detected

    Value

    Disable

    1

    Do not disable (default)

    0

    clpcfadm.py mod -t rc/errordetect/rscact/norecovery --set <Value> --nocheck
  • Recovery Operation when Group Resource Deactivation Failure Detected

    Recovery Operation when Group Resource Deactivation Failure Detected

    Value

    Disable

    1

    Do not disable (default)

    0

    clpcfadm.py mod -t rc/errordetect/rscdeact/norecovery --set <Value> --nocheck
  • Recovery Action when Monitor Resource Failure Detected

    Recovery Action when Monitor Resource Failure Detected

    Value

    Disable

    1

    Do not disable (default)

    0

    clpcfadm.py mod -t rm/errordetect/norecovery --set <Value>
  • Failover when Server Failure Detected

    Failover when Server Failure Detected

    Value

    Disable

    1

    Do not disable (default)

    0

    clpcfadm.py mod -t rc/svdowndetect/nofailover --set <Value> --nocheck
Settings of log storage period
  • Use log storage period feature

    Use log storage period feature

    Value

    Use

    1

    Do not use (default)

    0

    clpcfadm.py mod -t cluster/logarc/use --set <Value>

Note

To set the following items, set "Use log storage period feature" to "Use" in advance.

  • Store log for (days)

    Default, 7 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t cluster/logarc/period --set <Value>
  • Log storage destination (Within 170 bytes)

    clpcfadm.py mod -t cluster/logarc/path --set <Log storage destination>
  • Log storage timing

    Default, None (00:00 to 23:59)

    clpcfadm.py mod -t cluster/logarc/time --set <Value>

5. Configuring a server

Note

The command lines in this chapter use srv1 as the server name.
Change it to suit your environment.

5.1. Adding a server

Be sure to set the following items. For details, see "Setting server parameters".

Item (mandatory)

Server name

Priority

clpcfadm.py add srv srv1 <Priority>

Note

Of the cluster properties, configure the interconnect in advance.

Note

If you configure a cluster only with the above mandatory items, other parameters are set to their default values.

5.2. Setting parameters common to servers

Priority of servers that can start
clpcfadm.py mod -t server@<Server name>/priority --set <Priority of servers that can start>

Note

For the master server, specify 0 for Priority of servers that can start.
For servers other than the master server, specify consecutive numbers (e.g., 1, 2, 3...).
Server group
Add
clpcfadm.py mod -t servergroup@<Server group name>/comment --set <Comment> --nocheck
clpcfadm.py mod -t servergroup@<Server group name>/policy@<Server name>/order --set <Priority> --nocheck

Note

Enclose in double quotes a comment including spaces (e.g., "Sample Comment").

Note

With only one server belonging to the server group, specify 0 for Priority.
With more than one server belonging to the server group, specify consecutive numbers (e.g., 0, 1, 2...).
Delete
clpcfadm.py mod -t servergroup@<Server group name> --delete

5.3. Setting server parameters

5.3.1. Basic information

  • Server Name (Within 31 bytes)

    This is set when the server is added. To change the server name, delete the server and set it again

  • Comment (Within 127 bytes)

    clpcfadm.py mod -t server@srv1/comment --set <Comment> --nocheck

    Note

    Enclose in double quotes a string including spaces (e.g., "Sample Comment").

5.3.2. Warning Light

Add (Edit)
  • Warning Light

    Warning Light

    Value

    DN-1000S / DN-1000R / DN-1300GL (default)

    dn1000s

    DN-1500GL

    dn1500gl

    NH-FB series / NH-FB1 series

    patlite

    NH-FV1 series

    nhfv1

    clpcfadm.py mod -t server@srv1/device@20000/type --set <Value> --nocheck

    Important

    To change the setting for "Warning Light", set as follows:

    clpcfadm.py mod -t server@srv1/device@20000/normal/voice --set "" --nocheck
    clpcfadm.py mod -t server@srv1/device@20000/normal/voicefile --set "" --nocheck
    clpcfadm.py mod -t server@srv1/device@20000/error/voice --set "" --nocheck
    clpcfadm.py mod -t server@srv1/device@20000/error/voicefile --set "" --nocheck
  • IP Address

    clpcfadm.py mod -t server@srv1/device@20000/info --set <Value> --nocheck
    • User Name (Within 255 bytes)

      clpcfadm.py mod -t server@srv1/device@20000/user --set <Value> --nocheck
    • Password (Within 255 bytes)

      clpcfadm.py mod -t server@srv1/device@20000/password --set <Value> --nocheck

      Note

      Set an encrypted password string.
  • Set rsh Command File Path

    Set rsh Command File Path

    Value

    Set

    1

    Do not set (default)

    0

    clpcfadm.py mod -t server@srv1/device@20000/rsh --set <Value> --nocheck
    • File Path (Within 1023 bytes)

      clpcfadm.py mod -t server@srv1/device@20000/rshpath --set <Value> --nocheck

      Note

      Set as above with "Set rsh Command File Path" set to "Set".

  • Alert When Server Starts

    Alert When Server Starts

    Value

    Yes

    1

    No (default)

    0

    clpcfadm.py mod -t server@srv1/device@20000/normal/voice --set <Value> --nocheck

    Note

    Set as above with "Warning Light" set to "DN-1500GL" or "NH-FV1 series".

  • Voice File No.

    If "Warning Light" is set to "DN-1500GL"

    Default, 01 (minimum, 01; maximum, 20)

    If "Warning Light" is set to "NH-FV1 series"

    Default, 65 (minimum, 01; maximum, 70)

    clpcfadm.py mod -t server@srv1/device@20000/normal/voicefile --set <Value> --nocheck

    Note

    Set as above with "Alert When Server Starts" set to "Yes".

  • Alert When Server Stops

    Alert When Server Stops

    Value

    Yes

    1

    No (default)

    0

    clpcfadm.py mod -t server@srv1/device@20000/error/voice --set <Value> --nocheck

    Note

    Set as above with "Warning Light" set to "DN-1500GL" or "NH-FV1 series".

  • Voice File No.

    If "Warning Light" is set to "DN-1500GL"

    Default, 02 (minimum, 01; maximum, 20)

    If "Warning Light" is set to "NH-FV1 series"

    Default, 66 (minimum, 01; maximum, 70)

    clpcfadm.py mod -t server@srv1/device@20000/error/voicefile --set <Value> --nocheck

    Note

    Set as above with "Alert When Server Starts" set to "Yes".

Delete
clpcfadm.py mod -t server@srv1/device@20000 --delete

5.3.3. HBA

  • HBAs to be managed by the cluster system

    Add
    clpcfadm.py add hba srv1 <ID> <Port Number> <HBA Device ID> <HBA Instance ID>

    Note

    With only one HBA to be managed by the cluster system, specify 0 for ID.
    With more than one HBA to be managed by the cluster system, specify consecutive numbers (e.g., 0, 1, 2...).

    Note

    The port number, the HBA device ID, and the HBA instance ID can be retrieved by using the clpdiskctrl command.
    For details, see "clpdiskctrl command".
    Delete
    clpcfadm.py del hba srv1 <ID>
  • Partition excluded from cluster management

    Add
    clpcfadm.py mod -t server@<Server name>/hba@<ID>/vol@<Volume ID>/volumeguid --set <GUID> --nocheck
    clpcfadm.py mod -t server@<Server name>/hba@<ID>/vol@<Volume ID>/volumemountpoint --set <Drive letter> --nocheck

    Note

    With only one HBA to be managed by the cluster system, specify 0 for ID.
    With more than one HBA to be managed by the cluster system, specify consecutive numbers (e.g., 0, 1, 2...).

    Note

    With only one partition excluded from cluster management, specify 0 for Volume ID.
    With more than one partition excluded from cluster management, specify consecutive numbers (e.g., 0, 1, 2...).

    Note

    The GUID can be retrieved by using the clpdiskctrl command.
    For details, see "clpdiskctrl command".
    Delete
    clpcfadm.py mod -t server@<Server name>/hba@<ID>/vol@<Volume ID> --delete

5.3.4. Proxy

  • Proxy Scheme

    Proxy Scheme

    Value

    None (default)

    0

    HTTP

    1

    clpcfadm.py mod -t server@srv1/proxy/scheme --set <Value>
  • Proxy Server (Within 255 bytes)

    clpcfadm.py mod -t server@srv1/proxy/server --set <Proxy Server>

    Note

    Set as above with "Proxy Scheme" set to "HTTP".

  • Proxy Port

    Default, None (minimum, 1; maximum, 65535)

    clpcfadm.py mod -t server@srv1/proxy/port --set <Value>

    Note

    Set as above with "Proxy Scheme" set to "HTTP".

5.4. Deleting a server

Specify and delete a server name.

clpcfadm.py del srv srv1

6. Configuring a group

Note

The command lines in this chapter use failover1 as the group name.
Change it to suit your environment.

6.1. Adding a group

Be sure to set the following items. For details, see "Setting group parameters".

Item (mandatory)

Group name

Group type

Value

Failover group

failover

Management group

ManagementGroup

clpcfadm.py add grp <Group type> <Group name>

Note

If you configure a cluster only with the above mandatory items, other parameters are set to their default values.

6.2. Setting parameters common to groups

6.2.1. Exclusion

Add
clpcfadm.py mod -t xclrule@<Exclusion Name> --set "" --nocheck
clpcfadm.py mod -t xclrule@<Exclusion Name>/comment --set <Comment> --nocheck
clpcfadm.py mod -t xclrule@<Exclusion Name>/type --set <Exclusive Attribute> --nocheck
clpcfadm.py mod -t xclrule@<Exclusion Name>/group@<Exclusive Group> --set "" --nocheck
clpcfadm.py mod -t xclrule@<Exclusion Name>/order --set 0 --nocheck
  • Exclusion Name (Within 31 bytes)

    clpcfadm.py mod -t xclrule@<Exclusion Name> --set "" --nocheck
  • Comment (Within 127 bytes)

    clpcfadm.py mod -t xclrule@<Exclusion Name>/comment --set <Comment> --nocheck

    Note

    Enclose in double quotes a string including spaces (e.g., "Sample Comment").

  • Exclusive Attribute

    Exclusive Attribute

    Value

    Normal Exclusion (default)

    normal

    Absolute Exclusion

    high

    clpcfadm.py mod -t xclrule@<Exclusion Name>/type --set <Value> --nocheck
  • Exclusive Group

    Add
    clpcfadm.py mod -t xclrule@<Exclusion Name>/group@<Exclusive Group> --set "" --nocheck
    Delete
    clpcfadm.py mod -t xclrule@<Exclusion Name>/group@<Exclusive Group> --delete
Delete
clpcfadm.py mod -t xclrule@<Exclusion Name> --delete

6.3. Setting group parameters

6.3.1. Basic information

  • Use Server Group Settings

    Set
    clpcfadm.py mod -t group@failover1/svgpolicy@<ID>/order --set <The priority of a server group> --nocheck
    clpcfadm.py mod -t group@failover1/svgpolicy@<ID>/svgname --set <Server group name> --nocheck
    clpcfadm.py mod -t group@failover1/policy@<Server name>/order --set <Priority> --nocheck
    Delete
    clpcfadm.py mod -t group@failover1/svgpolicy@<ID> --delete
    clpcfadm.py mod -t group@failover1/policy --delete
  • Group Name (Within 31 bytes)

    This is set when the group is added. To change the group name, delete the group and set it again.

  • Comment (Within 127 bytes)

    clpcfadm.py mod -t group@failover1/comment --set <Comment>

    Note

    Enclose in double quotes a string including spaces (e.g., "Sample Comment").

6.3.2. Startup Server

  • Failover is possible at all servers (default)

    clpcfadm.py mod -t group@failover1/policy@<Server name> --delete

    Note

    Delete all configured servers.

  • Set Up Individually

    Add
    clpcfadm.py mod -t group@failover1/policy@<Server name>/order --set <The priority of starting up> --nocheck
    Delete
    clpcfadm.py mod -t group@failover1/policy@<Server name> --delete

6.3.3. Attribute

  • Startup Attribute

    Startup Attribute

    Value

    Automatic startup (default)

    1

    Manual startup

    0

    clpcfadm.py mod -t group@failover1/start --set <Value>
  • Execute Multi-Failover-Service Check

    Execute Multi-Failover-Service Check

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t group@failover1/checksvv/use --set <Value>
  • Timeout (sec)

    Default, 300 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t group@failover1/checksvv/preactping/timeout --set <Value>

    Note

    Set as above with "Execute Multi-Failover-Service Check" set to "Check".

Failover Attribute
  • Failover Attribute

    Automatic failover
    • Use startable server settings

      clpcfadm.py mod -t group@failover1/failover --set 1
    • Failover dynamically

      clpcfadm.py mod -t group@failover1/failover --set 100
      • Prioritize server group failover policy

        Prioritize server group failover policy

        Value

        Prioritize

        1

        Do not prioritize (default)

        0

        clpcfadm.py mod -t group@failover1/autonomic/functype/srvgrp/use --set <Value>
      • Perform a Smart Failover

        Perform a Smart Failover

        Value

        Perform smart failover

        1

        Do not perform smart failover (default)

        0

        clpcfadm.py mod -t group@failover1/autonomic/functype/sra/use --set <Value>
    • Prioritize server group failover policy

      clpcfadm.py mod -t group@failover1/failover --set 200
      • Enable only manual failover among the server groups

        clpcfadm.py mod -t group@failover1/failover --set 201
    • Manual failover

      clpcfadm.py mod -t group@failover1/failover --set 0
Failover Attribute (Advanced)
  • Exclude Server with Error Detected by Specified Monitor Resource, from Failover Destination

    Exclude Server with Error Detected by Specified Monitor Resource, from Failover Destination

    Value

    Exclude

    1

    Do not exclude (default)

    0

    clpcfadm.py mod -t group@failover1/autonomic/blacklist/use --set <Value>
Edit Monitor

Note

To set the following items, set "Exclude Server with Error Detected by Specified Monitor Resource, from Failover Destination" to "Exclude" in advance.

  • Monitor resource type

    Add

    Monitor resource type

    Value

    Application monitor

    appliw

    AWS AZ monitor

    awsazw

    AWS DNS monitor

    awsdnsw

    AWS Elastic IP monitor

    awseipw

    AWS Secondary IP monitor

    awssipw

    AWS Virtual IP monitor

    awsvipw

    Azure DNS monitor

    azurednsw

    Azure load balance monitor

    azurelbw

    Azure probe port monitor

    azureppw

    CIFS monitor

    cifsw

    DB2 monitor

    db2w

    Disk RW monitor

    diskw

    Floating IP monitor

    fipw

    FTP monitor

    ftpw

    Google Cloud DNS monitor

    gcdnsw

    Google Cloud load balance monitor

    gclbw

    Google Cloud Virtual IP monitor

    gcvipw

    Custom monitor

    genw

    HTTP monitor

    httpw

    IMAP4 monitor

    imap4w

    IP monitor

    ipw

    JVM monitor

    jraw

    NIC Link Up/Down monitor

    miiw

    Eternal link monitor

    mrw

    Oracle Cloud DNS monitor

    ocdnsw

    Oracle Cloud load balance monitor

    oclbw

    Oracle Cloud Virtual IP monitor

    ocvipw

    ODBC monitor

    odbcw

    Oracle monitor

    oraclew

    WebOTX monitor

    otxw

    POP3 monitor

    pop3w

    PostgreSQL monitor

    psqlw

    Process resource monitor

    psrw

    Process name monitor

    psw

    Disk TUR monitor

    sdw

    Service monitor

    servicew

    SMTP monitor

    smtpw

    SQL Server monitor

    sqlserverw

    System monitor

    sraw

    Tuxedo monitor

    tuxw

    Virtual IP monitor

    vipw

    WebSphere monitor

    wasw

    WebLogic monitor

    wlsw

    clpcfadm.py mod -t group@failover1/autonomic/functype/blacklist/target --set <Value>

    Note

    To add two or more monitor resource types, put commas (,) to separate them.

    clpcfadm.py mod -t group@failover1/autonomic/functype/blacklist/target --set ipw,miiw
    Delete
    clpcfadm.py mod -t group@failover1/autonomic/functype/blacklist/target --delete

    Important

    Delete all set monitor resource types.

  • Monitor resource group

    Add
    clpcfadm.py mod -t group@failover1/autonomic/functype/blacklist/targetgrp@0/rsc@<Monitor resource name> --set "" --nocheck
    Delete
    clpcfadm.py mod -t group@failover1/autonomic/functype/blacklist/targetgrp@0/rsc@<Monitor resource name> --delete
  • Failover with Error Ignored If It Is Detected in All Servers

    Failover with Error Ignored If It Is Detected in All Servers

    Value

    Fail over

    1

    Do not fail over (default)

    0

    clpcfadm.py mod -t group@failover1/autonomic/forcefo/use --set <Value>

    Note

    Set as above with "Exclude Server with Error Detected by Specified Monitor Resource, from Failover Destination" set to "Exclude".

Failback Attribute
  • Failback Attribute

    Failback Attribute

    Value

    Automatic failback

    1

    Manual failback (default)

    0

    clpcfadm.py mod -t group@failover1/failback --set <Value>

6.3.4. Start Dependency

  • Dependent Group

    Add
    clpcfadm.py mod -t group@failover1/depend/act/depend@<Group Name> --set "" --nocheck
    Delete
    clpcfadm.py mod -t group@failover1/depend/act/depend@<Group Name> --delete
Properties
  • Wait Only when on the Same Server

    Wait Only when on the Same Server

    Value

    Wait

    1

    Do not wait (default)

    0

    clpcfadm.py mod -t group@failover1/depend/act/depend@<Server name>/sameserver --set <Value> --nocheck
  • Start Wait Time (sec)

    Default, 1800 (minimum, 0; maximum, 9999)

    clpcfadm.py mod -t group@failover1/depend/act/timeout --set <Value>

6.3.5. Stop Dependency

  • Dependent Group

    Add
    clpcfadm.py mod -t group@failover1/depend/deact/depend@<Group Name> --set "" --nocheck
    Delete
    clpcfadm.py mod -t group@failover1/depend/deact/depend@<Group Name> --delete
  • Start Wait Time (sec)

    Default, 1800 (minimum, 0; maximum, 9999)

    clpcfadm.py mod -t group@failover1/depend/deact/timeout --set <Value>
  • Wait the Dependent Groups when a Cluster Stops

    Wait the Dependent Groups when a Cluster Stops

    Value

    Wait for the stop (default)

    1

    Do not wait for the stop

    0

    clpcfadm.py mod -t group@failover1/depend/deact/cluster/use --set <Value>
  • Wait the Dependent Groups when a Server Stops

    Wait the Dependent Groups when a Server Stops

    Value

    Wait for the stop

    1

    Do not wait for the stop (default)

    0

    clpcfadm.py mod -t group@failover1/depend/deact/server/use --set <Value>
  • Wait the Dependent Groups when a Group Stops

    Wait the Dependent Groups when a Group Stops

    Value

    Wait for the stop

    1

    Do not wait for the stop (default)

    0

    clpcfadm.py mod -t group@failover1/depend/deact/other/use --set <Value>
  • If stopping a target group fails, await the timeout

    If stopping a target group fails, await the timeout

    Value

    Yes (default)

    1

    No

    0

    clpcfadm.py mod -t group@failover1/depend/deact/failedbutwait --set <Value>

    Note

    Set as above with any of the following items set to "Yes":
    - "Wait the Dependent Groups when a Cluster Stops"
    - "Wait the Dependent Groups when a Server Stops"
    - "Wait the Dependent Groups when a Group Stops"

6.4. Deleting a group

Specify and delete a group name.

clpcfadm.py del grp failover1

7. Configuring group resources

7.1. Application resource

Note

The command lines in this section use appli1 as the group resource name.
Change it to suit your environment.

7.1.1. Adding an application resource

Be sure to set the following items. For details, see "Setting application resource parameters".

Item (mandatory)

Group resource name

Start Path

clpcfadm.py add rsc <Name of a group to which the resource belongs> appli appli1
clpcfadm.py mod -t resource/appli@appli1/parameters/actpath --set <Start Path>

Note

If you configure a cluster only with the above mandatory items, other parameters are set to their default values.

7.1.2. Setting application resource parameters

7.1.2.1. Basic information

  • Group resource name (Within 31 bytes)

    This is set when the resource is added. To change the group resource name, delete the resource and set it again.

  • Comment (Within 127 bytes)

    clpcfadm.py mod -t resource/appli@appli1/comment --set <Comment>

    Note

    Enclose in double quotes a string including spaces (e.g., "Sample Comment").

7.1.2.2. Dependency

  • Follow the default dependency (default)

    clpcfadm.py del rscdep appli appli1
  • Set a parent resource

    clpcfadm.py add rscdep appli appli1 <Parent resource name>
  • No parent resource

    clpcfadm.py add rscdep appli appli1 ""
  • Delete a parent resource

    clpcfadm.py mod -t resource/appli@appli1/depend@<Parent resource name> --delete

7.1.2.3. Recovery Operation

Recovery Operation at Activity Failure Detection
  • Retry Count

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t resource/appli@appli1/act/retry --set <Value>
  • Failover Target Server

    Failover Target Server

    Value

    Stable server (default)

    1

    Maximum priority server

    0

    clpcfadm.py mod -t resource/appli@appli1/act/mode --set <Value>
  • Failover Threshold

    Default, 1 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t resource/appli@appli1/act/fo2 --set <Value>
  • Final Action

    Final Action

    Value

    No operation (activate next resource)

    0

    No operation (not activate next resource) (default)

    1

    Stop group

    2

    Stop the cluster service

    3

    Stop the cluster service and shutdown OS

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t resource/appli@appli1/act/action --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/appli@appli1/act/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

    Script Settings
    • File type

      Script file type

      Value

      Script created with this product (default)

      1

      User Application

      0

      clpcfadm.py mod -t resource/appli@appli1/act/preaction/default --set <Value>

      Note

      If you change the value of this parameter, also change that of "File".

    • File (Within 1023 bytes)

      clpcfadm.py mod -t resource/appli@appli1/act/preaction/path --set <File>

      Note

      If you specify "Script created with this product", specify preactaction.bat.

      clpcfadm.py mod -t resource/appli@appli1/act/preaction/path --set preactaction.bat
    • Timeout (sec)

      Default, 5 (minimum, 1; maximum, 9999)

      clpcfadm.py mod -t resource/appli@appli1/act/preaction/timeout --set <Value>
    • Exec User

      clpcfadm.py mod -t resource/appli@appli1/act/preaction/account --set <Exec User>
Recovery Operation at Deactivity Failure Detection
  • Retry Count at Deactivation Failure

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t resource/appli@appli1/deact/retry --set <Value>
  • Final Action

    Final Action

    Value

    No operation (deactivate next resource)

    0

    No operation (not deactivate next resource)

    1

    Stop the cluster service and shutdown OS (default)

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t resource/appli@appli1/deact/action --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/appli@appli1/deact/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

    Script Settings
    • File type

      Script file type

      Value

      Script created with this product (default)

      1

      User Application

      0

      clpcfadm.py mod -t resource/appli@appli1/deact/preaction/default --set <Value>

      Note

      If you change the value of this parameter, also change that of "File".

    • File (Within 1023 bytes)

      clpcfadm.py mod -t resource/appli@appli1/deact/preaction/path --set <File>

      Note

      If you specify "Script created with this product", specify predeactaction.bat.

      clpcfadm.py mod -t resource/appli@appli1/deact/preaction/path --set predeactaction.bat
    • Timeout (sec)

      Default, 5 (minimum, 1; maximum, 9999)

      clpcfadm.py mod -t resource/appli@appli1/deact/preaction/timeout --set <Value>
    • Exec User

      clpcfadm.py mod -t resource/appli@appli1/deact/preaction/account --set <Exec User>

7.1.2.4. Details

  • Resident Type

    Resident Type

    Value

    Resident (default)

    1

    Non-Resident

    0

    clpcfadm.py mod -t resource/appli@appli1/parameters/resident --set <Value>
  • Start Path (Within 1023 bytes)

    clpcfadm.py mod -t resource/appli@appli1/parameters/actpath --set <Start Path>
  • Stop Path (Within 1023 bytes)

    clpcfadm.py mod -t resource/appli@appli1/parameters/deactpath --set <Stop Path>
Tuning
Parameter
Start
  • (Start) Synchronization type

    (Start) Synchronization type

    Value

    Synchronous (default)

    1

    Asynchronous

    0

    clpcfadm.py mod -t resource/appli@appli1/parameters/actsync --set <Value>
    • Timeout (sec)

      Default, 1800 (minimum, 1; maximum, 9999)

      clpcfadm.py mod -t resource/appli@appli1/parameters/acttimeout --set <Value>

      Note

      Set as above with "(Start) Synchronization type" set to "Synchronous".

    • Normal Return Value

      clpcfadm.py mod -t resource/appli@appli1/parameters/actnormalval --set <Value>

      Note

      Set as above with "(Start) Synchronization type" set to "Synchronous".

Stop
  • (Stop) Synchronization type

    (Stop) Synchronization type

    Value

    Synchronous (default)

    1

    Asynchronous

    0

    clpcfadm.py mod -t resource/appli@appli1/parameters/deactsync --set <Value>
    • Timeout (sec)

      Default, 1800 (minimum, 1; maximum, 9999)

      clpcfadm.py mod -t resource/appli@appli1/parameters/deacttimeout --set <Value>

      Note

      Set as above with "(Stop) Synchronization type" set to "Synchronous".

    • Normal Return Value

      clpcfadm.py mod -t resource/appli@appli1/parameters/deactnormalval --set <Value>

      Note

      Set as above with "(Stop) Synchronization type" set to "Synchronous".

  • Target VCOM Resource Name

    clpcfadm.py mod -t resource/appli@appli1/parameters/target --set <Target VCOM Resource Name>
  • Allow to Interact with Desktop

    Allow to Interact with Desktop

    Value

    Allow

    1

    Do not allow (default)

    0

    clpcfadm.py mod -t resource/appli@appli1/parameters/actinteractive --set <Value>
    clpcfadm.py mod -t resource/appli@appli1/parameters/deactinteractive --set <Value>

    Note

    Set each of the <Value> fields to the same value.

  • Kill the application when exit

    Kill the application when exit

    Value

    Yes

    1

    No (default)

    0

    clpcfadm.py mod -t resource/appli@appli1/parameters/termination --set <Value>

    Note

    Set as above with "Resident Type" set to "Resident".

  • Exec User

    Default: (Set Up Individually)

    clpcfadm.py mod -t resource/appli@appli1/parameters/account --set <Exec User>

    Note

    To change the current setting to "Set Up Individually", set as follows:

    clpcfadm.py mod -t resource/appli@appli1/parameters/account --delete
Start
  • Current Directory (Within 1023 bytes)

    clpcfadm.py mod -t resource/appli@appli1/parameters/actdirectory --set <Current Directory>
  • Option Parameter (Within 1023 bytes)

    clpcfadm.py mod -t resource/appli@appli1/parameters/actoption --set <Option Parameter>
  • Window Size

    Window Size

    Value

    Hide (default)

    0

    Normal

    1

    Maximize

    2

    Minimize

    3

    clpcfadm.py mod -t resource/appli@appli1/parameters/actwindowsize --set <Value>
Exec User
  • Domain

clpcfadm.py mod -t resource/appli@appli1/parameters/actdomain --set <Domain>
  • Account

    clpcfadm.py mod -t resource/appli@appli1/parameters/actaccount --set <Account>
  • Password (Within 255 bytes)

    clpcfadm.py mod -t resource/appli@appli1/parameters/actpassword --set <Encrypted password>

    Note

    Set an encrypted password string.
  • Execute from the command prompt

    Execute from the command prompt

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/appli@appli1/parameters/actcmd --set <Value>
Stop
  • Current Directory (Within 1023 bytes)

    clpcfadm.py mod -t resource/appli@appli1/parameters/deactdirectory --set <Current Directory>
  • Option Parameter (Within 1023 bytes)

    clpcfadm.py mod -t resource/appli@appli1/parameters/deactoption --set <Option Parameter>
  • Window Size

    Window Size

    Value

    Hide (default)

    0

    Normal

    1

    Maximize

    2

    Minimize

    3

    clpcfadm.py mod -t resource/appli@appli1/parameters/deactwindowsize --set <Value>
Exec User
  • Domain

clpcfadm.py mod -t resource/appli@appli1/parameters/deactdomain --set <Domain>
  • Account

    clpcfadm.py mod -t resource/appli@appli1/parameters/deactaccount --set <Account>
  • Password (Within 255 bytes)

    clpcfadm.py mod -t resource/appli@appli1/parameters/deactpassword --set <Encrypted password>

    Note

    Set an encrypted password string.
  • Execute from the command prompt

    Execute from the command prompt

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/appli@appli1/parameters/deactcmd --set <Value>

7.1.2.5. Extension

  • Resource Startup Attribute

    Resource Startup Attribute

    Value

    Automatic startup (default)

    1

    Manual startup

    0

    clpcfadm.py mod -t resource/appli@appli1/start --set <Value>
Execute Script before or after Activation or Deactivation

Note

If "Execute" is set for a script, specify the file. (See "Script Settings" -> "File".)

  • Execute Script before Activation

    Execute Script before Activation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/appli@appli1/preact/use --set <Value>
  • Execute Script after Activation

    Execute Script after Activation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/appli@appli1/predeact/use --set <Value>
  • Execute Script before Deactivation

    Execute Script before Deactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/appli@appli1/postact/use --set <Value>
  • Execute Script after Deactivation

    Execute Script after Deactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/appli@appli1/postdeact/use --set <Value>
Script Settings
  • File type

    Script file type

    Value

    Script created with this product (default)

    1

    User Application

    0

    clpcfadm.py mod -t resource/appli@appli1/preact/default --set <Value>
    clpcfadm.py mod -t resource/appli@appli1/predeact/default --set <Value>
    clpcfadm.py mod -t resource/appli@appli1/postact/default --set <Value>
    clpcfadm.py mod -t resource/appli@appli1/postdeact/default --set <Value>

    Note

    Set each of the <Value> fields to the same value.

    Note

    If you change the value of this parameter, also change that of "File".

  • File (Within 1023 bytes)

    clpcfadm.py mod -t resource/appli@appli1/preact/path --set <File>
    clpcfadm.py mod -t resource/appli@appli1/predeact/path --set <File>
    clpcfadm.py mod -t resource/appli@appli1/postact/path --set <File>
    clpcfadm.py mod -t resource/appli@appli1/postdeact/path --set <File>

    Note

    Set all <File> fields to the same value.

    Note

    If you specify "Script created with this product", specify rscextent.bat.

    clpcfadm.py mod -t resource/appli@appli1/preact/path --set rscextent.bat
    clpcfadm.py mod -t resource/appli@appli1/predeact/path --set rscextent.bat
    clpcfadm.py mod -t resource/appli@appli1/postact/path --set rscextent.bat
    clpcfadm.py mod -t resource/appli@appli1/postdeact/path --set rscextent.bat
  • Timeout (sec)

    Default, 30 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t resource/appli@appli1/preact/timeout --set <Value>
    clpcfadm.py mod -t resource/appli@appli1/predeact/timeout --set <Value>
    clpcfadm.py mod -t resource/appli@appli1/postact/timeout --set <Value>
    clpcfadm.py mod -t resource/appli@appli1/postdeact/timeout --set <Value>

    Note

    Set each of the <Value> fields to the same value.

  • Exec User

    clpcfadm.py mod -t resource/appli@appli1/preact/account --set <Value>
    clpcfadm.py mod -t resource/appli@appli1/predeact/account --set <Value>
    clpcfadm.py mod -t resource/appli@appli1/postact/account --set <Value>
    clpcfadm.py mod -t resource/appli@appli1/postdeact/account --set <Value>

    Note

    Set each of the <Value> fields to the same value.

7.1.3. Deleting an application resource

Delete a resource by specifying the group resource type and group resource name.

clpcfadm.py del rsc <Name of the group to which the resource belongs> appli appli1

Important

Resources associated with the group resource that you delete, such as monitor resources, are not deleted together.

7.2. AWS DNS resource

Note

The command lines in this section use awsdns1 as the group resource name.
Change it to suit your environment.

7.2.1. Adding an AWS DNS resource

Be sure to set the following items. For details, see "Setting AWS DNS resource parameters".

Item (mandatory)

Group resource name

Hosted Zone ID

Resource Record Set Name

IP Address

clpcfadm.py add rsc <Name of a group to which the resource belongs> awsdns awsdns1
clpcfadm.py mod -t resource/awsdns@awsdns1/parameters/hostedzoneid --set <Hosted Zone ID>
clpcfadm.py mod -t resource/awsdns@awsdns1/parameters/recordset --set <Resource Record Set Name>
clpcfadm.py mod -t resource/awsdns@awsdns1/parameters/ip --set <IP Address (Common)>
clpcfadm.py mod -t resource/awsdns@awsdns1/server@<Server name>/parameters/ip --set <IP Address (Individual)> --nocheck

Note

If you configure a cluster only with the above mandatory items, other parameters are set to their default values.

7.2.2. Setting AWS DNS resource parameters

7.2.2.1. Basic information

  • Group resource name (Within 31 bytes)

    This is set when the resource is added. To change the group resource name, delete the resource and set it again.

  • Comment (Within 127 bytes)

    clpcfadm.py mod -t resource/awsdns@awsdns1/comment --set <Comment>

    Note

    Enclose in double quotes a string including spaces (e.g., "Sample Comment").

7.2.2.2. Dependency

  • Follow the default dependency (default)

    clpcfadm.py del rscdep awsdns awsdns1
  • Set a parent resource

    clpcfadm.py add rscdep awsdns awsdns1 <Parent resource name>
  • No parent resource

    clpcfadm.py add rscdep awsdns awsdns1 ""
  • Delete a parent resource

    clpcfadm.py mod -t resource/awsdns@awsdns1/depend@<Parent resource name> --delete

7.2.2.3. Recovery Operation

Recovery Operation at Activity Failure Detection
  • Retry Count

    Default, 5 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t resource/awsdns@awsdns1/act/retry --set <Value>
  • Failover Target Server

    Failover Target Server

    Value

    Stable server (default)

    1

    Maximum priority server

    0

    clpcfadm.py mod -t resource/awsdns@awsdns1/act/mode --set <Value>
  • Failover Threshold

    Default, 1 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t resource/awsdns@awsdns1/act/fo2 --set <Value>
  • Final Action

    Final Action

    Value

    No operation (activate next resource)

    0

    No operation (not activate next resource) (default)

    1

    Stop group

    2

    Stop the cluster service

    3

    Stop the cluster service and shutdown OS

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t resource/awsdns@awsdns1/act/action --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/awsdns@awsdns1/act/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

    Script Settings
    • File type

      Script file type

      Value

      Script created with this product (default)

      1

      User Application

      0

      clpcfadm.py mod -t resource/awsdns@awsdns1/act/preaction/default --set <Value>

      Note

      If you change the value of this parameter, also change that of "File".

    • File (Within 1023 bytes)

      clpcfadm.py mod -t resource/awsdns@awsdns1/act/preaction/path --set <File>

      Note

      If you specify "Script created with this product", specify preactaction.bat.

      clpcfadm.py mod -t resource/awsdns@awsdns1/act/preaction/path --set preactaction.bat
    • Timeout (sec)

      Default, 5 (minimum, 1; maximum, 9999)

      clpcfadm.py mod -t resource/awsdns@awsdns1/act/preaction/timeout --set <Value>
    • Exec User

      clpcfadm.py mod -t resource/awsdns@awsdns1/act/preaction/account --set <Exec User>
Recovery Operation at Deactivity Failure Detection
  • Retry Count at Deactivation Failure

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t resource/awsdns@awsdns1/deact/retry --set <Value>
  • Final Action

    Final Action

    Value

    No operation (deactivate next resource)

    0

    No operation (not deactivate next resource)

    1

    Stop the cluster service and shutdown OS (default)

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t resource/awsdns@awsdns1/deact/action --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/awsdns@awsdns1/deact/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

    Script Settings
    • File type

      Script file type

      Value

      Script created with this product (default)

      1

      User Application

      0

      clpcfadm.py mod -t resource/awsdns@awsdns1/deact/preaction/default --set <Value>

      Note

      If you change the value of this parameter, also change that of "File".

    • File (Within 1023 bytes)

      clpcfadm.py mod -t resource/awsdns@awsdns1/deact/preaction/path --set <File>

      Note

      If you specify "Script created with this product", specify predeactaction.bat.

      clpcfadm.py mod -t resource/awsdns@awsdns1/deact/preaction/path --set predeactaction.bat
    • Timeout (sec)

      Default, 5 (minimum, 1; maximum, 9999)

      clpcfadm.py mod -t resource/awsdns@awsdns1/deact/preaction/timeout --set <Value>
    • Exec User

      clpcfadm.py mod -t resource/awsdns@awsdns1/deact/preaction/account --set <Exec User>

7.2.2.4. Details

Common
  • Hosted Zone ID (Within 255 bytes)

    clpcfadm.py mod -t resource/awsdns@awsdns1/parameters/hostedzoneid --set < Hosted Zone ID>
  • Resource Record Set Name (Within 255 bytes)

    clpcfadm.py mod -t resource/awsdns@awsdns1/parameters/recordset --set <Resource Record Set Name>
  • IP Address

    clpcfadm.py mod -t resource/awsdns@awsdns1/parameters/ip --set <IP Address>
  • TTL (sec)

    Default, 300 (minimum, 0; maximum, 2147483647)

    clpcfadm.py mod -t resource/awsdns@awsdns1/parameters/ttl --set <Value>
  • Delete a resource record set at deactivation

    Delete a resource record set at deactivation

    Value

    Delete

    1

    Do not delete (default)

    0

    clpcfadm.py mod -t resource/awsdns@awsdns1/parameters/delete --set <Value>
Tuning
AWS CLI
  • Timeout (sec)

    Default, 100 (minimum, 1; maximum, 999)

    clpcfadm.py mod -t resource/awsdns@awsdns1/parameters/awsclitimeout --set <Value>
Set Up Individually

Set the following for each server.

  • IP Address

    clpcfadm.py mod -t resource/awsdns@awsdns1/server@<Server name>/parameters/ip --set <IP Address> --nocheck

7.2.2.5. Extension

  • Resource Startup Attribute

    Resource Startup Attribute

    Value

    Automatic startup (default)

    1

    Manual startup

    0

    clpcfadm.py mod -t resource/awsdns@awsdns1/start --set <Value>
Execute Script before or after Activation or Deactivation

Note

If "Execute" is set for a script, specify the file. (See "Script Settings" -> "File".)

  • Execute Script before Activation

    Execute Script before Activation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/awsdns@awsdns1/preact/use --set <Value>
  • Execute Script after Activation

    Execute Script after Activation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/awsdns@awsdns1/predeact/use --set <Value>
  • Execute Script before Deactivation

    Execute Script before Deactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/awsdns@awsdns1/postact/use --set <Value>
  • Execute Script after Deactivation

    Execute Script after Deactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/awsdns@awsdns1/postdeact/use --set <Value>
Script Settings
  • File type

    Script file type

    Value

    Script created with this product (default)

    1

    User Application

    0

    clpcfadm.py mod -t resource/awsdns@awsdns1/preact/default --set <Value>
    clpcfadm.py mod -t resource/awsdns@awsdns1/predeact/default --set <Value>
    clpcfadm.py mod -t resource/awsdns@awsdns1/postact/default --set <Value>
    clpcfadm.py mod -t resource/awsdns@awsdns1/postdeact/default --set <Value>

    Note

    Set each of the <Value> fields to the same value.

    Note

    If you change the value of this parameter, also change that of "File".

  • File (Within 1023 bytes)

    clpcfadm.py mod -t resource/awsdns@awsdns1/preact/path --set <File>
    clpcfadm.py mod -t resource/awsdns@awsdns1/predeact/path --set <File>
    clpcfadm.py mod -t resource/awsdns@awsdns1/postact/path --set <File>
    clpcfadm.py mod -t resource/awsdns@awsdns1/postdeact/path --set <File>

    Note

    Set all <File> fields to the same value.

    Note

    If you specify "Script created with this product", specify rscextent.bat.

    clpcfadm.py mod -t resource/awsdns@awsdns1/preact/path --set rscextent.bat
    clpcfadm.py mod -t resource/awsdns@awsdns1/predeact/path --set rscextent.bat
    clpcfadm.py mod -t resource/awsdns@awsdns1/postact/path --set rscextent.bat
    clpcfadm.py mod -t resource/awsdns@awsdns1/postdeact/path --set rscextent.bat
  • Timeout (sec)

    Default, 30 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t resource/awsdns@awsdns1/preact/timeout --set <Value>
    clpcfadm.py mod -t resource/awsdns@awsdns1/predeact/timeout --set <Value>
    clpcfadm.py mod -t resource/awsdns@awsdns1/postact/timeout --set <Value>
    clpcfadm.py mod -t resource/awsdns@awsdns1/postdeact/timeout --set <Value>

    Note

    Set each of the <Value> fields to the same value.

  • Exec User

    clpcfadm.py mod -t resource/awsdns@awsdns1/preact/account --set <Value>
    clpcfadm.py mod -t resource/awsdns@awsdns1/predeact/account --set <Value>
    clpcfadm.py mod -t resource/awsdns@awsdns1/postact/account --set <Value>
    clpcfadm.py mod -t resource/awsdns@awsdns1/postdeact/account --set <Value>

    Note

    Set each of the <Value> fields to the same value.

7.2.3. Deleting an AWS DNS resource

Delete a resource by specifying the group resource type and group resource name.

clpcfadm.py del rsc <Name of the group to which the resource belongs> awsdns awsdns1

Important

Resources associated with the group resource that you delete, such as monitor resources, are not deleted together.

7.3. AWS Elastic IP resource

Note

The command lines in this section use awseip1 as the group resource name.
Change it to suit your environment.

7.3.1. Adding an AWS Elastic IP resource

Be sure to set the following items. For details, see "Setting AWS Elastic IP resource parameters".

Item (mandatory)

Group resource name

EIP ALLOCATION ID

ENI ID

clpcfadm.py add rsc <Name of a group to which the resource belongs> awseip awseip1
clpcfadm.py mod -t resource/awseip@awseip1/parameters/allocid --set <EIP ALLOCATION ID>
clpcfadm.py mod -t resource/awseip@awseip1/parameters/eniid --set <ENI ID (Common)>
clpcfadm.py mod -t resource/awseip@awseip1/server@<Server name>/parameters/eniid --set <ENI ID (Individual)> --nocheck

Note

If you configure a cluster only with the above mandatory items, other parameters are set to their default values.

7.3.2. Setting AWS Elastic IP resource parameters

7.3.2.1. Basic information

  • Group resource name (Within 31 bytes)

    This is set when the resource is added. To change the group resource name, delete the resource and set it again.

  • Comment (Within 127 bytes)

    clpcfadm.py mod -t resource/awseip@awseip1/comment --set <Comment>

    Note

    Enclose in double quotes a string including spaces (e.g., "Sample Comment").

7.3.2.2. Dependency

  • Follow the default dependency (default)

    clpcfadm.py del rscdep awseip awseip1
  • Set a parent resource

    clpcfadm.py add rscdep awseip awseip1 <Parent resource name>
  • No parent resource

    clpcfadm.py add rscdep awseip awseip1 ""
  • Delete a parent resource

    clpcfadm.py mod -t resource/awseip@awseip1/depend@<Parent resource name> --delete

7.3.2.3. Recovery Operation

Recovery Operation at Activity Failure Detection
  • Retry Count

    Default, 5 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t resource/awseip@awseip1/act/retry --set <Value>
  • Failover Target Server

    Failover Target Server

    Value

    Stable server (default)

    1

    Maximum priority server

    0

    clpcfadm.py mod -t resource/awseip@awseip1/act/mode --set <Value>
  • Failover Threshold

    Default, 1 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t resource/awseip@awseip1/act/fo2 --set <Value>
  • Final Action

    Final Action

    Value

    No operation (activate next resource)

    0

    No operation (not activate next resource) (default)

    1

    Stop group

    2

    Stop the cluster service

    3

    Stop the cluster service and shutdown OS

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t resource/awseip@awseip1/act/action --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/awseip@awseip1/act/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

    Script Settings
    • File type

      Script file type

      Value

      Script created with this product (default)

      1

      User Application

      0

      clpcfadm.py mod -t resource/awseip@awseip1/act/preaction/default --set <Value>

      Note

      If you change the value of this parameter, also change that of "File".

    • File (Within 1023 bytes)

      clpcfadm.py mod -t resource/awseip@awseip1/act/preaction/path --set <File>

      Note

      If you specify "Script created with this product", specify preactaction.bat.

      clpcfadm.py mod -t resource/awseip@awseip1/act/preaction/path --set preactaction.bat
    • Timeout (sec)

      Default, 5 (minimum, 1; maximum, 9999)

      clpcfadm.py mod -t resource/awseip@awseip1/act/preaction/timeout --set <Value>
    • Exec User

      clpcfadm.py mod -t resource/awseip@awseip1/act/preaction/account --set <Exec User>
Recovery Operation at Deactivity Failure Detection
  • Retry Count at Deactivation Failure

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t resource/awseip@awseip1/deact/retry --set <Value>
  • Final Action

    Final Action

    Value

    No operation (deactivate next resource)

    0

    No operation (not deactivate next resource)

    1

    Stop the cluster service and shutdown OS (default)

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t resource/awseip@awseip1/deact/action --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/awseip@awseip1/deact/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

    Script Settings
    • File type

      Script file type

      Value

      Script created with this product (default)

      1

      User Application

      0

      clpcfadm.py mod -t resource/awseip@awseip1/deact/preaction/default --set <Value>

      Note

      If you change the value of this parameter, also change that of "File".

    • File (Within 1023 bytes)

      clpcfadm.py mod -t resource/awseip@awseip1/deact/preaction/path --set <File>

      Note

      If you specify "Script created with this product", specify predeactaction.bat.

      clpcfadm.py mod -t resource/awseip@awseip1/deact/preaction/path --set predeactaction.bat
    • Timeout (sec)

      Default, 5 (minimum, 1; maximum, 9999)

      clpcfadm.py mod -t resource/awseip@awseip1/deact/preaction/timeout --set <Value>
    • Exec User

      clpcfadm.py mod -t resource/awseip@awseip1/deact/preaction/account --set <Exec User>

7.3.2.4. Details

Common
  • EIP ALLOCATION ID (Within 255 bytes)

    clpcfadm.py mod -t resource/awseip@awseip1/parameters/allocid --set <EIP ALLOCATION ID>
  • ENI ID (Within 45 bytes)

    clpcfadm.py mod -t resource/awseip@awseip1/parameters/eniid --set <ENI ID>
Tuning
AWS CLI
  • Timeout (sec)

    Default, 100 (minimum, 1; maximum, 999)

    clpcfadm.py mod -t resource/awseip@awseip1/parameters/awsclitimeout --set <Value>
Set Up Individually

Set the following for each server.

  • ENI ID

    clpcfadm.py mod -t resource/awseip@awseip1/server@<Server name>/parameters/eniid --set <ENI ID> --nocheck

7.3.2.5. Extension

  • Resource Startup Attribute

    Resource Startup Attribute

    Value

    Automatic startup (default)

    1

    Manual startup

    0

    clpcfadm.py mod -t resource/awseip@awseip1/start --set <Value>
Execute Script before or after Activation or Deactivation

Note

If "Execute" is set for a script, specify the file. (See "Script Settings" -> "File".)

  • Execute Script before Activation

    Execute Script before Activation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/awseip@awseip1/preact/use --set <Value>
  • Execute Script after Activation

    Execute Script after Activation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/awseip@awseip1/predeact/use --set <Value>
  • Execute Script before Deactivation

    Execute Script before Deactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/awseip@awseip1/postact/use --set <Value>
  • Execute Script after Deactivation

    Execute Script after Deactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/awseip@awseip1/postdeact/use --set <Value>
Script Settings
  • File type

    Script file type

    Value

    Script created with this product (default)

    1

    User Application

    0

    clpcfadm.py mod -t resource/awseip@awseip1/preact/default --set <Value>
    clpcfadm.py mod -t resource/awseip@awseip1/predeact/default --set <Value>
    clpcfadm.py mod -t resource/awseip@awseip1/postact/default --set <Value>
    clpcfadm.py mod -t resource/awseip@awseip1/postdeact/default --set <Value>

    Note

    Set each of the <Value> fields to the same value.

    Note

    If you change the value of this parameter, also change that of "File".

  • File (Within 1023 bytes)

    clpcfadm.py mod -t resource/awseip@awseip1/preact/path --set <File>
    clpcfadm.py mod -t resource/awseip@awseip1/predeact/path --set <File>
    clpcfadm.py mod -t resource/awseip@awseip1/postact/path --set <File>
    clpcfadm.py mod -t resource/awseip@awseip1/postdeact/path --set <File>

    Note

    Set all <File> fields to the same value.

    Note

    If you specify "Script created with this product", specify rscextent.bat.

    clpcfadm.py mod -t resource/awseip@awseip1/preact/path --set rscextent.bat
    clpcfadm.py mod -t resource/awseip@awseip1/predeact/path --set rscextent.bat
    clpcfadm.py mod -t resource/awseip@awseip1/postact/path --set rscextent.bat
    clpcfadm.py mod -t resource/awseip@awseip1/postdeact/path --set rscextent.bat
  • Timeout (sec)

    Default, 30 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t resource/awseip@awseip1/preact/timeout --set <Value>
    clpcfadm.py mod -t resource/awseip@awseip1/predeact/timeout --set <Value>
    clpcfadm.py mod -t resource/awseip@awseip1/postact/timeout --set <Value>
    clpcfadm.py mod -t resource/awseip@awseip1/postdeact/timeout --set <Value>

    Note

    Set each of the <Value> fields to the same value.

  • Exec User

    clpcfadm.py mod -t resource/awseip@awseip1/preact/account --set <Value>
    clpcfadm.py mod -t resource/awseip@awseip1/predeact/account --set <Value>
    clpcfadm.py mod -t resource/awseip@awseip1/postact/account --set <Value>
    clpcfadm.py mod -t resource/awseip@awseip1/postdeact/account --set <Value>

    Note

    Set each of the <Value> fields to the same value.

7.3.3. Deleting an AWS Elastic IP resource

Delete a resource by specifying the group resource type and group resource name.

clpcfadm.py del rsc <Name of the group to which the resource belongs> awseip awseip1

Important

Resources associated with the group resource that you delete, such as monitor resources, are not deleted together.

7.4. AWS Secondary IP resource

Note

The command lines in this section use awssip1 as the group resource name.
Change it to suit your environment.

7.4.1. Adding an AWS Secondary IP resource

Be sure to set the following items. For details, see "Setting AWS Secondary IP resource parameters".

Item (mandatory)

Group resource name

IP Address

ENI ID

clpcfadm.py add rsc <Name of a group to which the resource belongs> awssip awssip1
clpcfadm.py mod -t resource/awssip@awssip1/parameters/ip --set <IP Address>
clpcfadm.py mod -t resource/awssip@awssip1/parameters/eniid --set <ENI ID (Common)>
clpcfadm.py mod -t resource/awssip@awssip1/server@<Server name>/parameters/eniid --set <ENI ID (Individual)> --nocheck

Note

If you configure a cluster only with the above mandatory items, other parameters are set to their default values.

7.4.2. Setting AWS Secondary IP resource parameters

7.4.2.1. Basic information

  • Group resource name (Within 31 bytes)

    This is set when the resource is added. To change the group resource name, delete the resource and set it again.

  • Comment (Within 127 bytes)

    clpcfadm.py mod -t resource/awssip@awssip1/comment --set <Comment>

    Note

    Enclose in double quotes a string including spaces (e.g., "Sample Comment").

7.4.2.2. Dependency

  • Follow the default dependency (default)

    clpcfadm.py del rscdep awssip awssip1
  • Set a parent resource

    clpcfadm.py add rscdep awssip awssip1 <Parent resource name>
  • No parent resource

    clpcfadm.py add rscdep awssip awssip1 ""
  • Delete a parent resource

    clpcfadm.py mod -t resource/awssip@awssip1/depend@<Parent resource name> --delete

7.4.2.3. Recovery Operation

Recovery Operation at Activity Failure Detection
  • Retry Count

    Default, 5 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t resource/awssip@awssip1/act/retry --set <Value>
  • Failover Target Server

    Failover Target Server

    Value

    Stable server (default)

    1

    Maximum priority server

    0

    clpcfadm.py mod -t resource/awssip@awssip1/act/mode --set <Value>
  • Failover Threshold

    Default, 1 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t resource/awssip@awssip1/act/fo2 --set <Value>
  • Final Action

    Final Action

    Value

    No operation (activate next resource)

    0

    No operation (not activate next resource) (default)

    1

    Stop group

    2

    Stop the cluster service

    3

    Stop the cluster service and shutdown OS

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t resource/awssip@awssip1/act/action --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/awssip@awssip1/act/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

    Script Settings
    • File type

      Script file type

      Value

      Script created with this product (default)

      1

      User Application

      0

      clpcfadm.py mod -t resource/awssip@awssip1/act/preaction/default --set <Value>

      Note

      If you change the value of this parameter, also change that of "File".

    • File (Within 1023 bytes)

      clpcfadm.py mod -t resource/awssip@awssip1/act/preaction/path --set <File>

      Note

      If you specify "Script created with this product", specify preactaction.bat.

      clpcfadm.py mod -t resource/awssip@awssip1/act/preaction/path --set preactaction.bat
    • Timeout (sec)

      Default, 5 (minimum, 1; maximum, 9999)

      clpcfadm.py mod -t resource/awssip@awssip1/act/preaction/timeout --set <Value>
    • Exec User

      clpcfadm.py mod -t resource/awssip@awssip1/act/preaction/account --set <Exec User>
Recovery Operation at Deactivity Failure Detection
  • Retry Count at Deactivation Failure

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t resource/awssip@awssip1/deact/retry --set <Value>
  • Final Action

    Final Action

    Value

    No operation (deactivate next resource)

    0

    No operation (not deactivate next resource)

    1

    Stop the cluster service and shutdown OS (default)

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t resource/awssip@awssip1/deact/action --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/awssip@awssip1/deact/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

    Script Settings
    • File type

      Script file type

      Value

      Script created with this product (default)

      1

      User Application

      0

      clpcfadm.py mod -t resource/awssip@awssip1/deact/preaction/default --set <Value>

      Note

      If you change the value of this parameter, also change that of "File".

    • File (Within 1023 bytes)

      clpcfadm.py mod -t resource/awssip@awssip1/deact/preaction/path --set <File>

      Note

      If you specify "Script created with this product", specify predeactaction.bat.

      clpcfadm.py mod -t resource/awssip@awssip1/deact/preaction/path --set predeactaction.bat
    • Timeout (sec)

      Default, 5 (minimum, 1; maximum, 9999)

      clpcfadm.py mod -t resource/awssip@awssip1/deact/preaction/timeout --set <Value>
    • Exec User

      clpcfadm.py mod -t resource/awssip@awssip1/deact/preaction/account --set <Exec User>

7.4.2.4. Details

Common
  • IP Address

    clpcfadm.py mod -t resource/awssip@awssip1/parameters/ip --set <IP Address>
  • ENI ID (Within 48 bytes)

    clpcfadm.py mod -t resource/awssip@awssip1/parameters/eniid --set <ENI ID>
Tuning
  • Start Timeout (sec)

    Default, 180 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t resource/awssip@awssip1/parameters/acttimeout --set <Value>
  • Stop Timeout (sec)

    Default, 180 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t resource/awssip@awssip1/parameters/deacttimeout --set <Value>
Set Up Individually

Set the following for each server.

  • ENI ID (Within 48 bytes)

    clpcfadm.py mod -t resource/awssip@awssip1/server@<Server name>/parameters/eniid --set <ENI ID> --nocheck

7.4.2.5. Extension

  • Resource Startup Attribute

    Resource Startup Attribute

    Value

    Automatic startup (default)

    1

    Manual startup

    0

    clpcfadm.py mod -t resource/awssip@awssip1/start --set <Value>
Execute Script before or after Activation or Deactivation

Note

If "Execute" is set for a script, specify the file. (See "Script Settings" -> "File".)

  • Execute Script before Activation

    Execute Script before Activation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/awssip@awssip1/preact/use --set <Value>
  • Execute Script after Activation

    Execute Script after Activation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/awssip@awssip1/predeact/use --set <Value>
  • Execute Script before Deactivation

    Execute Script before Deactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/awssip@awssip1/postact/use --set <Value>
  • Execute Script after Deactivation

    Execute Script after Deactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/awssip@awssip1/postdeact/use --set <Value>
Script Settings
  • File type

    Script file type

    Value

    Script created with this product (default)

    1

    User Application

    0

    clpcfadm.py mod -t resource/awssip@awssip1/preact/default --set <Value>
    clpcfadm.py mod -t resource/awssip@awssip1/predeact/default --set <Value>
    clpcfadm.py mod -t resource/awssip@awssip1/postact/default --set <Value>
    clpcfadm.py mod -t resource/awssip@awssip1/postdeact/default --set <Value>

    Note

    Set each of the <Value> fields to the same value.

    Note

    If you change the value of this parameter, also change that of "File".

  • File (Within 1023 bytes)

    clpcfadm.py mod -t resource/awssip@awssip1/preact/path --set <File>
    clpcfadm.py mod -t resource/awssip@awssip1/predeact/path --set <File>
    clpcfadm.py mod -t resource/awssip@awssip1/postact/path --set <File>
    clpcfadm.py mod -t resource/awssip@awssip1/postdeact/path --set <File>

    Note

    Set all <File> fields to the same value.

    Note

    If you specify "Script created with this product", specify rscextent.bat.

    clpcfadm.py mod -t resource/awssip@awssip1/preact/path --set rscextent.bat
    clpcfadm.py mod -t resource/awssip@awssip1/predeact/path --set rscextent.bat
    clpcfadm.py mod -t resource/awssip@awssip1/postact/path --set rscextent.bat
    clpcfadm.py mod -t resource/awssip@awssip1/postdeact/path --set rscextent.bat
  • Timeout (sec)

    Default, 30 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t resource/awssip@awssip1/preact/timeout --set <Value>
    clpcfadm.py mod -t resource/awssip@awssip1/predeact/timeout --set <Value>
    clpcfadm.py mod -t resource/awssip@awssip1/postact/timeout --set <Value>
    clpcfadm.py mod -t resource/awssip@awssip1/postdeact/timeout --set <Value>

    Note

    Set each of the <Value> fields to the same value.

  • Exec User

    clpcfadm.py mod -t resource/awssip@awssip1/preact/account --set <Value>
    clpcfadm.py mod -t resource/awssip@awssip1/predeact/account --set <Value>
    clpcfadm.py mod -t resource/awssip@awssip1/postact/account --set <Value>
    clpcfadm.py mod -t resource/awssip@awssip1/postdeact/account --set <Value>

    Note

    Set each of the <Value> fields to the same value.

7.4.3. Deleting an AWS Secondary IP resource

Delete a resource by specifying the group resource type and group resource name.

clpcfadm.py del rsc <Name of the group to which the resource belongs> awssip awssip1

Important

Resources associated with the group resource that you delete, such as monitor resources, are not deleted together.

7.5. AWS Virtual IP resource

Note

The command lines in this section use awsvip1 as the group resource name.
Change it to suit your environment.

7.5.1. Adding an AWS Virtual IP resource

Be sure to set the following items. For details, see "Setting AWS Virtual IP resource parameters".

Item (mandatory)

Group resource name

IP Address

VPC ID

ENI ID

clpcfadm.py add rsc <Name of a group to which the resource belongs> awsvip awsvip1
clpcfadm.py mod -t resource/awsvip@awsvip1/parameters/ip --set <IP Address>
clpcfadm.py mod -t resource/awsvip@awsvip1/parameters/vpcid --set <VPC ID (Common)>
clpcfadm.py mod -t resource/awsvip@awsvip1/server@<Server name>/parameters/vpcid --set <VPC ID (Individual)> --nocheck
clpcfadm.py mod -t resource/awsvip@awsvip1/parameters/eniid --set <ENI ID (Common)>
clpcfadm.py mod -t resource/awsvip@awsvip1/server@<Server name>/parameters/eniid --set <ENI ID (Individual)> --nocheck

Note

If you configure a cluster only with the above mandatory items, other parameters are set to their default values.

7.5.2. Setting AWS Virtual IP resource parameters

7.5.2.1. Basic information

  • Group resource name (Within 31 bytes)

    This is set when the resource is added. To change the group resource name, delete the resource and set it again.

  • Comment (Within 127 bytes)

    clpcfadm.py mod -t resource/awsvip@awsvip1/comment --set <Comment>

    Note

    Enclose in double quotes a string including spaces (e.g., "Sample Comment").

7.5.2.2. Dependency

  • Follow the default dependency (default)

    clpcfadm.py del rscdep awsvip awsvip1
  • Set a parent resource

    clpcfadm.py add rscdep awsvip awsvip1 <Parent resource name>
  • No parent resource

    clpcfadm.py add rscdep awsvip awsvip1 ""
  • Delete a parent resource

    clpcfadm.py mod -t resource/awsvip@awsvip1/depend@<Parent resource name> --delete

7.5.2.3. Recovery Operation

Recovery Operation at Activity Failure Detection
  • Retry Count

    Default, 5 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t resource/awsvip@awsvip1/act/retry --set <Value>
  • Failover Target Server

    Failover Target Server

    Value

    Stable server (default)

    1

    Maximum priority server

    0

    clpcfadm.py mod -t resource/awsvip@awsvip1/act/mode --set <Value>
  • Failover Threshold

    Default, 1 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t resource/awsvip@awsvip1/act/fo2 --set <Value>
  • Final Action

    Final Action

    Value

    No operation (activate next resource)

    0

    No operation (not activate next resource) (default)

    1

    Stop group

    2

    Stop the cluster service

    3

    Stop the cluster service and shutdown OS

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t resource/awsvip@awsvip1/act/action --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/awsvip@awsvip1/act/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

    Script Settings
    • File type

      Script file type

      Value

      Script created with this product (default)

      1

      User Application

      0

      clpcfadm.py mod -t resource/awsvip@awsvip1/act/preaction/default --set <Value>

      Note

      If you change the value of this parameter, also change that of "File".

    • File (Within 1023 bytes)

      clpcfadm.py mod -t resource/awsvip@awsvip1/act/preaction/path --set <File>

      Note

      If you specify "Script created with this product", specify preactaction.bat.

      clpcfadm.py mod -t resource/awsvip@awsvip1/act/preaction/path --set preactaction.bat
    • Timeout (sec)

      Default, 5 (minimum, 1; maximum, 9999)

      clpcfadm.py mod -t resource/awsvip@awsvip1/act/preaction/timeout --set <Value>
    • Exec User

      clpcfadm.py mod -t resource/awsvip@awsvip1/act/preaction/account --set <Exec User>
Recovery Operation at Deactivity Failure Detection
  • Retry Count at Deactivation Failure

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t resource/awsvip@awsvip1/deact/retry --set <Value>
  • Final Action

    Final Action

    Value

    No operation (deactivate next resource)

    0

    No operation (not deactivate next resource)

    1

    Stop the cluster service and shutdown OS (default)

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t resource/awsvip@awsvip1/deact/action --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/awsvip@awsvip1/deact/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

    Script Settings
    • File type

      Script file type

      Value

      Script created with this product (default)

      1

      User Application

      0

      clpcfadm.py mod -t resource/awsvip@awsvip1/deact/preaction/default --set <Value>

      Note

      If you change the value of this parameter, also change that of "File".

    • File (Within 1023 bytes)

      clpcfadm.py mod -t resource/awsvip@awsvip1/deact/preaction/path --set <File>

      Note

      If you specify "Script created with this product", specify predeactaction.bat.

      clpcfadm.py mod -t resource/awsvip@awsvip1/deact/preaction/path --set predeactaction.bat
    • Timeout (sec)

      Default, 5 (minimum, 1; maximum, 9999)

      clpcfadm.py mod -t resource/awsvip@awsvip1/deact/preaction/timeout --set <Value>
    • Exec User

      clpcfadm.py mod -t resource/awsvip@awsvip1/deact/preaction/account --set <Exec User>

7.5.2.4. Details

Common
  • IP Address

    clpcfadm.py mod -t resource/awsvip@awsvip1/parameters/ip --set <IP Address>
  • VPC ID (Within 45 bytes)

    clpcfadm.py mod -t resource/awsvip@awsvip1/parameters/vpcid --set <VPC ID>
  • ENI ID (Within 45 bytes)

    clpcfadm.py mod -t resource/awsvip@awsvip1/parameters/eniid --set <ENI ID>
Tuning
  • Start Timeout (sec)

    Default, 300 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t resource/awsvip@awsvip1/parameters/acttimeout --set <Value>
  • Stop Timeout (sec)

    Default, 60 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t resource/awsvip@awsvip1/parameters/deacttimeout --set <Value>
Set Up Individually

Set the following for each server.

  • VPC ID (Within 45 bytes)

    clpcfadm.py mod -t resource/awsvip@awsvip1/server@<Server name>/parameters/vpcid --set <VPC ID> --nocheck
  • ENI ID (Within 45 bytes)

    clpcfadm.py mod -t resource/awsvip@awsvip1/server@<Server name>/parameters/eniid --set <ENI ID> --nocheck

7.5.2.5. Extension

  • Resource Startup Attribute

    Resource Startup Attribute

    Value

    Automatic startup (default)

    1

    Manual startup

    0

    clpcfadm.py mod -t resource/awsvip@awsvip1/start --set <Value>
Execute Script before or after Activation or Deactivation

Note

If "Execute" is set for a script, specify the file. (See "Script Settings" -> "File".)

  • Execute Script before Activation

    Execute Script before Activation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/awsvip@awsvip1/preact/use --set <Value>
  • Execute Script after Activation

    Execute Script after Activation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/awsvip@awsvip1/predeact/use --set <Value>
  • Execute Script before Deactivation

    Execute Script before Deactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/awsvip@awsvip1/postact/use --set <Value>
  • Execute Script after Deactivation

    Execute Script after Deactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/awsvip@awsvip1/postdeact/use --set <Value>
Script Settings
  • File type

    Script file type

    Value

    Script created with this product (default)

    1

    User Application

    0

    clpcfadm.py mod -t resource/awsvip@awsvip1/preact/default --set <Value>
    clpcfadm.py mod -t resource/awsvip@awsvip1/predeact/default --set <Value>
    clpcfadm.py mod -t resource/awsvip@awsvip1/postact/default --set <Value>
    clpcfadm.py mod -t resource/awsvip@awsvip1/postdeact/default --set <Value>

    Note

    Set each of the <Value> fields to the same value.

    Note

    If you change the value of this parameter, also change that of "File".

  • File (Within 1023 bytes)

    clpcfadm.py mod -t resource/awsvip@awsvip1/preact/path --set <File>
    clpcfadm.py mod -t resource/awsvip@awsvip1/predeact/path --set <File>
    clpcfadm.py mod -t resource/awsvip@awsvip1/postact/path --set <File>
    clpcfadm.py mod -t resource/awsvip@awsvip1/postdeact/path --set <File>

    Note

    Set all <File> fields to the same value.

    Note

    If you specify "Script created with this product", specify rscextent.bat.

    clpcfadm.py mod -t resource/awsvip@awsvip1/preact/path --set rscextent.bat
    clpcfadm.py mod -t resource/awsvip@awsvip1/predeact/path --set rscextent.bat
    clpcfadm.py mod -t resource/awsvip@awsvip1/postact/path --set rscextent.bat
    clpcfadm.py mod -t resource/awsvip@awsvip1/postdeact/path --set rscextent.bat
  • Timeout (sec)

    Default, 30 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t resource/awsvip@awsvip1/preact/timeout --set <Value>
    clpcfadm.py mod -t resource/awsvip@awsvip1/predeact/timeout --set <Value>
    clpcfadm.py mod -t resource/awsvip@awsvip1/postact/timeout --set <Value>
    clpcfadm.py mod -t resource/awsvip@awsvip1/postdeact/timeout --set <Value>

    Note

    Set each of the <Value> fields to the same value.

  • Exec User

    clpcfadm.py mod -t resource/awsvip@awsvip1/preact/account --set <Value>
    clpcfadm.py mod -t resource/awsvip@awsvip1/predeact/account --set <Value>
    clpcfadm.py mod -t resource/awsvip@awsvip1/postact/account --set <Value>
    clpcfadm.py mod -t resource/awsvip@awsvip1/postdeact/account --set <Value>

    Note

    Set each of the <Value> fields to the same value.

7.5.3. Deleting an AWS Virtual IP resource

Delete a resource by specifying the group resource type and group resource name.

clpcfadm.py del rsc <Name of the group to which the resource belongs> awsvip awsvip1

Important

Resources associated with the group resource that you delete, such as monitor resources, are not deleted together.

7.6. Azure DNS resource

Note

The command lines in this section use azuredns1 as the group resource name.
Change it to suit your environment.

7.6.1. Adding an Azure DNS resource

Be sure to set the following items. For details, see "Setting Azure DNS resource parameters".

Item (mandatory)

Group resource name

Record Set Name

Zone Name

IP Address

Resource Group Name

User URI

Tenant ID

File Path of Service Principal

Azure CLI File Path

clpcfadm.py add rsc <Name of a group to which the resource belongs> azuredns azuredns1
clpcfadm.py mod -t resource/azuredns@azuredns1/parameters/recordset --set <Record Set Name>
clpcfadm.py mod -t resource/azuredns@azuredns1/parameters/zone --set <Zone Name>
clpcfadm.py mod -t resource/azuredns@azuredns1/parameters/ip --set <IP Address (Common)>
clpcfadm.py mod -t resource/azuredns@azuredns1/server@<Server name>/parameters/ip --set <IP Address (Individual)> --nocheck
clpcfadm.py mod -t resource/azuredns@azuredns1/parameters/resourcegroup --set <Resource Group Name>
clpcfadm.py mod -t resource/azuredns@azuredns1/parameters/uri --set <User URI>
clpcfadm.py mod -t resource/azuredns@azuredns1/parameters/tenantid --set <Tenant ID>
clpcfadm.py mod -t resource/azuredns@azuredns1/parameters/certfile --set <File Path of Service Principal>
clpcfadm.py mod -t resource/azuredns@azuredns1/parameters/azurecli --set <Azure CLI File Path>

Note

If you configure a cluster only with the above mandatory items, other parameters are set to their default values.

7.6.2. Setting Azure DNS resource parameters

7.6.2.1. Basic information

  • Group resource name (Within 31 bytes)

    This is set when the resource is added. To change the group resource name, delete the resource and set it again.

  • Comment (Within 127 bytes)

    clpcfadm.py mod -t resource/azuredns@azuredns1/comment --set <Comment>

    Note

    Enclose in double quotes a string including spaces (e.g., "Sample Comment").

7.6.2.2. Dependency

  • Follow the default dependency (default)

    clpcfadm.py del rscdep azuredns azuredns1
  • Set a parent resource

    clpcfadm.py add rscdep azuredns azuredns1 <Parent resource name>
  • No parent resource

    clpcfadm.py add rscdep azuredns azuredns1 ""
  • Delete a parent resource

    clpcfadm.py mod -t resource/azuredns@azuredns1/depend@<Parent resource name> --delete

7.6.2.3. Recovery Operation

Recovery Operation at Activity Failure Detection
  • Retry Count

    Default, 1 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t resource/azuredns@azuredns1/act/retry --set <Value>
  • Failover Target Server

    Failover Target Server

    Value

    Stable server (default)

    1

    Maximum priority server

    0

    clpcfadm.py mod -t resource/azuredns@azuredns1/act/mode --set <Value>
  • Failover Threshold

    Default, 1 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t resource/azuredns@azuredns1/act/fo2 --set <Value>
  • Final Action

    Final Action

    Value

    No operation (activate next resource)

    0

    No operation (not activate next resource) (default)

    1

    Stop group

    2

    Stop the cluster service

    3

    Stop the cluster service and shutdown OS

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t resource/azuredns@azuredns1/act/action --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/azuredns@azuredns1/act/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

    Script Settings
    • File type

      Script file type

      Value

      Script created with this product (default)

      1

      User Application

      0

      clpcfadm.py mod -t resource/azuredns@azuredns1/act/preaction/default --set <Value>

      Note

      If you change the value of this parameter, also change that of "File".

    • File (Within 1023 bytes)

      clpcfadm.py mod -t resource/azuredns@azuredns1/act/preaction/path --set <File>

      Note

      If you specify "Script created with this product", specify preactaction.bat.

      clpcfadm.py mod -t resource/azuredns@azuredns1/act/preaction/path --set preactaction.bat
    • Timeout (sec)

      Default, 5 (minimum, 1; maximum, 9999)

      clpcfadm.py mod -t resource/azuredns@azuredns1/act/preaction/timeout --set <Value>
    • Exec User

      clpcfadm.py mod -t resource/azuredns@azuredns1/act/preaction/account --set <Exec User>
Recovery Operation at Deactivity Failure Detection
  • Retry Count at Deactivation Failure

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t resource/azuredns@azuredns1/deact/retry --set <Value>
  • Final Action

    Final Action

    Value

    No operation (deactivate next resource)

    0

    No operation (not deactivate next resource)

    1

    Stop the cluster service and shutdown OS (default)

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t resource/azuredns@azuredns1/deact/action --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/azuredns@azuredns1/deact/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

    Script Settings
    • File type

      Script file type

      Value

      Script created with this product (default)

      1

      User Application

      0

      clpcfadm.py mod -t resource/azuredns@azuredns1/deact/preaction/default --set <Value>

      Note

      If you change the value of this parameter, also change that of "File".

    • File (Within 1023 bytes)

      clpcfadm.py mod -t resource/azuredns@azuredns1/deact/preaction/path --set <File>

      Note

      If you specify "Script created with this product", specify predeactaction.bat.

      clpcfadm.py mod -t resource/azuredns@azuredns1/deact/preaction/path --set predeactaction.bat
    • Timeout (sec)

      Default, 5 (minimum, 1; maximum, 9999)

      clpcfadm.py mod -t resource/azuredns@azuredns1/deact/preaction/timeout --set <Value>
    • Exec User

      clpcfadm.py mod -t resource/azuredns@azuredns1/deact/preaction/account --set <Exec User>

7.6.2.4. Details

Common
  • Record Set Name (Within 253 bytes)

    clpcfadm.py mod -t resource/azuredns@azuredns1/parameters/recordset --set <Record Set Name>
  • Zone Name (Within 253 bytes)

    clpcfadm.py mod -t resource/azuredns@azuredns1/parameters/zone --set <Zone Name>
  • IP Address

    clpcfadm.py mod -t resource/azuredns@azuredns1/parameters/ip --set <IP Address>
  • TTL (sec)

    Default, 3600 (minimum, 0; maximum, 2147483647)

    clpcfadm.py mod -t resource/azuredns@azuredns1/parameters/ttl --set <Value>
  • Resource Group Name (Within 180 bytes)

    clpcfadm.py mod -t resource/azuredns@azuredns1/parameters/resourcegroup --set <Resource Group Name>
  • User URI (Within 2083 bytes)

    clpcfadm.py mod -t resource/azuredns@azuredns1/parameters/uri --set <User URI>
  • Tenant ID (Within 36 bytes)

    clpcfadm.py mod -t resource/azuredns@azuredns1/parameters/tenantid --set <Tenant ID>
  • File Path of Service Principal (Within 1023 bytes)

    clpcfadm.py mod -t resource/azuredns@azuredns1/parameters/certfile --set <File Path of Service Principal>
  • Azure CLI File Path (Within 1023 bytes)

    clpcfadm.py mod -t resource/azuredns@azuredns1/parameters/azurecli --set <Azure CLI File Path>
  • Delete a resource record set at deactivation

    Delete a resource record set at deactivation

    Value

    Delete (default)

    1

    Do not delete

    0

    clpcfadm.py mod -t resource/azuredns@azuredns1/parameters/delete --set <Value>
Tuning
Azure CLI
  • Timeout (sec)

    Default, 100 (minimum, 1; maximum, 999)

    clpcfadm.py mod -t resource/azuredns@azuredns1/parameters/azureclitimeout --set <Value>
Set Up Individually

Set the following for each server.

  • IP Address

    clpcfadm.py mod -t resource/azuredns@azuredns1/server@<Server name>/parameters/ip --set <IP Address> --nocheck

7.6.2.5. Extension

  • Resource Startup Attribute

    Resource Startup Attribute

    Value

    Automatic startup (default)

    1

    Manual startup

    0

    clpcfadm.py mod -t resource/azuredns@azuredns1/start --set <Value>
Execute Script before or after Activation or Deactivation

Note

If "Execute" is set for a script, specify the file. (See "Script Settings" -> "File".)

  • Execute Script before Activation

    Execute Script before Activation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/azuredns@azuredns1/preact/use --set <Value>
  • Execute Script after Activation

    Execute Script after Activation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/azuredns@azuredns1/predeact/use --set <Value>
  • Execute Script before Deactivation

    Execute Script before Deactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/azuredns@azuredns1/postact/use --set <Value>
  • Execute Script after Deactivation

    Execute Script after Deactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/azuredns@azuredns1/postdeact/use --set <Value>
Script Settings
  • File type

    Script file type

    Value

    Script created with this product (default)

    1

    User Application

    0

    clpcfadm.py mod -t resource/azuredns@azuredns1/preact/default --set <Value>
    clpcfadm.py mod -t resource/azuredns@azuredns1/predeact/default --set <Value>
    clpcfadm.py mod -t resource/azuredns@azuredns1/postact/default --set <Value>
    clpcfadm.py mod -t resource/azuredns@azuredns1/postdeact/default --set <Value>

    Note

    Set each of the <Value> fields to the same value.

    Note

    If you change the value of this parameter, also change that of "File".

  • File (Within 1023 bytes)

    clpcfadm.py mod -t resource/azuredns@azuredns1/preact/path --set <File>
    clpcfadm.py mod -t resource/azuredns@azuredns1/predeact/path --set <File>
    clpcfadm.py mod -t resource/azuredns@azuredns1/postact/path --set <File>
    clpcfadm.py mod -t resource/azuredns@azuredns1/postdeact/path --set <File>

    Note

    Set all <File> fields to the same value.

    Note

    If you specify "Script created with this product", specify rscextent.bat.

    clpcfadm.py mod -t resource/azuredns@azuredns1/preact/path --set rscextent.bat
    clpcfadm.py mod -t resource/azuredns@azuredns1/predeact/path --set rscextent.bat
    clpcfadm.py mod -t resource/azuredns@azuredns1/postact/path --set rscextent.bat
    clpcfadm.py mod -t resource/azuredns@azuredns1/postdeact/path --set rscextent.bat
  • Timeout (sec)

    Default, 30 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t resource/azuredns@azuredns1/preact/timeout --set <Value>
    clpcfadm.py mod -t resource/azuredns@azuredns1/predeact/timeout --set <Value>
    clpcfadm.py mod -t resource/azuredns@azuredns1/postact/timeout --set <Value>
    clpcfadm.py mod -t resource/azuredns@azuredns1/postdeact/timeout --set <Value>

    Note

    Set each of the <Value> fields to the same value.

  • Exec User

    clpcfadm.py mod -t resource/azuredns@azuredns1/preact/account --set <Value>
    clpcfadm.py mod -t resource/azuredns@azuredns1/predeact/account --set <Value>
    clpcfadm.py mod -t resource/azuredns@azuredns1/postact/account --set <Value>
    clpcfadm.py mod -t resource/azuredns@azuredns1/postdeact/account --set <Value>

    Note

    Set each of the <Value> fields to the same value.

7.6.3. Deleting an Azure DNS resource

Delete a resource by specifying the group resource type and group resource name.

clpcfadm.py del rsc <Name of the group to which the resource belongs> azuredns azuredns1

Important

Resources associated with the group resource that you delete, such as monitor resources, are not deleted together.

7.7. Azure probe port resource

Note

The command lines in this section use azurepp1 as the group resource name.
Change it to suit your environment.

7.7.1. Adding an Azure probe port resource

Be sure to set the following items. For details, see "Setting Azure probe port resource parameters".

Item (mandatory)

Group resource name

Probeport

clpcfadm.py add rsc <Name of a group to which the resource belongs> azurepp azurepp1
clpcfadm.py mod -t resource/azurepp@azurepp1/parameters/probeport --set <Probeport>

Note

If you configure a cluster only with the above mandatory items, other parameters are set to their default values.

7.7.2. Setting Azure probe port resource parameters

7.7.2.1. Basic information

  • Group resource name (Within 31 bytes)

    This is set when the resource is added. To change the group resource name, delete the resource and set it again.

  • Comment (Within 127 bytes)

    clpcfadm.py mod -t resource/azurepp@azurepp1/comment --set <Comment>

    Note

    Enclose in double quotes a string including spaces (e.g., "Sample Comment").

7.7.2.2. Dependency

  • Follow the default dependency (default)

    clpcfadm.py del rscdep azurepp azurepp1
  • Set a parent resource

    clpcfadm.py add rscdep azurepp azurepp1 <Parent resource name>
  • No parent resource

    clpcfadm.py add rscdep azurepp azurepp1 ""
  • Delete a parent resource

    clpcfadm.py mod -t resource/azurepp@azurepp1/depend@<Parent resource name> --delete

7.7.2.3. Recovery Operation

Recovery Operation at Activity Failure Detection
  • Retry Count

    Default, 5 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t resource/azurepp@azurepp1/act/retry --set <Value>
  • Failover Target Server

    Failover Target Server

    Value

    Stable server (default)

    1

    Maximum priority server

    0

    clpcfadm.py mod -t resource/azurepp@azurepp1/act/mode --set <Value>
  • Failover Threshold

    Default, 1 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t resource/azurepp@azurepp1/act/fo2 --set <Value>
  • Final Action

    Final Action

    Value

    No operation (activate next resource)

    0

    No operation (not activate next resource) (default)

    1

    Stop group

    2

    Stop the cluster service

    3

    Stop the cluster service and shutdown OS

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t resource/azurepp@azurepp1/act/action --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/azurepp@azurepp1/act/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

    Script Settings
    • File type

      Script file type

      Value

      Script created with this product (default)

      1

      User Application

      0

      clpcfadm.py mod -t resource/azurepp@azurepp1/act/preaction/default --set <Value>

      Note

      If you change the value of this parameter, also change that of "File".

    • File (Within 1023 bytes)

      clpcfadm.py mod -t resource/azurepp@azurepp1/act/preaction/path --set <File>

      Note

      If you specify "Script created with this product", specify preactaction.bat.

      clpcfadm.py mod -t resource/azurepp@azurepp1/act/preaction/path --set preactaction.bat
    • Timeout (sec)

      Default, 5 (minimum, 1; maximum, 9999)

      clpcfadm.py mod -t resource/azurepp@azurepp1/act/preaction/timeout --set <Value>
    • Exec User

      clpcfadm.py mod -t resource/azurepp@azurepp1/act/preaction/account --set <Exec User>
Recovery Operation at Deactivity Failure Detection
  • Retry Count at Deactivation Failure

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t resource/azurepp@azurepp1/deact/retry --set <Value>
  • Final Action

    Final Action

    Value

    No operation (deactivate next resource)

    0

    No operation (not deactivate next resource)

    1

    Stop the cluster service and shutdown OS (default)

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t resource/azurepp@azurepp1/deact/action --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/azurepp@azurepp1/deact/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

    Script Settings
    • File type

      Script file type

      Value

      Script created with this product (default)

      1

      User Application

      0

      clpcfadm.py mod -t resource/azurepp@azurepp1/deact/preaction/default --set <Value>

      Note

      If you change the value of this parameter, also change that of "File".

    • File (Within 1023 bytes)

      clpcfadm.py mod -t resource/azurepp@azurepp1/deact/preaction/path --set <File>

      Note

      If you specify "Script created with this product", specify predeactaction.bat.

      clpcfadm.py mod -t resource/azurepp@azurepp1/deact/preaction/path --set predeactaction.bat
    • Timeout (sec)

      Default, 5 (minimum, 1; maximum, 9999)

      clpcfadm.py mod -t resource/azurepp@azurepp1/deact/preaction/timeout --set <Value>
    • Exec User

      clpcfadm.py mod -t resource/azurepp@azurepp1/deact/preaction/account --set <Exec User>

7.7.2.4. Details

  • Probeport

    Default, None (minimum, 1; maximum, 65535)

    clpcfadm.py mod -t resource/azurepp@azurepp1/parameters/probeport --set <Value>
Tuning
  • Probe wait timeout (sec)

    Default, 30 (minimum, 5; maximum, 999999999)

    clpcfadm.py mod -t resource/azurepp@azurepp1/parameters/probetimeout --set <Value>

7.7.2.5. Extension

  • Resource Startup Attribute

    Resource Startup Attribute

    Value

    Automatic startup (default)

    1

    Manual startup

    0

    clpcfadm.py mod -t resource/azurepp@azurepp1/start --set <Value>
Execute Script before or after Activation or Deactivation

Note

If "Execute" is set for a script, specify the file. (See "Script Settings" -> "File".)

  • Execute Script before Activation

    Execute Script before Activation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/azurepp@azurepp1/preact/use --set <Value>
  • Execute Script after Activation

    Execute Script after Activation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/azurepp@azurepp1/predeact/use --set <Value>
  • Execute Script before Deactivation

    Execute Script before Deactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/azurepp@azurepp1/postact/use --set <Value>
  • Execute Script after Deactivation

    Execute Script after Deactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/azurepp@azurepp1/postdeact/use --set <Value>
Script Settings
  • File type

    Script file type

    Value

    Script created with this product (default)

    1

    User Application

    0

    clpcfadm.py mod -t resource/azurepp@azurepp1/preact/default --set <Value>
    clpcfadm.py mod -t resource/azurepp@azurepp1/predeact/default --set <Value>
    clpcfadm.py mod -t resource/azurepp@azurepp1/postact/default --set <Value>
    clpcfadm.py mod -t resource/azurepp@azurepp1/postdeact/default --set <Value>

    Note

    Set each of the <Value> fields to the same value.

    Note

    If you change the value of this parameter, also change that of "File".

  • File (Within 1023 bytes)

    clpcfadm.py mod -t resource/azurepp@azurepp1/preact/path --set <File>
    clpcfadm.py mod -t resource/azurepp@azurepp1/predeact/path --set <File>
    clpcfadm.py mod -t resource/azurepp@azurepp1/postact/path --set <File>
    clpcfadm.py mod -t resource/azurepp@azurepp1/postdeact/path --set <File>

    Note

    Set all <File> fields to the same value.

    Note

    If you specify "Script created with this product", specify rscextent.bat.

    clpcfadm.py mod -t resource/azurepp@azurepp1/preact/path --set rscextent.bat
    clpcfadm.py mod -t resource/azurepp@azurepp1/predeact/path --set rscextent.bat
    clpcfadm.py mod -t resource/azurepp@azurepp1/postact/path --set rscextent.bat
    clpcfadm.py mod -t resource/azurepp@azurepp1/postdeact/path --set rscextent.bat
  • Timeout (sec)

    Default, 30 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t resource/azurepp@azurepp1/preact/timeout --set <Value>
    clpcfadm.py mod -t resource/azurepp@azurepp1/predeact/timeout --set <Value>
    clpcfadm.py mod -t resource/azurepp@azurepp1/postact/timeout --set <Value>
    clpcfadm.py mod -t resource/azurepp@azurepp1/postdeact/timeout --set <Value>

    Note

    Set each of the <Value> fields to the same value.

  • Exec User

    clpcfadm.py mod -t resource/azurepp@azurepp1/preact/account --set <Value>
    clpcfadm.py mod -t resource/azurepp@azurepp1/predeact/account --set <Value>
    clpcfadm.py mod -t resource/azurepp@azurepp1/postact/account --set <Value>
    clpcfadm.py mod -t resource/azurepp@azurepp1/postdeact/account --set <Value>

    Note

    Set each of the <Value> fields to the same value.

7.7.3. Deleting an Azure probe port resource

Delete a resource by specifying the group resource type and group resource name.

clpcfadm.py del rsc <Name of the group to which the resource belongs> azurepp azurepp1

Important

Resources associated with the group resource that you delete, such as monitor resources, are not deleted together.

7.8. CIFS resource

Note

The command lines in this section use cifs1 as the group resource name.
Change it to suit your environment.

7.8.1. Adding a CIFS resource

Be sure to set the following items. For details, see "Setting CIFS resource parameters".

Item (mandatory)

Group resource name

Share Name

Folder

Target Drive

Number of users with access permission

User Name

Permission

clpcfadm.py add rsc <Name of a group to which the resource belongs> cifs cifs1
clpcfadm.py mod -t resource/cifs@cifs1/parameters/sharename --set <Share Name>
clpcfadm.py mod -t resource/cifs@cifs1/parameters/path --set <Folder>
clpcfadm.py mod -t resource/cifs@cifs1/parameters/drive --set <Target Drive>/
clpcfadm.py mod -t resource/cifs@cifs1/parameters/securitynum --set <Number of users with access permission>
clpcfadm.py mod -t resource/cifs@cifs1/parameters/securitylist@<ID>/name --set <User Name>
clpcfadm.py mod -t resource/cifs@cifs1/parameters/securitylist@<ID>/permissions --set <Permission>

Note

If you configure a cluster only with the above mandatory items, other parameters are set to their default values.

7.8.2. Setting CIFS resource parameters

7.8.2.1. Basic information

  • Group resource name (Within 31 bytes)

    This is set when the resource is added. To change the group resource name, delete the resource and set it again.

  • Comment (Within 127 bytes)

    clpcfadm.py mod -t resource/cifs@cifs1/comment --set <Comment>

    Note

    Enclose in double quotes a string including spaces (e.g., "Sample Comment").

7.8.2.2. Dependency

  • Follow the default dependency (default)

    clpcfadm.py del rscdep cifs cifs1
  • Set a parent resource

    clpcfadm.py add rscdep cifs cifs1 <Parent resource name>
  • No parent resource

    clpcfadm.py add rscdep cifs cifs1 ""
  • Delete a parent resource

    clpcfadm.py mod -t resource/cifs@cifs1/depend@<Parent resource name> --delete

7.8.2.3. Recovery Operation

Recovery Operation at Activity Failure Detection
  • Retry Count

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t resource/cifs@cifs1/act/retry --set <Value>
  • Failover Target Server

    Failover Target Server

    Value

    Stable server (default)

    1

    Maximum priority server

    0

    clpcfadm.py mod -t resource/cifs@cifs1/act/mode --set <Value>
  • Failover Threshold

    Default, 1 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t resource/cifs@cifs1/act/fo2 --set <Value>
  • Final Action

    Final Action

    Value

    No operation (activate next resource)

    0

    No operation (not activate next resource) (default)

    1

    Stop group

    2

    Stop the cluster service

    3

    Stop the cluster service and shutdown OS

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t resource/cifs@cifs1/act/action --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/cifs@cifs1/act/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

    Script Settings
    • File type

      Script file type

      Value

      Script created with this product (default)

      1

      User Application

      0

      clpcfadm.py mod -t resource/cifs@cifs1/act/preaction/default --set <Value>

      Note

      If you change the value of this parameter, also change that of "File".

    • File (Within 1023 bytes)

      clpcfadm.py mod -t resource/cifs@cifs1/act/preaction/path --set <File>

      Note

      If you specify "Script created with this product", specify preactaction.bat.

      clpcfadm.py mod -t resource/cifs@cifs1/act/preaction/path --set preactaction.bat
    • Timeout (sec)

      Default, 5 (minimum, 1; maximum, 9999)

      clpcfadm.py mod -t resource/cifs@cifs1/act/preaction/timeout --set <Value>
    • Exec User

      clpcfadm.py mod -t resource/cifs@cifs1/act/preaction/account --set <Exec User>
Recovery Operation at Deactivity Failure Detection
  • Retry Count at Deactivation Failure

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t resource/cifs@cifs1/deact/retry --set <Value>
  • Final Action

    Final Action

    Value

    No operation (deactivate next resource)

    0

    No operation (not deactivate next resource)

    1

    Stop the cluster service and shutdown OS (default)

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t resource/cifs@cifs1/deact/action --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/cifs@cifs1/deact/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

    Script Settings
    • File type

      Script file type

      Value

      Script created with this product (default)

      1

      User Application

      0

      clpcfadm.py mod -t resource/cifs@cifs1/deact/preaction/default --set <Value>

      Note

      If you change the value of this parameter, also change that of "File".

    • File (Within 1023 bytes)

      clpcfadm.py mod -t resource/cifs@cifs1/deact/preaction/path --set <File>

      Note

      If you specify "Script created with this product", specify predeactaction.bat.

      clpcfadm.py mod -t resource/cifs@cifs1/deact/preaction/path --set predeactaction.bat
    • Timeout (sec)

      Default, 5 (minimum, 1; maximum, 9999)

      clpcfadm.py mod -t resource/cifs@cifs1/deact/preaction/timeout --set <Value>
    • Exec User

      clpcfadm.py mod -t resource/cifs@cifs1/deact/preaction/account --set <Exec User>

7.8.2.4. Details

  • Execute the automatic saving of shared configuration of drive

    Execute the automatic saving of shared configuration of drive

    Value

    Yes

    1

    No (default)

    0

    clpcfadm.py mod -t resource/cifs@cifs1/parameters/driveadmin --set <Value>

Note

To set the following items, set "Execute the automatic saving of shared configuration of drive" to "Yes" in advance.

  • Target Drive

    Value

    A: (default)

    B:

    C:

    D:

    E:

    F:

    G:

    H:

    I:

    J:

    K:

    L:

    M:

    N:

    O:

    P:

    Q:

    R:

    S:

    T:

    U:

    V:

    W:

    X:

    Y:

    Z:

    clpcfadm.py mod -t resource/cifs@cifs1/parameters/drive --set <Value>
  • Shared Configuration File (Within 255 bytes)

    clpcfadm.py mod -t resource/cifs@cifs1/parameters/filepath --set <Shared Configuration File>
  • Errors in restoring file share setting are treated as activity failure

    Errors in restoring file share setting are treated as activity failure

    Value

    Yes

    1

    No (default)

    0

    clpcfadm.py mod -t resource/cifs@cifs1/parameters/errorcheck --set <Value>

Note

To set the following items, set "Execute the automatic saving of shared configuration of drive" to "No" in advance.

  • Share Name (Within 79 bytes)

    clpcfadm.py mod -t resource/cifs@cifs1/parameters/sharename --set <Share Name>
  • Folder (Within 255 bytes)

    clpcfadm.py mod -t resource/cifs@cifs1/parameters/path --set <Folder>
  • Comment (Within 255 bytes)

    clpcfadm.py mod -t resource/cifs@cifs1/parameters/comment --set <Comment>
  • When folder is shared not as activity failure

    When folder is shared not as activity failure

    Value

    Yes

    0

    No (default)

    1

    clpcfadm.py mod -t resource/cifs@cifs1/parameters/alreadyshared --set <Value>
Tuning

Note

To set the following items, set "Execute the automatic saving of shared configuration of drive" to "No" in advance.

Cache
  • Allow Caching

    Allow Caching

    Value

    Allow (default)

    1

    Do not allow

    0

    clpcfadm.py mod -t resource/cifs@cifs1/parameters/csc --set <Value>
  • Caching setting

    Caching setting

    Value

    Automatic Caching (default)

    0

    Manual Caching

    1

    Automatic Caching (Optimized for performance)

    2

    clpcfadm.py mod -t resource/cifs@cifs1/parameters/cscmethod --set <Value>
User
  • User Limit

    Default, 0 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t resource/cifs@cifs1/parameters/userlimit --set <Value>

    Note

    If you change the "User Limit" setting to "Infinite", set 0.

  • Permissions

    Add
    clpcfadm.py mod -t resource/cifs@cifs1/parameters/securitynum --set <Number of users>
    clpcfadm.py mod -t resource/cifs@cifs1/parameters/securitylist@<ID>/name --set <User Name> --nocheck
    clpcfadm.py mod -t resource/cifs@cifs1/parameters/securitylist@<ID>/permissions --set <Permission> --nocheck

    Note

    Set "Permission" to any of the following values:

    Permission

    Value

    None (default)

    0

    Read

    1

    Change

    2

    Full Control

    3

    Note

    With only one limited user, specify 0 for ID.
    With more than one limited user, specify consecutive numbers (e.g., 0, 1, 2...).
    Delete
    clpcfadm.py mod -t resource/cifs@cifs1/parameters/securitynum --set <Number of users after deletion>
    clpcfadm.py mod -t resource/cifs@cifs1/parameters/securitylist@<ID> --delete

7.8.2.5. Extension

  • Resource Startup Attribute

    Resource Startup Attribute

    Value

    Automatic startup (default)

    1

    Manual startup

    0

    clpcfadm.py mod -t resource/cifs@cifs1/start --set <Value>
Execute Script before or after Activation or Deactivation

Note

If "Execute" is set for a script, specify the file. (See "Script Settings" -> "File".)

  • Execute Script before Activation

    Execute Script before Activation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/cifs@cifs1/preact/use --set <Value>
  • Execute Script after Activation

    Execute Script after Activation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/cifs@cifs1/predeact/use --set <Value>
  • Execute Script before Deactivation

    Execute Script before Deactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/cifs@cifs1/postact/use --set <Value>
  • Execute Script after Deactivation

    Execute Script after Deactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/cifs@cifs1/postdeact/use --set <Value>
Script Settings
  • File type

    Script file type

    Value

    Script created with this product (default)

    1

    User Application

    0

    clpcfadm.py mod -t resource/cifs@cifs1/preact/default --set <Value>
    clpcfadm.py mod -t resource/cifs@cifs1/predeact/default --set <Value>
    clpcfadm.py mod -t resource/cifs@cifs1/postact/default --set <Value>
    clpcfadm.py mod -t resource/cifs@cifs1/postdeact/default --set <Value>

    Note

    Set each of the <Value> fields to the same value.

    Note

    If you change the value of this parameter, also change that of "File".

  • File (Within 1023 bytes)

    clpcfadm.py mod -t resource/cifs@cifs1/preact/path --set <File>
    clpcfadm.py mod -t resource/cifs@cifs1/predeact/path --set <File>
    clpcfadm.py mod -t resource/cifs@cifs1/postact/path --set <File>
    clpcfadm.py mod -t resource/cifs@cifs1/postdeact/path --set <File>

    Note

    Set all <File> fields to the same value.

    Note

    If you specify "Script created with this product", specify rscextent.bat.

    clpcfadm.py mod -t resource/cifs@cifs1/preact/path --set rscextent.bat
    clpcfadm.py mod -t resource/cifs@cifs1/predeact/path --set rscextent.bat
    clpcfadm.py mod -t resource/cifs@cifs1/postact/path --set rscextent.bat
    clpcfadm.py mod -t resource/cifs@cifs1/postdeact/path --set rscextent.bat
  • Timeout (sec)

    Default, 30 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t resource/cifs@cifs1/preact/timeout --set <Value>
    clpcfadm.py mod -t resource/cifs@cifs1/predeact/timeout --set <Value>
    clpcfadm.py mod -t resource/cifs@cifs1/postact/timeout --set <Value>
    clpcfadm.py mod -t resource/cifs@cifs1/postdeact/timeout --set <Value>

    Note

    Set each of the <Value> fields to the same value.

  • Exec User

    clpcfadm.py mod -t resource/cifs@cifs1/preact/account --set <Value>
    clpcfadm.py mod -t resource/cifs@cifs1/predeact/account --set <Value>
    clpcfadm.py mod -t resource/cifs@cifs1/postact/account --set <Value>
    clpcfadm.py mod -t resource/cifs@cifs1/postdeact/account --set <Value>

    Note

    Set each of the <Value> fields to the same value.

7.8.3. Deleting a CIFS resource

Delete a resource by specifying the group resource type and group resource name.

clpcfadm.py del rsc <Name of the group to which the resource belongs> cifs cifs1

Important

Resources associated with the group resource that you delete, such as monitor resources, are not deleted together.

7.9. Dynamic DNS resource

Note

The command lines in this section use ddns1 as the group resource name.
Change it to suit your environment.

7.9.1. Adding a dynamic DNS resource

Be sure to set the following items. For details, see "Setting dynamic DNS resource parameters".

Item (mandatory)

Group resource name

Virtual Host Name

IP Address

DDNS Server

clpcfadm.py add rsc <Name of a group to which the resource belongs> ddns ddns1
clpcfadm.py mod -t resource/ddns@ddns1/parameters/host/ddnsname --set <Virtual Host Name>
clpcfadm.py mod -t resource/ddns@ddns1/parameters/host/ip --set <IP Address>
clpcfadm.py mod -t resource/ddns@ddns1/parameters/dnsserver/name --set <DDNS Server>

Note

If you configure a cluster only with the above mandatory items, other parameters are set to their default values.

7.9.2. Setting dynamic DNS resource parameters

7.9.2.1. Basic information

  • Group resource name (Within 31 bytes)

    This is set when the resource is added. To change the group resource name, delete the resource and set it again.

  • Comment (Within 127 bytes)

    clpcfadm.py mod -t resource/ddns@ddns1/comment --set <Comment>

    Note

    Enclose in double quotes a string including spaces (e.g., "Sample Comment").

7.9.2.2. Dependency

  • Follow the default dependency (default)

    clpcfadm.py del rscdep ddns ddns1
  • Set a parent resource

    clpcfadm.py add rscdep ddns ddns1 <Parent resource name>
  • No parent resource

    clpcfadm.py add rscdep ddns ddns1 ""
  • Delete a parent resource

    clpcfadm.py mod -t resource/ddns@ddns1/depend@<Parent resource name> --delete

7.9.2.3. Recovery Operation

Recovery Operation at Activity Failure Detection
  • Retry Count

    Default, 1 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t resource/ddns@ddns1/act/retry --set <Value>
  • Failover Target Server

    Failover Target Server

    Value

    Stable server (default)

    1

    Maximum priority server

    0

    clpcfadm.py mod -t resource/ddns@ddns1/act/mode --set <Value>
  • Failover Threshold

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t resource/ddns@ddns1/act/fo2 --set <Value>
  • Final Action

    Final Action

    Value

    No operation (activate next resource)

    0

    No operation (not activate next resource) (default)

    1

    Stop group

    2

    Stop the cluster service

    3

    Stop the cluster service and shutdown OS

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t resource/ddns@ddns1/act/action --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/ddns@ddns1/act/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

    Script Settings
    • File type

      Script file type

      Value

      Script created with this product (default)

      1

      User Application

      0

      clpcfadm.py mod -t resource/ddns@ddns1/act/preaction/default --set <Value>

      Note

      If you change the value of this parameter, also change that of "File".

    • File (Within 1023 bytes)

      clpcfadm.py mod -t resource/ddns@ddns1/act/preaction/path --set <File>

      Note

      If you specify "Script created with this product", specify preactaction.bat.

      clpcfadm.py mod -t resource/ddns@ddns1/act/preaction/path --set preactaction.bat
    • Timeout (sec)

      Default, 5 (minimum, 1; maximum, 9999)

      clpcfadm.py mod -t resource/ddns@ddns1/act/preaction/timeout --set <Value>
    • Exec User

      clpcfadm.py mod -t resource/ddns@ddns1/act/preaction/account --set <Exec User>
Recovery Operation at Deactivity Failure Detection
  • Retry Count at Deactivation Failure

    Default, 1 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t resource/ddns@ddns1/deact/retry --set <Value>
  • Final Action

    Final Action

    Value

    No operation (deactivate next resource)

    0

    No operation (not deactivate next resource)

    1

    Stop the cluster service and shutdown OS (default)

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t resource/ddns@ddns1/deact/action --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/ddns@ddns1/deact/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

    Script Settings
    • File type

      Script file type

      Value

      Script created with this product (default)

      1

      User Application

      0

      clpcfadm.py mod -t resource/ddns@ddns1/deact/preaction/default --set <Value>

      Note

      If you change the value of this parameter, also change that of "File".

    • File (Within 1023 bytes)

      clpcfadm.py mod -t resource/ddns@ddns1/deact/preaction/path --set <File>

      Note

      If you specify "Script created with this product", specify predeactaction.bat.

      clpcfadm.py mod -t resource/ddns@ddns1/deact/preaction/path --set predeactaction.bat
    • Timeout (sec)

      Default, 5 (minimum, 1; maximum, 9999)

      clpcfadm.py mod -t resource/ddns@ddns1/deact/preaction/timeout --set <Value>
    • Exec User

      clpcfadm.py mod -t resource/ddns@ddns1/deact/preaction/account --set <Exec User>

7.9.2.4. Details

Common
  • Virtual Host Name (Within 255 bytes)

    clpcfadm.py mod -t resource/ddns@ddns1/parameters/host/ddnsname --set <Virtual Host Name>
  • IP Address

    clpcfadm.py mod -t resource/ddns@ddns1/parameters/host/ip --set <IP Address>
  • DDNS Server (Within 255 bytes)

    clpcfadm.py mod -t resource/ddns@ddns1/parameters/dnsserver/name --set <DDNS Server>
  • Port No.

    Default, 53 (minimum, 1; maximum, 65535)

    clpcfadm.py mod -t resource/ddns@ddns1/parameters/dnsserver/port --set <Value>
  • Cache TTL (sec)

    Default, 0 (minimum, 0; maximum, 2147483647)

    clpcfadm.py mod -t resource/ddns@ddns1/parameters/host/recordttl --set <Value>
  • Execute Dynamic Update Periodically

    Execute Dynamic Update Periodically

    Value

    Yes (default)

    1

    No

    0

    clpcfadm.py mod -t resource/ddns@ddns1/parameters/dynamicupdate --set <Value>
  • Update Interval (sec)

    Default, 3600 (minimum, 60; maximum, 599940)

    clpcfadm.py mod -t resource/ddns@ddns1/parameters/ddnsinterval --set <Value>

    Note

    Set as above with "Execute Dynamic Update Periodically" set to "Yes".

    Note

    Specify a value in seconds (divisible by 60).

  • Delete the Registered IP Address

    Delete the Registered IP Address

    Value

    Delete

    1

    Do not delete (default)

    0

    clpcfadm.py mod -t resource/ddns@ddns1/parameters/registeripdelete --set <Value>
  • Kerberos Authentication

    Kerberos Authentication

    Value

    Authenticate

    1

    Do not authenticate (default)

    0

    clpcfadm.py mod -t resource/ddns@ddns1/parameters/kerberosregister --set <Value>
Set Up Individually

Set the following for each server.

  • IP Address

    clpcfadm.py mod -t resource/ddns@ddns1/server@<Server name>/parameters/host/ip --set <IP Address> --nocheck

Note

To return to the common settings, set the following for each server.

clpcfadm.py mod -t resource/ddns@ddns1/server@<Server name> --delete

7.9.2.5. Extension

  • Resource Startup Attribute

    Resource Startup Attribute

    Value

    Automatic startup (default)

    1

    Manual startup

    0

    clpcfadm.py mod -t resource/ddns@ddns1/start --set <Value>
Execute Script before or after Activation or Deactivation

Note

If "Execute" is set for a script, specify the file. (See "Script Settings" -> "File".)

  • Execute Script before Activation

    Execute Script before Activation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/ddns@ddns1/preact/use --set <Value>
  • Execute Script after Activation

    Execute Script after Activation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/ddns@ddns1/predeact/use --set <Value>
  • Execute Script before Deactivation

    Execute Script before Deactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/ddns@ddns1/postact/use --set <Value>
  • Execute Script after Deactivation

    Execute Script after Deactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/ddns@ddns1/postdeact/use --set <Value>
Script Settings
  • File type

    Script file type

    Value

    Script created with this product (default)

    1

    User Application

    0

    clpcfadm.py mod -t resource/ddns@ddns1/preact/default --set <Value>
    clpcfadm.py mod -t resource/ddns@ddns1/predeact/default --set <Value>
    clpcfadm.py mod -t resource/ddns@ddns1/postact/default --set <Value>
    clpcfadm.py mod -t resource/ddns@ddns1/postdeact/default --set <Value>

    Note

    Set each of the <Value> fields to the same value.

    Note

    If you change the value of this parameter, also change that of "File".

  • File (Within 1023 bytes)

    clpcfadm.py mod -t resource/ddns@ddns1/preact/path --set <File>
    clpcfadm.py mod -t resource/ddns@ddns1/predeact/path --set <File>
    clpcfadm.py mod -t resource/ddns@ddns1/postact/path --set <File>
    clpcfadm.py mod -t resource/ddns@ddns1/postdeact/path --set <File>

    Note

    Set all <File> fields to the same value.

    Note

    If you specify "Script created with this product", specify rscextent.bat.

    clpcfadm.py mod -t resource/ddns@ddns1/preact/path --set rscextent.bat
    clpcfadm.py mod -t resource/ddns@ddns1/predeact/path --set rscextent.bat
    clpcfadm.py mod -t resource/ddns@ddns1/postact/path --set rscextent.bat
    clpcfadm.py mod -t resource/ddns@ddns1/postdeact/path --set rscextent.bat
  • Timeout (sec)

    Default, 30 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t resource/ddns@ddns1/preact/timeout --set <Value>
    clpcfadm.py mod -t resource/ddns@ddns1/predeact/timeout --set <Value>
    clpcfadm.py mod -t resource/ddns@ddns1/postact/timeout --set <Value>
    clpcfadm.py mod -t resource/ddns@ddns1/postdeact/timeout --set <Value>

    Note

    Set each of the <Value> fields to the same value.

  • Exec User

    clpcfadm.py mod -t resource/ddns@ddns1/preact/account --set <Value>
    clpcfadm.py mod -t resource/ddns@ddns1/predeact/account --set <Value>
    clpcfadm.py mod -t resource/ddns@ddns1/postact/account --set <Value>
    clpcfadm.py mod -t resource/ddns@ddns1/postdeact/account --set <Value>

    Note

    Set each of the <Value> fields to the same value.

7.9.3. Deleting a dynamic DNS resource

Delete a resource by specifying the group resource type and group resource name.

clpcfadm.py del rsc <Name of the group to which the resource belongs> ddns ddns1

Important

Resources associated with the group resource that you delete, such as monitor resources, are not deleted together.

7.10. Floating IP resource

Note

The command lines in this section use fip1 as the group resource name.
Change it to suit your environment.

7.10.1. Adding a floating IP resource

Be sure to set the following items. For details, see "Setting floating IP resource parameters".

Item (mandatory)

Group resource name

IP Address

clpcfadm.py add rsc <Name of a group to which the resource belongs> fip fip1
clpcfadm.py mod -t resource/fip@fip1/parameters/ip --set <IP Address>

Note

If you configure a cluster only with the above mandatory items, other parameters are set to their default values.

7.10.2. Setting floating IP resource parameters

7.10.2.1. Basic information

  • Group resource name (Within 31 bytes)

    This is set when the resource is added. To change the group resource name, delete the resource and set it again.

  • Comment (Within 127 bytes)

    clpcfadm.py mod -t resource/fip@fip1/comment --set <Comment>

    Note

    Enclose in double quotes a string including spaces (e.g., "Sample Comment").

7.10.2.2. Dependency

  • Follow the default dependency (default)

    clpcfadm.py del rscdep fip fip1
  • Set a parent resource

    clpcfadm.py add rscdep fip fip1 <Parent resource name>
  • No parent resource

    clpcfadm.py add rscdep fip fip1 ""
  • Delete a parent resource

    clpcfadm.py mod -t resource/fip@fip1/depend@<Parent resource name> --delete

7.10.2.3. Recovery Operation

Recovery Operation at Activity Failure Detection
  • Retry Count

    Default, 5 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t resource/fip@fip1/act/retry --set <Value>
  • Failover Target Server

    Failover Target Server

    Value

    Stable server (default)

    1

    Maximum priority server

    0

    clpcfadm.py mod -t resource/fip@fip1/act/mode --set <Value>
  • Failover Threshold

    Default, 1 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t resource/fip@fip1/act/fo2 --set <Value>
  • Final Action

    Final Action

    Value

    No operation (activate next resource)

    0

    No operation (not activate next resource) (default)

    1

    Stop group

    2

    Stop the cluster service

    3

    Stop the cluster service and shutdown OS

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t resource/fip@fip1/act/action --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/fip@fip1/act/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

    Script Settings
    • File type

      Script file type

      Value

      Script created with this product (default)

      1

      User Application

      0

      clpcfadm.py mod -t resource/fip@fip1/act/preaction/default --set <Value>

      Note

      If you change the value of this parameter, also change that of "File".

    • File (Within 1023 bytes)

      clpcfadm.py mod -t resource/fip@fip1/act/preaction/path --set <File>

      Note

      If you specify "Script created with this product", specify preactaction.bat.

      clpcfadm.py mod -t resource/fip@fip1/act/preaction/path --set preactaction.bat
    • Timeout (sec)

      Default, 5 (minimum, 1; maximum, 9999)

      clpcfadm.py mod -t resource/fip@fip1/act/preaction/timeout --set <Value>
    • Exec User

      clpcfadm.py mod -t resource/fip@fip1/act/preaction/account --set <Exec User>
Recovery Operation at Deactivity Failure Detection
  • Retry Count at Deactivation Failure

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t resource/fip@fip1/deact/retry --set <Value>
  • Final Action

    Final Action

    Value

    No operation (deactivate next resource)

    0

    No operation (not deactivate next resource)

    1

    Stop the cluster service and shutdown OS (default)

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t resource/fip@fip1/deact/action --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/fip@fip1/deact/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

    Script Settings
    • File type

      Script file type

      Value

      Script created with this product (default)

      1

      User Application

      0

      clpcfadm.py mod -t resource/fip@fip1/deact/preaction/default --set <Value>

      Note

      If you change the value of this parameter, also change that of "File".

    • File (Within 1023 bytes)

      clpcfadm.py mod -t resource/fip@fip1/deact/preaction/path --set <File>

      Note

      If you specify "Script created with this product", specify predeactaction.bat.

      clpcfadm.py mod -t resource/fip@fip1/deact/preaction/path --set predeactaction.bat
    • Timeout (sec)

      Default, 5 (minimum, 1; maximum, 9999)

      clpcfadm.py mod -t resource/fip@fip1/deact/preaction/timeout --set <Value>
    • Exec User

      clpcfadm.py mod -t resource/fip@fip1/deact/preaction/account --set <Exec User>

7.10.2.4. Details

Common
  • IP Address

    clpcfadm.py mod -t resource/fip@fip1/parameters/ip --set <IP Address>
Tuning
  • Run Ping

    Run Ping

    Value

    Yes (default)

    1

    No

    0

    clpcfadm.py mod -t resource/fip@fip1/parameters/pingexec --set <Value>

    Note

    To set the following items, set "Run Ping" to "Yes" in advance.

    ping
    • Interval (sec)

      Default, 1 (minimum, 0; maximum, 999)

      clpcfadm.py mod -t resource/fip@fip1/parameters/pinginterval --set <Value>
    • Timeout (msec)

      Default, 1000 (minimum, 1; maximum, 999999)

      clpcfadm.py mod -t resource/fip@fip1/parameters/pingtimeout --set <Value>
    • Retry Count

      Default, 5 (minimum, 0; maximum, 999)

      clpcfadm.py mod -t resource/fip@fip1/parameters/pingretry --set <Value>
    • Judge NIC Link Down as Failure

      Judge NIC Link Down as Failure

      Value

      Yes

      1

      No (default)

      0

      clpcfadm.py mod -t resource/fip@fip1/parameters/monmii --set <Value>
    • Use transmission source change feature

      Use transmission source change feature

      Value

      Use

      1

      Do not use (default)

      0

      clpcfadm.py mod -t resource/fip@fip1/parameters/srcip/use --set <Value>
    • Specification for transmission source

      Specification for transmission source

      Value

      Specify FIP as the transmission source (default)

      0

      Do not specify FIP as the transmission source

      1

      clpcfadm.py mod -t resource/fip@fip1/parameters/srcip/src --set <Value>

      Note

      Set as above with "Use transmission source change feature" set to "Use".

Set Up Individually

Set the following for each server.

  • IP Address

    clpcfadm.py mod -t resource/fip@fip1/server@<Server name>/parameters/ip --set <IP Address> --nocheck

Note

To return to the common settings, set the following for each server.

clpcfadm.py mod -t resource/fip@fip1/server@<Server name> --delete

7.10.2.5. Extension

  • Resource Startup Attribute

    Resource Startup Attribute

    Value

    Automatic startup (default)

    1

    Manual startup

    0

    clpcfadm.py mod -t resource/fip@fip1/start --set <Value>
Execute Script before or after Activation or Deactivation

Note

If "Execute" is set for a script, specify the file. (See "Script Settings" -> "File".)

  • Execute Script before Activation

    Execute Script before Activation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/fip@fip1/preact/use --set <Value>
  • Execute Script after Activation

    Execute Script after Activation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/fip@fip1/predeact/use --set <Value>
  • Execute Script before Deactivation

    Execute Script before Deactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/fip@fip1/postact/use --set <Value>
  • Execute Script after Deactivation

    Execute Script after Deactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/fip@fip1/postdeact/use --set <Value>
Script Settings
  • File type

    Script file type

    Value

    Script created with this product (default)

    1

    User Application

    0

    clpcfadm.py mod -t resource/fip@fip1/preact/default --set <Value>
    clpcfadm.py mod -t resource/fip@fip1/predeact/default --set <Value>
    clpcfadm.py mod -t resource/fip@fip1/postact/default --set <Value>
    clpcfadm.py mod -t resource/fip@fip1/postdeact/default --set <Value>

    Note

    Set each of the <Value> fields to the same value.

    Note

    If you change the value of this parameter, also change that of "File".

  • File (Within 1023 bytes)

    clpcfadm.py mod -t resource/fip@fip1/preact/path --set <File>
    clpcfadm.py mod -t resource/fip@fip1/predeact/path --set <File>
    clpcfadm.py mod -t resource/fip@fip1/postact/path --set <File>
    clpcfadm.py mod -t resource/fip@fip1/postdeact/path --set <File>

    Note

    Set all <File> fields to the same value.

    Note

    If you specify "Script created with this product", specify rscextent.bat.

    clpcfadm.py mod -t resource/fip@fip1/preact/path --set rscextent.bat
    clpcfadm.py mod -t resource/fip@fip1/predeact/path --set rscextent.bat
    clpcfadm.py mod -t resource/fip@fip1/postact/path --set rscextent.bat
    clpcfadm.py mod -t resource/fip@fip1/postdeact/path --set rscextent.bat
  • Timeout (sec)

    Default, 30 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t resource/fip@fip1/preact/timeout --set <Value>
    clpcfadm.py mod -t resource/fip@fip1/predeact/timeout --set <Value>
    clpcfadm.py mod -t resource/fip@fip1/postact/timeout --set <Value>
    clpcfadm.py mod -t resource/fip@fip1/postdeact/timeout --set <Value>

    Note

    Set each of the <Value> fields to the same value.

  • Exec User

    clpcfadm.py mod -t resource/fip@fip1/preact/account --set <Value>
    clpcfadm.py mod -t resource/fip@fip1/predeact/account --set <Value>
    clpcfadm.py mod -t resource/fip@fip1/postact/account --set <Value>
    clpcfadm.py mod -t resource/fip@fip1/postdeact/account --set <Value>

    Note

    Set each of the <Value> fields to the same value.

7.10.3. Deleting a floating IP resource

Delete a resource by specifying the group resource type and group resource name.

clpcfadm.py del rsc <Name of the group to which the resource belongs> fip fip1

Important

Resources associated with the group resource that you delete, such as monitor resources, are not deleted together.

7.11. Google Cloud DNS resource

Note

The command lines in this section use gcdns1 as the group resource name.
Change it to suit your environment.

7.11.1. Adding a Google Cloud DNS resource

Be sure to set the following items. For details, see "Setting Google Cloud DNS resource parameters".

Item (mandatory)

Group resource name

Zone Name

DNS Name

IP Address

clpcfadm.py add rsc <Name of a group to which the resource belongs> gcdns gcdns1
clpcfadm.py mod -t resource/gcdns@gcdns1/parameters/zone_name --set <Zone Name>
clpcfadm.py mod -t resource/gcdns@gcdns1/parameters/dns_name --set <DNS Name>
clpcfadm.py mod -t resource/gcdns@gcdns1/parameters/record_ip --set <IP Address (Common)>
clpcfadm.py mod -t resource/gcdns@gcdns1/server@<Server name>/parameters/record_ip --set <IP Address (Individual)> --nocheck

Note

If you configure a cluster only with the above mandatory items, other parameters are set to their default values.

7.11.2. Setting Google Cloud DNS resource parameters

7.11.2.1. Basic information

  • Group resource name (Within 31 bytes)

    This is set when the resource is added. To change the group resource name, delete the resource and set it again.

  • Comment (Within 127 bytes)

    clpcfadm.py mod -t resource/gcdns@gcdns1/comment --set <Comment>

    Note

    Enclose in double quotes a string including spaces (e.g., "Sample Comment").

7.11.2.2. Dependency

  • Follow the default dependency (default)

    clpcfadm.py del rscdep gcdns gcdns1
  • Set a parent resource

    clpcfadm.py add rscdep gcdns gcdns1 <Parent resource name>
  • No parent resource

    clpcfadm.py add rscdep gcdns gcdns1 ""
  • Delete a parent resource

    clpcfadm.py mod -t resource/gcdns@gcdns1/depend@<Parent resource name> --delete

7.11.2.3. Recovery Operation

Recovery Operation at Activity Failure Detection
  • Retry Count

    Default, 1 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t resource/gcdns@gcdns1/act/retry --set <Value>
  • Failover Target Server

    Failover Target Server

    Value

    Stable server (default)

    1

    Maximum priority server

    0

    clpcfadm.py mod -t resource/gcdns@gcdns1/act/mode --set <Value>
  • Failover Threshold

    Default, 1 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t resource/gcdns@gcdns1/act/fo2 --set <Value>
  • Final Action

    Final Action

    Value

    No operation (activate next resource)

    0

    No operation (not activate next resource) (default)

    1

    Stop group

    2

    Stop the cluster service

    3

    Stop the cluster service and shutdown OS

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t resource/gcdns@gcdns1/act/action --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/gcdns@gcdns1/act/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

    Script Settings
    • File type

      Script file type

      Value

      Script created with this product (default)

      1

      User Application

      0

      clpcfadm.py mod -t resource/gcdns@gcdns1/act/preaction/default --set <Value>

      Note

      If you change the value of this parameter, also change that of "File".

    • File (Within 1023 bytes)

      clpcfadm.py mod -t resource/gcdns@gcdns1/act/preaction/path --set <File>

      Note

      If you specify "Script created with this product", specify preactaction.bat.

      clpcfadm.py mod -t resource/gcdns@gcdns1/act/preaction/path --set preactaction.bat
    • Timeout (sec)

      Default, 5 (minimum, 1; maximum, 9999)

      clpcfadm.py mod -t resource/gcdns@gcdns1/act/preaction/timeout --set <Value>
    • Exec User

      clpcfadm.py mod -t resource/gcdns@gcdns1/act/preaction/account --set <Exec User>
Recovery Operation at Deactivity Failure Detection
  • Retry Count at Deactivation Failure

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t resource/gcdns@gcdns1/deact/retry --set <Value>
  • Final Action

    Final Action

    Value

    No operation (deactivate next resource)

    0

    No operation (not deactivate next resource)

    1

    Stop the cluster service and shutdown OS (default)

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t resource/gcdns@gcdns1/deact/action --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/gcdns@gcdns1/deact/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

    Script Settings
    • File type

      Script file type

      Value

      Script created with this product (default)

      1

      User Application

      0

      clpcfadm.py mod -t resource/gcdns@gcdns1/deact/preaction/default --set <Value>

      Note

      If you change the value of this parameter, also change that of "File".

    • File (Within 1023 bytes)

      clpcfadm.py mod -t resource/gcdns@gcdns1/deact/preaction/path --set <File>

      Note

      If you specify "Script created with this product", specify predeactaction.bat.

      clpcfadm.py mod -t resource/gcdns@gcdns1/deact/preaction/path --set predeactaction.bat
    • Timeout (sec)

      Default, 5 (minimum, 1; maximum, 9999)

      clpcfadm.py mod -t resource/gcdns@gcdns1/deact/preaction/timeout --set <Value>
    • Exec User

      clpcfadm.py mod -t resource/gcdns@gcdns1/deact/preaction/account --set <Exec User>

7.11.2.4. Details

Common
  • Zone Name (Within 63 bytes)

    clpcfadm.py mod -t resource/gcdns@gcdns1/parameters/zone_name --set <Zone Name>
  • DNS Name (Within 253 bytes)

    clpcfadm.py mod -t resource/gcdns@gcdns1/parameters/dns_name --set <DNS Name>
  • IP Address

    clpcfadm.py mod -t resource/gcdns@gcdns1/parameters/record_ip --set <IP Address>
  • TTL (sec)

    Default, 300 (minimum, 0; maximum, 2147483647)

    clpcfadm.py mod -t resource/gcdns@gcdns1/parameters/record_ttl --set <Value>
  • Delete the record at deactivation

    Delete the record at deactivation

    Value

    Delete (default)

    1

    Do not delete

    0

    clpcfadm.py mod -t resource/gcdns@gcdns1/parameters/delete --set <Value>
Set Up Individually

Set the following for each server.

  • IP Address

    clpcfadm.py mod -t resource/gcdns@gcdns1/server@<Server name>/parameters/record_ip --set <IP Address> --nocheck

7.11.2.5. Extension

  • Resource Startup Attribute

    Resource Startup Attribute

    Value

    Automatic startup (default)

    1

    Manual startup

    0

    clpcfadm.py mod -t resource/gcdns@gcdns1/start --set <Value>
Execute Script before or after Activation or Deactivation

Note

If "Execute" is set for a script, specify the file. (See "Script Settings" -> "File".)

  • Execute Script before Activation

    Execute Script before Activation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/gcdns@gcdns1/preact/use --set <Value>
  • Execute Script after Activation

    Execute Script after Activation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/gcdns@gcdns1/predeact/use --set <Value>
  • Execute Script before Deactivation

    Execute Script before Deactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/gcdns@gcdns1/postact/use --set <Value>
  • Execute Script after Deactivation

    Execute Script after Deactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/gcdns@gcdns1/postdeact/use --set <Value>
Script Settings
  • File type

    Script file type

    Value

    Script created with this product (default)

    1

    User Application

    0

    clpcfadm.py mod -t resource/gcdns@gcdns1/preact/default --set <Value>
    clpcfadm.py mod -t resource/gcdns@gcdns1/predeact/default --set <Value>
    clpcfadm.py mod -t resource/gcdns@gcdns1/postact/default --set <Value>
    clpcfadm.py mod -t resource/gcdns@gcdns1/postdeact/default --set <Value>

    Note

    Set each of the <Value> fields to the same value.

    Note

    If you change the value of this parameter, also change that of "File".

  • File (Within 1023 bytes)

    clpcfadm.py mod -t resource/gcdns@gcdns1/preact/path --set <File>
    clpcfadm.py mod -t resource/gcdns@gcdns1/predeact/path --set <File>
    clpcfadm.py mod -t resource/gcdns@gcdns1/postact/path --set <File>
    clpcfadm.py mod -t resource/gcdns@gcdns1/postdeact/path --set <File>

    Note

    Set all <File> fields to the same value.

    Note

    If you specify "Script created with this product", specify rscextent.bat.

    clpcfadm.py mod -t resource/gcdns@gcdns1/preact/path --set rscextent.bat
    clpcfadm.py mod -t resource/gcdns@gcdns1/predeact/path --set rscextent.bat
    clpcfadm.py mod -t resource/gcdns@gcdns1/postact/path --set rscextent.bat
    clpcfadm.py mod -t resource/gcdns@gcdns1/postdeact/path --set rscextent.bat
  • Timeout (sec)

    Default, 30 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t resource/gcdns@gcdns1/preact/timeout --set <Value>
    clpcfadm.py mod -t resource/gcdns@gcdns1/predeact/timeout --set <Value>
    clpcfadm.py mod -t resource/gcdns@gcdns1/postact/timeout --set <Value>
    clpcfadm.py mod -t resource/gcdns@gcdns1/postdeact/timeout --set <Value>

    Note

    Set each of the <Value> fields to the same value.

  • Exec User

    clpcfadm.py mod -t resource/gcdns@gcdns1/preact/account --set <Value>
    clpcfadm.py mod -t resource/gcdns@gcdns1/predeact/account --set <Value>
    clpcfadm.py mod -t resource/gcdns@gcdns1/postact/account --set <Value>
    clpcfadm.py mod -t resource/gcdns@gcdns1/postdeact/account --set <Value>

    Note

    Set each of the <Value> fields to the same value.

7.11.3. Deleting a Google Cloud DNS resource

Delete a resource by specifying the group resource type and group resource name.

clpcfadm.py del rsc <Name of the group to which the resource belongs> gcdns gcdns1

Important

Resources associated with the group resource that you delete, such as monitor resources, are not deleted together.

7.12. Google Cloud Virtual IP resource

Note

The command lines in this section use gcvip1 as the group resource name.
Change it to suit your environment.

7.12.1. Adding a Google Cloud Virtual IP resource

Be sure to set the following items. For details, see "Setting Google Cloud Virtual IP resource parameters".

Item (mandatory)

Group resource name

Port Number

clpcfadm.py add rsc <Name of a group to which the resource belongs> gcvip gcvip1
clpcfadm.py mod -t resource/gcvip@gcvip1/parameters/probeport --set <Port Number>

Note

If you configure a cluster only with the above mandatory items, other parameters are set to their default values.

7.12.2. Setting Google Cloud Virtual IP resource parameters

7.12.2.1. Basic information

  • Group resource name (Within 31 bytes)

    This is set when the resource is added. To change the group resource name, delete the resource and set it again.

  • Comment (Within 127 bytes)

    clpcfadm.py mod -t resource/gcvip@gcvip1/comment --set <Comment>

    Note

    Enclose in double quotes a string including spaces (e.g., "Sample Comment").

7.12.2.2. Dependency

  • Follow the default dependency (default)

    clpcfadm.py del rscdep gcvip gcvip1
  • Set a parent resource

    clpcfadm.py add rscdep gcvip gcvip1 <Parent resource name>
  • No parent resource

    clpcfadm.py add rscdep gcvip gcvip1 ""
  • Delete a parent resource

    clpcfadm.py mod -t resource/gcvip@gcvip1/depend@<Parent resource name> --delete

7.12.2.3. Recovery Operation

Recovery Operation at Activity Failure Detection
  • Retry Count

    Default, 5 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t resource/gcvip@gcvip1/act/retry --set <Value>
  • Failover Target Server

    Failover Target Server

    Value

    Stable server (default)

    1

    Maximum priority server

    0

    clpcfadm.py mod -t resource/gcvip@gcvip1/act/mode --set <Value>
  • Failover Threshold

    Default, 1 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t resource/gcvip@gcvip1/act/fo2 --set <Value>
  • Final Action

    Final Action

    Value

    No operation (activate next resource)

    0

    No operation (not activate next resource) (default)

    1

    Stop group

    2

    Stop the cluster service

    3

    Stop the cluster service and shutdown OS

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t resource/gcvip@gcvip1/act/action --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/gcvip@gcvip1/act/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

    Script Settings
    • File type

      Script file type

      Value

      Script created with this product (default)

      1

      User Application

      0

      clpcfadm.py mod -t resource/gcvip@gcvip1/act/preaction/default --set <Value>

      Note

      If you change the value of this parameter, also change that of "File".

    • File (Within 1023 bytes)

      clpcfadm.py mod -t resource/gcvip@gcvip1/act/preaction/path --set <File>

      Note

      If you specify "Script created with this product", specify preactaction.bat.

      clpcfadm.py mod -t resource/gcvip@gcvip1/act/preaction/path --set preactaction.bat
    • Timeout (sec)

      Default, 5 (minimum, 1; maximum, 9999)

      clpcfadm.py mod -t resource/gcvip@gcvip1/act/preaction/timeout --set <Value>
    • Exec User

      clpcfadm.py mod -t resource/gcvip@gcvip1/act/preaction/account --set <Exec User>
Recovery Operation at Deactivity Failure Detection
  • Retry Count at Deactivation Failure

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t resource/gcvip@gcvip1/deact/retry --set <Value>
  • Final Action

    Final Action

    Value

    No operation (deactivate next resource)

    0

    No operation (not deactivate next resource)

    1

    Stop the cluster service and shutdown OS (default)

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t resource/gcvip@gcvip1/deact/action --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/gcvip@gcvip1/deact/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

    Script Settings
    • File type

      Script file type

      Value

      Script created with this product (default)

      1

      User Application

      0

      clpcfadm.py mod -t resource/gcvip@gcvip1/deact/preaction/default --set <Value>

      Note

      If you change the value of this parameter, also change that of "File".

    • File (Within 1023 bytes)

      clpcfadm.py mod -t resource/gcvip@gcvip1/deact/preaction/path --set <File>

      Note

      If you specify "Script created with this product", specify predeactaction.bat.

      clpcfadm.py mod -t resource/gcvip@gcvip1/deact/preaction/path --set predeactaction.bat
    • Timeout (sec)

      Default, 5 (minimum, 1; maximum, 9999)

      clpcfadm.py mod -t resource/gcvip@gcvip1/deact/preaction/timeout --set <Value>
    • Exec User

      clpcfadm.py mod -t resource/gcvip@gcvip1/deact/preaction/account --set <Exec User>

7.12.2.4. Details

  • Port Number

    Default, None (minimum, 1; maximum, 65535)

    clpcfadm.py mod -t resource/gcvip@gcvip1/parameters/probeport --set <Value>
Tuning
  • Health Check Timeout (sec)

    Default, 30 (minimum, 5; maximum, 999999999)

    clpcfadm.py mod -t resource/gcvip@gcvip1/parameters/probetimeout --set <Value>

7.12.2.5. Extension

  • Resource Startup Attribute

    Resource Startup Attribute

    Value

    Automatic startup (default)

    1

    Manual startup

    0

    clpcfadm.py mod -t resource/gcvip@gcvip1/start --set <Value>
Execute Script before or after Activation or Deactivation

Note

If "Execute" is set for a script, specify the file. (See "Script Settings" -> "File".)

  • Execute Script before Activation

    Execute Script before Activation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/gcvip@gcvip1/preact/use --set <Value>
  • Execute Script after Activation

    Execute Script after Activation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/gcvip@gcvip1/predeact/use --set <Value>
  • Execute Script before Deactivation

    Execute Script before Deactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/gcvip@gcvip1/postact/use --set <Value>
  • Execute Script after Deactivation

    Execute Script after Deactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/gcvip@gcvip1/postdeact/use --set <Value>
Script Settings
  • File type

    Script file type

    Value

    Script created with this product (default)

    1

    User Application

    0

    clpcfadm.py mod -t resource/gcvip@gcvip1/preact/default --set <Value>
    clpcfadm.py mod -t resource/gcvip@gcvip1/predeact/default --set <Value>
    clpcfadm.py mod -t resource/gcvip@gcvip1/postact/default --set <Value>
    clpcfadm.py mod -t resource/gcvip@gcvip1/postdeact/default --set <Value>

    Note

    Set each of the <Value> fields to the same value.

    Note

    If you change the value of this parameter, also change that of "File".

  • File (Within 1023 bytes)

    clpcfadm.py mod -t resource/gcvip@gcvip1/preact/path --set <File>
    clpcfadm.py mod -t resource/gcvip@gcvip1/predeact/path --set <File>
    clpcfadm.py mod -t resource/gcvip@gcvip1/postact/path --set <File>
    clpcfadm.py mod -t resource/gcvip@gcvip1/postdeact/path --set <File>

    Note

    Set all <File> fields to the same value.

    Note

    If you specify "Script created with this product", specify rscextent.bat.

    clpcfadm.py mod -t resource/gcvip@gcvip1/preact/path --set rscextent.bat
    clpcfadm.py mod -t resource/gcvip@gcvip1/predeact/path --set rscextent.bat
    clpcfadm.py mod -t resource/gcvip@gcvip1/postact/path --set rscextent.bat
    clpcfadm.py mod -t resource/gcvip@gcvip1/postdeact/path --set rscextent.bat
  • Timeout (sec)

    Default, 30 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t resource/gcvip@gcvip1/preact/timeout --set <Value>
    clpcfadm.py mod -t resource/gcvip@gcvip1/predeact/timeout --set <Value>
    clpcfadm.py mod -t resource/gcvip@gcvip1/postact/timeout --set <Value>
    clpcfadm.py mod -t resource/gcvip@gcvip1/postdeact/timeout --set <Value>

    Note

    Set each of the <Value> fields to the same value.

  • Exec User

    clpcfadm.py mod -t resource/gcvip@gcvip1/preact/account --set <Value>
    clpcfadm.py mod -t resource/gcvip@gcvip1/predeact/account --set <Value>
    clpcfadm.py mod -t resource/gcvip@gcvip1/postact/account --set <Value>
    clpcfadm.py mod -t resource/gcvip@gcvip1/postdeact/account --set <Value>

    Note

    Set each of the <Value> fields to the same value.

7.12.3. Deleting a Google Cloud Virtual IP resource

Delete a resource by specifying the group resource type and group resource name.

clpcfadm.py del rsc <Name of the group to which the resource belongs> gcvip gcvip1

Important

Resources associated with the group resource that you delete, such as monitor resources, are not deleted together.

7.13. Hybrid disk resource

Note

The command lines in this section use hd1 as the group resource name.
Change it to suit your environment.

7.13.1. Adding a hybrid disk resource

Be sure to set the following items. For details, see "Setting hybrid disk resource parameters".

Item (mandatory)

Group resource name

Data Partition Drive Letter

GUID (data partition)

Cluster Partition Drive Letter

GUID (cluster partition)

Mirror Disk Connect

clpcfadm.py add rsc <Name of a group to which the resource belongs> hd hd1
clpcfadm.py mod -t resource/hd@hd1/parameters/volumemountpoint --set <Data Partition Drive Letter>
clpcfadm.py mod -t resource/hd@hd1/server@<Server name>/parameters/volumeguid --set <GUID (data partition)> --nocheck
clpcfadm.py mod -t resource/hd@hd1/parameters/cpvolumemountpoint --set <Cluster Partition Drive Letter>
clpcfadm.py mod -t resource/hd@hd1/server@<Server name>/parameters/cpvolumeguid --set <GUID (cluster partition)> --nocheck
clpcfadm.py mod -t resource/hd@hd1/parameters/netdev@<ID>/device --set <Mirror Disk Connect (Device ID)> --nocheck
clpcfadm.py mod -t resource/hd@hd1/parameters/netdev@<ID>/mdcname --set <Mirror Disk Connect (Name)> --nocheck
clpcfadm.py mod -t resource/hd@hd1/parameters/netdev@<ID>/priority --set <Mirror Disk Connect (Priority)> --nocheck

Note

If you configure a cluster only with the above mandatory items, other parameters are set to their default values.

7.13.2. Setting hybrid disk resource parameters

7.13.2.1. Basic information

  • Group resource name (Within 31 bytes)

    This is set when the resource is added. To change the group resource name, delete the resource and set it again.

  • Comment (Within 127 bytes)

    clpcfadm.py mod -t resource/hd@hd1/comment --set <Comment>

    Note

    Enclose in double quotes a string including spaces (e.g., "Sample Comment").

7.13.2.2. Dependency

  • Follow the default dependency (default)

    clpcfadm.py del rscdep hd hd1
  • Set a parent resource

    clpcfadm.py add rscdep hd hd1 <Parent resource name>
  • No parent resource

    clpcfadm.py add rscdep hd hd1 ""
  • Delete a parent resource

    clpcfadm.py mod -t resource/hd@hd1/depend@<Parent resource name> --delete

7.13.2.3. Recovery Operation

Recovery Operation at Activity Failure Detection
  • Retry Count

    Default, 3 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t resource/hd@hd1/act/retry --set <Value>
  • Failover Target Server

    Failover Target Server

    Value

    Stable server (default)

    1

    Maximum priority server

    0

    clpcfadm.py mod -t resource/hd@hd1/act/mode --set <Value>
  • Failover Threshold

    Default, 1 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t resource/hd@hd1/act/fo2 --set <Value>
  • Final Action

    Final Action

    Value

    No operation (activate next resource)

    0

    No operation (not activate next resource) (default)

    1

    Stop group

    2

    Stop the cluster service

    3

    Stop the cluster service and shutdown OS

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t resource/hd@hd1/act/action --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/hd@hd1/act/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

    Script Settings
    • File type

      Script file type

      Value

      Script created with this product (default)

      1

      User Application

      0

      clpcfadm.py mod -t resource/hd@hd1/act/preaction/default --set <Value>

      Note

      If you change the value of this parameter, also change that of "File".

    • File (Within 1023 bytes)

      clpcfadm.py mod -t resource/hd@hd1/act/preaction/path --set <File>

      Note

      If you specify "Script created with this product", specify preactaction.bat.

      clpcfadm.py mod -t resource/hd@hd1/act/preaction/path --set preactaction.bat
    • Timeout (sec)

      Default, 5 (minimum, 1; maximum, 9999)

      clpcfadm.py mod -t resource/hd@hd1/act/preaction/timeout --set <Value>
    • Exec User

      clpcfadm.py mod -t resource/hd@hd1/act/preaction/account --set <Exec User>
Recovery Operation at Deactivity Failure Detection
  • Retry Count at Deactivation Failure

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t resource/hd@hd1/deact/retry --set <Value>
  • Final Action

    Final Action

    Value

    No operation (deactivate next resource)

    0

    No operation (not deactivate next resource)

    1

    Stop the cluster service and shutdown OS (default)

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t resource/hd@hd1/deact/action --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/hd@hd1/deact/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

    Script Settings
    • File type

      Script file type

      Value

      Script created with this product (default)

      1

      User Application

      0

      clpcfadm.py mod -t resource/hd@hd1/deact/preaction/default --set <Value>

      Note

      If you change the value of this parameter, also change that of "File".

    • File (Within 1023 bytes)

      clpcfadm.py mod -t resource/hd@hd1/deact/preaction/path --set <File>

      Note

      If you specify "Script created with this product", specify predeactaction.bat.

      clpcfadm.py mod -t resource/hd@hd1/deact/preaction/path --set predeactaction.bat
    • Timeout (sec)

      Default, 5 (minimum, 1; maximum, 9999)

      clpcfadm.py mod -t resource/hd@hd1/deact/preaction/timeout --set <Value>
    • Exec User

      clpcfadm.py mod -t resource/hd@hd1/deact/preaction/account --set <Exec User>

7.13.2.4. Details

  • Hybrid Disk No.

    Value

    1

    2

    3

    4

    5

    6

    7

    8

    9

    10

    11

    12

    13

    14

    15

    16

    17

    18

    19

    20

    21

    22

    clpcfadm.py mod -t resource/hd@hd1/parameters/hdindex --set <Value>
  • Data Partition Drive Letter

    clpcfadm.py mod -t resource/hd@hd1/parameters/volumemountpoint --set <Data Partition Drive Letter>
  • GUID (data partition)

    clpcfadm.py mod -t resource/hd@hd1/server@<Server name>/parameters/volumeguid --set <GUID (data partition)> --nocheck

    Note

    The GUID can be retrieved by using the clpdiskctrl command.
    For details, see "clpdiskctrl command".
  • Cluster Partition Drive Letter

    clpcfadm.py mod -t resource/hd@hd1/parameters/cpvolumemountpoint --set <Cluster Partition Drive Letter>
  • GUID (cluster partition)

    clpcfadm.py mod -t resource/hd@hd1/server@<Server name>/parameters/cpvolumeguid --set <GUID (cluster partition)> --nocheck

    Note

    The GUID can be retrieved by using the clpdiskctrl command.
    For details, see "clpdiskctrl command".
  • Cluster Partition Offset Index

    Value

    0 (default)

    1

    2

    3

    4

    5

    6

    7

    clpcfadm.py mod -t resource/hd@hd1/parameters/cpvolumeoffsetindex --set <Value>
  • Mirror Disk Connect

    Value (Mirror disk connect [name])

    Value (Mirror disk connect [device ID])

    mdc1

    400

    mdc2

    401

    mdc3

    402

    mdc4

    403

    mdc5

    404

    mdc6

    405

    mdc7

    406

    mdc8

    407

    mdc9

    408

    mdc10

    409

    mdc11

    410

    mdc12

    411

    mdc13

    412

    mdc14

    413

    mdc15

    414

    mdc16

    415

    clpcfadm.py mod -t resource/hd@hd1/parameters/netdev@<ID>/device --set <Value (Mirror disk connect [device ID])> --nocheck
    clpcfadm.py mod -t resource/hd@hd1/parameters/netdev@<ID>/mdcname --set <Value (Mirror disk connect [name])> --nocheck
    clpcfadm.py mod -t resource/hd@hd1/parameters/netdev@<ID>/priority --set <Mirror Disk Connect (Priority)> --nocheck

    Note

    With only one mirror disk connect, specify 0 for ID.
    With more than one mirror disk connect, specify consecutive numbers (e.g., 0, 1, 2...).

    Note

    With only one mirror disk connect, specify 1 for Priority.
    With more than one mirror disk connect, specify consecutive numbers (e.g., 1, 2, 3...) in order of priority.
Tuning
  • Execute the initial mirror construction

    Execute the initial mirror construction

    Value

    Yes (default)

    1

    No

    0

    clpcfadm.py mod -t resource/hd@hd1/parameters/fullcopy --set <Value>
  • Mirror Connect Timeout (sec)

    Default, 20 (minimum, 2; maximum, 9999)

    clpcfadm.py mod -t resource/hd@hd1/parameters/mirrorconnecttimeout --set <Value>
  • Request Queue Maximum Size (KB)

    Default, 2048 (minimum, 512; maximum, 65535)

    clpcfadm.py mod -t resource/hd@hd1/parameters/requestqueuesize --set <Value>
Mode
  • Mode

    Mode

    Value

    Synchronous (default)

    1

    Asynchronous

    0

    clpcfadm.py mod -t resource/hd@hd1/parameters/syncmode --set <Value>

Note

To set the following items, set "Mode" to "Asynchronous" in advance.

  • Kernel Queue Size (KB)

    Default, 2048 (minimum, 512; maximum, 65535)

    clpcfadm.py mod -t resource/hd@hd1/parameters/kequeuesize --set <Value>
  • Application Queue Size (KB)

    Default, 2048 (minimum, 512; maximum, 65535)

    clpcfadm.py mod -t resource/hd@hd1/parameters/apqueuesize --set <Value>
  • Limit rate of Mirror Connect

    • Rate Limit (KB/sec)

      Default, 0 (minimum, 0; maximum, 999999999)

      clpcfadm.py mod -t resource/hd@hd1/parameters/bandlimit --set <Value>

    Note

    If you do not limit the communication bandwidth, specify 0.

    clpcfadm.py mod -t resource/hd@hd1/parameters/bandlimit --set 0
  • Thread Timeout (sec)

    Default, 0 (minimum, 2; maximum, 9999)

    clpcfadm.py mod -t resource/hd@hd1/parameters/apthreadtimeout --set <Value>
  • History Files Store Folder (Within 1023 bytes)

    clpcfadm.py mod -t resource/hd@hd1/parameters/historydir --set <History Files Store Folder>
  • Limit size of History File

    • Size Limit (MB)

      Default, 0 (minimum, 0; maximum, 999999999)

      clpcfadm.py mod -t resource/hd@hd1/parameters/historymax --set <Value>

    Note

    If you do not limit the history file size, specify 0.

    clpcfadm.py mod -t resource/hd@hd1/parameters/historymax --set 0
  • Compress Data

    Compress Data

    Value

    Compress data in normal operation

    1

    Compress data in recovery operation

    2

    Compress data in normal and recovery operation

    3

    Do not compress (default)

    0

    clpcfadm.py mod -t resource/hd@hd1/parameters/compress --set <Value>

    Important

    You cannot specify "Compress data in normal operation" or "Compress data in normal and recovery operation", with "Synchronize data" set to "Synchronize".

Recovery Method
  • Compress Data When Recovering

    Compress Data When Recovering

    Value

    Compress data in normal operation

    1

    Compress data in recovery operation

    2

    Compress data in normal and recovery operation

    3

    Do not compress (default)

    0

    clpcfadm.py mod -t resource/hd@hd1/parameters/compress --set <Value>

    Important

    You cannot specify "Compress data in normal operation" or "Compress data in normal and recovery operation", with "Synchronize data" set to "Synchronize".

Mirror Communication Encryption
  • Encrypt mirror communication

    Encrypt mirror communication

    Value

    Encrypt

    1

    Do not encrypt (default)

    0

    clpcfadm.py mod -t resource/hd@hd1/parameters/crypto/use --set <Value>
  • Key File Path (Within 1023 bytes)

    clpcfadm.py mod -t resource/hd@hd1/parameters/crypto/keyfile --set <Key File Path>

    Note

    Set as above with "Encrypt mirror communication" set to "Encrypt".

7.13.2.5. Extension

  • Resource Startup Attribute

    Resource Startup Attribute

    Value

    Automatic startup (default)

    1

    Manual startup

    0

    clpcfadm.py mod -t resource/hd@hd1/start --set <Value>
Execute Script before or after Activation or Deactivation

Note

If "Execute" is set for a script, specify the file. (See "Script Settings" -> "File".)

  • Execute Script before Activation

    Execute Script before Activation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/hd@hd1/preact/use --set <Value>
  • Execute Script after Activation

    Execute Script after Activation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/hd@hd1/predeact/use --set <Value>
  • Execute Script before Deactivation

    Execute Script before Deactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/hd@hd1/postact/use --set <Value>
  • Execute Script after Deactivation

    Execute Script after Deactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/hd@hd1/postdeact/use --set <Value>
Script Settings
  • File type

    Script file type

    Value

    Script created with this product (default)

    1

    User Application

    0

    clpcfadm.py mod -t resource/hd@hd1/preact/default --set <Value>
    clpcfadm.py mod -t resource/hd@hd1/predeact/default --set <Value>
    clpcfadm.py mod -t resource/hd@hd1/postact/default --set <Value>
    clpcfadm.py mod -t resource/hd@hd1/postdeact/default --set <Value>

    Note

    Set each of the <Value> fields to the same value.

    Note

    If you change the value of this parameter, also change that of "File".

  • File (Within 1023 bytes)

    clpcfadm.py mod -t resource/hd@hd1/preact/path --set <File>
    clpcfadm.py mod -t resource/hd@hd1/predeact/path --set <File>
    clpcfadm.py mod -t resource/hd@hd1/postact/path --set <File>
    clpcfadm.py mod -t resource/hd@hd1/postdeact/path --set <File>

    Note

    Set all <File> fields to the same value.

    Note

    If you specify "Script created with this product", specify rscextent.bat.

    clpcfadm.py mod -t resource/hd@hd1/preact/path --set rscextent.bat
    clpcfadm.py mod -t resource/hd@hd1/predeact/path --set rscextent.bat
    clpcfadm.py mod -t resource/hd@hd1/postact/path --set rscextent.bat
    clpcfadm.py mod -t resource/hd@hd1/postdeact/path --set rscextent.bat
  • Timeout (sec)

    Default, 30 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t resource/hd@hd1/preact/timeout --set <Value>
    clpcfadm.py mod -t resource/hd@hd1/predeact/timeout --set <Value>
    clpcfadm.py mod -t resource/hd@hd1/postact/timeout --set <Value>
    clpcfadm.py mod -t resource/hd@hd1/postdeact/timeout --set <Value>

    Note

    Set each of the <Value> fields to the same value.

  • Exec User

    clpcfadm.py mod -t resource/hd@hd1/preact/account --set <Value>
    clpcfadm.py mod -t resource/hd@hd1/predeact/account --set <Value>
    clpcfadm.py mod -t resource/hd@hd1/postact/account --set <Value>
    clpcfadm.py mod -t resource/hd@hd1/postdeact/account --set <Value>

    Note

    Set each of the <Value> fields to the same value.

7.13.3. Deleting a hybrid disk resource

Delete a resource by specifying the group resource type and group resource name.

clpcfadm.py del rsc <Name of the group to which the resource belongs> hd hd1

Important

Resources associated with the group resource that you delete, such as monitor resources, are not deleted together.

7.14. Mirror disk resource

Note

The command lines in this section use md1 as the group resource name.
Change it to suit your environment.

7.14.1. Adding a mirror disk resource

Be sure to set the following items. For details, see "Setting mirror disk resource parameters".

Item (mandatory)

Group resource name

Data Partition Drive Letter

GUID (data partition)

Cluster Partition Drive Letter

GUID (cluster partition)

Mirror Disk Connect

clpcfadm.py add rsc <Name of a group to which the resource belongs> md md1
clpcfadm.py mod -t resource/md@md1/parameters/volumemountpoint --set <Data Partition Drive Letter>
clpcfadm.py mod -t resource/md@md1/server@<Server name>/parameters/volumeguid --set <GUID (data partition)> --nocheck
clpcfadm.py mod -t resource/md@md1/parameters/cpvolumemountpoint --set <Cluster Partition Drive Letter>
clpcfadm.py mod -t resource/md@md1/server@<Server name>/parameters/cpvolumeguid --set <GUID (cluster partition)> --nocheck
clpcfadm.py mod -t resource/md@md1/parameters/netdev@<ID>/device --set <Mirror Disk Connect (Device ID)> --nocheck
clpcfadm.py mod -t resource/md@md1/parameters/netdev@<ID>/mdcname --set <Mirror Disk Connect (Name)> --nocheck
clpcfadm.py mod -t resource/md@md1/parameters/netdev@<ID>/priority --set <Mirror Disk Connect (Priority)> --nocheck

Note

If you configure a cluster only with the above mandatory items, other parameters are set to their default values.

7.14.2. Setting mirror disk resource parameters

7.14.2.1. Basic information

  • Group resource name (Within 31 bytes)

    This is set when the resource is added. To change the group resource name, delete the resource and set it again.

  • Comment (Within 127 bytes)

    clpcfadm.py mod -t resource/md@md1/comment --set <Comment>

    Note

    Enclose in double quotes a string including spaces (e.g., "Sample Comment").

7.14.2.2. Dependency

  • Follow the default dependency (default)

    clpcfadm.py del rscdep md md1
  • Set a parent resource

    clpcfadm.py add rscdep md md1 <Parent resource name>
  • No parent resource

    clpcfadm.py add rscdep md md1 ""
  • Delete a parent resource

    clpcfadm.py mod -t resource/md@md1/depend@<Parent resource name> --delete

7.14.2.3. Recovery Operation

Recovery Operation at Activity Failure Detection
  • Retry Count

    Default, 3 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t resource/md@md1/act/retry --set <Value>
  • Failover Target Server

    Failover Target Server

    Value

    Stable server (default)

    1

    Maximum priority server

    0

    clpcfadm.py mod -t resource/md@md1/act/mode --set <Value>
  • Failover Threshold

    Default, 1 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t resource/md@md1/act/fo2 --set <Value>
  • Final Action

    Final Action

    Value

    No operation (activate next resource)

    0

    No operation (not activate next resource) (default)

    1

    Stop group

    2

    Stop the cluster service

    3

    Stop the cluster service and shutdown OS

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t resource/md@md1/act/action --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/md@md1/act/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

    Script Settings
    • File type

      Script file type

      Value

      Script created with this product (default)

      1

      User Application

      0

      clpcfadm.py mod -t resource/md@md1/act/preaction/default --set <Value>

      Note

      If you change the value of this parameter, also change that of "File".

    • File (Within 1023 bytes)

      clpcfadm.py mod -t resource/md@md1/act/preaction/path --set <File>

      Note

      If you specify "Script created with this product", specify preactaction.bat.

      clpcfadm.py mod -t resource/md@md1/act/preaction/path --set preactaction.bat
    • Timeout (sec)

      Default, 5 (minimum, 1; maximum, 9999)

      clpcfadm.py mod -t resource/md@md1/act/preaction/timeout --set <Value>
    • Exec User

      clpcfadm.py mod -t resource/md@md1/act/preaction/account --set <Exec User>
Recovery Operation at Deactivity Failure Detection
  • Retry Count at Deactivation Failure

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t resource/md@md1/deact/retry --set <Value>
  • Final Action

    Final Action

    Value

    No operation (deactivate next resource)

    0

    No operation (not deactivate next resource)

    1

    Stop the cluster service and shutdown OS (default)

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t resource/md@md1/deact/action --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/md@md1/deact/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

    Script Settings
    • File type

      Script file type

      Value

      Script created with this product (default)

      1

      User Application

      0

      clpcfadm.py mod -t resource/md@md1/deact/preaction/default --set <Value>

      Note

      If you change the value of this parameter, also change that of "File".

    • File (Within 1023 bytes)

      clpcfadm.py mod -t resource/md@md1/deact/preaction/path --set <File>

      Note

      If you specify "Script created with this product", specify predeactaction.bat.

      clpcfadm.py mod -t resource/md@md1/deact/preaction/path --set predeactaction.bat
    • Timeout (sec)

      Default, 5 (minimum, 1; maximum, 9999)

      clpcfadm.py mod -t resource/md@md1/deact/preaction/timeout --set <Value>
    • Exec User

      clpcfadm.py mod -t resource/md@md1/deact/preaction/account --set <Exec User>

7.14.2.4. Details

  • Mirror Disk No.

    Value

    1

    2

    3

    4

    5

    6

    7

    8

    9

    10

    11

    12

    13

    14

    15

    16

    17

    18

    19

    20

    21

    22

    clpcfadm.py mod -t resource/md@md1/parameters/nmpindex --set <Value>
  • Data Partition Drive Letter

    clpcfadm.py mod -t resource/md@md1/parameters/volumemountpoint --set <Data Partition Drive Letter>
  • GUID (data partition)

    clpcfadm.py mod -t resource/md@md1/server@<Server name>/parameters/volumeguid --set <GUID (data partition)> --nocheck

    Note

    The GUID can be retrieved by using the clpdiskctrl command.
    For details, see "clpdiskctrl command".
  • Cluster Partition Drive Letter

    clpcfadm.py mod -t resource/md@md1/parameters/cpvolumemountpoint --set <Cluster Partition Drive Letter>
  • GUID (cluster partition)

    clpcfadm.py mod -t resource/md@md1/server@<Server name>/parameters/cpvolumeguid --set <GUID (cluster partition)> --nocheck

    Note

    The GUID can be retrieved by using the clpdiskctrl command.
    For details, see "clpdiskctrl command".
  • Cluster Partition Offset Index

    Value

    0 (default)

    1

    2

    3

    4

    5

    6

    7

    clpcfadm.py mod -t resource/md@md1/parameters/cpvolumeoffsetindex --set <Value>
  • Mirror Disk Connect

    Value (Mirror disk connect [name])

    Value (Mirror disk connect [device ID])

    mdc1

    400

    mdc2

    401

    mdc3

    402

    mdc4

    403

    mdc5

    404

    mdc6

    405

    mdc7

    406

    mdc8

    407

    mdc9

    408

    mdc10

    409

    mdc11

    410

    mdc12

    411

    mdc13

    412

    mdc14

    413

    mdc15

    414

    mdc16

    415

    clpcfadm.py mod -t resource/md@md1/parameters/netdev@<ID>/device --set <Value (Mirror disk connect [device ID]))> --nocheck
    clpcfadm.py mod -t resource/md@md1/parameters/netdev@<ID>/mdcname --set <Value (Mirror disk connect [name])> --nocheck
    clpcfadm.py mod -t resource/md@md1/parameters/netdev@<ID>/priority --set <Mirror Disk Connect (Priority)> --nocheck

    Note

    With only one mirror disk connect, specify 0 for ID.
    With more than one mirror disk connect, specify consecutive numbers (e.g., 0, 1, 2...).

    Note

    With only one mirror disk connect, specify 1 for Priority.
    With more than one mirror disk connect, specify consecutive numbers (e.g., 1, 2, 3...) in order of priority.
Tuning
  • Execute the initial mirror construction

    Execute the initial mirror construction

    Value

    Yes (default)

    1

    No

    0

    clpcfadm.py mod -t resource/md@md1/parameters/fullcopy --set <Value>
  • Mirror Connect Timeout (sec)

    Default, 20 (minimum, 2; maximum, 9999)

    clpcfadm.py mod -t resource/md@md1/parameters/mirrorconnecttimeout --set <Value>
  • Request Queue Maximum Size (KB)

    Default, 2048 (minimum, 512; maximum, 65535)

    clpcfadm.py mod -t resource/md@md1/parameters/requestqueuesize --set <Value>
Mode
  • Mode

    Mode

    Value

    Synchronous (default)

    1

    Asynchronous

    0

    clpcfadm.py mod -t resource/md@md1/parameters/syncmode --set <Value>

Note

To set the following items, set "Mode" to "Asynchronous" in advance.

  • Kernel Queue Size (KB)

    Default, 2048 (minimum, 512; maximum, 65535)

    clpcfadm.py mod -t resource/md@md1/parameters/kequeuesize --set <Value>
  • Application Queue Size (KB)

    Default, 2048 (minimum, 512; maximum, 65535)

    clpcfadm.py mod -t resource/md@md1/parameters/apqueuesize --set <Value>
  • Limit rate of Mirror Connect

    • Rate Limit (KB/sec)

      Default, 0 (minimum, 0; maximum, 999999999)

      clpcfadm.py mod -t resource/md@md1/parameters/bandlimit --set <Value>

    Note

    If you do not limit the communication bandwidth, specify 0.

    clpcfadm.py mod -t resource/md@md1/parameters/bandlimit --set 0
  • Thread Timeout (sec)

    Default, 0 (minimum, 2; maximum, 9999)

    clpcfadm.py mod -t resource/md@md1/parameters/apthreadtimeout --set <Value>
  • History Files Store Folder (Within 1023 bytes)

    clpcfadm.py mod -t resource/md@md1/parameters/historydir --set <History Files Store Folder>
  • Limit size of History File

    • Size Limit (MB)

      Default, 0 (minimum, 1; maximum, 999999999)

      clpcfadm.py mod -t resource/md@md1/parameters/historymax --set <Value>

    Note

    If you do not limit the history file size, specify 0.

    clpcfadm.py mod -t resource/md@md1/parameters/historymax --set 0
  • Compress Data

    Compress Data

    Value

    Compress data in normal operation

    1

    Compress data in recovery operation

    2

    Compress data in normal and recovery operation

    3

    Do not compress (default)

    0

    clpcfadm.py mod -t resource/md@md1/parameters/compress --set <Value>

    Important

    You cannot specify "Compress data in normal operation" or "Compress data in normal and recovery operation", with "Synchronize data" set to "Synchronize".

Recovery Method
  • Compress Data When Recovering

    Compress Data When Recovering

    Value

    Compress data in normal operation

    1

    Compress data in recovery operation

    2

    Compress data in normal and recovery operation

    3

    Do not compress (default)

    0

    clpcfadm.py mod -t resource/md@md1/parameters/compress --set <Value>

    Important

    You cannot specify "Compress data in normal operation" or "Compress data in normal and recovery operation", with "Synchronize data" set to "Synchronize".

Mirror Communication Encryption
  • Encrypt mirror communication

    Encrypt mirror communication

    Value

    Encrypt

    1

    Do not encrypt (default)

    0

    clpcfadm.py mod -t resource/md@md1/parameters/crypto/use --set <Value>
  • Key File Path (Within 1023 bytes)

    clpcfadm.py mod -t resource/md@md1/parameters/crypto/keyfile --set <Key File Path>

    Note

    Set as above with "Encrypt mirror communication" set to "Encrypt".

7.14.2.5. Extension

  • Resource Startup Attribute

    Resource Startup Attribute

    Value

    Automatic startup (default)

    1

    Manual startup

    0

    clpcfadm.py mod -t resource/md@md1/start --set <Value>
Execute Script before or after Activation or Deactivation

Note

If "Execute" is set for a script, specify the file. (See "Script Settings" -> "File".)

  • Execute Script before Activation

    Execute Script before Activation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/md@md1/preact/use --set <Value>
  • Execute Script after Activation

    Execute Script after Activation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/md@md1/predeact/use --set <Value>
  • Execute Script before Deactivation

    Execute Script before Deactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/md@md1/postact/use --set <Value>
  • Execute Script after Deactivation

    Execute Script after Deactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/md@md1/postdeact/use --set <Value>
Script Settings
  • File type

    Script file type

    Value

    Script created with this product (default)

    1

    User Application

    0

    clpcfadm.py mod -t resource/md@md1/preact/default --set <Value>
    clpcfadm.py mod -t resource/md@md1/predeact/default --set <Value>
    clpcfadm.py mod -t resource/md@md1/postact/default --set <Value>
    clpcfadm.py mod -t resource/md@md1/postdeact/default --set <Value>

    Note

    Set each of the <Value> fields to the same value.

    Note

    If you change the value of this parameter, also change that of "File".

  • File (Within 1023 bytes)

    clpcfadm.py mod -t resource/md@md1/preact/path --set <File>
    clpcfadm.py mod -t resource/md@md1/predeact/path --set <File>
    clpcfadm.py mod -t resource/md@md1/postact/path --set <File>
    clpcfadm.py mod -t resource/md@md1/postdeact/path --set <File>

    Note

    Set all <File> fields to the same value.

    Note

    If you specify "Script created with this product", specify rscextent.bat.

    clpcfadm.py mod -t resource/md@md1/preact/path --set rscextent.bat
    clpcfadm.py mod -t resource/md@md1/predeact/path --set rscextent.bat
    clpcfadm.py mod -t resource/md@md1/postact/path --set rscextent.bat
    clpcfadm.py mod -t resource/md@md1/postdeact/path --set rscextent.bat
  • Timeout (sec)

    Default, 30 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t resource/md@md1/preact/timeout --set <Value>
    clpcfadm.py mod -t resource/md@md1/predeact/timeout --set <Value>
    clpcfadm.py mod -t resource/md@md1/postact/timeout --set <Value>
    clpcfadm.py mod -t resource/md@md1/postdeact/timeout --set <Value>

    Note

    Set each of the <Value> fields to the same value.

  • Exec User

    clpcfadm.py mod -t resource/md@md1/preact/account --set <Value>
    clpcfadm.py mod -t resource/md@md1/predeact/account --set <Value>
    clpcfadm.py mod -t resource/md@md1/postact/account --set <Value>
    clpcfadm.py mod -t resource/md@md1/postdeact/account --set <Value>

    Note

    Set each of the <Value> fields to the same value.

7.14.3. Deleting a mirror disk resource

Delete a resource by specifying the group resource type and group resource name.

clpcfadm.py del rsc <Name of the group to which the resource belongs> md md1

Important

Resources associated with the group resource that you delete, such as monitor resources, are not deleted together.

7.15. Oracle Cloud DNS resource

Note

The command lines in this section use ocdns1 as the group resource name.
Change it to suit your environment.

7.15.1. Adding an Oracle Cloud DNS resource

Be sure to set the following items. For details, see "Setting Oracle Cloud DNS resource parameters".

Item (mandatory)

Group resource name

Region

Domain (FQDN)

Zone OCID

IP Address

clpcfadm.py add rsc <Name of a group to which the resource belongs> ocdns ocdns1
clpcfadm.py mod -t resource/ocdns@ocdns1/parameters/region --set <Region (Common)>
clpcfadm.py mod -t resource/ocdns@ocdns1/parameters/domain --set <Domain (FQDN)>
clpcfadm.py mod -t resource/ocdns@ocdns1/parameters/zoneid --set <Zone OCID (Common)>
clpcfadm.py mod -t resource/ocdns@ocdns1/parameters/ip --set <IP Address (Common)>
clpcfadm.py mod -t resource/ocdns@ocdns1/server@<Server name>/parameters/region --set <Region (Individual)>
clpcfadm.py mod -t resource/ocdns@ocdns1/server@<Server name>/parameters/zoneid --set <Zone OCID (Individual)>
clpcfadm.py mod -t resource/ocdns@ocdns1/server@<Server name>/parameters/ip --set <IP Address (Individual)>

Note

If you configure a cluster only with the above mandatory items, other parameters are set to their default values.

7.15.2. Setting Oracle Cloud DNS resource parameters

7.15.2.1. Basic information

  • Group resource name (Within 31 bytes)

    This is set when the resource is added. To change the group resource name, delete the resource and set it again.

  • Comment (Within 127 bytes)

    clpcfadm.py mod -t resource/ocdns@ocdns1/comment --set <Comment>

    Note

    Enclose in double quotes a string including spaces (e.g., "Sample Comment").

7.15.2.2. Dependency

  • Follow the default dependency (default)

    clpcfadm.py del rscdep ocdns ocdns1
  • Set a parent resource

    clpcfadm.py add rscdep ocdns ocdns1 <Parent resource name>
  • No parent resource

    clpcfadm.py add rscdep ocdns ocdns1 ""
  • Delete a parent resource

    clpcfadm.py mod -t resource/ocdns@ocdns1/depend@<Parent resource name> --delete

7.15.2.3. Recovery Operation

Recovery Operation at Activity Failure Detection
  • Retry Count

    Default, 5 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t resource/ocdns@ocdns1/act/retry --set <Value>
  • Failover Target Server

    Failover Target Server

    Value

    Stable server (default)

    1

    Maximum priority server

    0

    clpcfadm.py mod -t resource/ocdns@ocdns1/act/mode --set <Value>
  • Failover Threshold

    Default, 1 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t resource/ocdns@ocdns1/act/fo2 --set <Value>
  • Final Action

    Final Action

    Value

    No operation (activate next resource)

    0

    No operation (not activate next resource) (default)

    1

    Stop group

    2

    Stop the cluster service

    3

    Stop the cluster service and shutdown OS

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t resource/ocdns@ocdns1/act/action --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/ocdns@ocdns1/act/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

    Script Settings
    • File type

      Script file type

      Value

      Script created with this product (default)

      1

      User Application

      0

      clpcfadm.py mod -t resource/ocdns@ocdns1/act/preaction/default --set <Value>

      Note

      If you change the value of this parameter, also change that of "File".

    • File (Within 1023 bytes)

      clpcfadm.py mod -t resource/ocdns@ocdns1/act/preaction/path --set <File>

      Note

      If you specify "Script created with this product", specify preactaction.bat.

      clpcfadm.py mod -t resource/ocdns@ocdns1/act/preaction/path --set preactaction.bat
    • Timeout (sec)

      Default, 5 (minimum, 1; maximum, 9999)

      clpcfadm.py mod -t resource/ocdns@ocdns1/act/preaction/timeout --set <Value>
    • Exec User

      clpcfadm.py mod -t resource/ocdns@ocdns1/act/preaction/account --set <Exec User>
Recovery Operation at Deactivity Failure Detection
  • Retry Count at Deactivation Failure

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t resource/ocdns@ocdns1/deact/retry --set <Value>
  • Final Action

    Final Action

    Value

    No operation (deactivate next resource)

    0

    No operation (not deactivate next resource)

    1

    Stop the cluster service and shutdown OS (default)

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t resource/ocdns@ocdns1/deact/action --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/ocdns@ocdns1/deact/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

    Script Settings
    • File type

      Script file type

      Value

      Script created with this product (default)

      1

      User Application

      0

      clpcfadm.py mod -t resource/ocdns@ocdns1/deact/preaction/default --set <Value>

      Note

      If you change the value of this parameter, also change that of "File".

    • File (Within 1023 bytes)

      clpcfadm.py mod -t resource/ocdns@ocdns1/deact/preaction/path --set <File>

      Note

      If you specify "Script created with this product", specify predeactaction.bat.

      clpcfadm.py mod -t resource/ocdns@ocdns1/deact/preaction/path --set predeactaction.bat
    • Timeout (sec)

      Default, 5 (minimum, 1; maximum, 9999)

      clpcfadm.py mod -t resource/ocdns@ocdns1/deact/preaction/timeout --set <Value>
    • Exec User

      clpcfadm.py mod -t resource/ocdns@ocdns1/deact/preaction/account --set <Exec User>

7.15.2.4. Details

Common
  • Region (Within 48 bytes)

    clpcfadm.py mod -t resource/ocdns@ocdns1/parameters/region --set <Region>
  • Domain (FQDN) (Within 254 bytes)

    clpcfadm.py mod -t resource/ocdns@ocdns1/parameters/domain --set <Domain (FQDN)>
  • Zone OCID (Within 255 bytes)

    clpcfadm.py mod -t resource/ocdns@ocdns1/parameters/zoneid --set <Zone OCID>
  • IP Address

    clpcfadm.py mod -t resource/ocdns@ocdns1/parameters/ip --set <IP Address>
  • TTL (sec)

    Default, 300 (minimum, 1; maximum, 604800)

    clpcfadm.py mod -t resource/ocdns@ocdns1/parameters/ttl --set <Value>
  • Delete a resource record set at deactivation

    Delete a resource record set at deactivation

    Value

    Delete

    1

    Do not delete (default)

    0

    clpcfadm.py mod -t resource/ocdns@ocdns1/parameters/delete --set <Value>
  • Use Proxy

    Use Proxy

    Value

    Use

    1

    Do not use (default)

    0

    clpcfadm.py mod -t resource/ocdns@ocdns1/parameters/proxy/use --set <Value>
  • How far you manage a resource record in a multi-region environment

    How far you manage a resource record in a multi-region environment

    Value

    Only the region to which the active server belongs

    0

    All regions to which the cluster servers belong (default)

    1

    clpcfadm.py mod -t resource/ocdns@ocdns1/parameters/operationscope --set <Value>
Tuning
OCI CLI
  • Timeout (sec)

    Default, 100 (minimum, 1; maximum, 999)

    clpcfadm.py mod -t resource/ocdns@ocdns1/parameters/ociclitimeout --set <Value>
Set Up Individually

Set the following for each server.

  • Region (Within 48 bytes)

    clpcfadm.py mod -t resource/ocdns@ocdns1/server@<Server name>/parameters/region --set <Region> --nocheck
  • Zone OCID (Within 255 bytes)

    clpcfadm.py mod -t resource/ocdns@ocdns1/server@<Server name>/parameters/zoneid --set <Zone OCID> --nocheck
  • IP Address

    clpcfadm.py mod -t resource/ocdns@ocdns1/server@<Server name>/parameters/ip --set <IP Address> --nocheck

7.15.2.5. Extension

  • Resource Startup Attribute

    Resource Startup Attribute

    Value

    Automatic startup (default)

    1

    Manual startup

    0

    clpcfadm.py mod -t resource/ocdns@ocdns1/start --set <Value>
Execute Script before or after Activation or Deactivation

Note

If "Execute" is set for a script, specify the file. (See "Script Settings" -> "File".)

  • Execute Script before Activation

    Execute Script before Activation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/ocdns@ocdns1/preact/use --set <Value>
  • Execute Script after Activation

    Execute Script after Activation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/ocdns@ocdns1/predeact/use --set <Value>
  • Execute Script before Deactivation

    Execute Script before Deactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/ocdns@ocdns1/postact/use --set <Value>
  • Execute Script after Deactivation

    Execute Script after Deactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/ocdns@ocdns1/postdeact/use --set <Value>
Script Settings
  • File type

    Script file type

    Value

    Script created with this product (default)

    1

    User Application

    0

    clpcfadm.py mod -t resource/ocdns@ocdns1/preact/default --set <Value>
    clpcfadm.py mod -t resource/ocdns@ocdns1/predeact/default --set <Value>
    clpcfadm.py mod -t resource/ocdns@ocdns1/postact/default --set <Value>
    clpcfadm.py mod -t resource/ocdns@ocdns1/postdeact/default --set <Value>

    Note

    Set each of the <Value> fields to the same value.

    Note

    If you change the value of this parameter, also change that of "File".

  • File (Within 1023 bytes)

    clpcfadm.py mod -t resource/ocdns@ocdns1/preact/path --set <File>
    clpcfadm.py mod -t resource/ocdns@ocdns1/predeact/path --set <File>
    clpcfadm.py mod -t resource/ocdns@ocdns1/postact/path --set <File>
    clpcfadm.py mod -t resource/ocdns@ocdns1/postdeact/path --set <File>

    Note

    Set all <File> fields to the same value.

    Note

    If you specify "Script created with this product", specify rscextent.bat.

    clpcfadm.py mod -t resource/ocdns@ocdns1/preact/path --set rscextent.bat
    clpcfadm.py mod -t resource/ocdns@ocdns1/predeact/path --set rscextent.bat
    clpcfadm.py mod -t resource/ocdns@ocdns1/postact/path --set rscextent.bat
    clpcfadm.py mod -t resource/ocdns@ocdns1/postdeact/path --set rscextent.bat
  • Timeout (sec)

    Default, 30 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t resource/ocdns@ocdns1/preact/timeout --set <Value>
    clpcfadm.py mod -t resource/ocdns@ocdns1/predeact/timeout --set <Value>
    clpcfadm.py mod -t resource/ocdns@ocdns1/postact/timeout --set <Value>
    clpcfadm.py mod -t resource/ocdns@ocdns1/postdeact/timeout --set <Value>

    Note

    Set each of the <Value> fields to the same value.

  • Exec User

    clpcfadm.py mod -t resource/ocdns@ocdns1/preact/account --set <Value>
    clpcfadm.py mod -t resource/ocdns@ocdns1/predeact/account --set <Value>
    clpcfadm.py mod -t resource/ocdns@ocdns1/postact/account --set <Value>
    clpcfadm.py mod -t resource/ocdns@ocdns1/postdeact/account --set <Value>

    Note

    Set each of the <Value> fields to the same value.

7.15.3. Deleting an Oracle Cloud DNS resource

Delete a resource by specifying the group resource type and group resource name.

clpcfadm.py del rsc <Name of the group to which the resource belongs> ocdns ocdns1

Important

Resources associated with the group resource that you delete, such as monitor resources, are not deleted together.

7.16. Oracle Cloud Virtual IP resource

Note

The command lines in this section use ocvip1 as the group resource name.
Change it to suit your environment.

7.16.1. Adding an Oracle Cloud Virtual IP resource

Be sure to set the following items. For details, see "Setting Oracle Cloud Virtual IP resource parameters".

Item (mandatory)

Group resource name

Port Number

clpcfadm.py add rsc <Name of a group to which the resource belongs> ocvip ocvip1
clpcfadm.py mod -t resource/ocvip@ocvip1/parameters/probeport --set <Port Number>

Note

If you configure a cluster only with the above mandatory items, other parameters are set to their default values.

7.16.2. Setting Oracle Cloud Virtual IP resource parameters

7.16.2.1. Basic information

  • Group resource name (Within 31 bytes)

    This is set when the resource is added. To change the group resource name, delete the resource and set it again.

  • Comment (Within 127 bytes)

    clpcfadm.py mod -t resource/ocvip@ocvip1/comment --set <Comment>

    Note

    Enclose in double quotes a string including spaces (e.g., "Sample Comment").

7.16.2.2. Dependency

  • Follow the default dependency (default)

    clpcfadm.py del rscdep ocvip ocvip1
  • Set a parent resource

    clpcfadm.py add rscdep ocvip ocvip1 <Parent resource name>
  • No parent resource

    clpcfadm.py add rscdep ocvip ocvip1 ""
  • Delete a parent resource

    clpcfadm.py mod -t resource/ocvip@ocvip1/depend@<Parent resource name> --delete

7.16.2.3. Recovery Operation

Recovery Operation at Activity Failure Detection
  • Retry Count

    Default, 5 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t resource/ocvip@ocvip1/act/retry --set <Value>
  • Failover Target Server

    Failover Target Server

    Value

    Stable server (default)

    1

    Maximum priority server

    0

    clpcfadm.py mod -t resource/ocvip@ocvip1/act/mode --set <Value>
  • Failover Threshold

    Default, 1 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t resource/ocvip@ocvip1/act/fo2 --set <Value>
  • Final Action

    Final Action

    Value

    No operation (activate next resource)

    0

    No operation (not activate next resource) (default)

    1

    Stop group

    2

    Stop the cluster service

    3

    Stop the cluster service and shutdown OS

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t resource/ocvip@ocvip1/act/action --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/ocvip@ocvip1/act/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

    Script Settings
    • File type

      Script file type

      Value

      Script created with this product (default)

      1

      User Application

      0

      clpcfadm.py mod -t resource/ocvip@ocvip1/act/preaction/default --set <Value>

      Note

      If you change the value of this parameter, also change that of "File".

    • File (Within 1023 bytes)

      clpcfadm.py mod -t resource/ocvip@ocvip1/act/preaction/path --set <File>

      Note

      If you specify "Script created with this product", specify preactaction.bat.

      clpcfadm.py mod -t resource/ocvip@ocvip1/act/preaction/path --set preactaction.bat
    • Timeout (sec)

      Default, 5 (minimum, 1; maximum, 9999)

      clpcfadm.py mod -t resource/ocvip@ocvip1/act/preaction/timeout --set <Value>
    • Exec User

      clpcfadm.py mod -t resource/ocvip@ocvip1/act/preaction/account --set <Exec User>
Recovery Operation at Deactivity Failure Detection
  • Retry Count at Deactivation Failure

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t resource/ocvip@ocvip1/deact/retry --set <Value>
  • Final Action

    Final Action

    Value

    No operation (deactivate next resource)

    0

    No operation (not deactivate next resource)

    1

    Stop the cluster service and shutdown OS (default)

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t resource/ocvip@ocvip1/deact/action --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/ocvip@ocvip1/deact/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

    Script Settings
    • File type

      Script file type

      Value

      Script created with this product (default)

      1

      User Application

      0

      clpcfadm.py mod -t resource/ocvip@ocvip1/deact/preaction/default --set <Value>

      Note

      If you change the value of this parameter, also change that of "File".

    • File (Within 1023 bytes)

      clpcfadm.py mod -t resource/ocvip@ocvip1/deact/preaction/path --set <File>

      Note

      If you specify "Script created with this product", specify predeactaction.bat.

      clpcfadm.py mod -t resource/ocvip@ocvip1/deact/preaction/path --set predeactaction.bat
    • Timeout (sec)

      Default, 5 (minimum, 1; maximum, 9999)

      clpcfadm.py mod -t resource/ocvip@ocvip1/deact/preaction/timeout --set <Value>
    • Exec User

      clpcfadm.py mod -t resource/ocvip@ocvip1/deact/preaction/account --set <Exec User>

7.16.2.4. Details

  • Port Number

    Default, None (minimum, 1; maximum, 65535)

    clpcfadm.py mod -t resource/ocvip@ocvip1/parameters/probeport --set <Value>
Tuning
  • Health Check Timeout (sec)

    Default, 30 (minimum, 5; maximum, 999999999)

    clpcfadm.py mod -t resource/ocvip@ocvip1/parameters/probetimeout --set <Value>

7.16.2.5. Extension

  • Resource Startup Attribute

    Resource Startup Attribute

    Value

    Automatic startup (default)

    1

    Manual startup

    0

    clpcfadm.py mod -t resource/ocvip@ocvip1/start --set <Value>
Execute Script before or after Activation or Deactivation

Note

If "Execute" is set for a script, specify the file. (See "Script Settings" -> "File".)

  • Execute Script before Activation

    Execute Script before Activation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/ocvip@ocvip1/preact/use --set <Value>
  • Execute Script after Activation

    Execute Script after Activation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/ocvip@ocvip1/predeact/use --set <Value>
  • Execute Script before Deactivation

    Execute Script before Deactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/ocvip@ocvip1/postact/use --set <Value>
  • Execute Script after Deactivation

    Execute Script after Deactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/ocvip@ocvip1/postdeact/use --set <Value>
Script Settings
  • File type

    Script file type

    Value

    Script created with this product (default)

    1

    User Application

    0

    clpcfadm.py mod -t resource/ocvip@ocvip1/preact/default --set <Value>
    clpcfadm.py mod -t resource/ocvip@ocvip1/predeact/default --set <Value>
    clpcfadm.py mod -t resource/ocvip@ocvip1/postact/default --set <Value>
    clpcfadm.py mod -t resource/ocvip@ocvip1/postdeact/default --set <Value>

    Note

    Set each of the <Value> fields to the same value.

    Note

    If you change the value of this parameter, also change that of "File".

  • File (Within 1023 bytes)

    clpcfadm.py mod -t resource/ocvip@ocvip1/preact/path --set <File>
    clpcfadm.py mod -t resource/ocvip@ocvip1/predeact/path --set <File>
    clpcfadm.py mod -t resource/ocvip@ocvip1/postact/path --set <File>
    clpcfadm.py mod -t resource/ocvip@ocvip1/postdeact/path --set <File>

    Note

    Set all <File> fields to the same value.

    Note

    If you specify "Script created with this product", specify rscextent.bat.

    clpcfadm.py mod -t resource/ocvip@ocvip1/preact/path --set rscextent.bat
    clpcfadm.py mod -t resource/ocvip@ocvip1/predeact/path --set rscextent.bat
    clpcfadm.py mod -t resource/ocvip@ocvip1/postact/path --set rscextent.bat
    clpcfadm.py mod -t resource/ocvip@ocvip1/postdeact/path --set rscextent.bat
  • Timeout (sec)

    Default, 30 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t resource/ocvip@ocvip1/preact/timeout --set <Value>
    clpcfadm.py mod -t resource/ocvip@ocvip1/predeact/timeout --set <Value>
    clpcfadm.py mod -t resource/ocvip@ocvip1/postact/timeout --set <Value>
    clpcfadm.py mod -t resource/ocvip@ocvip1/postdeact/timeout --set <Value>

    Note

    Set each of the <Value> fields to the same value.

  • Exec User

    clpcfadm.py mod -t resource/ocvip@ocvip1/preact/account --set <Value>
    clpcfadm.py mod -t resource/ocvip@ocvip1/predeact/account --set <Value>
    clpcfadm.py mod -t resource/ocvip@ocvip1/postact/account --set <Value>
    clpcfadm.py mod -t resource/ocvip@ocvip1/postdeact/account --set <Value>

    Note

    Set each of the <Value> fields to the same value.

7.16.3. Deleting an Oracle Cloud Virtual IP resource

Delete a resource by specifying the group resource type and group resource name.

clpcfadm.py del rsc <Name of the group to which the resource belongs> ocvip ocvip1

Important

Resources associated with the group resource that you delete, such as monitor resources, are not deleted together.

7.17. Registry synchronization resource

Note

The command lines in this section use regsync1 as the group resource name.
Change it to suit your environment.

7.17.1. Adding a registry synchronization resource

Be sure to set the following items. For details, see "Setting registry synchronization resource parameters".

Item (mandatory)

Group resource name

Registry Key

clpcfadm.py add rsc <Name of a group to which the resource belongs> regsync regsync1
clpcfadm.py mod -t resource/regsync@regsync1/parameters/list@<ID>/regkey --set <Registry Key> --nocheck

Note

If you configure a cluster only with the above mandatory items, other parameters are set to their default values.

7.17.2. Setting registry synchronization resource parameters

7.17.2.1. Basic information

  • Group resource name (Within 31 bytes)

    This is set when the resource is added. To change the group resource name, delete the resource and set it again.

  • Comment (Within 127 bytes)

    clpcfadm.py mod -t resource/regsync@regsync1/comment --set <Comment>

    Note

    Enclose in double quotes a string including spaces (e.g., "Sample Comment").

7.17.2.2. Dependency

  • Follow the default dependency (default)

    clpcfadm.py del rscdep regsync regsync1
  • Set a parent resource

    clpcfadm.py add rscdep regsync regsync1 <Parent resource name>
  • No parent resource

    clpcfadm.py add rscdep regsync regsync1 ""
  • Delete a parent resource

    clpcfadm.py mod -t resource/regsync@regsync1/depend@<Parent resource name> --delete

7.17.2.3. Recovery Operation

Recovery Operation at Activity Failure Detection
  • Retry Count

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t resource/regsync@regsync1/act/retry --set <Value>
  • Failover Target Server

    Failover Target Server

    Value

    Stable server (default)

    1

    Maximum priority server

    0

    clpcfadm.py mod -t resource/regsync@regsync1/act/mode --set <Value>
  • Failover Threshold

    Default, 1 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t resource/regsync@regsync1/act/fo2 --set <Value>
  • Final Action

    Final Action

    Value

    No operation (activate next resource)

    0

    No operation (not activate next resource) (default)

    1

    Stop group

    2

    Stop the cluster service

    3

    Stop the cluster service and shutdown OS

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t resource/regsync@regsync1/act/action --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/regsync@regsync1/act/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

    Script Settings
    • File type

      Script file type

      Value

      Script created with this product (default)

      1

      User Application

      0

      clpcfadm.py mod -t resource/regsync@regsync1/act/preaction/default --set <Value>

      Note

      If you change the value of this parameter, also change that of "File".

    • File (Within 1023 bytes)

      clpcfadm.py mod -t resource/regsync@regsync1/act/preaction/path --set <File>

      Note

      If you specify "Script created with this product", specify preactaction.bat.

      clpcfadm.py mod -t resource/regsync@regsync1/act/preaction/path --set preactaction.bat
    • Timeout (sec)

      Default, 5 (minimum, 1; maximum, 9999)

      clpcfadm.py mod -t resource/regsync@regsync1/act/preaction/timeout --set <Value>
    • Exec User

      clpcfadm.py mod -t resource/regsync@regsync1/act/preaction/account --set <Exec User>
Recovery Operation at Deactivity Failure Detection
  • Retry Count at Deactivation Failure

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t resource/regsync@regsync1/deact/retry --set <Value>
  • Final Action

    Final Action

    Value

    No operation (deactivate next resource)

    0

    No operation (not deactivate next resource)

    1

    Stop the cluster service and shutdown OS (default)

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t resource/regsync@regsync1/deact/action --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/regsync@regsync1/deact/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

    Script Settings
    • File type

      Script file type

      Value

      Script created with this product (default)

      1

      User Application

      0

      clpcfadm.py mod -t resource/regsync@regsync1/deact/preaction/default --set <Value>

      Note

      If you change the value of this parameter, also change that of "File".

    • File (Within 1023 bytes)

      clpcfadm.py mod -t resource/regsync@regsync1/deact/preaction/path --set <File>

      Note

      If you specify "Script created with this product", specify predeactaction.bat.

      clpcfadm.py mod -t resource/regsync@regsync1/deact/preaction/path --set predeactaction.bat
    • Timeout (sec)

      Default, 5 (minimum, 1; maximum, 9999)

      clpcfadm.py mod -t resource/regsync@regsync1/deact/preaction/timeout --set <Value>
    • Exec User

      clpcfadm.py mod -t resource/regsync@regsync1/deact/preaction/account --set <Exec User>

7.17.2.4. Details

  • Registry Key (Within 1023 bytes)

    clpcfadm.py mod -t resource/regsync@regsync1/parameters/list@<ID>/regkey --set <Registry Key> --nocheck

    Note

    With only one registry key, specify 1 for ID.
    With more than one registry key, specify consecutive numbers (e.g., 1, 2, 3...).

    Note

    If you register more than one registry key, you cannot specify a parent or child key of a registered key.

Tuning
  • Delivery Interval (sec)

    Default, 1 (minimum, 1; maximum, 99)

    clpcfadm.py mod -t resource/regsync@regsync1/parameters/deliveryinterval --set <Value>

7.17.2.5. Extension

  • Resource Startup Attribute

    Resource Startup Attribute

    Value

    Automatic startup (default)

    1

    Manual startup

    0

    clpcfadm.py mod -t resource/regsync@regsync1/start --set <Value>
Execute Script before or after Activation or Deactivation

Note

If "Execute" is set for a script, specify the file. (See "Script Settings" -> "File".)

  • Execute Script before Activation

    Execute Script before Activation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/regsync@regsync1/preact/use --set <Value>
  • Execute Script after Activation

    Execute Script after Activation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/regsync@regsync1/predeact/use --set <Value>
  • Execute Script before Deactivation

    Execute Script before Deactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/regsync@regsync1/postact/use --set <Value>
  • Execute Script after Deactivation

    Execute Script after Deactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/regsync@regsync1/postdeact/use --set <Value>
Script Settings
  • File type

    Script file type

    Value

    Script created with this product (default)

    1

    User Application

    0

    clpcfadm.py mod -t resource/regsync@regsync1/preact/default --set <Value>
    clpcfadm.py mod -t resource/regsync@regsync1/predeact/default --set <Value>
    clpcfadm.py mod -t resource/regsync@regsync1/postact/default --set <Value>
    clpcfadm.py mod -t resource/regsync@regsync1/postdeact/default --set <Value>

    Note

    Set each of the <Value> fields to the same value.

    Note

    If you change the value of this parameter, also change that of "File".

  • File (Within 1023 bytes)

    clpcfadm.py mod -t resource/regsync@regsync1/preact/path --set <File>
    clpcfadm.py mod -t resource/regsync@regsync1/predeact/path --set <File>
    clpcfadm.py mod -t resource/regsync@regsync1/postact/path --set <File>
    clpcfadm.py mod -t resource/regsync@regsync1/postdeact/path --set <File>

    Note

    Set all <File> fields to the same value.

    Note

    If you specify "Script created with this product", specify rscextent.bat.

    clpcfadm.py mod -t resource/regsync@regsync1/preact/path --set rscextent.bat
    clpcfadm.py mod -t resource/regsync@regsync1/predeact/path --set rscextent.bat
    clpcfadm.py mod -t resource/regsync@regsync1/postact/path --set rscextent.bat
    clpcfadm.py mod -t resource/regsync@regsync1/postdeact/path --set rscextent.bat
  • Timeout (sec)

    Default, 30 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t resource/regsync@regsync1/preact/timeout --set <Value>
    clpcfadm.py mod -t resource/regsync@regsync1/predeact/timeout --set <Value>
    clpcfadm.py mod -t resource/regsync@regsync1/postact/timeout --set <Value>
    clpcfadm.py mod -t resource/regsync@regsync1/postdeact/timeout --set <Value>

    Note

    Set each of the <Value> fields to the same value.

  • Exec User

    clpcfadm.py mod -t resource/regsync@regsync1/preact/account --set <Value>
    clpcfadm.py mod -t resource/regsync@regsync1/predeact/account --set <Value>
    clpcfadm.py mod -t resource/regsync@regsync1/postact/account --set <Value>
    clpcfadm.py mod -t resource/regsync@regsync1/postdeact/account --set <Value>

    Note

    Set each of the <Value> fields to the same value.

7.17.3. Deleting a registry synchronization resource

Delete a resource by specifying the group resource type and group resource name.

clpcfadm.py del rsc <Name of the group to which the resource belongs> regsync regsync1

Important

Resources associated with the group resource that you delete, such as monitor resources, are not deleted together.

7.18. Script resource

Note

The command lines in this section use script1 as the group resource name.
Change it to suit your environment.

7.18.1. Adding a script resource

Be sure to set the following items. For details, see "Setting script resource parameters".

Item (mandatory)

Group resource name

clpcfadm.py add rsc <Name of a group to which the resource belongs> script script1

Note

If you configure a cluster only with the above mandatory items, other parameters are set to their default values.

7.18.2. Setting script resource parameters

7.18.2.1. Basic information

  • Group resource name (Within 31 bytes)

    This is set when the resource is added. To change the group resource name, delete the resource and set it again.

  • Comment (Within 127 bytes)

    clpcfadm.py mod -t resource/script@script1/comment --set <Comment>

    Note

    Enclose in double quotes a string including spaces (e.g., "Sample Comment").

7.18.2.2. Dependency

  • Follow the default dependency (default)

    clpcfadm.py del rscdep script script1
  • Set a parent resource

    clpcfadm.py add rscdep script script1 <Parent resource name>
  • No parent resource

    clpcfadm.py add rscdep script script1 ""
  • Delete a parent resource

    clpcfadm.py mod -t resource/script@script1/depend@<Parent resource name> --delete

7.18.2.3. Recovery Operation

Recovery Operation at Activity Failure Detection
  • Retry Count

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t resource/script@script1/act/retry --set <Value>
  • Failover Target Server

    Failover Target Server

    Value

    Stable server (default)

    1

    Maximum priority server

    0

    clpcfadm.py mod -t resource/script@script1/act/mode --set <Value>
  • Failover Threshold

    Default, 1 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t resource/script@script1/act/fo2 --set <Value>
  • Final Action

    Final Action

    Value

    No operation (activate next resource)

    0

    No operation (not activate next resource) (default)

    1

    Stop group

    2

    Stop the cluster service

    3

    Stop the cluster service and shutdown OS

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t resource/script@script1/act/action --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/script@script1/act/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

    Script Settings
    • File type

      Script file type

      Value

      Script created with this product (default)

      1

      User Application

      0

      clpcfadm.py mod -t resource/script@script1/act/preaction/default --set <Value>

      Note

      If you change the value of this parameter, also change that of "File".

    • File (Within 1023 bytes)

      clpcfadm.py mod -t resource/script@script1/act/preaction/path --set <File>

      Note

      If you specify "Script created with this product", specify preactaction.bat.

      clpcfadm.py mod -t resource/script@script1/act/preaction/path --set preactaction.bat
    • Timeout (sec)

      Default, 5 (minimum, 1; maximum, 9999)

      clpcfadm.py mod -t resource/script@script1/act/preaction/timeout --set <Value>
    • Exec User

      clpcfadm.py mod -t resource/script@script1/act/preaction/account --set <Exec User>
Recovery Operation at Deactivity Failure Detection
  • Retry Count at Deactivation Failure

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t resource/script@script1/deact/retry --set <Value>
  • Final Action

    Final Action

    Value

    No operation (deactivate next resource)

    0

    No operation (not deactivate next resource)

    1

    Stop the cluster service and shutdown OS (default)

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t resource/script@script1/deact/action --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/script@script1/deact/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

    Script Settings
    • File type

      Script file type

      Value

      Script created with this product (default)

      1

      User Application

      0

      clpcfadm.py mod -t resource/script@script1/deact/preaction/default --set <Value>

      Note

      If you change the value of this parameter, also change that of "File".

    • File (Within 1023 bytes)

      clpcfadm.py mod -t resource/script@script1/deact/preaction/path --set <File>

      Note

      If you specify "Script created with this product", specify predeactaction.bat.

      clpcfadm.py mod -t resource/script@script1/deact/preaction/path --set predeactaction.bat
    • Timeout (sec)

      Default, 5 (minimum, 1; maximum, 9999)

      clpcfadm.py mod -t resource/script@script1/deact/preaction/timeout --set <Value>
    • Exec User

      clpcfadm.py mod -t resource/script@script1/deact/preaction/account --set <Exec User>

7.18.2.4. Details

  • Script

    Note

    If you edit the default script file, edit <Installation path>\scripts\<Name of the group where the file belongs>\<Script resource name>\start.bat or stop.bat.
    If you add a script file, store it in <Installation path>\scripts\<Name of the group where the file belongs>\<Script resource name>.
Tuning
Start
  • Timeout (sec)

    Default, 1800 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t resource/script@script1/parameters/acttimeout --set <Value>
  • Normal Return Value

    clpcfadm.py mod -t resource/script@script1/parameters/actnormalval --set <Value>
  • Execute on standby server

    Execute on standby server

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/script@script1/parameters/actpostrunothers --set <Value>
    • Timeout (sec)

      Default, 10 (minimum, 1; maximum, 9999)

      clpcfadm.py mod -t resource/script@script1/parameters/acttimeoutothers --set <Value>

      Note

      Set as above with "Execute on standby server" set to "Execute".

  • Perform recovery processing

    Perform recovery processing

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/script@script1/parameters/recoveruse --set <Value>
Stop
  • Timeout (sec)

    Default, 1800 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t resource/script@script1/parameters/deacttimeout --set <Value>
  • Normal Return Value

    clpcfadm.py mod -t resource/script@script1/parameters/deactnormalval --set <Value>
  • Execute on standby server

    Execute on standby server

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/script@script1/parameters/deactprerunothers --set <Value>
    • Timeout (sec)

      Default, 10 (minimum, 1; maximum, 9999)

      clpcfadm.py mod -t resource/script@script1/parameters/deacttimeoutothers --set <Value>

      Note

      Set as above with "Execute on standby server" set to "Execute".

  • Target VCOM Resource Name

    clpcfadm.py mod -t resource/script@script1/parameters/target --set <Target VCOM Resource Name>
  • Allow to Interact with Desktop

    Allow to Interact with Desktop

    Value

    Allow

    1

    Do not allow (default)

    0

    clpcfadm.py mod -t resource/script@script1/parameters/actinteractive --set <Value>
    clpcfadm.py mod -t resource/script@script1/parameters/deactinteractive --set <Value>

    Note

    Set each of the <Value> fields to the same value.

  • Exec User

    clpcfadm.py mod -t resource/script@script1/parameters/account --set <Exec User>

7.18.2.5. Extension

  • Resource Startup Attribute

    Resource Startup Attribute

    Value

    Automatic startup (default)

    1

    Manual startup

    0

    clpcfadm.py mod -t resource/script@script1/start --set <Value>
Execute Script before or after Activation or Deactivation

Note

If "Execute" is set for a script, specify the file. (See "Script Settings" -> "File".)

  • Execute Script before Activation

    Execute Script before Activation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/script@script1/preact/use --set <Value>
  • Execute Script after Activation

    Execute Script after Activation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/script@script1/predeact/use --set <Value>
  • Execute Script before Deactivation

    Execute Script before Deactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/script@script1/postact/use --set <Value>
  • Execute Script after Deactivation

    Execute Script after Deactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/script@script1/postdeact/use --set <Value>
Script Settings
  • File type

    Script file type

    Value

    Script created with this product (default)

    1

    User Application

    0

    clpcfadm.py mod -t resource/script@script1/preact/default --set <Value>
    clpcfadm.py mod -t resource/script@script1/predeact/default --set <Value>
    clpcfadm.py mod -t resource/script@script1/postact/default --set <Value>
    clpcfadm.py mod -t resource/script@script1/postdeact/default --set <Value>

    Note

    Set each of the <Value> fields to the same value.

    Note

    If you change the value of this parameter, also change that of "File".

  • File (Within 1023 bytes)

    clpcfadm.py mod -t resource/script@script1/preact/path --set <File>
    clpcfadm.py mod -t resource/script@script1/predeact/path --set <File>
    clpcfadm.py mod -t resource/script@script1/postact/path --set <File>
    clpcfadm.py mod -t resource/script@script1/postdeact/path --set <File>

    Note

    Set all <File> fields to the same value.

    Note

    If you specify "Script created with this product", specify rscextent.bat.

    clpcfadm.py mod -t resource/script@script1/preact/path --set rscextent.bat
    clpcfadm.py mod -t resource/script@script1/predeact/path --set rscextent.bat
    clpcfadm.py mod -t resource/script@script1/postact/path --set rscextent.bat
    clpcfadm.py mod -t resource/script@script1/postdeact/path --set rscextent.bat
  • Timeout (sec)

    Default, 30 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t resource/script@script1/preact/timeout --set <Value>
    clpcfadm.py mod -t resource/script@script1/predeact/timeout --set <Value>
    clpcfadm.py mod -t resource/script@script1/postact/timeout --set <Value>
    clpcfadm.py mod -t resource/script@script1/postdeact/timeout --set <Value>

    Note

    Set each of the <Value> fields to the same value.

  • Exec User

    clpcfadm.py mod -t resource/script@script1/preact/account --set <Value>
    clpcfadm.py mod -t resource/script@script1/predeact/account --set <Value>
    clpcfadm.py mod -t resource/script@script1/postact/account --set <Value>
    clpcfadm.py mod -t resource/script@script1/postdeact/account --set <Value>

    Note

    Set each of the <Value> fields to the same value.

7.18.3. Deleting a script resource

Delete a resource by specifying the group resource type and group resource name.

clpcfadm.py del rsc <Name of the group to which the resource belongs> script script1

Important

Resources associated with the group resource that you delete, such as monitor resources, are not deleted together.

7.19. Disk resource

Note

The command lines in this section use sd1 as the group resource name.
Change it to suit your environment.

7.19.1. Adding a disk resource

Be sure to set the following items. For details, see "Setting disk resource parameters".

Item (mandatory)

Group resource name

Drive Letter

GUID

clpcfadm.py add rsc <Name of a group to which the resource belongs> sd sd1
clpcfadm.py mod -t resource/sd@sd1/parameters/volumemountpoint --set <Drive Letter>
clpcfadm.py mod -t resource/sd@sd1/server@<Server name>/parameters/volumeguid --set <GUID> --nocheck

Note

If you configure a cluster only with the above mandatory items, other parameters are set to their default values.

7.19.2. Setting disk resource parameters

7.19.2.1. Basic information

  • Group resource name (Within 31 bytes)

    This is set when the resource is added. To change the group resource name, delete the resource and set it again.

  • Comment (Within 127 bytes)

    clpcfadm.py mod -t resource/sd@sd1/comment --set <Comment>

    Note

    Enclose in double quotes a string including spaces (e.g., "Sample Comment").

7.19.2.2. Dependency

  • Follow the default dependency (default)

    clpcfadm.py del rscdep sd sd1
  • Set a parent resource

    clpcfadm.py add rscdep sd sd1 <Parent resource name>
  • No parent resource

    clpcfadm.py add rscdep sd sd1 ""
  • Delete a parent resource

    clpcfadm.py mod -t resource/sd@sd1/depend@<Parent resource name> --delete

7.19.2.3. Recovery Operation

Recovery Operation at Activity Failure Detection
  • Retry Count

    Default, 3 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t resource/sd@sd1/act/retry --set <Value>
  • Failover Target Server

    Failover Target Server

    Value

    Stable server (default)

    1

    Maximum priority server

    0

    clpcfadm.py mod -t resource/sd@sd1/act/mode --set <Value>
  • Failover Threshold

    Default, 1 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t resource/sd@sd1/act/fo2 --set <Value>
  • Final Action

    Final Action

    Value

    No operation (activate next resource)

    0

    No operation (not activate next resource) (default)

    1

    Stop group

    2

    Stop the cluster service

    3

    Stop the cluster service and shutdown OS

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t resource/sd@sd1/act/action --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/sd@sd1/act/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

    Script Settings
    • File type

      Script file type

      Value

      Script created with this product (default)

      1

      User Application

      0

      clpcfadm.py mod -t resource/sd@sd1/act/preaction/default --set <Value>

      Note

      If you change the value of this parameter, also change that of "File".

    • File (Within 1023 bytes)

      clpcfadm.py mod -t resource/sd@sd1/act/preaction/path --set <File>

      Note

      If you specify "Script created with this product", specify preactaction.bat.

      clpcfadm.py mod -t resource/sd@sd1/act/preaction/path --set preactaction.bat
    • Timeout (sec)

      Default, 5 (minimum, 1; maximum, 9999)

      clpcfadm.py mod -t resource/sd@sd1/act/preaction/timeout --set <Value>
    • Exec User

      clpcfadm.py mod -t resource/sd@sd1/act/preaction/account --set <Exec User>
Recovery Operation at Deactivity Failure Detection
  • Retry Count at Deactivation Failure

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t resource/sd@sd1/deact/retry --set <Value>
  • Final Action

    Final Action

    Value

    No operation (deactivate next resource)

    0

    No operation (not deactivate next resource)

    1

    Stop the cluster service and shutdown OS (default)

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t resource/sd@sd1/deact/action --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/sd@sd1/deact/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

    Script Settings
    • File type

      Script file type

      Value

      Script created with this product (default)

      1

      User Application

      0

      clpcfadm.py mod -t resource/sd@sd1/deact/preaction/default --set <Value>

      Note

      If you change the value of this parameter, also change that of "File".

    • File (Within 1023 bytes)

      clpcfadm.py mod -t resource/sd@sd1/deact/preaction/path --set <File>

      Note

      If you specify "Script created with this product", specify predeactaction.bat.

      clpcfadm.py mod -t resource/sd@sd1/deact/preaction/path --set predeactaction.bat
    • Timeout (sec)

      Default, 5 (minimum, 1; maximum, 9999)

      clpcfadm.py mod -t resource/sd@sd1/deact/preaction/timeout --set <Value>
    • Exec User

      clpcfadm.py mod -t resource/sd@sd1/deact/preaction/account --set <Exec User>

7.19.2.4. Details

  • Drive Letter

    clpcfadm.py mod -t resource/sd@sd1/parameters/volumemountpoint --set <Drive Letter>
  • GUID

    clpcfadm.py mod -t resource/sd@sd1/server@/<Server name>/parameters/volumeguid --set <GUID> --nocheck

    Note

    The GUID can be retrieved by using the clpdiskctrl command.
    For details, see "clpdiskctrl command".

7.19.2.5. Extension

  • Resource Startup Attribute

    Resource Startup Attribute

    Value

    Automatic startup (default)

    1

    Manual startup

    0

    clpcfadm.py mod -t resource/sd@sd1/start --set <Value>
Execute Script before or after Activation or Deactivation

Note

If "Execute" is set for a script, specify the file. (See "Script Settings" -> "File".)

  • Execute Script before Activation

    Execute Script before Activation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/sd@sd1/preact/use --set <Value>
  • Execute Script after Activation

    Execute Script after Activation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/sd@sd1/predeact/use --set <Value>
  • Execute Script before Deactivation

    Execute Script before Deactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/sd@sd1/postact/use --set <Value>
  • Execute Script after Deactivation

    Execute Script after Deactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/sd@sd1/postdeact/use --set <Value>
Script Settings
  • File type

    Script file type

    Value

    Script created with this product (default)

    1

    User Application

    0

    clpcfadm.py mod -t resource/sd@sd1/preact/default --set <Value>
    clpcfadm.py mod -t resource/sd@sd1/predeact/default --set <Value>
    clpcfadm.py mod -t resource/sd@sd1/postact/default --set <Value>
    clpcfadm.py mod -t resource/sd@sd1/postdeact/default --set <Value>

    Note

    Set each of the <Value> fields to the same value.

    Note

    If you change the value of this parameter, also change that of "File".

  • File (Within 1023 bytes)

    clpcfadm.py mod -t resource/sd@sd1/preact/path --set <File>
    clpcfadm.py mod -t resource/sd@sd1/predeact/path --set <File>
    clpcfadm.py mod -t resource/sd@sd1/postact/path --set <File>
    clpcfadm.py mod -t resource/sd@sd1/postdeact/path --set <File>

    Note

    Set all <File> fields to the same value.

    Note

    If you specify "Script created with this product", specify rscextent.bat.

    clpcfadm.py mod -t resource/sd@sd1/preact/path --set rscextent.bat
    clpcfadm.py mod -t resource/sd@sd1/predeact/path --set rscextent.bat
    clpcfadm.py mod -t resource/sd@sd1/postact/path --set rscextent.bat
    clpcfadm.py mod -t resource/sd@sd1/postdeact/path --set rscextent.bat
  • Timeout (sec)

    Default, 30 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t resource/sd@sd1/preact/timeout --set <Value>
    clpcfadm.py mod -t resource/sd@sd1/predeact/timeout --set <Value>
    clpcfadm.py mod -t resource/sd@sd1/postact/timeout --set <Value>
    clpcfadm.py mod -t resource/sd@sd1/postdeact/timeout --set <Value>

    Note

    Set each of the <Value> fields to the same value.

  • Exec User

    clpcfadm.py mod -t resource/sd@sd1/preact/account --set <Value>
    clpcfadm.py mod -t resource/sd@sd1/predeact/account --set <Value>
    clpcfadm.py mod -t resource/sd@sd1/postact/account --set <Value>
    clpcfadm.py mod -t resource/sd@sd1/postdeact/account --set <Value>

    Note

    Set each of the <Value> fields to the same value.

7.19.3. Deleting a disk resource

Delete a resource by specifying the group resource type and group resource name.

clpcfadm.py del rsc <Name of the group to which the resource belongs> sd sd1

Important

Resources associated with the group resource that you delete, such as monitor resources, are not deleted together.

7.20. Service resource

Note

The command lines in this section use service1 as the group resource name.
Change it to suit your environment.

7.20.1. Adding a service resource

Be sure to set the following items. For details, see "Setting service resource parameters".

Item (mandatory)

Group resource name

Service Name

clpcfadm.py add rsc <Name of a group to which the resource belongs> service service1
clpcfadm.py mod -t resource/service@service1/parameters/name --set <Service Name>

Note

If you configure a cluster only with the above mandatory items, other parameters are set to their default values.

7.20.2. Setting service resource parameters

7.20.2.1. Basic information

  • Group resource name (Within 31 bytes)

    This is set when the resource is added. To change the group resource name, delete the resource and set it again.

  • Comment (Within 127 bytes)

    clpcfadm.py mod -t resource/service@service1/comment --set <Comment>

    Note

    Enclose in double quotes a string including spaces (e.g., "Sample Comment").

7.20.2.2. Dependency

  • Follow the default dependency (default)

    clpcfadm.py del rscdep service service1
  • Set a parent resource

    clpcfadm.py add rscdep service service1 <Parent resource name>
  • No parent resource

    clpcfadm.py add rscdep service service1 ""
  • Delete a parent resource

    clpcfadm.py mod -t resource/service@service1/depend@<Parent resource name> --delete

7.20.2.3. Recovery Operation

Recovery Operation at Activity Failure Detection
  • Retry Count

    Default, 1 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t resource/service@service1/act/retry --set <Value>
  • Failover Target Server

    Failover Target Server

    Value

    Stable server (default)

    1

    Maximum priority server

    0

    clpcfadm.py mod -t resource/service@service1/act/mode --set <Value>
  • Failover Threshold

    Default, 1 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t resource/service@service1/act/fo2 --set <Value>
  • Final Action

    Final Action

    Value

    No operation (activate next resource)

    0

    No operation (not activate next resource) (default)

    1

    Stop group

    2

    Stop the cluster service

    3

    Stop the cluster service and shutdown OS

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t resource/service@service1/act/action --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/service@service1/act/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

    Script Settings
    • File type

      Script file type

      Value

      Script created with this product (default)

      1

      User Application

      0

      clpcfadm.py mod -t resource/service@service1/act/preaction/default --set <Value>

      Note

      If you change the value of this parameter, also change that of "File".

    • File (Within 1023 bytes)

      clpcfadm.py mod -t resource/service@service1/act/preaction/path --set <File>

      Note

      If you specify "Script created with this product", specify preactaction.bat.

      clpcfadm.py mod -t resource/service@service1/act/preaction/path --set preactaction.bat
    • Timeout (sec)

      Default, 5 (minimum, 1; maximum, 9999)

      clpcfadm.py mod -t resource/service@service1/act/preaction/timeout --set <Value>
    • Exec User

      clpcfadm.py mod -t resource/service@service1/act/preaction/account --set <Exec User>
Recovery Operation at Deactivity Failure Detection
  • Retry Count at Deactivation Failure

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t resource/service@service1/deact/retry --set <Value>
  • Final Action

    Final Action

    Value

    No operation (deactivate next resource)

    0

    No operation (not deactivate next resource)

    1

    Stop the cluster service and shutdown OS (default)

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t resource/service@service1/deact/action --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/service@service1/deact/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

    Script Settings
    • File type

      Script file type

      Value

      Script created with this product (default)

      1

      User Application

      0

      clpcfadm.py mod -t resource/service@service1/deact/preaction/default --set <Value>

      Note

      If you change the value of this parameter, also change that of "File".

    • File (Within 1023 bytes)

      clpcfadm.py mod -t resource/service@service1/deact/preaction/path --set <File>

      Note

      If you specify "Script created with this product", specify predeactaction.bat.

      clpcfadm.py mod -t resource/service@service1/deact/preaction/path --set predeactaction.bat
    • Timeout (sec)

      Default, 5 (minimum, 1; maximum, 9999)

      clpcfadm.py mod -t resource/service@service1/deact/preaction/timeout --set <Value>
    • Exec User

      clpcfadm.py mod -t resource/service@service1/deact/preaction/account --set <Exec User>

7.20.2.4. Details

  • Service Name (Within 1023 bytes)

    clpcfadm.py mod -t resource/service@service1/parameters/name --set <Service Name>
Tuning
Start
  • Synchronization type

    Synchronization type

    Value

    Synchronous (default)

    1

    Asynchronous

    0

    clpcfadm.py mod -t resource/service@service1/parameters/actsync --set <Value>
  • Timeout (sec)

    Default, 1800 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t resource/service@service1/parameters/acttimeout --set <Value>

    Note

    Set as above with "Synchronization type" set to "Synchronous".

Stop
  • Synchronization type

    Synchronization type

    Value

    Synchronous (default)

    1

    Asynchronous

    0

    clpcfadm.py mod -t resource/service@service1/parameters/deactsync --set <Value>
  • Timeout (sec)

    Default, 1800 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t resource/service@service1/parameters/deacttimeout --set <Value>

    Note

    Set as above with "Synchronization type" set to "Synchronous".

  • Target VCOM Resource Name

    clpcfadm.py mod -t resource/service@service1/parameters/target --set <Target VCOM Resource Name>
Service
  • Start Parameters (Within 1023 bytes)

    clpcfadm.py mod -t resource/service@service1/parameters/option --set <Start Parameters>
  • Do not generate an error when the service is already started

    Do not generate an error when the service is already started

    Value

    Generate an error (default)

    0

    Do not generate an error

    1

    clpcfadm.py mod -t resource/service@service1/parameters/started --set <Value>
  • Wait time after service started (sec)

    Default, 0 (minimum, 0; maximum, 9999)

    clpcfadm.py mod -t resource/service@service1/parameters/actwaittime --set <Value>
  • Wait time after service stopped (sec)

    Default, 0 (minimum, 0; maximum, 9999)

    clpcfadm.py mod -t resource/service@service1/parameters/deactwaittime --set <Value>

7.20.2.5. Extension

  • Resource Startup Attribute

    Resource Startup Attribute

    Value

    Automatic startup (default)

    1

    Manual startup

    0

    clpcfadm.py mod -t resource/service@service1/start --set <Value>
Execute Script before or after Activation or Deactivation

Note

If "Execute" is set for a script, specify the file. (See "Script Settings" -> "File".)

  • Execute Script before Activation

    Execute Script before Activation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/service@service1/preact/use --set <Value>
  • Execute Script after Activation

    Execute Script after Activation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/service@service1/predeact/use --set <Value>
  • Execute Script before Deactivation

    Execute Script before Deactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/service@service1/postact/use --set <Value>
  • Execute Script after Deactivation

    Execute Script after Deactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/service@service1/postdeact/use --set <Value>
Script Settings
  • File type

    Script file type

    Value

    Script created with this product (default)

    1

    User Application

    0

    clpcfadm.py mod -t resource/service@service1/preact/default --set <Value>
    clpcfadm.py mod -t resource/service@service1/predeact/default --set <Value>
    clpcfadm.py mod -t resource/service@service1/postact/default --set <Value>
    clpcfadm.py mod -t resource/service@service1/postdeact/default --set <Value>

    Note

    Set each of the <Value> fields to the same value.

    Note

    If you change the value of this parameter, also change that of "File".

  • File (Within 1023 bytes)

    clpcfadm.py mod -t resource/service@service1/preact/path --set <File>
    clpcfadm.py mod -t resource/service@service1/predeact/path --set <File>
    clpcfadm.py mod -t resource/service@service1/postact/path --set <File>
    clpcfadm.py mod -t resource/service@service1/postdeact/path --set <File>

    Note

    Set all <File> fields to the same value.

    Note

    If you specify "Script created with this product", specify rscextent.bat.

    clpcfadm.py mod -t resource/service@service1/preact/path --set rscextent.bat
    clpcfadm.py mod -t resource/service@service1/predeact/path --set rscextent.bat
    clpcfadm.py mod -t resource/service@service1/postact/path --set rscextent.bat
    clpcfadm.py mod -t resource/service@service1/postdeact/path --set rscextent.bat
  • Timeout (sec)

    Default, 30 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t resource/service@service1/preact/timeout --set <Value>
    clpcfadm.py mod -t resource/service@service1/predeact/timeout --set <Value>
    clpcfadm.py mod -t resource/service@service1/postact/timeout --set <Value>
    clpcfadm.py mod -t resource/service@service1/postdeact/timeout --set <Value>

    Note

    Set each of the <Value> fields to the same value.

  • Exec User

    clpcfadm.py mod -t resource/service@service1/preact/account --set <Value>
    clpcfadm.py mod -t resource/service@service1/predeact/account --set <Value>
    clpcfadm.py mod -t resource/service@service1/postact/account --set <Value>
    clpcfadm.py mod -t resource/service@service1/postdeact/account --set <Value>

    Note

    Set each of the <Value> fields to the same value.

7.20.3. Deleting a service resource

Delete a resource by specifying the group resource type and group resource name.

clpcfadm.py del rsc <Name of the group to which the resource belongs> service service1

Important

Resources associated with the group resource that you delete, such as monitor resources, are not deleted together.

7.21. Virtual computer name resource

Note

The command lines in this section use vcom1 as the group resource name.
Change it to suit your environment.

7.21.1. Adding a virtual computer name resource

Be sure to set the following items. For details, see "Setting virtual computer name resource parameters".

Item (mandatory)

Group resource name

Virtual Computer Name

clpcfadm.py add rsc <Name of a group to which the resource belongs> vcom vcom1
clpcfadm.py mod -t resource/vcom@vcom1/parameters/vcomname --set <Virtual Computer Name>

Note

If you configure a cluster only with the above mandatory items, other parameters are set to their default values.

7.21.2. Setting virtual computer name resource parameters

7.21.2.1. Basic information

  • Group resource name (Within 31 bytes)

    This is set when the resource is added. To change the group resource name, delete the resource and set it again.

  • Comment (Within 127 bytes)

    clpcfadm.py mod -t resource/vcom@vcom1/comment --set <Comment>

    Note

    Enclose in double quotes a string including spaces (e.g., "Sample Comment").

7.21.2.2. Dependency

  • Follow the default dependency (default)

    clpcfadm.py del rscdep vcom vcom1
  • Set a parent resource

    clpcfadm.py add rscdep vcom vcom1 <Parent resource name>
  • No parent resource

    clpcfadm.py add rscdep vcom vcom1 ""
  • Delete a parent resource

    clpcfadm.py mod -t resource/vcom@vcom1/depend@<Parent resource name> --delete

7.21.2.3. Recovery Operation

Recovery Operation at Activity Failure Detection
  • Retry Count

    Default, 5 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t resource/vcom@vcom1/act/retry --set <Value>
  • Failover Target Server

    Failover Target Server

    Value

    Stable server (default)

    1

    Maximum priority server

    0

    clpcfadm.py mod -t resource/vcom@vcom1/act/mode --set <Value>
  • Failover Threshold

    Default, 1 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t resource/vcom@vcom1/act/fo2 --set <Value>
  • Final Action

    Final Action

    Value

    No operation (activate next resource)

    0

    No operation (not activate next resource) (default)

    1

    Stop group

    2

    Stop the cluster service

    3

    Stop the cluster service and shutdown OS

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t resource/vcom@vcom1/act/action --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/vcom@vcom1/act/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

    Script Settings
    • File type

      Script file type

      Value

      Script created with this product (default)

      1

      User Application

      0

      clpcfadm.py mod -t resource/vcom@vcom1/act/preaction/default --set <Value>

      Note

      If you change the value of this parameter, also change that of "File".

    • File (Within 1023 bytes)

      clpcfadm.py mod -t resource/vcom@vcom1/act/preaction/path --set <File>

      Note

      If you specify "Script created with this product", specify preactaction.bat.

      clpcfadm.py mod -t resource/vcom@vcom1/act/preaction/path --set preactaction.bat
    • Timeout (sec)

      Default, 5 (minimum, 1; maximum, 9999)

      clpcfadm.py mod -t resource/vcom@vcom1/act/preaction/timeout --set <Value>
    • Exec User

      clpcfadm.py mod -t resource/vcom@vcom1/act/preaction/account --set <Exec User>
Recovery Operation at Deactivity Failure Detection
  • Retry Count at Deactivation Failure

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t resource/vcom@vcom1/deact/retry --set <Value>
  • Final Action

    Final Action

    Value

    No operation (deactivate next resource)

    0

    No operation (not deactivate next resource)

    1

    Stop the cluster service and shutdown OS (default)

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t resource/vcom@vcom1/deact/action --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/vcom@vcom1/deact/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

    Script Settings
    • File type

      Script file type

      Value

      Script created with this product (default)

      1

      User Application

      0

      clpcfadm.py mod -t resource/vcom@vcom1/deact/preaction/default --set <Value>

      Note

      If you change the value of this parameter, also change that of "File".

    • File (Within 1023 bytes)

      clpcfadm.py mod -t resource/vcom@vcom1/deact/preaction/path --set <File>

      Note

      If you specify "Script created with this product", specify predeactaction.bat.

      clpcfadm.py mod -t resource/vcom@vcom1/deact/preaction/path --set predeactaction.bat
    • Timeout (sec)

      Default, 5 (minimum, 1; maximum, 9999)

      clpcfadm.py mod -t resource/vcom@vcom1/deact/preaction/timeout --set <Value>
    • Exec User

      clpcfadm.py mod -t resource/vcom@vcom1/deact/preaction/account --set <Exec User>

7.21.2.4. Details

Important

If "Target FIP Resource Name" is not set, the resource is activated in non-bind mode.
In non-bind mode, the resource becomes inaccessible temporarily after failover.
  • Virtual Computer Name (Within 15 bytes)

    clpcfadm.py mod -t resource/vcom@vcom1/parameters/vcomname --set <Virtual Computer Name>
  • Target FIP Resource Name

    clpcfadm.py mod -t resource/vcom@vcom1/parameters/target --set <Target FIP Resource Name>
Tuning
  • Register with DNS dynamically

    Register with DNS dynamically

    Value

    Dynamically register

    1

    Do not dynamically register (default)

    0

    clpcfadm.py mod -t resource/vcom@vcom1/parameters/dnsregister --set <Value>

Note

To set the following items, set "Register with DNS dynamically" to "Dynamically register" in advance.

  • IP address to be associated

    IP address to be associated

    Value

    FIP (default)

    0

    Any Address

    2

    clpcfadm.py mod -t resource/vcom@vcom1/parameters/dnstype --set <Value>

    Important

    If "Target FIP Resource Name" has not been set, specify "Any Address".

  • IP Address

    clpcfadm.py mod -t resource/vcom@vcom1/server@<Server name>/parameters/dnsip --set <IP Address> --nocheck

Note

Set as above with "IP address to be associated" set to "Any Address".

Note

If you delete a server, set as follows:

clpcfadm.py mod -t resource/vcom@vcom1/server@<Server name> --delete

7.21.2.5. Extension

  • Resource Startup Attribute

    Resource Startup Attribute

    Value

    Automatic startup (default)

    1

    Manual startup

    0

    clpcfadm.py mod -t resource/vcom@vcom1/start --set <Value>
Execute Script before or after Activation or Deactivation

Note

If "Execute" is set for a script, specify the file. (See "Script Settings" -> "File".)

  • Execute Script before Activation

    Execute Script before Activation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/vcom@vcom1/preact/use --set <Value>
  • Execute Script after Activation

    Execute Script after Activation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/vcom@vcom1/predeact/use --set <Value>
  • Execute Script before Deactivation

    Execute Script before Deactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/vcom@vcom1/postact/use --set <Value>
  • Execute Script after Deactivation

    Execute Script after Deactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/vcom@vcom1/postdeact/use --set <Value>
Script Settings
  • File type

    Script file type

    Value

    Script created with this product (default)

    1

    User Application

    0

    clpcfadm.py mod -t resource/vcom@vcom1/preact/default --set <Value>
    clpcfadm.py mod -t resource/vcom@vcom1/predeact/default --set <Value>
    clpcfadm.py mod -t resource/vcom@vcom1/postact/default --set <Value>
    clpcfadm.py mod -t resource/vcom@vcom1/postdeact/default --set <Value>

    Note

    Set each of the <Value> fields to the same value.

    Note

    If you change the value of this parameter, also change that of "File".

  • File (Within 1023 bytes)

    clpcfadm.py mod -t resource/vcom@vcom1/preact/path --set <File>
    clpcfadm.py mod -t resource/vcom@vcom1/predeact/path --set <File>
    clpcfadm.py mod -t resource/vcom@vcom1/postact/path --set <File>
    clpcfadm.py mod -t resource/vcom@vcom1/postdeact/path --set <File>

    Note

    Set all <File> fields to the same value.

    Note

    If you specify "Script created with this product", specify rscextent.bat.

    clpcfadm.py mod -t resource/vcom@vcom1/preact/path --set rscextent.bat
    clpcfadm.py mod -t resource/vcom@vcom1/predeact/path --set rscextent.bat
    clpcfadm.py mod -t resource/vcom@vcom1/postact/path --set rscextent.bat
    clpcfadm.py mod -t resource/vcom@vcom1/postdeact/path --set rscextent.bat
  • Timeout (sec)

    Default, 30 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t resource/vcom@vcom1/preact/timeout --set <Value>
    clpcfadm.py mod -t resource/vcom@vcom1/predeact/timeout --set <Value>
    clpcfadm.py mod -t resource/vcom@vcom1/postact/timeout --set <Value>
    clpcfadm.py mod -t resource/vcom@vcom1/postdeact/timeout --set <Value>

    Note

    Set each of the <Value> fields to the same value.

  • Exec User

    clpcfadm.py mod -t resource/vcom@vcom1/preact/account --set <Value>
    clpcfadm.py mod -t resource/vcom@vcom1/predeact/account --set <Value>
    clpcfadm.py mod -t resource/vcom@vcom1/postact/account --set <Value>
    clpcfadm.py mod -t resource/vcom@vcom1/postdeact/account --set <Value>

    Note

    Set each of the <Value> fields to the same value.

7.21.3. Deleting a virtual computer name resource

Delete a resource by specifying the group resource type and group resource name.

clpcfadm.py del rsc <Name of the group to which the resource belongs> vcom vcom1

Important

Resources associated with the group resource that you delete, such as monitor resources, are not deleted together.

7.22. Virtual IP resource

Note

The command lines in this section use vip1 as the group resource name.
Change it to suit your environment.

7.22.1. Adding a Virtual IP resource

Be sure to set the following items. For details, see "Setting Virtual IP resource parameters".

Item (mandatory)

Group resource name

IP Address

Net Mask

Destination IP Address

Source IP Address

Routing Protocol

clpcfadm.py add rsc <Name of a group to which the resource belongs> vip vip1
clpcfadm.py mod -t resource/vip@vip1/parameters/ip --set <IP Address (Common)>
clpcfadm.py mod -t resource/vip@vip1/server@<Server name>/parameters/ip --set <IP Address (Individual)> --nocheck
clpcfadm.py mod -t resource/vip@vip1/parameters/mask --set <Net Mask (Common)>
clpcfadm.py mod -t resource/vip@vip1/server@<Server name>/parameters/mask --set <Net Mask (Individual)> --nocheck
clpcfadm.py mod -t resource/vip@vip1/parameters/multicast/dstaddr --set <Destination IP Address (Common)>
clpcfadm.py mod -t resource/vip@vip1/server@<Server name>/parameters/multicast/dstaddr --set <Destination IP Address (Individual)> --nocheck
clpcfadm.py mod -t resource/vip@vip1/parameters/multicast/srcaddr --set <Source IP Address (Common)>
clpcfadm.py mod -t resource/vip@vip1/server@<Server name>/parameters/multicast/srcaddr --set <Source IP Address (Individual)> --nocheck
clpcfadm.py mod -t resource/vip@vip1/parameters/protocol --set <Routing Protocol (Common)>
clpcfadm.py mod -t resource/vip@vip1/server@<Server name>/parameters/protocol --set <Routing Protocol (Individual)> --nocheck

Note

If you configure a cluster only with the above mandatory items, other parameters are set to their default values.

7.22.2. Setting Virtual IP resource parameters

7.22.2.1. Basic information

  • Group resource name (Within 31 bytes)

    This is set when the resource is added. To change the group resource name, delete the resource and set it again.

  • Comment (Within 127 bytes)

    clpcfadm.py mod -t resource/vip@vip1/comment --set <Comment>

    Note

    Enclose in double quotes a string including spaces (e.g., "Sample Comment").

7.22.2.2. Dependency

  • Follow the default dependency (default)

    clpcfadm.py del rscdep vip vip1
  • Set a parent resource

    clpcfadm.py add rscdep vip vip1 <Parent resource name>
  • No parent resource

    clpcfadm.py add rscdep vip vip1 ""
  • Delete a parent resource

    clpcfadm.py mod -t resource/vip@vip1/depend@<Parent resource name> --delete

7.22.2.3. Recovery Operation

Recovery Operation at Activity Failure Detection
  • Retry Count

    Default, 5 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t resource/vip@vip1/act/retry --set <Value>
  • Failover Target Server

    Failover Target Server

    Value

    Stable server (default)

    1

    Maximum priority server

    0

    clpcfadm.py mod -t resource/vip@vip1/act/mode --set <Value>
  • Failover Threshold

    Default, 1 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t resource/vip@vip1/act/fo2 --set <Value>
  • Final Action

    Final Action

    Value

    No operation (activate next resource)

    0

    No operation (not activate next resource) (default)

    1

    Stop group

    2

    Stop the cluster service

    3

    Stop the cluster service and shutdown OS

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t resource/vip@vip1/act/action --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/vip@vip1/act/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

    Script Settings
    • File type

      Script file type

      Value

      Script created with this product (default)

      1

      User Application

      0

      clpcfadm.py mod -t resource/vip@vip1/act/preaction/default --set <Value>

      Note

      If you change the value of this parameter, also change that of "File".

    • File (Within 1023 bytes)

      clpcfadm.py mod -t resource/vip@vip1/act/preaction/path --set <File>

      Note

      If you specify "Script created with this product", specify preactaction.bat.

      clpcfadm.py mod -t resource/vip@vip1/act/preaction/path --set preactaction.bat
    • Timeout (sec)

      Default, 5 (minimum, 1; maximum, 9999)

      clpcfadm.py mod -t resource/vip@vip1/act/preaction/timeout --set <Value>
    • Exec User

      clpcfadm.py mod -t resource/vip@vip1/act/preaction/account --set <Exec User>
Recovery Operation at Deactivity Failure Detection
  • Retry Count at Deactivation Failure

    Default, 1 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t resource/vip@vip1/deact/retry --set <Value>
  • Final Action

    Final Action

    Value

    No operation (deactivate next resource)

    0

    No operation (not deactivate next resource)

    1

    Stop the cluster service and shutdown OS (default)

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t resource/vip@vip1/deact/action --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/vip@vip1/deact/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

    Script Settings
    • File type

      Script file type

      Value

      Script created with this product (default)

      1

      User Application

      0

      clpcfadm.py mod -t resource/vip@vip1/deact/preaction/default --set <Value>

      Note

      If you change the value of this parameter, also change that of "File".

    • File (Within 1023 bytes)

      clpcfadm.py mod -t resource/vip@vip1/deact/preaction/path --set <File>

      Note

      If you specify "Script created with this product", specify predeactaction.bat.

      clpcfadm.py mod -t resource/vip@vip1/deact/preaction/path --set predeactaction.bat
    • Timeout (sec)

      Default, 5 (minimum, 1; maximum, 9999)

      clpcfadm.py mod -t resource/vip@vip1/deact/preaction/timeout --set <Value>
    • Exec User

      clpcfadm.py mod -t resource/vip@vip1/act/preaction/account --set <Exec User>

7.22.2.4. Details

Common
  • IP Address

    clpcfadm.py mod -t resource/vip@vip1/parameters/ip --set <IP Address>
  • Net Mask

    clpcfadm.py mod -t resource/vip@vip1/parameters/mask --set <Net Mask>
  • Destination IP Address

    clpcfadm.py mod -t resource/vip@vip1/parameters/multicast/dstaddr --set <Destination IP Address>
  • Source IP Address

    clpcfadm.py mod -t resource/vip@vip1/parameters/multicast/srcaddr --set <Source IP Address>
  • Send Interval (sec)

    Default, 30 (minimum, 1; maximum, 30)

    clpcfadm.py mod -t resource/vip@vip1/parameters/multicast/interval --set <Value>
  • Routing Protocol

    Value

    RIPngver1

    RIPngver2

    RIPngver3

    RIPver1 (default)

    RIPver2

    clpcfadm.py mod -t resource/vip@vip1/parameters/protocol --set <Value>

    Note

    If you use two or more routing protocols, put commas (,) to separate them.

    clpcfadm.py mod -t resource/vip@vip1/parameters/protocol --set "RIPngver3,RIPver2"
Tuning
Parameter
  • Run Ping

    Run Ping

    Value

    Execute Ping (default)

    1

    Do not execute Ping

    0

    clpcfadm.py mod -t resource/vip@vip1/parameters/pingexec --set <Value>
ping
  • Interval (sec)

    Default, 1 (minimum, 0; maximum, 999)

    clpcfadm.py mod -t resource/vip@vip1/parameters/pinginterval --set <Value>
  • Timeout (msec)

    Default, 1000 (minimum, 1; maximum, 999999)

    clpcfadm.py mod -t resource/vip@vip1/parameters/pingtimeout --set <Value>
  • Retry Count

    Default, 5 (minimum, 0; maximum, 999)

    clpcfadm.py mod -t resource/vip@vip1/parameters/pingretry --set <Value>
  • Judge NIC Link Down as Failure

    Judge NIC Link Down as Failure

    Value

    Yes

    1

    No (default)

    0

    clpcfadm.py mod -t resource/vip@vip1/parameters/monmii --set <Value>
RIP
  • Metric

    Default, 3 (minimum, 1; maximum, 15)

    clpcfadm.py mod -t resource/vip@vip1/parameters/protocols/rip/metric --set <Value>
Port
  • Port

    Default, 520 (minimum, 1; maximum, 65535)

    Add
    clpcfadm.py mod -t resource/vip@vip1/parameters/protocols/rip/port --set <Value>

    Note

    If you set two or more ports, put commas (,) to separate them.

    clpcfadm.py mod -t resource/vip@vip1/parameters/protocols/rip/port --set "12345,520"
    Delete (initializing the value to the default value)
    clpcfadm.py mod -t resource/vip@vip1/parameters/protocols/rip/port --set 520
RIPng
  • Metric

    Default, 1 (minimum, 1; maximum, 15)

    clpcfadm.py mod -t resource/vip@vip1/parameters/protocols/ripng/metric --set <Value>
    • Port

      Default, 521 (minimum, 1; maximum, 65535)

      Add
      clpcfadm.py mod -t resource/vip@vip1/parameters/protocols/ripng/port --set <Value>

      Note

      If you set two or more ports, put commas (,) to separate them.

      clpcfadm.py mod -t resource/vip@vip1/parameters/protocols/ripng/port --set "12345,521"
      Delete (initializing the value to the default value)
      clpcfadm.py mod -t resource/vip@vip1/parameters/protocols/ripng/port --set 521
Set Up Individually

Set the following for each server.

  • IP Address

    clpcfadm.py mod -t resource/vip@vip1/server@<Server name>/parameters/ip --set <IP Address> --nocheck
  • Net Mask (Within 15 bytes)

    clpcfadm.py mod -t resource/vip@vip1/server@<Server name>/parameters/mask --set <Net Mask> --nocheck
  • Destination IP Address

    clpcfadm.py mod -t resource/vip@vip1/server@<Server name>/parameters/multicast/dstaddr --set <Destination IP Address> --nocheck
  • Source IP Address

    clpcfadm.py mod -t resource/vip@vip1/server@<Server name>/parameters/multicast/srcaddr --set <Source IP Address> --nocheck
  • Send Interval (sec)

    clpcfadm.py mod -t resource/vip@vip1/server@<Server name>/parameters/multicast/interval --set <Send Interval> --nocheck
  • Routing Protocol

    clpcfadm.py mod -t resource/vip@vip1/server@<Server name>/parameters/protocol --set <Routing Protocol> --nocheck

7.22.2.5. Extension

  • Resource Startup Attribute

    Resource Startup Attribute

    Value

    Automatic startup (default)

    1

    Manual startup

    0

    clpcfadm.py mod -t resource/vip@vip1/start --set <Value>
Execute Script before or after Activation or Deactivation

Note

If "Execute" is set for a script, specify the file. (See "Script Settings" -> "File".)

  • Execute Script before Activation

    Execute Script before Activation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/vip@vip1/preact/use --set <Value>
  • Execute Script after Activation

    Execute Script after Activation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/vip@vip1/predeact/use --set <Value>
  • Execute Script before Deactivation

    Execute Script before Deactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/vip@vip1/postact/use --set <Value>
  • Execute Script after Deactivation

    Execute Script after Deactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t resource/vip@vip1/postdeact/use --set <Value>
Script Settings
  • File type

    Script file type

    Value

    Script created with this product (default)

    1

    User Application

    0

    clpcfadm.py mod -t resource/vip@vip1/preact/default --set <Value>
    clpcfadm.py mod -t resource/vip@vip1/predeact/default --set <Value>
    clpcfadm.py mod -t resource/vip@vip1/postact/default --set <Value>
    clpcfadm.py mod -t resource/vip@vip1/postdeact/default --set <Value>

    Note

    Set each of the <Value> fields to the same value.

    Note

    If you change the value of this parameter, also change that of "File".

  • File (Within 1023 bytes)

    clpcfadm.py mod -t resource/vip@vip1/preact/path --set <File>
    clpcfadm.py mod -t resource/vip@vip1/predeact/path --set <File>
    clpcfadm.py mod -t resource/vip@vip1/postact/path --set <File>
    clpcfadm.py mod -t resource/vip@vip1/postdeact/path --set <File>

    Note

    Set all <File> fields to the same value.

    Note

    If you specify "Script created with this product", specify rscextent.bat.

    clpcfadm.py mod -t resource/vip@vip1/preact/path --set rscextent.bat
    clpcfadm.py mod -t resource/vip@vip1/predeact/path --set rscextent.bat
    clpcfadm.py mod -t resource/vip@vip1/postact/path --set rscextent.bat
    clpcfadm.py mod -t resource/vip@vip1/postdeact/path --set rscextent.bat
  • Timeout (sec)

    Default, 30 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t resource/vip@vip1/preact/timeout --set <Value>
    clpcfadm.py mod -t resource/vip@vip1/predeact/timeout --set <Value>
    clpcfadm.py mod -t resource/vip@vip1/postact/timeout --set <Value>
    clpcfadm.py mod -t resource/vip@vip1/postdeact/timeout --set <Value>

    Note

    Set each of the <Value> fields to the same value.

  • Exec User

    clpcfadm.py mod -t resource/vip@vip1/preact/account --set <Value>
    clpcfadm.py mod -t resource/vip@vip1/predeact/account --set <Value>
    clpcfadm.py mod -t resource/vip@vip1/postact/account --set <Value>
    clpcfadm.py mod -t resource/vip@vip1/postdeact/account --set <Value>

    Note

    Set each of the <Value> fields to the same value.

7.22.3. Deleting a Virtual IP resource

Delete a resource by specifying the group resource type and group resource name.

clpcfadm.py del rsc <Name of the group to which the resource belongs> vip vip1

Important

Resources associated with the group resource that you delete, such as monitor resources, are not deleted together.

8. Configuring monitor resources

8.1. Application monitor resource

Note

The command lines in this section use appliw1 as the monitor resource name.
Change it to suit your environment.

8.1.1. Adding an application monitor resource

Be sure to set the following items. For details, see "Setting application monitor resource parameters".

Item (mandatory)

Monitor resource name

Target Resource (monitored when active)

Recovery target

Recovery target type

clpcfadm.py add mon appliw appliw1
clpcfadm.py mod -t monitor/appliw@appliw1/target --set <Target Resource (monitored when active)>
clpcfadm.py mod -t monitor/appliw@appliw1/relation/name --set <Recovery target> --nocheck
clpcfadm.py mod -t monitor/appliw@appliw1/relation/type --set <Recovery target type> --nocheck

Note

If you configure a cluster only with the above mandatory items, other parameters are set to their default values.

8.1.2. Setting application monitor resource parameters

8.1.2.1. Basic information

  • Monitor resource name (Within 31 bytes)

    This is set when the resource is added. To change the monitor resource name, delete the resource and set it again.

  • Comment (Within 127 bytes)

    clpcfadm.py mod -t monitor/appliw@appliw1/comment --set <Comment>

    Note

    Enclose in double quotes a string including spaces (e.g., "Sample Comment").

8.1.2.2. Monitor (common)

  • Interval (sec)

    Default, 60 (minimum, 1; maximum, 999)

    clpcfadm.py mod -t monitor/appliw@appliw1/polling/interval --set <Value>
  • Timeout (sec)

    Default, 60 (minimum, 5; maximum, 999)

    clpcfadm.py mod -t monitor/appliw@appliw1/polling/timeout --set <Value>
  • Do Not Retry at Timeout Occurrence

    Do Not Retry at Timeout Occurrence

    Value

    Retry

    0

    Do not retry (default)

    1

    clpcfadm.py mod -t monitor/appliw@appliw1/emergency/timeout/notreconfirmation/use --set <Value>
  • Action at Timeout Occurrence

    Action at Timeout Occurrence

    Value

    Recover

    0

    Do not recover (default)

    1

    Generate an intentional stop error

    2

    clpcfadm.py mod -t monitor/appliw@appliw1/emergency/timeout/notrecovery/use --set <Value>

    Note

    Set as above with "Do Not Retry at Timeout Occurrence" set to "Do not retry".

  • Retry Count

    Default, 1 (minimum, 0; maximum, 999)

    clpcfadm.py mod -t monitor/appliw@appliw1/polling/reconfirmation --set <Value>
  • Wait Time to Start Monitoring (sec)

    Default, 3 (minimum, 0; maximum, 9999)

    clpcfadm.py mod -t monitor/appliw@appliw1/firstmonwait --set <Value>
  • Target Resource (monitored when active)

    clpcfadm.py mod -t monitor/appliw@appliw1/target --set <Target Resource (monitored when active)>

    Note

    You can specify only an application resource for this monitor resource.

  • Choose servers that execute monitoring

    clpcfadm.py mod -t monitor/appliw@appliw1/polling/servers@<ID>/name --set <Server name> --nocheck

    Note

    With only one server to be monitored, specify 0 for ID.
    With more than one server to be monitored, specify consecutive numbers (e.g., 0, 1, 2...).
  • Send polling time metrics

    Send polling time metrics

    Value

    Send

    1

    Do not send (default)

    0

    clpcfadm.py mod -t monitor/appliw@appliw1/perf/metrics/use --set <Value>

8.1.2.3. Recovery Action

  • Recovery target

    Recovery target

    Recovery target type

    Local server

    LocalServer

    cls

    All groups([All Groups])

    ""

    grp

    Failover group name

    (Failover group name)

    grp

    Group resource name

    (Group resource name)

    rsc

    clpcfadm.py mod -t monitor/appliw@appliw1/relation/name --set <Recovery target> --nocheck
    clpcfadm.py mod -t monitor/appliw@appliw1/relation/type --set <Recovery target type> --nocheck

    Important

    If you set "Recovery target" to "Local server"

    Set "Maximum Reactivation Count" and "Maximum Failover Count" to 0 (times).

    clpcfadm.py mod -t monitor/appliw@appliw1/emergency/threshold/restart --set 0
    clpcfadm.py mod -t monitor/appliw@appliw1/emergency/threshold/fo2 --set 0

    If the current setting for "Final Action" is "Stop resource (16)" or "Stop Group (2)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/appliw@appliw1/emergency/action --set 1

    Important

    If you set "Recovery target" to "All groups ([All Groups])"

    Set "Maximum Reactivation Count" to 0 (times).

    clpcfadm.py mod -t monitor/appliw@appliw1/emergency/threshold/restart --set 0

    If the current setting for "Final Action" is "Stop resource (16)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/appliw@appliw1/emergency/action --set 1
  • Recovery Script Execution Count

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/appliw@appliw1/emergency/threshold/script --set <Value>
  • Execute Script before Reactivation

    Execute Script before Reactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/appliw@appliw1/emergency/preaction/userestart --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Maximum Reactivation Count

    Default, 3 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/appliw@appliw1/emergency/threshold/restart --set <Value>
  • Execute Script before Failover

    Execute Script before Failover

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/appliw@appliw1/emergency/preaction/usefailover --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Failover Target Server

    Failover Target Server

    Value

    Stable server (default)

    1

    Maximum priority server

    0

    clpcfadm.py mod -t monitor/appliw@appliw1/emergency/mode --set <Value>
  • Maximum Failover Count

    Default, 1 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/appliw@appliw1/emergency/threshold/fo2 --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/appliw@appliw1/emergency/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Final Action

    Final Action
    Value

    No operation (default)

    1

    Stop resource 5

    16

    Stop group 6

    2

    Stop the cluster service

    3

    Stop the cluster service and shutdown OS

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t monitor/appliw@appliw1/emergency/action --set <Value>
    5

    Cannot be specified with "Recovery target type" set to "cls" or "grp".

    6

    Cannot be specified with "Recovery target type" set to "cls".

Script Settings
  • File type

    Script file type

    Value

    Script created with this product (default)

    1

    User Application

    0

    clpcfadm.py mod -t monitor/appliw@appliw1/emergency/preaction/default --set <Value>

    Note

    If you change the value of this parameter, also change that of "File".

  • File (Within 1023 bytes)

    clpcfadm.py mod -t monitor/appliw@appliw1/emergency/preaction/path --set <File> --nocheck

    Note

    If you specify "Script created with this product", specify preaction.bat.

    clpcfadm.py mod -t monitor/appliw@appliw1/emergency/preaction/path --set preaction.bat --nocheck
  • Timeout (sec)

    Default, 5 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t monitor/appliw@appliw1/emergency/preaction/timeout --set <Value>
  • Exec User

    clpcfadm.py mod -t monitor/appliw@appliw1/emergency/preaction/account --set <Exec User>
  • Exec User

    clpcfadm.py mod -t monitor/appliw@appliw1/emergency/preaction/account --set <Exec User>

8.1.3. Deleting an application monitor resource

Delete a resource by specifying the monitor resource type and monitor resource name.

clpcfadm.py del mon appliw appliw1

8.2. AWS AZ monitor resource

Note

The command lines in this section use awsazw1 as the monitor resource name.
Change it to suit your environment.

8.2.1. Adding an AWS AZ monitor resource

Be sure to set the following items. For details, see "Setting AWS AZ monitor resource parameters".

Item (mandatory)

Monitor resource name

Availability Zone

Recovery target

Recovery target type

clpcfadm.py add mon awsazw awsazw1
clpcfadm.py mod -t monitor/awsazw@awsazw1/parameters/availabilityzone --set <Availability Zone>
clpcfadm.py mod -t monitor/awsazw@awsazw1/relation/name --set <Recovery target> --nocheck
clpcfadm.py mod -t monitor/awsazw@awsazw1/relation/type --set <Recovery target type> --nocheck

Note

If you configure a cluster only with the above mandatory items, other parameters are set to their default values.

8.2.2. Setting AWS AZ monitor resource parameters

8.2.2.1. Basic information

  • Monitor resource name (Within 31 bytes)

    This is set when the resource is added. To change the monitor resource name, delete the resource and set it again.

  • Comment (Within 127 bytes)

    clpcfadm.py mod -t monitor/awsazw@awsazw1/comment --set <Comment>

    Note

    Enclose in double quotes a string including spaces (e.g., "Sample Comment").

8.2.2.2. Monitor (common)

  • Interval (sec)

    Default, 60 (minimum, 1; maximum, 999)

    clpcfadm.py mod -t monitor/awsazw@awsazw1/polling/interval --set <Value>
  • Timeout (sec)

    Default, 180 (minimum, 5; maximum, 999)

    clpcfadm.py mod -t monitor/awsazw@awsazw1/polling/timeout --set <Value>
  • Do Not Retry at Timeout Occurrence

    Do Not Retry at Timeout Occurrence

    Value

    Retry

    0

    Do not retry (default)

    1

    clpcfadm.py mod -t monitor/awsazw@awsazw1/emergency/timeout/notreconfirmation/use --set <Value>
  • Action at Timeout Occurrence

    Action at Timeout Occurrence

    Value

    Recover

    0

    Do not recover (default)

    1

    Generate an intentional stop error

    2

    clpcfadm.py mod -t monitor/awsazw@awsazw1/emergency/timeout/notrecovery/use --set <Value>

    Note

    Set as above with "Do Not Retry at Timeout Occurrence" set to "Do not retry".

  • Retry Count

    Default, 1 (minimum, 0; maximum, 999)

    clpcfadm.py mod -t monitor/awsazw@awsazw1/polling/reconfirmation --set <Value>
  • Wait Time to Start Monitoring (sec)

    Default, 0 (minimum, 0; maximum, 9999)

    clpcfadm.py mod -t monitor/awsazw@awsazw1/firstmonwait --set <Value>
  • Choose servers that execute monitoring

    clpcfadm.py mod -t monitor/awsazw@awsazw1/polling/servers@<ID>/name --set <Server name> --nocheck

    Note

    With only one server to be monitored, specify 0 for ID.
    With more than one server to be monitored, specify consecutive numbers (e.g., 0, 1, 2...).
  • Send polling time metrics

    Send polling time metrics

    Value

    Send

    1

    Do not send (default)

    0

    clpcfadm.py mod -t monitor/awsazw@awsazw1/perf/metrics/use --set <Value>

8.2.2.3. Monitor (special)

Common
  • Availability Zone (Within 45 bytes)

    clpcfadm.py mod -t monitor/awsazw@awsazw1/parameters/availabilityzone --set <Availability Zone>
  • Action when AWS CLI command failed to receive response

    Action when AWS CLI command failed to receive response

    Value

    Disable recovery action(Do nothing) (default)

    0

    Disable recovery action(Display warning)

    1

    Recover

    2

    clpcfadm.py mod -t monitor/awsazw@awsazw1/parameters/mode --set <Value>
Set Up Individually

Set the following for each server.

  • Availability Zone (Within 45 bytes)

    clpcfadm.py mod -t monitor/awsazw@awsazw1/server@<Server name>/parameters/availabilityzone --set <Value> --nocheck

Note

To return to the common settings, set the following for each server.

clpcfadm.py mod -t monitor/awsazw@awsazw1/server@<Server name> --delete

8.2.2.4. Recovery Action

  • Recovery target

    Recovery target

    Recovery target type

    Local server

    LocalServer

    cls

    All groups([All Groups])

    ""

    grp

    Failover group name

    (Failover group name)

    grp

    Group resource name

    (Group resource name)

    rsc

    clpcfadm.py mod -t monitor/awsazw@awsazw1/relation/name --set <Recovery target> --nocheck
    clpcfadm.py mod -t monitor/awsazw@awsazw1/relation/type --set <Recovery target type> --nocheck

    Important

    If you set "Recovery target" to "Local server"

    Set "Maximum Reactivation Count" and "Maximum Failover Count" to 0 (times).

    clpcfadm.py mod -t monitor/awsazw@awsazw1/emergency/threshold/restart --set 0
    clpcfadm.py mod -t monitor/awsazw@awsazw1/emergency/threshold/fo2 --set 0

    If the current setting for "Final Action" is "Stop resource (16)" or "Stop Group (2)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/awsazw@awsazw1/emergency/action --set 1

    Important

    If you set "Recovery target" to "All groups ([All Groups])"

    Set "Maximum Reactivation Count" to 0 (times).

    clpcfadm.py mod -t monitor/awsazw@awsazw1/emergency/threshold/restart --set 0

    If the current setting for "Final Action" is "Stop resource (16)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/awsazw@awsazw1/emergency/action --set 1
  • Recovery Script Execution Count

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/awsazw@awsazw1/emergency/threshold/script --set <Value>
  • Execute Script before Reactivation

    Execute Script before Reactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/awsazw@awsazw1/emergency/preaction/userestart --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Maximum Reactivation Count

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/awsazw@awsazw1/emergency/threshold/restart --set <Value>
  • Execute Script before Failover

    Execute Script before Failover

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/awsazw@awsazw1/emergency/preaction/usefailover --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Failover Target Server

    Failover Target Server

    Value

    Stable server (default)

    1

    Maximum priority server

    0

    clpcfadm.py mod -t monitor/awsazw@awsazw1/emergency/mode --set <Value>
  • Maximum Failover Count

    Default, 1 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/awsazw@awsazw1/emergency/threshold/fo2 --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/awsazw@awsazw1/emergency/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Final Action

    Final Action
    Value

    No operation (default)

    1

    Stop resource 7

    16

    Stop group 8

    2

    Stop the cluster service

    3

    Stop the cluster service and shutdown OS

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t monitor/awsazw@awsazw1/emergency/action --set <Value>
    7

    Cannot be specified with "Recovery target type" set to "cls" or "grp".

    8

    Cannot be specified with "Recovery target type" set to "cls".

Script Settings
  • File type

    Script file type

    Value

    Script created with this product (default)

    1

    User Application

    0

    clpcfadm.py mod -t monitor/awsazw@awsazw1/emergency/preaction/default --set <Value>

    Note

    If you change the value of this parameter, also change that of "File".

  • File (Within 1023 bytes)

    clpcfadm.py mod -t monitor/awsazw@awsazw1/emergency/preaction/path --set <File> --nocheck

    Note

    If you specify "Script created with this product", specify preaction.bat.

    clpcfadm.py mod -t monitor/awsazw@awsazw1/emergency/preaction/path --set preaction.bat --nocheck
  • Timeout (sec)

    Default, 5 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t monitor/awsazw@awsazw1/emergency/preaction/timeout --set <Value>
  • Exec User

    clpcfadm.py mod -t monitor/awsazw@awsazw1/emergency/preaction/account --set <Exec User>

8.2.3. Deleting an AWS AZ monitor resource

Delete a resource by specifying the monitor resource type and monitor resource name.

clpcfadm.py del mon awsazw awsazw1

8.3. AWS DNS monitor resource

Note

The command lines in this section use awsdnsw1 as the monitor resource name.
Change it to suit your environment.

8.3.1. Adding an AWS DNS monitor resource

Be sure to set the following items. For details, see "Setting AWS DNS monitor resource parameters".

Item (mandatory)

Monitor resource name

Target Resource (monitored when active)

Recovery target

Recovery target type

clpcfadm.py add mon awsdnsw awsdnsw1
clpcfadm.py mod -t monitor/awsdnsw@awsdnsw1/target --set <Target Resource (monitored when active)>
clpcfadm.py mod -t monitor/awsdnsw@awsdnsw1/relation/name --set <Recovery target> --nocheck
clpcfadm.py mod -t monitor/awsdnsw@awsdnsw1/relation/type --set <Recovery target type> --nocheck

Note

If you configure a cluster only with the above mandatory items, other parameters are set to their default values.

8.3.2. Setting AWS DNS monitor resource parameters

8.3.2.1. Basic information

  • Monitor resource name (Within 31 bytes)

    This is set when the resource is added. To change the monitor resource name, delete the resource and set it again.

  • Comment (Within 127 bytes)

    clpcfadm.py mod -t monitor/awsdnsw@awsdnsw1/comment --set <Comment>

    Note

    Enclose in double quotes a string including spaces (e.g., "Sample Comment").

8.3.2.2. Monitor (common)

  • Interval (sec)

    Default, 60 (minimum, 1; maximum, 999)

    clpcfadm.py mod -t monitor/awsdnsw@awsdnsw1/polling/interval --set <Value>
  • Timeout (sec)

    Default, 180 (minimum, 5; maximum, 999)

    clpcfadm.py mod -t monitor/awsdnsw@awsdnsw1/polling/timeout --set <Value>
  • Do Not Retry at Timeout Occurrence

    Do Not Retry at Timeout Occurrence

    Value

    Retry

    0

    Do not retry (default)

    1

    clpcfadm.py mod -t monitor/awsdnsw@awsdnsw1/emergency/timeout/notreconfirmation/use --set <Value>
  • Action at Timeout Occurrence

    Action at Timeout Occurrence

    Value

    Recover

    0

    Do not recover (default)

    1

    Generate an intentional stop error

    2

    clpcfadm.py mod -t monitor/awsdnsw@awsdnsw1/emergency/timeout/notrecovery/use --set <Value>

    Note

    Set as above with "Do Not Retry at Timeout Occurrence" set to "Do not retry".

  • Retry Count

    Default, 1 (minimum, 0; maximum, 999)

    clpcfadm.py mod -t monitor/awsdnsw@awsdnsw1/polling/reconfirmation --set <Value>
  • Wait Time to Start Monitoring (sec)

    Default, 300 (minimum, 0; maximum, 9999)

    clpcfadm.py mod -t monitor/awsdnsw@awsdnsw1/firstmonwait --set <Value>
  • Target Resource (monitored when active)

    clpcfadm.py mod -t monitor/awsdnsw@awsdnsw1/target --set <Target Resource (monitored when active)>

    Note

    You can specify only an AWS DNS resource for this monitor resource.

  • Choose servers that execute monitoring

    clpcfadm.py mod -t monitor/awsdnsw@awsdnsw1/polling/servers@<ID>/name --set <Server name> --nocheck

    Note

    With only one server to be monitored, specify 0 for ID.
    With more than one server to be monitored, specify consecutive numbers (e.g., 0, 1, 2...).
  • Send polling time metrics

    Send polling time metrics

    Value

    Send

    1

    Do not send (default)

    0

    clpcfadm.py mod -t monitor/awsdnsw@awsdnsw1/perf/metrics/use --set <Value>

8.3.2.3. Monitor (special)

  • Action when AWS CLI command failed to receive response

    Action when AWS CLI command failed to receive response

    Value

    Disable recovery action(Do nothing) (default)

    0

    Disable recovery action(Display warning)

    1

    Recover

    2

    clpcfadm.py mod -t monitor/awsdnsw@awsdnsw1/parameters/mode --set <Value>
  • Check Name Resolution

    Check Name Resolution

    Value

    Check Name Resolution (default)

    1

    Do not check name resolution

    0

    clpcfadm.py mod -t monitor/awsdnsw@awsdnsw1/parameters/dnscheck --set <Value>

8.3.2.4. Recovery Action

  • Recovery target

    Recovery target

    Recovery target type

    Local server

    LocalServer

    cls

    All groups([All Groups])

    ""

    grp

    Failover group name

    (Failover group name)

    grp

    Group resource name

    (Group resource name)

    rsc

    clpcfadm.py mod -t monitor/awsdnsw@awsdnsw1/relation/name --set <Recovery target> --nocheck
    clpcfadm.py mod -t monitor/awsdnsw@awsdnsw1/relation/type --set <Recovery target type> --nocheck

    Important

    If you set "Recovery target" to "Local server"

    Set "Maximum Reactivation Count" and "Maximum Failover Count" to 0 (times).

    clpcfadm.py mod -t monitor/awsdnsw@awsdnsw1/emergency/threshold/restart --set 0
    clpcfadm.py mod -t monitor/awsdnsw@awsdnsw1/emergency/threshold/fo2 --set 0

    If the current setting for "Final Action" is "Stop resource (16)" or "Stop Group (2)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/awsdnsw@awsdnsw1/emergency/action --set 1

    Important

    If you set "Recovery target" to "All groups ([All Groups])"

    Set "Maximum Reactivation Count" to 0 (times).

    clpcfadm.py mod -t monitor/awsdnsw@awsdnsw1/emergency/threshold/restart --set 0

    If the current setting for "Final Action" is "Stop resource (16)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/awsdnsw@awsdnsw1/emergency/action --set 1
  • Recovery Script Execution Count

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/awsdnsw@awsdnsw1/emergency/threshold/script --set <Value>
  • Execute Script before Reactivation

    Execute Script before Reactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/awsdnsw@awsdnsw1/emergency/preaction/userestart --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Maximum Reactivation Count

    Default, 3 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/awsdnsw@awsdnsw1/emergency/threshold/restart --set <Value>
  • Execute Script before Failover

    Execute Script before Failover

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/awsdnsw@awsdnsw1/emergency/preaction/usefailover --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Failover Target Server

    Failover Target Server

    Value

    Stable server (default)

    1

    Maximum priority server

    0

    clpcfadm.py mod -t monitor/awsdnsw@awsdnsw1/emergency/mode --set <Value>
  • Maximum Failover Count

    Default, 1 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/awsdnsw@awsdnsw1/emergency/threshold/fo2 --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/awsdnsw@awsdnsw1/emergency/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Final Action

    Final Action
    Value

    No operation (default)

    1

    Stop resource 9

    16

    Stop group 10

    2

    Stop the cluster service

    3

    Stop the cluster service and shutdown OS

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t monitor/awsdnsw@awsdnsw1/emergency/action --set <Value>
    9

    Cannot be specified with "Recovery target type" set to "cls" or "grp".

    10

    Cannot be specified with "Recovery target type" set to "cls".

Script Settings
  • File type

    Script file type

    Value

    Script created with this product (default)

    1

    User Application

    0

    clpcfadm.py mod -t monitor/awsdnsw@awsdnsw1/emergency/preaction/default --set <Value>

    Note

    If you change the value of this parameter, also change that of "File".

  • File (Within 1023 bytes)

    clpcfadm.py mod -t monitor/awsdnsw@awsdnsw1/emergency/preaction/path --set <File> --nocheck

    Note

    If you specify "Script created with this product", specify preaction.bat.

    clpcfadm.py mod -t monitor/awsdnsw@awsdnsw1/emergency/preaction/path --set preaction.bat --nocheck
  • Timeout (sec)

    Default, 5 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t monitor/awsdnsw@awsdnsw1/emergency/preaction/timeout --set <Value>
  • Exec User

    clpcfadm.py mod -t monitor/awsdnsw@awsdnsw1/emergency/preaction/account --set <Exec User>

8.3.3. Deleting an AWS DNS monitor resource

Delete a resource by specifying the monitor resource type and monitor resource name.

clpcfadm.py del mon awsdnsw awsdnsw1

8.4. AWS Elastic IP monitor resource

Note

The command lines in this section use awseipw1 as the monitor resource name.
Change it to suit your environment.

8.4.1. Adding an AWS Elastic IP monitor resource

Be sure to set the following items. For details, see "Setting AWS Elastic IP monitor resource parameters".

Item (mandatory)

Monitor resource name

Target Resource (monitored when active)

Recovery target

Recovery target type

clpcfadm.py add mon awseipw awseipw1
clpcfadm.py mod -t monitor/awseipw@awseipw1/target --set <Target Resource (monitored when active)>
clpcfadm.py mod -t monitor/awseipw@awseipw1/relation/name --set <Recovery target> --nocheck
clpcfadm.py mod -t monitor/awseipw@awseipw1/relation/type --set <Recovery target type> --nocheck

Note

If you configure a cluster only with the above mandatory items, other parameters are set to their default values.

8.4.2. Setting AWS Elastic IP monitor resource parameters

8.4.2.1. Basic information

  • Monitor resource name (Within 31 bytes)

    This is set when the resource is added. To change the monitor resource name, delete the resource and set it again.

  • Comment (Within 127 bytes)

    clpcfadm.py mod -t monitor/awseipw@awseipw1/comment --set <Comment>

    Note

    Enclose in double quotes a string including spaces (e.g., "Sample Comment").

8.4.2.2. Monitor (common)

  • Interval (sec)

    Default, 60 (minimum, 1; maximum, 999)

    clpcfadm.py mod -t monitor/awseipw@awseipw1/polling/interval --set <Value>
  • Timeout (sec)

    Default, 180 (minimum, 5; maximum, 999)

    clpcfadm.py mod -t monitor/awseipw@awseipw1/polling/timeout --set <Value>
  • Do Not Retry at Timeout Occurrence

    Do Not Retry at Timeout Occurrence

    Value

    Retry

    0

    Do not retry (default)

    1

    clpcfadm.py mod -t monitor/awseipw@awseipw1/emergency/timeout/notreconfirmation/use --set <Value>
  • Action at Timeout Occurrence

    Action at Timeout Occurrence

    Value

    Recover

    0

    Do not recover (default)

    1

    Generate an intentional stop error

    2

    clpcfadm.py mod -t monitor/awseipw@awseipw1/emergency/timeout/notrecovery/use --set <Value>

    Note

    Set as above with "Do Not Retry at Timeout Occurrence" set to "Do not retry".

  • Retry Count

    Default, 1 (minimum, 0; maximum, 999)

    clpcfadm.py mod -t monitor/awseipw@awseipw1/polling/reconfirmation --set <Value>
  • Wait Time to Start Monitoring (sec)

    Default, 0 (minimum, 0; maximum, 9999)

    clpcfadm.py mod -t monitor/awseipw@awseipw1/firstmonwait --set <Value>
  • Target Resource (monitored when active)

    clpcfadm.py mod -t monitor/awseipw@awseipw1/target --set <Target Resource (monitored when active)>

    Note

    You can specify only an AWS Elastic IP resource for this monitor resource.

  • Choose servers that execute monitoring

    clpcfadm.py mod -t monitor/awseipw@awseipw1/polling/servers@<ID>/name --set <Server name> --nocheck

    Note

    With only one server to be monitored, specify 0 for ID.
    With more than one server to be monitored, specify consecutive numbers (e.g., 0, 1, 2...).
  • Send polling time metrics

    Send polling time metrics

    Value

    Send

    1

    Do not send (default)

    0

    clpcfadm.py mod -t monitor/awseipw@awseipw1/perf/metrics/use --set <Value>

8.4.2.3. Monitor (special)

  • Action when AWS CLI command failed to receive response

    Action when AWS CLI command failed to receive response

    Value

    Disable recovery action(Do nothing) (default)

    0

    Disable recovery action(Display warning)

    1

    Recover

    2

    clpcfadm.py mod -t monitor/awseipw@awseipw1/parameters/mode --set <Value>

8.4.2.4. Recovery Action

  • Recovery target

    Recovery target

    Recovery target type

    Local server

    LocalServer

    cls

    All groups([All Groups])

    ""

    grp

    Failover group name

    (Failover group name)

    grp

    Group resource name

    (Group resource name)

    rsc

    clpcfadm.py mod -t monitor/awseipw@awseipw1/relation/name --set <Recovery target> --nocheck
    clpcfadm.py mod -t monitor/awseipw@awseipw1/relation/type --set <Recovery target type> --nocheck

    Important

    If you set "Recovery target" to "Local server"

    Set "Maximum Reactivation Count" and "Maximum Failover Count" to 0 (times).

    clpcfadm.py mod -t monitor/awseipw@awseipw1/emergency/threshold/restart --set 0
    clpcfadm.py mod -t monitor/awseipw@awseipw1/emergency/threshold/fo2 --set 0

    If the current setting for "Final Action" is "Stop resource (16)" or "Stop Group (2)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/awseipw@awseipw1/emergency/action --set 1

    Important

    If you set "Recovery target" to "All groups ([All Groups])"

    Set "Maximum Reactivation Count" to 0 (times).

    clpcfadm.py mod -t monitor/awseipw@awseipw1/emergency/threshold/restart --set 0

    If the current setting for "Final Action" is "Stop resource (16)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/awseipw@awseipw1/emergency/action --set 1
  • Recovery Script Execution Count

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/awseipw@awseipw1/emergency/threshold/script --set <Value>
  • Execute Script before Reactivation

    Execute Script before Reactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/awseipw@awseipw1/emergency/preaction/userestart --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Maximum Reactivation Count

    Default, 3 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/awseipw@awseipw1/emergency/threshold/restart --set <Value>
  • Execute Script before Failover

    Execute Script before Failover

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/awseipw@awseipw1/emergency/preaction/usefailover --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Failover Target Server

    Failover Target Server

    Value

    Stable server (default)

    1

    Maximum priority server

    0

    clpcfadm.py mod -t monitor/awseipw@awseipw/emergency/mode --set <Value>
  • Maximum Failover Count

    Default, 1 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/awseipw@awseipw1/emergency/threshold/fo2 --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/awseipw@awseipw1/emergency/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Final Action

    Final Action
    Value

    No operation (default)

    1

    Stop resource 11

    16

    Stop group 12

    2

    Stop the cluster service

    3

    Stop the cluster service and shutdown OS

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t monitor/awseipw@awseipw1/emergency/action --set <Value>
    11

    Cannot be specified with "Recovery target type" set to "cls" or "grp".

    12

    Cannot be specified with "Recovery target type" set to "cls".

Script Settings
  • File type

    Script file type

    Value

    Script created with this product (default)

    1

    User Application

    0

    clpcfadm.py mod -t monitor/awseipw@awseipw1/emergency/preaction/default --set <Value>

    Note

    If you change the value of this parameter, also change that of "File".

  • File (Within 1023 bytes)

    clpcfadm.py mod -t monitor/awseipw@awseipw1/emergency/preaction/path --set <File> --nocheck

    Note

    If you specify "Script created with this product", specify preaction.bat.

    clpcfadm.py mod -t monitor/awseipw@awseipw1/emergency/preaction/path --set preaction.bat --nocheck
  • Timeout (sec)

    Default, 5 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t monitor/awseipw@awseipw1/emergency/preaction/timeout --set <Value>
  • Exec User

    clpcfadm.py mod -t monitor/awseipw@awseipw1/emergency/preaction/account --set <Exec User>

8.4.3. Deleting an AWS Elastic IP monitor resource

Delete a resource by specifying the monitor resource type and monitor resource name.

clpcfadm.py del mon awseipw awseipw1

8.5. AWS Secondary IP monitor resource

Note

The command lines in this section use awssipw1 as the monitor resource name.
Change it to suit your environment.

8.5.1. Adding an AWS secondary IP monitor resource

Be sure to set the following items. For details, see "Setting AWS secondary IP monitor resource parameters".

Item (mandatory)

Monitor resource name

Target Resource (monitored when active)

Recovery target

Recovery target type

clpcfadm.py add mon awssipw awssipw1
clpcfadm.py mod -t monitor/awssipw@awssipw1/target --set <Target Resource (monitored when active)>
clpcfadm.py mod -t monitor/awssipw@awssipw1/relation/name --set <Recovery target> --nocheck
clpcfadm.py mod -t monitor/awssipw@awssipw1/relation/type --set <Recovery target type> --nocheck

Note

If you configure a cluster only with the above mandatory items, other parameters are set to their default values.

8.5.2. Setting AWS secondary IP monitor resource parameters

8.5.2.1. Basic information

  • Monitor resource name (Within 31 bytes)

    This is set when the resource is added. To change the monitor resource name, delete the resource and set it again.

  • Comment (Within 127 bytes)

    clpcfadm.py mod -t monitor/awssipw@awssipw1/comment --set <Comment>

    Note

    Enclose in double quotes a string including spaces (e.g., "Sample Comment").

8.5.2.2. Monitor (common)

  • Interval (sec)

    Default, 60 (minimum, 1; maximum, 999)

    clpcfadm.py mod -t monitor/awssipw@awssipw1/polling/interval --set <Value>
  • Timeout (sec)

    Default, 120 (minimum, 5; maximum, 999)

    clpcfadm.py mod -t monitor/awssipw@awssipw1/polling/timeout --set <Value>
  • Do Not Retry at Timeout Occurrence

    Do Not Retry at Timeout Occurrence

    Value

    Retry

    0

    Do not retry (default)

    1

    clpcfadm.py mod -t monitor/awssipw@awssipw1/emergency/timeout/notreconfirmation/use --set <Value>
  • Action at Timeout Occurrence

    Action at Timeout Occurrence

    Value

    Recover

    0

    Do not recover (default)

    1

    Generate an intentional stop error

    2

    clpcfadm.py mod -t monitor/awssipw@awssipw1/emergency/timeout/notrecovery/use --set <Value>

    Note

    Set as above with "Do Not Retry at Timeout Occurrence" set to "Do not retry".

  • Retry Count

    Default, 1 (minimum, 0; maximum, 999)

    clpcfadm.py mod -t monitor/awssipw@awssipw1/polling/reconfirmation --set <Value>
  • Wait Time to Start Monitoring (sec)

    Default, 0 (minimum, 0; maximum, 9999)

    clpcfadm.py mod -t monitor/awssipw@awssipw1/firstmonwait --set <Value>
  • Target Resource (monitored when active)

    clpcfadm.py mod -t monitor/awssipw@awssipw1/target --set <Target Resource (monitored when active)>

    Note

    You can specify only an AWS secondary IP resource for this monitor resource.

  • Choose servers that execute monitoring

    clpcfadm.py mod -t monitor/awssipw@awssipw1/polling/servers@<ID>/name --set <Server name> --nocheck

    Note

    With only one server to be monitored, specify 0 for ID.
    With more than one server to be monitored, specify consecutive numbers (e.g., 0, 1, 2...).
  • Send polling time metrics

    Send polling time metrics

    Value

    Send

    1

    Do not send (default)

    0

    clpcfadm.py mod -t monitor/awssipw@awssipw1/perf/metrics/use --set <Value>

8.5.2.3. Monitor (special)

  • Action when AWS CLI command failed to receive response

    Action when AWS CLI command failed to receive response

    Value

    Disable recovery action(Do nothing) (default)

    0

    Disable recovery action(Display warning)

    1

    Recover

    2

    clpcfadm.py mod -t monitor/awssipw@awssipw1/parameters/mode --set <Value>

8.5.2.4. Recovery Action

  • Recovery target

    Recovery target

    Recovery target type

    Local server

    LocalServer

    cls

    All groups([All Groups])

    ""

    grp

    Failover group name

    (Failover group name)

    grp

    Group resource name

    (Group resource name)

    rsc

    clpcfadm.py mod -t monitor/awssipw@awssipw1/relation/name --set <Recovery target> --nocheck
    clpcfadm.py mod -t monitor/awssipw@awssipw1/relation/type --set <Recovery target type> --nocheck

    Important

    If you set "Recovery target" to "Local server"

    Set "Maximum Reactivation Count" and "Maximum Failover Count" to 0 (times).

    clpcfadm.py mod -t monitor/awssipw@awssipw1/emergency/threshold/restart --set 0
    clpcfadm.py mod -t monitor/awssipw@awssipw1/emergency/threshold/fo2 --set 0

    If the current setting for "Final Action" is "Stop resource (16)" or "Stop Group (2)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/awssipw@awssipw1/emergency/action --set 1

    Important

    If you set "Recovery target" to "All groups ([All Groups])"

    Set "Maximum Reactivation Count" to 0 (times).

    clpcfadm.py mod -t monitor/awssipw@awssipw1/emergency/threshold/restart --set 0

    If the current setting for "Final Action" is "Stop resource (16)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/awssipw@awssipw1/emergency/action --set 1
  • Recovery Script Execution Count

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/awssipw@awssipw1/emergency/threshold/script --set <Value>
  • Execute Script before Reactivation

    Execute Script before Reactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/awssipw@awssipw1/emergency/preaction/userestart --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Maximum Reactivation Count

    Default, 3 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/awssipw@awssipw1/emergency/threshold/restart --set <Value>
  • Execute Script before Failover

    Execute Script before Failover

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/awssipw@awssipw1/emergency/preaction/usefailover --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Failover Target Server

    Failover Target Server

    Value

    Stable server (default)

    1

    Maximum priority server

    0

    clpcfadm.py mod -t monitor/awssipw@awssipw1/emergency/mode --set <Value>
  • Maximum Failover Count

    Default, 1 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/awssipw@awssipw1/emergency/threshold/fo2 --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/awssipw@awssipw1/emergency/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Final Action

    Final Action
    Value

    No operation (default)

    1

    Stop resource 13

    16

    Stop group 14

    2

    Stop the cluster service

    3

    Stop the cluster service and shutdown OS

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t monitor/awssipw@awssipw1/emergency/action --set <Value>
    13

    Cannot be specified with "Recovery target type" set to "cls" or "grp".

    14

    Cannot be specified with "Recovery target type" set to "cls".

Script Settings
  • File type

    Script file type

    Value

    Script created with this product (default)

    1

    User Application

    0

    clpcfadm.py mod -t monitor/awssipw@awssipw1/emergency/preaction/default --set <Value>

    Note

    If you change the value of this parameter, also change that of "File".

  • File (Within 1023 bytes)

    clpcfadm.py mod -t monitor/awssipw@awssipw1/emergency/preaction/path --set <File> --nocheck

    Note

    If you specify "Script created with this product", specify preaction.bat.

    clpcfadm.py mod -t monitor/awssipw@awssipw1/emergency/preaction/path --set preaction.bat --nocheck
  • Timeout (sec)

    Default, 5 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t monitor/awssipw@awssipw1/emergency/preaction/timeout --set <Value>
  • Exec User

    clpcfadm.py mod -t monitor/awssipw@awssipw1/emergency/preaction/account --set <Exec User>

8.5.3. Deleting an AWS secondary IP monitor resource

Delete a resource by specifying the monitor resource type and monitor resource name.

clpcfadm.py del mon awssipw awssipw1

8.6. AWS Virtual IP monitor resource

Note

The command lines in this section use awsvipw1 as the monitor resource name.
Change it to suit your environment.

8.6.1. Adding an AWS Virtual IP monitor resource

Be sure to set the following items. For details, see "Setting AWS Virtual IP monitor resource parameters".

Item (mandatory)

Monitor resource name

Target Resource (monitored when active)

Recovery target

Recovery target type

clpcfadm.py add mon awsvipw awsvipw1
clpcfadm.py mod -t monitor/awsvipw@awsvipw1/target --set <Target Resource (monitored when active)>
clpcfadm.py mod -t monitor/awsvipw@awsvipw1/relation/name --set <Recovery target> --nocheck
clpcfadm.py mod -t monitor/awsvipw@awsvipw1/relation/type --set <Recovery target type> --nocheck

Note

If you configure a cluster only with the above mandatory items, other parameters are set to their default values.

8.6.2. Setting AWS Virtual IP monitor resource parameters

8.6.2.1. Basic information

  • Monitor resource name (Within 31 bytes)

    This is set when the resource is added. To change the monitor resource name, delete the resource and set it again.

  • Comment (Within 127 bytes)

    clpcfadm.py mod -t monitor/awsvipw@awsvipw1/comment --set <Comment>

    Note

    Enclose in double quotes a string including spaces (e.g., "Sample Comment").

8.6.2.2. Monitor (common)

  • Interval (sec)

    Default, 60 (minimum, 1; maximum, 999)

    clpcfadm.py mod -t monitor/awsvipw@awsvipw1/polling/interval --set <Value>
  • Timeout (sec)

    Default, 180 (minimum, 5; maximum, 999)

    clpcfadm.py mod -t monitor/awsvipw@awsvipw1/polling/timeout --set <Value>
  • Do Not Retry at Timeout Occurrence

    Do Not Retry at Timeout Occurrence

    Value

    Retry

    0

    Do not retry (default)

    1

    clpcfadm.py mod -t monitor/awsvipw@awsvipw1/emergency/timeout/notreconfirmation/use --set <Value>
  • Action at Timeout Occurrence

    Action at Timeout Occurrence

    Value

    Recover

    0

    Do not recover (default)

    1

    Generate an intentional stop error

    2

    clpcfadm.py mod -t monitor/awsvipw@awsvipw1/emergency/timeout/notrecovery/use --set <Value>

    Note

    Set as above with "Do Not Retry at Timeout Occurrence" set to "Do not retry".

  • Retry Count

    Default, 1 (minimum, 0; maximum, 999)

    clpcfadm.py mod -t monitor/awsvipw@awsvipw1/polling/reconfirmation --set <Value>
  • Wait Time to Start Monitoring (sec)

    Default, 0 (minimum, 0; maximum, 9999)

    clpcfadm.py mod -t monitor/awsvipw@awsvipw1/firstmonwait --set <Value>
  • Target Resource (monitored when active)

    clpcfadm.py mod -t monitor/awsvipw@awsvipw1/target --set <Target Resource (monitored when active)>

    Note

    You can specify only an AWS Virtual IP resource for this monitor resource.

  • Choose servers that execute monitoring

    clpcfadm.py mod -t monitor/awsvipw@awsvipw1/polling/servers@<ID>/name --set <Server name> --nocheck

    Note

    With only one server to be monitored, specify 0 for ID.
    With more than one server to be monitored, specify consecutive numbers (e.g., 0, 1, 2...).
  • Send polling time metrics

    Send polling time metrics

    Value

    Send

    1

    Do not send (default)

    0

    clpcfadm.py mod -t monitor/awsvipw@awsvipw1/perf/metrics/use --set <Value>

8.6.2.3. Monitor (special)

  • Action when AWS CLI command failed to receive response

    Action when AWS CLI command failed to receive response

    Value

    Disable recovery action(Do nothing) (default)

    0

    Disable recovery action(Display warning)

    1

    Recover

    2

    clpcfadm.py mod -t monitor/awsvipw@awsvipw1/parameters/mode --set <Value>

8.6.2.4. Recovery Action

  • Recovery target

    Recovery target

    Recovery target type

    Local server

    LocalServer

    cls

    All groups([All Groups])

    ""

    grp

    Failover group name

    (Failover group name)

    grp

    Group resource name

    (Group resource name)

    rsc

    clpcfadm.py mod -t monitor/awsvipw@awsvipw1/relation/name --set <Recovery target> --nocheck
    clpcfadm.py mod -t monitor/awsvipw@awsvipw1/relation/type --set <Recovery target type> --nocheck

    Important

    If you set "Recovery target" to "Local server"

    Set "Maximum Reactivation Count" and "Maximum Failover Count" to 0 (times).

    clpcfadm.py mod -t monitor/awsvipw@awsvipw1/emergency/threshold/restart --set 0
    clpcfadm.py mod -t monitor/awsvipw@awsvipw1/emergency/threshold/fo2 --set 0

    If the current setting for "Final Action" is "Stop resource (16)" or "Stop Group (2)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/awsvipw@awsvipw1/emergency/action --set 1

    Important

    If you set "Recovery target" to "All groups ([All Groups])"

    Set "Maximum Reactivation Count" to 0 (times).

    clpcfadm.py mod -t monitor/awsvipw@awsvipw1/emergency/threshold/restart --set 0

    If the current setting for "Final Action" is "Stop resource (16)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/awsvipw@awsvipw1/emergency/action --set 1
  • Recovery Script Execution Count

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/awsvipw@awsvipw1/emergency/threshold/script --set <Value>
  • Execute Script before Reactivation

    Execute Script before Reactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/awsvipw@awsvipw1/emergency/preaction/userestart --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Maximum Reactivation Count

    Default, 3 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/awsvipw@awsvipw1/emergency/threshold/restart --set <Value>
  • Execute Script before Failover

    Execute Script before Failover

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/awsvipw@awsvipw1/emergency/preaction/usefailover --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Failover Target Server

    Failover Target Server

    Value

    Stable server (default)

    1

    Maximum priority server

    0

    clpcfadm.py mod -t monitor/awsvipw@awsvipw1/emergency/mode --set <Value>
  • Maximum Failover Count

    Default, 1 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/awsvipw@awsvipw1/emergency/threshold/fo2 --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/awsvipw@awsvipw1/emergency/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Final Action

    Final Action
    Value

    No operation (default)

    1

    Stop resource 15

    16

    Stop group 16

    2

    Stop the cluster service

    3

    Stop the cluster service and shutdown OS

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t monitor/awsvipw@awsvipw1/emergency/action --set <Value>
    15

    Cannot be specified with "Recovery target type" set to "cls" or "grp".

    16

    Cannot be specified with "Recovery target type" set to "cls".

Script Settings
  • File type

    Script file type

    Value

    Script created with this product (default)

    1

    User Application

    0

    clpcfadm.py mod -t monitor/awsvipw@awsvipw1/emergency/preaction/default --set <Value>

    Note

    If you change the value of this parameter, also change that of "File".

  • File (Within 1023 bytes)

    clpcfadm.py mod -t monitor/awsvipw@awsvipw1/emergency/preaction/path --set <File> --nocheck

    Note

    If you specify "Script created with this product", specify preaction.bat.

    clpcfadm.py mod -t monitor/awsvipw@awsvipw1/emergency/preaction/path --set preaction.bat --nocheck
  • Timeout (sec)

    Default, 5 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t monitor/awsvipw@awsvipw1/emergency/preaction/timeout --set <Value>
  • Exec User

    clpcfadm.py mod -t monitor/awsvipw@awsvipw1/emergency/preaction/account --set <Exec User>

8.6.3. Deleting an AWS Virtual IP monitor resource

Delete a resource by specifying the monitor resource type and monitor resource name.

clpcfadm.py del mon awsvipw awsvipw1

8.7. Azure DNS monitor resource

Note

The command lines in this section use azurednsw1 as the monitor resource name.
Change it to suit your environment.

8.7.1. Adding an Azure DNS monitor resource

Be sure to set the following items. For details, see "Setting Azure DNS monitor resource parameters".

Item (mandatory)

Monitor resource name

Target Resource (monitored when active)

Recovery target

Recovery target type

clpcfadm.py add mon azurednsw azurednsw1
clpcfadm.py mod -t monitor/azurednsw@azurednsw1/target --set <Target Resource (monitored when active)>
clpcfadm.py mod -t monitor/azurednsw@azurednsw1/relation/name --set <Recovery target> --nocheck
clpcfadm.py mod -t monitor/azurednsw@azurednsw1/relation/type --set <Recovery target type> --nocheck

Note

If you configure a cluster only with the above mandatory items, other parameters are set to their default values.

8.7.2. Setting Azure DNS monitor resource parameters

8.7.2.1. Basic information

  • Monitor resource name (Within 31 bytes)

    This is set when the resource is added. To change the monitor resource name, delete the resource and set it again.

  • Comment (Within 127 bytes)

    clpcfadm.py mod -t monitor/azurednsw@azurednsw1/comment --set <Comment>

    Note

    Enclose in double quotes a string including spaces (e.g., "Sample Comment").

8.7.2.2. Monitor (common)

  • Interval (sec)

    Default, 60 (minimum, 1; maximum, 999)

    clpcfadm.py mod -t monitor/azurednsw@azurednsw1/polling/interval --set <Value>
  • Timeout (sec)

    Default, 180 (minimum, 5; maximum, 999)

    clpcfadm.py mod -t monitor/azurednsw@azurednsw1/polling/timeout --set <Value>
  • Do Not Retry at Timeout Occurrence

    Do Not Retry at Timeout Occurrence

    Value

    Retry

    0

    Do not retry (default)

    1

    clpcfadm.py mod -t monitor/azurednsw@azurednsw1/emergency/timeout/notreconfirmation/use --set <Value>
  • Action at Timeout Occurrence

    Action at Timeout Occurrence

    Value

    Recover

    0

    Do not recover (default)

    1

    Generate an intentional stop error

    2

    clpcfadm.py mod -t monitor/azurednsw@azurednsw1/emergency/timeout/notrecovery/use --set <Value>

    Note

    Set as above with "Do Not Retry at Timeout Occurrence" set to "Do not retry".

  • Retry Count

    Default, 1 (minimum, 0; maximum, 999)

    clpcfadm.py mod -t monitor/azurednsw@azurednsw1/polling/reconfirmation --set <Value>
  • Wait Time to Start Monitoring (sec)

    Default, 60 (minimum, 0; maximum, 9999)

    clpcfadm.py mod -t monitor/azurednsw@azurednsw1/firstmonwait --set <Value>
  • Target Resource (monitored when active)

    clpcfadm.py mod -t monitor/azurednsw@azurednsw1/target --set <Target Resource (monitored when active)>

    Note

    You can specify only an Azure DNS resource for this monitor resource.

  • Choose servers that execute monitoring

    clpcfadm.py mod -t monitor/azurednsw@azurednsw1/polling/servers@<ID>/name --set <Server name> --nocheck

    Note

    With only one server to be monitored, specify 0 for ID.
    With more than one server to be monitored, specify consecutive numbers (e.g., 0, 1, 2...).
  • Send polling time metrics

    Send polling time metrics

    Value

    Send

    1

    Do not send (default)

    0

    clpcfadm.py mod -t monitor/azurednsw@azurednsw1/perf/metrics/use --set <Value>

8.7.2.3. Monitor (special)

  • Check Name Resolution

    Check Name Resolution

    Value

    Check Name Resolution (default)

    1

    Do not check name resolution

    0

    clpcfadm.py mod -t monitor/azurednsw@azurednsw1/parameters/dnscheck --set <Value>

8.7.2.4. Recovery Action

  • Recovery target

    Recovery target

    Recovery target type

    Local server

    LocalServer

    cls

    All groups([All Groups])

    ""

    grp

    Failover group name

    (Failover group name)

    grp

    Group resource name

    (Group resource name)

    rsc

    clpcfadm.py mod -t monitor/azurednsw@azurednsw1/relation/name --set <Recovery target> --nocheck
    clpcfadm.py mod -t monitor/azurednsw@azurednsw1/relation/type --set <Recovery target type> --nocheck

    Important

    If you set "Recovery target" to "Local server"

    Set "Maximum Reactivation Count" and "Maximum Failover Count" to 0 (times).

    clpcfadm.py mod -t monitor/azurednsw@azurednsw1/emergency/threshold/restart --set 0
    clpcfadm.py mod -t monitor/azurednsw@azurednsw1/emergency/threshold/fo2 --set 0

    If the current setting for "Final Action" is "Stop resource (16)" or "Stop Group (2)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/azurednsw@azurednsw1/emergency/action --set 1

    Important

    If you set "Recovery target" to "All groups ([All Groups])"

    Set "Maximum Reactivation Count" to 0 (times).

    clpcfadm.py mod -t monitor/azurednsw@azurednsw1/emergency/threshold/restart --set 0

    If the current setting for "Final Action" is "Stop resource (16)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/azurednsw@azurednsw1/emergency/action --set 1
  • Recovery Script Execution Count

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/azurednsw@azurednsw1/emergency/threshold/script --set <Value>
  • Execute Script before Reactivation

    Execute Script before Reactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/azurednsw@azurednsw1/emergency/preaction/userestart --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Maximum Reactivation Count

    Default, 3 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/azurednsw@azurednsw1/emergency/threshold/restart --set <Value>
  • Execute Script before Failover

    Execute Script before Failover

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/azurednsw@azurednsw1/emergency/preaction/usefailover --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Failover Target Server

    Failover Target Server

    Value

    Stable server (default)

    1

    Maximum priority server

    0

    clpcfadm.py mod -t monitor/azurednsw@azurednsw1/emergency/mode --set <Value>
  • Maximum Failover Count

    Default, 1 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/azurednsw@azurednsw1/emergency/threshold/fo2 --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/azurednsw@azurednsw1/emergency/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Final Action

    Final Action
    Value

    No operation (default)

    1

    Stop resource 17

    16

    Stop group 18

    2

    Stop the cluster service

    3

    Stop the cluster service and shutdown OS

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t monitor/azurednsw@azurednsw1/emergency/action --set <Value>
    17

    Cannot be specified with "Recovery target type" set to "cls" or "grp".

    18

    Cannot be specified with "Recovery target type" set to "cls".

Script Settings
  • File type

    Script file type

    Value

    Script created with this product (default)

    1

    User Application

    0

    clpcfadm.py mod -t monitor/azurednsw@azurednsw1/emergency/preaction/default --set <Value>

    Note

    If you change the value of this parameter, also change that of "File".

  • File (Within 1023 bytes)

    clpcfadm.py mod -t monitor/azurednsw@azurednsw1/emergency/preaction/path --set <File> --nocheck

    Note

    If you specify "Script created with this product", specify preaction.bat.

    clpcfadm.py mod -t monitor/azurednsw@azurednsw1/emergency/preaction/path --set preaction.bat --nocheck
  • Timeout (sec)

    Default, 5 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t monitor/azurednsw@azurednsw1/emergency/preaction/timeout --set <Value>
  • Exec User

    clpcfadm.py mod -t monitor/azurednsw@azurednsw1/emergency/preaction/account --set <Exec User>

8.7.3. Deleting an Azure DNS monitor resource

Delete a resource by specifying the monitor resource type and monitor resource name.

clpcfadm.py del mon azurednsw azurednsw1

8.8. Azure load balance monitor resource

Note

The command lines in this section use azurelbw1 as the monitor resource name.
Change it to suit your environment.

8.8.1. Adding an Azure load balance monitor resource

Be sure to set the following items. For details, see "Setting Azure load balance monitor resource parameters".

Item (mandatory)

Monitor resource name

Target Resource

Recovery target

Recovery target type

clpcfadm.py add mon azurelbw azurelbw1
clpcfadm.py mod -t monitor/azurelbw@azurelbw1/parameters/object --set <Target Resource>
clpcfadm.py mod -t monitor/azurelbw@azurelbw1/relation/name --set <Recovery target> --nocheck
clpcfadm.py mod -t monitor/azurelbw@azurelbw1/relation/type --set <Recovery target type> --nocheck

Note

If you configure a cluster only with the above mandatory items, other parameters are set to their default values.

8.8.2. Setting Azure load balance monitor resource parameters

8.8.2.1. Basic information

  • Monitor resource name (Within 31 bytes)

    This is set when the resource is added. To change the monitor resource name, delete the resource and set it again.

  • Comment (Within 127 bytes)

    clpcfadm.py mod -t monitor/azurelbw@azurelbw1/comment --set <Comment>

    Note

    Enclose in double quotes a string including spaces (e.g., "Sample Comment").

8.8.2.2. Monitor (common)

  • Interval (sec)

    Default, 60 (minimum, 1; maximum, 999)

    clpcfadm.py mod -t monitor/azurelbw@azurelbw1/polling/interval --set <Value>
  • Timeout (sec)

    Default, 180 (minimum, 5; maximum, 999)

    clpcfadm.py mod -t monitor/azurelbw@azurelbw1/polling/timeout --set <Value>
  • Do Not Retry at Timeout Occurrence

    Do Not Retry at Timeout Occurrence

    Value

    Retry

    0

    Do not retry (default)

    1

    clpcfadm.py mod -t monitor/azurelbw@azurelbw1/emergency/timeout/notreconfirmation/use --set <Value>
  • Action at Timeout Occurrence

    Action at Timeout Occurrence

    Value

    Recover

    0

    Do not recover (default)

    1

    Generate an intentional stop error

    2

    clpcfadm.py mod -t monitor/azurelbw@azurelbw1/emergency/timeout/notrecovery/use --set <Value>

    Note

    Set as above with "Do Not Retry at Timeout Occurrence" set to "Do not retry".

  • Retry Count

    Default, 1 (minimum, 0; maximum, 999)

    clpcfadm.py mod -t monitor/azurelbw@azurelbw1/polling/reconfirmation --set <Value>
  • Wait Time to Start Monitoring (sec)

    Default, 0 (minimum, 0; maximum, 9999)

    clpcfadm.py mod -t monitor/azurelbw@azurelbw1/firstmonwait --set <Value>
  • Choose servers that execute monitoring

    clpcfadm.py mod -t monitor/azurelbw@azurelbw1/polling/servers@<ID>/name --set <Server name> --nocheck

    Note

    With only one server to be monitored, specify 0 for ID.
    With more than one server to be monitored, specify consecutive numbers (e.g., 0, 1, 2...).
  • Send polling time metrics

    Send polling time metrics

    Value

    Send

    1

    Do not send (default)

    0

    clpcfadm.py mod -t monitor/azurelbw@azurelbw1/perf/metrics/use --set <Value>

8.8.2.3. Monitor (special)

  • Target Resource

    clpcfadm.py mod -t monitor/azurelbw@azurelbw1/parameters/object --set <Target Resource>

    Note

    You can specify only an Azure probe port resource.

8.8.2.4. Recovery Action

  • Recovery target

    Recovery target

    Recovery target type

    Local server

    LocalServer

    cls

    All groups([All Groups])

    ""

    grp

    Failover group name

    (Failover group name)

    grp

    Group resource name

    (Group resource name)

    rsc

    clpcfadm.py mod -t monitor/azurelbw@azurelbw1/relation/name --set <Recovery target> --nocheck
    clpcfadm.py mod -t monitor/azurelbw@azurelbw1/relation/type --set <Recovery target type> --nocheck

    Important

    If you set "Recovery target" to "Local server"

    Set "Maximum Reactivation Count" and "Maximum Failover Count" to 0 (times).

    clpcfadm.py mod -t monitor/azurelbw@azurelbw1/emergency/threshold/restart --set 0
    clpcfadm.py mod -t monitor/azurelbw@azurelbw1/emergency/threshold/fo2 --set 0

    If the current setting for "Final Action" is "Stop resource (16)" or "Stop Group (2)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/azurelbw@azurelbw1/emergency/action --set 1

    Important

    If you set "Recovery target" to "All groups ([All Groups])"

    Set "Maximum Reactivation Count" to 0 (times).

    clpcfadm.py mod -t monitor/azurelbw@azurelbw1/emergency/threshold/restart --set 0

    If the current setting for "Final Action" is "Stop resource (16)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/azurelbw@azurelbw1/emergency/action --set 1
  • Recovery Script Execution Count

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/azurelbw@azurelbw1/emergency/threshold/script --set <Value>
  • Execute Script before Reactivation

    Execute Script before Reactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/azurelbw@azurelbw1/emergency/preaction/userestart --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Maximum Reactivation Count

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/azurelbw@azurelbw1/emergency/threshold/restart --set <Value>
  • Execute Script before Failover

    Execute Script before Failover

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/azurelbw@azurelbw1/emergency/preaction/usefailover --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Failover Target Server

    Failover Target Server

    Value

    Stable server (default)

    1

    Maximum priority server

    0

    clpcfadm.py mod -t monitor/azurelbw@azurelbw1/emergency/mode --set <Value>
  • Maximum Failover Count

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/azurelbw@azurelbw1/emergency/threshold/fo2 --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/azurelbw@azurelbw1/emergency/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Final Action

    Final Action
    Value

    No operation (default)

    1

    Stop resource 19

    16

    Stop group 20

    2

    Stop the cluster service

    3

    Stop the cluster service and shutdown OS

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t monitor/azurelbw@azurelbw1/emergency/action --set <Value>
    19

    Cannot be specified with "Recovery target type" set to "cls" or "grp".

    20

    Cannot be specified with "Recovery target type" set to "cls".

Script Settings
  • File type

    Script file type

    Value

    Script created with this product (default)

    1

    User Application

    0

    clpcfadm.py mod -t monitor/azurelbw@azurelbw1/emergency/preaction/default --set <Value>

    Note

    If you change the value of this parameter, also change that of "File".

  • File (Within 1023 bytes)

    clpcfadm.py mod -t monitor/azurelbw@azurelbw1/emergency/preaction/path --set <File> --nocheck

    Note

    If you specify "Script created with this product", specify preaction.bat.

    clpcfadm.py mod -t monitor/azurelbw@azurelbw1/emergency/preaction/path --set preaction.bat --nocheck
  • Timeout (sec)

    Default, 5 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t monitor/azurelbw@azurelbw1/emergency/preaction/timeout --set <Value>
  • Exec User

    clpcfadm.py mod -t monitor/azurelbw@azurelbw1/emergency/preaction/account --set <Exec User>

8.8.3. Deleting an Azure load balance monitor resource

Delete a resource by specifying the monitor resource type and monitor resource name.

clpcfadm.py del mon azurelbw azurelbw1

8.9. Azure probe port monitor resource

Note

The command lines in this section use azureppw1 as the monitor resource name.
Change it to suit your environment.

8.9.1. Adding an Azure probe port monitor resource

Be sure to set the following items. For details, see "Setting Azure probe port monitor resource parameters".

Item (mandatory)

Monitor resource name

Target Resource (monitored when active)

Recovery target

Recovery target type

clpcfadm.py add mon azureppw azureppw1
clpcfadm.py mod -t monitor/azureppw@azureppw1/target --set <Target Resource (monitored when active)>
clpcfadm.py mod -t monitor/azureppw@azureppw1/relation/name --set <Recovery target> --nocheck
clpcfadm.py mod -t monitor/azureppw@azureppw1/relation/type --set <Recovery target type> --nocheck

Note

If you configure a cluster only with the above mandatory items, other parameters are set to their default values.

8.9.2. Setting Azure probe port monitor resource parameters

8.9.2.1. Basic information

  • Monitor resource name (Within 31 bytes)

    This is set when the resource is added. To change the monitor resource name, delete the resource and set it again.

  • Comment (Within 127 bytes)

    clpcfadm.py mod -t monitor/azureppw@azureppw1/comment --set <Comment>

    Note

    Enclose in double quotes a string including spaces (e.g., "Sample Comment").

8.9.2.2. Monitor (common)

  • Interval (sec)

    Default, 60 (minimum, 1; maximum, 999)

    clpcfadm.py mod -t monitor/azureppw@azureppw1/polling/interval --set <Value>
  • Timeout (sec)

    Default, 180 (minimum, 5; maximum, 999)

    clpcfadm.py mod -t monitor/azureppw@azureppw1/polling/timeout --set <Value>
  • Do Not Retry at Timeout Occurrence

    Do Not Retry at Timeout Occurrence

    Value

    Retry

    0

    Do not retry (default)

    1

    clpcfadm.py mod -t monitor/azureppw@azureppw1/emergency/timeout/notreconfirmation/use --set <Value>
  • Action at Timeout Occurrence

    Action at Timeout Occurrence

    Value

    Recover

    0

    Do not recover (default)

    1

    Generate an intentional stop error

    2

    clpcfadm.py mod -t monitor/azureppw@azureppw1/emergency/timeout/notrecovery/use --set <Value>

    Note

    Set as above with "Do Not Retry at Timeout Occurrence" set to "Do not retry".

  • Retry Count

    Default, 1 (minimum, 0; maximum, 999)

    clpcfadm.py mod -t monitor/azureppw@azureppw1/polling/reconfirmation --set <Value>
  • Wait Time to Start Monitoring (sec)

    Default, 0 (minimum, 0; maximum, 9999)

    clpcfadm.py mod -t monitor/azureppw@azureppw1/firstmonwait --set <Value>
  • Target Resource (monitored when active)

    clpcfadm.py mod -t monitor/azureppw@azureppw1/target --set <Target Resource (monitored when active)>

    Note

    You can specify only an Azure probe port resource for this monitor resource.

  • Choose servers that execute monitoring

    clpcfadm.py mod -t monitor/azureppw@azureppw1/polling/servers@<ID>/name --set <Server name> --nocheck

    Note

    With only one server to be monitored, specify 0 for ID.
    With more than one server to be monitored, specify consecutive numbers (e.g., 0, 1, 2...).
  • Send polling time metrics

    Send polling time metrics

    Value

    Send

    1

    Do not send (default)

    0

    clpcfadm.py mod -t monitor/azureppw@azureppw1/perf/metrics/use --set <Value>

8.9.2.3. Monitor (special)

  • Action when Probe port wait timeout

    Action when Probe port wait timeout

    Value

    Disable recovery action(Do nothing) (default)

    0

    Disable recovery action(Display warning)

    1

    Recover

    2

    clpcfadm.py mod -t monitor/azureppw@azureppw1/parameters/mode --set <Value>

8.9.2.4. Recovery Action

  • Recovery target

    Recovery target

    Recovery target type

    Local server

    LocalServer

    cls

    All groups([All Groups])

    ""

    grp

    Failover group name

    (Failover group name)

    grp

    Group resource name

    (Group resource name)

    rsc

    clpcfadm.py mod -t monitor/azureppw@azureppw1/relation/name --set <Recovery target> --nocheck
    clpcfadm.py mod -t monitor/azureppw@azureppw1/relation/type --set <Recovery target type> --nocheck

    Important

    If you set "Recovery target" to "Local server"

    Set "Maximum Reactivation Count" and "Maximum Failover Count" to 0 (times).

    clpcfadm.py mod -t monitor/azureppw@azureppw1/emergency/threshold/restart --set 0
    clpcfadm.py mod -t monitor/azureppw@azureppw1/emergency/threshold/fo2 --set 0

    If the current setting for "Final Action" is "Stop resource (16)" or "Stop Group (2)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/azureppw@azureppw1/emergency/action --set 1

    Important

    If you set "Recovery target" to "All groups ([All Groups])"

    Set "Maximum Reactivation Count" to 0 (times).

    clpcfadm.py mod -t monitor/azureppw@azureppw1/emergency/threshold/restart --set 0

    If the current setting for "Final Action" is "Stop resource (16)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/azureppw@azureppw1/emergency/action --set 1
  • Recovery Script Execution Count

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/azureppw@azureppw1/emergency/threshold/script --set <Value>
  • Execute Script before Reactivation

    Execute Script before Reactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/azureppw@azureppw1/emergency/preaction/userestart --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Maximum Reactivation Count

    Default, 3 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/azureppw@azureppw1/emergency/threshold/restart --set <Value>
  • Execute Script before Failover

    Execute Script before Failover

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/azureppw@azureppw1/emergency/preaction/usefailover --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Failover Target Server

    Failover Target Server

    Value

    Stable server (default)

    1

    Maximum priority server

    0

    clpcfadm.py mod -t monitor/azureppw@azureppw1/emergency/mode --set <Value>
  • Maximum Failover Count

    Default, 1 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/azureppw@azureppw1/emergency/threshold/fo2 --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/azureppw@azureppw1/emergency/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Final Action

    Final Action
    Value

    No operation (default)

    1

    Stop resource 21

    16

    Stop group 22

    2

    Stop the cluster service

    3

    Stop the cluster service and shutdown OS

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t monitor/azureppw@azureppw1/emergency/action --set <Value>
    21

    Cannot be specified with "Recovery target type" set to "cls" or "grp".

    22

    Cannot be specified with "Recovery target type" set to "cls".

Script Settings
  • File type

    Script file type

    Value

    Script created with this product (default)

    1

    User Application

    0

    clpcfadm.py mod -t monitor/azureppw@azureppw1/emergency/preaction/default --set <Value>

    Note

    If you change the value of this parameter, also change that of "File".

  • File (Within 1023 bytes)

    clpcfadm.py mod -t monitor/azureppw@azureppw1/emergency/preaction/path --set <File> --nocheck

    Note

    If you specify "Script created with this product", specify preaction.bat.

    clpcfadm.py mod -t monitor/azureppw@azureppw1/emergency/preaction/path --set preaction.bat --nocheck
  • Timeout (sec)

    Default, 5 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t monitor/azureppw@azureppw1/emergency/preaction/timeout --set <Value>
  • Exec User

    clpcfadm.py mod -t monitor/azureppw@azureppw1/emergency/preaction/account --set <Exec User>

8.9.3. Deleting an Azure probe port monitor resource

Delete a resource by specifying the monitor resource type and monitor resource name.

clpcfadm.py del mon azureppw azureppw1

8.10. CIFS monitor resource

Note

The command lines in this section use cifsw1 as the monitor resource name.
Change it to suit your environment.

8.10.1. Adding a CIFS monitor resource

Be sure to set the following items. For details, see "Setting CIFS monitor resource parameters".

Item (mandatory)

Monitor resource name

Target Resource (monitored when active)

Recovery target

Recovery target type

clpcfadm.py add mon cifsw cifsw1
clpcfadm.py mod -t monitor/cifsw@cifsw1/target --set <Target Resource (monitored when active)>
clpcfadm.py mod -t monitor/cifsw@cifsw1/relation/name --set <Recovery target> --nocheck
clpcfadm.py mod -t monitor/cifsw@cifsw1/relation/type --set <Recovery target type> --nocheck

Note

If you configure a cluster only with the above mandatory items, other parameters are set to their default values.

8.10.2. Setting CIFS monitor resource parameters

8.10.2.1. Basic information

  • Monitor resource name (Within 31 bytes)

    This is set when the resource is added. To change the monitor resource name, delete the resource and set it again.

  • Comment (Within 127 bytes)

    clpcfadm.py mod -t monitor/cifsw@cifsw1/comment --set <Comment>

    Note

    Enclose in double quotes a string including spaces (e.g., "Sample Comment").

8.10.2.2. Monitor (common)

  • Interval (sec)

    Default, 60 (minimum, 1; maximum, 999)

    clpcfadm.py mod -t monitor/cifsw@cifsw1/polling/interval --set <Value>
  • Timeout (sec)

    Default, 60 (minimum, 5; maximum, 999)

    clpcfadm.py mod -t monitor/cifsw@cifsw1/polling/timeout --set <Value>
  • Do Not Retry at Timeout Occurrence

    Do Not Retry at Timeout Occurrence

    Value

    Retry (default)

    0

    Do not retry

    1

    clpcfadm.py mod -t monitor/cifsw@cifsw1/emergency/timeout/notreconfirmation/use --set <Value>
  • Action at Timeout Occurrence

    Action at Timeout Occurrence

    Value

    Recover (default)

    0

    Do not recover

    1

    Generate an intentional stop error

    2

    clpcfadm.py mod -t monitor/cifsw@cifsw1/emergency/timeout/notrecovery/use --set <Value>

    Note

    Set as above with "Do Not Retry at Timeout Occurrence" set to "Do not retry".

  • Retry Count

    Default, 1 (minimum, 0; maximum, 999)

    clpcfadm.py mod -t monitor/cifsw@cifsw1/polling/reconfirmation --set <Value>
  • Wait Time to Start Monitoring (sec)

    Default, 0 (minimum, 0; maximum, 9999)

    clpcfadm.py mod -t monitor/cifsw@cifsw1/firstmonwait --set <Value>
  • Target Resource (monitored when active)

    clpcfadm.py mod -t monitor/cifsw@cifsw1/target --set <Target Resource (monitored when active)>

    Note

    You can specify only a CIFS resource for this monitor resource.

  • Choose servers that execute monitoring

    clpcfadm.py mod -t monitor/cifsw@cifsw1/polling/servers@<ID>/name --set <Server name> --nocheck

    Note

    With only one server to be monitored, specify 0 for ID.
    With more than one server to be monitored, specify consecutive numbers (e.g., 0, 1, 2...).
  • Send polling time metrics

    Send polling time metrics

    Value

    Send

    1

    Do not send (default)

    0

    clpcfadm.py mod -t monitor/cifsw@cifsw1/perf/metrics/use --set <Value>

8.10.2.3. Monitor (special)

  • Access check

    Access check

    Value

    Do not perform (default)

    0

    Folder check

    1

    File check

    2

    clpcfadm.py mod -t monitor/cifsw@cifsw1/parameters/accesscheck --set <Value>
    • Path (Within 255 bytes)

      clpcfadm.py mod -t monitor/cifsw@cifsw1/parameters/checkpath --set <Path>

      Note

      Set as above with "Access check" set to "Folder check" or "File check".

    • Check

      Check

      Value

      Read and write

      1

      Read (default)

      0

      clpcfadm.py mod -t monitor/cifsw@cifsw1/parameters/checkmethod --set <Value>

      Note

      Set as above with "Access check" set to "File check".

8.10.2.4. Recovery Action

  • Recovery target

    Recovery target

    Recovery target type

    Local server

    LocalServer

    cls

    All groups([All Groups])

    ""

    grp

    Failover group name

    (Failover group name)

    grp

    Group resource name

    (Group resource name)

    rsc

    clpcfadm.py mod -t monitor/cifsw@cifsw1/relation/name --set <Recovery target> --nocheck
    clpcfadm.py mod -t monitor/cifsw@cifsw1/relation/type --set <Recovery target type> --nocheck

    Important

    If you set "Recovery target" to "Local server"

    Set "Maximum Reactivation Count" and "Maximum Failover Count" to 0 (times).

    clpcfadm.py mod -t monitor/cifsw@cifsw1/emergency/threshold/restart --set 0
    clpcfadm.py mod -t monitor/cifsw@cifsw1/emergency/threshold/fo2 --set 0

    If the current setting for "Final Action" is "Stop resource (16)" or "Stop Group (2)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/cifsw@cifsw1/emergency/action --set 1

    Important

    If you set "Recovery target" to "All groups ([All Groups])"

    Set "Maximum Reactivation Count" to 0 (times).

    clpcfadm.py mod -t monitor/cifsw@cifsw1/emergency/threshold/restart --set 0

    If the current setting for "Final Action" is "Stop resource (16)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/cifsw@cifsw1/emergency/action --set 1
  • Recovery Script Execution Count

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/cifsw@cifsw1/emergency/threshold/script --set <Value>
  • Execute Script before Reactivation

    Execute Script before Reactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/cifsw@cifsw1/emergency/preaction/userestart --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Maximum Reactivation Count

    Default, 3 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/cifsw@cifsw1/emergency/threshold/restart --set <Value>
  • Execute Script before Failover

    Execute Script before Failover

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/cifsw@cifsw1/emergency/preaction/usefailover --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Failover Target Server

    Failover Target Server

    Value

    Stable server (default)

    1

    Maximum priority server

    0

    clpcfadm.py mod -t monitor/cifsw@cifsw1/emergency/mode --set <Value>
  • Maximum Failover Count

    Default, 1 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/cifsw@cifsw1/emergency/threshold/fo2 --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/cifsw@cifsw1/emergency/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Final Action

    Final Action
    Value

    No operation (default)

    1

    Stop resource 23

    16

    Stop group 24

    2

    Stop the cluster service

    3

    Stop the cluster service and shutdown OS

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t monitor/cifsw@cifsw1/emergency/action --set <Value>
    23

    Cannot be specified with "Recovery target type" set to "cls" or "grp".

    24

    Cannot be specified with "Recovery target type" set to "cls".

Script Settings
  • File type

    Script file type

    Value

    Script created with this product (default)

    1

    User Application

    0

    clpcfadm.py mod -t monitor/cifsw@cifsw1/emergency/preaction/default --set <Value>

    Note

    If you change the value of this parameter, also change that of "File".

  • File (Within 1023 bytes)

    clpcfadm.py mod -t monitor/cifsw@cifsw1/emergency/preaction/path --set <File> --nocheck

    Note

    If you specify "Script created with this product", specify preaction.bat.

    clpcfadm.py mod -t monitor/cifsw@cifsw1/emergency/preaction/path --set preaction.bat --nocheck
  • Timeout (sec)

    Default, 5 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t monitor/cifsw@cifsw1/emergency/preaction/timeout --set <Value>
  • Exec User

    clpcfadm.py mod -t monitor/cifsw@cifsw1/emergency/preaction/account --set <Exec User>

8.10.3. Deleting a CIFS monitor resource

Delete a resource by specifying the monitor resource type and monitor resource name.

clpcfadm.py del mon cifsw cifsw1

8.11. DB2 monitor resource

Note

The command lines in this section use db2w1 as the monitor resource name.
Change it to suit your environment.

8.11.1. Adding a DB2 monitor resource

Be sure to set the following items. For details, see "Setting DB2 monitor resource parameters".

Item (mandatory)

Monitor resource name

Target Resource (monitored when active)

Database Name

Recovery target

Recovery target type

clpcfadm.py add mon db2w db2w1
clpcfadm.py mod -t monitor/db2w@db2w1/target --set <Target Resource (monitored when active)>
clpcfadm.py mod -t monitor/db2w@db2w1/agentparam/dbname --set <Database Name> --nocheck
clpcfadm.py mod -t monitor/db2w@db2w1/relation/name --set <Recovery target> --nocheck
clpcfadm.py mod -t monitor/db2w@db2w1/relation/type --set <Recovery target type> --nocheck

Note

If you configure a cluster only with the above mandatory items, other parameters are set to their default values.

8.11.2. Setting DB2 monitor resource parameters

8.11.2.1. Basic information

  • Monitor resource name (Within 31 bytes)

    This is set when the resource is added. To change the monitor resource name, delete the resource and set it again.

  • Comment (Within 127 bytes)

    clpcfadm.py mod -t monitor/db2w@db2w1/comment --set <Comment>

    Note

    Enclose in double quotes a string including spaces (e.g., "Sample Comment").

8.11.2.2. Monitor (common)

  • Interval (sec)

    Default, 60 (minimum, 1; maximum, 999)

    clpcfadm.py mod -t monitor/db2w@db2w1/polling/interval --set <Value>
  • Timeout (sec)

    Default, 120 (minimum, 5; maximum, 999)

    clpcfadm.py mod -t monitor/db2w@db2w1/polling/timeout --set <Value>
  • Do Not Retry at Timeout Occurrence

    Do Not Retry at Timeout Occurrence

    Value

    Retry (default)

    0

    Do not retry

    1

    clpcfadm.py mod -t monitor/db2w@db2w1/emergency/timeout/notreconfirmation/use --set <Value>
  • Action at Timeout Occurrence

    Action at Timeout Occurrence

    Value

    Recover (default)

    0

    Do not recover

    1

    Generate an intentional stop error

    2

    clpcfadm.py mod -t monitor/db2w@db2w1/emergency/timeout/notrecovery/use --set <Value>

    Note

    Set as above with "Do Not Retry at Timeout Occurrence" set to "Do not retry".

  • Retry Count

    Default, 2 (minimum, 0; maximum, 999)

    clpcfadm.py mod -t monitor/db2w@db2w1/polling/reconfirmation --set <Value>
  • Wait Time to Start Monitoring (sec)

    Default, 0 (minimum, 0; maximum, 9999)

    clpcfadm.py mod -t monitor/db2w@db2w1/firstmonwait --set <Value>
  • Target Resource (monitored when active)

    clpcfadm.py mod -t monitor/db2w@db2w1/target --set <Target Resource (monitored when active)>
  • Choose servers that execute monitoring

    clpcfadm.py mod -t monitor/db2w@db2w1/polling/servers@<ID>/name --set <Server name> --nocheck

    Note

    With only one server to be monitored, specify 0 for ID.
    With more than one server to be monitored, specify consecutive numbers (e.g., 0, 1, 2...).
  • Send polling time metrics

    Send polling time metrics

    Value

    Send

    1

    Do not send (default)

    0

    clpcfadm.py mod -t monitor/db2w@db2w1/perf/metrics/use --set <Value>

8.11.2.3. Monitor (special)

  • Monitor Level

    Monitor Level

    Value

    Level 1 (monitoring by select)

    3

    Level 2 (monitoring by update/select) (default)

    0

    clpcfadm.py mod -t monitor/db2w@db2w1/agentparam/docreatedrop --set <Value>
  • Database Name (Within 255 bytes)

    clpcfadm.py mod -t monitor/db2w@db2w1/agentparam/dbname --set <Database Name> --nocheck
  • Instance Name (Within 255 bytes)

    Default: DB2

    clpcfadm.py mod -t monitor/db2w@db2w1/agentparam/instance --set <Instance Name>
  • User Name (Within 255 bytes)

    clpcfadm.py mod -t monitor/db2w@db2w1/agentparam/username --set <User Name>
  • Password (Within 255 bytes)

    clpcfadm.py mod -t monitor/db2w@db2w1/agentparam/password --set <Encrypted password>

    Note

    Set an encrypted password string.
  • Monitor Table Name (Within 255 bytes)

    Default: db2watch

    clpcfadm.py mod -t monitor/db2w@db2w1/agentparam/tablename --set <Monitor Table Name>

8.11.2.4. Recovery Action

  • Recovery target

    Recovery target

    Recovery target type

    Local server

    LocalServer

    cls

    All groups([All Groups])

    ""

    grp

    Failover group name

    (Failover group name)

    grp

    Group resource name

    (Group resource name)

    rsc

    clpcfadm.py mod -t monitor/db2w@db2w1/relation/name --set <Recovery target> --nocheck
    clpcfadm.py mod -t monitor/db2w@db2w1/relation/type --set <Recovery target type> --nocheck

    Important

    If you set "Recovery target" to "Local server"

    Set "Maximum Reactivation Count" and "Maximum Failover Count" to 0 (times).

    clpcfadm.py mod -t monitor/db2w@db2w1/emergency/threshold/restart --set 0
    clpcfadm.py mod -t monitor/db2w@db2w1/emergency/threshold/fo2 --set 0

    If the current setting for "Final Action" is "Stop resource (16)" or "Stop Group (2)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/db2w@db2w1/emergency/action --set 1

    Important

    If you set "Recovery target" to "All groups ([All Groups])"

    Set "Maximum Reactivation Count" to 0 (times).

    clpcfadm.py mod -t monitor/db2w@db2w1/emergency/threshold/restart --set 0

    If the current setting for "Final Action" is "Stop resource (16)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/db2w@db2w1/emergency/action --set 1
  • Recovery Script Execution Count

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/db2w@db2w1/emergency/threshold/script --set <Value>
  • Execute Script before Reactivation

    Execute Script before Reactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/db2w@db2w1/emergency/preaction/userestart --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Maximum Reactivation Count

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/db2w@db2w1/emergency/threshold/restart --set <Value>
  • Execute Script before Failover

    Execute Script before Failover

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/db2w@db2w1/emergency/preaction/usefailover --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Failover Target Server

    Failover Target Server

    Value

    Stable server (default)

    1

    Maximum priority server

    0

    clpcfadm.py mod -t monitor/db2w@db2w1/emergency/mode --set <Value>
  • Maximum Failover Count

    Default, 1 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/db2w@db2w1/emergency/threshold/fo2 --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/db2w@db2w1/emergency/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Final Action

    Final Action
    Value

    No operation

    1

    Stop resource 25

    16

    Stop group 26

    2

    Stop the cluster service

    3

    Stop the cluster service and shutdown OS (default)

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t monitor/db2w@db2w1/emergency/action --set <Value>
    25

    Cannot be specified with "Recovery target type" set to "cls" or "grp".

    26

    Cannot be specified with "Recovery target type" set to "cls".

Script Settings
  • File type

    Script file type

    Value

    Script created with this product (default)

    1

    User Application

    0

    clpcfadm.py mod -t monitor/db2w@db2w1/emergency/preaction/default --set <Value>

    Note

    If you change the value of this parameter, also change that of "File".

  • File (Within 1023 bytes)

    clpcfadm.py mod -t monitor/db2w@db2w1/emergency/preaction/path --set <File> --nocheck

    Note

    If you specify "Script created with this product", specify preaction.bat.

    clpcfadm.py mod -t monitor/db2w@db2w1/emergency/preaction/path --set preaction.bat --nocheck
  • Timeout (sec)

    Default, 5 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t monitor/db2w@db2w1/emergency/preaction/timeout --set <Value>
  • Exec User

    clpcfadm.py mod -t monitor/db2w@db2w1/emergency/preaction/account --set <Exec User>

8.11.3. Deleting a DB2 monitor resource

Delete a resource by specifying the monitor resource type and monitor resource name.

clpcfadm.py del mon db2w db2w1

8.12. Dynamic DNS monitor resource

Note

The command lines in this section use ddnsw1 as the monitor resource name.
Change it to suit your environment.

8.12.1. Adding a dynamic DNS monitor resource

Be sure to set the following items. For details, see "Setting dynamic DNS monitor resource parameters".

Item (mandatory)

Monitor resource name

Target Resource (monitored when active)

Recovery target

Recovery target type

clpcfadm.py add mon ddnsw ddnsw1
clpcfadm.py mod -t monitor/ddnsw@ddnsw1/target --set <Target Resource (monitored when active)>
clpcfadm.py mod -t monitor/ddnsw@ddnsw1/relation/name --set <Recovery target> --nocheck
clpcfadm.py mod -t monitor/ddnsw@ddnsw1/relation/type --set <Recovery target type> --nocheck

Note

If you configure a cluster only with the above mandatory items, other parameters are set to their default values.

8.12.2. Setting dynamic DNS monitor resource parameters

8.12.2.1. Basic information

  • Monitor resource name (Within 31 bytes)

    This is set when the resource is added. To change the monitor resource name, delete the resource and set it again.

  • Comment (Within 127 bytes)

    clpcfadm.py mod -t monitor/ddnsw@ddnsw1/comment --set <Comment>

    Note

    Enclose in double quotes a string including spaces (e.g., "Sample Comment").

8.12.2.2. Monitor (common)

  • Interval (sec)

    Default, 60 (minimum, 1; maximum, 999)

    clpcfadm.py mod -t monitor/ddnsw@ddnsw1/polling/interval --set <Value>
  • Timeout (sec)

    Default, 180 (minimum, 5; maximum, 999)

    clpcfadm.py mod -t monitor/ddnsw@ddnsw1/polling/timeout --set <Value>
  • Do Not Retry at Timeout Occurrence

    Do Not Retry at Timeout Occurrence

    Value

    Retry

    0

    Do not retry (default)

    1

    clpcfadm.py mod -t monitor/ddnsw@ddnsw1/emergency/timeout/notreconfirmation/use --set <Value>
  • Action at Timeout Occurrence

    Action at Timeout Occurrence

    Value

    Recover

    0

    Do not recover (default)

    1

    Generate an intentional stop error

    2

    clpcfadm.py mod -t monitor/ddnsw@ddnsw1/emergency/timeout/notrecovery/use --set <Value>

    Note

    Set as above with "Do Not Retry at Timeout Occurrence" set to "Do not retry".

  • Retry Count

    Default, 1 (minimum, 0; maximum, 999)

    clpcfadm.py mod -t monitor/ddnsw@ddnsw1/polling/reconfirmation --set <Value>
  • Wait Time to Start Monitoring (sec)

    Default, 0 (minimum, 0; maximum, 9999)

    clpcfadm.py mod -t monitor/ddnsw@ddnsw1/firstmonwait --set <Value>
  • Target Resource (monitored when active)

    clpcfadm.py mod -t monitor/ddnsw@ddnsw1/target --set <Target Resource (monitored when active)>

    Note

    You can specify only a dynamic DNS resource for this monitor resource.

  • Send polling time metrics

    Send polling time metrics

    Value

    Send

    1

    Do not send (default)

    0

    clpcfadm.py mod -t monitor/ddnsw@ddnsw1/perf/metrics/use --set <Value>

8.12.2.3. Monitor (special)

  • Check Name Resolution

    Check Name Resolution

    Value

    Check Name Resolution (default)

    1

    Do not check name resolution

    0

    clpcfadm.py mod -t monitor/ddnsw@ddnsw1/parameters/dnscheck --set <Value>

8.12.2.4. Recovery Action

  • Recovery target

    Recovery target

    Recovery target type

    Local server

    LocalServer

    cls

    All groups([All Groups])

    ""

    grp

    Failover group name

    (Failover group name)

    grp

    Group resource name

    (Group resource name)

    rsc

    clpcfadm.py mod -t monitor/ddnsw@ddnsw1/relation/name --set <Recovery target> --nocheck
    clpcfadm.py mod -t monitor/ddnsw@ddnsw1/relation/type --set <Recovery target type> --nocheck

    Important

    If you set "Recovery target" to "Local server"

    Set "Maximum Reactivation Count" and "Maximum Failover Count" to 0 (times).

    clpcfadm.py mod -t monitor/ddnsw@ddnsw1/emergency/threshold/restart --set 0
    clpcfadm.py mod -t monitor/ddnsw@ddnsw1/emergency/threshold/fo2 --set 0

    If the current setting for "Final Action" is "Stop resource (16)" or "Stop Group (2)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/ddnsw@ddnsw1/emergency/action --set 1

    Important

    If you set "Recovery target" to "All groups ([All Groups])"

    Set "Maximum Reactivation Count" to 0 (times).

    clpcfadm.py mod -t monitor/ddnsw@ddnsw1/emergency/threshold/restart --set 0

    If the current setting for "Final Action" is "Stop resource (16)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/ddnsw@ddnsw1/emergency/action --set 1
  • Recovery Script Execution Count

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/ddnsw@ddnsw1/emergency/threshold/script --set <Value>
  • Execute Script before Reactivation

    Execute Script before Reactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/ddnsw@ddnsw1/emergency/preaction/userestart --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Maximum Reactivation Count

    Default, 3 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/ddnsw@ddnsw1/emergency/threshold/restart --set <Value>
  • Execute Script before Failover

    Execute Script before Failover

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/ddnsw@ddnsw1/emergency/preaction/usefailover --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Failover Target Server

    Failover Target Server

    Value

    Stable server (default)

    1

    Maximum priority server

    0

    clpcfadm.py mod -t monitor/ddnsw@ddnsw1/emergency/mode --set <Value>
  • Maximum Failover Count

    Default, 1 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/ddnsw@ddnsw1/emergency/threshold/fo2 --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/ddnsw@ddnsw1/emergency/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Final Action

    Final Action
    Value

    No operation (default)

    1

    Stop resource 27

    16

    Stop group 28

    2

    Stop the cluster service

    3

    Stop the cluster service and shutdown OS

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t monitor/ddnsw@ddnsw1/emergency/action --set <Value>
    27

    Cannot be specified with "Recovery target type" set to "cls" or "grp".

    28

    Cannot be specified with "Recovery target type" set to "cls".

Script Settings
  • File type

    Script file type

    Value

    Script created with this product (default)

    1

    User Application

    0

    clpcfadm.py mod -t monitor/ddnsw@ddnsw1/emergency/preaction/default --set <Value>

    Note

    If you change the value of this parameter, also change that of "File".

  • File (Within 1023 bytes)

    clpcfadm.py mod -t monitor/ddnsw@ddnsw1/emergency/preaction/path --set <File> --nocheck

    Note

    If you specify "Script created with this product", specify preaction.bat.

    clpcfadm.py mod -t monitor/ddnsw@ddnsw1/emergency/preaction/path --set preaction.bat --nocheck
  • Timeout (sec)

    Default, 5 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t monitor/ddnsw@ddnsw1/emergency/preaction/timeout --set <Value>
  • Exec User

    clpcfadm.py mod -t monitor/ddnsw@ddnsw1/emergency/preaction/account --set <Exec User>

8.12.3. Deleting a dynamic DNS monitor resource

Delete a resource by specifying the monitor resource type and monitor resource name.

clpcfadm.py del mon ddnsw ddnsw1

8.13. Disk RW monitor resource

Note

The command lines in this section use diskw1 as the monitor resource name.
Change it to suit your environment.

8.13.1. Adding a disk RW monitor resource

Be sure to set the following items. For details, see "Setting disk RW monitor resource parameters".

Item (mandatory)

Monitor resource name

Target Resource (monitored when active)

Recovery target

Recovery target type

clpcfadm.py add mon diskw diskw1
clpcfadm.py mod -t monitor/diskw@diskw1/target --set <Target Resource (monitored when active)>
clpcfadm.py mod -t monitor/diskw@diskw1/relation/name --set <Recovery target> --nocheck
clpcfadm.py mod -t monitor/diskw@diskw1/relation/type --set <Recovery target type> --nocheck

Note

If you configure a cluster only with the above mandatory items, other parameters are set to their default values.

8.13.2. Setting disk RW monitor resource parameters

8.13.2.1. Basic information

  • Monitor resource name (Within 31 bytes)

    This is set when the resource is added. To change the monitor resource name, delete the resource and set it again.

  • Comment (Within 127 bytes)

    clpcfadm.py mod -t monitor/diskw@diskw1/comment --set <Comment>

    Note

    Enclose in double quotes a string including spaces (e.g., "Sample Comment").

8.13.2.2. Monitor (common)

  • Interval (sec)

    Default, 30 (minimum, 1; maximum, 999)

    clpcfadm.py mod -t monitor/diskw@diskw1/polling/interval --set <Value>
  • Timeout (sec)

    Default, 300 (minimum, 5; maximum, 999)

    clpcfadm.py mod -t monitor/diskw@diskw1/polling/timeout --set <Value>
  • Do Not Retry at Timeout Occurrence

    Do Not Retry at Timeout Occurrence

    Value

    Retry

    0

    Do not retry (default)

    1

    clpcfadm.py mod -t monitor/diskw@diskw1/emergency/timeout/notreconfirmation/use --set <Value>
  • Action at Timeout Occurrence

    Action at Timeout Occurrence

    Value

    Recover (default)

    0

    Do not recover

    1

    Generate an intentional stop error

    2

    clpcfadm.py mod -t monitor/diskw@diskw1/emergency/timeout/notrecovery/use --set <Value>

    Note

    Set as above with "Do Not Retry at Timeout Occurrence" set to "Do not retry".

  • Retry Count

    Default, 0 (minimum, 0; maximum, 999)

    clpcfadm.py mod -t monitor/diskw@diskw1/polling/reconfirmation --set <Value>
  • Wait Time to Start Monitoring (sec)

    Default, 0 (minimum, 0; maximum, 9999)

    clpcfadm.py mod -t monitor/diskw@diskw1/firstmonwait --set <Value>
  • Monitoring Timing

    Monitoring Timing

    Value

    Always

    0

    Active (default)

    1

    clpcfadm.py mod -t monitor/diskw@diskw1/polling/timing --set <Value>

    Note

    If "Monitoring Timing" is set to "Active", set "Target Resource (monitored when active)".

    Important

    If you change the setting for "Monitoring timing" to "Always", set "Target Resource" to blank ("").

    clpcfadm.py mod -t monitor/diskw@diskw1/target --set ""
  • Target Resource (monitored when active)

    clpcfadm.py mod -t monitor/diskw@diskw1/target --set <Target Resource (monitored when active)>

    Note

    Set as above with "Monitoring Timing" set to "Active".

  • Choose servers that execute monitoring

    clpcfadm.py mod -t monitor/diskw@diskw1/polling/servers@<ID>/name --set <Server name> --nocheck

    Note

    With only one server to be monitored, specify 0 for ID.
    With more than one server to be monitored, specify consecutive numbers (e.g., 0, 1, 2...).
  • Send polling time metrics

    Send polling time metrics

    Value

    Send

    1

    Do not send (default)

    0

    clpcfadm.py mod -t monitor/diskw@diskw1/perf/metrics/use --set <Value>

8.13.2.3. Monitor (special)

  • File Name (Within 1023 bytes)

    clpcfadm.py mod -t monitor/diskw@diskw1/parameters/file --set <File Name> --nocheck
  • I/O size (bytes)

    Default, 2000000 (minimum, 1; maximum, 99999999)

    clpcfadm.py mod -t monitor/diskw@diskw1/parameters/size --set <Value> --nocheck
  • Action on Stall

    Action on Stall

    Value

    No operation

    0

    Reset the hardware

    1

    Generate an intentional stop error (default)

    2

    clpcfadm.py mod -t monitor/diskw@diskw1/parameters/stallaction --set <Value> --nocheck
  • Action When Diskfull Is Detected

    Action When Diskfull Is Detected

    Value

    Recover

    0

    Recover (default)

    1

    clpcfadm.py mod -t monitor/diskw@diskw1/parameters/diskfullerr --set <Value> --nocheck
  • Use Write Through Method

    Use Write Through Method

    Value

    Use

    0

    Do not use (default)

    1

    clpcfadm.py mod -t monitor/diskw@diskw1/parameters/writecache --set <Value> --nocheck

8.13.2.4. Recovery Action

  • Recovery target

    Recovery target

    Recovery target type

    Local server

    LocalServer

    cls

    All groups([All Groups])

    ""

    grp

    Failover group name

    (Failover group name)

    grp

    Group resource name

    (Group resource name)

    rsc

    clpcfadm.py mod -t monitor/diskw@diskw1/relation/name --set <Recovery target> --nocheck
    clpcfadm.py mod -t monitor/diskw@diskw1/relation/type --set <Recovery target type> --nocheck

    Important

    If you set "Recovery target" to "Local server"

    Set "Maximum Reactivation Count" and "Maximum Failover Count" to 0 (times).

    clpcfadm.py mod -t monitor/diskw@diskw1/emergency/threshold/restart --set 0
    clpcfadm.py mod -t monitor/diskw@diskw1/emergency/threshold/fo2 --set 0

    If the current setting for "Final Action" is "Stop resource (16)" or "Stop Group (2)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/diskw@diskw1/emergency/action --set 1

    Important

    If you set "Recovery target" to "All groups ([All Groups])"

    Set "Maximum Reactivation Count" to 0 (times).

    clpcfadm.py mod -t monitor/diskw@diskw1/emergency/threshold/restart --set 0

    If the current setting for "Final Action" is "Stop resource (16)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/diskw@diskw1/emergency/action --set 1
  • Recovery Script Execution Count

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/diskw@diskw1/emergency/threshold/script --set <Value>
  • Execute Script before Reactivation

    Execute Script before Reactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/diskw@diskw1/emergency/preaction/userestart --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Maximum Reactivation Count

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/diskw@diskw1/emergency/threshold/restart --set <Value>
  • Execute Script before Failover

    Execute Script before Failover

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/diskw@diskw1/emergency/preaction/usefailover --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Failover Target Server

    Failover Target Server

    Value

    Stable server (default)

    1

    Maximum priority server

    0

    clpcfadm.py mod -t monitor/diskw@diskw1/emergency/mode --set <Value>
  • Maximum Failover Count

    Default, 1 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/diskw@diskw1/emergency/threshold/fo2 --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/diskw@diskw1/emergency/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Final Action

    Final Action
    Value

    No operation (default)

    1

    Stop resource 29

    16

    Stop group 30

    2

    Stop the cluster service

    3

    Stop the cluster service and shutdown OS

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t monitor/diskw@diskw1/emergency/action --set <Value>
    29

    Cannot be specified with "Recovery target type" set to "cls" or "grp".

    30

    Cannot be specified with "Recovery target type" set to "cls".

Script Settings
  • File type

    Script file type

    Value

    Script created with this product (default)

    1

    User Application

    0

    clpcfadm.py mod -t monitor/diskw@diskw1/emergency/preaction/default --set <Value>

    Note

    If you change the value of this parameter, also change that of "File".

  • File (Within 1023 bytes)

    clpcfadm.py mod -t monitor/diskw@diskw1/emergency/preaction/path --set <File> --nocheck

    Note

    If you specify "Script created with this product", specify preaction.bat.

    clpcfadm.py mod -t monitor/diskw@diskw1/emergency/preaction/path --set preaction.bat --nocheck
  • Timeout (sec)

    Default, 5 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t monitor/diskw@diskw1/emergency/preaction/timeout --set <Value>
  • Exec User

    clpcfadm.py mod -t monitor/diskw@diskw1/emergency/preaction/account --set <Exec User>

8.13.3. Deleting a disk RW monitor resource

Delete a resource by specifying the monitor resource type and monitor resource name.

clpcfadm.py del mon diskw diskw1

8.14. Floating IP monitor resource

Note

The command lines in this section use fipw1 as the monitor resource name.
Change it to suit your environment.

8.14.1. Adding a floating IP monitor resource

Be sure to set the following items. For details, see "Setting floating IP monitor resource parameters".

Item (mandatory)

Monitor resource name

Target Resource (monitored when active)

Recovery target

Recovery target type

clpcfadm.py add mon fipw fipw1
clpcfadm.py mod -t monitor/fipw@fipw1/target --set <Target Resource (monitored when active)>
clpcfadm.py mod -t monitor/fipw@fipw1/relation/name --set <Recovery target> --nocheck
clpcfadm.py mod -t monitor/fipw@fipw1/relation/type --set <Recovery target type> --nocheck

Note

If you configure a cluster only with the above mandatory items, other parameters are set to their default values.

8.14.2. Setting floating IP monitor resource parameters

8.14.2.1. Basic information

  • Monitor resource name (Within 31 bytes)

    This is set when the resource is added. To change the monitor resource name, delete the resource and set it again.

  • Comment (Within 127 bytes)

    clpcfadm.py mod -t monitor/fipw@fipw1/comment --set <Comment>

    Note

    Enclose in double quotes a string including spaces (e.g., "Sample Comment").

8.14.2.2. Monitor (common)

  • Interval (sec)

    Default, 60 (minimum, 1; maximum, 999)

    clpcfadm.py mod -t monitor/fipw@fipw1/polling/interval --set <Value>
  • Timeout (sec)

    Default, 180 (minimum, 5; maximum, 999)

    clpcfadm.py mod -t monitor/fipw@fipw1/polling/timeout --set <Value>
  • Do Not Retry at Timeout Occurrence

    Do Not Retry at Timeout Occurrence

    Value

    Retry

    0

    Do not retry (default)

    1

    clpcfadm.py mod -t monitor/fipw@fipw1/emergency/timeout/notreconfirmation/use --set <Value>
  • Action at Timeout Occurrence

    Action at Timeout Occurrence

    Value

    Recover

    0

    Do not recover (default)

    1

    Generate an intentional stop error

    2

    clpcfadm.py mod -t monitor/fipw@fipw1/emergency/timeout/notrecovery/use --set <Value>

    Note

    Set as above with "Do Not Retry at Timeout Occurrence" set to "Do not retry".

  • Retry Count

    Default, 1 (minimum, 0; maximum, 999)

    clpcfadm.py mod -t monitor/fipw@fipw1/polling/reconfirmation --set <Value>
  • Wait Time to Start Monitoring (sec)

    Default, 0 (minimum, 0; maximum, 9999)

    clpcfadm.py mod -t monitor/fipw@fipw1/firstmonwait --set <Value>
  • Target Resource (monitored when active)

    clpcfadm.py mod -t monitor/fipw@fipw1/target --set <Target Resource (monitored when active)>

    Note

    You can specify only a Virtual IP resource for this monitor resource.

  • Choose servers that execute monitoring

    clpcfadm.py mod -t monitor/fipw@fipw1/polling/servers@<ID>/name --set <Server name> --nocheck

    Note

    With only one server to be monitored, specify 0 for ID.
    With more than one server to be monitored, specify consecutive numbers (e.g., 0, 1, 2...).
  • Send polling time metrics

    Send polling time metrics

    Value

    Send

    1

    Do not send (default)

    0

    clpcfadm.py mod -t monitor/fipw@fipw1/perf/metrics/use --set <Value>

8.14.2.3. Monitor (special)

  • Monitor NIC Link Up/Down

    Monitor NIC Link Up/Down

    Value

    Monitor

    1

    Do not monitor (default)

    0

    clpcfadm.py mod -t monitor/fipw@fipw1/parameters/monmii --set <Value>

8.14.2.4. Recovery Action

  • Recovery target

    Recovery target

    Recovery target type

    Local server

    LocalServer

    cls

    All groups([All Groups])

    ""

    grp

    Failover group name

    (Failover group name)

    grp

    Group resource name

    (Group resource name)

    rsc

    clpcfadm.py mod -t monitor/fipw@fipw1/relation/name --set <Recovery target> --nocheck
    clpcfadm.py mod -t monitor/fipw@fipw1/relation/type --set <Recovery target type> --nocheck

    Important

    If you set "Recovery target" to "Local server"

    Set "Maximum Reactivation Count" and "Maximum Failover Count" to 0 (times).

    clpcfadm.py mod -t monitor/fipw@fipw1/emergency/threshold/restart --set 0
    clpcfadm.py mod -t monitor/fipw@fipw1/emergency/threshold/fo2 --set 0

    If the current setting for "Final Action" is "Stop resource (16)" or "Stop Group (2)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/fipw@fipw1/emergency/action --set 1

    Important

    If you set "Recovery target" to "All groups ([All Groups])"

    Set "Maximum Reactivation Count" to 0 (times).

    clpcfadm.py mod -t monitor/fipw@fipw1/emergency/threshold/restart --set 0

    If the current setting for "Final Action" is "Stop resource (16)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/fipw@fipw1/emergency/action --set 1
  • Recovery Script Execution Count

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/fipw@fipw1/emergency/threshold/script --set <Value>
  • Execute Script before Reactivation

    Execute Script before Reactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/fipw@fipw1/emergency/preaction/userestart --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Maximum Reactivation Count

    Default, 3 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/fipw@fipw1/emergency/threshold/restart --set <Value>
  • Execute Script before Failover

    Execute Script before Failover

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/fipw@fipw1/emergency/preaction/usefailover --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Failover Target Server

    Failover Target Server

    Value

    Stable server (default)

    1

    Maximum priority server

    0

    clpcfadm.py mod -t monitor/fipw@fipw1/emergency/mode --set <Value>
  • Maximum Failover Count

    Default, 1 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/fipw@fipw1/emergency/threshold/fo2 --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/fipw@fipw1/emergency/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Final Action

    Final Action
    Value

    No operation (default)

    1

    Stop resource 31

    16

    Stop group 32

    2

    Stop the cluster service

    3

    Stop the cluster service and shutdown OS

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t monitor/fipw@fipw1/emergency/action --set <Value>
    31

    Cannot be specified with "Recovery target type" set to "cls" or "grp".

    32

    Cannot be specified with "Recovery target type" set to "cls".

Script Settings
  • File type

    Script file type

    Value

    Script created with this product (default)

    1

    User Application

    0

    clpcfadm.py mod -t monitor/fipw@fipw1/emergency/preaction/default --set <Value>

    Note

    If you change the value of this parameter, also change that of "File".

  • File (Within 1023 bytes)

    clpcfadm.py mod -t monitor/fipw@fipw1/emergency/preaction/path --set <File> --nocheck

    Note

    If you specify "Script created with this product", specify preaction.bat.

    clpcfadm.py mod -t monitor/fipw@fipw1/emergency/preaction/path --set preaction.bat --nocheck
  • Timeout (sec)

    Default, 5 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t monitor/fipw@fipw1/emergency/preaction/timeout --set <Value>
  • Exec User

    clpcfadm.py mod -t monitor/fipw@fipw1/emergency/preaction/account --set <Exec User>

8.14.3. Deleting a floating IP monitor resource

Delete a resource by specifying the monitor resource type and monitor resource name.

clpcfadm.py del mon fipw fipw1

8.15. FTP monitor resource

Note

The command lines in this section use ftpw1 as the monitor resource name.
Change it to suit your environment.

8.15.1. Adding an FTP monitor resource

Be sure to set the following items. For details, see "Setting FTP monitor resource parameters".

Item (mandatory)

Monitor resource name

Target Resource (monitored when active)

Recovery target

Recovery target type

clpcfadm.py add mon ftpw ftpw1
clpcfadm.py mod -t monitor/ftpw@ftpw1/target --set <Target Resource (monitored when active)>
clpcfadm.py mod -t monitor/ftpw@ftpw1/relation/name --set <Recovery target> --nocheck
clpcfadm.py mod -t monitor/ftpw@ftpw1/relation/type --set <Recovery target type> --nocheck

Note

If you configure a cluster only with the above mandatory items, other parameters are set to their default values.

8.15.2. Setting FTP monitor resource parameters

8.15.2.1. Basic information

  • Monitor resource name (Within 31 bytes)

    This is set when the resource is added. To change the monitor resource name, delete the resource and set it again.

  • Comment (Within 127 bytes)

    clpcfadm.py mod -t monitor/ftpw@ftpw1/comment --set <Comment>

    Note

    Enclose in double quotes a string including spaces (e.g., "Sample Comment").

8.15.2.2. Monitor (common)

  • Interval (sec)

    Default, 30 (minimum, 1; maximum, 999)

    clpcfadm.py mod -t monitor/ftpw@ftpw1/polling/interval --set <Value>
  • Timeout (sec)

    Default, 60 (minimum, 5; maximum, 999)

    clpcfadm.py mod -t monitor/ftpw@ftpw1/polling/timeout --set <Value>
  • Do Not Retry at Timeout Occurrence

    Do Not Retry at Timeout Occurrence

    Value

    Retry (default)

    0

    Do not retry

    1

    clpcfadm.py mod -t monitor/ftpw@ftpw1/emergency/timeout/notreconfirmation/use --set <Value>
  • Action at Timeout Occurrence

    Action at Timeout Occurrence

    Value

    Recover (default)

    0

    Do not recover

    1

    Generate an intentional stop error

    2

    clpcfadm.py mod -t monitor/ftpw@ftpw1/emergency/timeout/notrecovery/use --set <Value>

    Note

    Set as above with "Do Not Retry at Timeout Occurrence" set to "Do not retry".

  • Retry Count

    Default, 3 (minimum, 0; maximum, 999)

    clpcfadm.py mod -t monitor/ftpw@ftpw1/polling/reconfirmation --set <Value>
  • Wait Time to Start Monitoring (sec)

    Default, 0 (minimum, 0; maximum, 9999)

    clpcfadm.py mod -t monitor/ftpw@ftpw1/firstmonwait --set <Value>
  • Target Resource (monitored when active)

    clpcfadm.py mod -t monitor/ftpw@ftpw1/target --set <Target Resource (monitored when active)>
  • Choose servers that execute monitoring

    clpcfadm.py mod -t monitor/ftpw@ftpw1/polling/servers@<ID>/name --set <Server name> --nocheck

    Note

    With only one server to be monitored, specify 0 for ID.
    With more than one server to be monitored, specify consecutive numbers (e.g., 0, 1, 2...).
  • Send polling time metrics

    Send polling time metrics

    Value

    Send

    1

    Do not send (default)

    0

    clpcfadm.py mod -t monitor/ftpw@ftpw1/perf/metrics/use --set <Value>

8.15.2.3. Monitor (special)

  • IP Address

    Default: 127.0.0.1

    clpcfadm.py mod -t monitor/ftpw@ftpw1/agentparam/ipaddress --set <IP Address>
  • Port Number

    Default, 21 (minimum, 1; maximum, 65535)

    clpcfadm.py mod -t monitor/ftpw@ftpw1/agentparam/port --set <Value>
  • User Name (Within 255 bytes)

    clpcfadm.py mod -t monitor/ftpw@ftpw1/agentparam/username --set <User Name>
  • Password (Within 255 bytes)

    clpcfadm.py mod -t monitor/ftpw@ftpw1/agentparam/password --set <Encrypted password>

    Note

    Set an encrypted password string.
  • Protocol

    Protocol

    Value

    FTP (default)

    0

    FTPS

    1

    clpcfadm.py mod -t monitor/ftpw@ftpw1/agentparam/protocol --set <Value>

8.15.2.4. Recovery Action

  • Recovery target

    Recovery target

    Recovery target type

    Local server

    LocalServer

    cls

    All groups([All Groups])

    ""

    grp

    Failover group name

    (Failover group name)

    grp

    Group resource name

    (Group resource name)

    rsc

    clpcfadm.py mod -t monitor/ftpw@ftpw1/relation/name --set <Recovery target> --nocheck
    clpcfadm.py mod -t monitor/ftpw@ftpw1/relation/type --set <Recovery target type> --nocheck

    Important

    If you set "Recovery target" to "Local server"

    Set "Maximum Reactivation Count" and "Maximum Failover Count" to 0 (times).

    clpcfadm.py mod -t monitor/ftpw@ftpw1/emergency/threshold/restart --set 0
    clpcfadm.py mod -t monitor/ftpw@ftpw1/emergency/threshold/fo2 --set 0

    If the current setting for "Final Action" is "Stop resource (16)" or "Stop Group (2)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/ftpw@ftpw1/emergency/action --set 1

    Important

    If you set "Recovery target" to "All groups ([All Groups])"

    Set "Maximum Reactivation Count" to 0 (times).

    clpcfadm.py mod -t monitor/ftpw@ftpw1/emergency/threshold/restart --set 0

    If the current setting for "Final Action" is "Stop resource (16)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/ftpw@ftpw1/emergency/action --set 1
  • Recovery Script Execution Count

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/ftpw@ftpw1/emergency/threshold/script --set <Value>
  • Execute Script before Reactivation

    Execute Script before Reactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/ftpw@ftpw1/emergency/preaction/userestart --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Maximum Reactivation Count

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/ftpw@ftpw1/emergency/threshold/restart --set <Value>
  • Execute Script before Failover

    Execute Script before Failover

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/ftpw@ftpw1/emergency/preaction/usefailover --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Failover Target Server

    Failover Target Server

    Value

    Stable server (default)

    1

    Maximum priority server

    0

    clpcfadm.py mod -t monitor/ftpw@ftpw1/emergency/mode --set <Value>
  • Maximum Failover Count

    Default, 1 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/ftpw@ftpw1/emergency/threshold/fo2 --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/ftpw@ftpw1/emergency/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Final Action

    Final Action
    Value

    No operation

    1

    Stop resource 33

    16

    Stop group 34

    2

    Stop the cluster service

    3

    Stop the cluster service and shutdown OS (default)

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t monitor/ftpw@ftpw1/emergency/action --set <Value>
    33

    Cannot be specified with "Recovery target type" set to "cls" or "grp".

    34

    Cannot be specified with "Recovery target type" set to "cls".

Script Settings
  • File type

    Script file type

    Value

    Script created with this product (default)

    1

    User Application

    0

    clpcfadm.py mod -t monitor/ftpw@ftpw1/emergency/preaction/default --set <Value>

    Note

    If you change the value of this parameter, also change that of "File".

  • File (Within 1023 bytes)

    clpcfadm.py mod -t monitor/ftpw@ftpw1/emergency/preaction/path --set <File> --nocheck

    Note

    If you specify "Script created with this product", specify preaction.bat.

    clpcfadm.py mod -t monitor/ftpw@ftpw1/emergency/preaction/path --set preaction.bat --nocheck
  • Timeout (sec)

    Default, 5 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t monitor/ftpw@ftpw1/emergency/preaction/timeout --set <Value>
  • Exec User

    clpcfadm.py mod -t monitor/ftpw@ftpw1/emergency/preaction/account --set <Exec User>

8.15.3. Deleting an FTP monitor resource

Delete a resource by specifying the monitor resource type and monitor resource name.

clpcfadm.py del mon ftpw ftpw1

8.16. Google Cloud DNS monitor resource

Note

The command lines in this section use gcdnsw1 as the monitor resource name.
Change it to suit your environment.

8.16.1. Adding a Google Cloud DNS monitor resource

Be sure to set the following items. For details, see "Setting Google Cloud DNS monitor resource parameters".

Item (mandatory)

Monitor resource name

Target Resource (monitored when active)

Recovery target

Recovery target type

clpcfadm.py add mon gcdnsw gcdnsw1
clpcfadm.py mod -t monitor/gcdnsw@gcdnsw1/target --set <Target Resource (monitored when active)>
clpcfadm.py mod -t monitor/gcdnsw@gcdnsw1/relation/name --set <Recovery target> --nocheck
clpcfadm.py mod -t monitor/gcdnsw@gcdnsw1/relation/type --set <Recovery target type> --nocheck

Note

If you configure a cluster only with the above mandatory items, other parameters are set to their default values.

8.16.2. Setting Google Cloud DNS monitor resource parameters

8.16.2.1. Basic information

  • Monitor resource name (Within 31 bytes)

    This is set when the resource is added. To change the monitor resource name, delete the resource and set it again.

  • Comment (Within 127 bytes)

    clpcfadm.py mod -t monitor/gcdnsw@gcdnsw1/comment --set <Comment>

    Note

    Enclose in double quotes a string including spaces (e.g., "Sample Comment").

8.16.2.2. Monitor (common)

  • Interval (sec)

    Default, 60 (minimum, 1; maximum, 999)

    clpcfadm.py mod -t monitor/gcdnsw@gcdnsw1/polling/interval --set <Value>
  • Timeout (sec)

    Default, 120 (minimum, 5; maximum, 999)

    clpcfadm.py mod -t monitor/gcdnsw@gcdnsw1/polling/timeout --set <Value>
  • Do Not Retry at Timeout Occurrence

    Do Not Retry at Timeout Occurrence

    Value

    Retry (default)

    0

    Do not retry

    1

    clpcfadm.py mod -t monitor/gcdnsw@gcdnsw1/emergency/timeout/notreconfirmation/use --set <Value>
  • Action at Timeout Occurrence

    Action at Timeout Occurrence

    Value

    Recover (default)

    0

    Do not recover

    1

    Generate an intentional stop error

    2

    clpcfadm.py mod -t monitor/gcdnsw@gcdnsw1/emergency/timeout/notrecovery/use --set <Value>

    Note

    Set as above with "Do Not Retry at Timeout Occurrence" set to "Do not retry".

  • Retry Count

    Default, 1 (minimum, 0; maximum, 999)

    clpcfadm.py mod -t monitor/gcdnsw@gcdnsw1/polling/reconfirmation --set <Value>
  • Wait Time to Start Monitoring (sec)

    Default, 3 (minimum, 0; maximum, 9999)

    clpcfadm.py mod -t monitor/gcdnsw@gcdnsw1/firstmonwait --set <Value>
  • Target Resource (monitored when active)

    clpcfadm.py mod -t monitor/gcdnsw@gcdnsw1/target --set <Target Resource (monitored when active)>

    Note

    You can specify only a Google Cloud DNS resource for this monitor resource.

  • Choose servers that execute monitoring

    clpcfadm.py mod -t monitor/gcdnsw@gcdnsw1/polling/servers@<ID>/name --set <Server name> --nocheck

    Note

    With only one server to be monitored, specify 0 for ID.
    With more than one server to be monitored, specify consecutive numbers (e.g., 0, 1, 2...).
  • Send polling time metrics

    Send polling time metrics

    Value

    Send

    1

    Do not send (default)

    0

    clpcfadm.py mod -t monitor/gcdnsw@gcdnsw1/perf/metrics/use --set <Value>

8.16.2.3. Recovery Action

  • Recovery target

    Recovery target

    Recovery target type

    Local server

    LocalServer

    cls

    All groups([All Groups])

    ""

    grp

    Failover group name

    (Failover group name)

    grp

    Group resource name

    (Group resource name)

    rsc

    clpcfadm.py mod -t monitor/gcdnsw@gcdnsw1/relation/name --set <Recovery target> --nocheck
    clpcfadm.py mod -t monitor/gcdnsw@gcdnsw1/relation/type --set <Recovery target type> --nocheck

    Important

    If you set "Recovery target" to "Local server"

    Set "Maximum Reactivation Count" and "Maximum Failover Count" to 0 (times).

    clpcfadm.py mod -t monitor/gcdnsw@gcdnsw1/emergency/threshold/restart --set 0
    clpcfadm.py mod -t monitor/gcdnsw@gcdnsw1/emergency/threshold/fo2 --set 0

    If the current setting for "Final Action" is "Stop resource (16)" or "Stop Group (2)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/gcdnsw@gcdnsw1/emergency/action --set 1

    Important

    If you set "Recovery target" to "All groups ([All Groups])"

    Set "Maximum Reactivation Count" to 0 (times).

    clpcfadm.py mod -t monitor/gcdnsw@gcdnsw1/emergency/threshold/restart --set 0

    If the current setting for "Final Action" is "Stop resource (16)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/gcdnsw@gcdnsw1/emergency/action --set 1
  • Recovery Script Execution Count

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/gcdnsw@gcdnsw1/emergency/threshold/script --set <Value>
  • Execute Script before Reactivation

    Execute Script before Reactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/gcdnsw@gcdnsw1/emergency/preaction/userestart --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Maximum Reactivation Count

    Default, 3 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/gcdnsw@gcdnsw1/emergency/threshold/restart --set <Value>
  • Execute Script before Failover

    Execute Script before Failover

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/gcdnsw@gcdnsw1/emergency/preaction/usefailover --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Failover Target Server

    Failover Target Server

    Value

    Stable server (default)

    1

    Maximum priority server

    0

    clpcfadm.py mod -t monitor/gcdnsw@gcdnsw1/emergency/mode --set <Value>
  • Maximum Failover Count

    Default, 1 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/gcdnsw@gcdnsw1/emergency/threshold/fo2 --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/gcdnsw@gcdnsw1/emergency/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Final Action

    Final Action
    Value

    No operation (default)

    1

    Stop resource 35

    16

    Stop group 36

    2

    Stop the cluster service

    3

    Stop the cluster service and shutdown OS

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t monitor/gcdnsw@gcdnsw1/emergency/action --set <Value>
    35

    Cannot be specified with "Recovery target type" set to "cls" or "grp".

    36

    Cannot be specified with "Recovery target type" set to "cls".

Script Settings
  • File type

    Script file type

    Value

    Script created with this product (default)

    1

    User Application

    0

    clpcfadm.py mod -t monitor/gcdnsw@gcdnsw1/emergency/preaction/default --set <Value>

    Note

    If you change the value of this parameter, also change that of "File".

  • File (Within 1023 bytes)

    clpcfadm.py mod -t monitor/gcdnsw@gcdnsw1/emergency/preaction/path --set <File> --nocheck

    Note

    If you specify "Script created with this product", specify preaction.bat.

    clpcfadm.py mod -t monitor/gcdnsw@gcdnsw1/emergency/preaction/path --set preaction.bat --nocheck
  • Timeout (sec)

    Default, 5 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t monitor/gcdnsw@gcdnsw1/emergency/preaction/timeout --set <Value>
  • Exec User

    clpcfadm.py mod -t monitor/gcdnsw@gcdnsw1/emergency/preaction/account --set <Exec User>

8.16.3. Deleting a Google Cloud DNS monitor resource

Delete a resource by specifying the monitor resource type and monitor resource name.

clpcfadm.py del mon gcdnsw gcdnsw1

8.17. Google Cloud load balance monitor resource

Note

The command lines in this section use gclbw1 as the monitor resource name.
Change it to suit your environment.

8.17.1. Adding a Google Cloud load balance monitor resource

Be sure to set the following items. For details, see "Setting Google Cloud load balance monitor resource parameters".

Item (mandatory)

Monitor resource name

Target Resource

Recovery target

Recovery target type

clpcfadm.py add mon gclbw gclbw1
clpcfadm.py mod -t monitor/gclbw@gclbw1/parameters/object --set <Target Resource>
clpcfadm.py mod -t monitor/gclbw@gclbw1/relation/name --set <Recovery target> --nocheck
clpcfadm.py mod -t monitor/gclbw@gclbw1/relation/type --set <Recovery target type> --nocheck

Note

If you configure a cluster only with the above mandatory items, other parameters are set to their default values.

8.17.2. Setting Google Cloud load balance monitor resource parameters

8.17.2.1. Basic information

  • Monitor resource name (Within 31 bytes)

    This is set when the resource is added. To change the monitor resource name, delete the resource and set it again.

  • Comment (Within 127 bytes)

    clpcfadm.py mod -t monitor/gclbw@gclbw1/comment --set <Comment>

    Note

    Enclose in double quotes a string including spaces (e.g., "Sample Comment").

8.17.2.2. Monitor (common)

  • Interval (sec)

    Default, 60 (minimum, 1; maximum, 999)

    clpcfadm.py mod -t monitor/gclbw@gclbw1/polling/interval --set <Value>
  • Timeout (sec)

    Default, 180 (minimum, 5; maximum, 999)

    clpcfadm.py mod -t monitor/gclbw@gclbw1/polling/timeout --set <Value>
  • Do Not Retry at Timeout Occurrence

    Do Not Retry at Timeout Occurrence

    Value

    Retry

    0

    Do not retry (default)

    1

    clpcfadm.py mod -t monitor/gclbw@gclbw1/emergency/timeout/notreconfirmation/use --set <Value>
  • Action at Timeout Occurrence

    Action at Timeout Occurrence

    Value

    Recover

    0

    Do not recover (default)

    1

    Generate an intentional stop error

    2

    clpcfadm.py mod -t monitor/gclbw@gclbw1/emergency/timeout/notrecovery/use --set <Value>

    Note

    Set as above with "Do Not Retry at Timeout Occurrence" set to "Do not retry".

  • Retry Count

    Default, 1 (minimum, 0; maximum, 999)

    clpcfadm.py mod -t monitor/gclbw@gclbw1/polling/reconfirmation --set <Value>
  • Wait Time to Start Monitoring (sec)

    Default, 0 (minimum, 0; maximum, 9999)

    clpcfadm.py mod -t monitor/gclbw@gclbw1/firstmonwait --set <Value>
  • Choose servers that execute monitoring

    clpcfadm.py mod -t monitor/gclbw@gclbw1/polling/servers@<ID>/name --set <Server name> --nocheck

    Note

    With only one server to be monitored, specify 0 for ID.
    With more than one server to be monitored, specify consecutive numbers (e.g., 0, 1, 2...).
  • Send polling time metrics

    Send polling time metrics

    Value

    Send

    1

    Do not send (default)

    0

    clpcfadm.py mod -t monitor/gclbw@gclbw1/perf/metrics/use --set <Value>

8.17.2.3. Monitor (special)

  • Target Resource

    clpcfadm.py mod -t monitor/gclbw@gclbw1/parameters/object --set <Target Resource>

    Note

    You can specify only a Google Cloud Virtual IP resource.

8.17.2.4. Recovery Action

  • Recovery target

    Recovery target

    Recovery target type

    Local server

    LocalServer

    cls

    All groups([All Groups])

    ""

    grp

    Failover group name

    (Failover group name)

    grp

    Group resource name

    (Group resource name)

    rsc

    clpcfadm.py mod -t monitor/gclbw@gclbw1/relation/name --set <Recovery target> --nocheck
    clpcfadm.py mod -t monitor/gclbw@gclbw1/relation/type --set <Recovery target type> --nocheck

    Important

    If you set "Recovery target" to "Local server"

    Set "Maximum Reactivation Count" and "Maximum Failover Count" to 0 (times).

    clpcfadm.py mod -t monitor/gclbw@gclbw1/emergency/threshold/restart --set 0
    clpcfadm.py mod -t monitor/gclbw@gclbw1/emergency/threshold/fo2 --set 0

    If the current setting for "Final Action" is "Stop resource (16)" or "Stop Group (2)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/gclbw@gclbw1/emergency/action --set 1

    Important

    If you set "Recovery target" to "All groups ([All Groups])"

    Set "Maximum Reactivation Count" to 0 (times).

    clpcfadm.py mod -t monitor/gclbw@gclbw1/emergency/threshold/restart --set 0

    If the current setting for "Final Action" is "Stop resource (16)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/gclbw@gclbw1/emergency/action --set 1
  • Recovery Script Execution Count

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/gclbw@gclbw1/emergency/threshold/script --set <Value>
  • Execute Script before Reactivation

    Execute Script before Reactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/gclbw@gclbw1/emergency/preaction/userestart --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Maximum Reactivation Count

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/gclbw@gclbw1/emergency/threshold/restart --set <Value>
  • Execute Script before Failover

    Execute Script before Failover

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/gclbw@gclbw1/emergency/preaction/usefailover --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Failover Target Server

    Failover Target Server

    Value

    Stable server (default)

    1

    Maximum priority server

    0

    clpcfadm.py mod -t monitor/gclbw@gclbw1/emergency/mode --set <Value>
  • Maximum Failover Count

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/gclbw@gclbw1/emergency/threshold/fo2 --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/gclbw@gclbw1/emergency/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Final Action

    Final Action
    Value

    No operation (default)

    1

    Stop resource 37

    16

    Stop group 38

    2

    Stop the cluster service

    3

    Stop the cluster service and shutdown OS

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t monitor/gclbw@gclbw1/emergency/action --set <Value>
    37

    Cannot be specified with "Recovery target type" set to "cls" or "grp".

    38

    Cannot be specified with "Recovery target type" set to "cls".

Script Settings
  • File type

    Script file type

    Value

    Script created with this product (default)

    1

    User Application

    0

    clpcfadm.py mod -t monitor/gclbw@gclbw1/emergency/preaction/default --set <Value>

    Note

    If you change the value of this parameter, also change that of "File".

  • File (Within 1023 bytes)

    clpcfadm.py mod -t monitor/gclbw@gclbw1/emergency/preaction/path --set <File> --nocheck

    Note

    If you specify "Script created with this product", specify preaction.bat.

    clpcfadm.py mod -t monitor/gclbw@gclbw1/emergency/preaction/path --set preaction.bat --nocheck
  • Timeout (sec)

    Default, 5 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t monitor/gclbw@gclbw1/emergency/preaction/timeout --set <Value>
  • Exec User

    clpcfadm.py mod -t monitor/gclbw@gclbw1/emergency/preaction/account --set <Exec User>

8.17.3. Deleting a Google Cloud load balance monitor resource

Delete a resource by specifying the monitor resource type and monitor resource name.

clpcfadm.py del mon gclbw gclbw1

8.18. Google Cloud Virtual IP monitor resource

Note

The command lines in this section use gcvipw1 as the monitor resource name.
Change it to suit your environment.

8.18.1. Adding a Google Cloud Virtual IP monitor resource

Be sure to set the following items. For details, see "Setting Google Cloud Virtual IP monitor resource parameters".

Item (mandatory)

Monitor resource name

Target Resource (monitored when active)

Recovery target

Recovery target type

clpcfadm.py add mon gcvipw gcvipw1
clpcfadm.py mod -t monitor/gcvipw@gcvipw1/target --set <Target Resource (monitored when active)>
clpcfadm.py mod -t monitor/gcvipw@gcvipw1/relation/name --set <Recovery target> --nocheck
clpcfadm.py mod -t monitor/gcvipw@gcvipw1/relation/type --set <Recovery target type> --nocheck

Note

If you configure a cluster only with the above mandatory items, other parameters are set to their default values.

8.18.2. Setting Google Cloud Virtual IP monitor resource parameters

8.18.2.1. Basic information

  • Monitor resource name (Within 31 bytes)

    This is set when the resource is added. To change the monitor resource name, delete the resource and set it again.

  • Comment (Within 127 bytes)

    clpcfadm.py mod -t monitor/gcvipw@gcvipw1/comment --set <Comment>

    Note

    Enclose in double quotes a string including spaces (e.g., "Sample Comment").

8.18.2.2. Monitor (common)

  • Interval (sec)

    Default, 60 (minimum, 1; maximum, 999)

    clpcfadm.py mod -t monitor/gcvipw@gcvipw1/polling/interval --set <Value>
  • Timeout (sec)

    Default, 180 (minimum, 5; maximum, 999)

    clpcfadm.py mod -t monitor/gcvipw@gcvipw1/polling/timeout --set <Value>
  • Do Not Retry at Timeout Occurrence

    Do Not Retry at Timeout Occurrence

    Value

    Retry

    0

    Do not retry (default)

    1

    clpcfadm.py mod -t monitor/gcvipw@gcvipw1/emergency/timeout/notreconfirmation/use --set <Value>
  • Action at Timeout Occurrence

    Action at Timeout Occurrence

    Value

    Recover

    0

    Do not recover (default)

    1

    Generate an intentional stop error

    2

    clpcfadm.py mod -t monitor/gcvipw@gcvipw1/emergency/timeout/notrecovery/use --set <Value>

    Note

    Set as above with "Do Not Retry at Timeout Occurrence" set to "Do not retry".

  • Retry Count

    Default, 1 (minimum, 0; maximum, 999)

    clpcfadm.py mod -t monitor/gcvipw@gcvipw1/polling/reconfirmation --set <Value>
  • Wait Time to Start Monitoring (sec)

    Default, 0 (minimum, 0; maximum, 9999)

    clpcfadm.py mod -t monitor/gcvipw@gcvipw1/firstmonwait --set <Value>
  • Target Resource (monitored when active)

    clpcfadm.py mod -t monitor/gcvipw@gcvipw1/target --set <Target Resource (monitored when active)>

    Note

    You can specify only a Google Cloud Virtual IP resource for this monitor resource.

  • Choose servers that execute monitoring

    clpcfadm.py mod -t monitor/gcvipw@gcvipw1/polling/servers@<ID>/name --set <Server name> --nocheck

    Note

    With only one server to be monitored, specify 0 for ID.
    With more than one server to be monitored, specify consecutive numbers (e.g., 0, 1, 2...).
  • Send polling time metrics

    Send polling time metrics

    Value

    Send

    1

    Do not send (default)

    0

    clpcfadm.py mod -t monitor/gcvipw@gcvipw1/perf/metrics/use --set <Value>

8.18.2.3. Monitor (special)

  • Health Check Timeout Operation

    Health Check Timeout Operation

    Value

    Disable recovery action(Do nothing) (default)

    0

    Disable recovery action(Display warning)

    1

    Recover

    2

    clpcfadm.py mod -t monitor/gcvipw@gcvipw1/parameters/mode --set <Value>

8.18.2.4. Recovery Action

  • Recovery target

    Recovery target

    Recovery target type

    Local server

    LocalServer

    cls

    All groups([All Groups])

    ""

    grp

    Failover group name

    (Failover group name)

    grp

    Group resource name

    (Group resource name)

    rsc

    clpcfadm.py mod -t monitor/gcvipw@gcvipw1/relation/name --set <Recovery target> --nocheck
    clpcfadm.py mod -t monitor/gcvipw@gcvipw1/relation/type --set <Recovery target type> --nocheck

    Important

    If you set "Recovery target" to "Local server"

    Set "Maximum Reactivation Count" and "Maximum Failover Count" to 0 (times).

    clpcfadm.py mod -t monitor/gcvipw@gcvipw1/emergency/threshold/restart --set 0
    clpcfadm.py mod -t monitor/gcvipw@gcvipw1/emergency/threshold/fo2 --set 0

    If the current setting for "Final Action" is "Stop resource (16)" or "Stop Group (2)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/gcvipw@gcvipw1/emergency/action --set 1

    Important

    If you set "Recovery target" to "All groups ([All Groups])"

    Set "Maximum Reactivation Count" to 0 (times).

    clpcfadm.py mod -t monitor/gcvipw@gcvipw1/emergency/threshold/restart --set 0

    If the current setting for "Final Action" is "Stop resource (16)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/gcvipw@gcvipw1/emergency/action --set 1
  • Recovery Script Execution Count

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/gcvipw@gcvipw1/emergency/threshold/script --set <Value>
  • Execute Script before Reactivation

    Execute Script before Reactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/gcvipw@gcvipw1/emergency/preaction/userestart --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Maximum Reactivation Count

    Default, 3 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/gcvipw@gcvipw1/emergency/threshold/restart --set <Value>
  • Execute Script before Failover

    Execute Script before Failover

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/gcvipw@gcvipw1/emergency/preaction/usefailover --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Failover Target Server

    Failover Target Server

    Value

    Stable server (default)

    1

    Maximum priority server

    0

    clpcfadm.py mod -t monitor/gcvipw@gcvipw1/emergency/mode --set <Value>
  • Maximum Failover Count

    Default, 1 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/gcvipw@gcvipw1/emergency/threshold/fo2 --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/gcvipw@gcvipw1/emergency/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Final Action

    Final Action
    Value

    No operation (default)

    1

    Stop resource 39

    16

    Stop group 40

    2

    Stop the cluster service

    3

    Stop the cluster service and shutdown OS

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t monitor/gcvipw@gcvipw1/emergency/action --set <Value>
    39

    Cannot be specified with "Recovery target type" set to "cls" or "grp".

    40

    Cannot be specified with "Recovery target type" set to "cls".

Script Settings
  • File type

    Script file type

    Value

    Script created with this product (default)

    1

    User Application

    0

    clpcfadm.py mod -t monitor/gcvipw@gcvipw1/emergency/preaction/default --set <Value>

    Note

    If you change the value of this parameter, also change that of "File".

  • File (Within 1023 bytes)

    clpcfadm.py mod -t monitor/gcvipw@gcvipw1/emergency/preaction/path --set <File> --nocheck

    Note

    If you specify "Script created with this product", specify preaction.bat.

    clpcfadm.py mod -t monitor/gcvipw@gcvipw1/emergency/preaction/path --set preaction.bat --nocheck
  • Timeout (sec)

    Default, 5 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t monitor/gcvipw@gcvipw1/emergency/preaction/timeout --set <Value>
  • Exec User

    clpcfadm.py mod -t monitor/gcvipw@gcvipw1/emergency/preaction/account --set <Exec User>

8.18.3. Deleting a Google Cloud Virtual IP monitor resource

Delete a resource by specifying the monitor resource type and monitor resource name.

clpcfadm.py del mon gcvipw gcvipw1

8.19. Custom monitor resource

Note

The command lines in this section use genw1 as the monitor resource name.
Change it to suit your environment.

8.19.1. Adding a custom monitor resource

Be sure to set the following items. For details, see "Setting custom monitor resource parameters".

Item (mandatory)

Monitor resource name

Recovery target

Recovery target type

clpcfadm.py add mon genw genw1
clpcfadm.py mod -t monitor/genw@genw1/relation/name --set <Recovery target> --nocheck
clpcfadm.py mod -t monitor/genw@genw1/relation/type --set <Recovery target type> --nocheck

Note

If you configure a cluster only with the above mandatory items, other parameters are set to their default values.

8.19.2. Setting custom monitor resource parameters

8.19.2.1. Basic information

  • Monitor resource name (Within 31 bytes)

    This is set when the resource is added. To change the monitor resource name, delete the resource and set it again.

  • Comment (Within 127 bytes)

    clpcfadm.py mod -t monitor/genw@genw1/comment --set <Comment>

    Note

    Enclose in double quotes a string including spaces (e.g., "Sample Comment").

8.19.2.2. Monitor (common)

  • Interval (sec)

    Default, 60 (minimum, 1; maximum, 999)

    clpcfadm.py mod -t monitor/genw@genw1/polling/interval --set <Value>
  • Timeout (sec)

    Default, 120 (minimum, 5; maximum, 999)

    clpcfadm.py mod -t monitor/genw@genw1/polling/timeout --set <Value>
  • Do Not Retry at Timeout Occurrence

    Do Not Retry at Timeout Occurrence

    Value

    Retry (default)

    0

    Do not retry

    1

    clpcfadm.py mod -t monitor/genw@genw1/emergency/timeout/notreconfirmation/use --set <Value>
  • Action at Timeout Occurrence

    Action at Timeout Occurrence

    Value

    Recover (default)

    0

    Do not recover

    1

    Generate an intentional stop error

    2

    clpcfadm.py mod -t monitor/genw@genw1/emergency/timeout/notrecovery/use --set <Value>

    Note

    Set as above with "Do Not Retry at Timeout Occurrence" set to "Do not retry".

  • Retry Count

    Default, 1 (minimum, 0; maximum, 999)

    clpcfadm.py mod -t monitor/genw@genw1/polling/reconfirmation --set <Value>
  • Wait Time to Start Monitoring (sec)

    Default, 3 (minimum, 0; maximum, 9999)

    clpcfadm.py mod -t monitor/genw@genw1/firstmonwait --set <Value>
  • Monitoring Timing

    Monitoring Timing

    Value

    Always (default)

    0

    Active

    1

    clpcfadm.py mod -t monitor/genw@genw1/polling/timing --set <Value>

    Note

    If "Monitoring Timing" is set to "Active", set "Target Resource (monitored when active)".

    Important

    If you change the setting for "Monitoring timing" to "Always", set "Target Resource" to blank ("").

    clpcfadm.py mod -t monitor/genw@genw1/target --set ""
  • Target Resource (monitored when active)

    clpcfadm.py mod -t monitor/genw@genw1/target --set <Target Resource (monitored when active)>

    Note

    Set as above with "Monitoring Timing" set to "Active".

  • Choose servers that execute monitoring

    clpcfadm.py mod -t monitor/genw@genw1/polling/servers@<ID>/name --set <Server name> --nocheck

    Note

    With only one server to be monitored, specify 0 for ID.
    With more than one server to be monitored, specify consecutive numbers (e.g., 0, 1, 2...).
  • Send polling time metrics

    Send polling time metrics

    Value

    Send

    1

    Do not send (default)

    0

    clpcfadm.py mod -t monitor/genw@genw1/perf/metrics/use --set <Value>

8.19.2.3. Monitor (special)

  • Script file type

    Script file type

    Value

    Script created with this product (default)

    1

    User Application

    0

    clpcfadm.py mod -t monitor/genw@genw1/parameters/default --set <Value>

    Note

    If you change the value of this parameter, also change that of "Script file".

  • Script file (Within 1023 bytes)

    clpcfadm.py mod -t monitor/genw@genw1/parameters/path --set <Script file> --nocheck

    Note

    If you specify "Script created with this product", specify genw.bat.

    clpcfadm.py mod -t monitor/genw@genw1/parameters/path --set genw.bat --nocheck
  • Monitor Type

    Monitor Type

    Value

    Synchronous (default)

    1

    Asynchronous

    0

    clpcfadm.py mod -t monitor/genw@genw1/parameters/sync --set <Value>
  • Normal Return Value

    Default: 0

    clpcfadm.py mod -t monitor/genw@genw1/parameters/normalval --set <Value>
  • Warning Return Value

    clpcfadm.py mod -t monitor/genw@genw1/parameters/warningval --set <Value>
  • Kill the application when exit

    Kill the application when exit

    Value

    Yes

    1

    No (default)

    0

    clpcfadm.py mod -t monitor/genw@genw1/parameters/termination --set <Value>
  • Wait for activation monitoring to stop before stopping the cluster

    Wait for activation monitoring to stop before stopping the cluster

    Value

    Wait for the stop

    1

    Do not wait for the stop (default)

    0

    clpcfadm.py mod -t monitor/genw@genw1/parameters/waitstop --set <Value>
    • Exec User

      clpcfadm.py mod -t monitor/genw@genw1/parameters/account --set <Exec User>

8.19.2.4. Recovery Action

  • Recovery target

    Recovery target

    Recovery target type

    Local server

    LocalServer

    cls

    All groups([All Groups])

    ""

    grp

    Failover group name

    (Failover group name)

    grp

    Group resource name

    (Group resource name)

    rsc

    clpcfadm.py mod -t monitor/genw@genw1/relation/name --set <Recovery target> --nocheck
    clpcfadm.py mod -t monitor/genw@genw1/relation/type --set <Recovery target type> --nocheck

    Important

    If you set "Recovery target" to "Local server"

    Set "Maximum Reactivation Count" and "Maximum Failover Count" to 0 (times).

    clpcfadm.py mod -t monitor/genw@genw1/emergency/threshold/restart --set 0
    clpcfadm.py mod -t monitor/genw@genw1/emergency/threshold/fo2 --set 0

    If the current setting for "Final Action" is "Stop resource (16)" or "Stop Group (2)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/genw@genw1/emergency/action --set 1

    Important

    If you set "Recovery target" to "All groups ([All Groups])"

    Set "Maximum Reactivation Count" to 0 (times).

    clpcfadm.py mod -t monitor/genw@genw1/emergency/threshold/restart --set 0

    If the current setting for "Final Action" is "Stop resource (16)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/genw@genw1/emergency/action --set 1
  • Recovery Script Execution Count

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/genw@genw1/emergency/threshold/script --set <Value>
  • Execute Script before Reactivation

    Execute Script before Reactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/genw@genw1/emergency/preaction/userestart --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Maximum Reactivation Count

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/genw@genw1/emergency/threshold/restart --set <Value>
  • Execute Script before Failover

    Execute Script before Failover

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/genw@genw1/emergency/preaction/usefailover --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Failover Target Server

    Failover Target Server

    Value

    Stable server (default)

    1

    Maximum priority server

    0

    clpcfadm.py mod -t monitor/genw@genw1/emergency/mode --set <Value>
  • Maximum Failover Count

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/genw@genw1/emergency/threshold/fo2 --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/genw@genw1/emergency/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Final Action

    Final Action
    Value

    No operation (default)

    1

    Stop resource 41

    16

    Stop group 42

    2

    Stop the cluster service

    3

    Stop the cluster service and shutdown OS

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t monitor/genw@genw1/emergency/action --set <Value>
    41

    Cannot be specified with "Recovery target type" set to "cls" or "grp".

    42

    Cannot be specified with "Recovery target type" set to "cls".

Script Settings
  • File type

    Script file type

    Value

    Script created with this product (default)

    1

    User Application

    0

    clpcfadm.py mod -t monitor/genw@genw1/emergency/preaction/default --set <Value>

    Note

    If you change the value of this parameter, also change that of "File".

  • File (Within 1023 bytes)

    clpcfadm.py mod -t monitor/genw@genw1/emergency/preaction/path --set <File> --nocheck

    Note

    If you specify "Script created with this product", specify preaction.bat.

    clpcfadm.py mod -t monitor/genw@genw1/emergency/preaction/path --set preaction.bat --nocheck
  • Timeout (sec)

    Default, 5 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t monitor/genw@genw1/emergency/preaction/timeout --set <Value>
  • Exec User

    clpcfadm.py mod -t monitor/genw@genw1/emergency/preaction/account --set <Exec User>

8.19.3. Deleting a custom monitor resource

Delete a resource by specifying the monitor resource type and monitor resource name.

clpcfadm.py del mon genw genw1

8.20. Hybrid disk TUR monitor resource

Note

The command lines in this section use hdtw1 as the monitor resource name.
Change it to suit your environment.

8.20.1. Adding a hybrid disk TUR monitor resource

Be sure to set the following items. For details, see "Setting hybrid disk TUR monitor resource parameters".

Item (mandatory)

Monitor resource name

Hybrid disk resource

Recovery target (hybrid disk resource name)

Recovery target type (rsc)

clpcfadm.py add mon hdtw hdtw1
clpcfadm.py mod -t monitor/hdtw@hdtw1/parameters/object --set <Hybrid disk resource>
clpcfadm.py mod -t monitor/hdtw@hdtw1/relation/name --set <Hybrid disk resource name> --nocheck
clpcfadm.py mod -t monitor/hdtw@hdtw1/relation/type --set rsc --nocheck

Note

If you configure a cluster only with the above mandatory items, other parameters are set to their default values.

8.20.2. Setting hybrid disk TUR monitor resource parameters

8.20.2.1. Basic information

  • Monitor resource name (Within 31 bytes)

    This is set when the resource is added. To change the monitor resource name, delete the resource and set it again.

  • Comment (Within 127 bytes)

    clpcfadm.py mod -t monitor/hdtw@hdtw1/comment --set <Comment>

    Note

    Enclose in double quotes a string including spaces (e.g., "Sample Comment").

8.20.2.2. Monitor (common)

  • Interval (sec)

    Default, 30 (minimum, 1; maximum, 999)

    clpcfadm.py mod -t monitor/hdtw@hdtw1/polling/interval --set <Value>
  • Timeout (sec)

    Default, 300 (minimum, 5; maximum, 999)

    clpcfadm.py mod -t monitor/hdtw@hdtw1/polling/timeout --set <Value>
  • Do Not Retry at Timeout Occurrence

    Do Not Retry at Timeout Occurrence

    Value

    Retry (default)

    0

    Do not retry

    1

    clpcfadm.py mod -t monitor/hdtw@hdtw1/emergency/timeout/notreconfirmation/use --set <Value>
  • Action at Timeout Occurrence

    Action at Timeout Occurrence

    Value

    Recover (default)

    0

    Do not recover

    1

    Generate an intentional stop error

    2

    clpcfadm.py mod -t monitor/hdtw@hdtw1/emergency/timeout/notrecovery/use --set <Value>

    Note

    Set as above with "Do Not Retry at Timeout Occurrence" set to "Do not retry".

  • Retry Count

    Default, 1 (minimum, 0; maximum, 999)

    clpcfadm.py mod -t monitor/hdtw@hdtw1/polling/reconfirmation --set <Value>
  • Wait Time to Start Monitoring (sec)

    Default, 0 (minimum, 0; maximum, 9999)

    clpcfadm.py mod -t monitor/hdtw@hdtw1/firstmonwait --set <Value>
  • Monitoring Timing

    Monitoring Timing

    Value

    Always (default)

    0

    Active

    1

    clpcfadm.py mod -t monitor/hdtw@hdtw1/polling/timing --set <Value>

    Note

    If "Monitoring Timing" is set to "Active", set "Target Resource (monitored when active)".

    Important

    If you change the setting for "Monitoring timing" to "Always", set "Target Resource" to blank ("").

    clpcfadm.py mod -t monitor/hdtw@hdtw1/target --set ""
  • Target Resource (monitored when active)

    clpcfadm.py mod -t monitor/hdtw@hdtw1/target --set <Target Resource (monitored when active)>

    Note

    Set as above with "Monitoring Timing" set to "Active".

  • Choose servers that execute monitoring

    clpcfadm.py mod -t monitor/hdtw@hdtw1/polling/servers@<ID>/name --set <Server name> --nocheck

    Note

    With only one server to be monitored, specify 0 for ID.
    With more than one server to be monitored, specify consecutive numbers (e.g., 0, 1, 2...).
  • Send polling time metrics

    Send polling time metrics

    Value

    Send

    1

    Do not send (default)

    0

    clpcfadm.py mod -t monitor/hdtw@hdtw1/perf/metrics/use --set <Value>

8.20.2.3. Monitor (special)

  • Hybrid Disk Resource

    clpcfadm.py mod -t monitor/hdtw@hdtw1/parameters/object --set <Hybrid Disk Resource>

    Note

    You can specify only a hybrid disk resource.

8.20.2.4. Recovery Action

  • Execute Script before Failover

    Execute Script before Failover

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/hdtw@hdtw1/emergency/preaction/usefailover --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/hdtw@hdtw1/emergency/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

Script Settings
  • File type

    Script file type

    Value

    Script created with this product (default)

    1

    User Application

    0

    clpcfadm.py mod -t monitor/hdtw@hdtw1/emergency/preaction/default --set <Value>

    Note

    If you change the value of this parameter, also change that of "File".

  • File (Within 1023 bytes)

    clpcfadm.py mod -t monitor/hdtw@hdtw1/emergency/preaction/path --set <File> --nocheck

    Note

    If you specify "Script created with this product", specify preaction.bat.

    clpcfadm.py mod -t monitor/hdtw@hdtw1/emergency/preaction/path --set preaction.bat --nocheck
  • Timeout (sec)

    Default, 5 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t monitor/hdtw@hdtw1/emergency/preaction/timeout --set <Value>
  • Exec User

    clpcfadm.py mod -t monitor/hdtw@hdtw1/emergency/preaction/account --set <Exec User>

8.20.3. Deleting a hybrid disk TUR monitor resource

Delete a resource by specifying the monitor resource type and monitor resource name.

clpcfadm.py del mon hdtw hdtw1

8.21. Hybrid disk monitor resource

Note

The command lines in this section use hdw1 as the monitor resource name.
Change it to suit your environment.

8.21.1. Adding a hybrid disk monitor resource

Be sure to set the following items. For details, see "Setting hybrid disk monitor resource parameters".

Item (mandatory)

Monitor resource name

Hybrid disk resource

Recovery target (hybrid disk resource name)

Recovery target type (rsc)

clpcfadm.py add mon hdw hdw1
clpcfadm.py mod -t monitor/hdw@hdw1/parameters/object --set <Hybrid disk resource>
clpcfadm.py mod -t monitor/hdw@hdw1/relation/name --set <Hybrid disk resource name> --nocheck
clpcfadm.py mod -t monitor/hdw@hdw1/relation/type --set rsc --nocheck

Note

If you configure a cluster only with the above mandatory items, other parameters are set to their default values.

8.21.2. Setting hybrid disk monitor resource parameters

8.21.2.1. Basic information

  • Monitor resource name (Within 31 bytes)

    This is set when the resource is added. To change the monitor resource name, delete the resource and set it again.

  • Comment (Within 127 bytes)

    clpcfadm.py mod -t monitor/hdw@hdw1/comment --set <Comment>

    Note

    Enclose in double quotes a string including spaces (e.g., "Sample Comment").

8.21.2.2. Monitor (common)

  • Interval (sec)

    Default, 30 (minimum, 1; maximum, 999)

    clpcfadm.py mod -t monitor/hdw@hdw1/polling/interval --set <Value>
  • Timeout (sec)

    Default, 999 (minimum, 5; maximum, 999)

    clpcfadm.py mod -t monitor/hdw@hdw1/polling/timeout --set <Value>
  • Do Not Retry at Timeout Occurrence

    Do Not Retry at Timeout Occurrence

    Value

    Retry (default)

    0

    Do not retry

    1

    clpcfadm.py mod -t monitor/hdw@hdw1/emergency/timeout/notreconfirmation/use --set <Value>
  • Action at Timeout Occurrence

    Action at Timeout Occurrence

    Value

    Recover

    0

    Do not recover (default)

    1

    Generate an intentional stop error

    2

    clpcfadm.py mod -t monitor/hdw@hdw1/emergency/timeout/notrecovery/use --set <Value>

    Note

    Set as above with "Do Not Retry at Timeout Occurrence" set to "Do not retry".

  • Retry Count

    Default, 1 (minimum, 0; maximum, 999)

    clpcfadm.py mod -t monitor/hdw@hdw1/polling/reconfirmation --set <Value>
  • Wait Time to Start Monitoring (sec)

    Default, 10 (minimum, 0; maximum, 9999)

    clpcfadm.py mod -t monitor/hdw@hdw1/firstmonwait --set <Value>
  • Send polling time metrics

    Send polling time metrics

    Value

    Send

    1

    Do not send (default)

    0

    clpcfadm.py mod -t monitor/hdw@hdw1/perf/metrics/use --set <Value>

8.21.2.3. Monitor (special)

  • Hybrid Disk Resource

    clpcfadm.py mod -t monitor/hdw@hdw1/parameters/object --set <Hybrid Disk Resource>

    Note

    You can specify only a hybrid disk resource.

8.21.2.4. Recovery Action

  • Execute Script before Failover

    Execute Script before Failover

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/hdw@hdw1/emergency/preaction/usefailover --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/hdw@hdw1/emergency/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

Script Settings
  • File type

    Script file type

    Value

    Script created with this product (default)

    1

    User Application

    0

    clpcfadm.py mod -t monitor/hdw@hdw1/emergency/preaction/default --set <Value>

    Note

    If you change the value of this parameter, also change that of "File".

  • File (Within 1023 bytes)

    clpcfadm.py mod -t monitor/hdw@hdw1/emergency/preaction/path --set <File> --nocheck

    Note

    If you specify "Script created with this product", specify preaction.bat.

    clpcfadm.py mod -t monitor/hdw@hdw1/emergency/preaction/path --set preaction.bat --nocheck
  • Timeout (sec)

    Default, 5 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t monitor/hdw@hdw1/emergency/preaction/timeout --set <Value>
  • Exec User

    clpcfadm.py mod -t monitor/hdw@hdw1/emergency/preaction/account --set <Exec User>

8.21.3. Deleting a hybrid disk monitor resource

Delete a resource by specifying the monitor resource type and monitor resource name.

clpcfadm.py del mon hdw hdw1

8.22. HTTP monitor resource

Note

The command lines in this section use httpw1 as the monitor resource name.
Change it to suit your environment.

8.22.1. Adding an HTTP monitor resource

Be sure to set the following items. For details, see "Setting HTTP monitor resource parameters".

Item (mandatory)

Monitor resource name

Target Resource (monitored when active)

Recovery target

Recovery target type

clpcfadm.py add mon httpw httpw1
clpcfadm.py mod -t monitor/httpw@httpw1/target --set <Target Resource (monitored when active)>
clpcfadm.py mod -t monitor/httpw@httpw1/relation/name --set <Recovery target> --nocheck
clpcfadm.py mod -t monitor/httpw@httpw1/relation/type --set <Recovery target type> --nocheck

Note

If you configure a cluster only with the above mandatory items, other parameters are set to their default values.

8.22.2. Setting HTTP monitor resource parameters

8.22.2.1. Basic information

  • Monitor resource name (Within 31 bytes)

    This is set when the resource is added. To change the monitor resource name, delete the resource and set it again.

  • Comment (Within 127 bytes)

    clpcfadm.py mod -t monitor/httpw@httpw1/comment --set <Comment>

    Note

    Enclose in double quotes a string including spaces (e.g., "Sample Comment").

8.22.2.2. Monitor (common)

  • Interval (sec)

    Default, 30 (minimum, 1; maximum, 999)

    clpcfadm.py mod -t monitor/httpw@httpw1/polling/interval --set <Value>
  • Timeout (sec)

    Default, 60 (minimum, 5; maximum, 999)

    clpcfadm.py mod -t monitor/httpw@httpw1/polling/timeout --set <Value>
  • Do Not Retry at Timeout Occurrence

    Do Not Retry at Timeout Occurrence

    Value

    Retry (default)

    0

    Do not retry

    1

    clpcfadm.py mod -t monitor/httpw@httpw1/emergency/timeout/notreconfirmation/use --set <Value>
  • Action at Timeout Occurrence

    Action at Timeout Occurrence

    Value

    Recover (default)

    0

    Do not recover

    1

    Generate an intentional stop error

    2

    clpcfadm.py mod -t monitor/httpw@httpw1/emergency/timeout/notrecovery/use --set <Value>

    Note

    Set as above with "Do Not Retry at Timeout Occurrence" set to "Do not retry".

  • Retry Count

    Default, 3 (minimum, 0; maximum, 999)

    clpcfadm.py mod -t monitor/httpw@httpw1/polling/reconfirmation --set <Value>
  • Wait Time to Start Monitoring (sec)

    Default, 0 (minimum, 0; maximum, 9999)

    clpcfadm.py mod -t monitor/httpw@httpw1/firstmonwait --set <Value>
  • Target Resource (monitored when active)

    clpcfadm.py mod -t monitor/httpw@httpw1/target --set <Target Resource (monitored when active)>
  • Choose servers that execute monitoring

    clpcfadm.py mod -t monitor/httpw@httpw1/polling/servers@<ID>/name --set <Server name> --nocheck

    Note

    With only one server to be monitored, specify 0 for ID.
    With more than one server to be monitored, specify consecutive numbers (e.g., 0, 1, 2...).
  • Send polling time metrics

    Send polling time metrics

    Value

    Send

    1

    Do not send (default)

    0

    clpcfadm.py mod -t monitor/httpw@httpw1/perf/metrics/use --set <Value>

8.22.2.3. Monitor (special)

  • Connecting Destination (Within 255 bytes)

    Default: 127.0.0.1

    clpcfadm.py mod -t monitor/httpw@httpw1/agentparam/ipaddress --set <Connecting Destination>
  • Port Number

    Default, 80 (minimum, 1; maximum, 65535)

    clpcfadm.py mod -t monitor/httpw@httpw1/agentparam/port --set <Value>
  • Monitor URI (Within 255 bytes)

    clpcfadm.py mod -t monitor/httpw@httpw1/agentparam/uri --set <Request URI>
  • Protocol

    Protocol

    Value

    HTTP (default)

    0

    HTTPS

    1

    clpcfadm.py mod -t monitor/httpw@httpw1/agentparam/https --set <Value>

    Note

    If necessary, also change the setting for "Port Number".

  • Request Type

    Request Type

    Value

    HEAD (default)

    0

    GET

    1

    clpcfadm.py mod -t monitor/httpw@httpw1/agentparam/requesttype --set <Value>
  • Authentication Method

    Authentication Method

    Value

    No authentication (default)

    0

    Basic authentication

    1

    Digest authentication

    2

    clpcfadm.py mod -t monitor/httpw@httpw1/agentparam/authmethod --set <Value>
  • User Name (Within 255 bytes)

    clpcfadm.py mod -t monitor/httpw@httpw1/agentparam/username --set <User Name>

    Note

    Set as above with "Authentication Method" set to "Basic authentication" or "Digest authentication".

  • Password (Within 255 bytes)

    clpcfadm.py mod -t monitor/httpw@httpw1/agentparam/password --set <Encrypted password>

    Note

    Set as above with "Authentication Method" set to "Basic authentication" or "Digest authentication".

    Note

    Set an encrypted password string.
  • Client Authentication

    Client Authentication

    Value

    Set

    1

    Do not set (default)

    0

    clpcfadm.py mod -t monitor/httpw@httpw1/agentparam/clientauth --set <Value>

    Note

    You can set this parameter with "Protocol" set to "HTTPS".

  • Client Certificate Subject Name (Within 64 bytes)

    clpcfadm.py mod -t monitor/httpw@httpw1/agentparam/clientcertsubject --set <Client Certificate>

    Note

    Set as above with "Client Authentication" set to "Set".

8.22.2.4. Recovery Action

  • Recovery target

    Recovery target

    Recovery target type

    Local server

    LocalServer

    cls

    All groups([All Groups])

    ""

    grp

    Failover group name

    (Failover group name)

    grp

    Group resource name

    (Group resource name)

    rsc

    clpcfadm.py mod -t monitor/httpw@httpw1/relation/name --set <Recovery target> --nocheck
    clpcfadm.py mod -t monitor/httpw@httpw1/relation/type --set <Recovery target type> --nocheck

    Important

    If you set "Recovery target" to "Local server"

    Set "Maximum Reactivation Count" and "Maximum Failover Count" to 0 (times).

    clpcfadm.py mod -t monitor/httpw@httpw1/emergency/threshold/restart --set 0
    clpcfadm.py mod -t monitor/httpw@httpw1/emergency/threshold/fo2 --set 0

    If the current setting for "Final Action" is "Stop resource (16)" or "Stop Group (2)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/httpw@httpw1/emergency/action --set 1

    Important

    If you set "Recovery target" to "All groups ([All Groups])"

    Set "Maximum Reactivation Count" to 0 (times).

    clpcfadm.py mod -t monitor/httpw@httpw1/emergency/threshold/restart --set 0

    If the current setting for "Final Action" is "Stop resource (16)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/httpw@httpw1/emergency/action --set 1
  • Recovery Script Execution Count

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/httpw@httpw1/emergency/threshold/script --set <Value>
  • Execute Script before Reactivation

    Execute Script before Reactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/httpw@httpw1/emergency/preaction/userestart --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Maximum Reactivation Count

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/httpw@httpw1/emergency/threshold/restart --set <Value>
  • Execute Script before Failover

    Execute Script before Failover

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/httpw@httpw1/emergency/preaction/usefailover --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Failover Target Server

    Failover Target Server

    Value

    Stable server (default)

    1

    Maximum priority server

    0

    clpcfadm.py mod -t monitor/httpw@httpw1/emergency/mode --set <Value>
  • Maximum Failover Count

    Default, 1 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/httpw@httpw1/emergency/threshold/fo2 --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/httpw@httpw1/emergency/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Final Action

    Final Action
    Value

    No operation

    1

    Stop resource 43

    16

    Stop group 44

    2

    Stop the cluster service

    3

    Stop the cluster service and shutdown OS (default)

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t monitor/httpw@httpw1/emergency/action --set <Value>
    43

    Cannot be specified with "Recovery target type" set to "cls" or "grp".

    44

    Cannot be specified with "Recovery target type" set to "cls".

Script Settings
  • File type

    Script file type

    Value

    Script created with this product (default)

    1

    User Application

    0

    clpcfadm.py mod -t monitor/httpw@httpw1/emergency/preaction/default --set <Value>

    Note

    If you change the value of this parameter, also change that of "File".

  • File (Within 1023 bytes)

    clpcfadm.py mod -t monitor/httpw@httpw1/emergency/preaction/path --set <File> --nocheck

    Note

    If you specify "Script created with this product", specify preaction.bat.

    clpcfadm.py mod -t monitor/httpw@httpw1/emergency/preaction/path --set preaction.bat --nocheck
  • Timeout (sec)

    Default, 5 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t monitor/httpw@httpw1/emergency/preaction/timeout --set <Value>
  • Exec User

    clpcfadm.py mod -t monitor/httpw@httpw1/emergency/preaction/account --set <Exec User>

8.22.3. Deleting an HTTP monitor resource

Delete a resource by specifying the monitor resource type and monitor resource name.

clpcfadm.py del mon httpw httpw1

8.23. IMAP4 monitor resource

Note

The command lines in this section use imap4w1 as the monitor resource name.
Change it to suit your environment.

8.23.1. Adding an IMAP4 monitor resource

Be sure to set the following items. For details, see "Setting IMAP4 monitor resource parameters".

Item (mandatory)

Monitor resource name

Target Resource (monitored when active)

Recovery target

Recovery target type

clpcfadm.py add mon imap4w imap4w1
clpcfadm.py mod -t monitor/imap4w@imap4w1/target --set <Target Resource (monitored when active)>
clpcfadm.py mod -t monitor/imap4w@imap4w1/relation/name --set <Recovery target> --nocheck
clpcfadm.py mod -t monitor/imap4w@imap4w1/relation/type --set <Recovery target type> --nocheck

Note

If you configure a cluster only with the above mandatory items, other parameters are set to their default values.

8.23.2. Setting IMAP4 monitor resource parameters

8.23.2.1. Basic information

  • Monitor resource name (Within 31 bytes)

    This is set when the resource is added. To change the monitor resource name, delete the resource and set it again.

  • Comment (Within 127 bytes)

    clpcfadm.py mod -t monitor/imap4w@imap4w1/comment --set <Comment>

    Note

    Enclose in double quotes a string including spaces (e.g., "Sample Comment").

8.23.2.2. Monitor (common)

  • Interval (sec)

    Default, 30 (minimum, 1; maximum, 999)

    clpcfadm.py mod -t monitor/imap4w@imap4w1/polling/interval --set <Value>
  • Timeout (sec)

    Default, 60 (minimum, 5; maximum, 999)

    clpcfadm.py mod -t monitor/imap4w@imap4w1/polling/timeout --set <Value>
  • Do Not Retry at Timeout Occurrence

    Do Not Retry at Timeout Occurrence

    Value

    Retry (default)

    0

    Do not retry

    1

    clpcfadm.py mod -t monitor/imap4w@imap4w1/emergency/timeout/notreconfirmation/use --set <Value>
  • Action at Timeout Occurrence

    Action at Timeout Occurrence

    Value

    Recover (default)

    0

    Do not recover

    1

    Generate an intentional stop error

    2

    clpcfadm.py mod -t monitor/imap4w@imap4w1/emergency/timeout/notrecovery/use --set <Value>

    Note

    Set as above with "Do Not Retry at Timeout Occurrence" set to "Do not retry".

  • Retry Count

    Default, 3 (minimum, 0; maximum, 999)

    clpcfadm.py mod -t monitor/imap4w@imap4w1/polling/reconfirmation --set <Value>
  • Wait Time to Start Monitoring (sec)

    Default, 0 (minimum, 0; maximum, 9999)

    clpcfadm.py mod -t monitor/imap4w@imap4w1/firstmonwait --set <Value>
  • Target Resource (monitored when active)

    clpcfadm.py mod -t monitor/imap4w@imap4w1/target --set <Target Resource (monitored when active)>
  • Choose servers that execute monitoring

    clpcfadm.py mod -t monitor/imap4w@imap4w1/polling/servers@<ID>/name --set <Server name> --nocheck

    Note

    With only one server to be monitored, specify 0 for ID.
    With more than one server to be monitored, specify consecutive numbers (e.g., 0, 1, 2...).
  • Send polling time metrics

    Send polling time metrics

    Value

    Send

    1

    Do not send (default)

    0

    clpcfadm.py mod -t monitor/imap4w@imap4w1/perf/metrics/use --set <Value>

8.23.2.3. Monitor (special)

  • IP Address

    Default: 127.0.0.1

    clpcfadm.py mod -t monitor/imap4w@imap4w1/agentparam/ipaddress --set <IP Address>
  • Port Number

    Default, 143 (minimum, 1; maximum, 65535)

    clpcfadm.py mod -t monitor/imap4w@imap4w1/agentparam/port --set <Value>
  • User Name (Within 255 bytes)

    clpcfadm.py mod -t monitor/imap4w@imap4w1/agentparam/username --set <User Name>
  • Password (Within 189 bytes)

    clpcfadm.py mod -t monitor/imap4w@imap4w1/agentparam/password --set <Encrypted password>

    Note

    Set an encrypted password string.
  • Authentication Method

    Authentication Method

    Value

    AUTHENTICATE LOGIN (default)

    0

    LOGIN

    1

    clpcfadm.py mod -t monitor/imap4w@imap4w1/agentparam/certificate --set <Value>

8.23.2.4. Recovery Action

  • Recovery target

    Recovery target

    Recovery target type

    Local server

    LocalServer

    cls

    All groups([All Groups])

    ""

    grp

    Failover group name

    (Failover group name)

    grp

    Group resource name

    (Group resource name)

    rsc

    clpcfadm.py mod -t monitor/imap4w@imap4w1/relation/name --set <Recovery target> --nocheck
    clpcfadm.py mod -t monitor/imap4w@imap4w1/relation/type --set <Recovery target type> --nocheck

    Important

    If you set "Recovery target" to "Local server"

    Set "Maximum Reactivation Count" and "Maximum Failover Count" to 0 (times).

    clpcfadm.py mod -t monitor/imap4w@imap4w1/emergency/threshold/restart --set 0
    clpcfadm.py mod -t monitor/imap4w@imap4w1/emergency/threshold/fo2 --set 0

    If the current setting for "Final Action" is "Stop resource (16)" or "Stop Group (2)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/imap4w@imap4w1/emergency/action --set 1

    Important

    If you set "Recovery target" to "All groups ([All Groups])"

    Set "Maximum Reactivation Count" to 0 (times).

    clpcfadm.py mod -t monitor/imap4w@imap4w1/emergency/threshold/restart --set 0

    If the current setting for "Final Action" is "Stop resource (16)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/imap4w@imap4w1/emergency/action --set 1
  • Recovery Script Execution Count

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/imap4w@imap4w1/emergency/threshold/script --set <Value>
  • Execute Script before Reactivation

    Execute Script before Reactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/imap4w@imap4w1/emergency/preaction/userestart --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Maximum Reactivation Count

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/imap4w@imap4w1/emergency/threshold/restart --set <Value>
  • Execute Script before Failover

    Execute Script before Failover

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/imap4w@imap4w1/emergency/preaction/usefailover --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Failover Target Server

    Failover Target Server

    Value

    Stable server (default)

    1

    Maximum priority server

    0

    clpcfadm.py mod -t monitor/imap4w@imap4w1/emergency/mode --set <Value>
  • Maximum Failover Count

    Default, 1 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/imap4w@imap4w1/emergency/threshold/fo2 --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/imap4w@imap4w1/emergency/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Final Action

    Final Action
    Value

    No operation

    1

    Stop resource 45

    16

    Stop group 46

    2

    Stop the cluster service

    3

    Stop the cluster service and shutdown OS (default)

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t monitor/imap4w@imap4w1/emergency/action --set <Value>
    45

    Cannot be specified with "Recovery target type" set to "cls" or "grp".

    46

    Cannot be specified with "Recovery target type" set to "cls".

Script Settings
  • File type

    Script file type

    Value

    Script created with this product (default)

    1

    User Application

    0

    clpcfadm.py mod -t monitor/imap4w@imap4w1/emergency/preaction/default --set <Value>

    Note

    If you change the value of this parameter, also change that of "File".

  • File (Within 1023 bytes)

    clpcfadm.py mod -t monitor/imap4w@imap4w1/emergency/preaction/path --set <File> --nocheck

    Note

    If you specify "Script created with this product", specify preaction.bat.

    clpcfadm.py mod -t monitor/imap4w@imap4w1/emergency/preaction/path --set preaction.bat --nocheck
  • Timeout (sec)

    Default, 5 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t monitor/imap4w@imap4w1/emergency/preaction/timeout --set <Value>
  • Exec User

    clpcfadm.py mod -t monitor/imap4w@imap4w1/emergency/preaction/account --set <Exec User>

8.23.3. Deleting an IMAP4 monitor resource

Delete a resource by specifying the monitor resource type and monitor resource name.

clpcfadm.py del mon imap4w imap4w1

8.24. IP monitor resource

Note

The command lines in this section use ipw1 as the monitor resource name.
Change it to suit your environment.

8.24.1. Adding an IP monitor resource

Be sure to set the following items. For details, see "Setting IP monitor resource parameters".

Item (mandatory)

Monitor resource name

IP Address

Recovery target

Recovery target type

clpcfadm.py add mon ipw ipw1
clpcfadm.py mod -t monitor/ipw@ipw1/parameters/list@<ID>/ip --set <IP Address> --nocheck
clpcfadm.py mod -t monitor/ipw@ipw1/relation/name --set <Recovery target> --nocheck
clpcfadm.py mod -t monitor/ipw@ipw1/relation/type --set <Recovery target type> --nocheck

Note

If you configure a cluster only with the above mandatory items, other parameters are set to their default values.

8.24.2. Setting IP monitor resource parameters

8.24.2.1. Basic information

  • Monitor resource name (Within 31 bytes)

    This is set when the resource is added. To change the monitor resource name, delete the resource and set it again.

  • Comment (Within 127 bytes)

    clpcfadm.py mod -t monitor/ipw@ipw1/comment --set <Comment>

    Note

    Enclose in double quotes a string including spaces (e.g., "Sample Comment").

8.24.2.2. Monitor (common)

  • Interval (sec)

    Default, 60 (minimum, 1; maximum, 999)

    clpcfadm.py mod -t monitor/ipw@ipw1/polling/interval --set <Value>
  • Timeout (sec)

    Default, 60 (minimum, 5; maximum, 999)

    clpcfadm.py mod -t monitor/ipw@ipw1/polling/timeout --set <Value>
  • Do Not Retry at Timeout Occurrence

    Do Not Retry at Timeout Occurrence

    Value

    Retry (default)

    0

    Do not retry

    1

    clpcfadm.py mod -t monitor/ipw@ipw1/emergency/timeout/notreconfirmation/use --set <Value>
  • Action at Timeout Occurrence

    Action at Timeout Occurrence

    Value

    Recover (default)

    0

    Do not recover

    1

    Generate an intentional stop error

    2

    clpcfadm.py mod -t monitor/ipw@ipw1/emergency/timeout/notrecovery/use --set <Value>

    Note

    Set as above with "Do Not Retry at Timeout Occurrence" set to "Do not retry".

  • Retry Count

    Default, 1 (minimum, 0; maximum, 999)

    clpcfadm.py mod -t monitor/ipw@ipw1/polling/reconfirmation --set <Value>
  • Wait Time to Start Monitoring (sec)

    Default, 0 (minimum, 0; maximum, 9999)

    clpcfadm.py mod -t monitor/ipw@ipw1/firstmonwait --set <Value>
  • Monitoring Timing

    Monitoring Timing

    Value

    Always (default)

    0

    Active

    1

    clpcfadm.py mod -t monitor/ipw@ipw1/polling/timing --set <Value>

    Note

    If "Monitoring Timing" is set to "Active", set "Target Resource (monitored when active)".

    Important

    If you change the setting for "Monitoring timing" to "Always", set "Target Resource" to blank ("").

    clpcfadm.py mod -t monitor/ipw@ipw1/target --set ""
  • Target Resource (monitored when active)

    clpcfadm.py mod -t monitor/ipw@ipw1/target --set <Target Resource (monitored when active)>

    Note

    Set as above with "Monitoring Timing" set to "Active".

  • Choose servers that execute monitoring

    clpcfadm.py mod -t monitor/ipw@ipw1/polling/servers@<ID>/name --set <Server name> --nocheck

    Note

    With only one server to be monitored, specify 0 for ID.
    With more than one server to be monitored, specify consecutive numbers (e.g., 0, 1, 2...).
  • Send polling time metrics

    Send polling time metrics

    Value

    Send

    1

    Do not send (default)

    0

    clpcfadm.py mod -t monitor/ipw@ipw1/perf/metrics/use --set <Value>

8.24.2.3. Monitor (special)

  • IP Address

    Add
    clpcfadm.py mod -t monitor/ipw@ipw1/parameters/list@<ID>/ip --set <IP Address> --nocheck

    Note

    With only one IP address to be monitored, specify 0 for ID.
    With more than one IP address to be monitored, specify consecutive numbers (e.g., 0, 1, 2...). (Maximum: 7)
    Delete
    clpcfadm.py mod -t monitor/ipw@ipw1/parameters/list@<ID> --delete
  • Ping Timeout (msec)

    Default, 5000 (minimum, 1; maximum, 999999)

    clpcfadm.py mod -t monitor/ipw@ipw1/parameters/pingtimeout --set <Value> --nocheck

8.24.2.4. Recovery Action

  • Recovery target

    Recovery target

    Recovery target type

    Local server

    LocalServer

    cls

    All groups([All Groups])

    ""

    grp

    Failover group name

    (Failover group name)

    grp

    Group resource name

    (Group resource name)

    rsc

    clpcfadm.py mod -t monitor/ipw@ipw1/relation/name --set <Recovery target> --nocheck
    clpcfadm.py mod -t monitor/ipw@ipw1/relation/type --set <Recovery target type> --nocheck

    Important

    If you set "Recovery target" to "Local server"

    Set "Maximum Reactivation Count" and "Maximum Failover Count" to 0 (times).

    clpcfadm.py mod -t monitor/ipw@ipw1/emergency/threshold/restart --set 0
    clpcfadm.py mod -t monitor/ipw@ipw1/emergency/threshold/fo2 --set 0

    If the current setting for "Final Action" is "Stop resource (16)" or "Stop Group (2)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/ipw@ipw1/emergency/action --set 1

    Important

    If you set "Recovery target" to "All groups ([All Groups])"

    Set "Maximum Reactivation Count" to 0 (times).

    clpcfadm.py mod -t monitor/ipw@ipw1/emergency/threshold/restart --set 0

    If the current setting for "Final Action" is "Stop resource (16)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/ipw@ipw1/emergency/action --set 1
  • Recovery Script Execution Count

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/ipw@ipw1/emergency/threshold/script --set <Value>
  • Execute Script before Reactivation

    Execute Script before Reactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/ipw@ipw1/emergency/preaction/userestart --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Maximum Reactivation Count

    Default, 3 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/ipw@ipw1/emergency/threshold/restart --set <Value>
  • Execute Script before Failover

    Execute Script before Failover

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/ipw@ipw1/emergency/preaction/usefailover --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Failover Target Server

    Failover Target Server

    Value

    Stable server (default)

    1

    Maximum priority server

    0

    clpcfadm.py mod -t monitor/ipw@ipw1/emergency/mode --set <Value>
  • Maximum Failover Count

    Default, 1 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/ipw@ipw1/emergency/threshold/fo2 --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/ipw@ipw1/emergency/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Final Action

    Final Action
    Value

    No operation (default)

    1

    Stop resource 47

    16

    Stop group 48

    2

    Stop the cluster service

    3

    Stop the cluster service and shutdown OS

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t monitor/ipw@ipw1/emergency/action --set <Value>
    47

    Cannot be specified with "Recovery target type" set to "cls" or "grp".

    48

    Cannot be specified with "Recovery target type" set to "cls".

Script Settings
  • File type

    Script file type

    Value

    Script created with this product (default)

    1

    User Application

    0

    clpcfadm.py mod -t monitor/ipw@ipw1/emergency/preaction/default --set <Value>

    Note

    If you change the value of this parameter, also change that of "File".

  • File (Within 1023 bytes)

    clpcfadm.py mod -t monitor/ipw@ipw1/emergency/preaction/path --set <File> --nocheck

    Note

    If you specify "Script created with this product", specify preaction.bat.

    clpcfadm.py mod -t monitor/ipw@ipw1/emergency/preaction/path --set preaction.bat --nocheck
  • Timeout (sec)

    Default, 5 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t monitor/ipw@ipw1/emergency/preaction/timeout --set <Value>
  • Exec User

    clpcfadm.py mod -t monitor/ipw@ipw1/emergency/preaction/account --set <Exec User>

8.24.3. Deleting an IP monitor resource

Delete a resource by specifying the monitor resource type and monitor resource name.

clpcfadm.py del mon ipw ipw1

8.25. JVM monitor resource

Note

The command lines in this section use jraw1 as the monitor resource name.
Change it to suit your environment.

8.25.1. Adding a JVM monitor resource

Note

Please set Java installation path in JVM monitor on the cluster property before creating a JVM monitor resource.

Be sure to set the following items. For details, see "Setting JVM monitor resource parameters".

Item (mandatory)

Monitor resource name

Target Resource (monitored when active)

JVM Type

Identifier

Connection Port

Target

Recovery target

Recovery target type

Number of JVM monitor resources

clpcfadm.py add mon jraw jraw1
clpcfadm.py mod -t monitor/jraw@jraw1/target --set <Target Resource (monitored when active)>
clpcfadm.py mod -t monitor/jraw@jraw1/parameters/jvmtype --set <JVM Type>
clpcfadm.py mod -t monitor/jraw@jraw1/parameters/jvm/name --set <Identifier>
clpcfadm.py mod -t monitor/jraw@jraw1/parameters/jvm/port --set <Connection Port>
clpcfadm.py mod -t monitor/jraw@jraw1/parameters/jvm/servertype --set <Target>
clpcfadm.py mod -t monitor/jraw@jraw1/relation/name --set <Recovery target> --nocheck
clpcfadm.py mod -t monitor/jraw@jraw1/relation/type --set <Recovery target type> --nocheck
clpcfadm.py mod -t monitor/jraw@jraw1/parameters/targetnum --set <Number of JVM monitor resources>

Note

With only one JVM monitor, specify 0 for Number of JVM monitor resources.
With more than one JVM monitor, specify consecutive numbers (e.g., 0, 1, 2...). (Maximum: 24)

Note

If you configure a cluster only with the above mandatory items, other parameters are set to their default values.

8.25.2. Setting JVM monitor resource parameters

8.25.2.1. Basic information

  • Monitor resource name (Within 31 bytes)

    This is set when the resource is added. To change the monitor resource name, delete the resource and set it again.

  • Comment (Within 127 bytes)

    clpcfadm.py mod -t monitor/jraw@jraw1/comment --set <Comment>

    Note

    Enclose in double quotes a string including spaces (e.g., "Sample Comment").

8.25.2.2. Monitor (common)

  • Interval (sec)

    Default, 60 (minimum, 1; maximum, 999)

    clpcfadm.py mod -t monitor/jraw@jraw1/polling/interval --set <Value>
  • Timeout (sec)

    Default, 180 (minimum, 5; maximum, 999)

    clpcfadm.py mod -t monitor/jraw@jraw1/polling/timeout --set <Value>
  • Retry Count

    Default, 1 (minimum, 0; maximum, 999)

    clpcfadm.py mod -t monitor/jraw@jraw1/polling/reconfirmation --set <Value>
  • Wait Time to Start Monitoring (sec)

    Default, 0 (minimum, 0; maximum, 9999)

    clpcfadm.py mod -t monitor/jraw@jraw1/firstmonwait --set <Value>
  • Monitoring Timing

    Monitoring Timing

    Value

    Always

    0

    Active (default)

    1

    clpcfadm.py mod -t monitor/jraw@jraw1/polling/timing --set <Value>

    Note

    If "Monitoring Timing" is set to "Active", set "Target Resource (monitored when active)".

    Important

    If you change the setting for "Monitoring timing" to "Always", set "Target Resource" to blank ("").

    clpcfadm.py mod -t monitor/jraw@jraw1/target --set ""
  • Target Resource (monitored when active)

    clpcfadm.py mod -t monitor/jraw@jraw1/target --set <Target Resource (monitored when active)>

    Note

    Set as above with "Monitoring Timing" set to "Active".

  • Choose servers that execute monitoring

    clpcfadm.py mod -t monitor/jraw@jraw1/polling/servers@<ID>/name --set <Server name> --nocheck

    Note

    With only one server to be monitored, specify 0 for ID.
    With more than one server to be monitored, specify consecutive numbers (e.g., 0, 1, 2...).
  • Send polling time metrics

    Send polling time metrics

    Value

    Send

    1

    Do not send (default)

    0

    clpcfadm.py mod -t monitor/jraw@jraw1/perf/metrics/use --set <Value>

8.25.2.3. Monitor (special)

  • Target

    Target

    Value(targettypeidx)

    Value(servertype)

    WebLogic Server (default)

    0

    weblogic

    WebOTX Domain Agent

    1

    webotx

    WebOTX Process Group

    2

    sun

    Tomcat

    3

    sun

    WebOTX ESB

    4

    sun

    WebSAM SVF

    5

    sun

    Java Application

    6

    sun

    clpcfadm.py mod -t monitor/jraw@jraw1/parameters/targettypeidx --set <Value(targettypeidx)>
    clpcfadm.py mod -t monitor/jraw@jraw1/parameters/jvm/servertype --set <Value(servertype)>
  • JVM Type

    Value

    Oracle Java (default)

    Oracle Java(usage monitoring)

    clpcfadm.py mod -t monitor/jraw@jraw1/parameters/jvmtype --set <Value>

    Note

    Enclose in double quotes a string including spaces (e.g., "Oracle Java").

  • Identifier (Within 255 bytes)

    clpcfadm.py mod -t monitor/jraw@jraw1/parameters/jvm/name --set <Identifier>
  • Connection Port

    Default, None (minimum, 1; maximum, 65535)

    clpcfadm.py mod -t monitor/jraw@jraw1/parameters/jvm/port --set <Value>
  • User Name (Within 255 bytes)

    clpcfadm.py mod -t monitor/jraw@jraw1/parameters/jvm/user/id --set <User Name>

    Note

    Set as above with "Target" set to "WebOTX Domain Agent".

  • Password (Within 255 bytes)

    clpcfadm.py mod -t monitor/jraw@jraw1/parameters/jvm/user/passwd --set <Encrypted password>

    Note

    Set as above with "Target" set to "WebOTX Domain Agent".

    Note

    Set an encrypted password string.
  • Command (Within 255 bytes)

    clpcfadm.py mod -t monitor/jraw@jraw1/parameters/jvm/action/down/runcommand --set <Command>

    Note

    Enclose the path with double quotes (e.g., "cmd").

Tuning
Memory
If "JVM Type" is set to "Oracle Java":
  • Monitor Heap Memory Rate

    Monitor Heap Memory Rate

    Value

    Monitor (default)

    1

    Do not monitor

    0

    clpcfadm.py mod -t monitor/jraw@jraw1/parameters/memory/heapgroup/check --set <Value>
    • Total Usage

      Total Usage

      Value

      Monitor (default)

      1

      Do not monitor

      0

      clpcfadm.py mod -t monitor/jraw@jraw1/parameters/memory/heap/check --set <Value>
      • Total Usage (%)

        Default, 80 (minimum, 1; maximum, 100)

        clpcfadm.py mod -t monitor/jraw@jraw1/parameters/memory/heap/threshold --set <Value>
    • Eden Space

      Eden Space

      Value

      Monitor

      1

      Do not monitor (default)

      0

      clpcfadm.py mod -t monitor/jraw@jraw1/parameters/memory/eden/check --set <Value>
      • Eden Space(%)

        Default, 100 (minimum, 1; maximum, 100)

        clpcfadm.py mod -t monitor/jraw@jraw1/parameters/memory/eden/threshold --set <Value>
    • Survivor Space

      Survivor Space

      Value

      Monitor

      1

      Do not monitor (default)

      0

      clpcfadm.py mod -t monitor/jraw@jraw1/parameters/memory/survivor/check --set <Value>
      • Survivor Space(%)

        Default, 100 (minimum, 1; maximum, 100)

        clpcfadm.py mod -t monitor/jraw@jraw1/parameters/memory/survivor/threshold --set <Value>
    • Tenured Gen

      Tenured Gen

      Value

      Monitor (default)

      1

      Do not monitor

      0

      clpcfadm.py mod -t monitor/jraw@jraw1/parameters/memory/tenured/check --set <Value>
      • Tenured Gen(%)

        Default, 80 (minimum, 1; maximum, 100)

        clpcfadm.py mod -t monitor/jraw@jraw1/parameters/memory/tenured/threshold --set <Value>
    • Command (Within 255 bytes)

      clpcfadm.py mod -t monitor/jraw@jraw1/parameters/memory/heapgroup/action/down/runcommand --set <Command>

      Note

      Enclose the path with double quotes.

  • Monitor Non-Heap Memory Rate

    Monitor Non-Heap Memory Rate

    Value

    Monitor (default)

    1

    Do not monitor

    0

    clpcfadm.py mod -t monitor/jraw@jraw1/parameters/memory/nonheapgroup/check --set <Value>
    • Total Usage

      Total Usage

      Value

      Monitor (default)

      1

      Do not monitor

      0

      clpcfadm.py mod -t monitor/jraw@jraw1/parameters/memory/nonheap/check --set <Value>
      • Total Usage (%)

        Default, 80 (minimum, 1; maximum, 100)

        clpcfadm.py mod -t monitor/jraw@jraw1/parameters/memory/nonheap/threshold --set <Value>
    • Code Cache

      Code Cache

      Value

      Monitor

      1

      Do not monitor (default)

      0

      clpcfadm.py mod -t monitor/jraw@jraw1/parameters/memory/codecash/check --set <Value>
      • Code Cache(%)

        Default, 100 (minimum, 1; maximum, 100)

        clpcfadm.py mod -t monitor/jraw@jraw1/parameters/memory/codecash/threshold --set <Value>
    • Perm Gen

      Perm Gen

      Value

      Monitor (default)

      1

      Do not monitor

      0

      clpcfadm.py mod -t monitor/jraw@jraw1/parameters/memory/perm/check --set <Value>
      • Perm Gen(%)

        Default, 80 (minimum, 1; maximum, 100)

        clpcfadm.py mod -t monitor/jraw@jraw1/parameters/memory/perm/threshold --set <Value>
    • Perm Gen[shared-ro]

      Perm Gen[shared-ro]

      Value

      Monitor (default)

      1

      Do not monitor

      0

      clpcfadm.py mod -t monitor/jraw@jraw1/parameters/memory/perm/ro/check --set <Value>
      • Perm Gen[shared-ro](%)

        Default, 80 (minimum, 1; maximum, 100)

        clpcfadm.py mod -t monitor/jraw@jraw1/parameters/memory/perm/ro/threshold --set <Value>
    • Perm Gen[shared-rw]

      Perm Gen[shared-rw]

      Value

      Monitor (default)

      1

      Do not monitor

      0

      clpcfadm.py mod -t monitor/jraw@jraw1/parameters/memory/perm/rw/check --set <Value>
      • Perm Gen[shared-rw](%)

        Default, 80 (minimum, 1; maximum, 100)

        clpcfadm.py mod -t monitor/jraw@jraw1/parameters/memory/perm/rw/threshold --set <Value>
    • Command (Within 255 bytes)

      clpcfadm.py mod -t monitor/jraw@jraw1/parameters/memory/nonheapgroup/action/down/runcommand --set <Command>

      Note

      Enclose the path with double quotes.

If "JVM Type" is set to "Oracle Java (usage monitoring)":
  • Monitor Heap Memory Rate

    Monitor Heap Memory Rate

    Value

    Monitor

    1

    Do not monitor (default)

    0

    clpcfadm.py mod -t monitor/jraw@jraw1/parameters/memory/heapgroup/maxcheck --set <Value>
    • Total Usage

      Total Usage

      Value

      Monitor (default)

      1

      Do not monitor

      0

      clpcfadm.py mod -t monitor/jraw@jraw1/parameters/memory/heap/check --set <Value>
      • Total Usage (MB)

        Default, 0 (minimum, 0; maximum, 102400)

        clpcfadm.py mod -t monitor/jraw@jraw1/parameters/memory/heap/maxsize --set <Value>
    • Eden Space

      Eden Space

      Value

      Monitor

      1

      Do not monitor (default)

      0

      clpcfadm.py mod -t monitor/jraw@jraw1/parameters/memory/eden/check --set <Value>
      • Eden Space(MB)

        Default, 0 (minimum, 0; maximum, 102400)

        clpcfadm.py mod -t monitor/jraw@jraw1/parameters/memory/eden/maxsize --set <Value>
    • Survivor Space

      Survivor Space

      Value

      Monitor

      1

      Do not monitor (default)

      0

      clpcfadm.py mod -t monitor/jraw@jraw1/parameters/memory/survivor/check --set <Value>
      • Survivor Space(MB)

        Default, 0 (minimum, 0; maximum, 102400)

        clpcfadm.py mod -t monitor/jraw@jraw1/parameters/memory/survivor/maxsize --set <Value>
    • Tenured Gen(Old Gen)

      Tenured Gen(Old Gen)

      Value

      Monitor (default)

      1

      Do not monitor

      0

      clpcfadm.py mod -t monitor/jraw@jraw1/parameters/memory/tenured/check --set <Value>
      • Tenured Gen(Old Gen)(MB)

        Default, 0 (minimum, 0; maximum, 102400)

        clpcfadm.py mod -t monitor/jraw@jraw1/parameters/memory/tenured/maxsize --set <Value>
    • Command (Within 255 bytes)

      clpcfadm.py mod -t monitor/jraw@jraw1/parameters/memory/heapgroup/action/down/runcommand --set <Command>

      Note

      Enclose the path with double quotes.

  • Monitor Non-Heap Memory Rate

    Monitor Non-Heap Memory Rate

    Value

    Monitor

    1

    Do not monitor (default)

    0

    clpcfadm.py mod -t monitor/jraw@jraw1/parameters/memory/nonheapgroup/maxcheck --set <Value>
    • Total Usage

      Total Usage

      Value

      Monitor (default)

      1

      Do not monitor

      0

      clpcfadm.py mod -t monitor/jraw@jraw1/parameters/memory/nonheap/check --set <Value>
      • Total Usage (MB)

        Default, 0 (minimum, 0; maximum, 102400)

        clpcfadm.py mod -t monitor/jraw@jraw1/parameters/memory/nonheap/maxsize --set <Value>
    • Code Cache

      Code Cache

      Value

      Monitor

      1

      Do not monitor (default)

      0

      clpcfadm.py mod -t monitor/jraw@jraw1/parameters/memory/codecash/check --set <Value>
      • Code Cache(MB)

        Default, 0 (minimum, 0; maximum, 102400)

        clpcfadm.py mod -t monitor/jraw@jraw1/parameters/memory/codecash/maxsize --set <Value>
    • CodeHeap non-nmethods

      CodeHeap non-nmethods

      Value

      Monitor

      1

      Do not monitor (default)

      0

      clpcfadm.py mod -t monitor/jraw@jraw1/parameters/memory/nonnmethods/check --set <Value>
      • CodeHeap non-nmethods(MB)

        Default, 0 (minimum, 0; maximum, 102400)

        clpcfadm.py mod -t monitor/jraw@jraw1/parameters/memory/nonnmethods/maxsize --set <Value>

        Note

        Set as above with "Code Cache" set to "Do not monitor".

    • CodeHeap profiled

      CodeHeap profiled

      Value

      Monitor

      1

      Do not monitor (default)

      0

      clpcfadm.py mod -t monitor/jraw@jraw1/parameters/memory/profilednmethods/check --set <Value>
      • CodeHeap profiled(MB)

        Default, 0 (minimum, 0; maximum, 102400)

        clpcfadm.py mod -t monitor/jraw@jraw1/parameters/memory/profilednmethods/maxsize --set <Value>

        Note

        Set as above with "Code Cache" set to "Do not monitor".

    • CodeHeap non-profiled

      CodeHeap non-profiled

      Value

      Monitor

      1

      Do not monitor (default)

      0

      clpcfadm.py mod -t monitor/jraw@jraw1/parameters/memory/nonprofilednmethods/check --set <Value>
      • CodeHeap non-profiled(MB)

        Default, 0 (minimum, 0; maximum, 102400)

        clpcfadm.py mod -t monitor/jraw@jraw1/parameters/memory/nonprofilednmethods/maxsize --set <Value>

        Note

        Set as above with "Code Cache" set to "Do not monitor".

    • Compressed Class Space

      Compressed Class Space

      Value

      Monitor

      1

      Do not monitor (default)

      0

      clpcfadm.py mod -t monitor/jraw@jraw1/parameters/memory/ccs/check --set <Value>
      • Compressed Class Space(MB)

        Default, 0 (minimum, 0; maximum, 102400)

        clpcfadm.py mod -t monitor/jraw@jraw1/parameters/memory/ccs/maxsize --set <Value>
    • Metaspace

      Metaspace

      Value

      Monitor

      1

      Do not monitor (default)

      0

      clpcfadm.py mod -t monitor/jraw@jraw1/parameters/memory/metaspace/check --set <Value>
      • Metaspace(MB)

        Default, 0 (minimum, 0; maximum, 102400)

        clpcfadm.py mod -t monitor/jraw@jraw1/parameters/memory/metaspace/maxsize --set <Value>
    • Command (Within 255 bytes)

      clpcfadm.py mod -t monitor/jraw@jraw1/parameters/memory/nonheapgroup/action/down/runcommand --set <Command>

      Note

      Enclose the path with double quotes.

Thread
  • Monitor the number of Active Threads

    Monitor the number of Active Threads

    Value

    Monitor

    1

    Do not monitor (default)

    0

    clpcfadm.py mod -t monitor/jraw@jraw1/parameters/thread/count/check --set <Value>
    • (Thread)

      Default, 65535 (minimum, 1; maximum, 65535)

      clpcfadm.py mod -t monitor/jraw@jraw1/parameters/thread/count/threshold --set <Value>

      Note

      Set as above with "Monitor the number of Active Threads" set to "Monitor".

  • Command (Within 255 bytes)

    clpcfadm.py mod -t monitor/jraw@jraw1/parameters/thread/action/down/runcommand --set <Command>

    Note

    Enclose the path with double quotes.

GC
  • Monitor the time in Full GC

    Monitor the time in Full GC

    Value

    Monitor

    1

    Do not monitor (default)

    0

    clpcfadm.py mod -t monitor/jraw@jraw1/parameters/gc/time/check --set <Value>
    • (msec)

      Default, 65535 (minimum, 1; maximum, 65535)

      clpcfadm.py mod -t monitor/jraw@jraw1/parameters/gc/time/threshold --set <Value>
  • Monitor the count of Full GC execution

    Monitor the count of Full GC execution

    Value

    Monitor (default)

    1

    Do not monitor

    0

    clpcfadm.py mod -t monitor/jraw@jraw1/parameters/gc/cont/check --set <Value>
    • (count)

      Default, 1 (minimum, 1; maximum, 65535)

      clpcfadm.py mod -t monitor/jraw@jraw1/parameters/gc/cont/threshold --set <Value>
  • Command (Within 255 bytes)

    clpcfadm.py mod -t monitor/jraw@jraw1/parameters/gc/action/down/runcommand --set <Command>

    Note

    Enclose the path with double quotes.

WebLogic

Note

To set the following items, set "Target" to "WebLogic Server" in advance.

  • Monitor the requests in Work Manager

    Monitor the requests in Work Manager

    Value

    Monitor

    1

    Do not monitor (default)

    0

    clpcfadm.py mod -t monitor/jraw@jraw1/parameters/wl/wm/check --set <Value>
  • Target Work Managers (Within 255 bytes)

    clpcfadm.py mod -t monitor/jraw@jraw1/parameters/wl/work/manager --set <Target Work Managers>

    Note

    Set as above with "Monitor the requests in Work Manager" set to "Monitor".

Waiting Requests

Note

To set the following items, set "Monitor the requests in Work Manager" to "Monitor" in advance.

  • The number

    The number

    Value

    Enable

    1

    Do not enable (default)

    0

    clpcfadm.py mod -t monitor/jraw@jraw1/parameters/wl/wm/pending/requests/chkthreshold --set <Value>
    • The number

      Default, 65535 (minimum, 1; maximum, 65535)

      clpcfadm.py mod -t monitor/jraw@jraw1/parameters/wl/wm/pending/requests/threshold --set <Value>
  • Average

    Average

    Value

    Enable

    1

    Do not enable (default)

    0

    clpcfadm.py mod -t monitor/jraw@jraw1/parameters/wl/wm/pending/requests/avg/chkthreshold --set <Value>
    • Average

      Default, 65535 (minimum, 1; maximum, 65535)

      clpcfadm.py mod -t monitor/jraw@jraw1/parameters/wl/wm/pending/requests/avg/threshold --set <Value>
  • Increment from the last

    Increment from the last

    Value

    Enable (default)

    1

    Do not enable

    0

    clpcfadm.py mod -t monitor/jraw@jraw1/parameters/wl/wm/pending/requests/chkincrement --set <Value>
    • Increment from the last (%)

      Default, 80 (minimum, 1; maximum, 100)

      clpcfadm.py mod -t monitor/jraw@jraw1/parameters/wl/wm/pending/requests/increment --set <Value>
  • Monitor the requests in Thread Pool

    Monitor the requests in Thread Pool

    Value

    Monitor (default)

    1

    Do not monitor

    0

    clpcfadm.py mod -t monitor/jraw@jraw1/parameters/wl/tp/check --set <Value>
Waiting Requests

Note

To set the following items, set "Monitor the requests in Thread Pool" to "Monitor" in advance.

  • The number

    The number

    Value

    Enable

    1

    Do not enable (default)

    0

    clpcfadm.py mod -t monitor/jraw@jraw1/parameters/wl/tp/pending/requests/chkthreshold --set <Value>
    • The number

      Default, 65535 (minimum, 1; maximum, 65535)

      clpcfadm.py mod -t monitor/jraw@jraw1/parameters/wl/tp/pending/requests/threshold --set <Value>
  • Average

    Average

    Value

    Enable

    1

    Do not enable (default)

    0

    clpcfadm.py mod -t monitor/jraw@jraw1/parameters/wl/tp/pending/requests/avg/chkthreshold --set <Value>
    • Average

      Default, 65535 (minimum, 1; maximum, 65535)

      clpcfadm.py mod -t monitor/jraw@jraw1/parameters/wl/tp/pending/requests/avg/threshold --set <Value>
  • Increment from the last

    Increment from the last

    Value

    Enable (default)

    1

    Do not enable

    0

    clpcfadm.py mod -t monitor/jraw@jraw1/parameters/wl/tp/pending/requests/chkincrement --set <Value>
    • Increment from the last (%)

      Default, 80 (minimum, 1; maximum, 100)

      clpcfadm.py mod -t monitor/jraw@jraw1/parameters/wl/tp/pending/requests/increment --set <Value>
Executing Requests

Note

To set the following items, set "Monitor the requests in Thread Pool" to "Monitor" in advance.

  • The number

    The number

    Value

    Enable

    1

    Do not enable (default)

    0

    clpcfadm.py mod -t monitor/jraw@jraw1/parameters/wl/tp/throughput/chkthreshold --set <Value>
    • The number

      Default, 65535 (minimum, 1; maximum, 65535)

      clpcfadm.py mod -t monitor/jraw@jraw1/parameters/wl/tp/throughput/threshold --set <Value>
  • Average

    Average

    Value

    Enable

    1

    Do not enable (default)

    0

    clpcfadm.py mod -t monitor/jraw@jraw1/parameters/wl/tp/throughput/avg/chkthreshold --set <Value>
    • Average

      Default, 65535 (minimum, 1; maximum, 65535)

      clpcfadm.py mod -t monitor/jraw@jraw1/parameters/wl/tp/throughput/avg/threshold --set <Value>
  • Increment from the last

    Increment from the last

    Value

    Enable (default)

    1

    Do not enable

    0

    clpcfadm.py mod -t monitor/jraw@jraw1/parameters/wl/tp/throughput/chkincrement --set <Value>
    • Increment from the last (%)

      Default, 80 (minimum, 1; maximum, 100)

      clpcfadm.py mod -t monitor/jraw@jraw1/parameters/wl/tp/throughput/increment --set <Value>
  • Command (Within 255 bytes)

    clpcfadm.py mod -t monitor/jraw@jraw1/parameters/wl/action/down/runcommand --set <Command>

    Note

    Enclose the path with double quotes.

8.25.2.4. Recovery Action

  • Recovery target

    Recovery target

    Recovery target type

    Local server

    LocalServer

    cls

    All groups([All Groups])

    ""

    grp

    Failover group name

    (Failover group name)

    grp

    Group resource name

    (Group resource name)

    rsc

    clpcfadm.py mod -t monitor/jraw@jraw1/relation/name --set <Recovery target> --nocheck
    clpcfadm.py mod -t monitor/jraw@jraw1/relation/type --set <Recovery target type> --nocheck

    Important

    If you set "Recovery target" to "Local server"

    Set "Maximum Reactivation Count" and "Maximum Failover Count" to 0 (times).

    clpcfadm.py mod -t monitor/jraw@jraw1/emergency/threshold/restart --set 0
    clpcfadm.py mod -t monitor/jraw@jraw1/emergency/threshold/fo2 --set 0

    If the current setting for "Final Action" is "Stop resource (16)" or "Stop Group (2)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/jraw@jraw1/emergency/action --set 1

    Important

    If you set "Recovery target" to "All groups ([All Groups])"

    Set "Maximum Reactivation Count" to 0 (times).

    clpcfadm.py mod -t monitor/jraw@jraw1/emergency/threshold/restart --set 0

    If the current setting for "Final Action" is "Stop resource (16)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/jraw@jraw1/emergency/action --set 1
  • Recovery Script Execution Count

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/jraw@jraw1/emergency/threshold/script --set <Value>
  • Execute Script before Reactivation

    Execute Script before Reactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/jraw@jraw1/emergency/preaction/userestart --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Maximum Reactivation Count

    Default, 3 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/jraw@jraw1/emergency/threshold/restart --set <Value>
  • Execute Script before Failover

    Execute Script before Failover

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/jraw@jraw1/emergency/preaction/usefailover --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Failover Target Server

    Failover Target Server

    Value

    Stable server (default)

    1

    Maximum priority server

    0

    clpcfadm.py mod -t monitor/jraw@jraw1/emergency/mode --set <Value>
  • Maximum Failover Count

    Default, 1 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/jraw@jraw1/emergency/threshold/fo2 --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/jraw@jraw1/emergency/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Final Action

    Final Action
    Value

    No operation (default)

    1

    Stop resource 49

    16

    Stop group 50

    2

    Stop the cluster service

    3

    Stop the cluster service and shutdown OS

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t monitor/jraw@jraw1/emergency/action --set <Value>
    49

    Cannot be specified with "Recovery target type" set to "cls" or "grp".

    50

    Cannot be specified with "Recovery target type" set to "cls".

Script Settings
  • File type

    Script file type

    Value

    Script created with this product (default)

    1

    User Application

    0

    clpcfadm.py mod -t monitor/jraw@jraw1/emergency/preaction/default --set <Value>

    Note

    If you change the value of this parameter, also change that of "File".

  • File (Within 1023 bytes)

    clpcfadm.py mod -t monitor/jraw@jraw1/emergency/preaction/path --set <File> --nocheck

    Note

    If you specify "Script created with this product", specify preaction.bat.

    clpcfadm.py mod -t monitor/jraw@jraw1/emergency/preaction/path --set preaction.bat --nocheck
  • Timeout (sec)

    Default, 5 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t monitor/jraw@jraw1/emergency/preaction/timeout --set <Value>
  • Exec User

    clpcfadm.py mod -t monitor/jraw@jraw1/emergency/preaction/account --set <Exec User>

8.25.3. Deleting a JVM monitor resource

Delete a resource by specifying the monitor resource type and monitor resource name.

clpcfadm.py del mon jraw jraw1

8.26. Mirror disk monitor resource

Note

The command lines in this section use mdw1 as the monitor resource name.
Change it to suit your environment.

8.26.1. Adding a mirror disk monitor resource

Be sure to set the following items. For details, see "Setting mirror disk monitor resource parameters".

Item (mandatory)

Monitor resource name

Mirror Disk Resource

Recovery target (Mirror Disk Resource name)

Recovery target type (rsc)

clpcfadm.py add mon mdw mdw1
clpcfadm.py mod -t monitor/mdw@mdw1/parameters/object --set <Mirror Disk Resource>
clpcfadm.py mod -t monitor/mdw@mdw1/relation/name --set <Mirror Disk Resource name> --nocheck
clpcfadm.py mod -t monitor/mdw@mdw1/relation/type --set rsc --nocheck

Note

If you configure a cluster only with the above mandatory items, other parameters are set to their default values.

8.26.2. Setting mirror disk monitor resource parameters

8.26.2.1. Basic information

  • Monitor resource name (Within 31 bytes)

    This is set when the resource is added. To change the monitor resource name, delete the resource and set it again.

  • Comment (Within 127 bytes)

    clpcfadm.py mod -t monitor/mdw@mdw1/comment --set <Comment>

    Note

    Enclose in double quotes a string including spaces (e.g., "Sample Comment").

8.26.2.2. Monitor (common)

  • Interval (sec)

    Default, 30 (minimum, 1; maximum, 999)

    clpcfadm.py mod -t monitor/mdw@mdw1/polling/interval --set <Value>
  • Timeout (sec)

    Default, 999 (minimum, 5; maximum, 999)

    clpcfadm.py mod -t monitor/mdw@mdw1/polling/timeout --set <Value>
  • Do Not Retry at Timeout Occurrence

    Do Not Retry at Timeout Occurrence

    Value

    Retry

    0

    Do not retry (default)

    1

    clpcfadm.py mod -t monitor/mdw@mdw1/emergency/timeout/notreconfirmation/use --set <Value>
  • Action at Timeout Occurrence

    Action at Timeout Occurrence

    Value

    Recover

    0

    Do not recover (default)

    1

    Generate an intentional stop error

    2

    clpcfadm.py mod -t monitor/mdw@mdw1/emergency/timeout/notrecovery/use --set <Value>

    Note

    Set as above with "Do Not Retry at Timeout Occurrence" set to "Do not retry".

  • Retry Count

    Default, 1 (minimum, 0; maximum, 999)

    clpcfadm.py mod -t monitor/mdw@mdw1/polling/reconfirmation --set <Value>
  • Wait Time to Start Monitoring (sec)

    Default, 10 (minimum, 0; maximum, 9999)

    clpcfadm.py mod -t monitor/mdw@mdw1/firstmonwait --set <Value>
  • Send polling time metrics

    Send polling time metrics

    Value

    Send

    1

    Do not send (default)

    0

    clpcfadm.py mod -t monitor/mdw@mdw1/perf/metrics/use --set <Value>

8.26.2.3. Monitor (special)

  • Mirror Disk Resource

    clpcfadm.py mod -t monitor/mdw@mdw1/parameters/object --set <Mirror Disk Resource>

    Note

    You can specify only a mirror disk resource.

8.26.2.4. Recovery Action

  • Execute Script before Failover

    Execute Script before Failover

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/mdw@mdw1/emergency/preaction/usefailover --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/mdw@mdw1/emergency/preaction/use --set <Value>
Script Settings
  • File type

    Script file type

    Value

    Script created with this product (default)

    1

    User Application

    0

    clpcfadm.py mod -t monitor/mdw@mdw1/emergency/preaction/default --set <Value>

    Note

    If you change the value of this parameter, also change that of "File".

  • File (Within 1023 bytes)

    clpcfadm.py mod -t monitor/mdw@mdw1/emergency/preaction/path --set <File> --nocheck

    Note

    If you specify "Script created with this product", specify preaction.bat.

    clpcfadm.py mod -t monitor/mdw@mdw1/emergency/preaction/path --set preaction.bat --nocheck
  • Timeout (sec)

    Default, 5 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t monitor/mdw@mdw1/emergency/preaction/timeout --set <Value>
  • Exec User

    clpcfadm.py mod -t monitor/mdw@mdw1/emergency/preaction/account --set <Exec User>

8.26.3. Deleting a mirror disk monitor resource

Delete a resource by specifying the monitor resource type and monitor resource name.

clpcfadm.py del mon mdw mdw1

8.29. Multi target monitor resource

Note

The command lines in this section use mtw1 as the monitor resource name.
Change it to suit your environment.

8.29.1. Adding a multi-target monitor resource

Be sure to set the following items. For details, see "Setting multi target monitor resource parameters".

Item (mandatory)

Monitor resource name

Target monitor resource name

Target monitor resource type

Recovery target

Recovery target type

clpcfadm.py add mon mtw mtw1
clpcfadm.py mod -t monitor/mtw@mtw1/parameters/list@<ID>/member --set <Target monitor resource name> --nocheck
clpcfadm.py mod -t monitor/mtw@mtw1/parameters/list@<ID>/type --set <Target monitor resource type> --nocheck
clpcfadm.py mod -t monitor/mtw@mtw1/relation/name --set <Recovery target> --nocheck
clpcfadm.py mod -t monitor/mtw@mtw1/relation/type --set <Recovery target type> --nocheck
clpcfadm.py mod -t monitor/<Monitor resource type>@<Monitor resource name>/multi --set 1 --nocheck

Note

If you configure a cluster only with the above mandatory items, other parameters are set to their default values.

8.29.2. Setting multi target monitor resource parameters

8.29.2.1. Basic information

  • Monitor resource name (Within 31 bytes)

    This is set when the resource is added. To change the monitor resource name, delete the resource and set it again.

  • Comment (Within 127 bytes)

    clpcfadm.py mod -t monitor/mtw@mtw1/comment --set <Comment>

    Note

    Enclose in double quotes a string including spaces (e.g., "Sample Comment").

8.29.2.2. Monitor (common)

  • Interval (sec)

    Default, 60 (minimum, 1; maximum, 999)

    clpcfadm.py mod -t monitor/mtw@mtw1/polling/interval --set <Value>
  • Timeout (sec)

    Default, 60 (minimum, 5; maximum, 999)

    clpcfadm.py mod -t monitor/mtw@mtw1/polling/timeout --set <Value>
  • Retry Count

    Default, 1 (minimum, 0; maximum, 999)

    clpcfadm.py mod -t monitor/mtw@mtw1/polling/reconfirmation --set <Value>
  • Wait Time to Start Monitoring (sec)

    Default, 0 (minimum, 0; maximum, 9999)

    clpcfadm.py mod -t monitor/mtw@mtw1/firstmonwait --set <Value>
  • Monitoring Timing

    Monitoring Timing

    Value

    Always (default)

    0

    Active

    1

    clpcfadm.py mod -t monitor/mtw@mtw1/polling/timing --set <Value>

    Note

    If "Monitoring Timing" is set to "Active", set "Target Resource (monitored when active)".

    Important

    If you change the setting for "Monitoring timing" to "Always", set "Target Resource" to blank ("").

    clpcfadm.py mod -t monitor/mtw@mtw1/target --set ""
  • Target Resource (monitored when active)

    clpcfadm.py mod -t monitor/mtw@mtw1/target --set <Target Resource (monitored when active)>

    Note

    Set as above with "Monitoring Timing" set to "Active".

  • Send polling time metrics

    Send polling time metrics

    Value

    Send

    1

    Do not send (default)

    0

    clpcfadm.py mod -t monitor/mtw@mtw1/perf/metrics/use --set <Value>

8.29.2.3. Monitor (special)

  • Monitor Resource

    Add
    clpcfadm.py mod -t monitor/mtw@mtw1/parameters/list@<ID>/member --set <Monitor resource name> --nocheck
    clpcfadm.py mod -t monitor/mtw@mtw1/parameters/list@<ID>/type --set <Monitor resource type> --nocheck
    clpcfadm.py mod -t monitor/<Monitor resource type>@<Monitor resource name>/multi --set 1 --nocheck

    Note

    With only one monitor resource to be added, specify 0 for ID.
    With more than one monitor resource to be added, specify consecutive numbers (e.g., 0, 1, 2...).

    Note

    Set "Monitor resource type" to any of the following values:

    Monitor resource type

    Value

    Application monitor resource

    appliw

    AWS AZ monitor resource

    awsazw

    AWS DNS monitor resource

    awsdnsw

    AWS Elastic IP monitor resource

    awseipw

    AWS Secondary IP monitor resource

    awssipw

    AWS Virtual IP monitor resource

    awsvipw

    Azure DNS monitor resource

    azurednsw

    Azure load balance monitor resource

    azurelbw

    Azure probe port monitor resource

    azureppw

    CIFS monitor resource

    cifsw

    DB2 monitor resource

    db2w

    Disk RW monitor resource

    diskw

    Floating IP monitor resource

    fipw

    FTP monitor resource

    ftpw

    Google Cloud DNS monitor resource

    gcdnsw

    Google Cloud load balance monitor resource

    gclbw

    Google Cloud Virtual IP monitor resource

    gcvipw

    Custom monitor resource

    genw

    HTTP monitor resource

    httpw

    IMAP4 monitor resource

    imap4w

    IP monitor resource

    ipw

    JVM monitor resource

    jraw

    NIC Link Up/Down monitor resource

    miiw

    Eternal link monitor resource

    mrw

    Oracle Cloud DNS monitor resource

    ocdnsw

    Oracle Cloud load balance monitor resource

    oclbw

    Oracle Cloud Virtual IP monitor resource

    ocvipw

    ODBC monitor resource

    odbcw

    Oracle monitor resource

    oraclew

    WebOTX monitor resource

    otxw

    POP3 monitor resource

    pop3w

    PostgreSQL monitor resource

    psqlw

    Process resource monitor resource

    psrw

    Process name monitor resource

    psw

    Disk TUR monitor resource

    sdw

    Service monitor resource

    servicew

    SMTP monitor resource

    smtpw

    SQL Server monitor resource

    sqlserverw

    System monitor resource

    sraw

    Tuxedo monitor resource

    tuxw

    Virtual IP monitor resource

    vipw

    WebSphere monitor resource

    wasw

    WebLogic monitor resource

    wlsw

    Delete
    clpcfadm.py mod -t monitor/mtw@mtw1/parameters/list@<ID> --delete
    clpcfadm.py mod -t monitor/<Monitor resource type>@<Monitor resource name>/multi --set 0
Tuning
  • Failure Threshold

    Failure Threshold

    Value

    Same as Number of Members (default)

    0

    Specify Number

    1

    clpcfadm.py mod -t monitor/mtw@mtw1/parameters/info/seterr --set <Value>
    • Specify Number

      Default, 64 (minimum, 1; maximum, 64)

      clpcfadm.py mod -t monitor/mtw@mtw1/parameters/info/errnum --set <Value>
  • Warning Threshold (Specify Number)

    Default, None (minimum, 1; maximum, 63)

    clpcfadm.py mod -t monitor/mtw@mtw1/parameters/info/caunum --set <Value>

    Note

    With "Failure Threshold" set to "Specify Number", set "Warning Threshold" to a value smaller than "Failure Threshold".

    Note

    To turn off "Warning Threshold", specify 0.

    clpcfadm.py mod -t monitor/mtw@mtw1/parameters/info/caunum --set 0

8.29.2.4. Recovery Action

  • Recovery target

    Recovery target

    Recovery target type

    Local server

    LocalServer

    cls

    All groups([All Groups])

    ""

    grp

    Failover group name

    (Failover group name)

    grp

    Group resource name

    (Group resource name)

    rsc

    clpcfadm.py mod -t monitor/mtw@mtw1/relation/name --set <Recovery target> --nocheck
    clpcfadm.py mod -t monitor/mtw@mtw1/relation/type --set <Recovery target type> --nocheck

    Important

    If you set "Recovery target" to "Local server"

    Set "Maximum Reactivation Count" and "Maximum Failover Count" to 0 (times).

    clpcfadm.py mod -t monitor/mtw@mtw1/emergency/threshold/restart --set 0
    clpcfadm.py mod -t monitor/mtw@mtw1/emergency/threshold/fo2 --set 0

    If the current setting for "Final Action" is "Stop resource (16)" or "Stop Group (2)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/mtw@mtw1/emergency/action --set 1

    Important

    If you set "Recovery target" to "All groups ([All Groups])"

    Set "Maximum Reactivation Count" to 0 (times).

    clpcfadm.py mod -t monitor/mtw@mtw1/emergency/threshold/restart --set 0

    If the current setting for "Final Action" is "Stop resource (16)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/mtw@mtw1/emergency/action --set 1
  • Recovery Script Execution Count

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/mtw@mtw1/emergency/threshold/script --set <Value>
  • Execute Script before Reactivation

    Execute Script before Reactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/mtw@mtw1/emergency/preaction/userestart --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Maximum Reactivation Count

    Default, 3 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/mtw@mtw1/emergency/threshold/restart --set <Value>
  • Execute Script before Failover

    Execute Script before Failover

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/mtw@mtw1/emergency/preaction/usefailover --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Failover Target Server

    Failover Target Server

    Value

    Stable server (default)

    1

    Maximum priority server

    0

    clpcfadm.py mod -t monitor/mtw@mtw1/emergency/mode --set <Value>
  • Maximum Failover Count

    Default, 1 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/mtw@mtw1/emergency/threshold/fo2 --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/mtw@mtw1/emergency/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Final Action

    Final Action
    Value

    No operation (default)

    1

    Stop resource 53

    16

    Stop group 54

    2

    Stop the cluster service

    3

    Stop the cluster service and shutdown OS

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t monitor/mtw@mtw1/emergency/action --set <Value>
    53

    Cannot be specified with "Recovery target type" set to "cls" or "grp".

    54

    Cannot be specified with "Recovery target type" set to "cls".

Script Settings
  • File type

    Script file type

    Value

    Script created with this product (default)

    1

    User Application

    0

    clpcfadm.py mod -t monitor/mtw@mtw1/emergency/preaction/default --set <Value>

    Note

    If you change the value of this parameter, also change that of "File".

  • File (Within 1023 bytes)

    clpcfadm.py mod -t monitor/mtw@mtw1/emergency/preaction/path --set <File> --nocheck

    Note

    If you specify "Script created with this product", specify preaction.bat.

    clpcfadm.py mod -t monitor/mtw@mtw1/emergency/preaction/path --set preaction.bat --nocheck
  • Timeout (sec)

    Default, 5 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t monitor/mtw@mtw1/emergency/preaction/timeout --set <Value>
  • Exec User

    clpcfadm.py mod -t monitor/mtw@mtw1/emergency/preaction/account --set <Exec User>

8.29.3. Deleting a multi target monitor resource

Delete a resource by specifying the monitor resource type and monitor resource name.

clpcfadm.py del mon mtw mtw1
clpcfadm.py mod -t monitor/<Monitor resource type>@<Monitor resource name>/multi --set 0

8.30. Oracle Cloud DNS monitor resource

Note

The command lines in this section use ocdnsw1 as the monitor resource name.
Change it to suit your environment.

8.30.1. Adding an Oracle Cloud DNS monitor resource

Be sure to set the following items. For details, see "Setting Oracle Cloud DNS monitor resource parameters".

Item (mandatory)

Monitor resource name

Target Resource (monitored when active)

Recovery target

Recovery target type

clpcfadm.py add mon ocdnsw ocdnsw1
clpcfadm.py mod -t monitor/ocdnsw@ocdnsw1/parameters/target --set <Target Resource (monitored when active)>
clpcfadm.py mod -t monitor/ocdnsw@ocdnsw1/relation/name --set <Recovery target> --nocheck
clpcfadm.py mod -t monitor/ocdnsw@ocdnsw1/relation/type --set <Recovery target type> --nocheck

Note

If you configure a cluster only with the above mandatory items, other parameters are set to their default values.

8.30.2. Setting Oracle Cloud DNS monitor resource parameters

8.30.2.1. Basic information

  • Monitor resource name (Within 31 bytes)

    This is set when the resource is added. To change the monitor resource name, delete the resource and set it again.

  • Comment (Within 127 bytes)

    clpcfadm.py mod -t monitor/ocdnsw@ocdnsw1/comment --set <Comment>

    Note

    Enclose in double quotes a string including spaces (e.g., "Sample Comment").

8.30.2.2. Monitor (common)

  • Interval (sec)

    Default, 60 (minimum, 1; maximum, 999)

    clpcfadm.py mod -t monitor/ocdnsw@ocdnsw1/polling/interval --set <Value>
  • Timeout (sec)

    Default, 180 (minimum, 5; maximum, 999)

    clpcfadm.py mod -t monitor/ocdnsw@ocdnsw1/polling/timeout --set <Value>
  • Do Not Retry at Timeout Occurrence

    Do Not Retry at Timeout Occurrence

    Value

    Retry

    0

    Do not retry (default)

    1

    clpcfadm.py mod -t monitor/ocdnsw@ocdnsw1/emergency/timeout/notreconfirmation/use --set <Value>
  • Action at Timeout Occurrence

    Action at Timeout Occurrence

    Value

    Recover

    0

    Do not recover (default)

    1

    Generate an intentional stop error

    2

    clpcfadm.py mod -t monitor/ocdnsw@ocdnsw1/emergency/timeout/notrecovery/use --set <Value>

    Note

    Set as above with "Do Not Retry at Timeout Occurrence" set to "Do not retry".

  • Retry Count

    Default, 1 (minimum, 0; maximum, 999)

    clpcfadm.py mod -t monitor/ocdnsw@ocdnsw1/polling/reconfirmation --set <Value>
  • Wait Time to Start Monitoring (sec)

    Default, 300 (minimum, 0; maximum, 9999)

    clpcfadm.py mod -t monitor/ocdnsw@ocdnsw1/firstmonwait --set <Value>
  • Target Resource (monitored when active)

    clpcfadm.py mod -t monitor/ocdnsw@ocdnsw1/target --set <Target Resource (monitored when active)>

    Note

    You can specify only a Oracle Cloud DNS resource for this monitor resource.

  • Choose servers that execute monitoring

    clpcfadm.py mod -t monitor/ocdnsw@ocdnsw1/polling/servers@<ID>/name --set <Server name> --nocheck

    Note

    With only one server to be monitored, specify 0 for ID.
    With more than one server to be monitored, specify consecutive numbers (e.g., 0, 1, 2...).
  • Send polling time metrics

    Send polling time metrics

    Value

    Send

    1

    Do not send (default)

    0

    clpcfadm.py mod -t monitor/ocdnsw@ocdnsw1/perf/metrics/use --set <Value>

8.30.2.3. Monitor (special)

  • Check Name Resolution

    Check Name Resolution

    Value

    Check Name Resolution (default)

    1

    Do not check name resolution

    0

    clpcfadm.py mod -t monitor/ocdnsw@ocdnsw1/parameters/dnscheck --set <Value>

8.30.2.4. Recovery Action

  • Recovery target

    Recovery target

    Recovery target type

    Local server

    LocalServer

    cls

    All groups([All Groups])

    ""

    grp

    Failover group name

    (Failover group name)

    grp

    Group resource name

    (Group resource name)

    rsc

    clpcfadm.py mod -t monitor/ocdnsw@ocdnsw1/relation/name --set <Recovery target> --nocheck
    clpcfadm.py mod -t monitor/ocdnsw@ocdnsw1/relation/type --set <Recovery target type> --nocheck

    Important

    If you set "Recovery target" to "Local server"

    Set "Maximum Reactivation Count" and "Maximum Failover Count" to 0 (times).

    clpcfadm.py mod -t monitor/ocdnsw@ocdnsw1/emergency/threshold/restart --set 0
    clpcfadm.py mod -t monitor/ocdnsw@ocdnsw1/emergency/threshold/fo2 --set 0

    If the current setting for "Final Action" is "Stop resource (16)" or "Stop Group (2)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/ocdnsw@ocdnsw1/emergency/action --set 1

    Important

    If you set "Recovery target" to "All groups ([All Groups])"

    Set "Maximum Reactivation Count" to 0 (times).

    clpcfadm.py mod -t monitor/ocdnsw@ocdnsw1/emergency/threshold/restart --set 0

    If the current setting for "Final Action" is "Stop resource (16)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/ocdnsw@ocdnsw1/emergency/action --set 1
  • Recovery Script Execution Count

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/ocdnsw@ocdnsw1/emergency/threshold/script --set <Value>
  • Execute Script before Reactivation

    Execute Script before Reactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/ocdnsw@ocdnsw1/emergency/preaction/userestart --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Maximum Reactivation Count

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/ocdnsw@ocdnsw1/emergency/threshold/restart --set <Value>
  • Execute Script before Failover

    Execute Script before Failover

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/ocdnsw@ocdnsw1/emergency/preaction/usefailover --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Failover Target Server

    Failover Target Server

    Value

    Stable server (default)

    1

    Maximum priority server

    0

    clpcfadm.py mod -t monitor/ocdnsw@ocdnsw1/emergency/mode --set <Value>
  • Maximum Failover Count

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/ocdnsw@ocdnsw1/emergency/threshold/fo2 --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/ocdnsw@ocdnsw1/emergency/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Final Action

    Final Action
    Value

    No operation (default)

    1

    Stop resource 55

    16

    Stop group 56

    2

    Stop the cluster service

    3

    Stop the cluster service and shutdown OS

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t monitor/ocdnsw@ocdnsw1/emergency/action --set <Value>
    55

    Cannot be specified with "Recovery target type" set to "cls" or "grp".

    56

    Cannot be specified with "Recovery target type" set to "cls".

Script Settings
  • File type

    Script file type

    Value

    Script created with this product (default)

    1

    User Application

    0

    clpcfadm.py mod -t monitor/ocdnsw@ocdnsw1/emergency/preaction/default --set <Value>

    Note

    If you change the value of this parameter, also change that of "File".

  • File (Within 1023 bytes)

    clpcfadm.py mod -t monitor/ocdnsw@ocdnsw1/emergency/preaction/path --set <File> --nocheck

    Note

    If you specify "Script created with this product", specify preaction.bat.

    clpcfadm.py mod -t monitor/ocdnsw@ocdnsw1/emergency/preaction/path --set preaction.bat --nocheck
  • Timeout (sec)

    Default, 5 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t monitor/ocdnsw@ocdnsw1/emergency/preaction/timeout --set <Value>
  • Exec User

    clpcfadm.py mod -t monitor/ocdnsw@ocdnsw1/emergency/preaction/account --set <Exec User>

8.30.3. Deleting an Oracle Cloud DNS monitor resource

Delete a resource by specifying the monitor resource type and monitor resource name.

clpcfadm.py del mon ocdnsw ocdnsw1

8.31. Oracle Cloud load balance monitor resource

Note

The command lines in this section use oclbw1 as the monitor resource name.
Change it to suit your environment.

8.31.1. Adding an Oracle Cloud load balance monitor resource

Be sure to set the following items. For details, see "Setting Oracle Cloud load balance monitor resource parameters".

Item (mandatory)

Monitor resource name

Target Resource

Recovery target

Recovery target type

clpcfadm.py add mon oclbw oclbw1
clpcfadm.py mod -t monitor/oclbw@oclbw1/parameters/object --set <Target Resource>
clpcfadm.py mod -t monitor/oclbw@oclbw1/relation/name --set <Recovery target> --nocheck
clpcfadm.py mod -t monitor/oclbw@oclbw1/relation/type --set <Recovery target type> --nocheck

Note

If you configure a cluster only with the above mandatory items, other parameters are set to their default values.

8.31.2. Setting Oracle Cloud load balance monitor resource parameters

8.31.2.1. Basic information

  • Monitor resource name (Within 31 bytes)

    This is set when the resource is added. To change the monitor resource name, delete the resource and set it again.

  • Comment (Within 127 bytes)

    clpcfadm.py mod -t monitor/oclbw@oclbw1/comment --set <Comment>

    Note

    Enclose in double quotes a string including spaces (e.g., "Sample Comment").

8.31.2.2. Monitor (common)

  • Interval (sec)

    Default, 60 (minimum, 1; maximum, 999)

    clpcfadm.py mod -t monitor/oclbw@oclbw1/polling/interval --set <Value>
  • Timeout (sec)

    Default, 180 (minimum, 5; maximum, 999)

    clpcfadm.py mod -t monitor/oclbw@oclbw1/polling/timeout --set <Value>
  • Do Not Retry at Timeout Occurrence

    Do Not Retry at Timeout Occurrence

    Value

    Retry

    0

    Do not retry (default)

    1

    clpcfadm.py mod -t monitor/oclbw@oclbw1/emergency/timeout/notreconfirmation/use --set <Value>
  • Action at Timeout Occurrence

    Action at Timeout Occurrence

    Value

    Recover

    0

    Do not recover (default)

    1

    Generate an intentional stop error

    2

    clpcfadm.py mod -t monitor/oclbw@oclbw1/emergency/timeout/notrecovery/use --set <Value>

    Note

    Set as above with "Do Not Retry at Timeout Occurrence" set to "Do not retry".

  • Retry Count

    Default, 1 (minimum, 0; maximum, 999)

    clpcfadm.py mod -t monitor/oclbw@oclbw1/polling/reconfirmation --set <Value>
  • Wait Time to Start Monitoring (sec)

    Default, 0 (minimum, 0; maximum, 9999)

    clpcfadm.py mod -t monitor/oclbw@oclbw1/firstmonwait --set <Value>
  • Choose servers that execute monitoring

    clpcfadm.py mod -t monitor/oclbw@oclbw1/polling/servers@<ID>/name --set <Server name> --nocheck

    Note

    With only one server to be monitored, specify 0 for ID.
    With more than one server to be monitored, specify consecutive numbers (e.g., 0, 1, 2...).
  • Send polling time metrics

    Send polling time metrics

    Value

    Send

    1

    Do not send (default)

    0

    clpcfadm.py mod -t monitor/oclbw@oclbw1/perf/metrics/use --set <Value>

8.31.2.3. Monitor (special)

  • Target Resource

    clpcfadm.py mod -t monitor/oclbw@oclbw1/parameters/object --set <Target Resource>

    Note

    You can specify only an Oracle Cloud Virtual IP resource.

8.31.2.4. Recovery Action

  • Recovery target

    Recovery target

    Recovery target type

    Local server

    LocalServer

    cls

    All groups([All Groups])

    ""

    grp

    Failover group name

    (Failover group name)

    grp

    Group resource name

    (Group resource name)

    rsc

    clpcfadm.py mod -t monitor/oclbw@oclbw1/relation/name --set <Recovery target> --nocheck
    clpcfadm.py mod -t monitor/oclbw@oclbw1/relation/type --set <Recovery target type> --nocheck

    Important

    If you set "Recovery target" to "Local server"

    Set "Maximum Reactivation Count" and "Maximum Failover Count" to 0 (times).

    clpcfadm.py mod -t monitor/oclbw@oclbw1/emergency/threshold/restart --set 0
    clpcfadm.py mod -t monitor/oclbw@oclbw1/emergency/threshold/fo2 --set 0

    If the current setting for "Final Action" is "Stop resource (16)" or "Stop Group (2)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/oclbw@oclbw1/emergency/action --set 1

    Important

    If you set "Recovery target" to "All groups ([All Groups])"

    Set "Maximum Reactivation Count" to 0 (times).

    clpcfadm.py mod -t monitor/oclbw@oclbw1/emergency/threshold/restart --set 0

    If the current setting for "Final Action" is "Stop resource (16)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/oclbw@oclbw1/emergency/action --set 1
  • Recovery Script Execution Count

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/oclbw@oclbw1/emergency/threshold/script --set <Value>
  • Execute Script before Reactivation

    Execute Script before Reactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/oclbw@oclbw1/emergency/preaction/userestart --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Maximum Reactivation Count

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/oclbw@oclbw1/emergency/threshold/restart --set <Value>
  • Execute Script before Failover

    Execute Script before Failover

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/oclbw@oclbw1/emergency/preaction/usefailover --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Failover Target Server

    Failover Target Server

    Value

    Stable server (default)

    1

    Maximum priority server

    0

    clpcfadm.py mod -t monitor/oclbw@oclbw1/emergency/mode --set <Value>
  • Maximum Failover Count

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/oclbw@oclbw1/emergency/threshold/fo2 --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/oclbw@oclbw1/emergency/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Final Action

    Final Action
    Value

    No operation (default)

    1

    Stop resource 57

    16

    Stop group 58

    2

    Stop the cluster service

    3

    Stop the cluster service and shutdown OS

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t monitor/oclbw@oclbw1/emergency/action --set <Value>
    57

    Cannot be specified with "Recovery target type" set to "cls" or "grp".

    58

    Cannot be specified with "Recovery target type" set to "cls".

Script Settings
  • File type

    Script file type

    Value

    Script created with this product (default)

    1

    User Application

    0

    clpcfadm.py mod -t monitor/oclbw@oclbw1/emergency/preaction/default --set <Value>

    Note

    If you change the value of this parameter, also change that of "File".

  • File (Within 1023 bytes)

    clpcfadm.py mod -t monitor/oclbw@oclbw1/emergency/preaction/path --set <File> --nocheck

    Note

    If you specify "Script created with this product", specify preaction.bat.

    clpcfadm.py mod -t monitor/oclbw@oclbw1/emergency/preaction/path --set preaction.bat --nocheck
  • Timeout (sec)

    Default, 5 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t monitor/oclbw@oclbw1/emergency/preaction/timeout --set <Value>
  • Exec User

    clpcfadm.py mod -t monitor/oclbw@oclbw1/emergency/preaction/account --set <Exec User>

8.31.3. Deleting an Oracle Cloud load balance monitor resource

Delete a resource by specifying the monitor resource type and monitor resource name.

clpcfadm.py del mon oclbw oclbw1

8.32. Oracle Cloud Virtual IP monitor resource

Note

The command lines in this section use ocvipw1 as the monitor resource name.
Change it to suit your environment.

8.32.1. Adding an Oracle Cloud Virtual IP monitor resource

Be sure to set the following items. For details, see "Setting Oracle Cloud Virtual IP monitor resource parameters".

Item (mandatory)

Monitor resource name

Target Resource (monitored when active)

Recovery target

Recovery target type

clpcfadm.py add mon ocvipw ocvipw1
clpcfadm.py mod -t monitor/ocvipw@ocvipw1/target --set <Target Resource (monitored when active)>
clpcfadm.py mod -t monitor/ocvipw@ocvipw1/relation/name --set <Recovery target> --nocheck
clpcfadm.py mod -t monitor/ocvipw@ocvipw1/relation/type --set <Recovery target type> --nocheck

Note

If you configure a cluster only with the above mandatory items, other parameters are set to their default values.

8.32.2. Setting Oracle Cloud Virtual IP monitor resource parameters

8.32.2.1. Basic information

  • Monitor resource name (Within 31 bytes)

    This is set when the resource is added. To change the monitor resource name, delete the resource and set it again.

  • Comment (Within 127 bytes)

    clpcfadm.py mod -t monitor/ocvipw@ocvipw1/comment --set <Comment>

    Note

    Enclose in double quotes a string including spaces (e.g., "Sample Comment").

8.32.2.2. Monitor (common)

  • Interval (sec)

    Default, 60 (minimum, 1; maximum, 999)

    clpcfadm.py mod -t monitor/ocvipw@ocvipw1/polling/interval --set <Value>
  • Timeout (sec)

    Default, 180 (minimum, 5; maximum, 999)

    clpcfadm.py mod -t monitor/ocvipw@ocvipw1/polling/timeout --set <Value>
  • Do Not Retry at Timeout Occurrence

    Do Not Retry at Timeout Occurrence

    Value

    Retry

    0

    Do not retry (default)

    1

    clpcfadm.py mod -t monitor/ocvipw@ocvipw1/emergency/timeout/notreconfirmation/use --set <Value>
  • Action at Timeout Occurrence

    Action at Timeout Occurrence

    Value

    Recover

    0

    Do not recover (default)

    1

    Generate an intentional stop error

    2

    clpcfadm.py mod -t monitor/ocvipw@ocvipw1/emergency/timeout/notrecovery/use --set <Value>

    Note

    Set as above with "Do Not Retry at Timeout Occurrence" set to "Do not retry".

  • Retry Count

    Default, 1 (minimum, 0; maximum, 999)

    clpcfadm.py mod -t monitor/ocvipw@ocvipw1/polling/reconfirmation --set <Value>
  • Wait Time to Start Monitoring (sec)

    Default, 0 (minimum, 0; maximum, 9999)

    clpcfadm.py mod -t monitor/ocvipw@ocvipw1/firstmonwait --set <Value>
  • Target Resource (monitored when active)

    clpcfadm.py mod -t monitor/ocvipw@ocvipw1/target --set <Target Resource (monitored when active)>

    Note

    You can specify only an Oracle Cloud Virtual IP resource for this monitor resource.

  • Choose servers that execute monitoring

    clpcfadm.py mod -t monitor/ocvipw@ocvipw1/polling/servers@<ID>/name --set <Server name> --nocheck

    Note

    With only one server to be monitored, specify 0 for ID.
    With more than one server to be monitored, specify consecutive numbers (e.g., 0, 1, 2...).
  • Send polling time metrics

    Send polling time metrics

    Value

    Send

    1

    Do not send (default)

    0

    clpcfadm.py mod -t monitor/ocvipw@ocvipw1/perf/metrics/use --set <Value>

8.32.2.3. Monitor (special)

  • Health Check Timeout Operation

    Health Check Timeout Operation

    Value

    Disable recovery action(Do nothing) (default)

    0

    Disable recovery action(Display warning)

    1

    Recover

    2

    clpcfadm.py mod -t monitor/ocvipw@ocvipw1/parameters/mode --set <Value>

8.32.2.4. Recovery Action

  • Recovery target

    Recovery target

    Recovery target type

    Local server

    LocalServer

    cls

    All groups([All Groups])

    ""

    grp

    Failover group name

    (Failover group name)

    grp

    Group resource name

    (Group resource name)

    rsc

    clpcfadm.py mod -t monitor/ocvipw@ocvipw1/relation/name --set <Recovery target> --nocheck
    clpcfadm.py mod -t monitor/ocvipw@ocvipw1/relation/type --set <Recovery target type> --nocheck

    Important

    If you set "Recovery target" to "Local server"

    Set "Maximum Reactivation Count" and "Maximum Failover Count" to 0 (times).

    clpcfadm.py mod -t monitor/ocvipw@ocvipw1/emergency/threshold/restart --set 0
    clpcfadm.py mod -t monitor/ocvipw@ocvipw1/emergency/threshold/fo2 --set 0

    If the current setting for "Final Action" is "Stop resource (16)" or "Stop Group (2)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/ocvipw@ocvipw1/emergency/action --set 1

    Important

    If you set "Recovery target" to "All groups ([All Groups])"

    Set "Maximum Reactivation Count" to 0 (times).

    clpcfadm.py mod -t monitor/ocvipw@ocvipw1/emergency/threshold/restart --set 0

    If the current setting for "Final Action" is "Stop resource (16)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/ocvipw@ocvipw1/emergency/action --set 1
  • Recovery Script Execution Count

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/ocvipw@ocvipw1/emergency/threshold/script --set <Value>
  • Execute Script before Reactivation

    Execute Script before Reactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/ocvipw@ocvipw1/emergency/preaction/userestart --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Maximum Reactivation Count

    Default, 3 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/ocvipw@ocvipw1/emergency/threshold/restart --set <Value>
  • Execute Script before Failover

    Execute Script before Failover

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/ocvipw@ocvipw1/emergency/preaction/usefailover --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Failover Target Server

    Failover Target Server

    Value

    Stable server (default)

    1

    Maximum priority server

    0

    clpcfadm.py mod -t monitor/ocvipw@ocvipw1/emergency/mode --set <Value>
  • Maximum Failover Count

    Default, 1 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/ocvipw@ocvipw1/emergency/threshold/fo2 --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/ocvipw@ocvipw1/emergency/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Final Action

    Final Action
    Value

    No operation (default)

    1

    Stop resource 59

    16

    Stop group 60

    2

    Stop the cluster service

    3

    Stop the cluster service and shutdown OS

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t monitor/ocvipw@ocvipw1/emergency/action --set <Value>
    59

    Cannot be specified with "Recovery target type" set to "cls" or "grp".

    60

    Cannot be specified with "Recovery target type" set to "cls".

Script Settings
  • File type

    Script file type

    Value

    Script created with this product (default)

    1

    User Application

    0

    clpcfadm.py mod -t monitor/ocvipw@ocvipw1/emergency/preaction/default --set <Value>

    Note

    If you change the value of this parameter, also change that of "File".

  • File (Within 1023 bytes)

    clpcfadm.py mod -t monitor/ocvipw@ocvipw1/emergency/preaction/path --set <File> --nocheck

    Note

    If you specify "Script created with this product", specify preaction.bat.

    clpcfadm.py mod -t monitor/ocvipw@ocvipw1/emergency/preaction/path --set preaction.bat --nocheck
  • Timeout (sec)

    Default, 5 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t monitor/ocvipw@ocvipw1/emergency/preaction/timeout --set <Value>
  • Exec User

    clpcfadm.py mod -t monitor/ocvipw@ocvipw1/emergency/preaction/account --set <Exec User>

8.32.3. Deleting an Oracle Cloud Virtual IP monitor resource

Delete a resource by specifying the monitor resource type and monitor resource name.

clpcfadm.py del mon ocvipw ocvipw1

8.33. ODBC monitor resource

Note

The command lines in this section use odbcw1 as the monitor resource name.
Change it to suit your environment.

8.33.1. Adding an ODBC monitor resource

Be sure to set the following items. For details, see "Setting ODBC monitor resource parameters".

Item (mandatory)

Monitor resource name

Target Resource (monitored when active)

Data Source Name

Recovery target

Recovery target type

clpcfadm.py add mon odbcw odbcw1
clpcfadm.py mod -t monitor/odbcw@odbcw1/target --set <Target Resource (monitored when active)>
clpcfadm.py mod -t monitor/odbcw@odbcw1/agentparam/dbname --set <Data Source Name>
clpcfadm.py mod -t monitor/odbcw@odbcw1/relation/name --set <Recovery target> --nocheck
clpcfadm.py mod -t monitor/odbcw@odbcw1/relation/type --set <Recovery target type> --nocheck

Note

If you configure a cluster only with the above mandatory items, other parameters are set to their default values.

8.33.2. Setting ODBC monitor resource parameters

8.33.2.1. Basic information

  • Monitor resource name (Within 31 bytes)

    This is set when the resource is added. To change the monitor resource name, delete the resource and set it again.

  • Comment (Within 127 bytes)

    clpcfadm.py mod -t monitor/odbcw@odbcw1/comment --set <Comment>

    Note

    Enclose in double quotes a string including spaces (e.g., "Sample Comment").

8.33.2.2. Monitor (common)

  • Interval (sec)

    Default, 60 (minimum, 1; maximum, 999)

    clpcfadm.py mod -t monitor/odbcw@odbcw1/polling/interval --set <Value>
  • Timeout (sec)

    Default, 120 (minimum, 5; maximum, 999)

    clpcfadm.py mod -t monitor/odbcw@odbcw1/polling/timeout --set <Value>
  • Do Not Retry at Timeout Occurrence

    Do Not Retry at Timeout Occurrence

    Value

    Retry (default)

    0

    Do not retry

    1

    clpcfadm.py mod -t monitor/odbcw@odbcw1/emergency/timeout/notreconfirmation/use --set <Value>
  • Action at Timeout Occurrence

    Action at Timeout Occurrence

    Value

    Recover (default)

    0

    Do not recover

    1

    Generate an intentional stop error

    2

    clpcfadm.py mod -t monitor/odbcw@odbcw1/emergency/timeout/notrecovery/use --set <Value>

    Note

    Set as above with "Do Not Retry at Timeout Occurrence" set to "Do not retry".

  • Retry Count

    Default, 2 (minimum, 0; maximum, 999)

    clpcfadm.py mod -t monitor/odbcw@odbcw1/polling/reconfirmation --set <Value>
  • Wait Time to Start Monitoring (sec)

    Default, 0 (minimum, 0; maximum, 9999)

    clpcfadm.py mod -t monitor/odbcw@odbcw1/firstmonwait --set <Value>
  • Target Resource (monitored when active)

    clpcfadm.py mod -t monitor/odbcw@odbcw1/target --set <Target Resource (monitored when active)>
  • Choose servers that execute monitoring

    clpcfadm.py mod -t monitor/odbcw@odbcw1/polling/servers@<ID>/name --set <Server name> --nocheck

    Note

    With only one server to be monitored, specify 0 for ID.
    With more than one server to be monitored, specify consecutive numbers (e.g., 0, 1, 2...).
  • Send polling time metrics

    Send polling time metrics

    Value

    Send

    1

    Do not send (default)

    0

    clpcfadm.py mod -t monitor/odbcw@odbcw1/perf/metrics/use --set <Value>

8.33.2.3. Monitor (special)

  • Monitor Level

    Monitor Level

    Value

    Level 1 (monitoring by select)

    3

    Level 2 (monitoring by update/select) (default)

    0

    clpcfadm.py mod -t monitor/odbcw@odbcw1/agentparam/docreatedrop --set <Value>
  • Data Source Name (Within 255 bytes)

    clpcfadm.py mod -t monitor/odbcw@odbcw1/agentparam/dbname --set <Data Source Name>
  • User Name (Within 255 bytes)

    clpcfadm.py mod -t monitor/odbcw@odbcw1/agentparam/username --set <User Name>
  • Password (Within 255 bytes)

    clpcfadm.py mod -t monitor/odbcw@odbcw1/agentparam/password --set <Encrypted password>

    Note

    Set an encrypted password string.
  • Monitor Table Name (Within 255 bytes)

    Default: ODBCWATCH

    clpcfadm.py mod -t monitor/odbcw@odbcw1/agentparam/tablename --set <Monitor Table Name>

8.33.2.4. Recovery Action

  • Recovery target

    Recovery target

    Recovery target type

    Local server

    LocalServer

    cls

    All groups([All Groups])

    ""

    grp

    Failover group name

    (Failover group name)

    grp

    Group resource name

    (Group resource name)

    rsc

    clpcfadm.py mod -t monitor/odbcw@odbcw1/relation/name --set <Recovery target> --nocheck
    clpcfadm.py mod -t monitor/odbcw@odbcw1/relation/type --set <Recovery target type> --nocheck

    Important

    If you set "Recovery target" to "Local server"

    Set "Maximum Reactivation Count" and "Maximum Failover Count" to 0 (times).

    clpcfadm.py mod -t monitor/odbcw@odbcw1/emergency/threshold/restart --set 0
    clpcfadm.py mod -t monitor/odbcw@odbcw1/emergency/threshold/fo2 --set 0

    If the current setting for "Final Action" is "Stop resource (16)" or "Stop Group (2)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/odbcw@odbcw1/emergency/action --set 1

    Important

    If you set "Recovery target" to "All groups ([All Groups])"

    Set "Maximum Reactivation Count" to 0 (times).

    clpcfadm.py mod -t monitor/odbcw@odbcw1/emergency/threshold/restart --set 0

    If the current setting for "Final Action" is "Stop resource (16)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/odbcw@odbcw1/emergency/action --set 1
  • Recovery Script Execution Count

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/odbcw@odbcw1/emergency/threshold/script --set <Value>
  • Execute Script before Reactivation

    Execute Script before Reactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/odbcw@odbcw1/emergency/preaction/userestart --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Maximum Reactivation Count

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/odbcw@odbcw1/emergency/threshold/restart --set <Value>
  • Execute Script before Failover

    Execute Script before Failover

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/odbcw@odbcw1/emergency/preaction/usefailover --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Failover Target Server

    Failover Target Server

    Value

    Stable server (default)

    1

    Maximum priority server

    0

    clpcfadm.py mod -t monitor/odbcw@odbcw1/emergency/mode --set <Value>
  • Maximum Failover Count

    Default, 1 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/odbcw@odbcw1/emergency/threshold/fo2 --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/odbcw@odbcw1/emergency/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Final Action

    Final Action
    Value

    No operation

    1

    Stop resource 61

    16

    Stop group 62

    2

    Stop the cluster service

    3

    Stop the cluster service and shutdown OS (default)

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t monitor/odbcw@odbcw1/emergency/action --set <Value>
    61

    Cannot be specified with "Recovery target type" set to "cls" or "grp".

    62

    Cannot be specified with "Recovery target type" set to "cls".

Script Settings
  • File type

    Script file type

    Value

    Script created with this product (default)

    1

    User Application

    0

    clpcfadm.py mod -t monitor/odbcw@odbcw1/emergency/preaction/default --set <Value>

    Note

    If you change the value of this parameter, also change that of "File".

  • File (Within 1023 bytes)

    clpcfadm.py mod -t monitor/odbcw@odbcw1/emergency/preaction/path --set <File> --nocheck

    Note

    If you specify "Script created with this product", specify preaction.bat.

    clpcfadm.py mod -t monitor/odbcw@odbcw1/emergency/preaction/path --set preaction.bat --nocheck
  • Timeout (sec)

    Default, 5 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t monitor/odbcw@odbcw1/emergency/preaction/timeout --set <Value>
  • Exec User

    clpcfadm.py mod -t monitor/odbcw@odbcw1/emergency/preaction/account --set <Exec User>

8.33.3. Deleting an ODBC monitor resource

Delete a resource by specifying the monitor resource type and monitor resource name.

clpcfadm.py del mon odbcw odbcw1

8.34. Oracle monitor resource

Note

The command lines in this section use oraclew1 as the monitor resource name.
Change it to suit your environment.

8.34.1. Adding an Oracle monitor resource

Be sure to set the following items. For details, see "Setting Oracle monitor resource parameters".

Item (mandatory)

Monitor resource name

Target Resource (monitored when active)

Connect Command

Recovery target

Recovery target type

clpcfadm.py add mon oraclew oraclew1
clpcfadm.py mod -t monitor/oraclew@oraclew1/target --set <Target Resource (monitored when active)>
clpcfadm.py mod -t monitor/oraclew@oraclew1/agentparam/dbname --set <Connect Command> --nocheck
clpcfadm.py mod -t monitor/oraclew@oraclew1/relation/name --set <Recovery target> --nocheck
clpcfadm.py mod -t monitor/oraclew@oraclew1/relation/type --set <Recovery target type> --nocheck

Note

If you configure a cluster only with the above mandatory items, other parameters are set to their default values.

8.34.2. Setting Oracle monitor resource parameters

8.34.2.1. Basic information

  • Monitor resource name (Within 31 bytes)

    This is set when the resource is added. To change the monitor resource name, delete the resource and set it again.

  • Comment (Within 127 bytes)

    clpcfadm.py mod -t monitor/oraclew@oraclew1/comment --set <Comment>

    Note

    Enclose in double quotes a string including spaces (e.g., "Sample Comment").

8.34.2.2. Monitor (common)

  • Interval (sec)

    Default, 60 (minimum, 1; maximum, 999)

    clpcfadm.py mod -t monitor/oraclew@oraclew1/polling/interval --set <Value>
  • Timeout (sec)

    Default, 120 (minimum, 5; maximum, 999)

    clpcfadm.py mod -t monitor/oraclew@oraclew1/polling/timeout --set <Value>
  • Do Not Retry at Timeout Occurrence

    Do Not Retry at Timeout Occurrence

    Value

    Retry (default)

    0

    Do not retry

    1

    clpcfadm.py mod -t monitor/oraclew@oraclew1/emergency/timeout/notreconfirmation/use --set <Value>
  • Action at Timeout Occurrence

    Action at Timeout Occurrence

    Value

    Recover (default)

    0

    Do not recover

    1

    Generate an intentional stop error

    2

    clpcfadm.py mod -t monitor/oraclew@oraclew1/emergency/timeout/notrecovery/use --set <Value>

    Note

    Set as above with "Do Not Retry at Timeout Occurrence" set to "Do not retry".

  • Retry Count

    Default, 2 (minimum, 0; maximum, 999)

    clpcfadm.py mod -t monitor/oraclew@oraclew1/polling/reconfirmation --set <Value>
  • Wait Time to Start Monitoring (sec)

    Default, 0 (minimum, 0; maximum, 9999)

    clpcfadm.py mod -t monitor/oraclew@oraclew1/firstmonwait --set <Value>
  • Target Resource (monitored when active)

    clpcfadm.py mod -t monitor/oraclew@oraclew1/target --set <Target Resource (monitored when active)>
  • Choose servers that execute monitoring

    clpcfadm.py mod -t monitor/oraclew@oraclew1/polling/servers@<ID>/name --set <Server name> --nocheck

    Note

    With only one server to be monitored, specify 0 for ID.
    With more than one server to be monitored, specify consecutive numbers (e.g., 0, 1, 2...).
  • Send polling time metrics

    Send polling time metrics

    Value

    Send

    1

    Do not send (default)

    0

    clpcfadm.py mod -t monitor/oraclew@oraclew1/perf/metrics/use --set <Value>

8.34.2.3. Monitor (special)

  • Monitor Method

    Monitor Method

    Value

    Listener and Instance Monitor (default)

    0

    Listener Monitor

    1

    Instance Monitor

    2

    clpcfadm.py mod -t monitor/oraclew@oraclew1/agentparam/monmethod --set <Value>
  • Monitor Level

    Monitor Level

    Value

    Level 0 (database status)

    2

    Level 1 (monitoring by select)

    3

    Level 2 (monitoring by update/select) (default)

    0

    clpcfadm.py mod -t monitor/oraclew@oraclew1/agentparam/docreatedrop --set <Value>
  • Connect Command (Within 255 bytes)

    clpcfadm.py mod -t monitor/oraclew@oraclew1/agentparam/dbname --set <Connect Command> --nocheck
  • User Name (Within 255 bytes)

    Default: sys

    clpcfadm.py mod -t monitor/oraclew@oraclew1/agentparam/username --set <User Name>
  • Password (Within 255 bytes)

    clpcfadm.py mod -t monitor/oraclew@oraclew1/agentparam/password --set <Encrypted password>

    Note

    Set an encrypted password string.
  • OS Authentication

    OS Authentication

    Value

    Perform OS authentication

    1

    Do not perform OS authentication (default)

    0

    clpcfadm.py mod -t monitor/oraclew@oraclew1/agentparam/os --set <Value>
  • Authority Method

    Authority Method

    Value

    SYSDBA (default)

    0

    DEFAULT

    1

    clpcfadm.py mod -t monitor/oraclew@oraclew1/agentparam/certificate --set <Value>
  • Monitor Table Name (Within 255 bytes)

    Default: ORAWATCH

    clpcfadm.py mod -t monitor/oraclew@oraclew1/agentparam/tablename --set <Monitor Table Name>
  • ORACLE_HOME (Within 255 bytes)

    clpcfadm.py mod -t monitor/oraclew@oraclew1/agentparam/oraclehome --set <ORACLE_HOME>
  • Character Set

    Value

    (Following the setting of the application)

    AMERICAN_AMERICA.US7ASCII

    clpcfadm.py mod -t monitor/oraclew@oraclew1/agentparam/characterset --set <Value> --nocheck
  • Collect detailed application information at failure occurrence

    Collect detailed application information at failure occurrence

    Value

    Collect

    1

    Do not collect (default)

    0

    clpcfadm.py mod -t monitor/oraclew@oraclew1/emergency/infocollect/use --set <Value>
  • Collection Timeout (sec)

    Default, 600 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t monitor/oraclew@oraclew1/emergency/infocollect/timeout --set <Value>

    Note

    Set as above with "Collect detailed application information at failure occurrence" set to "Collect".

  • Set error during Oracle initialization or shutdown

    Set error during Oracle initialization or shutdown

    Value

    Yes

    1

    No (default)

    0

    clpcfadm.py mod -t monitor/oraclew@oraclew1/agentparam/ignoreuse --set <Value>

8.34.2.4. Recovery Action

  • Recovery target

    Recovery target

    Recovery target type

    Local server

    LocalServer

    cls

    All groups([All Groups])

    ""

    grp

    Failover group name

    (Failover group name)

    grp

    Group resource name

    (Group resource name)

    rsc

    clpcfadm.py mod -t monitor/oraclew@oraclew1/relation/name --set <Recovery target> --nocheck
    clpcfadm.py mod -t monitor/oraclew@oraclew1/relation/type --set <Recovery target type> --nocheck

    Important

    If you set "Recovery target" to "Local server"

    Set "Maximum Reactivation Count" and "Maximum Failover Count" to 0 (times).

    clpcfadm.py mod -t monitor/oraclew@oraclew1/emergency/threshold/restart --set 0
    clpcfadm.py mod -t monitor/oraclew@oraclew1/emergency/threshold/fo2 --set 0

    If the current setting for "Final Action" is "Stop resource (16)" or "Stop Group (2)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/oraclew@oraclew1/emergency/action --set 1

    Important

    If you set "Recovery target" to "All groups ([All Groups])"

    Set "Maximum Reactivation Count" to 0 (times).

    clpcfadm.py mod -t monitor/oraclew@oraclew1/emergency/threshold/restart --set 0

    If the current setting for "Final Action" is "Stop resource (16)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/oraclew@oraclew1/emergency/action --set 1
  • Recovery Script Execution Count

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/oraclew@oraclew1/emergency/threshold/script --set <Value>
  • Execute Script before Reactivation

    Execute Script before Reactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/oraclew@oraclew1/emergency/preaction/userestart --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Maximum Reactivation Count

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/oraclew@oraclew1/emergency/threshold/restart --set <Value>
  • Execute Script before Failover

    Execute Script before Failover

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/oraclew@oraclew1/emergency/preaction/usefailover --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Failover Target Server

    Failover Target Server

    Value

    Stable server (default)

    1

    Maximum priority server

    0

    clpcfadm.py mod -t monitor/oraclew@oraclew1/emergency/mode --set <Value>
  • Maximum Failover Count

    Default, 1 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/oraclew@oraclew1/emergency/threshold/fo2 --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/oraclew@oraclew1/emergency/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Final Action

    Final Action
    Value

    No operation

    1

    Stop resource 63

    16

    Stop group 64

    2

    Stop the cluster service

    3

    Stop the cluster service and shutdown OS (default)

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t monitor/oraclew@oraclew1/emergency/action --set <Value>
    63

    Cannot be specified with "Recovery target type" set to "cls" or "grp".

    64

    Cannot be specified with "Recovery target type" set to "cls".

Script Settings
  • File type

    Script file type

    Value

    Script created with this product (default)

    1

    User Application

    0

    clpcfadm.py mod -t monitor/oraclew@oraclew1/emergency/preaction/default --set <Value>

    Note

    If you change the value of this parameter, also change that of "File".

  • File (Within 1023 bytes)

    clpcfadm.py mod -t monitor/oraclew@oraclew1/emergency/preaction/path --set <File> --nocheck

    Note

    If you specify "Script created with this product", specify preaction.bat.

    clpcfadm.py mod -t monitor/oraclew@oraclew1/emergency/preaction/path --set preaction.bat --nocheck
  • Timeout (sec)

    Default, 5 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t monitor/oraclew@oraclew1/emergency/preaction/timeout --set <Value>
  • Exec User

    clpcfadm.py mod -t monitor/oraclew@oraclew1/emergency/preaction/account --set <Exec User>

8.34.3. Deleting an Oracle monitor resource

Delete a resource by specifying the monitor resource type and monitor resource name.

clpcfadm.py del mon oraclew oraclew1

8.35. WebOTX monitor resource

Note

The command lines in this section use otxw1 as the monitor resource name.
Change it to suit your environment.

8.35.1. Adding a WebOTX monitor resource

Be sure to set the following items. For details, see "Setting WebOTX monitor resource parameters".

Item (mandatory)

Monitor resource name

Target Resource (monitored when active)

User Name

Recovery target

Recovery target type

clpcfadm.py add mon otxw otxw1
clpcfadm.py mod -t monitor/otxw@otxw1/target --set <Target Resource (monitored when active)>
clpcfadm.py mod -t monitor/otxw@otxw1/parameters/username --set <User Name>
clpcfadm.py mod -t monitor/otxw@otxw1/relation/name --set <Recovery target> --nocheck
clpcfadm.py mod -t monitor/otxw@otxw1/relation/type --set <Recovery target type> --nocheck

Note

If you configure a cluster only with the above mandatory items, other parameters are set to their default values.

8.35.2. Setting WebOTX monitor resource parameters

8.35.2.1. Basic information

  • Monitor resource name (Within 31 bytes)

    This is set when the resource is added. To change the monitor resource name, delete the resource and set it again.

  • Comment (Within 127 bytes)

    clpcfadm.py mod -t monitor/otxw@otxw1/comment --set <Comment>

    Note

    Enclose in double quotes a string including spaces (e.g., "Sample Comment").

8.35.2.2. Monitor (common)

  • Interval (sec)

    Default, 60 (minimum, 1; maximum, 999)

    clpcfadm.py mod -t monitor/otxw@otxw1/polling/interval --set <Value>
  • Timeout (sec)

    Default, 120 (minimum, 5; maximum, 999)

    clpcfadm.py mod -t monitor/otxw@otxw1/polling/timeout --set <Value>
  • Do Not Retry at Timeout Occurrence

    Do Not Retry at Timeout Occurrence

    Value

    Retry (default)

    0

    Do not retry

    1

    clpcfadm.py mod -t monitor/otxw@otxw1/emergency/timeout/notreconfirmation/use --set <Value>
  • Action at Timeout Occurrence

    Action at Timeout Occurrence

    Value

    Recover (default)

    0

    Do not recover

    1

    Generate an intentional stop error

    2

    clpcfadm.py mod -t monitor/otxw@otxw1/emergency/timeout/notrecovery/use --set <Value>

    Note

    Set as above with "Do Not Retry at Timeout Occurrence" set to "Do not retry".

  • Retry Count

    Default, 1 (minimum, 0; maximum, 999)

    clpcfadm.py mod -t monitor/otxw@otxw1/polling/reconfirmation --set <Value>
  • Wait Time to Start Monitoring (sec)

    Default, 0 (minimum, 0; maximum, 9999)

    clpcfadm.py mod -t monitor/otxw@otxw1/firstmonwait --set <Value>
  • Target Resource (monitored when active)

    clpcfadm.py mod -t monitor/otxw@otxw1/target --set <Target Resource (monitored when active)>
  • Choose servers that execute monitoring

    clpcfadm.py mod -t monitor/otxw@otxw1/polling/servers@<ID>/name --set <Server name> --nocheck

    Note

    With only one server to be monitored, specify 0 for ID.
    With more than one server to be monitored, specify consecutive numbers (e.g., 0, 1, 2...).
  • Send polling time metrics

    Send polling time metrics

    Value

    Send

    1

    Do not send (default)

    0

    clpcfadm.py mod -t monitor/otxw@otxw1/perf/metrics/use --set <Value>

8.35.2.3. Monitor (special)

  • Connecting Destination (Within 255 bytes)

    Default: localhost

    clpcfadm.py mod -t monitor/otxw@otxw1/parameters/servername --set <Connecting Destination>
  • Port Number

    Default, 6212 (minimum, 1; maximum, 65535)

    clpcfadm.py mod -t monitor/otxw@otxw1/parameters/port --set <Value>
  • User Name (Within 255 bytes)

    clpcfadm.py mod -t monitor/otxw@otxw1/parameters/username --set <User Name>
  • Password (Within 255 bytes)

    clpcfadm.py mod -t monitor/otxw@otxw1/parameters/password --set <Encrypted password>

    Note

    Set an encrypted password string.
  • Install Path (Within 1023 bytes)

    clpcfadm.py mod -t monitor/otxw@otxw1/parameters/installpath --set <Install Path>

8.35.2.4. Recovery Action

  • Recovery target

    Recovery target

    Recovery target type

    Local server

    LocalServer

    cls

    All groups([All Groups])

    ""

    grp

    Failover group name

    (Failover group name)

    grp

    Group resource name

    (Group resource name)

    rsc

    clpcfadm.py mod -t monitor/otxw@otxw1/relation/name --set <Recovery target> --nocheck
    clpcfadm.py mod -t monitor/otxw@otxw1/relation/type --set <Recovery target type> --nocheck

    Important

    If you set "Recovery target" to "Local server"

    Set "Maximum Reactivation Count" and "Maximum Failover Count" to 0 (times).

    clpcfadm.py mod -t monitor/otxw@otxw1/emergency/threshold/restart --set 0
    clpcfadm.py mod -t monitor/otxw@otxw1/emergency/threshold/fo2 --set 0

    If the current setting for "Final Action" is "Stop resource (16)" or "Stop Group (2)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/otxw@otxw1/emergency/action --set 1

    Important

    If you set "Recovery target" to "All groups ([All Groups])"

    Set "Maximum Reactivation Count" to 0 (times).

    clpcfadm.py mod -t monitor/otxw@otxw1/emergency/threshold/restart --set 0

    If the current setting for "Final Action" is "Stop resource (16)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/otxw@otxw1/emergency/action --set 1
  • Recovery Script Execution Count

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/otxw@otxw1/emergency/threshold/script --set <Value>
  • Execute Script before Reactivation

    Execute Script before Reactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/otxw@otxw1/emergency/preaction/userestart --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Maximum Reactivation Count

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/otxw@otxw1/emergency/threshold/restart --set <Value>
  • Execute Script before Failover

    Execute Script before Failover

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/otxw@otxw1/emergency/preaction/usefailover --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Failover Target Server

    Failover Target Server

    Value

    Stable server (default)

    1

    Maximum priority server

    0

    clpcfadm.py mod -t monitor/otxw@otxw1/emergency/mode --set <Value>
  • Maximum Failover Count

    Default, 1 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/otxw@otxw1/emergency/threshold/fo2 --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/otxw@otxw1/emergency/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Final Action

    Final Action
    Value

    No operation

    1

    Stop resource 65

    16

    Stop group 66

    2

    Stop the cluster service

    3

    Stop the cluster service and shutdown OS (default)

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t monitor/otxw@otxw1/emergency/action --set <Value>
    65

    Cannot be specified with "Recovery target type" set to "cls" or "grp".

    66

    Cannot be specified with "Recovery target type" set to "cls".

Script Settings
  • File type

    Script file type

    Value

    Script created with this product (default)

    1

    User Application

    0

    clpcfadm.py mod -t monitor/otxw@otxw1/emergency/preaction/default --set <Value>

    Note

    If you change the value of this parameter, also change that of "File".

  • File (Within 1023 bytes)

    clpcfadm.py mod -t monitor/otxw@otxw1/emergency/preaction/path --set <File> --nocheck

    Note

    If you specify "Script created with this product", specify preaction.bat.

    clpcfadm.py mod -t monitor/otxw@otxw1/emergency/preaction/path --set preaction.bat --nocheck
  • Timeout (sec)

    Default, 5 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t monitor/otxw@otxw1/emergency/preaction/timeout --set <Value>
  • Exec User

    clpcfadm.py mod -t monitor/otxw@otxw1/emergency/preaction/account --set <Exec User>

8.35.3. Deleting a WebOTX monitor resource

Delete a resource by specifying the monitor resource type and monitor resource name.

clpcfadm.py del mon otxw otxw1

8.36. POP3 monitor resource

Note

The command lines in this section use pop3w1 as the monitor resource name.
Change it to suit your environment.

8.36.1. Adding a POP3 monitor resource

Be sure to set the following items. For details, see "Setting POP3 monitor resource parameters".

Item (mandatory)

Monitor resource name

Target Resource (monitored when active)

Recovery target

Recovery target type

clpcfadm.py add mon pop3w pop3w1
clpcfadm.py mod -t monitor/pop3w@pop3w1/target --set <Target Resource (monitored when active)>
clpcfadm.py mod -t monitor/pop3w@pop3w1/relation/name --set <Recovery target> --nocheck
clpcfadm.py mod -t monitor/pop3w@pop3w1/relation/type --set <Recovery target type> --nocheck

Note

If you configure a cluster only with the above mandatory items, other parameters are set to their default values.

8.36.2. Setting POP3 monitor resource parameters

8.36.2.1. Basic information

  • Monitor resource name (Within 31 bytes)

    This is set when the resource is added. To change the monitor resource name, delete the resource and set it again.

  • Comment (Within 127 bytes)

    clpcfadm.py mod -t monitor/pop3w@pop3w1/comment --set <Comment>

    Note

    Enclose in double quotes a string including spaces (e.g., "Sample Comment").

8.36.2.2. Monitor (common)

  • Interval (sec)

    Default, 30 (minimum, 1; maximum, 999)

    clpcfadm.py mod -t monitor/pop3w@pop3w1/polling/interval --set <Value>
  • Timeout (sec)

    Default, 60 (minimum, 5; maximum, 999)

    clpcfadm.py mod -t monitor/pop3w@pop3w1/polling/timeout --set <Value>
  • Do Not Retry at Timeout Occurrence

    Do Not Retry at Timeout Occurrence

    Value

    Retry (default)

    0

    Do not retry

    1

    clpcfadm.py mod -t monitor/pop3w@pop3w1/emergency/timeout/notreconfirmation/use --set <Value>
  • Action at Timeout Occurrence

    Action at Timeout Occurrence

    Value

    Recover (default)

    0

    Do not recover

    1

    Generate an intentional stop error

    2

    clpcfadm.py mod -t monitor/pop3w@pop3w1/emergency/timeout/notrecovery/use --set <Value>

    Note

    Set as above with "Do Not Retry at Timeout Occurrence" set to "Do not retry".

  • Retry Count

    Default, 3 (minimum, 0; maximum, 999)

    clpcfadm.py mod -t monitor/pop3w@pop3w1/polling/reconfirmation --set <Value>
  • Wait Time to Start Monitoring (sec)

    Default, 0 (minimum, 0; maximum, 9999)

    clpcfadm.py mod -t monitor/pop3w@pop3w1/firstmonwait --set <Value>
  • Target Resource (monitored when active)

    clpcfadm.py mod -t monitor/pop3w@pop3w1/target --set <Target Resource (monitored when active)>
  • Choose servers that execute monitoring

    clpcfadm.py mod -t monitor/pop3w@pop3w1/polling/servers@<ID>/name --set <Server name> --nocheck

    Note

    With only one server to be monitored, specify 0 for ID.
    With more than one server to be monitored, specify consecutive numbers (e.g., 0, 1, 2...).
  • Send polling time metrics

    Send polling time metrics

    Value

    Send

    1

    Do not send (default)

    0

    clpcfadm.py mod -t monitor/pop3w@pop3w1/perf/metrics/use --set <Value>

8.36.2.3. Monitor (special)

  • IP Address

    Default: 127.0.0.1

    clpcfadm.py mod -t monitor/pop3w@pop3w1/agentparam/ipaddress --set <IP Address>
  • Port Number

    Default, 110 (minimum, 1; maximum, 65535)

    clpcfadm.py mod -t monitor/pop3w@pop3w1/agentparam/port --set <Value>
  • User Name (Within 255 bytes)

    clpcfadm.py mod -t monitor/pop3w@pop3w1/agentparam/username --set <User Name>
  • Password (Within 255 bytes)

    clpcfadm.py mod -t monitor/pop3w@pop3w1/agentparam/password --set <Encrypted password>

    Note

    Set an encrypted password string.
  • Authentication Method

    Authentication Method

    Value

    APOP (default)

    0

    USER/PASS

    1

    clpcfadm.py mod -t monitor/pop3w@pop3w1/agentparam/certificate --set <Value>

8.36.2.4. Recovery Action

  • Recovery target

    Recovery target

    Recovery target type

    Local server

    LocalServer

    cls

    All groups([All Groups])

    ""

    grp

    Failover group name

    (Failover group name)

    grp

    Group resource name

    (Group resource name)

    rsc

    clpcfadm.py mod -t monitor/pop3w@pop3w1/relation/name --set <Recovery target> --nocheck
    clpcfadm.py mod -t monitor/pop3w@pop3w1/relation/type --set <Recovery target type> --nocheck

    Important

    If you set "Recovery target" to "Local server"

    Set "Maximum Reactivation Count" and "Maximum Failover Count" to 0 (times).

    clpcfadm.py mod -t monitor/pop3w@pop3w1/emergency/threshold/restart --set 0
    clpcfadm.py mod -t monitor/pop3w@pop3w1/emergency/threshold/fo2 --set 0

    If the current setting for "Final Action" is "Stop resource (16)" or "Stop Group (2)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/pop3w@pop3w1/emergency/action --set 1

    Important

    If you set "Recovery target" to "All groups ([All Groups])"

    Set "Maximum Reactivation Count" to 0 (times).

    clpcfadm.py mod -t monitor/pop3w@pop3w1/emergency/threshold/restart --set 0

    If the current setting for "Final Action" is "Stop resource (16)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/pop3w@pop3w1/emergency/action --set 1
  • Recovery Script Execution Count

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/pop3w@pop3w1/emergency/threshold/script --set <Value>
  • Execute Script before Reactivation

    Execute Script before Reactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/pop3w@pop3w1/emergency/preaction/userestart --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Maximum Reactivation Count

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/pop3w@pop3w1/emergency/threshold/restart --set <Value>
  • Execute Script before Failover

    Execute Script before Failover

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/pop3w@pop3w1/emergency/preaction/usefailover --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Failover Target Server

    Failover Target Server

    Value

    Stable server (default)

    1

    Maximum priority server

    0

    clpcfadm.py mod -t monitor/pop3w@pop3w1/emergency/mode --set <Value>
  • Maximum Failover Count

    Default, 1 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/pop3w@pop3w1/emergency/threshold/fo2 --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/pop3w@pop3w1/emergency/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Final Action

    Final Action
    Value

    No operation

    1

    Stop resource 67

    16

    Stop group 68

    2

    Stop the cluster service

    3

    Stop the cluster service and shutdown OS (default)

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t monitor/pop3w@pop3w1/emergency/action --set <Value>
    67

    Cannot be specified with "Recovery target type" set to "cls" or "grp".

    68

    Cannot be specified with "Recovery target type" set to "cls".

Script Settings
  • File type

    Script file type

    Value

    Script created with this product (default)

    1

    User Application

    0

    clpcfadm.py mod -t monitor/pop3w@pop3w1/emergency/preaction/default --set <Value>

    Note

    If you change the value of this parameter, also change that of "File".

  • File (Within 1023 bytes)

    clpcfadm.py mod -t monitor/pop3w@pop3w1/emergency/preaction/path --set <File> --nocheck

    Note

    If you specify "Script created with this product", specify preaction.bat.

    clpcfadm.py mod -t monitor/pop3w@pop3w1/emergency/preaction/path --set preaction.bat --nocheck
  • Timeout (sec)

    Default, 5 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t monitor/pop3w@pop3w1/emergency/preaction/timeout --set <Value>
  • Exec User

    clpcfadm.py mod -t monitor/pop3w@pop3w1/emergency/preaction/account --set <Exec User>

8.36.3. Deleting a POP3 monitor resource

Delete a resource by specifying the monitor resource type and monitor resource name.

clpcfadm.py del mon pop3w pop3w1

8.37. PostgreSQL monitor resource

Note

The command lines in this section use psqlw1 as the monitor resource name.
Change it to suit your environment.

8.37.1. Adding a PostgreSQL monitor resource

Be sure to set the following items. For details, see "Setting PostgreSQL monitor resource parameters".

Item (mandatory)

Monitor resource name

Target Resource (monitored when active)

Database Name

Recovery target

Recovery target type

clpcfadm.py add mon psqlw psqlw1
clpcfadm.py mod -t monitor/psqlw@psqlw1/target --set <Target Resource (monitored when active)>
clpcfadm.py mod -t monitor/psqlw@psqlw1/agentparam/dbname --set <Database Name> --nocheck
clpcfadm.py mod -t monitor/psqlw@psqlw1/relation/name --set <Recovery target> --nocheck
clpcfadm.py mod -t monitor/psqlw@psqlw1/relation/type --set <Recovery target type> --nocheck

Note

If you configure a cluster only with the above mandatory items, other parameters are set to their default values.

8.37.2. Setting PostgreSQL monitor resource parameters

8.37.2.1. Basic information

  • Monitor resource name (Within 31 bytes)

    This is set when the resource is added. To change the monitor resource name, delete the resource and set it again.

  • Comment (Within 127 bytes)

    clpcfadm.py mod -t monitor/psqlw@psqlw1/comment --set <Comment>

    Note

    Enclose in double quotes a string including spaces (e.g., "Sample Comment").

8.37.2.2. Monitor (common)

  • Interval (sec)

    Default, 60 (minimum, 1; maximum, 999)

    clpcfadm.py mod -t monitor/psqlw@psqlw1/polling/interval --set <Value>
  • Timeout (sec)

    Default, 120 (minimum, 5; maximum, 999)

    clpcfadm.py mod -t monitor/psqlw@psqlw1/polling/timeout --set <Value>
  • Do Not Retry at Timeout Occurrence

    Do Not Retry at Timeout Occurrence

    Value

    Retry (default)

    0

    Do not retry

    1

    clpcfadm.py mod -t monitor/psqlw@psqlw1/emergency/timeout/notreconfirmation/use --set <Value>
  • Action at Timeout Occurrence

    Action at Timeout Occurrence

    Value

    Recover (default)

    0

    Do not recover

    1

    Generate an intentional stop error

    2

    clpcfadm.py mod -t monitor/psqlw@psqlw1/emergency/timeout/notrecovery/use --set <Value>

    Note

    Set as above with "Do Not Retry at Timeout Occurrence" set to "Do not retry".

  • Retry Count

    Default, 2 (minimum, 0; maximum, 999)

    clpcfadm.py mod -t monitor/psqlw@psqlw1/polling/reconfirmation --set <Value>
  • Wait Time to Start Monitoring (sec)

    Default, 0 (minimum, 0; maximum, 9999)

    clpcfadm.py mod -t monitor/psqlw@psqlw1/firstmonwait --set <Value>
  • Target Resource (monitored when active)

    clpcfadm.py mod -t monitor/psqlw@psqlw1/target --set <Target Resource (monitored when active)>
  • Choose servers that execute monitoring

    clpcfadm.py mod -t monitor/psqlw@psqlw1/polling/servers@<ID>/name --set <Server name> --nocheck

    Note

    With only one server to be monitored, specify 0 for ID.
    With more than one server to be monitored, specify consecutive numbers (e.g., 0, 1, 2...).
  • Send polling time metrics

    Send polling time metrics

    Value

    Send

    1

    Do not send (default)

    0

    clpcfadm.py mod -t monitor/psqlw@psqlw1/perf/metrics/use --set <Value>

8.37.2.3. Monitor (special)

  • Monitor Level

    Monitor Level

    Value

    Level 1 (monitoring by select)

    3

    Level 2 (monitoring by update/select) (default)

    0

    clpcfadm.py mod -t monitor/psqlw@psqlw1/agentparam/docreatedrop --set <Value>
  • Database Name (Within 255 bytes)

    clpcfadm.py mod -t monitor/psqlw@psqlw1/agentparam/dbname --set <Database Name> --nocheck
  • IP Address

    Default: 127.0.0.1

    clpcfadm.py mod -t monitor/psqlw@psqlw1/agentparam/ipaddress --set <IP Address>
  • Port Number

    Default, 5432 (minimum, 1; maximum, 65535)

    clpcfadm.py mod -t monitor/psqlw@psqlw1/agentparam/port --set <Value>
  • User Name (Within 255 bytes)

    Default: postgres

    clpcfadm.py mod -t monitor/psqlw@psqlw1/agentparam/username --set <User Name>
  • Password (Within 255 bytes)

    clpcfadm.py mod -t monitor/psqlw@psqlw1/agentparam/password --set <Encrypted password>

    Note

    Set an encrypted password string.
  • Monitor Table Name (Within 255 bytes)

    Default: PSQLWATCH

    clpcfadm.py mod -t monitor/psqlw@psqlw1/agentparam/tablename --set <Monitor Table Name>
  • Set error during PostgreSQL initialization or shutdown

    Set error during PostgreSQL initialization or shutdown

    Value

    Yes (default)

    1

    No

    0

    clpcfadm.py mod -t monitor/psqlw@psqlw1/agentparam/ignoreuse --set <Value>

8.37.2.4. Recovery Action

  • Recovery target

    Recovery target

    Recovery target type

    Local server

    LocalServer

    cls

    All groups([All Groups])

    ""

    grp

    Failover group name

    (Failover group name)

    grp

    Group resource name

    (Group resource name)

    rsc

    clpcfadm.py mod -t monitor/psqlw@psqlw1/relation/name --set <Recovery target> --nocheck
    clpcfadm.py mod -t monitor/psqlw@psqlw1/relation/type --set <Recovery target type> --nocheck

    Important

    If you set "Recovery target" to "Local server"

    Set "Maximum Reactivation Count" and "Maximum Failover Count" to 0 (times).

    clpcfadm.py mod -t monitor/psqlw@psqlw1/emergency/threshold/restart --set 0
    clpcfadm.py mod -t monitor/psqlw@psqlw1/emergency/threshold/fo2 --set 0

    If the current setting for "Final Action" is "Stop resource (16)" or "Stop Group (2)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/psqlw@psqlw1/emergency/action --set 1

    Important

    If you set "Recovery target" to "All groups ([All Groups])"

    Set "Maximum Reactivation Count" to 0 (times).

    clpcfadm.py mod -t monitor/psqlw@psqlw1/emergency/threshold/restart --set 0

    If the current setting for "Final Action" is "Stop resource (16)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/psqlw@psqlw1/emergency/action --set 1
  • Recovery Script Execution Count

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/psqlw@psqlw1/emergency/threshold/script --set <Value>
  • Execute Script before Reactivation

    Execute Script before Reactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/psqlw@psqlw1/emergency/preaction/userestart --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Maximum Reactivation Count

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/psqlw@psqlw1/emergency/threshold/restart --set <Value>
  • Execute Script before Failover

    Execute Script before Failover

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/psqlw@psqlw1/emergency/preaction/usefailover --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Failover Target Server

    Failover Target Server

    Value

    Stable server (default)

    1

    Maximum priority server

    0

    clpcfadm.py mod -t monitor/psqlw@psqlw1/emergency/mode --set <Value>
  • Maximum Failover Count

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/psqlw@psqlw1/emergency/threshold/fo2 --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/psqlw@psqlw1/emergency/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Final Action

    Final Action
    Value

    No operation

    1

    Stop resource 69

    16

    Stop group 70

    2

    Stop the cluster service

    3

    Stop the cluster service and shutdown OS (default)

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t monitor/psqlw@psqlw1/emergency/action --set <Value>
    69

    Cannot be specified with "Recovery target type" set to "cls" or "grp".

    70

    Cannot be specified with "Recovery target type" set to "cls".

Script Settings
  • File type

    Script file type

    Value

    Script created with this product (default)

    1

    User Application

    0

    clpcfadm.py mod -t monitor/psqlw@psqlw1/emergency/preaction/default --set <Value>

    Note

    If you change the value of this parameter, also change that of "File".

  • File (Within 1023 bytes)

    clpcfadm.py mod -t monitor/psqlw@psqlw1/emergency/preaction/path --set <File> --nocheck

    Note

    If you specify "Script created with this product", specify preaction.bat.

    clpcfadm.py mod -t monitor/psqlw@psqlw1/emergency/preaction/path --set preaction.bat --nocheck
  • Timeout (sec)

    Default, 5 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t monitor/psqlw@psqlw1/emergency/preaction/timeout --set <Value>
  • Exec User

    clpcfadm.py mod -t monitor/psqlw@psqlw1/emergency/preaction/account --set <Exec User>

8.37.3. Deleting a PostgreSQL monitor resources

Delete a resource by specifying the monitor resource type and monitor resource name.

clpcfadm.py del mon psqlw psqlw1

8.38. Process resource monitor resource

Note

The command lines in this section use psrw1 as the monitor resource name.
Change it to suit your environment.

8.38.1. Adding a process resource monitor resource

Be sure to set the following items. For details, see "Setting process resource monitor resource parameters".

Item (mandatory)

Monitor resource name

Recovery target

Recovery target type

clpcfadm.py add mon psrw psrw1
clpcfadm.py mod -t monitor/psrw@psrw1/relation/name --set <Recovery target> --nocheck
clpcfadm.py mod -t monitor/psrw@psrw1/relation/type --set <Recovery target type> --nocheck

Note

If you configure a cluster only with the above mandatory items, other parameters are set to their default values.

8.38.2. Setting process resource monitor resource parameters

8.38.2.1. Basic information

  • Monitor resource name (Within 31 bytes)

    This is set when the resource is added. To change the monitor resource name, delete the resource and set it again.

  • Comment (Within 127 bytes)

    clpcfadm.py mod -t monitor/psrw@psrw1/comment --set <Comment>

    Note

    Enclose in double quotes a string including spaces (e.g., "Sample Comment").

8.38.2.2. Monitor (common)

  • Interval (sec)

    Default, 30 (minimum, 1; maximum, 999)

    clpcfadm.py mod -t monitor/psrw@psrw1/polling/interval --set <Value>
  • Timeout (sec)

    Default, 60 (minimum, 5; maximum, 999)

    clpcfadm.py mod -t monitor/psrw@psrw1/polling/timeout --set <Value>
  • Retry Count

    Default, 0 (minimum, 0; maximum, 999)

    clpcfadm.py mod -t monitor/psrw@psrw1/polling/reconfirmation --set <Value>
  • Wait Time to Start Monitoring (sec)

    Default, 0 (minimum, 0; maximum, 9999)

    clpcfadm.py mod -t monitor/psrw@psrw1/firstmonwait --set <Value>
  • Choose servers that execute monitoring

    clpcfadm.py mod -t monitor/psrw@psrw1/polling/servers@<ID>/name --set <Server name> --nocheck

    Note

    With only one server to be monitored, specify 0 for ID.
    With more than one server to be monitored, specify consecutive numbers (e.g., 0, 1, 2...).
  • Send polling time metrics

    Send polling time metrics

    Value

    Send

    1

    Do not send (default)

    0

    clpcfadm.py mod -t monitor/psrw@psrw1/perf/metrics/use --set <Value>

8.38.2.3. Monitor (special)

  • Process Name (Within 1023 bytes)

    clpcfadm.py mod -t monitor/psrw@psrw1/parameters/process/name --set <Process Name>
  • Monitoring CPU usage

    Monitoring CPU usage

    Value

    Monitor (default)

    1

    Do not monitor

    0

    clpcfadm.py mod -t monitor/psrw@psrw1/parameters/process/cpu/docheck --set <Value>
    • CPU usage (%)

      Default, 90 (minimum, 1; maximum, 100)

      clpcfadm.py mod -t monitor/psrw@psrw1/parameters/process/cpu/rate --set <Value>

      Note

      Set as above with "Monitoring CPU usage" set to "Monitor".

    • Duration Time (min)

      Default, 1440 (minimum, 1; maximum, 4320)

      clpcfadm.py mod -t monitor/psrw@psrw1/parameters/process/cpu/count --set <Value>

      Note

      Set as above with "Monitoring CPU usage" set to "Monitor".

  • Monitoring usage of memory

    Monitoring usage of memory

    Value

    Monitor (default)

    1

    Do not monitor

    0

    clpcfadm.py mod -t monitor/psrw@psrw1/parameters/process/memory/docheck --set <Value>
    • Rate of Increase from the First Monitoring Point (%)

      Default, 10 (minimum, 1; maximum, 1000)

      clpcfadm.py mod -t monitor/psrw@psrw1/parameters/process/memory/rate --set <Value>

      Note

      Set as above with "Monitoring usage of memory" set to "Monitor".

    • Maximum Refresh Count

      Default, 1440 (minimum, 1; maximum, 4320)

      clpcfadm.py mod -t monitor/psrw@psrw1/parameters/process/memory/count --set <Value>

      Note

      Set as above with "Monitoring usage of memory" set to "Monitor".

  • Monitoring number of opening files (maximum number)

    Monitoring number of opening files (maximum number)

    Value

    Monitor

    1

    Do not monitor (default)

    0

    clpcfadm.py mod -t monitor/psrw@psrw1/parameters/process/fileleak/docheck --set <Value>
    • Refresh Count

      Default, 1440 (minimum, 1; maximum, 4320)

      clpcfadm.py mod -t monitor/psrw@psrw1/parameters/process/fileleak/count --set <Value>

      Note

      Set as above with "Monitoring number of opening files (maximum number)" set to "Monitor".

  • Monitoring number of running threads

    Monitoring number of running threads

    Value

    Monitor (default)

    1

    Do not monitor

    0

    clpcfadm.py mod -t monitor/psrw@psrw1/parameters/process/thread/docheck --set <Value>
    • Duration Time (min)

      Default, 1440 (minimum, 1; maximum, 4320)

      clpcfadm.py mod -t monitor/psrw@psrw1/parameters/process/thread/count --set <Value>

      Note

      Set as above with "Monitoring number of running threads" set to "Monitor".

  • Monitoring Processes of the Same Name

    Monitoring Processes of the Same Name

    Value

    Monitor

    1

    Do not monitor (default)

    0

    clpcfadm.py mod -t monitor/psrw@psrw1/parameters/process/proccount/docheck --set <Value>
    • Count

      Default, 100 (minimum, 1; maximum, 10000)

      clpcfadm.py mod -t monitor/psrw@psrw1/parameters/process/proccount/number --set <Value>

    Note

    You can set this parameter with "Monitoring Processes of the Same Name" set to "Monitor".

8.38.2.4. Recovery Action

  • Recovery target

    Recovery target

    Recovery target type

    Local server

    LocalServer

    cls

    All groups([All Groups])

    ""

    grp

    Failover group name

    (Failover group name)

    grp

    Group resource name

    (Group resource name)

    rsc

    clpcfadm.py mod -t monitor/psrw@psrw1/relation/name --set <Recovery target> --nocheck
    clpcfadm.py mod -t monitor/psrw@psrw1/relation/type --set <Recovery target type> --nocheck

    Important

    If you set "Recovery target" to "Local server"

    Set "Maximum Reactivation Count" and "Maximum Failover Count" to 0 (times).

    clpcfadm.py mod -t monitor/psrw@psrw1/emergency/threshold/restart --set 0
    clpcfadm.py mod -t monitor/psrw@psrw1/emergency/threshold/fo2 --set 0

    If the current setting for "Final Action" is "Stop resource (16)" or "Stop Group (2)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/psrw@psrw1/emergency/action --set 1

    Important

    If you set "Recovery target" to "All groups ([All Groups])"

    Set "Maximum Reactivation Count" to 0 (times).

    clpcfadm.py mod -t monitor/psrw@psrw1/emergency/threshold/restart --set 0

    If the current setting for "Final Action" is "Stop resource (16)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/psrw@psrw1/emergency/action --set 1
  • Recovery Script Execution Count

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/psrw@psrw1/emergency/threshold/script --set <Value>
  • Execute Script before Reactivation

    Execute Script before Reactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/psrw@psrw1/emergency/preaction/userestart --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Maximum Reactivation Count

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/psrw@psrw1/emergency/threshold/restart --set <Value>
  • Execute Script before Failover

    Execute Script before Failover

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/psrw@psrw1/emergency/preaction/usefailover --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Failover Target Server

    Failover Target Server

    Value

    Stable server (default)

    1

    Maximum priority server

    0

    clpcfadm.py mod -t monitor/psrw@psrw1/emergency/mode --set <Value>
  • Maximum Failover Count

    Default, 1 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/psrw@psrw1/emergency/threshold/fo2 --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/psrw@psrw1/emergency/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Final Action

    Final Action
    Value

    No operation (default)

    1

    Stop resource 71

    16

    Stop group 72

    2

    Stop the cluster service

    3

    Stop the cluster service and shutdown OS

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t monitor/psrw@psrw1/emergency/action --set <Value>
    71

    Cannot be specified with "Recovery target type" set to "cls" or "grp".

    72

    Cannot be specified with "Recovery target type" set to "cls".

Script Settings
  • File type

    Script file type

    Value

    Script created with this product (default)

    1

    User Application

    0

    clpcfadm.py mod -t monitor/psrw@psrw1/emergency/preaction/default --set <Value>

    Note

    If you change the value of this parameter, also change that of "File".

  • File (Within 1023 bytes)

    clpcfadm.py mod -t monitor/psrw@psrw1/emergency/preaction/path --set <File> --nocheck

    Note

    If you specify "Script created with this product", specify preaction.bat.

    clpcfadm.py mod -t monitor/psrw@psrw1/emergency/preaction/path --set preaction.bat --nocheck
  • Timeout (sec)

    Default, 5 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t monitor/psrw@psrw1/emergency/preaction/timeout --set <Value>
  • Exec User

    clpcfadm.py mod -t monitor/psrw@psrw1/emergency/preaction/account --set <Exec User>

8.38.3. Deleting a process resource monitor resource

Delete a resource by specifying the monitor resource type and monitor resource name.

clpcfadm.py del mon psrw psrw1

8.39. Process name monitor resource

Note

The command lines in this section use psw1 as the monitor resource name.
Change it to suit your environment.

8.39.1. Adding a process name monitor resource

Be sure to set the following items. For details, see "Setting process name monitor resource parameters".

Item (mandatory)

Monitor resource name

Process Name

Recovery target

Recovery target type

clpcfadm.py add mon psw psw1
clpcfadm.py mod -t monitor/psw@psw1/parameters/processname --set <Process Name>
clpcfadm.py mod -t monitor/psw@psw1/relation/name --set <Recovery target> --nocheck
clpcfadm.py mod -t monitor/psw@psw1/relation/type --set <Recovery target type> --nocheck

Note

If you configure a cluster only with the above mandatory items, other parameters are set to their default values.

8.39.2. Setting process name monitor resource parameters

8.39.2.1. Basic information

  • Monitor resource name (Within 31 bytes)

    This is set when the resource is added. To change the monitor resource name, delete the resource and set it again.

  • Comment (Within 127 bytes)

    clpcfadm.py mod -t monitor/psw@psw1/comment --set <Comment>

    Note

    Enclose in double quotes a string including spaces (e.g., "Sample Comment").

8.39.2.2. Monitor (common)

  • Interval (sec)

    Default, 5 (minimum, 1; maximum, 999)

    clpcfadm.py mod -t monitor/psw@psw1/polling/interval --set <Value>
  • Timeout (sec)

    Default, 60 (minimum, 5; maximum, 999)

    clpcfadm.py mod -t monitor/psw@psw1/polling/timeout --set <Value>
  • Do Not Retry at Timeout Occurrence

    Do Not Retry at Timeout Occurrence

    Value

    Retry

    0

    Do not retry (default)

    1

    clpcfadm.py mod -t monitor/psw@psw1/emergency/timeout/notreconfirmation/use --set <Value>
  • Action at Timeout Occurrence

    Action at Timeout Occurrence

    Value

    Recover

    0

    Do not recover (default)

    1

    Generate an intentional stop error

    2

    clpcfadm.py mod -t monitor/psw@psw1/emergency/timeout/notrecovery/use --set <Value>

    Note

    Set as above with "Do Not Retry at Timeout Occurrence" set to "Do not retry".

  • Retry Count

    Default, 0 (minimum, 0; maximum, 999)

    clpcfadm.py mod -t monitor/psw@psw1/polling/reconfirmation --set <Value>
  • Wait Time to Start Monitoring (sec)

    Default, 3 (minimum, 0; maximum, 9999)

    clpcfadm.py mod -t monitor/psw@psw1/firstmonwait --set <Value>
  • Monitoring Timing

    Monitoring Timing

    Value

    Always (default)

    0

    Active

    1

    clpcfadm.py mod -t monitor/psw@psw1/polling/timing --set <Value>

    Note

    If "Monitoring Timing" is set to "Active", set "Target Resource (monitored when active)".

    Important

    If you change the setting for "Monitoring timing" to "Always", set "Target Resource" to blank ("").

    clpcfadm.py mod -t monitor/psw@psw1/target --set ""
  • Target Resource (monitored when active)

    clpcfadm.py mod -t monitor/psw@psw1/target --set <Target Resource (monitored when active)>

    Note

    Set as above with "Monitoring Timing" set to "Active".

  • Choose servers that execute monitoring

    clpcfadm.py mod -t monitor/psw@psw1/polling/servers@<ID>/name --set <Server name> --nocheck

    Note

    With only one server to be monitored, specify 0 for ID.
    With more than one server to be monitored, specify consecutive numbers (e.g., 0, 1, 2...).
  • Send polling time metrics

    Send polling time metrics

    Value

    Send

    1

    Do not send (default)

    0

    clpcfadm.py mod -t monitor/psw@psw1/perf/metrics/use --set <Value>

8.39.2.3. Monitor (special)

  • Process Name (Within 1023 bytes)

    clpcfadm.py mod -t monitor/psw@psw1/parameters/processname --set <Process Name>
  • Minimum Process Count

    Default, 1 (minimum, 1; maximum, 999)

    clpcfadm.py mod -t monitor/psw@psw1/parameters/processnum --set <Value>

8.39.2.4. Recovery Action

  • Recovery target

    Recovery target

    Recovery target type

    Local server

    LocalServer

    cls

    All groups([All Groups])

    ""

    grp

    Failover group name

    (Failover group name)

    grp

    Group resource name

    (Group resource name)

    rsc

    clpcfadm.py mod -t monitor/psw@psw1/relation/name --set <Recovery target> --nocheck
    clpcfadm.py mod -t monitor/psw@psw1/relation/type --set <Recovery target type> --nocheck

    Important

    If you set "Recovery target" to "Local server"

    Set "Maximum Reactivation Count" and "Maximum Failover Count" to 0 (times).

    clpcfadm.py mod -t monitor/psw@psw1/emergency/threshold/restart --set 0
    clpcfadm.py mod -t monitor/psw@psw1/emergency/threshold/fo2 --set 0

    If the current setting for "Final Action" is "Stop resource (16)" or "Stop Group (2)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/psw@psw1/emergency/action --set 1

    Important

    If you set "Recovery target" to "All groups ([All Groups])"

    Set "Maximum Reactivation Count" to 0 (times).

    clpcfadm.py mod -t monitor/psw@psw1/emergency/threshold/restart --set 0

    If the current setting for "Final Action" is "Stop resource (16)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/psw@psw1/emergency/action --set 1
  • Recovery Script Execution Count

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/psw@psw1/emergency/threshold/script --set <Value>
  • Execute Script before Reactivation

    Execute Script before Reactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/psw@psw1/emergency/preaction/userestart --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Maximum Reactivation Count

    Default, 3 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/psw@psw1/emergency/threshold/restart --set <Value>
  • Execute Script before Failover

    Execute Script before Failover

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/psw@psw1/emergency/preaction/usefailover --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Failover Target Server

    Failover Target Server

    Value

    Stable server (default)

    1

    Maximum priority server

    0

    clpcfadm.py mod -t monitor/psw@psw1/emergency/mode --set <Value>
  • Maximum Failover Count

    Default, 1 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/psw@psw1/emergency/threshold/fo2 --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/psw@psw1/emergency/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Final Action

    Final Action
    Value

    No operation (default)

    1

    Stop resource 73

    16

    Stop group 74

    2

    Stop the cluster service

    3

    Stop the cluster service and shutdown OS

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t monitor/psw@psw1/emergency/action --set <Value>
    73

    Cannot be specified with "Recovery target type" set to "cls" or "grp".

    74

    Cannot be specified with "Recovery target type" set to "cls".

Script Settings
  • File type

    Script file type

    Value

    Script created with this product (default)

    1

    User Application

    0

    clpcfadm.py mod -t monitor/psw@psw1/emergency/preaction/default --set <Value>

    Note

    If you change the value of this parameter, also change that of "File".

  • File (Within 1023 bytes)

    clpcfadm.py mod -t monitor/psw@psw1/emergency/preaction/path --set <File> --nocheck

    Note

    If you specify "Script created with this product", specify preaction.bat.

    clpcfadm.py mod -t monitor/psw@psw1/emergency/preaction/path --set preaction.bat --nocheck
  • Timeout (sec)

    Default, 5 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t monitor/psw@psw1/emergency/preaction/timeout --set <Value>
  • Exec User

    clpcfadm.py mod -t monitor/psw@psw1/emergency/preaction/account --set <Exec User>

8.39.3. Deleting a process name monitor resource

Delete a resource by specifying the monitor resource type and monitor resource name.

clpcfadm.py del mon psw psw1

8.40. Registry synchronization monitor resource

Note

The command lines in this section use regsyncw1 as the monitor resource name.
Change it to suit your environment.

8.40.1. Adding a registry synchronization monitor resource

Be sure to set the following items. For details, see "Setting registry synchronization monitor resource parameters".

Item (mandatory)

Monitor resource name

Target Resource (monitored when active)

Recovery target

Recovery target type

clpcfadm.py add mon regsyncw regsyncw1
clpcfadm.py mod -t monitor/regsyncw@regsyncw1/target --set <Target Resource (monitored when active)>
clpcfadm.py mod -t monitor/regsyncw@regsyncw1/relation/name --set <Recovery target> --nocheck
clpcfadm.py mod -t monitor/regsyncw@regsyncw1/relation/type --set <Recovery target type> --nocheck

Note

If you configure a cluster only with the above mandatory items, other parameters are set to their default values.

8.40.2. Setting registry synchronization monitor resource parameters

8.40.2.1. Basic information

  • Monitor resource name (Within 31 bytes)

    This is set when the resource is added. To change the monitor resource name, delete the resource and set it again.

  • Comment (Within 127 bytes)

    clpcfadm.py mod -t monitor/regsyncw@regsyncw1/comment --set <Comment>

    Note

    Enclose in double quotes a string including spaces (e.g., "Sample Comment").

8.40.2.2. Monitor (common)

  • Interval (sec)

    Default, 60 (minimum, 1; maximum, 999)

    clpcfadm.py mod -t monitor/regsyncw@regsyncw1/polling/interval --set <Value>
  • Timeout (sec)

    Default, 60 (minimum, 5; maximum, 999)

    clpcfadm.py mod -t monitor/regsyncw@regsyncw1/polling/timeout --set <Value>
  • Do Not Retry at Timeout Occurrence

    Do Not Retry at Timeout Occurrence

    Value

    Retry

    0

    Do not retry (default)

    1

    clpcfadm.py mod -t monitor/regsyncw@regsyncw1/emergency/timeout/notreconfirmation/use --set <Value>
  • Action at Timeout Occurrence

    Action at Timeout Occurrence

    Value

    Recover

    0

    Do not recover (default)

    1

    Generate an intentional stop error

    2

    clpcfadm.py mod -t monitor/regsyncw@regsyncw1/emergency/timeout/notrecovery/use --set <Value>

    Note

    Set as above with "Do Not Retry at Timeout Occurrence" set to "Do not retry".

  • Retry Count

    Default, 1 (minimum, 0; maximum, 999)

    clpcfadm.py mod -t monitor/regsyncw@regsyncw1/polling/reconfirmation --set <Value>
  • Wait Time to Start Monitoring (sec)

    Default, 0 (minimum, 0; maximum, 9999)

    clpcfadm.py mod -t monitor/regsyncw@regsyncw1/firstmonwait --set <Value>
  • Target Resource (monitored when active)

    clpcfadm.py mod -t monitor/regsyncw@regsyncw1/target --set <Target Resource (monitored when active)>

    Note

    You can specify only a registry synchronization resource for this monitor resource.

  • Send polling time metrics

    Send polling time metrics

    Value

    Send

    1

    Do not send (default)

    0

    clpcfadm.py mod -t monitor/regsyncw@regsyncw1/perf/metrics/use --set <Value>

8.40.2.3. Recovery Action

  • Recovery target

    Recovery target

    Recovery target type

    Local server

    LocalServer

    cls

    All groups([All Groups])

    ""

    grp

    Failover group name

    (Failover group name)

    grp

    Group resource name

    (Group resource name)

    rsc

    clpcfadm.py mod -t monitor/regsyncw@regsyncw1/relation/name --set <Recovery target> --nocheck
    clpcfadm.py mod -t monitor/regsyncw@regsyncw1/relation/type --set <Recovery target type> --nocheck

    Important

    If you set "Recovery target" to "Local server"

    Set "Maximum Reactivation Count" and "Maximum Failover Count" to 0 (times).

    clpcfadm.py mod -t monitor/regsyncw@regsyncw1/emergency/threshold/restart --set 0
    clpcfadm.py mod -t monitor/regsyncw@regsyncw1/emergency/threshold/fo2 --set 0

    If the current setting for "Final Action" is "Stop resource (16)" or "Stop Group (2)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/regsyncw@regsyncw1/emergency/action --set 1

    Important

    If you set "Recovery target" to "All groups ([All Groups])"

    Set "Maximum Reactivation Count" to 0 (times).

    clpcfadm.py mod -t monitor/regsyncw@regsyncw1/emergency/threshold/restart --set 0

    If the current setting for "Final Action" is "Stop resource (16)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/regsyncw@regsyncw1/emergency/action --set 1
  • Recovery Script Execution Count

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/regsyncw@regsyncw1/emergency/threshold/script --set <Value>
  • Execute Script before Reactivation

    Execute Script before Reactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/regsyncw@regsyncw1/emergency/preaction/userestart --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Maximum Reactivation Count

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/regsyncw@regsyncw1/emergency/threshold/restart --set <Value>
  • Execute Script before Failover

    Execute Script before Failover

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/regsyncw@regsyncw1/emergency/preaction/usefailover --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Failover Target Server

    Failover Target Server

    Value

    Stable server (default)

    1

    Maximum priority server

    0

    clpcfadm.py mod -t monitor/regsyncw@regsyncw1/emergency/mode --set <Value>
  • Maximum Failover Count

    Default, 1 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/regsyncw@regsyncw1/emergency/threshold/fo2 --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/regsyncw@regsyncw1/emergency/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Final Action

    Final Action
    Value

    No operation (default)

    1

    Stop resource 75

    16

    Stop group 76

    2

    Stop the cluster service

    3

    Stop the cluster service and shutdown OS

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t monitor/regsyncw@regsyncw1/emergency/action --set <Value>
    75

    Cannot be specified with "Recovery target type" set to "cls" or "grp".

    76

    Cannot be specified with "Recovery target type" set to "cls".

Script Settings
  • File type

    Script file type

    Value

    Script created with this product (default)

    1

    User Application

    0

    clpcfadm.py mod -t monitor/regsyncw@regsyncw1/emergency/preaction/default --set <Value>

    Note

    If you change the value of this parameter, also change that of "File".

  • File (Within 1023 bytes)

    clpcfadm.py mod -t monitor/regsyncw@regsyncw1/emergency/preaction/path --set <File> --nocheck

    Note

    If you specify "Script created with this product", specify preaction.bat.

    clpcfadm.py mod -t monitor/regsyncw@regsyncw1/emergency/preaction/path --set preaction.bat --nocheck
  • Timeout (sec)

    Default, 5 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t monitor/regsyncw@regsyncw1/emergency/preaction/timeout --set <Value>
  • Exec User

    clpcfadm.py mod -t monitor/regsyncw@regsyncw1/emergency/preaction/account --set <Exec User>

8.40.3. Deleting a registry synchronization monitor resource

Delete a resource by specifying the monitor resource type and monitor resource name.

clpcfadm.py del mon regsyncw regsyncw1

8.41. Disk TUR monitor resource

Note

The command lines in this section use sdw1 as the monitor resource name.
Change it to suit your environment.

8.41.1. Adding a disk TUR monitor resource

Be sure to set the following items. For details, see "Setting disk TUR monitor resource parameters".

Item (mandatory)

Monitor resource name

Disk Resource

Recovery target

Recovery target type

clpcfadm.py add mon sdw sdw1
clpcfadm.py mod -t monitor/sdw@sdw1/parameters/object --set <Disk Resource>
clpcfadm.py mod -t monitor/sdw@sdw1/relation/name --set <Recovery target> --nocheck
clpcfadm.py mod -t monitor/sdw@sdw1/relation/type --set <Recovery target type> --nocheck

Note

If you configure a cluster only with the above mandatory items, other parameters are set to their default values.

8.41.2. Setting disk TUR monitor resource parameters

8.41.2.1. Basic information

  • Monitor resource name (Within 31 bytes)

    This is set when the resource is added. To change the monitor resource name, delete the resource and set it again.

  • Comment (Within 127 bytes)

    clpcfadm.py mod -t monitor/sdw@sdw1/comment --set <Comment>

    Note

    Enclose in double quotes a string including spaces (e.g., "Sample Comment").

8.41.2.2. Monitor (common)

  • Interval (sec)

    Default, 30 (minimum, 1; maximum, 999)

    clpcfadm.py mod -t monitor/sdw@sdw1/polling/interval --set <Value>
  • Timeout (sec)

    Default, 300 (minimum, 5; maximum, 999)

    clpcfadm.py mod -t monitor/sdw@sdw1/polling/timeout --set <Value>
  • Do Not Retry at Timeout Occurrence

    Do Not Retry at Timeout Occurrence

    Value

    Retry (default)

    0

    Do not retry

    1

    clpcfadm.py mod -t monitor/sdw@sdw1/emergency/timeout/notreconfirmation/use --set <Value>
  • Action at Timeout Occurrence

    Action at Timeout Occurrence

    Value

    Recover (default)

    0

    Do not recover

    1

    Generate an intentional stop error

    2

    clpcfadm.py mod -t monitor/sdw@sdw1/emergency/timeout/notrecovery/use --set <Value>

    Note

    Set as above with "Do Not Retry at Timeout Occurrence" set to "Do not retry".

  • Retry Count

    Default, 1 (minimum, 0; maximum, 999)

    clpcfadm.py mod -t monitor/sdw@sdw1/polling/reconfirmation --set <Value>
  • Wait Time to Start Monitoring (sec)

    Default, 0 (minimum, 0; maximum, 9999)

    clpcfadm.py mod -t monitor/sdw@sdw1/firstmonwait --set <Value>
  • Monitoring Timing

    Monitoring Timing

    Value

    Always (default)

    0

    Active

    1

    clpcfadm.py mod -t monitor/sdw@sdw1/polling/timing --set <Value>

    Note

    If "Monitoring Timing" is set to "Active", set "Target Resource (monitored when active)".

    Important

    If you change the setting for "Monitoring timing" to "Always", set "Target Resource" to blank ("").

    clpcfadm.py mod -t monitor/sdw@sdw1/target --set ""
  • Target Resource (monitored when active)

    clpcfadm.py mod -t monitor/sdw@sdw1/target --set <Target Resource (monitored when active)>

    Note

    You can specify only a disk resource for this monitor resource.

    Note

    Set as above with "Monitoring Timing" set to "Active".

  • Choose servers that execute monitoring

    clpcfadm.py mod -t monitor/sdw@sdw1/polling/servers@<ID>/name --set <Server name> --nocheck

    Note

    With only one server to be monitored, specify 0 for ID.
    With more than one server to be monitored, specify consecutive numbers (e.g., 0, 1, 2...).
  • Send polling time metrics

    Send polling time metrics

    Value

    Send

    1

    Do not send (default)

    0

    clpcfadm.py mod -t monitor/sdw@sdw1/perf/metrics/use --set <Value>

8.41.2.3. Monitor (special)

  • Disk Resource

    clpcfadm.py mod -t monitor/sdw@sdw1/parameters/object --set <Disk Resource>

    Note

    You can specify only a disk resource.

8.41.2.4. Recovery Action

  • Recovery target

    Recovery target

    Recovery target type

    Local server

    LocalServer

    cls

    All groups([All Groups])

    ""

    grp

    Failover group name

    (Failover group name)

    grp

    Group resource name

    (Group resource name)

    rsc

    clpcfadm.py mod -t monitor/sdw@sdw1/relation/name --set <Recovery target> --nocheck
    clpcfadm.py mod -t monitor/sdw@sdw1/relation/type --set <Recovery target type> --nocheck

    Important

    If you set "Recovery target" to "Local server"

    Set "Maximum Reactivation Count" and "Maximum Failover Count" to 0 (times).

    clpcfadm.py mod -t monitor/sdw@sdw1/emergency/threshold/restart --set 0
    clpcfadm.py mod -t monitor/sdw@sdw1/emergency/threshold/fo2 --set 0

    If the current setting for "Final Action" is "Stop resource (16)" or "Stop Group (2)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/sdw@sdw1/emergency/action --set 1

    Important

    If you set "Recovery target" to "All groups ([All Groups])"

    Set "Maximum Reactivation Count" to 0 (times).

    clpcfadm.py mod -t monitor/sdw@sdw1/emergency/threshold/restart --set 0

    If the current setting for "Final Action" is "Stop resource (16)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/sdw@sdw1/emergency/action --set 1
  • Recovery Script Execution Count

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/sdw@sdw1/emergency/threshold/script --set <Value>
  • Execute Script before Reactivation

    Execute Script before Reactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/sdw@sdw1/emergency/preaction/userestart --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Maximum Reactivation Count

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/sdw@sdw1/emergency/threshold/restart --set <Value>
  • Execute Script before Failover

    Execute Script before Failover

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/sdw@sdw1/emergency/preaction/usefailover --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Failover Target Server

    Failover Target Server

    Value

    Stable server (default)

    1

    Maximum priority server

    0

    clpcfadm.py mod -t monitor/sdw@sdw1/emergency/mode --set <Value>
  • Maximum Failover Count

    Default, 1 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/sdw@sdw1/emergency/threshold/fo2 --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/sdw@sdw1/emergency/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Final Action

    Final Action
    Value

    No operation (default)

    1

    Stop resource 77

    16

    Stop group 78

    2

    Stop the cluster service

    3

    Stop the cluster service and shutdown OS

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t monitor/sdw@sdw1/emergency/action --set <Value>
    77

    Cannot be specified with "Recovery target type" set to "cls" or "grp".

    78

    Cannot be specified with "Recovery target type" set to "cls".

Script Settings
  • File type

    Script file type

    Value

    Script created with this product (default)

    1

    User Application

    0

    clpcfadm.py mod -t monitor/sdw@sdw1/emergency/preaction/default --set <Value>

    Note

    If you change the value of this parameter, also change that of "File".

  • File (Within 1023 bytes)

    clpcfadm.py mod -t monitor/sdw@sdw1/emergency/preaction/path --set <File> --nocheck

    Note

    If you specify "Script created with this product", specify preaction.bat.

    clpcfadm.py mod -t monitor/sdw@sdw1/emergency/preaction/path --set preaction.bat --nocheck
  • Timeout (sec)

    Default, 5 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t monitor/sdw@sdw1/emergency/preaction/timeout --set <Value>
  • Exec User

    clpcfadm.py mod -t monitor/sdw@sdw1/emergency/preaction/account --set <Exec User>

8.41.3. Deleting a disk TUR monitor resource

Delete a resource by specifying the monitor resource type and monitor resource name.

clpcfadm.py del mon sdw sdw1

8.42. Service monitor resource

Note

The command lines in this section use servicew1 as the monitor resource name.
Change it to suit your environment.

8.42.1. Adding a service monitor resource

Be sure to set the following items. For details, see "Setting service monitor resource parameters".

Item (mandatory)

Monitor resource name

Target Resource (monitored when active)

Service Name

Recovery target

Recovery target type

clpcfadm.py add mon servicew servicew1
clpcfadm.py mod -t monitor/servicew@servicew1/target --set <Target Resource (monitored when active)>
clpcfadm.py mod -t monitor/servicew@servicew1/parameters/name --set <Service Name>
clpcfadm.py mod -t monitor/servicew@servicew1/relation/name --set <Recovery target> --nocheck
clpcfadm.py mod -t monitor/servicew@servicew1/relation/type --set <Recovery target type> --nocheck

Note

If you configure a cluster only with the above mandatory items, other parameters are set to their default values.

8.42.2. Setting service monitor resource parameters

8.42.2.1. Basic information

  • Monitor resource name (Within 31 bytes)

    This is set when the resource is added. To change the monitor resource name, delete the resource and set it again.

  • Comment (Within 127 bytes)

    clpcfadm.py mod -t monitor/servicew@servicew1/comment --set <Comment>

    Note

    Enclose in double quotes a string including spaces (e.g., "Sample Comment").

8.42.2.2. Monitor (common)

  • Interval (sec)

    Default, 60 (minimum, 1; maximum, 999)

    clpcfadm.py mod -t monitor/servicew@servicew1/polling/interval --set <Value>
  • Timeout (sec)

    Default, 60 (minimum, 5; maximum, 999)

    clpcfadm.py mod -t monitor/servicew@servicew1/polling/timeout --set <Value>
  • Do Not Retry at Timeout Occurrence

    Do Not Retry at Timeout Occurrence

    Value

    Retry

    0

    Do not retry (default)

    1

    clpcfadm.py mod -t monitor/servicew@servicew1/emergency/timeout/notreconfirmation/use --set <Value>
  • Action at Timeout Occurrence

    Action at Timeout Occurrence

    Value

    Recover

    0

    Do not recover (default)

    1

    Generate an intentional stop error

    2

    clpcfadm.py mod -t monitor/servicew@servicew1/emergency/timeout/notrecovery/use --set <Value>

    Note

    Set as above with "Do Not Retry at Timeout Occurrence" set to "Do not retry".

  • Retry Count

    Default, 1 (minimum, 0; maximum, 999)

    clpcfadm.py mod -t monitor/servicew@servicew1/polling/reconfirmation --set <Value>
  • Wait Time to Start Monitoring (sec)

    Default, 3 (minimum, 0; maximum, 9999)

    clpcfadm.py mod -t monitor/servicew@servicew1/firstmonwait --set <Value>
  • Monitoring Timing

    Monitoring Timing

    Value

    Always

    0

    Active (default)

    1

    clpcfadm.py mod -t monitor/servicew@servicew1/polling/timing --set <Value>

    Note

    If "Monitoring Timing" is set to "Active", set "Target Resource (monitored when active)".

    Important

    If you change the setting for "Monitoring timing" to "Always", set "Target Resource" to blank ("").

    clpcfadm.py mod -t monitor/servicew@servicew1/target --set ""
  • Target Resource (monitored when active)

    clpcfadm.py mod -t monitor/servicew@servicew1/target --set <Target Resource (monitored when active)>

    Note

    Set as above with "Monitoring Timing" set to "Active".

  • Choose servers that execute monitoring

    clpcfadm.py mod -t monitor/servicew@servicew1/polling/servers@<ID>/name --set <Server name> --nocheck

    Note

    With only one server to be monitored, specify 0 for ID.
    With more than one server to be monitored, specify consecutive numbers (e.g., 0, 1, 2...).
  • Send polling time metrics

    Send polling time metrics

    Value

    Send

    1

    Do not send (default)

    0

    clpcfadm.py mod -t monitor/servicew@servicew1/perf/metrics/use --set <Value>

8.42.2.3. Monitor (special)

  • Service Name (Within 1023 bytes)

    clpcfadm.py mod -t monitor/servicew@servicew1/parameters/name --set <Service Name>

8.42.2.4. Recovery Action

  • Recovery target

    Recovery target

    Recovery target type

    Local server

    LocalServer

    cls

    All groups([All Groups])

    ""

    grp

    Failover group name

    (Failover group name)

    grp

    Group resource name

    (Group resource name)

    rsc

    clpcfadm.py mod -t monitor/servicew@servicew1/relation/name --set <Recovery target> --nocheck
    clpcfadm.py mod -t monitor/servicew@servicew1/relation/type --set <Recovery target type> --nocheck

    Important

    If you set "Recovery target" to "Local server"

    Set "Maximum Reactivation Count" and "Maximum Failover Count" to 0 (times).

    clpcfadm.py mod -t monitor/servicew@servicew1/emergency/threshold/restart --set 0
    clpcfadm.py mod -t monitor/servicew@servicew1/emergency/threshold/fo2 --set 0

    If the current setting for "Final Action" is "Stop resource (16)" or "Stop Group (2)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/servicew@servicew1/emergency/action --set 1

    Important

    If you set "Recovery target" to "All groups ([All Groups])"

    Set "Maximum Reactivation Count" to 0 (times).

    clpcfadm.py mod -t monitor/servicew@servicew1/emergency/threshold/restart --set 0

    If the current setting for "Final Action" is "Stop resource (16)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/servicew@servicew1/emergency/action --set 1
  • Recovery Script Execution Count

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/servicew@servicew1/emergency/threshold/script --set <Value>
  • Execute Script before Reactivation

    Execute Script before Reactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/servicew@servicew1/emergency/preaction/userestart --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Maximum Reactivation Count

    Default, 3 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/servicew@servicew1/emergency/threshold/restart --set <Value>
  • Execute Script before Failover

    Execute Script before Failover

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/servicew@servicew1/emergency/preaction/usefailover --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Failover Target Server

    Failover Target Server

    Value

    Stable server (default)

    1

    Maximum priority server

    0

    clpcfadm.py mod -t monitor/servicew@servicew1/emergency/mode --set <Value>
  • Maximum Failover Count

    Default, 1 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/servicew@servicew1/emergency/threshold/fo2 --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/servicew@servicew1/emergency/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Final Action

    Final Action
    Value

    No operation (default)

    1

    Stop resource 79

    16

    Stop group 80

    2

    Stop the cluster service

    3

    Stop the cluster service and shutdown OS

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t monitor/servicew@servicew1/emergency/action --set <Value>
    79

    Cannot be specified with "Recovery target type" set to "cls" or "grp".

    80

    Cannot be specified with "Recovery target type" set to "cls".

Script Settings
  • File type

    Script file type

    Value

    Script created with this product (default)

    1

    User Application

    0

    clpcfadm.py mod -t monitor/servicew@servicew1/emergency/preaction/default --set <Value>

    Note

    If you change the value of this parameter, also change that of "File".

  • File (Within 1023 bytes)

    clpcfadm.py mod -t monitor/servicew@servicew1/emergency/preaction/path --set <File> --nocheck

    Note

    If you specify "Script created with this product", specify preaction.bat.

    clpcfadm.py mod -t monitor/servicew@servicew1/emergency/preaction/path --set preaction.bat --nocheck
  • Timeout (sec)

    Default, 5 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t monitor/servicew@servicew1/emergency/preaction/timeout --set <Value>
  • Exec User

    clpcfadm.py mod -t monitor/servicew@servicew1/emergency/preaction/account --set <Exec User>

8.42.3. Deleting a service monitor resource

Delete a resource by specifying the monitor resource type and monitor resource name.

clpcfadm.py del mon servicew servicew1

8.43. SMTP monitor resource

Note

The command lines in this section use smtpw1 as the monitor resource name.
Change it to suit your environment.

8.43.1. Adding an SMTP monitor resource

Be sure to set the following items. For details, see "Setting SMTP monitor resource parameters".

Item (mandatory)

Monitor resource name

Target Resource (monitored when active)

Recovery target

Recovery target type

clpcfadm.py add mon smtpw smtpw1
clpcfadm.py mod -t monitor/smtpw@smtpw1/target --set <Target Resource (monitored when active)>
clpcfadm.py mod -t monitor/smtpw@smtpw1/relation/name --set <Recovery target> --nocheck
clpcfadm.py mod -t monitor/smtpw@smtpw1/relation/type --set <Recovery target type> --nocheck

Note

If you configure a cluster only with the above mandatory items, other parameters are set to their default values.

8.43.2. Setting SMTP monitor resource parameters

8.43.2.1. Basic information

  • Monitor resource name (Within 31 bytes)

    This is set when the resource is added. To change the monitor resource name, delete the resource and set it again.

  • Comment (Within 127 bytes)

    clpcfadm.py mod -t monitor/smtpw@smtpw1/comment --set <Comment>

    Note

    Enclose in double quotes a string including spaces (e.g., "Sample Comment").

8.43.2.2. Monitor (common)

  • Interval (sec)

    Default, 30 (minimum, 1; maximum, 999)

    clpcfadm.py mod -t monitor/smtpw@smtpw1/polling/interval --set <Value>
  • Timeout (sec)

    Default, 60 (minimum, 5; maximum, 999)

    clpcfadm.py mod -t monitor/smtpw@smtpw1/polling/timeout --set <Value>
  • Do Not Retry at Timeout Occurrence

    Do Not Retry at Timeout Occurrence

    Value

    Retry (default)

    0

    Do not retry

    1

    clpcfadm.py mod -t monitor/smtpw@smtpw1/emergency/timeout/notreconfirmation/use --set <Value>
  • Action at Timeout Occurrence

    Action at Timeout Occurrence

    Value

    Recover (default)

    0

    Do not recover

    1

    Generate an intentional stop error

    2

    clpcfadm.py mod -t monitor/smtpw@smtpw1/emergency/timeout/notrecovery/use --set <Value>

    Note

    Set as above with "Do Not Retry at Timeout Occurrence" set to "Do not retry".

  • Retry Count

    Default, 3 (minimum, 0; maximum, 999)

    clpcfadm.py mod -t monitor/smtpw@smtpw1/polling/reconfirmation --set <Value>
  • Wait Time to Start Monitoring (sec)

    Default, 0 (minimum, 0; maximum, 9999)

    clpcfadm.py mod -t monitor/smtpw@smtpw1/firstmonwait --set <Value>
  • Target Resource (monitored when active)

    clpcfadm.py mod -t monitor/smtpw@smtpw1/target --set <Target Resource (monitored when active)>
  • Choose servers that execute monitoring

    clpcfadm.py mod -t monitor/smtpw@smtpw1/polling/servers@<ID>/name --set <Server name> --nocheck

    Note

    With only one server to be monitored, specify 0 for ID.
    With more than one server to be monitored, specify consecutive numbers (e.g., 0, 1, 2...).
  • Send polling time metrics

    Send polling time metrics

    Value

    Send

    1

    Do not send (default)

    0

    clpcfadm.py mod -t monitor/smtpw@smtpw1/perf/metrics/use --set <Value>

8.43.2.3. Monitor (special)

  • IP Address

    Default: 127.0.0.1

    clpcfadm.py mod -t monitor/smtpw@smtpw1/agentparam/ipaddress --set <IP Address>
  • Port Number

    Default, 25 (minimum, 1; maximum, 65535)

    clpcfadm.py mod -t monitor/smtpw@smtpw1/agentparam/port --set <Value>
  • User Name (Within 255 bytes)

    clpcfadm.py mod -t monitor/smtpw@smtpw1/agentparam/username --set <User Name>
  • Password (Within 255 bytes)

    clpcfadm.py mod -t monitor/smtpw@smtpw1/agentparam/password --set <Encrypted password>

    Note

    Set an encrypted password string.
  • Authentication Method

    Value

    CRAM-MD5 (default)

    LOGIN

    clpcfadm.py mod -t monitor/smtpw@smtpw1/agentparam/certificate --set <Value>
  • E-mail Address (Within 255 bytes)

    clpcfadm.py mod -t monitor/smtpw@smtpw1/agentparam/mailaddress --set <E-mail Address>

8.43.2.4. Recovery Action

  • Recovery target

    Recovery target

    Recovery target type

    Local server

    LocalServer

    cls

    All groups([All Groups])

    ""

    grp

    Failover group name

    (Failover group name)

    grp

    Group resource name

    (Group resource name)

    rsc

    clpcfadm.py mod -t monitor/smtpw@smtpw1/relation/name --set <Recovery target> --nocheck
    clpcfadm.py mod -t monitor/smtpw@smtpw1/relation/type --set <Recovery target type> --nocheck

    Important

    If you set "Recovery target" to "Local server"

    Set "Maximum Reactivation Count" and "Maximum Failover Count" to 0 (times).

    clpcfadm.py mod -t monitor/smtpw@smtpw1/emergency/threshold/restart --set 0
    clpcfadm.py mod -t monitor/smtpw@smtpw1/emergency/threshold/fo2 --set 0

    If the current setting for "Final Action" is "Stop resource (16)" or "Stop Group (2)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/smtpw@smtpw1/emergency/action --set 1

    Important

    If you set "Recovery target" to "All groups ([All Groups])"

    Set "Maximum Reactivation Count" to 0 (times).

    clpcfadm.py mod -t monitor/smtpw@smtpw1/emergency/threshold/restart --set 0

    If the current setting for "Final Action" is "Stop resource (16)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/smtpw@smtpw1/emergency/action --set 1
  • Recovery Script Execution Count

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/smtpw@smtpw1/emergency/threshold/script --set <Value>
  • Execute Script before Reactivation

    Execute Script before Reactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/smtpw@smtpw1/emergency/preaction/userestart --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Maximum Reactivation Count

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/smtpw@smtpw1/emergency/threshold/restart --set <Value>
  • Execute Script before Failover

    Execute Script before Failover

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/smtpw@smtpw1/emergency/preaction/usefailover --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Failover Target Server

    Failover Target Server

    Value

    Stable server (default)

    1

    Maximum priority server

    0

    clpcfadm.py mod -t monitor/smtpw@smtpw1/emergency/mode --set <Value>
  • Maximum Failover Count

    Default, 1 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/smtpw@smtpw1/emergency/threshold/fo2 --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/smtpw@smtpw1/emergency/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Final Action

    Final Action
    Value

    No operation

    1

    Stop resource 81

    16

    Stop group 82

    2

    Stop the cluster service

    3

    Stop the cluster service and shutdown OS (default)

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t monitor/smtpw@smtpw1/emergency/action --set <Value>
    81

    Cannot be specified with "Recovery target type" set to "cls" or "grp".

    82

    Cannot be specified with "Recovery target type" set to "cls".

Script Settings
  • File type

    Script file type

    Value

    Script created with this product (default)

    1

    User Application

    0

    clpcfadm.py mod -t monitor/smtpw@smtpw1/emergency/preaction/default --set <Value>

    Note

    If you change the value of this parameter, also change that of "File".

  • File (Within 1023 bytes)

    clpcfadm.py mod -t monitor/smtpw@smtpw1/emergency/preaction/path --set <File> --nocheck

    Note

    If you specify "Script created with this product", specify preaction.bat.

    clpcfadm.py mod -t monitor/smtpw@smtpw1/emergency/preaction/path --set preaction.bat --nocheck
  • Timeout (sec)

    Default, 5 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t monitor/smtpw@smtpw1/emergency/preaction/timeout --set <Value>
  • Exec User

    clpcfadm.py mod -t monitor/smtpw@smtpw1/emergency/preaction/account --set <Exec User>

8.43.3. Deleting an SMTP monitor resource

Delete a resource by specifying the monitor resource type and monitor resource name.

clpcfadm.py del mon smtpw smtpw1

8.44. SQL Server monitor resource

Note

The command lines in this section use sqlserverw1 as the monitor resource name.
Change it to suit your environment.

8.44.1. Adding an SQL Server monitor resource

Be sure to set the following items. For details, see "Setting SQL Server monitor resource parameters".

Item (mandatory)

Monitor resource name

Target Resource (monitored when active)

Database Name

Recovery target

Recovery target type

clpcfadm.py add mon sqlserverw sqlserverw1
clpcfadm.py mod -t monitor/sqlserverw@sqlserverw1/target --set <Target Resource (monitored when active)>
clpcfadm.py mod -t monitor/sqlserverw@sqlserverw1/agentparam/dbname --set <Database Name>
clpcfadm.py mod -t monitor/sqlserverw@sqlserverw1/relation/name --set <Recovery target> --nocheck
clpcfadm.py mod -t monitor/sqlserverw@sqlserverw1/relation/type --set <Recovery target type> --nocheck

Note

If you configure a cluster only with the above mandatory items, other parameters are set to their default values.

8.44.2. Setting SQL Server monitor resource parameters

8.44.2.1. Basic information

  • Monitor resource name (Within 31 bytes)

    This is set when the resource is added. To change the monitor resource name, delete the resource and set it again.

  • Comment (Within 127 bytes)

    clpcfadm.py mod -t monitor/sqlserverw@sqlserverw1/comment --set <Comment>

    Note

    Enclose in double quotes a string including spaces (e.g., "Sample Comment").

8.44.2.2. Monitor (common)

  • Interval (sec)

    Default, 60 (minimum, 1; maximum, 999)

    clpcfadm.py mod -t monitor/sqlserverw@sqlserverw1/polling/interval --set <Value>
  • Timeout (sec)

    Default, 120 (minimum, 5; maximum, 999)

    clpcfadm.py mod -t monitor/sqlserverw@sqlserverw1/polling/timeout --set <Value>
  • Do Not Retry at Timeout Occurrence

    Do Not Retry at Timeout Occurrence

    Value

    Retry (default)

    0

    Do not retry

    1

    clpcfadm.py mod -t monitor/sqlserverw@sqlserverw1/emergency/timeout/notreconfirmation/use --set <Value>
  • Action at Timeout Occurrence

    Action at Timeout Occurrence

    Value

    Recover (default)

    0

    Do not recover

    1

    Generate an intentional stop error

    2

    clpcfadm.py mod -t monitor/sqlserverw@sqlserverw1/emergency/timeout/notrecovery/use --set <Value>

    Note

    Set as above with "Do Not Retry at Timeout Occurrence" set to "Do not retry".

  • Retry Count

    Default, 2 (minimum, 0; maximum, 999)

    clpcfadm.py mod -t monitor/sqlserverw@sqlserverw1/polling/reconfirmation --set <Value>
  • Wait Time to Start Monitoring (sec)

    Default, 0 (minimum, 0; maximum, 9999)

    clpcfadm.py mod -t monitor/sqlserverw@sqlserverw1/firstmonwait --set <Value>
  • Target Resource (monitored when active)

    clpcfadm.py mod -t monitor/sqlserverw@sqlserverw1/target --set <Target Resource (monitored when active)>
  • Choose servers that execute monitoring

    clpcfadm.py mod -t monitor/sqlserverw@sqlserverw1/polling/servers@<ID>/name --set <Server name> --nocheck

    Note

    With only one server to be monitored, specify 0 for ID.
    With more than one server to be monitored, specify consecutive numbers (e.g., 0, 1, 2...).
  • Send polling time metrics

    Send polling time metrics

    Value

    Send

    1

    Do not send (default)

    0

    clpcfadm.py mod -t monitor/sqlserverw@sqlserverw1/perf/metrics/use --set <Value>

8.44.2.3. Monitor (special)

  • Monitor Level

    Monitor Level

    Value

    Level 0 (database status)

    2

    Level 1 (monitoring by select)

    3

    Level 2 (monitoring by update/select) (default)

    0

    clpcfadm.py mod -t monitor/sqlserverw@sqlserverw1/agentparam/docreatedrop --set <Value>
  • Database Name (Within 255 bytes)

    clpcfadm.py mod -t monitor/sqlserverw@sqlserverw1/agentparam/dbname --set <Database Name>
  • Instance Name (Within 255 bytes)

    Default: MSSQLSERVER

    clpcfadm.py mod -t monitor/sqlserverw@sqlserverw1/agentparam/instance --set <Instance Name>
  • User Name (Within 255 bytes)

    Default: SA

    clpcfadm.py mod -t monitor/sqlserverw@sqlserverw1/agentparam/username --set <User Name>
  • Password (Within 255 bytes)

    clpcfadm.py mod -t monitor/sqlserverw@sqlserverw1/agentparam/password --set <Encrypted password>

    Note

    Set an encrypted password string.
  • Monitor Table Name (Within 255 bytes)

    Default: SQLWATCH

    clpcfadm.py mod -t monitor/sqlserverw@sqlserverw1/agentparam/tablename --set <Monitor Table Name>
  • ODBC Driver Name (Within 255 bytes)

    ODBC Driver Name

    SQL Server Native Client 11.0

    ODBC Driver 13 for SQL Server (default)

    ODBC Driver 17 for SQL Server

    SQL Server

    clpcfadm.py mod -t monitor/sqlserverw@sqlserverw1/agentparam/odbcname --set <ODBC Driver Name>

8.44.2.4. Recovery Action

  • Recovery target

    Recovery target

    Recovery target type

    Local server

    LocalServer

    cls

    All groups([All Groups])

    ""

    grp

    Failover group name

    (Failover group name)

    grp

    Group resource name

    (Group resource name)

    rsc

    clpcfadm.py mod -t monitor/sqlserverw@sqlserverw1/relation/name --set <Recovery target> --nocheck
    clpcfadm.py mod -t monitor/sqlserverw@sqlserverw1/relation/type --set <Recovery target type> --nocheck

    Important

    If you set "Recovery target" to "Local server"

    Set "Maximum Reactivation Count" and "Maximum Failover Count" to 0 (times).

    clpcfadm.py mod -t monitor/sqlserverw@sqlserverw1/emergency/threshold/restart --set 0
    clpcfadm.py mod -t monitor/sqlserverw@sqlserverw1/emergency/threshold/fo2 --set 0

    If the current setting for "Final Action" is "Stop resource (16)" or "Stop Group (2)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/sqlserverw@sqlserverw1/emergency/action --set 1

    Important

    If you set "Recovery target" to "All groups ([All Groups])"

    Set "Maximum Reactivation Count" to 0 (times).

    clpcfadm.py mod -t monitor/sqlserverw@sqlserverw1/emergency/threshold/restart --set 0

    If the current setting for "Final Action" is "Stop resource (16)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/sqlserverw@sqlserverw1/emergency/action --set 1
  • Recovery Script Execution Count

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/sqlserverw@sqlserverw1/emergency/threshold/script --set <Value>
  • Execute Script before Reactivation

    Execute Script before Reactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/sqlserverw@sqlserverw1/emergency/preaction/userestart --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Maximum Reactivation Count

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/sqlserverw@sqlserverw1/emergency/threshold/restart --set <Value>
  • Execute Script before Failover

    Execute Script before Failover

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/sqlserverw@sqlserverw1/emergency/preaction/usefailover --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Failover Target Server

    Failover Target Server

    Value

    Stable server (default)

    1

    Maximum priority server

    0

    clpcfadm.py mod -t monitor/sqlserverw@sqlserverw1/emergency/mode --set <Value>
  • Maximum Failover Count

    Default, 1 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/sqlserverw@sqlserverw1/emergency/threshold/fo2 --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/sqlserverw@sqlserverw1/emergency/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Final Action

    Final Action
    Value

    No operation

    1

    Stop resource 83

    16

    Stop group 84

    2

    Stop the cluster service

    3

    Stop the cluster service and shutdown OS (default)

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t monitor/sqlserverw@sqlserverw1/emergency/action --set <Value>
    83

    Cannot be specified with "Recovery target type" set to "cls" or "grp".

    84

    Cannot be specified with "Recovery target type" set to "cls".

Script Settings
  • File type

    Script file type

    Value

    Script created with this product (default)

    1

    User Application

    0

    clpcfadm.py mod -t monitor/sqlserverw@sqlserverw1/emergency/preaction/default --set <Value>

    Note

    If you change the value of this parameter, also change that of "File".

  • File (Within 1023 bytes)

    clpcfadm.py mod -t monitor/sqlserverw@sqlserverw1/emergency/preaction/path --set <File> --nocheck

    Note

    If you specify "Script created with this product", specify preaction.bat.

    clpcfadm.py mod -t monitor/sqlserverw@sqlserverw1/emergency/preaction/path --set preaction.bat --nocheck
  • Timeout (sec)

    Default, 5 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t monitor/sqlserverw@sqlserverw1/emergency/preaction/timeout --set <Value>
  • Exec User

    clpcfadm.py mod -t monitor/sqlserverw@sqlserverw1/emergency/preaction/account --set <Exec User>

8.44.3. Deleting an SQL Server monitor resource

Delete a resource by specifying the monitor resource type and monitor resource name.

clpcfadm.py del mon sqlserverw sqlserverw1

8.45. System monitor resource

Note

The command lines in this section use sraw1 as the monitor resource name.
Change it to suit your environment.

8.45.1. Adding a system monitor resource

Be sure to set the following items. For details, see "Setting system monitor resource parameters".

Item (mandatory)

Monitor resource name

Recovery target

Recovery target type

clpcfadm.py add mon sraw sraw1
clpcfadm.py mod -t monitor/sraw@sraw1/relation/name --set <Recovery target> --nocheck
clpcfadm.py mod -t monitor/sraw@sraw1/relation/type --set <Recovery target type> --nocheck

Note

If you configure a cluster only with the above mandatory items, other parameters are set to their default values.

8.45.2. Setting system monitor resource parameters

8.45.2.1. Basic information

  • Monitor resource name (Within 31 bytes)

    This is set when the resource is added. To change the monitor resource name, delete the resource and set it again.

  • Comment (Within 127 bytes)

    clpcfadm.py mod -t monitor/sraw@sraw1/comment --set <Comment>

    Note

    Enclose in double quotes a string including spaces (e.g., "Sample Comment").

8.45.2.2. Monitor (common)

  • Interval (sec)

    Default, 30 (minimum, 1; maximum, 999)

    clpcfadm.py mod -t monitor/sraw@sraw1/polling/interval --set <Value>
  • Timeout (sec)

    Default, 60 (minimum, 5; maximum, 999)

    clpcfadm.py mod -t monitor/sraw@sraw1/polling/timeout --set <Value>
  • Retry Count

    Default, 0 (minimum, 0; maximum, 999)

    clpcfadm.py mod -t monitor/sraw@sraw1/polling/reconfirmation --set <Value>
  • Wait Time to Start Monitoring (sec)

    Default, 0 (minimum, 0; maximum, 9999)

    clpcfadm.py mod -t monitor/sraw@sraw1/firstmonwait --set <Value>
  • Choose servers that execute monitoring

    clpcfadm.py mod -t monitor/sraw@sraw1/polling/servers@<ID>/name --set <Server name> --nocheck

    Note

    With only one server to be monitored, specify 0 for ID.
    With more than one server to be monitored, specify consecutive numbers (e.g., 0, 1, 2...).
  • Send polling time metrics

    Send polling time metrics

    Value

    Send

    1

    Do not send (default)

    0

    clpcfadm.py mod -t monitor/sraw@sraw1/perf/metrics/use --set <Value>

8.45.2.3. Monitor (special)

  • Monitoring CPU usage

    Monitoring CPU usage

    Value

    Monitor (default)

    1

    Do not monitor

    0

    clpcfadm.py mod -t monitor/sraw@sraw1/parameters/system/cpu/docheck --set <Value>
    • CPU usage (%)

      Default, 90 (minimum, 1; maximum, 100)

      clpcfadm.py mod -t monitor/sraw@sraw1/parameters/system/cpu/rate --set <Value>

      Note

      Set as above with "Monitoring CPU usage" set to "Monitor".

    • Duration Time (sec)

      Default, 3600 (minimum, 60; maximum, 86400)

      clpcfadm.py mod -t monitor/sraw@sraw1/parameters/system/cpu/time --set <Value>

      Note

      Set as above with "Monitoring CPU usage" set to "Monitor".

      Note

      Specify a value in seconds (divisible by 60).

  • Monitoring total usage of memory

    Monitoring total usage of memory

    Value

    Monitor (default)

    1

    Do not monitor

    0

    clpcfadm.py mod -t monitor/sraw@sraw1/parameters/system/memory/docheck --set <Value>
    • Total usage of memory (%)

      Default, 90 (minimum, 1; maximum, 100)

      clpcfadm.py mod -t monitor/sraw@sraw1/parameters/system/memory/rate --set <Value>

      Note

      Set as above with "Monitoring total usage of memory" set to "Monitor".

    • Duration Time (sec)

      Default, 3600 (minimum, 60; maximum, 86400)

      clpcfadm.py mod -t monitor/sraw@sraw1/parameters/system/memory/time --set <Value>

      Note

      Set as above with "Monitoring total usage of memory" set to "Monitor".

      Note

      Specify a value in seconds (divisible by 60).

  • Monitoring total usage of virtual memory

    Monitoring total usage of virtual memory

    Value

    Monitor (default)

    1

    Do not monitor

    0

    clpcfadm.py mod -t monitor/sraw@sraw1/parameters/system/swap/docheck --set <Value>
    • Total usage of memory (%)

      Default, 90 (minimum, 1; maximum, 100)

      clpcfadm.py mod -t monitor/sraw@sraw1/parameters/system/swap/rate --set <Value>

      Note

      Set as above with "Monitoring total usage of virtual memory" set to "Monitor".

    • Duration Time (sec)

      Default, 3600 (minimum, 60; maximum, 86400)

      clpcfadm.py mod -t monitor/sraw@sraw1/parameters/system/swap/time --set <Value>

      Note

      Set as above with "Monitoring total usage of virtual memory" set to "Monitor".

      Note

      Specify a value in seconds (divisible by 60).

Condition of detecting failure
Add
clpcfadm.py mod -t monitor/sraw@sraw1/parameters/diskcap@<ID>/mountpoint --set <Logical Drive> --nocheck
clpcfadm.py mod -t monitor/sraw@sraw1/parameters/diskcap@<ID>/docheck_rate --set <Utilization rate> --nocheck
clpcfadm.py mod -t monitor/sraw@sraw1/parameters/diskcap@<ID>/warning_rate --set <(Utilization rate) Warning level> --nocheck
clpcfadm.py mod -t monitor/sraw@sraw1/parameters/diskcap@<ID>/notice_rate --set <(Utilization rate) Notice level> --nocheck
clpcfadm.py mod -t monitor/sraw@sraw1/parameters/diskcap@<ID>/rate_time --set <(Utilization rate) Duration Time> --nocheck
clpcfadm.py mod -t monitor/sraw@sraw1/parameters/diskcap@<ID>/docheck_size --set <Free space> --nocheck
clpcfadm.py mod -t monitor/sraw@sraw1/parameters/diskcap@<ID>/warning_size --set <(Free space) Warning level> --nocheck
clpcfadm.py mod -t monitor/sraw@sraw1/parameters/diskcap@<ID>/notice_size --set <(Free space) Notice level> --nocheck
clpcfadm.py mod -t monitor/sraw@sraw1/parameters/diskcap@<ID>/size_time --set <(Free space) Duration Time> --nocheck

Note

With only one condition of detecting failure, specify 0 for ID.
With more than one condition of detecting failure, specify consecutive numbers (e.g., 0, 1, 2...).
  • Logical Drive

    clpcfadm.py mod -t monitor/sraw@sraw1/parameters/diskcap@<ID>/mountpoint --set <Drive letter> --nocheck
Monitor Type
  • Utilization rate

    Utilization rate

    Value

    Set (default)

    1

    Do not set

    0

    clpcfadm.py mod -t monitor/sraw@sraw1/parameters/diskcap@<ID>/docheck_rate --set <Value> --nocheck

Note

To set the following items, set "Utilization rate" to "Set" in advance.

  • Warning level (%)

    Default, 90 (minimum, 1; maximum, 100)

    clpcfadm.py mod -t monitor/sraw@sraw1/parameters/diskcap@<ID>/warning_rate --set <Value> --nocheck

    Note

    Set the warning level to a value equal to or greater than the notice level value.

  • Notice level (%)

    Default, 80 (minimum, 1; maximum, 100)

    clpcfadm.py mod -t monitor/sraw@sraw1/parameters/diskcap@<ID>/notice_rate --set <Value> --nocheck
  • Duration Time (sec)

    Default, 86400 (minimum, 60; maximum, 2592000)

    clpcfadm.py mod -t monitor/sraw@sraw1/parameters/diskcap@<ID>/rate_time --set <Value> --nocheck

    Note

    Specify a value in seconds (divisible by 60).

  • Free space

    Free space

    Value

    Set (default)

    1

    Do not set

    0

    clpcfadm.py mod -t monitor/sraw@sraw1/parameters/diskcap@<ID>/docheck_size --set <Value> --nocheck

Note

To set the following items, set "Free space" to "Set" in advance.

  • Warning level (MB)

    Default, 500 (minimum, 1; maximum, 4294967295)

    clpcfadm.py mod -t monitor/sraw@sraw1/parameters/diskcap@<ID>/warning_size --set <Value> --nocheck

    Note

    Set the warning level to a value equal to or less than the notice level value.

  • Notice level (MB)

    Default, 1000 (minimum, 1; maximum, 4294967295)

    clpcfadm.py mod -t monitor/sraw@sraw1/parameters/diskcap@<ID>/notice_size --set <Value> --nocheck
  • Duration Time (sec)

    Default, 86400 (minimum, 60; maximum, 2592000)

    clpcfadm.py mod -t monitor/sraw@sraw1/parameters/diskcap@<ID>/size_time --set <Value> --nocheck

    Note

    Specify a value in seconds (divisible by 60).

Delete
clpcfadm.py mod -t monitor/sraw@sraw1/parameters/diskcap@<ID> --delete

8.45.2.4. Recovery Action

  • Recovery target

    Recovery target

    Recovery target type

    Local server

    LocalServer

    cls

    All groups([All Groups])

    ""

    grp

    Failover group name

    (Failover group name)

    grp

    Group resource name

    (Group resource name)

    rsc

    clpcfadm.py mod -t monitor/sraw@sraw1/relation/name --set <Recovery target> --nocheck
    clpcfadm.py mod -t monitor/sraw@sraw1/relation/type --set <Recovery target type> --nocheck

    Important

    If you set "Recovery target" to "Local server"

    Set "Maximum Reactivation Count" and "Maximum Failover Count" to 0 (times).

    clpcfadm.py mod -t monitor/sraw@sraw1/emergency/threshold/restart --set 0
    clpcfadm.py mod -t monitor/sraw@sraw1/emergency/threshold/fo2 --set 0

    If the current setting for "Final Action" is "Stop resource (16)" or "Stop Group (2)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/sraw@sraw1/emergency/action --set 1

    Important

    If you set "Recovery target" to "All groups ([All Groups])"

    Set "Maximum Reactivation Count" to 0 (times).

    clpcfadm.py mod -t monitor/sraw@sraw1/emergency/threshold/restart --set 0

    If the current setting for "Final Action" is "Stop resource (16)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/sraw@sraw1/emergency/action --set 1
  • Recovery Script Execution Count

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/sraw@sraw1/emergency/threshold/script --set <Value>
  • Execute Script before Reactivation

    Execute Script before Reactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/sraw@sraw1/emergency/preaction/userestart --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Maximum Reactivation Count

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/sraw@sraw1/emergency/threshold/restart --set <Value>
  • Execute Script before Failover

    Execute Script before Failover

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/sraw@sraw1/emergency/preaction/usefailover --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Failover Target Server

    Failover Target Server

    Value

    Stable server (default)

    1

    Maximum priority server

    0

    clpcfadm.py mod -t monitor/sraw@sraw1/emergency/mode --set <Value>
  • Maximum Failover Count

    Default, 1 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/sraw@sraw1/emergency/threshold/fo2 --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/sraw@sraw1/emergency/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Final Action

    Final Action
    Value

    No operation (default)

    1

    Stop resource 85

    16

    Stop group 86

    2

    Stop the cluster service

    3

    Stop the cluster service and shutdown OS

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t monitor/sraw@sraw1/emergency/action --set <Value>
    85

    Cannot be specified with "Recovery target type" set to "cls" or "grp".

    86

    Cannot be specified with "Recovery target type" set to "cls".

Script Settings
  • File type

    Script file type

    Value

    Script created with this product (default)

    1

    User Application

    0

    clpcfadm.py mod -t monitor/sraw@sraw1/emergency/preaction/default --set <Value>

    Note

    If you change the value of this parameter, also change that of "File".

  • File (Within 1023 bytes)

    clpcfadm.py mod -t monitor/sraw@sraw1/emergency/preaction/path --set <File> --nocheck

    Note

    If you specify "Script created with this product", specify preaction.bat.

    clpcfadm.py mod -t monitor/sraw@sraw1/emergency/preaction/path --set preaction.bat --nocheck
  • Timeout (sec)

    Default, 5 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t monitor/sraw@sraw1/emergency/preaction/timeout --set <Value>
  • Exec User

    clpcfadm.py mod -t monitor/sraw@sraw1/emergency/preaction/account --set <Exec User>

8.45.3. Deleting a system monitor resource

Delete a resource by specifying the monitor resource type and monitor resource name.

clpcfadm.py del mon sraw sraw1

8.46. Tuxedo monitor resource

Note

The command lines in this section use tuxw1 as the monitor resource name.
Change it to suit your environment.

8.46.1. Adding a Tuxedo monitor resource

Be sure to set the following items. For details, see "Setting Tuxedo monitor resource parameters".

Item (mandatory)

Monitor resource name

Target Resource (monitored when active)

Config File

Recovery target

Recovery target type

clpcfadm.py add mon tuxw tuxw1
clpcfadm.py mod -t monitor/tuxw@tuxw1/target --set <Target Resource (monitored when active)>
clpcfadm.py mod -t monitor/tuxw@tuxw1/parameters/tuxconfig --set <Config File> --nocheck
clpcfadm.py mod -t monitor/tuxw@tuxw1/relation/name --set <Recovery target> --nocheck
clpcfadm.py mod -t monitor/tuxw@tuxw1/relation/type --set <Recovery target type> --nocheck

Note

If you configure a cluster only with the above mandatory items, other parameters are set to their default values.

8.46.2. Setting Tuxedo monitor resource parameters

8.46.2.1. Basic information

  • Monitor resource name (Within 31 bytes)

    This is set when the resource is added. To change the monitor resource name, delete the resource and set it again.

  • Comment (Within 127 bytes)

    clpcfadm.py mod -t monitor/tuxw@tuxw1/comment --set <Comment>

    Note

    Enclose in double quotes a string including spaces (e.g., "Sample Comment").

8.46.2.2. Monitor (common)

  • Interval (sec)

    Default, 60 (minimum, 1; maximum, 999)

    clpcfadm.py mod -t monitor/tuxw@tuxw1/polling/interval --set <Value>
  • Timeout (sec)

    Default, 120 (minimum, 5; maximum, 999)

    clpcfadm.py mod -t monitor/tuxw@tuxw1/polling/timeout --set <Value>
  • Do Not Retry at Timeout Occurrence

    Do Not Retry at Timeout Occurrence

    Value

    Retry (default)

    0

    Do not retry

    1

    clpcfadm.py mod -t monitor/tuxw@tuxw1/emergency/timeout/notreconfirmation/use --set <Value>
  • Action at Timeout Occurrence

    Action at Timeout Occurrence

    Value

    Recover (default)

    0

    Do not recover

    1

    Generate an intentional stop error

    2

    clpcfadm.py mod -t monitor/tuxw@tuxw1/emergency/timeout/notrecovery/use --set <Value>

    Note

    Set as above with "Do Not Retry at Timeout Occurrence" set to "Do not retry".

  • Retry Count

    Default, 2 (minimum, 0; maximum, 999)

    clpcfadm.py mod -t monitor/tuxw@tuxw1/polling/reconfirmation --set <Value>
  • Wait Time to Start Monitoring (sec)

    Default, 0 (minimum, 0; maximum, 9999)

    clpcfadm.py mod -t monitor/tuxw@tuxw1/firstmonwait --set <Value>
  • Target Resource (monitored when active)

    clpcfadm.py mod -t monitor/tuxw@tuxw1/target --set <Target Resource (monitored when active)>
  • Choose servers that execute monitoring

    clpcfadm.py mod -t monitor/tuxw@tuxw1/polling/servers@<ID>/name --set <Server name> --nocheck

    Note

    With only one server to be monitored, specify 0 for ID.
    With more than one server to be monitored, specify consecutive numbers (e.g., 0, 1, 2...).
  • Send polling time metrics

    Send polling time metrics

    Value

    Send

    1

    Do not send (default)

    0

    clpcfadm.py mod -t monitor/tuxw@tuxw1/perf/metrics/use --set <Value>

8.46.2.3. Monitor (special)

  • Application Server Name (Within 255 bytes)

    Default: BBL

    clpcfadm.py mod -t monitor/tuxw@tuxw1/parameters/servername --set <Application Server Name>
  • Config File (Within 1023 bytes)

    clpcfadm.py mod -t monitor/tuxw@tuxw1/parameters/tuxconfig --set <Config File> --nocheck

8.46.2.4. Recovery Action

  • Recovery target

    Recovery target

    Recovery target type

    Local server

    LocalServer

    cls

    All groups([All Groups])

    ""

    grp

    Failover group name

    (Failover group name)

    grp

    Group resource name

    (Group resource name)

    rsc

    clpcfadm.py mod -t monitor/tuxw@tuxw1/relation/name --set <Recovery target> --nocheck
    clpcfadm.py mod -t monitor/tuxw@tuxw1/relation/type --set <Recovery target type> --nocheck

    Important

    If you set "Recovery target" to "Local server"

    Set "Maximum Reactivation Count" and "Maximum Failover Count" to 0 (times).

    clpcfadm.py mod -t monitor/tuxw@tuxw1/emergency/threshold/restart --set 0
    clpcfadm.py mod -t monitor/tuxw@tuxw1/emergency/threshold/fo2 --set 0

    If the current setting for "Final Action" is "Stop resource (16)" or "Stop Group (2)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/tuxw@tuxw1/emergency/action --set 1

    Important

    If you set "Recovery target" to "All groups ([All Groups])"

    Set "Maximum Reactivation Count" to 0 (times).

    clpcfadm.py mod -t monitor/tuxw@tuxw1/emergency/threshold/restart --set 0

    If the current setting for "Final Action" is "Stop resource (16)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/tuxw@tuxw1/emergency/action --set 1
  • Recovery Script Execution Count

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/tuxw@tuxw1/emergency/threshold/script --set <Value>
  • Execute Script before Reactivation

    Execute Script before Reactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/tuxw@tuxw1/emergency/preaction/userestart --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Maximum Reactivation Count

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/tuxw@tuxw1/emergency/threshold/restart --set <Value>
  • Execute Script before Failover

    Execute Script before Failover

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/tuxw@tuxw1/emergency/preaction/usefailover --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Failover Target Server

    Failover Target Server

    Value

    Stable server (default)

    1

    Maximum priority server

    0

    clpcfadm.py mod -t monitor/tuxw@tuxw1/emergency/mode --set <Value>
  • Maximum Failover Count

    Default, 1 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/tuxw@tuxw1/emergency/threshold/fo2 --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/tuxw@tuxw1/emergency/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Final Action

    Final Action
    Value

    No operation

    1

    Stop resource 87

    16

    Stop group 88

    2

    Stop the cluster service

    3

    Stop the cluster service and shutdown OS (default)

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t monitor/tuxw@tuxw1/emergency/action --set <Value>
    87

    Cannot be specified with "Recovery target type" set to "cls" or "grp".

    88

    Cannot be specified with "Recovery target type" set to "cls".

Script Settings
  • File type

    Script file type

    Value

    Script created with this product (default)

    1

    User Application

    0

    clpcfadm.py mod -t monitor/tuxw@tuxw1/emergency/preaction/default --set <Value>

    Note

    If you change the value of this parameter, also change that of "File".

  • File (Within 1023 bytes)

    clpcfadm.py mod -t monitor/tuxw@tuxw1/emergency/preaction/path --set <File> --nocheck

    Note

    If you specify "Script created with this product", specify preaction.bat.

    clpcfadm.py mod -t monitor/tuxw@tuxw1/emergency/preaction/path --set preaction.bat --nocheck
  • Timeout (sec)

    Default, 5 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t monitor/tuxw@tuxw1/emergency/preaction/timeout --set <Value>
  • Exec User

    clpcfadm.py mod -t monitor/tuxw@tuxw1/emergency/preaction/account --set <Exec User>

8.46.3. Deleting a Tuxedo monitor resource

Delete a resource by specifying the monitor resource type and monitor resource name.

clpcfadm.py del mon tuxw tuxw1

8.47. User mode monitor resource

Note

The command lines in this section use userw1 as the monitor resource name.
Change it to suit your environment.

8.47.1. Adding a user mode monitor resource

Be sure to set the following items. For details, see "Setting user mode monitor resource parameters".

Item (mandatory)

Monitor resource name

Recovery target (LocalServer)

Recovery target type (cls)

clpcfadm.py add mon userw userw1
clpcfadm.py mod -t monitor/userw@userw1/relation/name --set LocalServer --nocheck
clpcfadm.py mod -t monitor/userw@userw1/relation/type --set cls --nocheck

Note

If you configure a cluster only with the above mandatory items, other parameters are set to their default values.

8.47.2. Setting user mode monitor resource parameters

8.47.2.1. Information

  • Monitor resource name (Within 31 bytes)

    This is set when the resource is added. To change the monitor resource name, delete the resource and set it again.

  • Comment (Within 127 bytes)

    clpcfadm.py mod -t monitor/userw@userw1/comment --set <Comment>

    Note

    Enclose in double quotes a string including spaces (e.g., "Sample Comment").

8.47.2.2. Monitor (common)

  • Interval (sec)

    Default, 30 (minimum, 1; maximum, 999)

    clpcfadm.py mod -t monitor/userw@userw1/polling/interval --set <Value>
  • Timeout (sec)

    Default, 300 (minimum, 5; maximum, 999)

    clpcfadm.py mod -t monitor/userw@userw1/polling/timeout --set <Value>
  • Wait Time to Start Monitoring (sec)

    Default, 0 (minimum, 0; maximum, 9999)

    clpcfadm.py mod -t monitor/userw@userw1/firstmonwait --set <Value>
  • Choose servers that execute monitoring

    clpcfadm.py mod -t monitor/userw@userw1/polling/servers@<ID>/name --set <Server name> --nocheck

    Note

    With only one server to be monitored, specify 0 for ID.
    With more than one server to be monitored, specify consecutive numbers (e.g., 0, 1, 2...).
  • Send polling time metrics

    Send polling time metrics

    Value

    Send

    1

    Do not send (default)

    0

    clpcfadm.py mod -t monitor/userw@userw1/perf/metrics/use --set <Value>

8.47.2.3. Monitor (special)

  • Method

    Value

    keepalive (default)

    clpcfadm.py mod -t monitor/userw@userw1/parameters/method --set <Value>
  • Action at Timeout Occurrence

    Action at Timeout Occurrence

    Value

    No operation

    0

    Reset the hardware

    1

    Generate an intentional stop error (default)

    2

    clpcfadm.py mod -t monitor/userw@userw1/parameters/stallaction --set <Value>
  • Create Temporary Thread

    Create Temporary Thread

    Value

    Set (default)

    1

    Do not set

    0

    clpcfadm.py mod -t monitor/userw@userw1/parameters/mkthread --set <Value>

8.47.2.4. Recovery Action

This cannot be set for this monitor resource.

8.47.3. Deleting a user mode monitor resource

Delete a resource by specifying the monitor resource type and monitor resource name.

clpcfadm.py del mon userw userw1

8.48. Virtual computer name monitor resource

Note

The command lines in this section use vcomw1 as the monitor resource name.
Change it to suit your environment.

8.48.1. Adding a virtual computer name monitor resource

Be sure to set the following items. For details, see "Setting virtual computer name monitor resource parameters".

Item (mandatory)

Monitor resource name

Target Resource (monitored when active)

Recovery target

Recovery target type

clpcfadm.py add mon vcomw vcomw1
clpcfadm.py mod -t monitor/vcomw@vcomw1/target --set <Target Resource (monitored when active)>
clpcfadm.py mod -t monitor/vcomw@vcomw1/relation/name --set <Recovery target> --nocheck
clpcfadm.py mod -t monitor/vcomw@vcomw1/relation/type --set <Recovery target type> --nocheck

Note

If you configure a cluster only with the above mandatory items, other parameters are set to their default values.

8.48.2. Setting virtual computer name monitor resource parameters

8.48.2.1. Basic information

  • Monitor resource name (Within 31 bytes)

    This is set when the resource is added. To change the monitor resource name, delete the resource and set it again.

  • Comment (Within 127 bytes)

    clpcfadm.py mod -t monitor/vcomw@vcomw1/comment --set <Comment>

    Note

    Enclose in double quotes a string including spaces (e.g., "Sample Comment").

8.48.2.2. Monitor (common)

  • Interval (sec)

    Default, 60 (minimum, 1; maximum, 999)

    clpcfadm.py mod -t monitor/vcomw@vcomw1/polling/interval --set <Value>
  • Timeout (sec)

    Default, 180 (minimum, 5; maximum, 999)

    clpcfadm.py mod -t monitor/vcomw@vcomw1/polling/timeout --set <Value>
  • Do Not Retry at Timeout Occurrence

    Do Not Retry at Timeout Occurrence

    Value

    Retry

    0

    Do not retry (default)

    1

    clpcfadm.py mod -t monitor/vcomw@vcomw1/emergency/timeout/notreconfirmation/use --set <Value>
  • Action at Timeout Occurrence

    Action at Timeout Occurrence

    Value

    Recover

    0

    Do not recover (default)

    1

    Generate an intentional stop error

    2

    clpcfadm.py mod -t monitor/vcomw@vcomw1/emergency/timeout/notrecovery/use --set <Value>

    Note

    Set as above with "Do Not Retry at Timeout Occurrence" set to "Do not retry".

  • Retry Count

    Default, 1 (minimum, 0; maximum, 999)

    clpcfadm.py mod -t monitor/vcomw@vcomw1/polling/reconfirmation --set <Value>
  • Wait Time to Start Monitoring (sec)

    Default, 0 (minimum, 0; maximum, 9999)

    clpcfadm.py mod -t monitor/vcomw@vcomw1/firstmonwait --set <Value>
  • Target Resource (monitored when active)

    clpcfadm.py mod -t monitor/vcomw@vcomw1/target --set <Target Resource (monitored when active)>
  • Choose servers that execute monitoring

    clpcfadm.py mod -t monitor/vcomw@vcomw1/polling/servers@<ID>/name --set <Server name> --nocheck

    Note

    With only one server to be monitored, specify 0 for ID.
    With more than one server to be monitored, specify consecutive numbers (e.g., 0, 1, 2...).
  • Send polling time metrics

    Send polling time metrics

    Value

    Send

    1

    Do not send (default)

    0

    clpcfadm.py mod -t monitor/vcomw@vcomw1/perf/metrics/use --set <Value>

8.48.2.3. Recovery Action

  • Recovery target

    Recovery target

    Recovery target type

    Local server

    LocalServer

    cls

    All groups([All Groups])

    ""

    grp

    Failover group name

    (Failover group name)

    grp

    Group resource name

    (Group resource name)

    rsc

    clpcfadm.py mod -t monitor/vcomw@vcomw1/relation/name --set <Recovery target> --nocheck
    clpcfadm.py mod -t monitor/vcomw@vcomw1/relation/type --set <Recovery target type> --nocheck

    Important

    If you set "Recovery target" to "Local server"

    Set "Maximum Reactivation Count" and "Maximum Failover Count" to 0 (times).

    clpcfadm.py mod -t monitor/vcomw@vcomw1/emergency/threshold/restart --set 0
    clpcfadm.py mod -t monitor/vcomw@vcomw1/emergency/threshold/fo2 --set 0

    If the current setting for "Final Action" is "Stop resource (16)" or "Stop Group (2)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/vcomw@vcomw1/emergency/action --set 1

    Important

    If you set "Recovery target" to "All groups ([All Groups])"

    Set "Maximum Reactivation Count" to 0 (times).

    clpcfadm.py mod -t monitor/vcomw@vcomw1/emergency/threshold/restart --set 0

    If the current setting for "Final Action" is "Stop resource (16)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/vcomw@vcomw1/emergency/action --set 1
  • Recovery Script Execution Count

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/vcomw@vcomw1/emergency/threshold/script --set <Value>
  • Execute Script before Reactivation

    Execute Script before Reactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/vcomw@vcomw1/emergency/preaction/userestart --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Maximum Reactivation Count

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/vcomw@vcomw1/emergency/threshold/restart --set <Value>
  • Execute Script before Failover

    Execute Script before Failover

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/vcomw@vcomw1/emergency/preaction/usefailover --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Failover Target Server

    Failover Target Server

    Value

    Stable server (default)

    1

    Maximum priority server

    0

    clpcfadm.py mod -t monitor/vcomw@vcomw1/emergency/mode --set <Value>
  • Maximum Failover Count

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/vcomw@vcomw1/emergency/threshold/fo2 --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/vcomw@vcomw1/emergency/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Final Action

    Final Action
    Value

    No operation

    1

    Stop resource 89

    16

    Stop group 90

    2

    Stop the cluster service

    3

    Stop the cluster service and shutdown OS (default)

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t monitor/vcomw@vcomw1/emergency/action --set <Value>
    89

    Cannot be specified with "Recovery target type" set to "cls" or "grp".

    90

    Cannot be specified with "Recovery target type" set to "cls".

Script Settings
  • File type

    Script file type

    Value

    Script created with this product (default)

    1

    User Application

    0

    clpcfadm.py mod -t monitor/vcomw@vcomw1/emergency/preaction/default --set <Value>

    Note

    If you change the value of this parameter, also change that of "File".

  • File (Within 1023 bytes)

    clpcfadm.py mod -t monitor/vcomw@vcomw1/emergency/preaction/path --set <File> --nocheck

    Note

    If you specify "Script created with this product", specify preaction.bat.

    clpcfadm.py mod -t monitor/vcomw@vcomw1/emergency/preaction/path --set preaction.bat --nocheck
  • Timeout (sec)

    Default, 5 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t monitor/vcomw@vcomw1/emergency/preaction/timeout --set <Value>
  • Exec User

    clpcfadm.py mod -t monitor/vcomw@vcomw1/emergency/preaction/account --set <Exec User>

8.48.3. Deleting a virtual computer name monitor resource

Delete a resource by specifying the monitor resource type and monitor resource name.

clpcfadm.py del mon vcomw vcomw1

8.49. Virtual IP monitor resource

Note

The command lines in this section use vipw1 as the monitor resource name.
Change it to suit your environment.

8.49.1. Adding a Virtual IP monitor resource

Be sure to set the following items. For details, see "Setting Virtual IP monitor resource parameters".

Item (mandatory)

Monitor resource name

Target Resource (monitored when active)

Recovery target

Recovery target type

clpcfadm.py add mon vipw vipw1
clpcfadm.py mod -t monitor/vipw@vipw1/target --set <Target Resource (monitored when active)>
clpcfadm.py mod -t monitor/vipw@vipw1/relation/name --set <Recovery target> --nocheck
clpcfadm.py mod -t monitor/vipw@vipw1/relation/type --set <Recovery target type> --nocheck

Note

If you configure a cluster only with the above mandatory items, other parameters are set to their default values.

8.49.2. Setting Virtual IP monitor resource parameters

8.49.2.1. Basic information

  • Monitor resource name (Within 31 bytes)

    This is set when the resource is added. To change the monitor resource name, delete the resource and set it again.

  • Comment (Within 127 bytes)

    clpcfadm.py mod -t monitor/vipw@vipw1/comment --set <Comment>

    Note

    Enclose in double quotes a string including spaces (e.g., "Sample Comment").

8.49.2.2. Monitor (common)

  • Interval (sec)

    Default, 60 (minimum, 1; maximum, 999)

    clpcfadm.py mod -t monitor/vipw@vipw1/polling/interval --set <Value>
  • Timeout (sec)

    Default, 180 (minimum, 5; maximum, 999)

    clpcfadm.py mod -t monitor/vipw@vipw1/polling/timeout --set <Value>
  • Do Not Retry at Timeout Occurrence

    Do Not Retry at Timeout Occurrence

    Value

    Retry

    0

    Do not retry (default)

    1

    clpcfadm.py mod -t monitor/vipw@vipw1/emergency/timeout/notreconfirmation/use --set <Value>
  • Action at Timeout Occurrence

    Action at Timeout Occurrence

    Value

    Recover

    0

    Do not recover (default)

    1

    Generate an intentional stop error

    2

    clpcfadm.py mod -t monitor/vipw@vipw1/emergency/timeout/notrecovery/use --set <Value>

    Note

    Set as above with "Do Not Retry at Timeout Occurrence" set to "Do not retry".

  • Retry Count

    Default, 1 (minimum, 0; maximum, 999)

    clpcfadm.py mod -t monitor/vipw@vipw1/polling/reconfirmation --set <Value>
  • Wait Time to Start Monitoring (sec)

    Default, 0 (minimum, 0; maximum, 9999)

    clpcfadm.py mod -t monitor/vipw@vipw1/firstmonwait --set <Value>
  • Target Resource (monitored when active)

    clpcfadm.py mod -t monitor/vipw@vipw1/target --set <Target Resource (monitored when active)>

    Note

    You can specify only a Virtual IP resource for this monitor resource.

  • Choose servers that execute monitoring

    clpcfadm.py mod -t monitor/vipw@vipw1/polling/servers@<ID>/name --set <Server name> --nocheck

    Note

    With only one server to be monitored, specify 0 for ID.
    With more than one server to be monitored, specify consecutive numbers (e.g., 0, 1, 2...).
  • Send polling time metrics

    Send polling time metrics

    Value

    Send

    1

    Do not send (default)

    0

    clpcfadm.py mod -t monitor/vipw@vipw1/perf/metrics/use --set <Value>

8.49.2.3. Recovery Action

  • Recovery target

    Recovery target

    Recovery target type

    Local server

    LocalServer

    cls

    All groups([All Groups])

    ""

    grp

    Failover group name

    (Failover group name)

    grp

    Group resource name

    (Group resource name)

    rsc

    clpcfadm.py mod -t monitor/vipw@vipw1/relation/name --set <Recovery target> --nocheck
    clpcfadm.py mod -t monitor/vipw@vipw1/relation/type --set <Recovery target type> --nocheck

    Important

    If you set "Recovery target" to "Local server"

    Set "Maximum Reactivation Count" and "Maximum Failover Count" to 0 (times).

    clpcfadm.py mod -t monitor/vipw@vipw1/emergency/threshold/restart --set 0
    clpcfadm.py mod -t monitor/vipw@vipw1/emergency/threshold/fo2 --set 0

    If the current setting for "Final Action" is "Stop resource (16)" or "Stop Group (2)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/vipw@vipw1/emergency/action --set 1

    Important

    If you set "Recovery target" to "All groups ([All Groups])"

    Set "Maximum Reactivation Count" to 0 (times).

    clpcfadm.py mod -t monitor/vipw@vipw1/emergency/threshold/restart --set 0

    If the current setting for "Final Action" is "Stop resource (16)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/vipw@vipw1/emergency/action --set 1
  • Recovery Script Execution Count

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/vipw@vipw1/emergency/threshold/script --set <Value>
  • Execute Script before Reactivation

    Execute Script before Reactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/vipw@vipw1/emergency/preaction/userestart --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Maximum Reactivation Count

    Default, 3 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/vipw@vipw1/emergency/threshold/restart --set <Value>
  • Execute Script before Failover

    Execute Script before Failover

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/vipw@vipw1/emergency/preaction/usefailover --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Failover Target Server

    Failover Target Server

    Value

    Stable server (default)

    1

    Maximum priority server

    0

    clpcfadm.py mod -t monitor/vipw@vipw1/emergency/mode --set <Value>
  • Maximum Failover Count

    Default, 1 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/vipw@vipw1/emergency/threshold/fo2 --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/vipw@vipw1/emergency/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Final Action

    Final Action
    Value

    No operation (default)

    1

    Stop resource 91

    16

    Stop group 92

    2

    Stop the cluster service

    3

    Stop the cluster service and shutdown OS

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t monitor/vipw@vipw1/emergency/action --set <Value>
    91

    Cannot be specified with "Recovery target type" set to "cls" or "grp".

    92

    Cannot be specified with "Recovery target type" set to "cls".

Script Settings
  • File type

    Script file type

    Value

    Script created with this product (default)

    1

    User Application

    0

    clpcfadm.py mod -t monitor/vipw@vipw1/emergency/preaction/default --set <Value>

    Note

    If you change the value of this parameter, also change that of "File".

  • File (Within 1023 bytes)

    clpcfadm.py mod -t monitor/vipw@vipw1/emergency/preaction/path --set <File> --nocheck

    Note

    If you specify "Script created with this product", specify preaction.bat.

    clpcfadm.py mod -t monitor/vipw@vipw1/emergency/preaction/path --set preaction.bat --nocheck
  • Timeout (sec)

    Default, 5 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t monitor/vipw@vipw1/emergency/preaction/timeout --set <Value>
  • Exec User

    clpcfadm.py mod -t monitor/vipw@vipw1/emergency/preaction/account --set <Exec User>

8.49.3. Deleting a Virtual IP monitor resource

Delete a resource by specifying the monitor resource type and monitor resource name.

clpcfadm.py del mon vipw vipw1

8.50. WebSphere monitor resource

Note

The command lines in this section use wasw1 as the monitor resource name.
Change it to suit your environment.

8.50.1. Adding a WebSphere monitor resource

Be sure to set the following items. For details, see "Setting WebSphere monitor resource parameters".

Item (mandatory)

Monitor resource name

Target Resource (monitored when active)

User Name

Recovery target

Recovery target type

clpcfadm.py add mon wasw wasw1
clpcfadm.py mod -t monitor/wasw@wasw1/target --set <Target Resource (monitored when active)>
clpcfadm.py mod -t monitor/wasw@wasw1/parameters/username --set <User Name> --nocheck
clpcfadm.py mod -t monitor/wasw@wasw1/relation/name --set <Recovery target> --nocheck
clpcfadm.py mod -t monitor/wasw@wasw1/relation/type --set <Recovery target type> --nocheck

Note

If you configure a cluster only with the above mandatory items, other parameters are set to their default values.

8.50.2. Setting WebSphere monitor resource parameters

8.50.2.1. Basic information

  • Monitor resource name (Within 31 bytes)

    This is set when the resource is added. To change the monitor resource name, delete the resource and set it again.

  • Comment (Within 127 bytes)

    clpcfadm.py mod -t monitor/wasw@wasw1/comment --set <Comment>

    Note

    Enclose in double quotes a string including spaces (e.g., "Sample Comment").

8.50.2.2. Monitor (common)

  • Interval (sec)

    Default, 60 (minimum, 1; maximum, 999)

    clpcfadm.py mod -t monitor/wasw@wasw1/polling/interval --set <Value>
  • Timeout (sec)

    Default, 120 (minimum, 5; maximum, 999)

    clpcfadm.py mod -t monitor/wasw@wasw1/polling/timeout --set <Value>
  • Do Not Retry at Timeout Occurrence

    Do Not Retry at Timeout Occurrence

    Value

    Retry (default)

    0

    Do not retry

    1

    clpcfadm.py mod -t monitor/wasw@wasw1/emergency/timeout/notreconfirmation/use --set <Value>
  • Action at Timeout Occurrence

    Action at Timeout Occurrence

    Value

    Recover (default)

    0

    Do not recover

    1

    Generate an intentional stop error

    2

    clpcfadm.py mod -t monitor/wasw@wasw1/emergency/timeout/notrecovery/use --set <Value>

    Note

    Set as above with "Do Not Retry at Timeout Occurrence" set to "Do not retry".

  • Retry Count

    Default, 2 (minimum, 0; maximum, 999)

    clpcfadm.py mod -t monitor/wasw@wasw1/polling/reconfirmation --set <Value>
  • Wait Time to Start Monitoring (sec)

    Default, 0 (minimum, 0; maximum, 9999)

    clpcfadm.py mod -t monitor/wasw@wasw1/firstmonwait --set <Value>
  • Target Resource (monitored when active)

    clpcfadm.py mod -t monitor/wasw@wasw1/target --set <Target Resource (monitored when active)>
  • Choose servers that execute monitoring

    clpcfadm.py mod -t monitor/wasw@wasw1/polling/servers@<ID>/name --set <Server name> --nocheck

    Note

    With only one server to be monitored, specify 0 for ID.
    With more than one server to be monitored, specify consecutive numbers (e.g., 0, 1, 2...).
  • Send polling time metrics

    Send polling time metrics

    Value

    Send

    1

    Do not send (default)

    0

    clpcfadm.py mod -t monitor/wasw@wasw1/perf/metrics/use --set <Value>

8.50.2.3. Monitor (special)

  • Application Server Name (Within 255 bytes)

    Default: server1

    clpcfadm.py mod -t monitor/wasw@wasw1/parameters/server --set <Application Server Name>
  • Profile Name (Within 1023 bytes)

    Default: default

    clpcfadm.py mod -t monitor/wasw@wasw1/parameters/profile --set <Profile Name>
  • User Name (Within 255 bytes)

    clpcfadm.py mod -t monitor/wasw@wasw1/parameters/username --set <User Name> --nocheck
  • Password (Within 255 bytes)

    clpcfadm.py mod -t monitor/wasw@wasw1/parameters/password --set <Encrypted password>

    Note

    Set an encrypted password string.
  • Install Path (Within 1023 bytes)

    Install Path

    C:Program FilesIBMWebSphereAppServer (default)

    clpcfadm.py mod -t monitor/wasw@wasw1/parameters/installpath --set <Install Path>

8.50.2.4. Recovery Action

  • Recovery target

    Recovery target

    Recovery target type

    Local server

    LocalServer

    cls

    All groups([All Groups])

    ""

    grp

    Failover group name

    (Failover group name)

    grp

    Group resource name

    (Group resource name)

    rsc

    clpcfadm.py mod -t monitor/wasw@wasw1/relation/name --set <Recovery target> --nocheck
    clpcfadm.py mod -t monitor/wasw@wasw1/relation/type --set <Recovery target type> --nocheck

    Important

    If you set "Recovery target" to "Local server"

    Set "Maximum Reactivation Count" and "Maximum Failover Count" to 0 (times).

    clpcfadm.py mod -t monitor/wasw@wasw1/emergency/threshold/restart --set 0
    clpcfadm.py mod -t monitor/wasw@wasw1/emergency/threshold/fo2 --set 0

    If the current setting for "Final Action" is "Stop resource (16)" or "Stop Group (2)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/wasw@wasw1/emergency/action --set 1

    Important

    If you set "Recovery target" to "All groups ([All Groups])"

    Set "Maximum Reactivation Count" to 0 (times).

    clpcfadm.py mod -t monitor/wasw@wasw1/emergency/threshold/restart --set 0

    If the current setting for "Final Action" is "Stop resource (16)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/wasw@wasw1/emergency/action --set 1
  • Recovery Script Execution Count

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/wasw@wasw1/emergency/threshold/script --set <Value>
  • Execute Script before Reactivation

    Execute Script before Reactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/wasw@wasw1/emergency/preaction/userestart --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Maximum Reactivation Count

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/wasw@wasw1/emergency/threshold/restart --set <Value>
  • Execute Script before Failover

    Execute Script before Failover

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/wasw@wasw1/emergency/preaction/usefailover --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Failover Target Server

    Failover Target Server

    Value

    Stable server (default)

    1

    Maximum priority server

    0

    clpcfadm.py mod -t monitor/wasw@wasw1/emergency/mode --set <Value>
  • Maximum Failover Count

    Default, 1 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/wasw@wasw1/emergency/threshold/fo2 --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/wasw@wasw1/emergency/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Final Action

    Final Action
    Value

    No operation

    1

    Stop resource 93

    16

    Stop group 94

    2

    Stop the cluster service

    3

    Stop the cluster service and shutdown OS (default)

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t monitor/wasw@wasw1/emergency/action --set <Value>
    93

    Cannot be specified with "Recovery target type" set to "cls" or "grp".

    94

    Cannot be specified with "Recovery target type" set to "cls".

Script Settings
  • File type

    Script file type

    Value

    Script created with this product (default)

    1

    User Application

    0

    clpcfadm.py mod -t monitor/wasw@wasw1/emergency/preaction/default --set <Value>

    Note

    If you change the value of this parameter, also change that of "File".

  • File (Within 1023 bytes)

    clpcfadm.py mod -t monitor/wasw@wasw1/emergency/preaction/path --set <File> --nocheck

    Note

    If you specify "Script created with this product", specify preaction.bat.

    clpcfadm.py mod -t monitor/wasw@wasw1/emergency/preaction/path --set preaction.bat --nocheck
  • Timeout (sec)

    Default, 5 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t monitor/wasw@wasw1/emergency/preaction/timeout --set <Value>
  • Exec User

    clpcfadm.py mod -t monitor/wasw@wasw1/emergency/preaction/account --set <Exec User>

8.50.3. Deleting a WebSphere monitor resource

Delete a resource by specifying the monitor resource type and monitor resource name.

clpcfadm.py del mon wasw wasw1

8.51. WebLogic monitor resource

Note

The command lines in this section use wlsw1 as the monitor resource name.
Change it to suit your environment.

8.51.1. Adding a WebLogic monitor resource

Be sure to set the following items. For details, see "Setting WebLogic monitor resource parameters".

Item (mandatory)

Monitor resource name

Target Resource (monitored when active)

Recovery target

Recovery target type

clpcfadm.py add mon wlsw wlsw1
clpcfadm.py mod -t monitor/wlsw@wlsw1/target --set <Target Resource (monitored when active)>
clpcfadm.py mod -t monitor/wlsw@wlsw1/relation/name --set <Recovery target> --nocheck
clpcfadm.py mod -t monitor/wlsw@wlsw1/relation/type --set <Recovery target type> --nocheck

Note

If you configure a cluster only with the above mandatory items, other parameters are set to their default values.

8.51.2. Setting WebLogic monitor resource parameters

8.51.2.1. Basic information

  • Monitor resource name (Within 31 bytes)

    This is set when the resource is added. To change the monitor resource name, delete the resource and set it again.

  • Comment (Within 127 bytes)

    clpcfadm.py mod -t monitor/wlsw@wlsw1/comment --set <Comment>

    Note

    Enclose in double quotes a string including spaces (e.g., "Sample Comment").

8.51.2.2. Monitor (common)

  • Interval (sec)

    Default, 60 (minimum, 1; maximum, 999)

    clpcfadm.py mod -t monitor/wlsw@wlsw1/polling/interval --set <Value>
  • Timeout (sec)

    Default, 120 (minimum, 5; maximum, 999)

    clpcfadm.py mod -t monitor/wlsw@wlsw1/polling/timeout --set <Value>
  • Do Not Retry at Timeout Occurrence

    Do Not Retry at Timeout Occurrence

    Value

    Retry (default)

    0

    Do not retry

    1

    clpcfadm.py mod -t monitor/wlsw@wlsw1/emergency/timeout/notreconfirmation/use --set <Value>
  • Action at Timeout Occurrence

    Action at Timeout Occurrence

    Value

    Recover (default)

    0

    Do not recover

    1

    Generate an intentional stop error

    2

    clpcfadm.py mod -t monitor/wlsw@wlsw1/emergency/timeout/notrecovery/use --set <Value>

    Note

    Set as above with "Do Not Retry at Timeout Occurrence" set to "Do not retry".

  • Retry Count

    Default, 2 (minimum, 0; maximum, 999)

    clpcfadm.py mod -t monitor/wlsw@wlsw1/polling/reconfirmation --set <Value>
  • Wait Time to Start Monitoring (sec)

    Default, 0 (minimum, 0; maximum, 9999)

    clpcfadm.py mod -t monitor/wlsw@wlsw1/firstmonwait --set <Value>
  • Target Resource (monitored when active)

    clpcfadm.py mod -t monitor/wlsw@wlsw1/target --set <Target Resource (monitored when active)>
  • Choose servers that execute monitoring

    clpcfadm.py mod -t monitor/wlsw@wlsw1/polling/servers@<ID>/name --set <Server name> --nocheck

    Note

    With only one server to be monitored, specify 0 for ID.
    With more than one server to be monitored, specify consecutive numbers (e.g., 0, 1, 2...).
  • Send polling time metrics

    Send polling time metrics

    Value

    Send

    1

    Do not send (default)

    0

    clpcfadm.py mod -t monitor/wlsw@wlsw1/perf/metrics/use --set <Value>

8.51.2.3. Monitor (special)

  • IP Address

    Default: 127.0.0.1

    clpcfadm.py mod -t monitor/wlsw@wlsw1/parameters/ipaddress --set <IP Address>
  • Port Number

    Default, 7002 (minimum, 1; maximum, 65535)

    clpcfadm.py mod -t monitor/wlsw@wlsw1/parameters/port --set <Value>
  • Monitor Method

    Monitor Method

    Value

    RESTful API (default)

    3

    WLST

    2

    clpcfadm.py mod -t monitor/wlsw@wlsw1/parameters/checkmethod --set <Value>
  • Protocol

    Protocol

    Value

    HTTP (default)

    0

    HTTPS

    1

    clpcfadm.py mod -t monitor/wlsw@wlsw1/parameters/https --set <Value>
  • User Name (Within 255 bytes)

    Default: weblogic

    clpcfadm.py mod -t monitor/wlsw@wlsw1/parameters/restusername --set <User Name>

    Note

    You can set this parameter with "Monitor Method" set to "RESTful API".

  • Password (Within 255 bytes)

    clpcfadm.py mod -t monitor/wlsw@wlsw1/parameters/restpassword --set <Encrypted password>

    Note

    You can set this parameter with "Monitor Method" set to "RESTful API".

    Note

    Set an encrypted password string.
Account Shadow

Note

To set the following items, set "Monitor Method" to "WLST" in advance.

  • Account Shadow

    Account Shadow

    Value

    On

    1

    Off (default)

    0

    clpcfadm.py mod -t monitor/wlsw@wlsw1/parameters/shadow --set <Value>
  • Config File (Within 1023 bytes)

    clpcfadm.py mod -t monitor/wlsw@wlsw1/parameters/configfile --set <Config File>

    Note

    Set as above with "Account Shadow" set to "On".

  • Key File (Within 1023 bytes)

    clpcfadm.py mod -t monitor/wlsw@wlsw1/parameters/keyfile --set <Key File>

    Note

    Set as above with "Account Shadow" set to "On".

  • User Name (Within 255 bytes)

    Default: weblogic

    clpcfadm.py mod -t monitor/wlsw@wlsw1/parameters/username --set <User Name>

    Note

    Set as above with "Account Shadow" set to "Off".

  • Password (Within 255 bytes)

    clpcfadm.py mod -t monitor/wlsw@wlsw1/parameters/password --set <Encrypted password>

    Note

    Set as above with "Account Shadow" set to "Off".

    Note

    Set an encrypted password string.
Authority Method

Note

To set the following items, set "Monitor Method" to "WLST" in advance.

  • Authority Method

    Authority Method

    Value

    Not Use SSL

    0

    DemoTrust (default)

    1

    CustomTrust

    2

    clpcfadm.py mod -t monitor/wlsw@wlsw1/parameters/authority --set <Value>
  • Key Store File (Within 1023 bytes)

    clpcfadm.py mod -t monitor/wlsw@wlsw1/parameters/keystorefile --set <Key Store File>

    Note

    Set as above with "Authority Method" set to "CustomTrust".

  • Install Path (Within 255 bytes)

    Install Path

    C:\Oracle\Middleware\Oracle_Home\wlserver (default)

    clpcfadm.py mod -t monitor/wlsw@wlsw1/parameters/installpath --set <Install Path>
  • Add command option (Within 1023 bytes)

    Default: -Dwlst.offline.log=disable -Duser.language=en_US

    clpcfadm.py mod -t monitor/wlsw@wlsw1/parameters/option --set <Add command option>

8.51.2.4. Recovery Action

  • Recovery target

    Recovery target

    Recovery target type

    Local server

    LocalServer

    cls

    All groups([All Groups])

    ""

    grp

    Failover group name

    (Failover group name)

    grp

    Group resource name

    (Group resource name)

    rsc

    clpcfadm.py mod -t monitor/wlsw@wlsw1/relation/name --set <Recovery target> --nocheck
    clpcfadm.py mod -t monitor/wlsw@wlsw1/relation/type --set <Recovery target type> --nocheck

    Important

    If you set "Recovery target" to "Local server"

    Set "Maximum Reactivation Count" and "Maximum Failover Count" to 0 (times).

    clpcfadm.py mod -t monitor/wlsw@wlsw1/emergency/threshold/restart --set 0
    clpcfadm.py mod -t monitor/wlsw@wlsw1/emergency/threshold/fo2 --set 0

    If the current setting for "Final Action" is "Stop resource (16)" or "Stop Group (2)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/wlsw@wlsw1/emergency/action --set 1

    Important

    If you set "Recovery target" to "All groups ([All Groups])"

    Set "Maximum Reactivation Count" to 0 (times).

    clpcfadm.py mod -t monitor/wlsw@wlsw1/emergency/threshold/restart --set 0

    If the current setting for "Final Action" is "Stop resource (16)", change it to "No operation (1)".

    clpcfadm.py mod -t monitor/wlsw@wlsw1/emergency/action --set 1
  • Recovery Script Execution Count

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/wlsw@wlsw1/emergency/threshold/script --set <Value>
  • Execute Script before Reactivation

    Execute Script before Reactivation

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/wlsw@wlsw1/emergency/preaction/userestart --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Maximum Reactivation Count

    Default, 0 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/wlsw@wlsw1/emergency/threshold/restart --set <Value>
  • Execute Script before Failover

    Execute Script before Failover

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/wlsw@wlsw1/emergency/preaction/usefailover --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Failover Target Server

    Failover Target Server

    Value

    Stable server (default)

    1

    Maximum priority server

    0

    clpcfadm.py mod -t monitor/wlsw@wlsw1/emergency/mode --set <Value>
  • Maximum Failover Count

    Default, 1 (minimum, 0; maximum, 99)

    clpcfadm.py mod -t monitor/wlsw@wlsw1/emergency/threshold/fo2 --set <Value>
  • Execute Script before Final Action

    Execute Script before Final Action

    Value

    Check

    1

    Do not check (default)

    0

    clpcfadm.py mod -t monitor/wlsw@wlsw1/emergency/preaction/use --set <Value>

    Note

    If "Execute" is set, specify the file. (See "Script Settings" -> "File".)

  • Final Action

    Final Action
    Value

    No operation

    1

    Stop resource 95

    16

    Stop group 96

    2

    Stop the cluster service

    3

    Stop the cluster service and shutdown OS (default)

    4

    Stop the cluster service and reboot OS

    5

    Generate an intentional stop error

    6

    clpcfadm.py mod -t monitor/wlsw@wlsw1/emergency/action --set <Value>
    95

    Cannot be specified with "Recovery target type" set to "cls" or "grp".

    96

    Cannot be specified with "Recovery target type" set to "cls".

Script Settings
  • File type

    Script file type

    Value

    Script created with this product (default)

    1

    User Application

    0

    clpcfadm.py mod -t monitor/wlsw@wlsw1/emergency/preaction/default --set <Value>

    Note

    If you change the value of this parameter, also change that of "File".

  • File (Within 1023 bytes)

    clpcfadm.py mod -t monitor/wlsw@wlsw1/emergency/preaction/path --set <File> --nocheck

    Note

    If you specify "Script created with this product", specify preaction.bat.

    clpcfadm.py mod -t monitor/wlsw@wlsw1/emergency/preaction/path --set preaction.bat --nocheck
  • Timeout (sec)

    Default, 5 (minimum, 1; maximum, 9999)

    clpcfadm.py mod -t monitor/wlsw@wlsw1/emergency/preaction/timeout --set <Value>
  • Exec User

    clpcfadm.py mod -t monitor/wlsw@wlsw1/emergency/preaction/account --set <Exec User>

8.51.3. Deleting a WebLogic monitor resource

Delete a resource by specifying the monitor resource type and monitor resource name.

clpcfadm.py del mon wlsw wlsw1

9. Retrieving an encrypted password string

The clpcfadm.py command cannot retrieve encrypted password strings.
See "Reference" in the following table, then carry out the applicable procedure.

Authentication password

Reference

Cluster WebUI authentication (for operation)
Cluster WebUI authentication (for reference)

Retrieving an encrypted password string with Cluster WebUI/Cluster WebUI Offline

Other than the above

Retrieving an encrypted password string with the clpencrypt command

9.1. Retrieving an encrypted password string with Cluster WebUI/Cluster WebUI Offline

Retrieve an encrypted password string as follows:

  1. Import any set of cluster configuration data through Cluster WebUI or Cluster WebUI Offline.

  2. On Cluster WebUI or Cluster WebUI Offline, set relevant passwords.

  3. Click Export, then save the cluster configuration data to any directory.

  4. Extract the zip file that you saved above, and then open clp.conf with a text editor.

  5. Check relevant path values.

    Example: Cluster WebUI authentication
    <root>
        <webmgr>
            <security>
                <adminpwd>ca978112ca1bbdcafac231b39a23dc4da786eff8147c4e72b9807785afee48bb</adminpwd>
                <userpwd>3e23e8160039594a33894f6564e1b1348bbd7a0088d42c4acb73eeaed59c009d</userpwd>
            </security>
        </webmgr>
    </root>
    
    Password for Operation ca978112ca1bbdcafac231b39a23dc4da786eff8147c4e72b9807785afee48bb
    Password for Reference 3e23e8160039594a33894f6564e1b1348bbd7a0088d42c4acb73eeaed59c009d

9.2. Retrieving an encrypted password string with the clpencrypt command

Retrieve an encrypted password string by executing the following command:

clpencrypt <password (plaintext)>

10. Notes and restrictions

  • For strings that can be entered for parameters, and for prohibited strings, see the corresponding chapters of "EXPRESSCLUSTER X Reference Guide"

  • When specifying a file (e.g., script file), place the file in the same path on each server.

    Example

    Desired script file specified in the Recovery Action of a monitor resource

    clpcfadm.py mod -t monitor/<Monitor resource type>@<Monitor resource name>/emergency/preaction/path --set <Desired script file>
  • The command execution examples provided in this guide may require escape characters, which depends on the shell that you execute.