Creates a job.
job ‑add ‑name job‑name [{‑enable | ‑disable}] { ‑oneTime date‑time | ‑recurring ‑interval {hourly | daily | weekly | monthly} ‑frequency interval_frequency ‑startTime date‑time } { ‑addCloneLun ‑cloneName clone‑lun‑name ‑source source‑lun‑id‑or‑fqn [‑capacity capacity] [‑priority {premium | high | medium | low | archive}] [‑volumeGroup volume‑group‑id‑or‑fqn] [{‑fibreChannelAccess | ‑noFibreChannelAccess}] [‑maskedControllerPorts /controller[/slot[/port]] [, /controller[/slot[/port]]]... ] [{‑active | ‑inactive}] [{‑disableRefTagChecking | ‑enableRefTagChecking}] [‑bootLun | ‑noBootLun] | ‑generateReport ‑type {system | storageUse | volumeUse | performance | sanHosts | systemSummary | autoTier} [‑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}]
The job itself
The clone or the report that the job creates or generates when the job runs
Makes a Clone LUN visible on the network so that the clone can be discovered and accessed by a SAN host. By default, the Clone LUN is active.
Specifies that the job is to create a point-in-time snapshot of a LUN . The snapshot is referred to as a Clone LUN. All clones are readable and writable and are partial-block copies of the specified source volume.
For the ‑addCloneLUN option, identifies that the Clone LUN can be used as a boot drive in the SAN.
Specifies the storage space in gigabytes for the clone volume. 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.
Specifies the name to use for the new Clone FS or for the new Clone LUN.
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/.
Prevents the job from being active after the job is created.
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.
Makes the job active. You can select the ‑enable option, the ‑disable option, or neither option. If you select neither option, the job becomes active after it is created.
By default, reference tag checking is enabled.
Permits access to the volume through the Fibre Channel (FC) ports. By default, FC access is enabled.
Defines the number of time units as specified by the ‑interval option between the time when one task is run and the time when the next task is run. The value must be a positive integer.
For example, to create a Clone LUN once every two weeks, specify weekly for the ‑interval option and 2 for the ‑frequency option.
Specifies that the job creates a report.
Renders the LUN volume invisible on the network. An inactive volume is not accessible and cannot be used by a SAN host.
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.
Specifies the ID or the fully qualified name (FQN) of the Controller that is hosting the port.
Specifies the PCIE slot number of the HBA on which the port is located. The slot number must be 0 or greater.
Identifies the port number on the HBA slot. The port number must be 0 or greater.
For example, /husky/0/1 specifies port 1 on HBA slot 0 of the Controller that is named husky.
Specifies the name of the job. The name that you provide is used to create the fully qualified name (FQN) of the job. Use double quotation marks around names containing dashes or spaces.
Identifies that the logical volume cannot be used as a boot drive in the SAN.
Not using the LUN volume as a boot drive is the default action.
Disables access to the volume through the Fibre Channel (FC) ports.
Defines the date and the time when the job is to run. The job is run only one time.
YYYY-MM-DD[THH[:mm[:SS[.xxx]]]][+|-HH:mm]
where:
Designates a 4‑digit year, a 2‑digit month, and a 2‑digit day. If the remaining values are omitted, the time is set to 12:00:00.000+00:00.
A separator that designates the start of the time portion of the string.
Designates the hours, the minutes, and the seconds (to three decimals) in terms of a 24-hour clock. If only HH is defined, the remaining values default to 00.
Designates the time zone as an offset from Coordinated Universal Time (UTC) in hours and minutes.
Indicates the highest priority for responding to requests in the processing queue
Indicates the next highest priority for responding to requests in the processing queue
Indicates an intermediate priority for responding to requests in the processing queue
Indicates the next to lowest priority for responding to requests in the processing queue
Indicates the lowest priority for responding to requests in the processing queue
Causes the job to be run on a regular, repeating basis.
Specifies the unique ID or the fully qualified name (FQN) of the source volume to use when cloning the volume.
Defines the time and the date of when the task is to begin.
YYYY-MM-DD[THH[:mm[:SS[.xxx]]]][+|-HH:mm]
where:
Designates a 4‑digit year, a 2‑digit month, and a 2‑digit day. If the remaining values are omitted, the time is set to 12:00:00.000+00:00.
A separator that designates the start of the time portion of the string.
Designates the hours, the minutes, and the seconds (to three decimals) in terms of a 24-hour clock. If only HH is defined, the remaining values default to 00.
Designates the time zone as an offset from Coordinated Universal Time (UTC) in hours and minutes.
Specifies the fully qualified name (FQN) or the unique identifier (ID) of the Storage Domain on which the system bases the auto-tier effectiveness report. The ‑storageDomain option is required when the ‑type option is set to autoTier.
Returns information about the effectiveness of auto‑tiering for a Storage Domain. This option requires that the ‑storageDomain option be specified as well.
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.
Returns detailed configuration information about the SAN hosts and about the components that are configured on those hosts.
Returns detailed information on the configuration and the current status of the Oracle FS System and of all of its components.
Returns capacity information for each logical volume in the Oracle FS System.
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.
Specifies the fully qualified name (FQN) or the unique ID of a volume group to which the logical volume is assigned.
The following global options can be used for fully formed fscli commands:
The command completes successfully.
The command returns with an error.
The session times out.
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.
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.
Add a new job using a point-in-time snapshot of a LUN.
The name of the job: job_1
The date and time when the job is to run: 2014-08-01
The name of the Clone LUN: clone_1
The (FQN) of the source volume to use when cloning: /lun_1
$ fscli job ‑add ‑name job_1 ‑oneTime 2014‑08‑01 ‑addCloneLun ‑cloneName clone_1 ‑source /lun_1