Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Set-NetTeredoConfiguration

Set-NetTeredoConfiguration

msft_netteredoconfiguration.cdxml

Synopsis

Modifies the Teredo configuration of a computer or a Group Policy object (GPO).

Syntax

Set-NetTeredoConfiguration [-Type] [-ServerName] [-RefreshIntervalSeconds] [-ClientPort] [-ServerVirtualIP] [-DefaultQualified] [-ServerShunt] [-AsJob] [-CimSession] [-GPOSession] [-IPInterface] [-PassThru] [-PolicyStore] [-ThrottleLimit] [-Confirm] [-WhatIf] [<CommonParameters>]

Set-NetTeredoConfiguration [-Type] [-ServerName] [-RefreshIntervalSeconds] [-ClientPort] [-ServerVirtualIP] [-DefaultQualified] [-ServerShunt] [-AsJob] [-CimSession] [-PassThru] [-ThrottleLimit] [-InputObject] [-Confirm] [-WhatIf] [<CommonParameters>]

Detailed Description

The Set-NetTeredoConfiguration cmdlet modifies the Teredo configuration of either a computer or a Group Policy Object (GPO).

Parameters

-AsJob <SwitchParameter>

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet. For more information about Windows PowerShell® background jobs, see about_Jobs.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-CimSession <CimSession[]>

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.

Aliases

Session

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-ClientPort <UInt32>

Specifies the UDP port of the client computer. If this parameter is not specified, then the port is chosen by the operating system.

Aliases

None

Required?

false

Position

5

Default value

False

Accept pipeline input?

false

Accept wildcard characters?

false

-DefaultQualified <Boolean>

Determines if this cmdlet qualifies Teredo by default. The default value is False. This parameter can only be specified on GPOs.

Aliases

None

Required?

false

Position

7

Default value

False

Accept pipeline input?

false

Accept wildcard characters?

false

-GPOSession <String>

Specifies the Group Policy session to which to store the configuration information. You can use this parameter with the NetGPO cmdlets to aggregate multiple operations performed on a GPO. You cannot use this parameter with the PolicyStore parameter.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-InputObject <CimInstance[]>

Specifies the object which contains the Teredo configuration information to modify.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

True (ByValue)

Accept wildcard characters?

false

-IPInterface <CimInstance>

Specifies the interface on which to set the Teredo configuration. If the specified interface is not a Teredo interface, then the cmdlet does not return any configuration.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByValue)

Accept wildcard characters?

false

-PassThru <SwitchParameter>

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-PolicyStore <String>

Specifies the policy store that contains the configuration to set. The acceptable values for this parameter are:  -- PersistentStore -- GPO The default value is PersistentStore. To set the configuration of a GPO, specify the GPO name using the following format: Domain\GPOName You cannot use this parameter with the GPOSession parameter.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-RefreshIntervalSeconds <UInt32>

Specifies the client refresh interval in seconds.

Aliases

RefreshInterval

Required?

false

Position

4

Default value

False

Accept pipeline input?

false

Accept wildcard characters?

false

-ServerName <String>

Specifies the name or IPv4 address of the Teredo server.

Aliases

None

Required?

false

Position

3

Default value

False

Accept pipeline input?

false

Accept wildcard characters?

false

-ServerShunt <Boolean>

Indicates that the tunnel miniport and IPv4 routing layer are bypassed for high throughput on the Teredo relay functionality of the Teredo server.

Aliases

None

Required?

false

Position

8

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-ServerVirtualIP <String>

Specifies the virtual IPv4 address of the server. This parameter is not applicable if the computer is a Teredo client. This parameter can only be specified on GPOs.

Aliases

None

Required?

false

Position

6

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-ThrottleLimit <Int32>

Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Type <Type>

Specifies the state of Teredo. The acceptable values for this parameter are:  -- Disabled: Disables the Teredo service. -- Client: Enables the Teredo client. -- Enterpriseclient: Skips the managed network detection. -- Server: Enables the Teredo server. -- Default: The default state is client.

Aliases

None

Required?

false

Position

2

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Confirm <SwitchParameter>

Prompts you for confirmation before running the cmdlet.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

-WhatIf <SwitchParameter>

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type

None

Return Type

Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\MSFT_NetTeredoConfiguration

Notes

None

Examples

Example 1: Set the Teredo server name

This command sets the Teredo server name to Test on the local persistent store.

PS C:\>Set-NetTeredoConfiguration -ServerName "Test"

Example 2: Set the Teredo state

This command sets the Teredo state to enterpriseclient in a GPO named Domain\GPOname.

PS C:\>Set-NetTeredoConfiguration -Type enterpriseclient -PolicyStore "Domain\GPOname"

Online Version
Get-NetTeredoConfiguration
Reset-NetTeredoConfiguration