Apache CloudStack 4.20.0.0 Root Admin API Reference
listVpnConnections
Lists site to site vpn connection gateways
Request parameters
| Parameter Name | Description | Required |
| account | list resources by account. Must be used with the domainId parameter. | false |
| domainid | list only resources belonging to the domain specified | false |
| fordisplay | list resources by display flag; only ROOT admin is eligible to pass this parameter | false |
| id | id of the vpn connection | false |
| isrecursive | defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. | false |
| keyword | List by keyword | false |
| listall | If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. | false |
| page | false | |
| pagesize | false | |
| projectid | list objects by project; if projectid=-1 lists All VMs | false |
| vpcid | id of vpc | false |
Response Tags
| Response Name | Description |
| id | the connection ID |
| account | the owner |
| cidrlist | guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,). |
| created | the date and time the host was created |
| domain | the domain name of the owner |
| domainid | the domain id of the owner |
| domainpath | the domain path of the owner |
| dpd | if DPD is enabled for customer gateway |
| esplifetime | Lifetime of ESP SA of customer gateway |
| esppolicy | ESP policy of the customer gateway |
| forceencap | if Force NAT Encapsulation is enabled for customer gateway |
| fordisplay | is connection for display to the regular user |
| gateway | public ip address id of the customer gateway |
| ikelifetime | Lifetime of IKE SA of customer gateway |
| ikepolicy | IKE policy of the customer gateway |
| ikeversion | Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike |
| ipsecpsk | IPsec Preshared-Key of the customer gateway |
| passive | State of vpn connection |
| project | the project name |
| projectid | the project id |
| publicip | the public IP address |
| removed | the date and time the host was removed |
| s2scustomergatewayid | the customer gateway ID |
| s2svpngatewayid | the vpn gateway ID |
| splitconnections | Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products. |
| state | State of vpn connection |