rp_pool_status

Description

Sets or displays pool status.

NoteYou can also use OpenSwitch Manager to change the pool status.

Syntax

rp_pool_status [pool_name, status]

Parameters

pool_name

Name of the pool to be displayed or changed.

status

The status to which the pool is to be changed. If you supply a status value, but no pool name, the status of all pools is changed. Table 7-10 describes the values for status.

Table 7-10: Status values for rp_pool_status

Status

Description

PRE_UP

Mutually-aware-specific pool status. The pool is either in the process of being marked as UP, or has encountered a problem during that process. Check the error log to troubleshoot the problem. After you resolve the problem, manually set the pool status to UP on one of the mutually-aware companion OpenSwitch servers. The command will be propagated to the other OpenSwitch companion if it is running.

WARNING! Do not manually set a pool’s status to PRE_UP.

UP

The pool is immediately available for use.

PRE_DOWN

Mutually-aware specific pool status. The pool is either in the process of being marked as DOWN, or has encountered a problem during that process. Check the error log to troubleshoot the problem. After you resolve the problem, manually set the pool status to DOWN on one of the mutually-aware companion OpenSwitch servers. The command will be propagated to the other OpenSwitch companion if it is running.

WARNING! Do not manually set a pool’s status to PRE_DOWN.

DOWN

The pool is unavailable, and is not considered for use by any new client connections established to OpenSwitch.

PRE_LOCKED

Mutually-aware specific pool status. The pool is either in the process of being marked as LOCKED, or has encountered a problem during that process. doing so. Check the error log to troubleshoot the problem. After you resolve the problem, manually set the pool status to LOCKED on one of the mutually-aware companion OpenSwitch servers. The command will be propagated to the other OpenSwitch companion if it is running.

WARNING! Do not manually set a pool’s status to PRE_LOCKED.

LOCKED

The pool is available, but any new incoming connections actively being connected through the pool are blocked (or stopped) until the status is changed to UP or DOWN. Blocked connections appear to the client applications to have stopped responding until the pool is unlocked.

SUSPENDED

The pool is being suspended by OpenSwitch due to a failure that requires an administrator’s manual intervention. See “Invoking custom and manual scripts” for more information. The pool blocks on all new connections until rp_go is issued.

WARNING! Do not manually set a pool’s status to SUSPENDED.

Examples

Example 1

Displays the list of all pools and their current status:

1> rp_pool_status
2> go

Returns:

pool_name     status
------------- ---------
POOL_A        UP
POOL_B        UP
POOL_C        UP

Example 2

Displays the current status of POOL_A:

1> rp_pool_status "POOL_A"
2> go

Returns:

pool_name     status
------------- ---------
POOL_A        UP

Example 3

Changes the status of POOL_A to LOCKED and displays the results:

1> rp_pool_status "POOL_A", "LOCKED"
2> go

Returns:

pool_name     status
------------- ---------
POOL_A        LOCKED

Usage


Messages

See also

rp_pool_create, rp_pool_help