Install-LXCAUpdatePackage

This cmdlet applies one or more firmware updates to a target system with or without the compliance policy comparison result for the target system.

Note: You cannot pipe objects to this cmdlet.

Syntax

Install-LXCAUpdatePackage [-Connection LXCAConnection]
                           -Compliance SystemCompliance
                           -UpdateRule String
                           -ActivationMode String
                           -OnErrorMode String
                          [-ForceUpdate]
                          [-AsJob]
                          [-Schedule ScheduleObject]
                          [CommonParameter]

Install-LXCAUpdatePackage [-Connection LXCAConnection]
                           -Compliances SystemCompliance[]
                           -UpdateRule String
                           -ActivationMode String
                           -OnErrorMode String
                          [-ForceUpdate]
                          [-AsJob]
                          [-Schedule ScheduleObject]
                          [CommonParameter]

Install-LXCAUpdatePackage [-Connection LXCAConnection]
                           -Compliance SystemCompliance
                           -FixId String[]
                           -ActivationMode String
                           -OnErrorMode String
                          [-ForceUpdate]
                          [-AsJob]
                          [-Schedule ScheduleObject]
                          [CommonParameter]

Install-LXCAUpdatePackage [-Connection LXCAConnection]
                           -Uuid String
                           -SystemType SystemType
                           -ComponentName  String[]
                           -FixId String[]
                           -ActivationMode String
                           -OnErrorMode String
                          [-ForceUpdate]
                          [-AsJob]
                          [-Schedule ScheduleObject]
                          [CommonParameter]

Parameters

-Connection LXCAConnection
Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the result from the last Connect-LXCA cmdlet is used.
-Compliance SystemCompliance
Specifies the firmware compliance-check results.
-Compliances SystemCompliance[]
Specifies one or more the firmware compliance-check results.
-UpdateRule String
Specifies which firmware updates in the firmware compliance-check result are to be applied to target device. You can specify one of the following values:
  • All. All firmware updates in the compliance-check result are applied. To also apply to firmware updates that are in compliance, specify the -ForceUpdate parameter.
  • NotCompliantOnly. Only those firmware updates in the compliance-check result that are not compliant are applied.
-Uuid String
Specifies the UUID of the target system.
-SystemType SystemType
Specifies the type of the target system. The type can be one of the following values:
  • CMM. The specified device is a CMM.

  • ComputeNode. The specified device is a Flex System compute node.

  • IOSwitch. The specified device is a Flex System switch.

  • RackServer. The specified device is a rack or tower server.

  • RackSwitch. The specified device is a RackSwitch switch.

  • Storage. The specified device is a storage device.

-ComponentName String[]
Specifies the component name to be applied to the target device. The component name can be retrieved from cmdlet Get-LXCAUpdatePackage.

The component name must be a one-to-one match to the FixId in the same order.

-FixId String[]
Specifies the ID of one or more firmware updates to be applied to target device. The component name can be retrieved from cmdlet Get-LXCAUpdatePackage.
-ActivationMode String
Specifies when to restart the target device to activate new firmware. You can specify one of the following:
  • Immediate. During the update process, the target device might be automatically restarted multiple times until the entire process is complete. Ensure that you quiesce all applications on the target device before you proceed.
  • Delayed. Some but not all update operations are performed. The target device must be restarted manually to continue the update process. Additional restarts are then performed automatically until the update operation completes. This rule is supported only for servers and rack switches.
  • Prioritized. Firmware updates on the baseboard management controller are activated immediately; all other firmware updates are firmware updates are activated the next time the device is restarted. Additional restarts are then performed until the update operation completes. This rule is supported only for servers.
-OnErrorMode String
Specifies how to handle an update error. You can specify one of the following values:
  • StopAllUpdatesOnError. If an error occurs while updating any of the components in a target device (such as an adapter or baseboard management controller firmware), the firmware-updates process stops for all targeted devices in the current firmware-update job. In this case, none of the updates in the firmware-updates package for the device are activated. The current firmware that is installed on all targeted devices remains in effect.
  • ContinueOnError. If an error occurs while updating one of the components in a target device (such as an adapter or management controller firmware), the firmware-updates process does not update the firmware for that specific component. However, the firmware-updates process continues to update other components for the device and continues with all other updates in the current update job.
  • ContinueToNextSystemOnError. If an error occurs while updating one of the components in a target device (such as an adapter or management controller firmware), the firmware-updates process stops attempting to update the firmware for that specific device. The current firmware that is installed on that device remains in effect. However, if you have selected multiple devices as part of the current firmware-update job, the management server continues to update the firmware for the remaining devices selected as part of the current job.
-ForceUpdate
If specified, this cmdlet applies firmware updates to the specified devices even if the firmware is in compliance. Otherwise, if the firmware is already compliant, this cmdlet skips the firmware updates on the specified devices.
-AsJob
If specified, the cmdlet runs as background job and returns a Job object immediately.
-Schedule ScheduleObject
When specified, the cmdlet runs based on the specified schedule.
CommonParameters
This cmdlet supports the following common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -WarningAction, -WarningVariable, -OutBuffer, -PipelineVariable, -OutVariable. For detailed information about each common parameter, see the Microsoft PowerShell Common Parameters webpage.

Results

If you specify the -Asjob parameter, this cmdlet returns a Job object. You can retrieve the UpdateResult object from Job.Output when the job is complete. You can retrieve the SubJob from Job.GetSubJobStatus() to get the status of each update.

If you do not specify the -Asjob parameter, this cmdlet returns an UpdateResult object.

Examples

Related links