lun modify

Changes the properties of an existing LUN.

SYNOPSIS

lun ‑modify 
   ‑lun lun‑id‑or‑fqn
   [‑name new‑lun‑name]
   [‑capacity capacity [‑exactCapacity]]
   [‑allocatedCapacity allocated‑logical‑capacity]
   [{ ‑profile performance‑profile‑id‑or‑fqn
    | [‑priority {premium | high | medium | low | archive}]
      [‑storageClass {capDisk | perfDisk | perfSsd | capSsd}]
      { ‑redundancy {1 | 2}
        ‑accessBias {sequential | random | mixed}
        ‑ioBias {read | write | mixed}
      | ‑raidLevel {raid5 | raid10 | raid6 | default}
        ‑readAhead {default | normal | aggressive | conservative}
      }
    }]
   [{ ‑singleTier
    | ‑autoTier
         [‑metaDataStorageClass {capDisk | perfDisk | perfSsd | capSsd}]
      [‑preferredStorageClass {capDisk | perfDisk | perfSsd | capSsd}
                     [, {capDisk | perfDisk | perfSsd | capSsd} ]... ]
      [‑preferredRepositoryStorageClass {capDisk | perfDisk | perfSsd | capSsd}
                     [, {capDisk | perfDisk | perfSsd | capSsd} ]... ]
      [{‑enableTierReallocation | ‑disableTierReallocation}]
    }]
   [‑repositoryPercentage capacity‑percentage]
   [{ ‑matchTierQos
    |   [‑noMatchTierQos]
      [‑repositoryPriority {premium | high | medium | low | archive}]
   [‑repositoryStorageClass {capDisk | perfDisk | perfSsd | capSsd}]
   { ‑repositoryRedundancy {1 | 2}
     ‑repositoryAccessBias {sequential | random | mixed}
     ‑repositoryIoBias {read | write | mixed}
   | [‑repositoryRaidLevel {raid5 | raid10 | raid6 | default}]
   }
 }]
   [‑volumeGroup volume‑group‑id‑or‑fqn]
   [‑controller controller‑id‑or‑fqn]
   [{‑fibreChannelAccess | ‑noFibreChannelAccess}]
   [‑maskedControllerPorts /controller[/slot[/port]]
                           [, /controller[/slot[/port]]]... ]
   [‑unMaskedControllerPorts /controller[/slot[/port]]
                           [, /controller[/slot[/port]]]... ]
   [{ ‑unmapped
    | ‑globalMapping lun‑number
    }]
   [‑storageDomain storage‑domain‑id‑or‑fqn]
   [{‑active | ‑inactive}]
   [‑copyPriority {auto | low | high}]
   [{‑conservativeMode | ‑noConservativeMode}]
   [‑clearPinnedData]
   [{‑disableRefTagChecking | ‑enableRefTagChecking}]
   [‑bootLun | ‑noBootLun]

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

DESCRIPTION

To change the QoS attributes for a LUN, such as increasing the capacity that is allocated to the LUN or allocating space for clones of the LUN, use the lun ‑modify command. You can also modify the mapping of a LUN and change the Controller to which the LUN is assigned.

Before using the lun ‑modify command, you can run the lun ‑maximumCapacity command to test different settings for the RAID level, the priority level, and the Storage Class to determine the effect of these properties on the modified LUN.

When specifying any of the following options, use all the options, or none of the options:
  • -IOBias

  • -AccessBias

  • -Redundancy

Likewise, when specifying any of the following options, use all the options, or none of the options:
  • -repositoryIOBias

  • -repositoryAccessBias

  • -repositoryRedundancy

Note: Only administrators with primary administrator, admin1, or admin2 roles are authorized to run the lun ‑modify command.

OPTIONS

accessBias
Identifies the expected access pattern for the logical volume. Valid biases:
  • sequential. Indicates that the read requests and the write requests operate on the data mostly by accessing the records one after the other in a physical order.

  • random. Indicates that the read requests and the write requests operate on the data mostly by accessing the records in an arbitrary order.

  • mixed. Indicates that the read requests and the write requests operate on the data sometimes in sequential order and sometimes in random order. Accessing in a mixed pattern is the default.

Note: Do not use the ‑accessBias option if you use the ‑profile option to apply a QoS Storage Profile to the volume.
Note: During a modify operation of a LUN, if you need to change the value of one of the following options, you must specify the values of all three options: ‑accessBias, ‑ioBias, and ‑redundancy. Specify all three of these options or none.
active

Enables the LUN to be accessible and available for use immediately after the LUN is created. To ensure accurate mapping relationships, use the ‑globalMapping option, the ‑hostmap option, or the ‑hostGroupMap option with the ‑active option.

allocatedCapacity

