Apache CloudStack 4.0.0-incubating Root Admin API Reference

listVPCs

Lists VPCs

Request parameters

Parameter NameDescriptionRequired
accountlist by account associated with the VPC. Must be used with the domainId parameter.false
accountList resources by account. Must be used with the domainId parameter.false
cidrlist by cidr of the VPC. All VPC guest networks' cidrs should be within this CIDRfalse
displaytextList by display text of the VPCfalse
domainidlist by domain ID associated with the VPC. If used with the account parameter returns the VPC associated with the account for the specified domain.false
domainidlist only resources belonging to the domain specifiedfalse
idlist VPC by idfalse
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
namelist by name of the VPCfalse
pagefalse
pagesizefalse
projectidlist objects by projectfalse
restartrequiredlist VPCs by restartRequired optionfalse
statelist VPCs by statefalse
supportedserviceslist VPC supporting certain servicesfalse
tagsList resources by tags (key/value pairs)false
vpcofferingidlist by ID of the VPC offeringfalse
zoneidlist by zonefalse

Response Tags

Response NameDescription
idthe id of the VPC
accountthe owner of the VPC
cidrthe cidr the VPC
createdthe date this VPC was created
displaytextan alternate display text of the VPC.
domainthe domain name of the owner
domainidthe domain id of the VPC owner
namethe name of the VPC
networkdomainthe network domain of the VPC
projectthe project name of the VPC
projectidthe project id of the VPC
restartrequiredtrue VPC requires restart
statestate of the VPC. Can be Inactive/Enabled
vpcofferingidvpc offering id the VPC is created from
zoneidzone id of the vpc
zonenamethe name of the zone the VPC belongs to
network(*)the list of networks belongign to the VPC
idthe id of the network
accountthe owner of the network
acltypeacl type - access type to the network
broadcastdomaintypeBroadcast domain type of the network
broadcasturibroadcast uri of the network
canusefordeploylist networks available for vm deployment
cidrthe cidr the network
displaytextthe displaytext of the network
dns1the first DNS for the network
dns2the second DNS for the network
domainthe domain name of the network owner
domainidthe domain id of the network owner
gatewaythe network's gateway
isdefaulttrue if network is default, false otherwise
issystemtrue if network is system, false otherwise
namethe name of the network
netmaskthe network's netmask
networkdomainthe network domain
networkofferingavailabilityavailability of the network offering the network is created from
networkofferingdisplaytextdisplay text of the network offering the network is created from
networkofferingidnetwork offering id the network is created from
networkofferingnamename of the network offering the network is created from
physicalnetworkidthe physical network id
projectthe project name of the address
projectidthe project id of the ipaddress
relatedrelated to what other network configuration
restartrequiredtrue network requires restart
specifyiprangestrue if network supports specifying ip ranges, false otherwise
statestate of the network
subdomainaccesstrue if users from subdomains can access the domain level network
traffictypethe traffic type of the network
typethe type of the network
vlanthe vlan of the network
vpcidVPC the network belongs to
zoneidzone id of the network
zonenamethe name of the zone the network belongs to
service(*)the list of services
namethe service name
providerthe service provider name
capability(*)the list of capabilities
tags(*)the list of resource tags associated with network
accountthe account associated with the tag
customercustomer associated with the tag
domainthe domain associated with the tag
domainidthe ID of the domain associated with the tag
keytag key name
projectthe project name where tag belongs to
projectidthe project id the tag belongs to
resourceidid of the resource
resourcetyperesource type
valuetag value
service(*)the list of supported services
namethe service name
providerthe service provider name
capability(*)the list of capabilities
canchooseservicecapabilitycan this service capability value can be choosable while creatine network offerings
namethe capability name
valuethe capability value
tags(*)the list of resource tags associated with the project
accountthe account associated with the tag
customercustomer associated with the tag
domainthe domain associated with the tag
domainidthe ID of the domain associated with the tag
keytag key name
projectthe project name where tag belongs to
projectidthe project id the tag belongs to
resourceidid of the resource
resourcetyperesource type
valuetag value