rp_pool_server_status

Description

Displays or sets the status of the server present in any pool that is defined in the [POOL] section of the OpenSwitch configuration file.

NoteYou can also use OpenSwitch Manager to view or set the status of servers.

Syntax

rp_pool_server_status pool [server, status]

Parameters

pool

The name of the pool. The pool you specify must be defined in the [POOL] section of the OpenSwitch configuration file.

server

Name of the server. If server name is NULL, rp_pool_server_status displays the status of all servers present in the pool.

status

The status of the server. If status is NULL, then rp_pool_server_status displays the status of the specified server that is present in the pool. If status is not NULL, the status value is used to set the pool-specific server status for this pool.Valid status values are:

Value

Description

UP

The server is immediately available for use.

DOWN

The server is unavailable, and is not considered for new client connections to OpenSwitch.

LOCKED

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

Examples

Example 1

Displays the status of all the servers present in the “POOL1.”

1> rp_pool_server_status  "POOL1", NULL, NULL
2> go

Returns:

pool_name   server_name   status
-------------------------------------------
POOL1        ase1         UP
POOL1        ase2         UP
POOL1        ase3         UP

Example 2

Displays the status of the “ase1” server that is present in “POOL1.”

1> rp_pool_server_status  "POOL1", ”ase1”, NULL
2> go

Returns:

pool_name    server_name   status
-----------------------------------------------
POOL1         ase1         UP

Example 3

Sets the status to DOWN of the “ase1” server that is present in the “POOL1.”

1> rp_pool_server_status  "POOL1", "ase1", "DOWN"
2> go

Returns:

pool_name       server_name   status 
------------------------------------------------ 
POOL1            ase1         DOWN

Usage

The status set by rp_pool_server_status, if any, takes precedence over the status set by rp_server_status for a server status within a pool.

See also

rp_pool_addserver, rp_server_status