Edit

Share via

Set-NetTeredoConfiguration

Module:
NetworkTransition Module

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

Syntax

ByName (Default) 

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

InputObject (cdxml) 

Set-NetTeredoConfiguration
    [[-Type] <Type>]
    [[-ServerName] <String>]
    [[-RefreshIntervalSeconds] <UInt32>]
    [[-ClientPort] <UInt32>]
    [[-ServerVirtualIP] <String>]
    [[-DefaultQualified] <Boolean>]
    [[-ServerShunt] <Boolean>]
    -InputObject <CimInstance[]>
    [-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.

Parameters

-AsJob

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

Parameter properties

Type:SwitchParameter
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

-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.

Parameter properties

Type:

CimSession[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:Session

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:UInt32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:4
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:False
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

-DefaultQualified

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

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:6
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InputObject

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

Parameter properties

Type:

CimInstance[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

InputObject (cdxml)
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:CimInstance
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByName
Position:Named
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-PassThru

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

Parameter properties

Type:SwitchParameter
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

-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.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RefreshIntervalSeconds

Specifies the client refresh interval in seconds.

Parameter properties

Type:UInt32
Default value:None
Supports wildcards:False
DontShow:False
Aliases:RefreshInterval

Parameter sets

(All)
Position:3
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ServerName

Specifies the name or IPv4 address of the Teredo server.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:2
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:7
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:5
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:Int32
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

-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.

Parameter properties

Type:Type
Default value:None
Accepted values:Default, Relay, Client, Server, Disabled, Automatic, Enterpriseclient, Natawareclient
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:1
Mandatory:False
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 is not run.

Parameter properties

Type:SwitchParameter
Default value:False
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.

Inputs

None

This cmdlet accepts no input objects.

Outputs

CimInstance

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.