statistics ‑list

Displays performance data collected in the last two minutes for objects such as LUNs unless the ‑realTime option is specified.

SYNOPSIS

statistics ‑list 
   [‑details]
   { ‑realTime [collection‑duration‑in‑seconds]
     [‑poll polling‑interval‑in‑seconds
       [‑duration duration‑in‑seconds]
     ]
     [‑cpuCores       controller‑id‑or‑fqn]
     [‑driveGroup    drive‑group‑id‑or‑fqn]
     [‑ethernetPort    controller‑port]
     [‑fcPort          controller‑port]
     [‑lun             lun‑id‑or‑fqn]
   |
     [‑realTimeSubscriptions [subscription‑id‑or‑fqn
                        [, subscription‑id‑or‑fqn]...] ]
|
  [‑cpuCores [controller‑id‑or‑fqn [, controller‑id‑or‑fqn]...] ]
  [‑driveGroup [drive‑group‑id‑or‑fqn [, drive‑group‑id‑or‑fqn]...] ]
  [‑ethernetPort [controller‑port [,controller‑port]...] ]
  [‑fcPort [controller‑port [,controller‑port]...] ]
  [‑lun [lun‑or‑clone‑id‑or‑fqn [,lun‑or‑clone‑id‑or‑fqn]...] ]
}

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

DESCRIPTION

Displays performance statistics from an Oracle FS System when an option is added such as ‑lun. If you do not specify the ‑realTime option, then data for the last two minutes is displayed. For example, if you enter statistics ‑list ‑lun, the last two minutes of data collected is displayed for all LUNs. If you specify the ‑realTime option with a specific LUN, then a subscription is created and data is collected and returned for the time period that you specify.

Note: Administrators with primary administrator, admin1, admin2, monitor, or support roles are authorized to run the statistics ‑list command.

OPTIONS

‑cpuCores

Returns statistics for the CPU of the specified Controller.

‑details

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

‑driveGroup

Returns performance statistics for the specified drive group.

‑duration

Specifies the total time period for performance statistics collection as defined by the ‑realTime option at intervals determined by the ‑poll option. If you do not include this option, performance data is collected until you enter Ctrl-C at the command prompt.

‑ethernetPort

Returns performance statistics for the specified Ethernet port on a Controller.

‑fcPort

Returns performance statistics for the specified Fibre Channel port on a Controller.

‑lun

Returns performance statistics for the specified LUN.

‑poll

Specifies the time interval in seconds between performance statistics collection as defined by the ‑realTime option. The performance data is collected until reaching the limit specified by ‑duration, or until you enter Ctrl-C at the command prompt.

‑realTime

Creates real-time subscriptions for one or more statistic types that you identify. You can specify a time period in seconds for which performance statistics are collected and then returned.

If you do not specify a time period, then statistics are collected for 120 seconds and returned.
If you specify a time period that is greater than 120 seconds, then statistics are returned in multiple sets that each cover 120 seconds.

Used with ‑poll and ‑duration options to determine how often and how long the statistical data is generated and displayed.

‑realTimeSubscriptions

Displays any real-time statistics subscriptions.

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

Display real time CPU statistics for the specified Controller on the Oracle FS System.

Note: To subscribe to real time statistics and then list or delete them, the ‑realTime option must be used.

Parameters

The FQN of the Controller: /⁠⁠CONTROLLER‑01
The FQN of the LUN: /⁠FCLUN01

$ fscli statistics -list -realtime -cpuCores /⁠CONTROLLER-01
$ fscli statistics -list -realtime -lun /⁠FCLUN0
$ fscli statistics -list -realTimeSubscriptions