report ‑generate

Creates a report that can be downloaded for viewing.

SYNOPSIS

report ‑generate 
   ‑type { system | storageUse | volumeUse | performance
         | sanHosts | systemSummary | quotas | autoTier
         }
   [‑filesystem filesystem‑id‑or‑fqn]
   [‑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/.

‑filesystem

Identifies a filesystem in the Oracle FS System.

‑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.
quotas: Returns detailed information about the capacity controls that exist for a filesystem. This option requires that the ‑filesystem option be specified as well.
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.

EXAMPLE

Task

Create a report that can be downloaded for viewing.

Parameters

The type of report to generate: system

$ fscli report ‑generate ‑type system