Get-NetworkControllerVirtualGatewayNetworkConnection
Gets a virtual gateway network connection.
Syntax
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.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | 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.
Type: | Uri |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | 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.
Type: | PSCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | 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.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ResourceId
Specifies an array of network connection resource IDs
Type: | String[] |
Position: | 1 |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-VirtualGatewayId
Specifies an array of virtual gateway IDs.
Type: | String[] |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Inputs
String[]
Outputs
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.
Related Links
피드백
https://aka.ms/ContentUserFeedback
출시 예정: 2024년 내내 콘텐츠에 대한 피드백 메커니즘으로 GitHub 문제를 단계적으로 폐지하고 이를 새로운 피드백 시스템으로 바꿀 예정입니다. 자세한 내용은 다음을 참조하세요.다음에 대한 사용자 의견 제출 및 보기