Cosmic User API Reference

createVPC

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
advertintervalVRRP advertisement interval. Defaults to 1.'false
advertmethodVRRP advertisement method to use: unicast / multicast. Defaults to multicast'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
sourcenatlistSource NAT CIDR list for used to allow other CIDRs to be source NATted by the VPC over the public interfacefalse
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
syslogserverlistComma separated list of IP addresses to configure as syslog servers on the VPC to forward IP tables loggingfalse

Response Tags

Response NameDescription
idthe id of the VPC
accountthe owner of the VPC
advertintervalVRRP advertisement interval. Defaults to 1.
advertmethodVRRP advertisement method to use: unicast / multicast. Defaults to multicast'
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
fordisplayis vpc for display to the regular user
namethe name of 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
restartrequiredtrue VPC requires restart
sourcenatlistSource Nat CIDR list for used to allow other CIDRs to be source NATted by the VPC over the public interface
statestate of the VPC. Can be Inactive/Enabled
syslogserverlistComma separated list of IP addresses to configure as syslog servers on the VPC to forward IP tables logging
vpcofferingdisplaytextdisplay text of the vpc offering the vpc is created from
vpcofferingidvpc offering id the VPC is created from
vpcofferingnamename of the vpc offering 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
aclidACL Id associated with the VPC network
aclnamethe name of the ACL applied to this IP
acltypeacl type - access type to the network
broadcastdomaintypeBroadcast domain type of the network
broadcasturibroadcast uri of the network. This parameter is visible to ROOT admins only
canusefordeploylist networks available for vm deployment
cidrCloudstack managed address space, all CloudStack managed VMs get IP address from CIDR
dhcpbootfilenameDHCP option 67: bootfile-name
dhcptftpserverDHCP option 66: tftp-server
displaynetworkan optional field, whether to the display the network to the end user or not.
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
ip6cidrthe cidr of IPv6 network
ip6gatewaythe gateway of IPv6 network
ipexclusionlistlist of ip addresses and/or ranges of addresses to be excluded from the network for assignment
isdefaulttrue if network is default, false otherwise
ispersistentlist networks that are persistent
issystemtrue if network is system, false otherwise
namethe name of the network
netmaskthe network's netmask
networkcidrthe network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE
networkdomainthe network domain
networkofferingavailabilityavailability of the network offering the network is created from
networkofferingconservemodetrue if network offering is ip conserve mode enabled
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
reservediprangethe network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes
restartrequiredtrue network requires restart
specifyiprangestrue if network supports specifying ip ranges, false otherwise
statestate of the network
strechedl2subnettrue if network can span multiple zones
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. This parameter is visible to ROOT admins only
vpcidVPC the network belongs to
vpcnameVPC the network belongs to
zoneidzone id of the network
zonenamethe name of the zone the network belongs to
zonesnetworkspansIf a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans
service(*)the list of services
namethe service name
capability(*)the list of capabilities
provider(*)the service provider name
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
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