Apache CloudStack 4.12.0.0 Root Admin API Reference

createNetwork

Creates a network

Request parameters

Parameter NameDescriptionRequired
displaytextthe display text of the networktrue
namethe name of the networktrue
networkofferingidthe network offering IDtrue
zoneidthe zone ID for the networktrue
accountaccount that will own the networkfalse
aclidNetwork ACL ID associated for the networkfalse
acltypeAccess control type; supported values are account and domain. In 3.0 all shared networks should have aclType=Domain, and all isolated networks - Account. Account means that only the account owner can use the network, domain - all accounts in the domain can use the networkfalse
bypassvlanoverlapcheckwhen true bypasses VLAN id/range overlap check during network creation for shared and L2 networksfalse
displaynetworkan optional field, whether to the display the network to the end user or not.false
domainiddomain ID of the account owning a networkfalse
endipthe ending IP address in the network IP range. If not specified, will be defaulted to startIPfalse
endipv6the ending IPv6 address in the IPv6 network rangefalse
externalidID of the network in an external system.false
gatewaythe gateway of the network. Required for shared networks and isolated networks when it belongs to VPCfalse
ip6cidrthe CIDR of IPv6 network, must be at least /64false
ip6gatewaythe gateway of the IPv6 network. Required for Shared networksfalse
isolatedpvlanthe isolated private VLAN for this networkfalse
netmaskthe netmask of the network. Required for shared networks and isolated networks when it belongs to VPCfalse
networkdomainnetwork domainfalse
physicalnetworkidthe physical network ID the network belongs tofalse
projectidan optional project for the SSH keyfalse
startipthe beginning IP address in the network IP rangefalse
startipv6the beginning IPv6 address in the IPv6 network rangefalse
subdomainaccessDefines whether to allow subdomains to use networks dedicated to their parent domain(s). Should be used with aclType=Domain, defaulted to allow.subdomain.network.access global config if not specifiedfalse
vlanthe ID or VID of the networkfalse
vpcidthe VPC network belongs tofalse

Response Tags

Response NameDescription
idthe id of the network
accountthe owner of the network
aclidACL Id associated with the VPC network
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
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
externalidThe external id of the network
gatewaythe network's gateway
ip6cidrthe cidr of IPv6 network
ip6gatewaythe gateway of IPv6 network
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
redundantrouterIf the network has redundant routers enabled
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
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
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 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