external help file | Module Name | ms.date | online version | schema |
---|---|---|---|---|
AdminUI.PS.dll-Help.xml |
ConfigurationManager |
08/12/2021 |
2.0.0 |
Create a Connect To Network Folder step, which you can add to a task sequence.
New-CMTSStepConnectNetworkFolder [-Drive <String>] -Path <String> -UserName <String>
[-UserPassword <SecureString>] [-Condition <IResultObject[]>] [-ContinueOnError] [-Description <String>]
[-Disable] -Name <String> [-DisableWildcardHandling] [-ForceWildcardHandling] [-WhatIf] [-Confirm]
[<CommonParameters>]
This cmdlet creates a new Connect To Network Folder 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: Connect To Network Folder.
Note
Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>
. For more information, see getting started.
This example first uses the ConvertTo-SecureString built-in cmdlet to create a secure string for the user password. This method is used here as a simple example, but not the most secure since the plain text password is in the script. For more information on this cmdlet and other options, see ConvertTo-SecureString.
The next line creates an object for the Connect To Network Folder step, which connects the Z: drive to a network share as the _osdnetfolder service account.
It then gets a task sequence object, and adds this new step to the task sequence at index 11.
$Secure_String_Pwd = ConvertTo-SecureString "P@ssW0rD!" -AsPlainText -Force
$step = New-CMTSStepConnectNetworkFolder -Name "Connect To Network Folder" -Drive "Z:" -Path "\\server\share$" -UserName "contoso\_osdnetfolder" -UserPassword $Secure_String_Pwd
$tsNameOsd = "Default OS deployment"
$tsOsd = Get-CMTaskSequence -Name $tsNameOsd -Fast
$tsOsd | Add-CMTaskSequenceStep -Step $step -InsertStepStartIndex 11
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[]
Parameter Sets: (All)
Aliases: Conditions
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
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
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specify an optional description for this task sequence step.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Add this parameter to disable this task sequence step.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: DisableThisStep
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
This parameter treats wildcard characters as literal character values. You can't combine it with ForceWildcardHandling.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specify the local drive letter to assign for this connection.
Type: String
Parameter Sets: (All)
Aliases: DriveLetter
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
This parameter processes wildcard characters and may lead to unexpected behavior (not recommended). You can't combine it with DisableWildcardHandling.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specify a name for this step to identify it in the task sequence.
Type: String
Parameter Sets: (All)
Aliases: StepName
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specify the network folder path. Use the format \\server\share
.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specify the user account with permissions to connect to this network folder. Also use the UserPassword parameter.
For more information on this account, see the task sequence network folder connection account.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specify the password for the UserName.
Type: SecureString
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Prompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Shows what would happen if the cmdlet runs. The cmdlet doesn't run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
For more information on this return object and its properties, see SMS_TaskSequence_ConnectNetworkFolderAction server WMI class.
Get-CMTSStepConnectNetworkFolder Remove-CMTSStepConnectNetworkFolder Set-CMTSStepConnectNetworkFolder