Skip to content

Latest commit

 

History

History
279 lines (217 loc) · 6.44 KB

Update-OMEFirmware.md

File metadata and controls

279 lines (217 loc) · 6.44 KB
external help file Module Name online version schema
DellOpenManage-help.xml
DellOpenManage
2.0.0

Update-OMEFirmware

SYNOPSIS

Update firmware on devices in OpenManage Enterprise

SYNTAX

Update-OMEFirmware [[-Name] <String>] [[-DeviceFilter] <Device[]>] [[-ComponentFilter] <String[]>]
 [-Baseline] <FirmwareBaseline> [[-UpdateSchedule] <String>] [[-RebootType] <String>]
 [[-UpdateScheduleCron] <String>] [[-UpdateAction] <String[]>] [-ResetiDRAC] [-ClearJobQueue] [-Wait]
 [[-WaitTime] <Int32>] [<CommonParameters>]

DESCRIPTION

This will use an existing firmware baseline to submit a Job that updates firmware on a set of devices.

EXAMPLES

EXAMPLE 1

Update-OMEFirmware -Baseline $("AllLatest" | Get-OMEFirmwareBaseline) | Format-Table

Display device compliance report for all devices in baseline. No updates are installed by default.

EXAMPLE 2

Update-OMEFirmware -Baseline $("AllLatest" | Get-OMEFirmwareBaseline) -UpdateSchedule "RebootNow"

Update firmware on all devices in baseline immediately ***Warning: This will force a reboot of all servers

EXAMPLE 3

Update-OMEFirmware -Baseline $("AllLatest" | Get-OMEFirmwareBaseline) -UpdateSchedule "StageForNextReboot"

Update firmware on all devices in baseline on next reboot

EXAMPLE 4

Update-OMEFirmware -Baseline $("AllLatest" | Get-OMEFirmwareBaseline) -DeviceFilter $("C86C0Q2" | Get-OMEDevice -FilterBy "ServiceTag") -UpdateSchedule "ScheduleLater" -UpdateScheduleCron "0 0 0 1 11 ?"

Update firmware on 11/1/2020 12:00AM UTC

EXAMPLE 5

Update-OMEFirmware -Baseline $("AllLatest" | Get-OMEFirmwareBaseline) -DeviceFilter $("C86C0Q2" | Get-OMEDevice -FilterBy "ServiceTag") -UpdateSchedule "RebootNow"

Update firmware on specific devices in baseline immediately ***Warning: This will force a reboot of all servers

EXAMPLE 6

Update-OMEFirmware -Baseline $("AllLatest" | Get-OMEFirmwareBaseline) -ComponentFilter "iDRAC" -UpdateSchedule "StageForNextReboot" -ClearJobQueue

Update firmware on specific components in baseline on next reboot and clear job queue before update

EXAMPLE 7

Update-OMEFirmware -Baseline $("AllLatest" | Get-OMEFirmwareBaseline) -ComponentFilter "BIOS", "iDRAC" -UpdateSchedule "StageForNextReboot" -ClearJobQueue

Update firmware on multiple specific components in baseline on next reboot and clear job queue before update

PARAMETERS

-Name

Name of the firmware update job

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: "Update Firmware $((Get-Date).ToString('yyyyMMddHHmmss'))"
Accept pipeline input: False
Accept wildcard characters: False

-DeviceFilter

Array of type Device returned from Get-OMEDevice function. Used to limit the devices updated within the baseline.

Type: Device[]
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ComponentFilter

Array of Strings that represent component name. Used to limit the components updated within the baseline. Supports regex via Powershell -match

Type: String[]
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Baseline

Array of type Baseline returned from Get-Baseline function

Type: FirmwareBaseline
Parameter Sets: (All)
Aliases:

Required: True
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-UpdateSchedule

Determines when the updates will be performed. (Default="Preview", "RebootNow", "ScheduleLater", "StageForNextReboot")

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 5
Default value: Preview
Accept pipeline input: False
Accept wildcard characters: False

-RebootType

Used when -UpdateSchedule=RebootNow. ("PowerCycle", "Graceful" Graceful reboot without forced shutdown, Default="GracefulForced" Graceful reboot with forced shutdown

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 6
Default value: GracefulForced
Accept pipeline input: False
Accept wildcard characters: False

-UpdateScheduleCron

Cron string to schedule updates at a later time. Uses UTC time. Used with -UpdateSchedule "ScheduleLater"

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-UpdateAction

Determines what type of updates will be performed. (Default="Upgrade", "Downgrade", "All")

Type: String[]
Parameter Sets: (All)
Aliases:

Required: False
Position: 8
Default value: Upgrade
Accept pipeline input: False
Accept wildcard characters: False

-ResetiDRAC

This option will restart the iDRAC. Occurs immediately, regardless if StageForNextReboot is set

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-ClearJobQueue

This option clears any active or pending jobs. Occurs immediately, regardless if StageForNextReboot is set

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Wait

Wait for job to complete

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-WaitTime

Time, in seconds, to wait for the job to complete

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: 9
Default value: 3600
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

None

OUTPUTS

NOTES

RELATED LINKS