lun ‑maximumCapacity

Returns the amount of storage that can be allocated to a LUN.

SYNOPSIS

lun ‑maximumCapacity 
   ‑storageDomain storage‑domain‑id‑or‑fqn
   ‑priority {premium | high | medium | low | archive}
   ‑redundancy {1 | 2}
   [‑raidLevel {raid5 | raid6 | raid10 | default}]
   [‑stripeWidth stripe‑width]
   [‑enableEnclosureWideStriping]
   ‑storageClass {capDisk | perfDisk | perfSsd | capSsd}

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

DESCRIPTION

You can run the lun ‑maximumCapacity command to display the actual storage capacity that could be allocated to a LUN. The Oracle FS System returns the maximum capacity (in bytes) that is available for creating a LUN, a copy of a LUN, or increasing the size of a LUN. You can examine the impact of different QoS properties on the storage capacity by running the lun ‑maximumCapacity command with different values.

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

OPTIONS

‑enableEnclosureWideStriping

Enables data striping for the LUN across the entire Drive Enclosure.

‑priority

Assigns a priority level that determines the system response to incoming I/O requests against the LUN. In general, the higher the priority level, the faster the system can respond to an access request. Valid priority levels:

premium. Indicates the highest priority for responding to requests in the processing queue. For Auto-Tier LUNs, busy LUN extents receive the highest priority when the system migrates the data to the higher-performing storage tiers.
high. Indicates the next highest priority for responding to requests in the processing queue. For Auto-Tier LUNs, busy LUN extents receive the next highest priority when the system migrates the data to the higher-performing storage tiers.
medium. Indicates an intermediate priority for responding to requests in the processing queue. For Auto-Tier LUNs, busy LUN extents receive an intermediate priority when the system migrates the data to the higher-performing storage tiers.
low. Indicates the next to lowest priority for responding to requests in the processing queue. For Auto-Tier LUNs, busy LUN extents receive the next to lowest priority when the system migrates the data to the higher-performing storage tiers.
archive. Indicates the lowest priority for responding to requests in the processing queue. For Auto-Tier LUNs, busy LUN extents receive the lowest priority when the system migrates the data to the higher-performing storage tiers.

Note: You can include the ‑priority option or the ‑profile option. Do not include both options.

‑raidLevel

Specifies the level of RAID data protection to use for the logical volume. Valid values:

raid5: Indicates that, in addition to the actual data, one set of parity bits exists for the logical volume. This parity level protects against the loss of one drive.
raid6: Indicates that, in addition to the actual data, two sets of parity bits exist for the logical volume. This parity level protects against the loss of one or two drives with a slight cost to write performance.
raid10: Indicates that no parity bits exist for the volume. Instead, the system writes the data in two different locations. This RAID level protects against the loss of at least one drive and possibly more drives with an improvement of the performance of random write operations.
default: Indicates that the level of RAID protection is determined by the Storage Class. For large form factor (capacity) hard disk drives, RAID 6 is the default level of protection. For the other Storage Classes, RAID 5 is the default level of protection.

‑redundancy

Identifies the number of copies of the parity bits that the Oracle FS System creates for the volume

Valid redundancy levels:

1: Stores the original user data plus one set of parity bits to help in the recovery of lost data. Access to the data is preserved even after the failure of one drive. 1 parity is implemented using RAID 5 technology and is the default redundancy level for the Storage Classes that specify the performance-type media.
2: Stores the original user data plus two sets of parity bits to help in the recovery of lost data. Access to the data is preserved even after the simultaneous failure of two drives. 2 parity is implemented using RAID 6 technology and is the default redundancy level for the Storage Classes that specify the capacity-type media.

Note: Double parity is the default for large form factor (capacity) hard disk drives. Single parity is the default for the other Storage Classes.

‑storageClass

Indicates the type of storage media to be used for the LUN. If you do not use the ‑profile option, the ‑storageClass option is required if the Oracle FS System supports two or more Storage Classes.

Valid Storage Classes:

capDisk. Specifies that the data is stored on high-capacity, rotating hard disk drives (HDDs). This Storage Class optimizes capacity at some sacrifice of speed. For the FS1, this storage class provides the lowest cost for each GB of capacity.
perfDisk. Specifies that the data is stored on high-speed HDDs. This Storage Class sacrifices some capacity to reduce the access time and the latency of the read operations and of the write operations.
perfSsd. Specifies that the data is stored on SSDs that are optimized for the performance of balanced read and write operations.
capSsd. Specifies that the data is stored on solid state drives (SSDs) that are optimized for the performance of read operations and for capacity. The write performance for this Storage Class is sacrificed somewhat to achieve the optimizations for read performance and for capacity.

Do not use the ‑storageClass option if you use the ‑profile option to match the QoS settings of the LUN.

‑storageDomain

Specifies the FQN or GUID of the Storage Domain that contains the LUN. If you do not include this option, and there is only one Storage Domain on the Oracle FS System, the system uses the default Storage Domain in which to create the LUN. If you do not include this option, and there are multiple Storage Domains available, the system prompts you to specify a Storage Domain.

‑stripeWidth

Specifies the number of drive groups across which to stripe the LUN. Values are 1 to 64. If you do not specify a size, the system uses the maximum possible stripe width.

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 the maximum capacity that could be allocated to a LUN.

Parameters

The Storage Domain: /⁠sd1
The priority level: medium
The level of redundancy: 1
The Storage Class: capDisk

$ fscli lun ‑maximumCapacity ‑storageDomain /⁠sd1 ‑priority medium ‑redundancy 1 ‑storageClass capDisk