Apache CloudStack 4.18.0.0 Root Admin API Reference

listVpnGateways

Lists site 2 site vpn 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 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
vpcidid of vpcfalse

Response Tags

Response NameDescription
idthe vpn gateway ID
accountthe owner
domainthe domain name of the owner
domainidthe domain id of the owner
fordisplayis vpn gateway for display to the regular user
projectthe project name
projectidthe project id
publicipthe public IP address
removedthe date and time the host was removed
vpcidthe vpc id of this gateway
vpcnamethe vpc name of this gateway