controller ‑list

Returns status and configuration information for one or both Controllers.

SYNOPSIS

controller ‑list 
   [‑details]
   [{ [‑controller controller‑id‑or‑fqn [,controller‑id‑or‑fqn]... ]
      [‑diagnostics]
      [‑master]
      [‑linkAggregation]
    | ‑port [controller[/slot[/port]] [,controller[/slot[/port]]]... ]
    }]

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

DESCRIPTION

Run the controller ‑list command to obtain the fully qualified names of the Controllers.

Run the controller ‑list ‑details command to obtain status and configuration information for the Controllers and their components. Additional options are available to inquire about the network interface ports. The port information can optionally include the link aggregation status.

Note: Administrators with primary administrator, admin1, admin2, monitor, or support roles can run the controller ‑list command and most of the options. However, only administrators with primary administrator, admin1, or support roles are authorized to run the ‑master option.

OPTIONS

‑controller

Specifies the fully qualified name (FQN) or unique identifier (ID) of one or more Controllers. When specifying more than one Controller, provide commas to separate the FQNs or IDs.

‑details

Returns the following information for each of the specified Controllers:

The temperature status, serial number, and revision number of the Controller.
The service type of the Controller.
The port provisioning settings for each HBA, if the ‑port option is included. Includes the link aggregation settings of the ports, if ‑linkAggregation is included.
The status and configurations of the Controller, the power supplies, and the power supply fans.
The fully qualified name of the master Controller, if the ‑controller option is included. In a peer-to-peer configuration, the master Controller assumes the functioning of the failed Controller and operates in a conservative mode.

‑diagnostics

Returns the most recent diagnostics report for the specified Controller.

‑linkAggregation

Returns the link aggregation settings that show individual HBA ports that are linked to present their combined throughput to the network as a single port. Only two ports on a given HBA card can be link aggregated.

‑master

Returns the fully qualified name or ID of the Controller that is designated to be the master Controller. In the Oracle FS System, the master Controller maintains the system configuration information, and communicates with the Pilot.

Only administrators with primary administrator, admin1, or support roles are authorized to run this option.

‑port

Returns information about one or more ports. To specify a port, use the following format: controller/slot/port. Specify each portion of the variable by providing the following values:

For the controller portion of the variable, provide a string that includes the fully qualified name or ID of the Controller.
For the slot portion of the variable, specify the HBA slot number.
For the port portion of the variable, specify the port number. You can optionally provide “Port” as a label before the number.

Separate each element in the string with a forward slash character (/). If you do not specify a port, controller ‑list returns information about all of the ports.

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

Before replacing a failed FRU, Oracle Customer Support requests that you verify that the Controller has failed over to the partner Controller.

Parameters

None

$ fscli controller ‑list ‑details