report ‑generate

Creates a report that can be downloaded for viewing.

SYNOPSIS

report ‑generate 
   ‑type { system | storageUse | volumeUse | performance
         | sanHosts | systemSummary | autoTier
         }
   [‑storageDomain storage‑domain‑id‑or‑fqn]
   [‑language locale‑language]
   [‑country locale‑country]
   [‑variant locale‑variant]

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

DESCRIPTION

You can specify that the report contain configuration details, storage and performance information, or statistical information. The information generated in the report is based on the report type you select.

Note: Only administrators with primary administrator or admin1 roles are authorized to run the report ‑generate command.

OPTIONS

‑country

Specifies the country locale (two uppercase letters that conform to ISO-3166) to use for generating the report. Use the country locale ISO code to specify the country locale when creating the report. For example, to request a report in Canadian French, you could use the variant fr_CA (language option combined with country option). You can find a copy of ISO-3166 at https://www.iso.org/obp/ui/.

‑storageDomain

Specifies the Storage Domain you want to display data about to determine the auto‑tier effectiveness for that Storage Domain.

‑language

Specifies the language. The format is two lowercase letters that conform to ISO‑639. Use the language ISO code to specify the language when creating the report. For example, to request a report in Canadian French, you could use the variant fr_CA (language option combined with country option). You can find a copy of ISO-639 at http://userpage.chemie.fu-berlin.de/diverse/doc/ISO_639.html.

‑type

Specifies the type of report to generate. Valid types:

autoTier: Returns information about the effectiveness of auto‑tiering for a Storage Domain. This option requires that the ‑storageDomain option be specified as well.
performance: Returns performance information about the Oracle FS System LUNs. This information includes, for example, the I/⁠O operations per second and the I/⁠O MB per second for each LUN.
sanHosts: Returns detailed configuration information about the SAN hosts and about the components that are configured on those hosts.
system: Returns detailed information on the configuration and the current status of the Oracle FS System and of all of its components.
systemSummary: Returns a configuration summary of the Pilots, the Controllers, and the Drive Enclosures, including the status of each of those components.
volumeUse: Returns capacity information for each logical volume in the Oracle FS System.

‑variant

Specifies the locale variant to use for generating the report. Multiple variants can be connected with an underscore. For example, to request a report in Canadian French, use the variant fr_CA.

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

Create a report that can be downloaded for viewing.

Parameters

The type of report to generate: system

$ fscli report ‑generate ‑type system