Set-CMOperatingSystemInstaller
Changes configuration settings of OS upgrade packages.
Syntax
SetById (Default)
Set-CMOperatingSystemInstaller
-Id <String>
[-CopyToPackageShareOnDistributionPoint <Boolean>]
[-CustomPackageShareName <String>]
[-Description <String>]
[-DisconnectUserFromDistributionPoint <Boolean>]
[-DisconnectUserFromDistributionPointMins <UInt32>]
[-DisconnectUserFromDistributionPointRetryCount <UInt32>]
[-DistributionPointUpdateSchedule <IResultObject>]
[-EnableBinaryDeltaReplication <Boolean>]
[-MulticastAllow <Boolean>]
[-MulticastEncrypt <Boolean>]
[-MulticastTransferOnly <Boolean>]
[-NewName <String>]
[-PassThru]
[-Path <String>]
[-PersistContentInCache <Boolean>]
[-PrestageBehavior <PrestageBehavior>]
[-Priority <Priority>]
[-Reload]
[-SendToPreferredDistributionPoint <Boolean>]
[-Version <String>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
SetByValueMandatory
Set-CMOperatingSystemInstaller
-InputObject <IResultObject>
[-CopyToPackageShareOnDistributionPoint <Boolean>]
[-CustomPackageShareName <String>]
[-Description <String>]
[-DisconnectUserFromDistributionPoint <Boolean>]
[-DisconnectUserFromDistributionPointMins <UInt32>]
[-DisconnectUserFromDistributionPointRetryCount <UInt32>]
[-DistributionPointUpdateSchedule <IResultObject>]
[-EnableBinaryDeltaReplication <Boolean>]
[-MulticastAllow <Boolean>]
[-MulticastEncrypt <Boolean>]
[-MulticastTransferOnly <Boolean>]
[-NewName <String>]
[-PassThru]
[-Path <String>]
[-PersistContentInCache <Boolean>]
[-PrestageBehavior <PrestageBehavior>]
[-Priority <Priority>]
[-Reload]
[-SendToPreferredDistributionPoint <Boolean>]
[-Version <String>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
SetByName
Set-CMOperatingSystemInstaller
-Name <String>
[-CopyToPackageShareOnDistributionPoint <Boolean>]
[-CustomPackageShareName <String>]
[-Description <String>]
[-DisconnectUserFromDistributionPoint <Boolean>]
[-DisconnectUserFromDistributionPointMins <UInt32>]
[-DisconnectUserFromDistributionPointRetryCount <UInt32>]
[-DistributionPointUpdateSchedule <IResultObject>]
[-EnableBinaryDeltaReplication <Boolean>]
[-MulticastAllow <Boolean>]
[-MulticastEncrypt <Boolean>]
[-MulticastTransferOnly <Boolean>]
[-NewName <String>]
[-PassThru]
[-Path <String>]
[-PersistContentInCache <Boolean>]
[-PrestageBehavior <PrestageBehavior>]
[-Priority <Priority>]
[-Reload]
[-SendToPreferredDistributionPoint <Boolean>]
[-Version <String>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Set-CMOperatingSystemInstaller cmdlet changes configuration settings of one or more OS upgrade packages in Configuration Manager. An OS upgrade package contains all the files that Configuration Manager needs to install a Windows OS on a reference computer.
Note
Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.
Examples
Example 1: Change settings for an OS upgrade package by using a name
This command changes configuration settings of the OS upgrade package named Win8x64. The command renames the OS upgrade package, adds a version and description, and specifies the path to the installation source files of the OS upgrade package.
Set-CMOperatingSystemInstaller -Name "Win8x64" -NewName "OsiWin8x64" -Version "I20B" -Description "Dept02 Sys Install" -Path "\\Win2k3X64contoso\Public\OSD\win8x64"
Example 2: Add an OS upgrade package to a security scope by using a name
This command adds membership to the security scope named SecScope02 for the OS upgrade package named InstPkg01.
Set-CMOperatingSystemInstaller -SecurityScopeAction AddMembership -SecurityScopeName "SecScope02" -Name "InstPkg01"
Example 3: Remove an OS upgrade package from a security scope
This command removes membership to the security scope named SecScope02 for the OS upgrade package named InstPkg01.
Set-CMOperatingSystemInstaller -SecurityScopeAction RemoveMembership -SecurityScopeName "SecScope02" -Name "InstPkg01"
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 |
-CopyToPackageShareOnDistributionPoint
The Set-CMOperatingSystemInstaller cmdlet changes configuration settings of one or more OS upgrade packages in Configuration Manager. An OS upgrade package contains all the files that Configuration Manager needs to install a Windows OS on a reference computer.
Note
Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | CopyToPackageShareOnDistributionPoints |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-CustomPackageShareName
The Set-CMOperatingSystemInstaller cmdlet changes configuration settings of one or more OS upgrade packages in Configuration Manager. An OS upgrade package contains all the files that Configuration Manager needs to install a Windows OS on a reference computer.
Note
Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.
Parameter properties
| Type: | String |
| 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 |
-Description
Specifies a description for the OS upgrade package.
Parameter properties
| Type: | String |
| 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 |
-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 |
-DisconnectUserFromDistributionPoint
The Set-CMOperatingSystemInstaller cmdlet changes configuration settings of one or more OS upgrade packages in Configuration Manager. An OS upgrade package contains all the files that Configuration Manager needs to install a Windows OS on a reference computer.
Note
Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | DisconnectUsersFromDistributionPoints |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-DisconnectUserFromDistributionPointMins
The Set-CMOperatingSystemInstaller cmdlet changes configuration settings of one or more OS upgrade packages in Configuration Manager. An OS upgrade package contains all the files that Configuration Manager needs to install a Windows OS on a reference computer.
Note
Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.
Parameter properties
| Type: | UInt32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | DisconnectUsersFromDistributionPointsMinutes |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-DisconnectUserFromDistributionPointRetryCount
The Set-CMOperatingSystemInstaller cmdlet changes configuration settings of one or more OS upgrade packages in Configuration Manager. An OS upgrade package contains all the files that Configuration Manager needs to install a Windows OS on a reference computer.
Note
Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.
Parameter properties
| Type: | UInt32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | DisconnectUsersFromDistributionPointsRetries |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-DistributionPointUpdateSchedule
The Set-CMOperatingSystemInstaller cmdlet changes configuration settings of one or more OS upgrade packages in Configuration Manager. An OS upgrade package contains all the files that Configuration Manager needs to install a Windows OS on a reference computer.
Note
Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.
Parameter properties
| Type: | IResultObject |
| 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 |
-EnableBinaryDeltaReplication
The Set-CMOperatingSystemInstaller cmdlet changes configuration settings of one or more OS upgrade packages in Configuration Manager. An OS upgrade package contains all the files that Configuration Manager needs to install a Windows OS on a reference computer.
Note
Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.
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 |
-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 an array of IDs of OS upgrade packages.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | PackageId |
Parameter sets
SetById
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-InputObject
Specifies a CMOperatingSystemInstaller object. To obtain a CMOperatingSystemInstaller object, use the Get-CMOperatingSystemInstaller cmdlet.
Parameter properties
| Type: | IResultObject |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
SetByValueMandatory
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-MulticastAllow
The Set-CMOperatingSystemInstaller cmdlet changes configuration settings of one or more OS upgrade packages in Configuration Manager. An OS upgrade package contains all the files that Configuration Manager needs to install a Windows OS on a reference computer.
Note
Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.
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 |
-MulticastEncrypt
The Set-CMOperatingSystemInstaller cmdlet changes configuration settings of one or more OS upgrade packages in Configuration Manager. An OS upgrade package contains all the files that Configuration Manager needs to install a Windows OS on a reference computer.
Note
Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.
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 |
-MulticastTransferOnly
The Set-CMOperatingSystemInstaller cmdlet changes configuration settings of one or more OS upgrade packages in Configuration Manager. An OS upgrade package contains all the files that Configuration Manager needs to install a Windows OS on a reference computer.
Note
Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.
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 |
-Name
Specifies the name of an OS upgrade package.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
SetByName
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-NewName
Specifies the new name of an OS upgrade package.
Parameter properties
| Type: | String |
| 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 |
-PassThru
Add this parameter to return an object that represents the item with which you're working. By default, this cmdlet may not generate any output.
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 |
-Path
Specifies the network path to the installation source files of an OS upgrade package.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | PackageSourcePath |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-PersistContentInCache
The Set-CMOperatingSystemInstaller cmdlet changes configuration settings of one or more OS upgrade packages in Configuration Manager. An OS upgrade package contains all the files that Configuration Manager needs to install a Windows OS on a reference computer.
Note
Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.
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 |
-PrestageBehavior
The Set-CMOperatingSystemInstaller cmdlet changes configuration settings of one or more OS upgrade packages in Configuration Manager. An OS upgrade package contains all the files that Configuration Manager needs to install a Windows OS on a reference computer.
Note
Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.
Parameter properties
| Type: | PrestageBehavior |
| Default value: | None |
| Accepted values: | ManualCopy, DownloadDelta, OnDemand |
| 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 |
-Priority
Specifies a change for the priority of the deployment type. Valid values are: Increase and Decrease.
Parameter properties
| Type: | Priority |
| Default value: | None |
| Accepted values: | High, Medium, Low |
| 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 |
-Reload
Applies to version 2006 and later. If you change the image properties using an external tool, use this option to reload the information in the site database.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | ReloadImage |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-SendToPreferredDistributionPoint
The Set-CMOperatingSystemInstaller cmdlet changes configuration settings of one or more OS upgrade packages in Configuration Manager. An OS upgrade package contains all the files that Configuration Manager needs to install a Windows OS on a reference computer.
Note
Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | SendToPreferredDistributionPoints |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Version
Specifies the version of an OS upgrade package.
Parameter properties
| Type: | String |
| 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 |
-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.