Specifies the amount of space, in gigabytes, that the Oracle FS System sets aside for a LUN. This number cannot be less than the currently allocated size of the LUN, and cannot exceed the addressable logical capacity for the LUN as defined by the ‑capacity option.

autoTier

Enables the auto-tiering capability, also called QoS Plus, as needed. An auto-tiered LUN monitors the data activity and automatically adjusts the QoS properties. Based on historical usage information, the system moves the data block to a Storage Class within the Storage Domain that can optimally store the data and best use the available storage types and capacities.

bootLun

Identifies that the LUN can be used as a boot drive in the SAN.

capacity

Specifies the storage space in gigabytes for the volume. The amount of space cannot be less than the current maximum capacity of the LUN. This space is also referred to as addressable capacity. Repository space for the Clone LUNs is also included.

clearPinnedData
Clears any pinned data on the specified volume.
Important! Contact Oracle Customer Support to resolve any issues with the Backend SAS Interconnect, a storage condition, or both, which might be causing the pinned data. Clearing pinned data guarantees that host data is deleted permanently.
conservativeMode

If a Controller node fails, permits the Oracle FS System to enter conservative mode for the specified LUN. In conservative mode, data is written to the storage array before the write operation is reported as complete to the SAN host. Permitting conservative mode is the default.

controller

Specifies the fully qualified name (FQN) or the unique identifier (ID) of a Controller to which the LUN is assigned. By default, the Oracle FS System chooses the Controller. If included, the FQN format consists of /controller-name. For example, /CONTROLLER-01 specifies Controller01.

copyPriority

Identifies the setting to use when copying or migrating data from one location to another.

To control the impact on system performance, you can specify one of the following priority levels:
  • auto. Balances data movement rate and system performance. If you do not use the ‑copyPriority option, the default priority is auto.

  • low. Completes copy operations and data migration without degrading overall system performance. Completion rate might be slower.

  • high. Completes copy operations and data migration as quickly as possible. System performance might be degraded.

disableRefTagChecking

Instructs the HBA to bypass the check of whether a host has written to a specific area of the LUN before the host reads from that same area. If this option is omitted, read-before-write error events can be generated.

disableTierReallocation

Turns off dynamic data progression for the LUN. The Oracle FS System does not migrate the LUN data to other Storage Classes.

enableRefTagChecking
Instructs the HBA to check whether a SAN host has written to a specific area of the LUN before the host reads from that area. When a host reads from a specific area before writing to that area, the Oracle FS System generates a read-before-write error event.
Note: This check is sometimes called a reference tag check and is a part of the process for ensuring data protection integrity.
enableTierReallocation

Turns on dynamic data migration for the LUN. The Oracle FS System migrates the LUN data to the appropriate Storage Class based on the usage patterns of the data. By default, tier reallocation is enabled.

exactCapacity

Specifies that the amount of storage is limited to the amount of space set by the capacity option. If you do not use the exactCapacity option, the amount of space used by the volume might be rounded up to an allocation segment boundary, resulting in a LUN that is larger than requested. Use this option when strict control over the LUN capacity is required, such as configuring a replication pair.

fibreChannelAccess

Permits access to the volume through the Fibre Channel (FC) ports. By default, FC access is enabled.

globalMapping

Maps the LUN globally to all hosts using the specified lun-number.

inactive

Renders the LUN volume invisible on the network. An inactive volume is not accessible and cannot be used by a SAN host.

ioBias
Indicates the typical read-write ratio. Valid I/O biases:
  • read. Indicates that most of the access requests are for read operations.

  • write. Indicates that most of the access requests are for write operations.

  • mixed. Indicates that the number of access requests are similar for read operations and write operations.

A mixed read-write ratio is the default. Do not use the ‑ioBias option if you use the ‑profile option to apply a QoS Storage Profile to the LUN.
Note: During a modify operation of a LUN, if you need to change the value of one of the following options, you must specify the values of all three options: ‑accessBias, ‑ioBias, and ‑redundancy. Specify all three of these options or none.
lun

Specifies the ID or the FQN of the LUN that you are changing.

maskedControllerPorts
Restricts access to the LUN through one or more Controller ports. To mask all the ports in a Controller, to mask all the ports for a given Controller slot, or to mask only a specific Controller port, use the following format: /⁠controller[/⁠slot[/⁠port]]
  • For controller, provide a string that includes the FQN or ID of the Controller.

  • For slot, specify the HBA slot number.

  • For port, specify the port number.

If you do not include this option, the LUN becomes accessible on all Controller ports on the assigned node by default.
matchTierQos

Sets the QoS settings of the clone repository to match the QoS settings of the LUN.

metaDataStorageClass

Specifies the Storage Class for the filesystem metadata tier. If not provided, the system uses the highest performing Storage Class that is available.

name

