software_update ‑install

Installs components from the staged software package.

SYNOPSIS

software_update ‑install 
   { ‑drive drive‑type [,drive‑type]...
   | { ‑component component:instruction [,component:instruction]...
     | ‑all {newerVersionOnly | alwaysInstall}
     }
     [{‑disruptive | ‑noDisruptive}]
     [‑ignoreCompatibilityChecking]
     [‑forceControllerShutdown
      [‑discardFbm]
     ]
     [‑ignoreBadSystemState]
     [‑ignoreOperationPoolDraining]
     [‑overridePreviousFailedUpdate]
     [‑ignoreExistingAlerts]
   }
   [‑suppressWarnings]

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

DESCRIPTION

For an update operation to succeed smoothly, the following conditions must not exist during the update operation:

Conflicts with the compatibility matrix
Non-optimal system state
Incomplete internal tasks
Previously failed update operations
Unresolved system alerts

By default, if any combination of the above conditions exists, the update operation fails. To override this default action, you can explicitly request to be prompted when one or more of these conditions are encountered. When prompted, you can choose whether to terminate the update operation or to proceed with the update operation.

If you use any of the override options in the software_update ‑install command and the corresponding condition is encountered during the update operation, the system displays the following prompt (unless the ‑suppressWarnings option is included in the command):

Warning: Contact the Support Center before proceeding! Proceeding without their assistance could risk data loss. 
Continue?

An affirmative response of y (or any value beginning with y, such as yes) instructs the system to proceed with the software update.

Caution

Responding affirmatively could result in data loss.

Note: Administrators with primary administrator, admin1, or support roles are authorized to run the software_update ‑install command. However, because data loss might well occur, only support roles are authorized to use the ‑suppressWarnings option.

OPTIONS

‑all

Processes all of the staged modules except drive firmware in one operation. The selected operand applies to each staged module as it is processed. Choose from the following valid operands:

newerVersionOnly: Processes the staged software module only when it is newer than the existing module.
alwaysInstall: Processes the staged software module regardless of the version of the existing module. Only use this option if you have been instructed by the release notes, a My Oracle Support Knowledge article, or Oracle Customer Support.

‑component

Specifies a comma-separated list that indicates the component version to install and the installation instruction for that component. Separate the component operand and the instruction operand with a colon ( : ).

Express the component operand by one of the following methods:
As a regular expression

[0‑9]{4}‑[0‑9]{5}‑[0‑9]{6}‑[0‑9]{6}

As a string
Valid components:
pilotSoftware

pilotOS

controllerSoftware

controllerOS

enclosureFirmware2U

enclosureFirmware4U

Note: To get a list of components that are available for processing, run the software_update ‑list ‑staged command.
Express the instruction operand by including one of the following values:
exclude

Prevents the software component from being installed.

newerVersionOnly

Installs the software component only if the staged component is more recent than the installed version.

alwaysInstall

Installs the software component regardless of its version.

‑discardFbm

Clears the flash-backed memory in the Controllers.

To use the ‑discardFbm option, you must also specify the ‑forceControllerShutdown option.

Note: Only use this option if you have been instructed by the release notes, a My Oracle Support Knowledge article, or Oracle Customer Support.

‑disruptive

Takes all of the data paths offline and temporarily places the Oracle FS System in an inactive state.

‑drive

Specifies the types of staged drive firmware to install. To get a list of the types of installed drive firmware, use the ‑list subcommand.

‑forceControllerShutdown

Disregards all exceptions and stops all software modules that are running on the Controllers.

Note: Using this option causes a disruptive update.

‑ignoreBadSystemState

Instructs the software update process to proceed when hardware issues exist.

If a hardware issue is encountered during the update operation, you are prompted to confirm that you want the system to ignore the condition. To ignore the condition and to proceed with the update, enter y.

Note:

Both Pilots need to be online. If both Pilots are not online, the update fails.

Any hardware that is not online at the time of the installation is not upgraded until it is back online.

‑ignoreCompatibilityChecking

Instructs the software update process to proceed when a conflict with the settings in the compatibility matrix occurs.

If a conflict is encountered during the update operation, you are prompted to confirm that you want the system to ignore the condition. To ignore the condition and to proceed with the update, enter y.

‑ignoreExistingAlerts

Instructs the software update process to ignore any existing system alerts and to continue the update.

If unresolved system alerts are encountered during the update operation, you are prompted to confirm that you want the system to ignore the condition. To ignore the condition and to proceed with the update, enter y.

‑ignoreOperationPoolDraining

Instructs the software update process to proceed after waiting for a preset time period for internal tasks to complete, regardless of whether those tasks have completed within that period.

If internal tasks cannot be completed in time during the update operation, you are prompted to confirm that you want the system to ignore the condition. To ignore the condition and to proceed with the update, enter y.

‑noDisruptive

Performs the software update with the data paths and the Oracle FS System remaining active. User applications can continue accessing the storage arrays without interruption.

Note: Only use this option if you have been instructed by the release notes, a My Oracle Support Knowledge article, or Oracle Customer Support.

‑overridePreviousFailedUpdate

Instructs the software update process to ignore any failures from a previous update attempt and to continue the update.

If a previous update failure is encountered during the update operation, you are prompted to confirm that you want the system to ignore the condition. To ignore the condition and to proceed with the update, enter y.

‑suppressWarnings

Instructs the system not to display any confirmation prompts when non-optimum conditions are encountered and, instead, to continue the specified operation.

Note: Only administrators with support roles are authorized to use the ‑suppressWarnings option.

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

Install only newer components from the staged software package to the Oracle FS System.

Parameters

None

$ fscli software_update ‑install ‑all newerVersionOnly ‑noDisruptive