Apache CloudStack Root Admin API Reference


Lists site to site vpn connection 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
fordisplaylist resources by display flag; only ROOT admin is eligible to pass this parameterfalse
idid of the vpn connectionfalse
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 falsefalse
projectidlist objects by projectfalse
vpcidid of vpcfalse

Response Tags

Response NameDescription
idthe connection ID
accountthe owner
cidrlistguest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).
createdthe date and time the host was created
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
esppolicyESP policy of the customer gateway
forceencapif Force NAT Encapsulation is enabled for customer gateway
fordisplayis connection for display to the regular user
gatewaypublic ip address id of the customer gateway
ikelifetimeLifetime of IKE SA of customer gateway
ikepolicyIKE policy of the customer gateway
ipsecpskIPsec Preshared-Key of the customer gateway
passiveState of vpn connection
projectthe project name
projectidthe project id
publicipthe public IP address
removedthe date and time the host was removed
s2scustomergatewayidthe customer gateway ID
s2svpngatewayidthe vpn gateway ID
stateState of vpn connection