Get-CMTSStepCaptureNetworkSettings
Get the Capture Network Settings step from a specific task sequence.
Syntax
ByValue (Default)
Get-CMTSStepCaptureNetworkSettings
[-InputObject] <IResultObject>
[-StepName <String>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ById
Get-CMTSStepCaptureNetworkSettings
[-TaskSequenceId] <String>
[-StepName <String>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByName
Get-CMTSStepCaptureNetworkSettings
[-TaskSequenceName] <String>
[-StepName <String>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Use this cmdlet to get a task sequence step object for one or more instances of the Capture Network Settings step. You can use this object to:
- Remove the step from a task sequence with Remove-CMTSStepCaptureNetworkSettings
- Copy the step to another task sequence with Add-CMTaskSequenceStep
For more information on this step, see About task sequence steps: Capture Network 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 task sequence object in the $tsOsd variable. It then passes that variable as the input object to get the Capture Network Settings step.
$tsNameOsd = "Default OS deployment"
$tsOsd = Get-CMTaskSequence -Name $tsNameOsd -Fast
$tsStepNameCapNetSet = "Capture Network Settings"
$tsStepCapNetSet = Get-CMTSStepCaptureNetworkSettings -InputObject $tsOsd -StepName $tsStepNameCapNetSet
Parameters
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| 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 |
-InputObject
Specify a task sequence object from which to get the Capture Network Settings step. To get this object, use the Get-CMTaskSequence cmdlet.
Parameter properties
| Type: | IResultObject |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | TaskSequence |
Parameter sets
ByValue
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-StepName
Specify the name of the Capture Network Settings step to get from the task sequence.
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 |
-TaskSequenceId
Specify the package ID of the task sequence from which to get the Capture Network Settings step. This value is a standard package ID, for example XYZ00858.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | Id, TaskSequencePackageId |
Parameter sets
ById
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-TaskSequenceName
Specify the name of the task sequence from which to get the Capture Network Settings step.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByName
| Position: | 0 |
| Mandatory: | True |
| 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: | None |
| 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.