job ‑modify

Changes the properties of a job.

SYNOPSIS

job ‑modify 
   ‑job job‑id‑or‑fqn
   [‑name job‑name]
   [{‑enable | ‑disable}]
   [{ ‑oneTime date‑time
    | ‑recurring
      ‑interval {hourly | daily | weekly | monthly}
      ‑frequency interval_frequency
      ‑startTime date‑time
    }]
   [{‑addCloneLun
      [‑cloneName new‑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]]]... ]
      [‑unMaskedControllerPorts /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}]

DESCRIPTION

Changes the properties of an existing job such as its schedule, the properties of the object that the job creates, or both. You cannot, however, change the type of object that the job creates. To change the type of object that the job creates, delete the job and then create another job that performs the desired task.

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

OPTIONS

‑active

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.

‑addCloneLun

Changes the properties of an existing job that creates a Clone LUN.

‑bootLun

For the ‑addCloneLUN option, 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 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.

‑cloneName

Specifies the name to use for the new Clone FS or for the new Clone LUN.

‑comment

Defines a character string, such as a description, that the Oracle FS System associates with the filesystem clone.

‑country

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

‑disable

Prevents the job from being active after the job is modified.

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

‑enable

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.

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

‑frequency

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.

‑generateReport

Specifies that the job creates a report.

‑inactive

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

‑interval

Defines the time unit to use as the basis for the repeating interval between the following tasks. Valid values:

hourly: Specifies that the interval is in hours.
daily: Specifies that the interval is in days.
weekly: Specifies that the interval is in weeks.
monthly: Specifies that the interval is in months.

‑job

Specifies the ID or the fully qualified name (FQN) of a job to modify.

‑language

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.

‑maskedControllerPorts

Prevents SAN hosts from accessing the LUN through the specified Controller ports. If this option is omitted, the LUN can be accessed through any of the ports.

Note: If a Controller port is not masked, a SAN host can access the LUN through that port.

Specify the ports using the following arguments:

controller: Specifies the ID or the fully qualified name (FQN) of the Controller that is hosting the port.
slot: Specifies the PCIE slot number of the HBA on which the port is located. The slot number must be 0 or greater.
port: 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.

‑name

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.

‑noBootLun

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.

‑noFibreChannelAccess

Disables access to the volume through the Fibre Channel (FC) ports.

‑oneTime

Defines the date and the time when the job is to run. The job is run only one time.

Use the following format for the date and the time:

YYYY-MM-DD[THH[:mm[:SS[.xxx]]]][+|-HH:mm]

where:

YYYY-MM-DD: 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.
T: A separator that designates the start of the time portion of the string.
HH:mm:SS.xxx: 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.
HH:mm: Designates the time zone as an offset from Coordinated Universal Time (UTC) in hours and minutes.

‑priority

Identifies the priority that the system gives to various operational aspects of a logical volume, such as the Controller processing queue. The processing-queue priority defines the percentage of the Controller CPU cycles that are dedicated to the volume. Identifies as well where the data is striped on rotating drives. Valid priority levels:

premium: Indicates the highest priority for responding to requests in the processing queue
high: Indicates the next highest priority for responding to requests in the processing queue
medium: Indicates an intermediate priority for responding to requests in the processing queue
low: Indicates the next to lowest priority for responding to requests in the processing queue
archive: Indicates the lowest priority for responding to requests in the processing queue

‑recurring

Causes the job to be run on a regular, repeating basis.

‑source

Specifies the unique ID or the fully qualified name (FQN) of the source volume to use when cloning the volume.

‑startTime

Defines the time and the date of when the task is to begin.

Use the following format for the date and the time:

YYYY-MM-DD[THH[:mm[:SS[.xxx]]]][+|-HH:mm]

where:

YYYY-MM-DD: 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.
T: A separator that designates the start of the time portion of the string.
HH:mm:SS.xxx: 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.
HH:mm: Designates the time zone as an offset from Coordinated Universal Time (UTC) in hours and minutes.

‑storageDomain

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.

‑type

Specifies the type of report to generate. Valid types:

autoTier: Returns information about the effectiveness of auto‑tiering for a Storage Domain. This option requires that the ‑storageDomain option be specified as well.
performance: 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.
sanHosts: Returns detailed configuration information about the SAN hosts and about the components that are configured on those hosts.
system: Returns detailed information on the configuration and the current status of the Oracle FS System and of all of its components.
systemSummary: Returns a configuration summary of the Pilots, the Controllers, and the Drive Enclosures, including the status of each of those components.
volumeUse: Returns capacity information for each logical volume in the Oracle FS System.

‑unMaskedControllerPorts

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

Specify the ports using the following arguments:

controller: Specifies the ID or the fully qualified name (FQN) of the Controller that is hosting the port.
slot: Specifies the PCIE slot number of the HBA on which the port is located. The slot number must be 0 or greater.
port: 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.

‑variant

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.

‑volumeGroup

Specifies the fully qualified name (FQN) or the unique ID of a volume group to which the logical volume 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-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

Change the capacity of the clone volume.

Parameters

The FQN of the job: /⁠job_1
The new capacity: 20

$ fscli job ‑modify ‑job /⁠job_1 ‑addCloneLun ‑capacity 20