Get-VpnS2SInterface
Retrieves configuration details for a site-to-site (S2S) interface.
Syntax
Default (Default)
Get-VpnS2SInterface
[[-Name] <String>]
[[-RoutingDomain] <String>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>]
Description
The Get-VpnS2SInterface cmdlet retrieves details for a site-to-site (S2S) interface.
Examples
EXAMPLE 1
PS C:\> Get-VpnS2SInterface
Name Destination AdminStatus ConnectionState IPv4Subnet
---- ----------- ----------- --------------- ----------
edge1 {131.107.0.2} True Disconnected {10.0.0.0/24:100}
This example retrieves all of the S2S VPN interfaces.
EXAMPLE 2
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 :
This example retrieves all of the S2S VPN interfaces and displays the interfaces in list format.
EXAMPLE 3
PS C:\>Get-VpnS2SInterface -Name edge1
Name Destination AdminStatus ConnectionState IPv4Subnet
---- ----------- ----------- --------------- ----------
edge1 {131.107.0.2} True Disconnected {10.0.0.0/24:100}
This example retrieves details of interface named edge1.
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 |
-Name
Specifies the name of the connection.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | ElementName |
Parameter sets
(All)
| Position: | 1 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-RoutingDomain
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.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | RoutingDomainName |
Parameter sets
(All)
| Position: | 2 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| 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 |
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
String
Outputs
CimInstance
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.