Specifies a new name for the LUN. The name that you provide must be from 1 through 40 characters. To prevent parsing errors, use double quotation marks around names containing one or more spaces or dashes.

The following characters are invalid in a LUN name:
  • Tab

  • / (slash) and \ (backslash)

  • . (dot) and .. (dot-dot)

  • Embedded tabs

Note: If the Oracle FS System already contains a LUN with the specified name within the same volume group, the lun ‑modify command does not map the modified LUN. You can use the lun ‑modify command to map the modified LUN after determining the name to assign.
noBootLun

Identifies that the LUN cannot be used as a boot drive in the SAN. Not using the LUN as a boot drive is the default.

noConservativeMode
Prevents the Oracle FS System from entering conservative mode for the specified LUN.
Caution
If a Controller node fails, the system does not enable write-through mode, which it normally would. If the remaining node fails, any data that has not been written to the storage arrays is lost.
noFibreChannelAccess

Disables access to the modified LUN through FC ports. By default, access is enabled.

noMatchTierQos

Indicates that the QoS settings of the clone repository are not automatically set to the QoS settings of the LUN. Not automatically matching the QoS settings is the default.

preferredRepositoryStorageClass

Identifies the Storage Classes for the Clone LUNs that are created for the LUN, based on the usage patterns of the Clone LUNs. The Storage Classes do not need to be physically present on the Oracle FS System when you set this property. Storage Classes that are not present can be used after they are installed in the Oracle FS System.

