controller ‑replaceFru

Prepares the Controller for maintenance.

SYNOPSIS

controller ‑replaceFru 
   ‑controller controller‑id‑or‑fqn
   { ‑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
   }
   [‑abort]

   [{‑sessionKey | ‑u admin‑user ‑oracleFS oracle‑fs‑system}]
   [{‑outputformat | ‑o} { text | xml }]
   [{‑timeout timeout‑in‑seconds | ‑verify | ‑usage | ‑example | ‑help}]

DESCRIPTION

Oracle Customer Support might request that you issue a controller ‑replaceFru command to prepare the Controller for the following maintenance operations:

Replacing FRUs
Upgrading Controllers
Adding or removing network interface HBA cards
Adding or removing SAS HBA cards
Adding or removing memory (NVDIMM or DIMM)

Note: Immediately after you run the controller ‑replaceFru command, the FSCLI returns with a successful status if the specified Controller is in an AVAILABLE management state. Receiving the successful status does not mean that the Controller is fully prepared for a FRU replacement procedure. Instead, the Oracle FS System must complete the following processes before it is safe to power off the Controller:

The Controller fails over to the partner Controller.
The partner Controller assumes the responsibilities of the failed over Controller.
The system places the partner Controller into a conservative operational mode.
The system marks the prepared Controller as FAILED_OVER.

Note: When preparing the Controller for the replacement of a failed component, specify a FRU number. To obtain the FRU number, use one of the following methods:

The system_alert ‑list ‑details command provides information to identify the component. For some of the components, the FRU number is displayed in the slot field.
The controller ‑list ‑details command marks a failed FRU with a WARNING or CRITICAL status. The Location field provides the FRU number.

Note: The Oracle FS System requires that memory or HBA cards are added to both Controllers in a symmetrical configuration. When adding memory or HBA cards, Oracle Customer Support might request that you run the controller ‑list ‑details command to identify the empty slots. After Oracle Customer Support determines the most appropriate slot to specify as the FRU number, run the controller ‑replaceFru command to prepare one of the Controllers. The Controller fails over to the partner Controller. To prepare the partner Controller, Oracle Customer Support might request that you run a system ‑shutdown command. Before shutting down the Oracle FS System, be sure to stop all I/O traffic to the partner Controller.

Note: Only administrators with primary administrator, admin1, or support roles are authorized to run the controller ‑replaceFru command.

OPTIONS

‑abort

Cancels the processes that prepare the specified FRU for replacement.

‑chassis

Specifies the FRU number for the chassis in the Controller to prepare for replacement. The value for the chassis is 0. The system performs the following operations:

The system marks the chassis as missing.
The system fails the Controller over to the partnerController.
The prepared Controller is powered off and marked as missing.
The system places the partner Controller into a conservative mode.

‑controller

Specifies the fully qualified name (FQN) or unique identifier (ID) of a Controller to prepare for upgrade or maintenance.

‑cpu

If the ‑memory option is not provided, specifies the CPU to prepare for replacement. The system performs the following operations:

The Controller with the faulty CPU fails over to the partner Controller.
The Controller is powered off and is marked as missing.
The system places the partner Controller into a conservative mode.

If the ‑memory option is provided, specifies the CPU on which the faulted DIMM or NVDIMM memory card resides.

Values are 0 or 1.

‑esm

Specifies the energy storage module in the Controller to prepare for replacement. Values are 0 and 1. The system performs the following operations:

The Controller with the faulty energy storage module fails over to the partner Controller.
The Controller is powered off and marked as missing.
The system places the failed to Controller into a conservative mode.

‑fan

Specifies the fan to prepare for replacement. The system performs the following operations:

The system powers down the fan and marks it as missing.
The Controller with the faulty fan fails over to the partner Controller.
The Controller is powered off and is marked as missing.
The system places the partner Controller into a conservative mode.

The values for the fans are 0 through 4.

‑mb

Specifies the motherboard to prepare for replacement. The system performs the following operations:

The system prepares the motherboard for replacement and marks it as missing.
The Controller with the faulty motherboard fails over to the partner Controller.
The Controller is powered off and the Controller is marked as missing.
The system places the partner Controller into a conservative mode.

There is only one motherboard in the Controller. The value is 0.

‑memory

Specifies the memory slot on the CPU in which the faulted DIMM or NVDIMM memory card resides. The system performs the following operations:

The system prepares the DIMM or NVDIMM card for replacement and marks it as missing.
The Controller with the faulty memory card fails over to the partner Controller.
The Controller is powered off and the Controller is marked as missing.
The Oracle FS System places the partner Controller into a conservative mode.

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 prepare for replacement. The system performs the following operations:

The system disables the card and marks it as missing.
The Controller with the faulty HBA card fails over to the partner Controller.
The Controller is powered off and is marked as missing.
The system places the partner Controller into a conservative mode.

The values for the network interface HBA cards are 0 through 5.

‑pcieRiser

Specifies the PCIe riser to prepare for replacement. The system performs the following operations:

The system disables the PCIe riser and marks it as missing.
The HBA cards that are inserted into the PCIe riser are marked as missing.
The Controller with the faulty PCIe riser fails over to the partner Controller.
The Controller is powered off and is marked as missing.
The system places the partner Controller into a conservative mode.

The values for the PCIe riser are 0, 1, or 2.

‑powerSupply

Specifies the power supply to prepare for replacement. The system performs the following operations:

The system disables the power supply and marks it as missing.
The Controller with the faulty power supply fails over to the partner Controller.
The Controller is powered off and is marked as missing.
The system places the partner Controller into a conservative mode.

Values of the power supplies are 0 or 1.

‑sasHba

Specifies the SAS HBA card to prepare for replacement. The system performs the following operations:

The system disables the SAS HBA card and marks it as missing.
The Controller with the faulty HBA card fails over to the partner Controller.
The Controller is powered off and is marked as missing.
The system places the partner Controller into a conservative mode.

Values of the SAS HBA cards are 0 through 5.

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:

The command completes successfully.
The command returns with an error.
The session times out.

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

To begin the process of replacing a faulty power supply, Oracle Customer Support instructs you to prepare the Controller for a FRU replacement.

Parameters

The name of the Controller preceded by a forward slash: /⁠CONTROLLER-00
The FRU number of the power supply: 0

$ fscli controller ‑replaceFru ‑controller /⁠CONTROLLER-00 ‑powerSupply 0