Flashes the LEDs of the FRU on the specified Controller.
SYNOPSIS
controller ‑beacon
‑controller controller‑id‑or‑fqn
[‑stop]
[‑reverseBeacon]
{ ‑powerSupply powerSupply‑fru‑number
| ‑fan fan‑fru‑number
| ‑mb mb‑fru‑number
| ‑chassis chassis‑fru‑number
| ‑cpu cpu‑fru‑number
[‑memory memory‑fru‑number]
| ‑esm esm‑fru‑number
| ‑pcieRiser pcieRiser‑fru‑number
| ‑nicHba nicHba‑fru‑number
| ‑sasHba sasHba‑fru‑number
}
[{‑sessionKey | ‑u admin‑user ‑oracleFS oracle‑fs‑system}]
[{‑outputformat | ‑o} { text | xml }]
[{‑timeout timeout‑in‑seconds | ‑verify | ‑usage | ‑example | ‑help}]
DESCRIPTION
Run the controller ‑beacon command to identify a particular FRU on the Controller. For example, to beacon the fan on Controller 1, you can use controller ‑beacon ‑controller /CONTROLLER-01 ‑fan 1.
You can beacon any one of the various types of FRUs, such as a chassis, a CPU, an energy storage module (ESM), a fan, a motherboard, a network interface HBA card, a PCIe riser, a power supply, or a SAS HBA card.
Note: Administrators with primary administrator, admin1, admin2, monitor, or support roles are authorized to run the controller
‑beacon command.
OPTIONS
- ‑chassis
Specifies 0 as the FRU number for the chassis of the Controller to beacon. The value for the chassis is 0.
- ‑controller
Specifies the fully qualified name (FQN) or the unique identifier (ID) of a Controller.
- ‑cpu
Specifies the CPU to beacon. The LEDs flash on the Controller within which the CPU resides. When specifying memory to beacon, provide a value to identify the CPU in which the specified memory card slot resides. Values are 0 or 1.
- ‑esm
Specifies the energy storage module (ESM) to beacon. Flashes the LEDs for the ESM card and the LEDs for the Controller in which the specified FRU resides. Values are 0 and 1.
- ‑fan
Specifies the fan to beacon. Flashes the LEDs for the Controller within which the fan resides. Values are 0 through 4.
- ‑mb
Specifies the motherboard to beacon. The flashing LEDs identify the Controller in which the motherboard resides. There is only one motherboard in the Controller. The value is 0.
- ‑memory
Specifies the DIMM or NVDIMM card slot. Beacons the
Controller chassis in which the memory card resides. Values are 0 through 7.
Note: In addition to the slot number, you must specify the CPU in which the memory card resides by specifying a value for the ‑cpu option. The DIMM cards reside in slots 0 through 7 on CPU 0, and in slots 2 through 7 on CPU 1. The NVDIMM cards reside in slots 0 and 1 on CPU 1.
- ‑nicHba
Specifies the network interface HBA card to beacon. Flashes the LEDs for the Controller in which the card resides. Values are 0 through 5.
- ‑pcieRiser
Specifies the PCIe riser to beacon. Flashes the LEDs for the Controller within which the PCIe riser resides. Values are 0, 1, or 2.
- ‑powerSupply
Specifies the power supply to beacon. Flashes the LEDs for the Controller in which the power supply resides. Values are 0 or 1.
- ‑reverseBeacon
Flashes the
LEDs on the
Controller. Also flashes the component
LEDs except for the LEDs of the specified FRU. Use reverse beaconing
to identify the failed FRU in a pair of FRUs for the following FRUs:
- ‑sasHba
Specifies the SAS HBA card to beacon. Flashes the LEDs for the Controller in which the SAS HBA card resides. Values are 0 through 5.
- ‑stop
Stops the specialized
LED beaconing request and returns all LED indicators to their normal
function.
GLOBAL OPTIONS FOR SUBCOMMANDS
The following global options can be used for
fscli command-subcommand pairs that do not include other command-line options:
- ‑help
Returns the context-sensitive help for the specified subcommand.
- ‑usage
Returns the subcommand syntax for the given command, including all of the options that are available for the command-subcommand pair.
GLOBAL OPTIONS FOR COMMANDS
The following global options can be used for fully formed fscli commands:
- ‑example
Returns sample output from the specified command.
Note: To see the output in XML format, include the ‑o xml option.
- ‑timeout timeout-in-seconds
Specifies the length of time (
timeout-in-seconds) that the command line interface waits before another command is allowed to run. If the command takes longer to run than the specified time limit, the system continues processing the command, but the command prompt is made available so that you can issue another command. If the
-timeout option is omitted, the command line interface blocks until the one of the following conditions is met:
Note: Be sure to check the state of the system after initiating a long running command with the ‑timeout option. Many fscli commands run a series of underlying commands in sequence. When the timeout value is reached before all of the underlying commands have completed, the fscli command does not complete with the outstanding tasks reporting a failure status.
- ‑outputformat | ‑o { text | xml }
Controls the type of the output the system returns from a command. If the
‑outputformat option is not included, the format of the output defaults to simple text. If
xml is provided, the output is a collection of XML elements.
Note: For XML output, if internal errors occur during command execution, each error is included in a separate <ErrorList> tag.
- ‑verify
Inspects the validity of the command syntax, not the semantics. Used to test the structure of a command without running the command. Does not determine whether errors would be produced if you issue a structurally correct command with the input provided.
- ‑sessionkey
Directs the CLI to prompt you to supply a session key when you issue the command. The CLI displays Sessionkey: as the prompt. To obtain a session key, log in with the ‑returnKey option specified. After the session is established, the session key is displayed in STDOUT. If you request a session key, the ‑sessionkey option is required syntax for all commands that are issued in a given session. In environments with more than one Oracle FS System, the session key is used to determine to which Oracle FS System to direct the command for validation. Session keys are also used to establish two or more CLI sessions when using a shared administrator account.
- ‑u admin-user ‑oracleFS oracle‑fs-system
Routes the command to a particular
Oracle FS System for execution. This option passes the name of the administrator account to use when opening the session on the specified system. Identify a specific
Oracle FS System by its IP address or by the name that is recorded in the domain name system (DNS). When logging in to the
Oracle FS System using the
‑u option and the
‑oracleFS option, the
fscli application prompts you for a password on the command line interface for access. The
Oracle FS System and the account login information are used to authenticate the current session. Establishing a login session by specifying an
Oracle FS System and an account does not change the credentials that are associated with the active sessions that are running on other clients.
Caution
Oracle recommends that you not use the Cygwin command line interface to run the fscli application on Windows platforms. If you are running the Cygwin interface and include the ‑u option as a part of the ‑list subcommand, the password for the specified account is included in the results. Exposing the password can cause a breach in security.
EXAMPLE
- Task
Identify a failed power supply that was prepared for replacement.
- Parameters
-
$ fscli controller ‑beacon ‑controller /CONTROLLER-01 ‑reverseBeacon ‑powerSupply 0