clone_lun ‑prepare

Enables you to set up a Clone LUN without completing its creation.

SYNOPSIS

clone_lun ‑prepare 
   ‑name clone‑lun‑name
   ‑source source‑lun‑id‑or‑fqn
   [‑capacity capacity]
   [‑priority {premium | high | medium | low | archive}]
   [‑volumeGroup volume‑group‑id‑or‑fqn]
   [{ ‑unmapped
    | ‑globalMapping lun‑number
    | ‑hostmap host‑id‑or‑fqn [, host‑id‑or‑fqn]...
      { ‑lunNumber lun‑number | ‑nextLunNumber }
    | ‑hostGroupMap host‑group‑id‑or‑fqn
      { ‑lunNumber lun‑number | ‑nextLunNumber }
    }]
   [{‑fibreChannelAccess | ‑noFibreChannelAccess}]
   [‑maskedControllerPorts /controller[/slot[/port]]
                        [, /controller[/slot[/port]]]... ]
   [{‑active | ‑inactive }]
   [{‑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

The clone_lun -prepare command enables you to organize the details of a new Clone LUN without creating an active clone. You can define the characteristics for the new clone, such as Quality of Service (QoS) attributes, mapping, and storage capacity. When you are ready to complete the creation of the new Clone LUN, run the clone_lun -commit command.

Note: Only administrators with primary administrator, admin1, or admin2 roles are authorized to run the clone_lun -prepare command.

OPTIONS

‑active

Enables the Clone LUN to be accessible and available for use immediately after you run the clone_lun ‑commit command. To ensure accurate mapping relationships, use the ‑globalMapping option, the ‑hostmap option, or the ‑hostGroupMap option with the ‑active option. Enabling the Clone LUN to be accessible is the default.

‑bootLun

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

‑capacity

Specifies the storage space in gigabytes for the clone. Specify this value if you want the capacity of the clone volume to be different from the capacity of the source volume. This value must be equal to or larger than the source volume. This space is sometimes referred to as addressable capacity.

‑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.

If this option is omitted, reference tag checking is enabled by default.

‑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.

By default, reference tag checking is enabled.

‑fibreChannelAccess

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

‑globalMapping

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

‑hostGroupMap

Specifies a mapping relationship between a Clone LUN and a host group. You identify the host group mapping by providing a fully qualified name (FQN) or a unique ID (ID).

‑hostmap

Specifies a mapping relationship between a Clone LUN and a SAN host. You identify the host by providing a unique ID (ID) or a fully qualified name (FQN).

‑inactive

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

‑lunNumber

Identifies the logical unit number that is used to present a Clone LUN to a SAN host or a host group.

Note: If the host already contains a LUN with the specified number, the clone_lun ‑prepare command does not map the new Clone LUN. You can run the clone_lun ‑modify command to map the new Clone LUN after determining the number to use.

‑maskedControllerPorts

Restricts access to the Clone 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 Clone LUN becomes accessible on all Controller ports on the assigned node by default.

‑name

Specifies a name for the Clone 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 clone_lun ‑commit command does not create the prepared Clone LUN.

‑nextLunNumber

Instructs the system to assign the next available logical unit number to the volume. This number is used to present an Oracle FS System Clone LUN to a SAN host or to a host group.

‑noBootLun

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

‑noFibreChannelAccess

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

‑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.

‑source

Specifies the FQN or unique identifier (ID) of the source LUN.

‑unmapped

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

‑volumeGroup

Specifies the FQN or the ID of the volume group to which the Clone LUN is assigned. If you do not include this option, the Clone LUN is assigned to the root level volume group.

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

Prepare a Clone LUN that will be created later using the clone_lun ‑commit command.

Parameters

The name of the Clone LUN: CLONE_DISK1
The fully qualified name (FQN) of the source LUN: /⁠user1_vg/⁠DISK1

$ fscli clone_lun -prepare ‑name CLONE_DISK1 ‑source /⁠user1_vg/⁠DISK1