Set-Net Teredo Configuration

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

Syntax 

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

Description

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

Examples

Example 1: Set the Teredo server name 

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

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

Example 2: Set the Teredo state 

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

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

Required Parameters

-InputObject

Specifies the input object that is used in a pipeline command.

Type: CimInstance[]
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

Optional Parameters

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.

Type: SwitchParameter
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-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.

Type: CimSession[]
Aliases: Session
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ClientPort

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

Type: UInt32
Position: 4
Default value: None
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: False
Accept pipeline input: False
Accept wildcard characters: False
-DefaultQualified

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

Type: Boolean
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-GPOSession

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.

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

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.

Type: CimInstance
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-PassThru

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

Type: SwitchParameter
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-PolicyStore

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.

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

Specifies the client refresh interval in seconds.

Type: UInt32
Aliases: RefreshInterval
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ServerName

Specifies the name or IPv4 address of the Teredo server.

Type: String
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ServerShunt

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

Type: Boolean
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ServerVirtualIP

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.

Type: String
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ThrottleLimit

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.

Type: Int32
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-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.
  • Relay.
  • Automatic.
  • Default. The default state is client.
Type: Type
Parameter Sets: Default, Relay, Client, Server, Disabled, Automatic, Enterpriseclient, Natawareclient
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-WhatIf

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

Type: SwitchParameter
Aliases: wi
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

Inputs

None

This cmdlet accepts no input objects.

Outputs

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

The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign ( # ) provides the namespace and class name for the underlying WMI object.

When the Passthru parameter is specified, this cmdlet outputs a modified Teredo configuration object.