EXAMPLES

NAME

status - Query device status.

MODULE

base

SYNOPSIS

status [ --help|usage ] [ --db[name] dbname ] [ --default ] [ --console ] [ --power ] [ --node ] [ --leader ] [ --net[work] [ --interface <number> ] [ --protocol <type> ] [ --timeout <time> ] ] [ --full ] [ --only <key> ] <{device|collection}..>

DESCRIPTION

The default action of the status command is to status the device or devices specified. The remainder of the status parameters can be used as follows to alter the functionality of the status command as specified below.

OPTIONS

--db[name] <dbname > Filename of cluster database to use.

--node

    Query only node type devices

--help or --usage

    Print usage.

--man

    Print manpage.

--default

    Execute the "default" type status for the device specified.  
    This is the default action.

--console

    Display the status of the device specified in the console 
    attribute of the original device specified.

--power

    Display the status of the device specified in the power attribute 
    of the original device specified.

--leader

    Display the status of the device specified in the leader attribute 
    of the original device specified.

--full

    Display everything returned by the status of the device, 
    by default a DEVICE type status is returned. Devices are required 
    to return at a minimum the DEVICE status but may return additional 
    information.

--only <key >

    Display only the specific type of status identified by <key>

--network

    Display a "network" status of the device specified.  
    The following additional parameters can be specified to modify 
    the network status

--interface <number >

    Specify the specific interface number to use for a network type 
    status

--protocol <proto >

    Specify the protocol to use for the network status. 
    Valid options are "tcp", "udp" and "icmp", see Net::Ping for more 
    information of the protocol types.

--timeout <time >

    Specify the timeout period for the network status. (integer number)

EXAMPLES

Display the simple DEVICE status of node.n-1.t-0

# status node.n-1.t-0

node.n-1.t-0: STATUS READY

Display the status of the device assigned to the console attribute (ts-0.t-0) of node.n-1.t-0

# status --console node.n-1.t-0

node.n-1.t-0: CONSOLE ts-0.t-0 STATUS READY

Display the status of the device assigned to the leader attribute () of node.n-1.t-0

# status --leader node.n-1.t-0

node.n-1.t-0: LEADER node.n-0.t-0 STATUS RUNNING

NOTES

Set the environment variable CLUSTER_CONFIG to the location of the cluster database, for example /cluster/machine/machine_name.

FILES

The default paths for location of the database, cloned directories, and other defaults are recorded in $CLUSTER_CONFIG/CConf.pm.