New-CMOperatingSystemImageUpdateSchedule

Module:

ConfigurationManager Module

Creates an operating system image update schedule.

Syntax

NewScheduleByInputObject (Default)

New-CMOperatingSystemImageUpdateSchedule
    -InputObject <IResultObject>
    -SoftwareUpdate <IResultObject[]>
    [-ContinueOnError <Boolean>]
    [-CustomSchedule <DateTime>]
    [-RemoveSupersededUpdates <Boolean>]
    [-UpdateDistributionPoint <Boolean>]
    [-Utc <Boolean>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

NewScheduleByName

New-CMOperatingSystemImageUpdateSchedule
    -SoftwareUpdate <IResultObject[]>
    [-ContinueOnError <Boolean>]
    [-CustomSchedule <DateTime>]
    [-RemoveSupersededUpdates <Boolean>]
    [-UpdateDistributionPoint <Boolean>]
    [-Utc <Boolean>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

NewScheduleById

New-CMOperatingSystemImageUpdateSchedule
    -SoftwareUpdate <IResultObject[]>
    [-ContinueOnError <Boolean>]
    [-CustomSchedule <DateTime>]
    [-RemoveSupersededUpdates <Boolean>]
    [-UpdateDistributionPoint <Boolean>]
    [-Utc <Boolean>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

NewScheduleByScheduleInputObject

New-CMOperatingSystemImageUpdateSchedule
    -SoftwareUpdate <IResultObject[]>
    [-ContinueOnError <Boolean>]
    [-CustomSchedule <DateTime>]
    [-RemoveSupersededUpdates <Boolean>]
    [-UpdateDistributionPoint <Boolean>]
    [-Utc <Boolean>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

NewScheduleByIdRunNow

New-CMOperatingSystemImageUpdateSchedule
    -Id <String>
    -SoftwareUpdate <IResultObject[]>
    [-ContinueOnError <Boolean>]
    [-RemoveSupersededUpdates <Boolean>]
    [-RunNow]
    [-UpdateDistributionPoint <Boolean>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

NewScheduleByInputObjectRunNow

New-CMOperatingSystemImageUpdateSchedule
    -InputObject <IResultObject>
    -SoftwareUpdate <IResultObject[]>
    [-ContinueOnError <Boolean>]
    [-RemoveSupersededUpdates <Boolean>]
    [-RunNow]
    [-UpdateDistributionPoint <Boolean>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

NewScheduleByNameRunNow

New-CMOperatingSystemImageUpdateSchedule
    -Name <String>
    -SoftwareUpdate <IResultObject[]>
    [-ContinueOnError <Boolean>]
    [-RemoveSupersededUpdates <Boolean>]
    [-RunNow]
    [-UpdateDistributionPoint <Boolean>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

NewScheduleByScheduleInputObjectRunNow

New-CMOperatingSystemImageUpdateSchedule
    -SoftwareUpdate <IResultObject[]>
    [-ContinueOnError <Boolean>]
    [-RemoveSupersededUpdates <Boolean>]
    [-RunNow]
    [-UpdateDistributionPoint <Boolean>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The New-CMOperatingSystemImageUpdateSchedule cmdlet creates an operating system image update schedule.

Note

Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.

Examples

Example 1: Create an operating system image update schedule

PS ABC:\> $Win10Image = Get-CMOperatingSystemImage -Name "Windows 10 Enterprise"
PS ABC:\> $Win10SU = Get-CMSoftwareUpdate -UpdateGroupName "Win10SUgroup01"
PS ABC:\> New-CMOperatingSystemImageUpdateSchedule -Name $Win10Image.Name -SoftwareUpdate $Win10SU -RunNow -ContinueOnError $True

The first command gets the operating system image object named Windows 10 Enterprise and stores the object in the $Win10Image variable.

The second command gets the software update object for the update group named Win10SUgroup01 and stores the object in the $Win10SU variable.

The last command creates an operating system image update schedule to update the operating system image named Windows 10 Enterprise with the update stored in $Win10SU. The update will run now, and will continue to apply the updates even if an error is encountered.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:	SwitchParameter
Default value:	False
Supports wildcards:	False
DontShow:	False
Aliases:	cf

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ContinueOnError

Indicates whether software updates should be applied to the image even when there is an error.

Parameter properties

Type:	Boolean
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-CustomSchedule

Specifies the date and time when the software updates are applied to the operating system image.

Parameter properties

Type:	DateTime
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

NewScheduleByInputObject

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

NewScheduleByName

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

NewScheduleById

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

NewScheduleByScheduleInputObject

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-DisableWildcardHandling

This parameter treats wildcard characters as literal character values. You can't combine it with ForceWildcardHandling.

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ForceWildcardHandling

This parameter processes wildcard characters and may lead to unexpected behavior (not recommended). You can't combine it with DisableWildcardHandling.

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Id

Specifies the ID of an operating system image.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	PackageId

Parameter sets

NewScheduleByIdRunNow

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-InputObject

Specifies an operating system image object. To obtain an operating system image object, use the Get-CMOperatingSystemImage cmdlet.

Parameter properties

Type:	IResultObject
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

NewScheduleByInputObject

Position:	Named
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

NewScheduleByInputObjectRunNow

Position:	Named
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Name

Specifies the name of an operating system image.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

NewScheduleByNameRunNow

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-RemoveSupersededUpdates

{{ Fill RemoveSupersededUpdates Description }}

Parameter properties

Type:	Boolean
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	CleanUp

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-RunNow

Indicates that the update should run now.

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

NewScheduleByIdRunNow

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

NewScheduleByInputObjectRunNow

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

NewScheduleByNameRunNow

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

NewScheduleByScheduleInputObjectRunNow

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-SoftwareUpdate

Specifies an array of software update objects. To obtain a software update object, use the Get-CMSoftwareUpdate cmdlet.

Parameter properties

Type:	IResultObject[]
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-UpdateDistributionPoint

Indicates whether the operating system image on distribution points is updated after the software updates are applied.

Parameter properties

Type:	Boolean
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	UpdateDistributionPointsWithImage, UpdateDistributionPoints

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Utc

Indicates whether to use UTC time.

Parameter properties

Type:	Boolean
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

NewScheduleByInputObject

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

NewScheduleByName

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

NewScheduleById

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

NewScheduleByScheduleInputObject

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet doesn't run.

Parameter properties

Type:	SwitchParameter
Default value:	False
Supports wildcards:	False
DontShow:	False
Aliases:	wi

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

CommonParameters

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

Inputs

Microsoft.ConfigurationManagement.ManagementProvider.IResultObject

Outputs

IResultObject

Related Links

• Get-CMOperatingSystemImageUpdateSchedule
• Clear-CMOperatingSystemImageUpdateSchedule