Apache CloudStack 4.23.0.0 Root Admin API Reference
listVpnCustomerGateways
Lists site to site VPN customer 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 |
| id | ID of the customer gateway | 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 Instances | false |
Response Tags
| Response Name | Description |
| id | The VPN gateway ID |
| account | The owner |
| cidrlist | Guest CIDR list of the customer gateway. Multiple entries are separated by a single comma character (,). |
| 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 | IPsec policy of customer gateway |
| excludedparameters | Contains the list of excluded/not allowed cryptographic parameters that the vpn customer gateway is using. |
| forceencap | If Force NAT Encapsulation is enabled for customer gateway |
| gateway | Public IP address ID of the customer gateway |
| ikelifetime | Lifetime of IKE SA of customer gateway |
| ikepolicy | IKE policy of customer gateway |
| ikeversion | Which IKE Version to use, one of ike (autoselect), IKEv1, or IKEv2. Defaults to ike |
| ipaddress | Guest IP of the customer gateway |
| ipsecpsk | IPsec preshared-key of customer gateway |
| name | Name of the customer gateway |
| obsoleteparameters | Contains the list of obsolete/insecure cryptographic parameters that the vpn customer gateway is using. |
| project | The project name |
| projectid | The project ID |
| removed | The date and time the host was removed |
| splitconnections | For IKEv2, whether to split multiple right subnet CIDRs into multiple connection statements. |