Export (0) Print
Expand All
Expand Minimize
This topic has not yet been rated - Rate this topic

Get-VpnS2SInterface

Windows Server 2012 R2 and Windows 8.1

Updated: October 17, 2013

Applies To: Windows 8.1, Windows PowerShell 4.0, Windows Server 2012 R2

Get-VpnS2SInterface

Retrieves configuration details for a site-to-site (S2S) interface.

Syntax

Parameter Set: Get2
Get-VpnS2SInterface [[-Name] <String> ] [[-RoutingDomain] <String> ] [-AsJob] [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]




Detailed Description

The Get-VpnS2SInterface cmdlet retrieves details for a site-to-site (S2S) interface.

Parameters

-AsJob

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

-Name<String>

Specifies the name of the connection.


Aliases

ElementName

Required?

false

Position?

2

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-RoutingDomain<String>

Specifies an ID, as a string, for a routing domain. The ID of a routing domain is a user-defined alphanumeric string. Do not use this parameter with the Name parameter.


Aliases

RoutingDomainName

Required?

false

Position?

3

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

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

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • None

Outputs

The output type is the type of the objects that the cmdlet emits.

  • Microsoft.Management.Infrastructure.CimInstance#VpnS2SInterface[]

    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.


Examples

EXAMPLE 1

This example retrieves all of the S2S VPN interfaces.


PS C:\> Get-VpnS2SInterface
Name                 Destination          AdminStatus  ConnectionState IPv4Subnet 
----                 -----------          -----------  --------------- ---------- 
edge1                {131.107.0.2}        True         Disconnected    {10.0.0.0/24:100} 

EXAMPLE 2

This example retrieves all of the S2S VPN interfaces and displays the interfaces in list format.


PS C:\> Get-VpnS2SInterface | Format-List -Property *
Name                             : edge1 
Destination                      : {131.107.0.2} 
AdminStatus                      : True 
ConnectionState                  : Disconnected 
IPv4Subnet                       : {10.0.0.0/24:100} 
IPv6Subnet                       : {2001:db8:1::/48:100} 
Protocol                         : Ikev2 
EncryptionType                   : RequireEncryption 
AuthenticationMethod             : PSKOnly 
EapMethod                        : 
Certificate                      : 
UserName                         : 
ResponderAuthenticationMethod    : PSKOnly 
NumberOfTries                    : 3 
RetryInterval(s)                 : 60 
SADataSizeForRenegotiation(KB)   : 33553408 
SALifeTime(s)                    : 3600 
NetworkOutageTime(s)             : 15 
IdleDisconnect(s)                : 300 
InternalIPv4                     : True 
InternalIPv6                     : True 
PromoteAlternate                 : False 
LastError                        : 0 
UnReachabilityReasons            : 
CustomPolicy                     : 
AuthenticationTransformConstants : 
DHGroup                          : 
CipherTransformConstants         : 
EncryptionMethod                 : 
IntegrityCheckMethod             : 
PfsGroup                         : 

EXAMPLE 3

This example retrieves details of interface named edge1.


PS C:\> Get-VpnS2SInterface -Name edge1
Name                 Destination          AdminStatus  ConnectionState IPv4Subnet 
----                 -----------          -----------  --------------- ---------- 
edge1                {131.107.0.2}        True         Disconnected    {10.0.0.0/24:100} 

Related topics

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.