NAME

drain - start memory drain

SYNOPSIS

drain sb [wait]

AVAILABILITY

Sun Enterprise 10000 servers only.

DESCRIPTION

The drain command, which you execute from the dr (1M)prompt, is the first of a twostep procedure for DR detaching a system board. The primary function of the drain command is to determine how the memory physically located on the designated board should be vacated. This memory may be simply flushed, or it may be copied to memory available on another system board in the same domain.

If a suitable target memory for the memory copy is not available when the drain command is invoked, the request is denied. If the unavailability is due to run-time conditions and system load, you can retry the drain operation at a later time.

The drain command starts the drain operation, and then returns. The drain may take several minutes to complete. You can execute drshow sb DRAIN to monitor its progress; see drshow(1M). Or, you can specify the wait option, and the drain command returns only after the board has been fully drained, or drain detects an error. drain automatically displays the board status once before returning.

OPTIONS

sb

The board number (0 to 15) of the system board to be drained.

wait

Poll the DR daemon every 5 seconds and return to the caller only after the drain completes. This option is useful when the drain is performed by a script. This option is case-insensitive.

EXIT STATUS

Upon successful initiation of the drain, drain returns a 0 in the dr_return global variable; if the initiation fails, it returns a 1. If wait is specified, a 0 in dr_return indicates that the drain (not just initiation of it) has completed successfully, and a 1 indicates that the drain has failed.

drain ( 1M ) EXAMPLE

ts4-ssp% domain_switch ts4

ts4-ssp% dr
Checking environment...
Establishing Control Board Server connection...
Initializing SSP SNMP MIB...
Establishing communication with DR daemon...

                ts4: System Status - Summary

BOARD #: 1 3 4 5 being used by the system.

dr> drain 5

Removing board 5 from domain_config file.

Start draining board 5.

Board drain started. Retrieving System Info...

Bound Processes for Board 5

cpu user sys procs

--- ---- --- -----

20  0  1
21  0  1
22  0  1
23  0  1

No active IO devices.

Memory Drain for Board 5 - IN PROGRESS

Reduction

= 1024 MBytes

Remaining in System

= 2048 MBytes

Percent Complete

= 0% (1048576 KBytes remaining)

Drain operation started at Sun Sep 15 22:50:57 1996

Current time

Sun Sep 15 22:50:57 1996

Memory Drain is in progress. When Drain has finished,

you may COMPLETE the board detach.

NOTES

If DR detects a usage syntax error, it immediately aborts the dr (1M)command, displays the dr (1M)shell prompt, and leaves dr_return unmodified. See dr (1M).

SEE ALSO

dr (1M)in this reference manual

domain_switch(1M) in the Ultra Enterprise 10000 SSP Reference Manual