storage_allocation ‑list

Displays information about a storage object or the system metadata.

SYNOPSIS

storage_allocation ‑list 
   [‑details]
   [‑saveConfigFile saved‑file‑name]
   [{ ‑lun
      {‑name lun‑or‑clone‑name | ‑id lun‑or‑clone‑id}
    | ‑storageDomain
      [{‑name storage‑domain‑name | ‑id storage‑domain‑id}]
    | ‑enclosure
      [{‑name enclosure‑name | ‑wwn enclosure‑wwn }]
    | ‑allVolumes
    }]
   [{‑csv [csv‑file‑name]
    | ‑xml [xml‑file‑name]
    }]

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

DESCRIPTION

The storage_allocation ‑list command summarizes the QoS properties of a logical volume, a Storage Domain, or a Drive Enclosure. Alternatively, this command returns the information that comprises the system configuration database. For both usages, you can store the query results in a local file.

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

OPTIONS

‑allVolumes

Produces a report containing configuration information for all LUNs on the Oracle FS System.

‑csv

Directs the output into the specified file as comma-separated values. If a file is not specified, the output is directed to stdout.

The ‑csv option is valid only for ‑lun or ‑allVolumes output. This option is not valid when selecting output for filesystems, Storage Domains, or Drive Enclosures.

‑details

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

‑enclosure

Specifies an enclosure in the Oracle FS System.

Note: You specify an enclosure using either the ‑name or the ‑wwn option. You do not use the fully qualified name (FQN) or unique identifier (ID).

‑id

Specifies the unique identifier (ID) of the storage object (a LUN or a Storage Domain) for which information is displayed.

lun: The QoS properties of the specified volume are returned.
storageDomain: If a particular Storage Domain is not specified, returns a summary of all Storage Domains. If a particular Storage Domain is specified, returns a summary of the QoS properties of the specified Storage Domain.

‑lun

Requests that a summary of the QoS properties be displayed for the specified LUN or Clone LUN.

‑name

Identifies the name of the storage object (a LUN, a Storage Domain, or a Drive Enclosure) for which information is displayed. Use double quotation marks around names containing dashes or spaces.

lun: The QoS properties of the specified volume are returned. If a particular LUN is not specified, returns a summary of all LUNs.
storageDomain: If a particular Storage Domain is not specified, returns a summary of all Storage Domains. If a particular Storage Domain is specified, returns a summary of the QoS properties of the specified Storage Domain.
enclosure: If a particular Drive Enclosure is not specified, returns a list of all of the logical volumes and all of the clone repositories for all Drive Enclosures. If a particular Drive Enclosure is specified, returns the logical volumes and the clone repositories for the specified Drive Enclosure.

‑saveConfigFile

Preserves the system configuration database that was downloaded from the Oracle FS System. The information is saved as a file at the location that is specified by saved-file-name. If the ‑saveConfigFile option is omitted, the file is deleted when the command completes. You can use the SCV program to view the configuration file.

‑storageDomain

Specifies the fully qualified name (FQN) or the unique identifier (ID) of the Storage Domain with which one or more drive groups are associated.

‑wwn

Specifies the World Wide Name (WWN) of the Drive Enclosure for which information is displayed. If a particular Drive Enclosure is not specified, returns a list of all of the logical volumes and all of the clone repositories for all Drive Enclosures. If a particular Drive Enclosure is specified, returns the logical volumes and the clone repositories for the specified Drive Enclosure.

‑xml

Directs the output into the specified file as an XML document. If a file is not specified, the output is directed to stdout.

If neither ‑csv or ‑xml is specified, the default output format is XML.

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 }

Has no effect on the output format. The ‑outputformat option is included for consistency across all subcommands.

For the storage_allocation ‑list command, the output format is always XML.

‑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

Save information about a storage object or the system metadata in an XML format.

Parameters

None

$ fscli storage_allocation ‑list -xml xml-file-name