topology ‑list

Returns the configuration information and statistics for the Backend SAS Interconnect and returns the results of any diagnostic tests that the system performed.

SYNOPSIS

topology ‑list 
   [‑details]
   [{ ‑violations
    | [ ‑statistics ]
      [ ‑enclosure ]
      [ ‑controllerPort controller‑id‑or‑fqn
        ‑slot hba‑slot‑number
        ‑port port‑number
      ]
    }]

   [{‑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 run the topology ‑list command to provide the following information:

The Controller‑to‑Controller performance metrics and usage statistics
The Controller‑to‑Drive Enclosures performance metrics and usage statistics
The indications of any wrongly connected cables
The indications of any loosely connected cables
The indications of any faulty SAS connectors on the Drive Enclosures
The status of the Controller SAS HBA cards and ports
The contents of the database that manages the Backend SAS Interconnect

If no options are specified, information is displayed only for Drive Enclosure connectivity and for the Controller ports.

Note: Administrators with primary administrator, admin1, admin2, monitor, or support roles are authorized to run the topology -list command, except for the ‑violations option. Only administrators with primary administrator, admin1, admin2, or support roles are authorized to use the -violations option.

OPTIONS

‑controllerPort

Limits the display to the current status of the specified Controller port. The HBA slot number and the port number are specified by the ‑slot option and by the ‑port option respectively.

‑details

Provides no additional information. This option is included for consistency across all subcommands.

If the ‑details option is specified with no other options, the information about the following objects is displayed:

Controller ports
Controller statistics
Drive Enclosure connectivity
Drive Enclosure statistics

In this case, the topology violations are not displayed.

‑enclosure

Returns information about the SAS ports on the Drive Enclosures that are connected to the SAS HBAs on the Controllers.

‑port

Returns information about the specified Controller port. Values are 0, 1, 2, or 3.

‑slot

Returns information about the specified SAS HBA card. Use this option in combination with the ‑controllerPort and ‑port options.

‑statistics

Returns the performance and usage statistics for the physical connections between the Controllers and the Drive Enclosures.

‑violations

Returns a report of any SAS connections that are incorrectly cabled.

This option cannot be used with other options. Also, this option cannot be used by administrators using the monitor role.

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 assist with a topology evaluation, Oracle Customer Support instructs you to obtain health and status information for the components that comprise the Backend SAS Interconnect.

Parameters

None

$ fscli topology ‑list