HP StoreOnce Backup System CLI Reference Guide

hardware beacon
NOTE: This command applies to single-node products only.
Description of Command Function
Turns on or off the beacon for a hardware component. (The hardware component must support
the beacon feature.)
Command Syntax
hardware beacon { dev-id [ALL] | ALL } { on | off }
Command Authority
Operator and Administrator
Command Object Requirements
dev-id – This required object defines the hardware component whose beacon is to be turned on
or off. The value is a string of the device identifier as listed in the hardware show status
command.
• dev-id – This object defines the hardware component whose beacon is to be turned on or off.
The value is a string of the device identifier as listed in the hardware show status
command. The command requires this object or the global default “ALL.”
• ALL – This global parameter represents all the components in the StoreOnce device which
support the beacon function. (Typically, this is used with the “off” parameter to turn off the
beacons for all the components and place the StoreOnce system into a known state. Then any
beacons turned on with this command will be the only components with illuminated beacons.)
The command requires this object or the device ID (dev-id).
Command Parameter Requirements
• on/off – This required parameter defines the state of the beacon on the hardware component;
on illuminates the beacon, and off places the beacon in a non-illuminated state. Provide
either dev-id or all as the option, and then select the on/off parameter
• all – This optional parameter represents all the components in the backup device which support
the beacon feature.
NOTE: If the all parameter is specified, beacon turns on or off on the specified component
(if it has a beacon) in addition to all hardware components supporting the beacon feature
that are hierarchically beneath it.
Requirements for Command Execution
• The command entry must conform to command syntax.
• All object values must be valid. See object requirements for details.
• All parameter values must be valid. See parameter requirements for details.
Successful Command Output
After command execution, the beacon on the selected hardware component is turned on or off,
and the following is displayed:
Command Successful
Command Operation during Abnormal Conditions
If any of the command execution requirements fail, command execution terminates, the beacon
status is unchanged, and one of these error messages is displayed:
hardware beacon 61