Set-GatewayTunnel
{{ Fill in the Synopsis }}
Syntax
Default (Default)
Set-GatewayTunnel
[-TunnelName] <String>
[[-RoutingDomainName] <String>]
[[-LocalIp] <String>]
[[-RemoteIp] <String>]
[[-TunnelIdentity] <String>]
[[-Routes] <String>]
[[-LocalExemptRoutes] <String>]
[[-RemoteExemptRoutes] <String>]
[-LocalSubnets <String>]
[-Standby <Boolean>]
[-AdminStatus <Boolean>]
[-AutoConnectEnabled <Boolean>]
[-ProtocolType <ProtocolType>]
[-EncryptionType <EncryptionType>]
[-IpsecEncryption <IpsecEncryption>]
[-IpsecIntegrity <IpsecIntegrity>]
[-Pfsgroup <Pfsgroup>]
[-IkeEncryption <IkeEncryption>]
[-IkeIntegrity <IkeIntegrity>]
[-Dhgroup <Dhgroup>]
[-MMSALifeTimeInSeconds <UInt32>]
[-SALifeTimeInSeconds <UInt32>]
[-SALifeKilloBytes <UInt32>]
[[-SharedSecret] <String>]
[-DpdTimeout <UInt32>]
[-UseNarrowTrafficSelectors <Boolean>]
[-IsConnectionNATed <Boolean>]
[-ConnectReason <ConnectReason>]
[-TunnelId <String>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>]
Description
{{ Fill in the Description }}
Examples
Example 1
PS C:\> {{ Add example code here }}
{{ Add example description here }}
Parameters
-AdminStatus
{{ Fill AdminStatus Description }}
Parameter properties
Type: Boolean
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: True Value from remaining arguments: False
-AsJob
{{ Fill AsJob Description }}
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
-AutoConnectEnabled
{{ Fill AutoConnectEnabled Description }}
Parameter properties
Type: Boolean
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: True Value from remaining arguments: False
-CimSession
{{ Fill CimSession Description }}
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
-ConnectReason
{{ Fill ConnectReason Description }}
Parameter properties
Type: Microsoft.PowerShell.Cmdletization.GeneratedTypes.PS_GatewayTunnel.ConnectReason
Default value: None Accepted values: Unknown, ServiceTriggered, DataTriggered, UserTriggered, RemoteTriggered, RemoteCrashTriggered Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-Dhgroup
{{ Fill Dhgroup Description }}
Parameter properties
Type: Microsoft.PowerShell.Cmdletization.GeneratedTypes.PS_GatewayTunnel.Dhgroup
Default value: None Accepted values: None, DhGroup1, DhGroup2, DhGroup14 Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-DpdTimeout
{{ Fill DpdTimeout Description }}
Parameter properties
Type: UInt32
Default value: None Supports wildcards: False DontShow: False Aliases: Dpd
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-EncryptionType
{{ Fill EncryptionType Description }}
Parameter properties
Type: Microsoft.PowerShell.Cmdletization.GeneratedTypes.PS_GatewayTunnel.EncryptionType
Default value: None Accepted values: NoEncryption, StrongEncryption, RequiredEncryption, OptionalEncryption, CustomEncryption Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-IkeEncryption
{{ Fill IkeEncryption Description }}
Parameter properties
Type: Microsoft.PowerShell.Cmdletization.GeneratedTypes.PS_GatewayTunnel.IkeEncryption
Default value: None Accepted values: DES, DES3, AES128, AES192, AES256 Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-IkeIntegrity
{{ Fill IkeIntegrity Description }}
Parameter properties
Type: Microsoft.PowerShell.Cmdletization.GeneratedTypes.PS_GatewayTunnel.IkeIntegrity
Default value: None Accepted values: MD5, SHA1, SHA256, SHA384 Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-IpsecEncryption
{{ Fill IpsecEncryption Description }}
Parameter properties
Type: Microsoft.PowerShell.Cmdletization.GeneratedTypes.PS_GatewayTunnel.IpsecEncryption
Default value: None Accepted values: DES, DES3, AES128, AES192, AES256, GCMAES128, GCMAES192, GCMAES256, None Supports wildcards: False DontShow: False Aliases: Encryption
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-IpsecIntegrity
{{ Fill IpsecIntegrity Description }}
Parameter properties
Type: Microsoft.PowerShell.Cmdletization.GeneratedTypes.PS_GatewayTunnel.IpsecIntegrity
Default value: None Accepted values: MD5, SHA1, SHA256, GCMAES128, GCMAES192, GCMAES256 Supports wildcards: False DontShow: False Aliases: Auth
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-IsConnectionNATed
{{ Fill IsConnectionNATed Description }}
Parameter properties
Type: Boolean
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: True Value from remaining arguments: False
-LocalExemptRoutes
{{ Fill LocalExemptRoutes Description }}
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: 8 Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-LocalIp
{{ Fill LocalIp Description }}
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False Aliases: local
Parameter sets
(All)
Position: 4 Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-LocalSubnets
{{ Fill LocalSubnets Description }}
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False Aliases: LocalSubnet
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-MMSALifeTimeInSeconds
{{ Fill MMSALifeTimeInSeconds Description }}
Parameter properties
Type: UInt32
Default value: None Supports wildcards: False DontShow: False Aliases: MMSALifeTime
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-Pfsgroup
{{ Fill Pfsgroup Description }}
Parameter properties
Type: Microsoft.PowerShell.Cmdletization.GeneratedTypes.PS_GatewayTunnel.Pfsgroup
Default value: None Accepted values: None, PFS1, PFS2, PFS2048, ECP256, ECP384, MM, PFS24 Supports wildcards: False DontShow: False Aliases: Pfs
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-ProtocolType
{{ Fill ProtocolType Description }}
Parameter properties
Type: Microsoft.PowerShell.Cmdletization.GeneratedTypes.PS_GatewayTunnel.ProtocolType
Default value: None Accepted values: Ikev2, None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-RemoteExemptRoutes
{{ Fill RemoteExemptRoutes Description }}
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: 9 Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-RemoteIp
{{ Fill RemoteIp Description }}
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False Aliases: remote
Parameter sets
(All)
Position: 3 Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-Routes
{{ Fill Routes Description }}
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False Aliases: Route
Parameter sets
(All)
Position: 5 Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-RoutingDomainName
{{ Fill RoutingDomainName Description }}
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False Aliases: customer
Parameter sets
(All)
Position: 2 Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-SALifeKilloBytes
{{ Fill SALifeKilloBytes Description }}
Parameter properties
Type: UInt32
Default value: None Supports wildcards: False DontShow: False Aliases: SALifeKb
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-SALifeTimeInSeconds
{{ Fill SALifeTimeInSeconds Description }}
Parameter properties
Type: UInt32
Default value: None Supports wildcards: False DontShow: False Aliases: SALifeTime
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-SharedSecret
{{ Fill SharedSecret Description }}
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False Aliases: Presharedkey
Parameter sets
(All)
Position: 7 Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-Standby
{{ Fill Standby Description }}
Parameter properties
Type: Boolean
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: True Value from remaining arguments: False
-ThrottleLimit
{{ Fill ThrottleLimit Description }}
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
-TunnelId
{{ Fill TunnelId Description }}
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False Aliases: MMProviderContextKey
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-TunnelIdentity
{{ Fill TunnelIdentity Description }}
Parameter properties
Type: String
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: True Value from remaining arguments: False
-TunnelName
{{ Fill TunnelName Description }}
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False Aliases: Name
Parameter sets
(All)
Position: 1 Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-UseNarrowTrafficSelectors
{{ Fill UseNarrowTrafficSelectors Description }}
Parameter properties
Type: Boolean
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: True 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 .
Microsoft.PowerShell.Cmdletization.GeneratedTypes.PS_GatewayTunnel.ProtocolType
Microsoft.PowerShell.Cmdletization.GeneratedTypes.PS_GatewayTunnel.EncryptionType
Microsoft.PowerShell.Cmdletization.GeneratedTypes.PS_GatewayTunnel.IpsecEncryption
Microsoft.PowerShell.Cmdletization.GeneratedTypes.PS_GatewayTunnel.IpsecIntegrity
Microsoft.PowerShell.Cmdletization.GeneratedTypes.PS_GatewayTunnel.Pfsgroup
Microsoft.PowerShell.Cmdletization.GeneratedTypes.PS_GatewayTunnel.IkeEncryption
Microsoft.PowerShell.Cmdletization.GeneratedTypes.PS_GatewayTunnel.IkeIntegrity
Microsoft.PowerShell.Cmdletization.GeneratedTypes.PS_GatewayTunnel.Dhgroup
Microsoft.PowerShell.Cmdletization.GeneratedTypes.PS_GatewayTunnel.ConnectReason
Outputs