Apache CloudStack 4.18.0.0 Root Admin API Reference

listPrivateGateways

List private 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
idlist private gateway by idfalse
ipaddresslist gateways by ip addressfalse
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
statelist gateways by statefalse
vlanlist gateways by vlanfalse
vpcidlist gateways by vpcfalse

Response Tags

Response NameDescription
idthe id of the private gateway
accountthe account associated with the private gateway
aclidACL Id set for private gateway
aclnameACL name set for private gateway
domainthe domain associated with the private gateway
domainidthe ID of the domain associated with the private gateway
gatewaythe gateway
ipaddressthe private gateway's ip address
netmaskthe private gateway's netmask
physicalnetworkidthe physical network id
projectthe project name of the private gateway
projectidthe project id of the private gateway
sourcenatsupportedSource Nat enable status
stateState of the gateway, can be Creating, Ready, Deleting
vlanthe network implementation uri for the private gateway
vpcidVPC id the private gateway belongs to
vpcnameVPC name the private gateway belongs to
zoneidzone id of the private gateway
zonenamethe name of the zone the private gateway belongs to