Apache CloudStack Root Admin API Reference


Creates a VPC

Request parameters

Parameter NameDescriptionRequired
cidrthe cidr of the VPC. All VPC guest networks' cidrs should be within this CIDRtrue
displaytextthe display text of the VPCtrue
namethe name of the VPCtrue
vpcofferingidthe ID of the VPC offeringtrue
zoneidthe ID of the availability zonetrue
accountthe account associated with the VPC. Must be used with the domainId parameter.false
domainidthe domain ID associated with the VPC. If used with the account parameter returns the VPC associated with the account for the specified domain.false
fordisplayan optional field, whether to the display the vpc to the end user or notfalse
networkdomainVPC network domain. All networks inside the VPC will belong to this domainfalse
projectidcreate VPC for the projectfalse
startIf set to false, the VPC won't start (VPC VR will not get allocated) until its first network gets implemented. True by default.false

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.
distributedvpcrouteris VPC uses distributed router for one hop forwarding and host based network ACL's
domainthe domain name of the owner
domainidthe domain id of the VPC owner
fordisplayis vpc for display to the regular user
iconBase64 string representation of the resource icon
namethe name of the VPC
networkthe list of networks belongign to the VPC
networkdomainthe network domain of the VPC
projectthe project name of the VPC
projectidthe project id of the VPC
redundantvpcrouterif this VPC has redundant router
regionlevelvpctrue if VPC is region level
restartrequiredtrue VPC requires restart
statestate of the VPC. Can be Inactive/Enabled
vpcofferingidvpc offering id the VPC is created from
vpcofferingnamevpc offering name the VPC is created from
zoneidzone id of the vpc
zonenamethe name of the zone the VPC belongs to
service(*)the list of supported services
namethe service name
capability(*)the list of capabilities
canchooseservicecapabilitycan this service capability value can be choosable while creatine network offerings
namethe capability name
valuethe capability value
provider(*)the service provider name
iduuid of the network provider
canenableindividualservicetrue if individual services can be enabled/disabled
destinationphysicalnetworkidthe destination physical network
namethe provider name
physicalnetworkidthe physical network this belongs to
servicelistservices for this provider
statestate of the network provider
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