本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

# 将 `DescribeVpnConnections` 与 CLI 配合使用
<a name="example_ec2_DescribeVpnConnections_section"></a>

以下代码示例演示如何使用 `DescribeVpnConnections`。

------
#### [ CLI ]

**AWS CLI**  
**示例 1：描述 VPN 连接**  
以下`describe-vpn-connections`示例描述了您的所有 Site-to-Site VPN 连接。  

```
aws ec2 describe-vpn-connections
```
输出：  

```
{
    "VpnConnections": [
        {
            "CustomerGatewayConfiguration": "...configuration information...",
            "CustomerGatewayId": "cgw-01234567abcde1234",
            "Category": "VPN",
            "State": "available",
            "Type": "ipsec.1",
            "VpnConnectionId": "vpn-1122334455aabbccd",
            "TransitGatewayId": "tgw-00112233445566aab",
            "Options": {
                "EnableAcceleration": false,
                "StaticRoutesOnly": true,
                "LocalIpv4NetworkCidr": "0.0.0.0/0",
                "RemoteIpv4NetworkCidr": "0.0.0.0/0",
                "TunnelInsideIpVersion": "ipv4"
            },
            "Routes": [],
            "Tags": [
                {
                    "Key": "Name",
                    "Value": "CanadaVPN"
                }
            ],
            "VgwTelemetry": [
                {
                    "AcceptedRouteCount": 0,
                    "LastStatusChange": "2020-07-29T10:35:11.000Z",
                    "OutsideIpAddress": "203.0.113.3",
                    "Status": "DOWN",
                    "StatusMessage": ""
                },
                {
                    "AcceptedRouteCount": 0,
                    "LastStatusChange": "2020-09-02T09:09:33.000Z",
                    "OutsideIpAddress": "203.0.113.5",
                    "Status": "UP",
                    "StatusMessage": ""
                }
            ]
        }
    ]
}
```
有关更多信息，[请参阅《 AWS Site-to-Site VPN *用户指南》中的AWS Site-to-Site VPN* 工作原理](https://docs.aws.amazon.com/vpn/latest/s2svpn/how_it_works.html)。  
**示例 2：描述可用的 VPN 连接**  
以下`describe-vpn-connections`示例描述了状态为的 Site-to-Site VPN 连接`available`。  

```
aws ec2 describe-vpn-connections \
    --filters "Name=state,Values=available"
```
有关更多信息，[请参阅《 AWS Site-to-Site VPN *用户指南》中的AWS Site-to-Site VPN* 工作原理](https://docs.aws.amazon.com/vpn/latest/s2svpn/how_it_works.html)。  
+  有关 API 的详细信息，请参阅*AWS CLI 命令参考[DescribeVpnConnections](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-vpn-connections.html)*中的。

------
#### [ PowerShell ]

**适用于 PowerShell V4 的工具**  
**示例 1：此示例描述指定的 VPN 连接。**  

```
Get-EC2VpnConnection -VpnConnectionId vpn-12345678
```
**输出**：  

```
CustomerGatewayConfiguration : [XML document]
CustomerGatewayId            : cgw-1a2b3c4d
Options                      : Amazon.EC2.Model.VpnConnectionOptions
Routes                       : {Amazon.EC2.Model.VpnStaticRoute}
State                        : available
Tags                         : {}
Type                         : ipsec.1
VgwTelemetry                 : {Amazon.EC2.Model.VgwTelemetry, Amazon.EC2.Model.VgwTelemetry}
VpnConnectionId              : vpn-12345678
VpnGatewayId                 : vgw-1a2b3c4d
```
**示例 2：此示例描述状态为待定或可用的任何 VPN 连接。**  

```
$filter = New-Object Amazon.EC2.Model.Filter
$filter.Name = "state"
$filter.Values = @( "pending", "available" )

Get-EC2VpnConnection -Filter $filter
```
**示例 3：此示例描述所有 VPN 连接。**  

```
Get-EC2VpnConnection
```
+  有关 API 的详细信息，请参阅 *AWS Tools for PowerShell Cmdlet 参考 (V* 4) [DescribeVpnConnections](https://docs.aws.amazon.com/powershell/v4/reference)中的。

**适用于 PowerShell V5 的工具**  
**示例 1：此示例描述指定的 VPN 连接。**  

```
Get-EC2VpnConnection -VpnConnectionId vpn-12345678
```
**输出**：  

```
CustomerGatewayConfiguration : [XML document]
CustomerGatewayId            : cgw-1a2b3c4d
Options                      : Amazon.EC2.Model.VpnConnectionOptions
Routes                       : {Amazon.EC2.Model.VpnStaticRoute}
State                        : available
Tags                         : {}
Type                         : ipsec.1
VgwTelemetry                 : {Amazon.EC2.Model.VgwTelemetry, Amazon.EC2.Model.VgwTelemetry}
VpnConnectionId              : vpn-12345678
VpnGatewayId                 : vgw-1a2b3c4d
```
**示例 2：此示例描述状态为待定或可用的任何 VPN 连接。**  

```
$filter = New-Object Amazon.EC2.Model.Filter
$filter.Name = "state"
$filter.Values = @( "pending", "available" )

Get-EC2VpnConnection -Filter $filter
```
**示例 3：此示例描述所有 VPN 连接。**  

```
Get-EC2VpnConnection
```
+  有关 API 的详细信息，请参阅 *AWS Tools for PowerShell Cmdlet 参考 (V* 5) [DescribeVpnConnections](https://docs.aws.amazon.com/powershell/v5/reference)中的。

------

有关 S AWS DK 开发者指南和代码示例的完整列表，请参阅[使用 AWS SDK 创建 Amazon EC2 资源](sdk-general-information-section.md)。本主题还包括有关入门的信息以及有关先前的 SDK 版本的详细信息。