Managing the storage system with the RLM

Using the RLM command line interface

You manage the storage system with the RLM by using the RLM CLI, which has the same CLI features available in the Data ONTAP CLI:

History
Command-line editor
Online command-line help

These CLI features that are common to Data ONTAP and the RLM are described in the section Using the command line interface. Note that RLM CLI commands are not documented in online command line manual (man) pages.

The RLM CLI provides two sets of commands, depending on the current user mode, or privilege level, which can be administrative (admin) or advanced. This functionality is identical to that of the privilege levels supported by the Data ONTAP CLI. For more information about privilege levels, see Using Data ONTAP commands at different privilege levels.

Using online help at the RLM CLI

You can display all of the available commands by entering the question mark (?) or help, as shown in the following example.

RLM toaster> ?

date

exit

events

help

priv

rlm

system

version

If a command has subcommands, they are displayed if you enter the command name after the help command, as shown in the following example:

RLM toaster> help events

events all

events info

events newest

events oldest

events search

For detailed online command help, you can enter the command followed by the question mark (-?) or the -h option. The basic command help is displayed if the command does not have subcommands. The following example shows the result of entering -h as an option for a command that has subcommands.

RLM toaster> events -h

events all - print all system events

events info - print system event log information

events newest - print newest system events

events oldest - print oldest system events

events search - search for and print system events

What you can do in RLM admin mode

In admin mode, you can use the RLM administrative commands to

Connect to the storage system console (system console)
Control the storage system power (system power)
Display the following information:
- Available commands (help or ?)
- Events that occur on the storage system (events subcommand)
- Storage system console logs (system log)
- Storage system power status (system power status)
- Privilege level (priv show)
- RLM status (rlm status)
- RLM version (version)
- Syntax usage for a specific command (help command)
Dump the storage system core and reset the storage system (system core)
Exit from the RLM CLI (exit)
Reset the storage system with the firmware you specify (primary, backup, or current) (system reset firmware)
Reboot the RLM (rlm reboot)
Set the user mode privilege level (priv set level)
Update RLM firmware (rlm update path)

Connecting to the storage system console

You use the system console command to log in to the storage system. When you are logged in to the storage system console, you use the Data ONTAP CLI to administer the storage system. You can enter commands at the storage system prompt or the CFE boot prompt. Use Ctrl-D to exit from the storage system console and return to the RLM CLI. For information about the procedure, see Using the RLM to remotely access the system console. The following example shows the result of entering the system console command. Notice that the message "Type Ctrl-D to exit." appears and that you must press the Enter key to see the storage system prompt. Once the prompt appears, you can enter Data ONTAP commands. In the following example, the vol status command is entered, followed by Ctrl-D, which returns you to the RLM prompt.

RLM toaster> system console

Type Ctrl-D to exit.

(Press the Enter key to see the storage system prompt.)

toaster>

toaster> vol status

(information about all of the existing volumes is displayed)

toaster> Ctrl-D

RLM toaster>

Controlling storage system power

You use the system power command to turn the power on or off, or you can power-cycle the storage system, which automatically turns system power off and then back on. Turning the power off or power-cycling the storage system may cause an improper shutdown of the storage system (also called a dirty shutdown). The following example shows the result of using the system power cycle command.

RLM toaster> system power cycle

This will cause a dirty shutdown of your appliance. Continue? [y/n]

If you press y, the storage system is turned off. Five seconds later, the storage system is turned back on, and the CFE> firmware prompt appears.

In the meantime, the RLM prompt awaits your next command.

RLM toaster>

Even when the storage system is powered off or power-cycled, the RLM remains 
operational.

Syntax summary for admin mode RLM CLI commands

The following table provides a quick reference of the command syntax for the RLM commands you can use in admin mode. For information on how to change the privilege level to admin mode, see Setting the privilege level.

Command syntax	Description
RLM toaster> events {all \| information \| newest \| oldest \| search string}	Displays storage system events stored by the RLM specified by the subcommand.
`RLM toaster>` exit	Exits from the RLM command line interface.
RLM toaster> help [command]	Displays a list of available commands, or if a command is specified, displays either the subcommands available for that command or its syntax usage.
RLM toaster> priv set {admin \| advanced \| diag}	Sets the privilege level to access the specified mode.
RLM toaster> priv show	Displays privilege level of the user mode.
RLM toaster> rlm reboot	Reboots the RLM. This action takes approximately one minute.
RLM toaster> rlm sensors [-c]	Displays RLM environmental sensor status. The `-c` option, which takes a few seconds to display, shows the current values, rather than cached values.
RLM toaster> rlm status	Displays RLM status. Note The Data ONTAP `sysconfig` command displays both the storage system and RLM status.
RLM toaster> rlm update http://path	Updates the RLM firmware.
RLM toaster> system console Result The following prompt is displayed. toaster> To exit, enter Ctrl-D. Result The following prompt is displayed. RLM toaster>	Logs in to Data ONTAP at the current prompt. Use Ctrl-D to exit.
RLM toaster> system core	Dumps the storage system core and resets the storage system. This command is similar to pressing the Non-maskable Interrupt (NMI) button on a storage system. Note The RLM stays operational as long as input power to the storage system is not interrupted.
RLM toaster> system power {on \| off \| cycle}	Turns the storage system on or off, or performs a power cycle. When system power is turned off or power-cycled, standby power stays on. This may cause an improper shutdown of the storage system. When power-cycling, there is a 5-second pause before power is turned back on. Note The RLM stays operational as long as input power to the storage system is not interrupted.
RLM toaster> system power status	Displays status for each power supply, such as presence, input power, and output power.
RLM toaster> system reset {primary \| backup \| current}	Resets the storage system using the specified firmware image. Note The RLM stays operational as long as input power to the storage system is not interrupted.
RLM toaster> version	Displays the RLM version information, including hardware and firmware information.

What you can display in RLM advanced mode

You can use the RLM advanced commands to display more information than is available in administrative mode:

Debug log file (rlm log debug)
RLM command history (rlm log audit)
RLM environmental sensor status (rlm sensors)
RLM messages file (rlm log messages)
RLM statistics (rlm status -v)

Syntax summary for advanced mode commands

The following table provides a quick reference of the command syntax for the RLM commands you can use in advanced mode. For information on how to change the privilege level to advanced mode, see Setting the privilege level.

Command	Description
`RLM toaster*>` rlm log audit	Displays the RLM command history.
`RLM toaster*>` rlm log debug	Displays the RLM debug file.
`RLM toaster*>` rlm log messages	Dumps the RLM messages file.
`RLM toaster*>` system sensors	Displays a list of environmental sensors, their states, and their current values.