RSH Module

The RSH module is used to execute commands on a remote host. The module implements a set of available commands. It does not allow the user to execute arbitrary commands on a remote host.

Module Features

The RSH module provides the end user or client with the following capabilities:

Configuring the RSH Module To Manage a Node

The CONFIGURATION command is used to configure the agent, and remote user for RSH to use during connect.
FORMAT:
SERCON:CONFIGURATION:<NODE_ID>:<RSH_AGENT>:<RSH_USER>
RESPONSES:
JOB_STARTED
JOB_ERROR:(errno string)
JOB_COMPLETED
FIELDS:
<RSH_AGENT> - The RSH agent is the transport agent used for the RSH
module to execute commands on a remote host.  Currently the only transport
supported is RSH.
<RSH_USER> - The RSH user is the username to use to connect to the
remote node.  This should usually be root.
RSH takes the address of the remote node from the global variable IP_ADDRESS.

Obtaining Node Inventory

FORMAT:
RSH:NODE_INV_INFO:<NODE_ID>
RESPONSES:
JOB_STARTED
NODE_INV_INFO:<OS_NAME>:<KERNEL_VERSION>
JOB_COMPLETED

Obtaining Load Average

FORMAT:
RSH:LOAD_AVG:<NODE_ID>
RESPONSES:
JOB_STARTED
LOAD_AVG:<LOAD_ONE>:<LOAD_FIVE>:<LOAD_FIFTEEN>
JOB_COMPLETED

Obtaining Online User Listing

FORMAT:
RSH:WHO:<NODE_ID>
RESPONSES:
JOB_STARTED
WHO:<USERNAME>:<TTY>
JOB_COMPLETED

Obtaining Memory Usage

FORMAT:
RSH:MEM:<NODE_ID>
RESPONSES:
JOB_STARTED
MEM:<T_MEM>:<F_MEM>:<S_MEM>:<BUFF>:<CACHE>:<T_SWAP>:<F_SWAP>
JOB_COMPLETED
FIELDS:
<T_MEM>  - Total System Memory
<F_MEM>  - Free System Memory
<S_MEM>  - Shared System Memory
<BUFF>   - Buffers
<CACHE>  - Cache
<T_SWAP> - Total Swap
<F_SWAP> - Free Swap

Obtaining Process Listing

FORMAT:
RSH:PS:<NODE_ID>
RESPONSES:
JOB_STARTED
PS:<PID>:<USER>:<CPU>:<MEM>:<RSS>:<STATE>:<TTY>:<CMD>
JOB_COMPLETED
FIELDS:
<PID>  - Process ID
<USER>  - Username running process
<CPU>  - Percentage of CPU currently in use
<MEM>   - Percentage of memory currently in use
<RSS>  - Resident set size of process
<STATE> - Current state of process
<TTY> - TTY associated with process
<CMD> - Command name

Retrieving Remote Syslog

FORMAT:
RSH:DOWNLOAD_LOG:<NODE_ID>
RESPONSES:
JOB_STARTED
DOWNLOAD_LOG:<LOG_ENTRY>
JOB_COMPLETED

Shutdown a Node

FORMAT:
RSH:SHUTDOWN:<NODE_ID>
RESPONSES:
JOB_STARTED
JOB_COMPLETED

Restart a Node

FORMAT:
RSH:RESTART:<NODE_ID>
RESPONSES:
JOB_STARTED
JOB_COMPLETED