Apache CloudStack 4.18.0.0 Root Admin API Reference

listVpnCustomerGateways

Lists site to site vpn customer gateways

Request parameters

Parameter NameDescriptionRequired
accountlist resources by account. Must be used with the domainId parameter.false
domainidlist only resources belonging to the domain specifiedfalse
idid of the customer gatewayfalse
isrecursivedefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
listallIf 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
pagefalse
pagesizefalse
projectidlist objects by project; if projectid=-1 lists All VMsfalse

Response Tags

Response NameDescription
idthe vpn gateway ID
accountthe owner
cidrlistguest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).
domainthe domain name of the owner
domainidthe domain id of the owner
dpdif DPD is enabled for customer gateway
esplifetimeLifetime of ESP SA of customer gateway
esppolicyIPsec policy of customer gateway
forceencapif Force NAT Encapsulation is enabled for customer gateway
gatewaypublic ip address id of the customer gateway
ikelifetimeLifetime of IKE SA of customer gateway
ikepolicyIKE policy of customer gateway
ikeversionWhich IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike
ipaddressguest ip of the customer gateway
ipsecpskIPsec preshared-key of customer gateway
namename of the customer gateway
projectthe project name
projectidthe project id
removedthe date and time the host was removed
splitconnectionsFor IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.