New-CMTSStepApplyWindowsSetting
Create an Apply Windows Settings step, which you can add to a task sequence.
Syntax
New-CMTSStepApplyWindowsSetting
[-InputLocale <String>]
-OrganizationName <String>
[-Password <SecureString>]
[-ProductKey <String>]
[-SystemLocale <String>]
[-TimeZone <TimeZoneInfo>]
[-UILanguage <String>]
[-UILanguageFallback <String>]
[-UserLocale <String>]
-UserName <String>
[-Condition <IResultObject[]>]
[-ContinueOnError]
[-Description <String>]
[-Disable]
-Name <String>
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
This cmdlet creates a new Apply Windows Settings step object. Then use the Add-CMTaskSequenceStep cmdlet to add the step to a task sequence. For more information on this step, see About task sequence steps: Apply Windows Settings.
Note
Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.
Examples
Example 1
This example first gets a time zone object. The next line creates an object for the Apply Windows Settings step that specifies various location-specific settings. It then gets a task sequence object, and adds this new step to the task sequence at index 11.
$tz = Get-TimeZone -Id "Russian Standard Time"
$step = New-CMTSStepApplyWindowsSetting -Name "Apply Windows Settings for Moscow office" -UserName "Natalia Ivanovna" -OrganizationName "Contoso" -TimeZone $tz -InputLocale "ru-ru" -SystemLocale "ru-ru" -UILanguage "ru-ru" UserLocale "ru-ru"
$tsNameOsd = "Default OS deployment"
$tsOsd = Get-CMTaskSequence -Name $tsNameOsd -Fast
$tsOsd | Add-CMTaskSequenceStep -Step $step -InsertStepStartIndex 11Parameters
-Condition
Specify a condition object to use with this step. To get this object, use one of the task sequence condition cmdlets. For example, Get-CMTSStepConditionVariable.
| Type: | IResultObject[] |
| Aliases: | Conditions |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ContinueOnError
Add this parameter to enable the step option Continue on error. When you enable this option, if the step fails, the task sequence continues.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Description
Specify an optional description for this task sequence step.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Disable
Add this parameter to disable this task sequence step.
| Type: | SwitchParameter |
| Aliases: | DisableThisStep |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DisableWildcardHandling
This parameter treats wildcard characters as literal character values. You can't combine it with ForceWildcardHandling.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ForceWildcardHandling
This parameter processes wildcard characters and may lead to unexpected behavior (not recommended). You can't combine it with DisableWildcardHandling.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InputLocale
Use this parameter to set the locale setting for the default keyboard layout. For example, to set it to Russian (Russia), specify the string ru-ru: -InputLocale "ru-ru"
For more information on these Windows setup answer file values, see Microsoft-Windows-International-Core.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Name
Specify a name for this step to identify it in the task sequence.
| Type: | String |
| Aliases: | StepName |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-OrganizationName
Specify the registered organization name to associate with the destination computer.
| Type: | String |
| Aliases: | RegisteredOrganizationName |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Password
To enable the local Administrator account, use this parameter to specify its password. If you don't include this parameter, the local account is disabled by default with a randomly generated password.
| Type: | SecureString |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ProductKey
Specify the product key to use for the Windows installation on the destination computer.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SystemLocale
Use this parameter to set the language for non-Unicode programs. For example, to set it to Russian (Russia), specify the string ru-ru: -SystemLocale "ru-ru"
For more information on these Windows setup answer file values, see Microsoft-Windows-International-Core.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-TimeZone
Specify the time zone to configure on the destination computer. To get this object, use the Get-TimeZone built-in cmdlet.
| Type: | TimeZoneInfo |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-UILanguage
Use this parameter to set the system default user interface (UI) language. For example, to set it to Russian (Russia), specify the string ru-ru: -UILanguage "ru-ru"
For more information on these Windows setup answer file values, see Microsoft-Windows-International-Core.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-UILanguageFallback
Use this parameter to set the fallback language if the system default UI language is only partially localized. For example, to set it to Russian (Russia), specify the string ru-ru: -UILanguageFallback "ru-ru"
For more information on these Windows setup answer file values, see Microsoft-Windows-International-Core.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-UserLocale
Use this parameter to set the per-user settings used for formatting dates, times, currency, and numbers. For example, to set it to Russian (Russia), specify the string ru-ru: -UserLocale "ru-ru"
For more information on these Windows setup answer file values, see Microsoft-Windows-International-Core.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-UserName
Specify the registered user name to associate with the destination computer.
| Type: | String |
| Aliases: | RegisteredUserName |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet doesn't run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
None
Outputs
IResultObject
Notes
For more information on this return object and its properties, see SMS_TaskSequence_ApplyWindowsSettingsAction server WMI class.
Related Links
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for