Specify one or more Storage Classes:
  • capDisk. Specifies that the data is stored on high-capacity, rotating HDDs. This Storage Class optimizes capacity at some sacrifice of speed. For a storage system that does not include tape storage as an option, this Storage Class always provides the lowest cost for each GB of capacity.

  • perfDisk. Specifies that the data is stored on high-speed hard disk drives (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 solid state drives (SSDs) that are optimized for the performance of balanced read and write operations.

  • capSsd. Specifies that the data is stored on SSDs that are optimized for the performance of capacity and for read operations. The write performance for this Storage Class is sacrificed somewhat to achieve the optimizations for read performance and for capacity.

If you do not include this option, all Storage Classes can be used based on usage patterns. Do not use this option with the ‑matchTierQos option.
preferredStorageClass

Identifies the Storage Classes for the LUN based on the usage patterns of the LUN data. The Storage Classes do not need to be physically present on the Oracle FS System when you set this property. Storage Classes that are not present can be used after they are installed in the Oracle FS System.

Specify one or more Storage Classes:
  • capDisk. Specifies that the data is stored on high-capacity, rotating HDDs. This Storage Class optimizes capacity at some sacrifice of speed. For a storage system that does not include tape storage as an option, this Storage Class always provides the lowest cost for each GB of capacity.

  • perfDisk. Specifies that the data is stored on high-speed hard disk drives (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 solid state drives (SSDs) that are optimized for the performance of balanced read and write operations.

  • capSsd. Specifies that the data is stored on SSDs that are optimized for the performance of capacity and for read operations. The write performance for this Storage Class is sacrificed somewhat to achieve the optimizations for read performance and for capacity.

If you do not include the ‑preferredStorageClass option, all Storage Classes can be used based on usage patterns.
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.
profile
Specifies the fully qualified name (FQN) or unique identifier (ID) of the QoS Storage Profile to apply to the volume. To prevent parsing errors, use double quotes around names containing one or more spaces or dashes.
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.

readAhead
Identifies the read‑ahead policy that the system uses for sequential read operations. The policy determines the amount of additional data, if any, that the system places into the Controller cache. Valid policies:
normal and default

Indicates that the input requests and the output requests are accessing the data mostly in a random manner or in a mixed sequential and random manner.

aggressive

Indicates that the input requests and the output requests are accessing the data mostly in a sequential manner and that the workload is biased toward read operations.

conservative

Indicates that the input requests and the output requests are mostly sequential and that the workload is biased toward write operations.

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: During a modify operation of a LUN, if you need to change the value of one of the following options, you must specify the values of all three options: ‑accessBias, ‑ioBias, and ‑redundancy. Specify all three of these options or none.
repositoryAccessBias
Identifies the expected access pattern for the Clone LUN. Valid biases:
  • sequential. Indicates that the read requests and the write requests operate on the data mostly by accessing the records one after the other in a physical order.

  • random. Indicates that the read requests and the write requests operate on the data mostly by accessing the records in an arbitrary order.

  • mixed. Indicates that the read requests and the write requests operate on the data sometimes in sequential order and sometimes in random order. Accessing in a mixed pattern is the default.

Do not use the ‑repositoryAccessBias option if you use the ‑matchTierQos option to match the QoS settings of the LUN.
Note: During a modify operation of a LUN repository, if you need to change the value of one of the following options, you must specify the values of all three options: ‑repositoryAccessBias, ‑repositoryIoBias, and ‑repositoryRedundancy. Specify all three of these options or none.
repositoryIoBias
Indicates the typical read-write ratio for the Clone LUNs that are created for the LUN. Valid I/O biases:
  • read. Indicates that most of the access requests are for read operations.

  • write. Indicates that most of the access requests are for write operations.

  • mixed. Indicates that the number of access requests are similar for read operations and write operations.

A mixed read-write ratio is the default. Do not use the ‑repositoryIoBias option if you use the ‑matchTierQos option to match the QoS settings of the LUN.
Note: During a modify operation of a LUN repository, if you need to change the value of one of the following options, you must specify the values of all three options: ‑repositoryAccessBias, ‑repositoryIoBias, and ‑repositoryRedundancy. Specify all three of these options or none.
repositoryPercentage

Determines the amount of extra space to set aside as a repository for Clone LUNs. Specify the amount as a percentage of the maximum capacity for the LUN. The default capacity is set to 110%. If you do not want to create a repository, specify 0.

repositoryPriority
Assigns a priority level to determine the system response to incoming I/O requests against all Clone LUNs that are created from 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.

Do not use the ‑repositoryPriority option if you use the ‑matchTierQos option to match the QoS settings of the LUN.
repositoryRaidLevel
Specifies the level of RAID data protection to use for the clone repository. Valid values:
  • raid5. Indicates that, in addition to the actual data, one set of parity bits exists for the logical volume. Single parity protects against the loss of one drive. Single parity is implemented as a variant of the RAID 5 storage technology.

  • raid6. Indicates that, in addition to the actual data, two sets of parity bits exist for the logical volume. Double parity protects against the loss of one or two drives with a slight cost of write performance. Double parity is implemented as a variant of the RAID 6 storage technology.

  • raid10. Indicates that no parity bits exist for the volume. Instead, the system writes the data in two different locations. Mirroring protects against the loss of at least one drive and possibly more drives with an improvement of the performance of random write operations. Mirrored RAID is implemented as a variant of the RAID 10 storage technology.

  • default. Indicates that the level of protection is determined by the storage class. For large form factor (capacity) hard disk drives, the RAID 6 level of protection is the default. For the other storage classes, the RAID 5 level of protection is the default.

Do not use the ‑repositoryRaidLevel option if you use the ‑matchTierQos option to match the QoS settings of the LUN.
repositoryRedundancy
Identifies the number of copies of the parity bits that the Oracle FS System creates for the Clone LUN. Valid values:
  • 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. Single parity is implemented using RAID 5 technology.

  • 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. Double parity is implemented using RAID 6 technology.

Do not use the ‑repositoryRedundancy option if you use the ‑matchTierQos option to match the QoS settings of the LUN.
Note: During a modify operation of a LUN repository, if you need to change the value of one of the following options, you must specify the values of all three options: ‑repositoryAccessBias, ‑repositoryIoBias, and ‑repositoryRedundancy. Specify all three of these options or none.
repositoryStorageClass
Identifies the type of storage media to be used for all Clone LUNs that are created for the LUN. 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 ‑repositoryStorageClass option if you use the ‑matchTierQos option to match the QoS settings of the LUN.
singleTier

Creates a LUN that uses standard QoS properties. A single-tier LUN has QoS properties that you set to specify the Storage Class and other performance parameters for storing the LUN data onto the storage media. The QoS properties remain unchanged until you change these properties.

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.

unMaskedControllerPorts

Opens access to the volume through the Controller ports that were previously set to restricted access.

Specify the port using the form /Controller ID or name/HBA slot number/port number. Specify the arguments in the following manner:
Controller ID or name

Indicates the unique ID or the name of a Controller. Include a forward slash ( / ) character before the name.

HBA slot number

Specifies the PCIE slot number of the HBA on which the port is located. The slot number must be 0 or greater.

port number

Identifies the port number on the HBA slot. The port number must be 0 or greater.

For example, /CONTROLLER-01/1/0 specifies port 1 on HBA slot 0 of the Controller named CONTROLLER-01.

unmapped

Prevents the LUN from being detected or accessed by any SAN host.

volumeGroup

Specifies the FQN or the ID of the volume group to which the LUN is assigned.

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-useroracleFS 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

Change the name of a LUN on the Oracle FS System and increase the logical capacity of the LUN. Change the priority to the highest processing queue setting for testing purposes, and make the LUN accessible immediately.

Parameters
  • The FQN or the ID of the LUN: DISK1/⁠⁠user1_vg

  • The new name of the LUN: DISK3

  • The size of the LUN, in gigabytes: 128

  • The priority level: premium

$ fscli lun ‑modify ‑lun /⁠user1_vg/⁠DISK1 ‑name DISK3 ‑capacity 128 ‑priority premium ‑active