Edit

Get-CMTSStepApplyNetworkSetting

  • Reference
Module:
ConfigurationManager

Get the Apply Network Settings step from a specific task sequence.

Syntax

Get-CMTSStepApplyNetworkSetting
   [-InputObject] <IResultObject>
   [-StepName <String>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Get-CMTSStepApplyNetworkSetting
   [-TaskSequenceId] <String>
   [-StepName <String>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Get-CMTSStepApplyNetworkSetting
   [-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 Apply Network Settings step. You can use this object to:

For more information on this step, see About task sequence steps: Apply 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: Get the Apply Network Settings step from a task sequence

This example first gets a task sequence object in the $tsOsd variable. It then passes that variable as the input object to get the Apply Network Settings step.

$tsNameOsd = "Default OS deployment"
$tsOsd = Get-CMTaskSequence -Name $tsNameOsd -Fast

$tsStepNameApplyNetSet = "Apply Network Settings"
$tsStepApplyNetSet = Get-CMTSStepApplyNetworkSetting -InputObject $tsOsd -StepName $tsStepNameApplyNetSet

Example 2: Get the network adapter details for an Apply Network Settings step

This example builds on the previous example. To view the first network adapter settings, reference the Adapters property, which is an array of SMS_TaskSequence_NetworkAdapterSettings objects.

$tsStepApplyNetSet = Get-CMTSStepApplyNetworkSetting -InputObject $tsOsd -StepName $tsStepNameApplyNetSet

$tsStepApplyNetSet.Adapters[0]

Parameters

-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

-InputObject

Specify a task sequence object from which to get the Apply Network Settings step. To get this object, use the Get-CMTaskSequence cmdlet.

Type:IResultObject
Aliases:TaskSequence
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-StepName

Specify the name of the Apply Network Settings step to get from the task sequence.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-TaskSequenceId

Specify the package ID of the task sequence from which to get the Apply Network Settings step. This value is a standard package ID, for example XYZ00858.

Type:String
Aliases:Id, TaskSequencePackageId
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-TaskSequenceName

Specify the name of the task sequence from which to get the Apply Network Settings step.

Type:String
Position:0
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

Microsoft.ConfigurationManagement.ManagementProvider.IResultObject

Outputs

System.Object