Apache CloudStack v4.1.0 User API Reference

createNetwork

Creates a network

Request parameters

Parameter Name	Description	Required
displaytext	the display text of the network	true
name	the name of the network	true
networkofferingid	the network offering id	true
zoneid	the Zone ID for the network	true
account	account who will own the network	false
acltype	Access 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 accouns in the domain can use the network	false
domainid	domain ID of the account owning a network	false
endip	the ending IP address in the network IP range. If not specified, will be defaulted to startIP	false
endipv6	the ending IPv6 address in the IPv6 network range	false
gateway	the gateway of the network. Required for Shared networks and Isolated networks when it belongs to VPC	false
ip6cidr	the CIDR of IPv6 network, must be at least /64	false
ip6gateway	the gateway of the IPv6 network. Required for Shared networks and Isolated networks when it belongs to VPC	false
netmask	the netmask of the network. Required for Shared networks and Isolated networks when it belongs to VPC	false
networkdomain	network domain	false
physicalnetworkid	the Physical Network ID the network belongs to	false
projectid	an optional project for the ssh key	false
startip	the beginning IP address in the network IP range	false
startipv6	the beginning IPv6 address in the IPv6 network range	false
subdomainaccess	Defines 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 specified	false
vlan	the ID or VID of the network	false
vpcid	the VPC network belongs to	false

Response Tags

Response Name	Description
id	the id of the network
account	the owner of the network
acltype	acl type - access type to the network
broadcastdomaintype	Broadcast domain type of the network
broadcasturi	broadcast uri of the network. This parameter is visible to ROOT admins only
canusefordeploy	list networks available for vm deployment
cidr	the cidr the network
displaytext	the displaytext of the network
dns1	the first DNS for the network
dns2	the second DNS for the network
domain	the domain name of the network owner
domainid	the domain id of the network owner
gateway	the network's gateway
ip6cidr	the cidr of IPv6 network
ip6gateway	the gateway of IPv6 network
isdefault	true if network is default, false otherwise
ispersistent	list networks that are persistent
issystem	true if network is system, false otherwise
name	the name of the network
netmask	the network's netmask
networkdomain	the network domain
networkofferingavailability	availability of the network offering the network is created from
networkofferingdisplaytext	display text of the network offering the network is created from
networkofferingid	network offering id the network is created from
networkofferingname	name of the network offering the network is created from
physicalnetworkid	the physical network id
project	the project name of the address
projectid	the project id of the ipaddress
related	related to what other network configuration
restartrequired	true network requires restart
specifyipranges	true if network supports specifying ip ranges, false otherwise
state	state of the network
subdomainaccess	true if users from subdomains can access the domain level network
traffictype	the traffic type of the network
type	the type of the network
vlan	The vlan of the network. This parameter is visible to ROOT admins only
vpcid	VPC the network belongs to
zoneid	zone id of the network
zonename	the name of the zone the network belongs to
*service()**	the list of services
name	the service name
provider	the service provider name
*capability()**	the list of capabilities
canchooseservicecapability	can this service capability value can be choosable while creatine network offerings
name	the capability name
value	the capability value
*tags()**	the list of resource tags associated with network
account	the account associated with the tag
customer	customer associated with the tag
domain	the domain associated with the tag
domainid	the ID of the domain associated with the tag
key	tag key name
project	the project name where tag belongs to
projectid	the project id the tag belongs to
resourceid	id of the resource
resourcetype	resource type
value	tag value