Get-NetworkControllerVirtualGatewayNetworkConnection
Gets a virtual gateway network connection.
Syntax
Default (Default)
Get-NetworkControllerVirtualGatewayNetworkConnection
[-VirtualGatewayId] <String[]>
[[-ResourceId] <String[]>]
-ConnectionUri <Uri>
[-CertificateThumbprint <String>]
[-Credential <PSCredential>]
[-PassInnerException]
[<CommonParameters>]
Description
The Get-NetworkControllerVirtualGatewayNetworkConnection cmdlet gets the configuration of one or more network connections for the specified virtual/tenant gateway.
If you do not specify a ResourceId, this cmdlet gets all network connections.
Examples
Example 1: Display all Network Connections configurations for the tenant virtual gateway
PS C:\> Get-NetworkControllerVirtualGatewayNetworkConnection -ConnectionUri https://networkcontroller -VirtualGatewayId "Contoso"
This command retrieves all the Network Connections for the virtual gateway Contoso configured with the Network Controller.
Example 2: Display a specified Network Connection configuration for the tenant virtual gateway
PS C:\> Get-NetworkControllerVirtualGatewayNetworkConnection -ConnectionUri "https://networkcontroller" -VirtualGatewayId "Contoso" -ResourceId "IPSec_GW"
This command retrieves the Network Connection configuration for the tenant Contoso.
Parameters
-CertificateThumbprint
Specifies the digital public key X.509 certificate of a user account that has permission to perform this action. This is the certificate thumbprint of the certificate.This thumbprint must also be provided in the ClientCertificateThumbprint parameter in the Install-NetworkController or Set-NetworkController cmdlet so that Network Controller can authorize this user.
Parameter properties
| Type: | String |
| 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 |
-ConnectionUri
Specifies the Uniform Resource Identifier (URI) of the Network Controller, used by all Representational State Transfer (REST) clients to connect to Network Controller.
Parameter properties
| Type: | Uri |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Credential
Specifies a user credential that has permission to perform this action. The default value is the current user. This user must be present in the security group provided in the ClientSecurityGroup parameter in the Install-NetworkController cmdlet.
Parameter properties
| Type: | PSCredential |
| 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 |
-PassInnerException
This thumbprint must also be provided in the ClientCertificateThumbprint parameter in the Install-NetworkController or Set-NetworkController cmdlet so that Network Controller can authorize this user.
The thumbprint must be provided only if the network controller client authentication is X509 certificates. Get-NetworkController retrieves that client authentication and authorization information.
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 |
-ResourceId
Specifies an array of network connection resource IDs
Parameter properties
| Type: | String[] |
| Default value: | None |
| 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 |
-VirtualGatewayId
Specifies an array of virtual gateway IDs.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 0 |
| Mandatory: | True |
| 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.
Inputs
String
Outputs
Object
This cmdlet returns object(s) that contains the following fields:
- Resource reference URI.
- Created time of the resource.
- Instance ID of the resource.
- Resource metadata.
- Resource ID.
- Properties of the resource (a virtual/tenant gateway's network connection).
- Network connection type (IPSec, GRE, L3).
- Outbound bandwidth capacity.
- Inbound bandwidth capacity.
- Network connection (IPSec/GRE/L3) specific configuration details.
- Array of local IP addresses.
- Array of remote peer IP addresses.
- Array of customer routes, both static and dynamically learned.
- Connection status (enabled/disabled).
- Connection state (connected/disconnected).
- Connection up-time.
- Connection statistics.
- Connection error reason.
- Connection unreachability reason.
- Source IP address.
- Remote destination IP address.
- Reference to the gateway virtual machine where the connection is configured.