static/api/apidocs-4.20/apis/createNetwork.html

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 1.0 Transitional//EN"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <META http-equiv="Content-Type" content="text/html; charset=UTF-8"> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <link rel="stylesheet" href="../includes/main.css" type="text/css"> <link rel="shortcut icon" href="../favicon.ico" type="image/x-icon"> <title>Apache CloudStack | The Power Behind Your Cloud</title> </head> <body> <div id="insidetopbg"> <div id="inside_wrapper"> <div class="uppermenu_panel"> <div class="uppermenu_box"></div> </div> <div id="main_controller"> <div id="inside_header"> <div class="header_top"> <a class="cloud_logo" href="http://cloudstack.org"></a> <div class="mainemenu_panel"></div> </div> </div> <div id="main_content"> <div class="inside_apileftpanel"> <div class="inside_contentpanel" style="width:930px;"> <div class="api_titlebox"> <div class="api_titlebox_left"> Apache CloudStack 4.20.0.0 Root Admin API Reference <h1>createNetwork</h1> Creates a network </div> <div class="api_titlebox_right"> <a class="api_backbutton" href="../index.html"></a> </div> </div> <div class="api_tablepanel"> <h2>Request parameters</h2> <table class="apitable"> <tr class="hed"> <td style="width:200px;">Parameter Name</td><td style="width:500px;">Description</td><td style="width:180px;">Required</td> </tr> <tr> <td style="width:200px;">name</td><td style="width:500px;">the name of the network</td><td style="width:180px;">true</td> </tr> <tr> <td style="width:200px;">networkofferingid</td><td style="width:500px;">the network offering ID</td><td style="width:180px;">true</td> </tr> <tr> <td style="width:200px;">zoneid</td><td style="width:500px;">the zone ID for the network</td><td style="width:180px;">true</td> </tr> <tr> <td style="width:200px;">account</td><td style="width:500px;">Account that will own the network. Account should be under the selected domain</td><td style="width:180px;">false</td> </tr> <tr> <td style="width:200px;">aclid</td><td style="width:500px;">Network ACL ID associated for the network</td><td style="width:180px;">false</td> </tr> <tr> <td style="width:200px;">acltype</td><td style="width:500px;">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 accounts in the domain can use the network</td><td style="width:180px;">false</td> </tr> <tr> <td style="width:200px;">asnumber</td><td style="width:500px;">the AS Number of the network</td><td style="width:180px;">false</td> </tr> <tr> <td style="width:200px;">associatednetworkid</td><td style="width:500px;">The network this network is associated to. only available if create a Shared network</td><td style="width:180px;">false</td> </tr> <tr> <td style="width:200px;">bgppeerids</td><td style="width:500px;">Ids of the Bgp Peer for the network</td><td style="width:180px;">false</td> </tr> <tr> <td style="width:200px;">bypassvlanoverlapcheck</td><td style="width:500px;">when true bypasses VLAN id/range overlap check during network creation for shared and L2 networks</td><td style="width:180px;">false</td> </tr> <tr> <td style="width:200px;">cidrsize</td><td style="width:500px;">the CIDR size of IPv4 network. For regular users, this is required for isolated networks with ROUTED mode.</td><td style="width:180px;">false</td> </tr> <tr> <td style="width:200px;">displaynetwork</td><td style="width:500px;">an optional field, whether to the display the network to the end user or not.</td><td style="width:180px;">false</td> </tr> <tr> <td style="width:200px;">displaytext</td><td style="width:500px;">the display text of the network</td><td style="width:180px;">false</td> </tr> <tr> <td style="width:200px;">dns1</td><td style="width:500px;">the first IPv4 DNS for the network</td><td style="width:180px;">false</td> </tr> <tr> <td style="width:200px;">dns2</td><td style="width:500px;">the second IPv4 DNS for the network</td><td style="width:180px;">false</td> </tr> <tr> <td style="width:200px;">domainid</td><td style="width:500px;">domain ID of the account owning a network. If the account is not specified, but the acltype is Account or not specified, the network will be automatically assigned to the caller account and domain. To create a network under the domain without linking it to any account, make sure to include acltype=Domain parameter in the api call. If account is not specified, but acltype is Domain, the network will be created for the specified domain.</td><td style="width:180px;">false</td> </tr> <tr> <td style="width:200px;">endip</td><td style="width:500px;">the ending IP address in the network IP range. If not specified, will be defaulted to startIP</td><td style="width:180px;">false</td> </tr> <tr> <td style="width:200px;">endipv6</td><td style="width:500px;">the ending IPv6 address in the IPv6 network range</td><td style="width:180px;">false</td> </tr> <tr> <td style="width:200px;">externalid</td><td style="width:500px;">ID of the network in an external system.</td><td style="width:180px;">false</td> </tr> <tr> <td style="width:200px;">gateway</td><td style="width:500px;">the gateway of the network. Required for shared networks and isolated networks when it belongs to VPC</td><td style="width:180px;">false</td> </tr> <tr> <td style="width:200px;">hideipaddressusage</td><td style="width:500px;">when true ip address usage for the network will not be exported by the listUsageRecords API</td><td style="width:180px;">false</td> </tr> <tr> <td style="width:200px;">ip6cidr</td><td style="width:500px;">the CIDR of IPv6 network, must be at least /64</td><td style="width:180px;">false</td> </tr> <tr> <td style="width:200px;">ip6dns1</td><td style="width:500px;">the first IPv6 DNS for the network</td><td style="width:180px;">false</td> </tr> <tr> <td style="width:200px;">ip6dns2</td><td style="width:500px;">the second IPv6 DNS for the network</td><td style="width:180px;">false</td> </tr> <tr> <td style="width:200px;">ip6gateway</td><td style="width:500px;">the gateway of the IPv6 network. Required for Shared networks</td><td style="width:180px;">false</td> </tr> <tr> <td style="width:200px;">isolatedpvlan</td><td style="width:500px;">the isolated private VLAN for this network</td><td style="width:180px;">false</td> </tr> <tr> <td style="width:200px;">isolatedpvlantype</td><td style="width:500px;">the isolated private VLAN type for this network</td><td style="width:180px;">false</td> </tr> <tr> <td style="width:200px;">netmask</td><td style="width:500px;">the netmask of the network. Required for shared networks and isolated networks when it belongs to VPC</td><td style="width:180px;">false</td> </tr> <tr> <td style="width:200px;">networkdomain</td><td style="width:500px;">network domain</td><td style="width:180px;">false</td> </tr> <tr> <td style="width:200px;">physicalnetworkid</td><td style="width:500px;">the physical network ID the network belongs to</td><td style="width:180px;">false</td> </tr> <tr> <td style="width:200px;">privatemtu</td><td style="width:500px;">MTU to be configured on the network VR's private interface(s)</td><td style="width:180px;">false</td> </tr> <tr> <td style="width:200px;">projectid</td><td style="width:500px;">an optional project for the network</td><td style="width:180px;">false</td> </tr> <tr> <td style="width:200px;">publicmtu</td><td style="width:500px;">MTU to be configured on the network VR's public facing interfaces</td><td style="width:180px;">false</td> </tr> <tr> <td style="width:200px;">routerip</td><td style="width:500px;">IPV4 address to be assigned to a router in a shared network</td><td style="width:180px;">false</td> </tr> <tr> <td style="width:200px;">routeripv6</td><td style="width:500px;">IPV6 address to be assigned to a router in a shared network</td><td style="width:180px;">false</td> </tr> <tr> <td style="width:200px;">sourcenatipaddress</td><td style="width:500px;">IPV4 address to be assigned to the public interface of the network router. This address will be used as source NAT address for the network. If an address is given and it cannot be acquired, an error will be returned and the network won´t be implemented,</td><td style="width:180px;">false</td> </tr> <tr> <td style="width:200px;">startip</td><td style="width:500px;">the beginning IP address in the network IP range</td><td style="width:180px;">false</td> </tr> <tr> <td style="width:200px;">startipv6</td><td style="width:500px;">the beginning IPv6 address in the IPv6 network range</td><td style="width:180px;">false</td> </tr> <tr> <td style="width:200px;">subdomainaccess</td><td style="width:500px;">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</td><td style="width:180px;">false</td> </tr> <tr> <td style="width:200px;">tungstenvirtualrouteruuid</td><td style="width:500px;">Tungsten-Fabric virtual router the network belongs to</td><td style="width:180px;">false</td> </tr> <tr> <td style="width:200px;">vlan</td><td style="width:500px;">the ID or VID of the network</td><td style="width:180px;">false</td> </tr> <tr> <td style="width:200px;">vpcid</td><td style="width:500px;">the VPC network belongs to</td><td style="width:180px;">false</td> </tr> </table> </div> <div class="api_tablepanel"> <h2>Response Tags</h2> <table class="apitable"> <tr class="hed"> <td style="width:200px;">Response Name</td><td style="width:500px;">Description</td> </tr> <tr> <td style="width:200px;">id</td><td style="width:500px;">the id of the network</td> </tr> <tr> <td style="width:200px;">account</td><td style="width:500px;">the owner of the network</td> </tr> <tr> <td style="width:200px;">aclid</td><td style="width:500px;">ACL Id associated with the VPC network</td> </tr> <tr> <td style="width:200px;">aclname</td><td style="width:500px;">ACL name associated with the VPC network</td> </tr> <tr> <td style="width:200px;">acltype</td><td style="width:500px;">acl type - access type to the network</td> </tr> <tr> <td style="width:200px;">asnumber</td><td style="width:500px;">AS NUMBER</td> </tr> <tr> <td style="width:200px;">asnumberid</td><td style="width:500px;">UUID of AS NUMBER</td> </tr> <tr> <td style="width:200px;">associatednetwork</td><td style="width:500px;">the name of the Network associated with this network</td> </tr> <tr> <td style="width:200px;">associatednetworkid</td><td style="width:500px;">the ID of the Network associated with this network</td> </tr> <tr> <td style="width:200px;">bgppeers</td><td style="width:500px;">The BGP peers for the network</td> </tr> <tr> <td style="width:200px;">broadcastdomaintype</td><td style="width:500px;">Broadcast domain type of the network</td> </tr> <tr> <td style="width:200px;">broadcasturi</td><td style="width:500px;">broadcast uri of the network. This parameter is visible to ROOT admins only</td> </tr> <tr> <td style="width:200px;">canusefordeploy</td><td style="width:500px;">list networks available for vm deployment</td> </tr> <tr> <td style="width:200px;">cidr</td><td style="width:500px;">Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR</td> </tr> <tr> <td style="width:200px;">created</td><td style="width:500px;">the date this network was created</td> </tr> <tr> <td style="width:200px;">details</td><td style="width:500px;">the details of the network</td> </tr> <tr> <td style="width:200px;">displaynetwork</td><td style="width:500px;">an optional field, whether to the display the network to the end user or not.</td> </tr> <tr> <td style="width:200px;">displaytext</td><td style="width:500px;">the displaytext of the network</td> </tr> <tr> <td style="width:200px;">dns1</td><td style="width:500px;">the first IPv4 DNS for the network</td> </tr> <tr> <td style="width:200px;">dns2</td><td style="width:500px;">the second IPv4 DNS for the network</td> </tr> <tr> <td style="width:200px;">domain</td><td style="width:500px;">the domain name of the network owner</td> </tr> <tr> <td style="width:200px;">domainid</td><td style="width:500px;">the domain id of the network owner</td> </tr> <tr> <td style="width:200px;">domainpath</td><td style="width:500px;">path of the Domain the network belongs to</td> </tr> <tr> <td style="width:200px;">egressdefaultpolicy</td><td style="width:500px;">true if guest network default egress policy is allow; false if default egress policy is deny</td> </tr> <tr> <td style="width:200px;">externalid</td><td style="width:500px;">The external id of the network</td> </tr> <tr> <td style="width:200px;">gateway</td><td style="width:500px;">the network's gateway</td> </tr> <tr> <td style="width:200px;">icon</td><td style="width:500px;">Base64 string representation of the resource icon</td> </tr> <tr> <td style="width:200px;">internetprotocol</td><td style="width:500px;">The internet protocol of network offering</td> </tr> <tr> <td style="width:200px;">ip4routes</td><td style="width:500px;">The routes for the network to ease adding route in upstream router</td> </tr> <tr> <td style="width:200px;">ip4routing</td><td style="width:500px;">The IPv4 routing type of network</td> </tr> <tr> <td style="width:200px;">ip6cidr</td><td style="width:500px;">the cidr of IPv6 network</td> </tr> <tr> <td style="width:200px;">ip6dns1</td><td style="width:500px;">the first IPv6 DNS for the network</td> </tr> <tr> <td style="width:200px;">ip6dns2</td><td style="width:500px;">the second IPv6 DNS for the network</td> </tr> <tr> <td style="width:200px;">ip6gateway</td><td style="width:500px;">the gateway of IPv6 network</td> </tr> <tr> <td style="width:200px;">ip6routes</td><td style="width:500px;">The routes for the network to ease adding route in upstream router</td> </tr> <tr> <td style="width:200px;">ip6routing</td><td style="width:500px;">The Ipv6 routing type of network offering</td> </tr> <tr> <td style="width:200px;">isdefault</td><td style="width:500px;">true if network is default, false otherwise</td> </tr> <tr> <td style="width:200px;">ispersistent</td><td style="width:500px;">list networks that are persistent</td> </tr> <tr> <td style="width:200px;">issystem</td><td style="width:500px;">true if network is system, false otherwise</td> </tr> <tr> <td style="width:200px;">name</td><td style="width:500px;">the name of the network</td> </tr> <tr> <td style="width:200px;">netmask</td><td style="width:500px;">the network's netmask</td> </tr> <tr> <td style="width:200px;">networkcidr</td><td style="width:500px;">the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE</td> </tr> <tr> <td style="width:200px;">networkdomain</td><td style="width:500px;">the network domain</td> </tr> <tr> <td style="width:200px;">networkofferingavailability</td><td style="width:500px;">availability of the network offering the network is created from</td> </tr> <tr> <td style="width:200px;">networkofferingconservemode</td><td style="width:500px;">true if network offering is ip conserve mode enabled</td> </tr> <tr> <td style="width:200px;">networkofferingdisplaytext</td><td style="width:500px;">display text of the network offering the network is created from</td> </tr> <tr> <td style="width:200px;">networkofferingid</td><td style="width:500px;">network offering id the network is created from</td> </tr> <tr> <td style="width:200px;">networkofferingname</td><td style="width:500px;">name of the network offering the network is created from</td> </tr> <tr> <td style="width:200px;">physicalnetworkid</td><td style="width:500px;">the physical network id</td> </tr> <tr> <td style="width:200px;">privatemtu</td><td style="width:500px;">MTU configured on the network VR's private interfaces</td> </tr> <tr> <td style="width:200px;">project</td><td style="width:500px;">the project name of the address</td> </tr> <tr> <td style="width:200px;">projectid</td><td style="width:500px;">the project id of the ipaddress</td> </tr> <tr> <td style="width:200px;">publicmtu</td><td style="width:500px;">MTU configured on the network VR's public facing interfaces</td> </tr> <tr> <td style="width:200px;">receivedbytes</td><td style="width:500px;">the total number of network traffic bytes received</td> </tr> <tr> <td style="width:200px;">redundantrouter</td><td style="width:500px;">If the network has redundant routers enabled</td> </tr> <tr> <td style="width:200px;">related</td><td style="width:500px;">related to what other network configuration</td> </tr> <tr> <td style="width:200px;">reservediprange</td><td style="width:500px;">the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes</td> </tr> <tr> <td style="width:200px;">restartrequired</td><td style="width:500px;">true network requires restart</td> </tr> <tr> <td style="width:200px;">sentbytes</td><td style="width:500px;">the total number of network traffic bytes sent</td> </tr> <tr> <td style="width:200px;">specifyipranges</td><td style="width:500px;">true if network supports specifying ip ranges, false otherwise</td> </tr> <tr> <td style="width:200px;">state</td><td style="width:500px;">state of the network</td> </tr> <tr> <td style="width:200px;">strechedl2subnet</td><td style="width:500px;">true if network can span multiple zones</td> </tr> <tr> <td style="width:200px;">subdomainaccess</td><td style="width:500px;">true if users from subdomains can access the domain level network</td> </tr> <tr> <td style="width:200px;">supportsvmautoscaling</td><td style="width:500px;">if network offering supports vm autoscaling feature</td> </tr> <tr> <td style="width:200px;">traffictype</td><td style="width:500px;">the traffic type of the network</td> </tr> <tr> <td style="width:200px;">tungstenvirtualrouteruuid</td><td style="width:500px;">Tungsten-Fabric virtual router the network belongs to</td> </tr> <tr> <td style="width:200px;">type</td><td style="width:500px;">the type of the network</td> </tr> <tr> <td style="width:200px;">vlan</td><td style="width:500px;">The vlan of the network. This parameter is visible to ROOT admins only</td> </tr> <tr> <td style="width:200px;">vpcid</td><td style="width:500px;">VPC the network belongs to</td> </tr> <tr> <td style="width:200px;">vpcname</td><td style="width:500px;">Name of the VPC to which this network belongs</td> </tr> <tr> <td style="width:200px;">zoneid</td><td style="width:500px;">zone id of the network</td> </tr> <tr> <td style="width:200px;">zonename</td><td style="width:500px;">the name of the zone the network belongs to</td> </tr> <tr> <td style="width:200px;">zonesnetworkspans</td><td style="width:500px;">If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans</td> </tr> <tr> <td style="width:200px;">service(*)</td><td style="width:500px;">the list of services</td> <tr> <td style="width:180px; padding-left:25px;">name</td><td style="width:500px;">the service name</td> </tr> <tr> <td style="width:180px; padding-left:25px;">capability(*)</td><td style="width:500px;">the list of capabilities</td> </tr> <tr> <td style="width:165px; padding-left:40px;">canchooseservicecapability</td><td style="width:500px;">can this service capability value can be choosable while creatine network offerings</td> </tr> <tr> <td style="width:165px; padding-left:40px;">name</td><td style="width:500px;">the capability name</td> </tr> <tr> <td style="width:165px; padding-left:40px;">value</td><td style="width:500px;">the capability value</td> </tr> <tr> <td style="width:180px; padding-left:25px;">provider(*)</td><td style="width:500px;">the service provider name</td> </tr> <tr> <td style="width:165px; padding-left:40px;">id</td><td style="width:500px;">uuid of the network provider</td> </tr> <tr> <td style="width:165px; padding-left:40px;">canenableindividualservice</td><td style="width:500px;">true if individual services can be enabled/disabled</td> </tr> <tr> <td style="width:165px; padding-left:40px;">destinationphysicalnetworkid</td><td style="width:500px;">the destination physical network</td> </tr> <tr> <td style="width:165px; padding-left:40px;">name</td><td style="width:500px;">the provider name</td> </tr> <tr> <td style="width:165px; padding-left:40px;">physicalnetworkid</td><td style="width:500px;">the physical network this belongs to</td> </tr> <tr> <td style="width:165px; padding-left:40px;">servicelist</td><td style="width:500px;">services for this provider</td> </tr> <tr> <td style="width:165px; padding-left:40px;">state</td><td style="width:500px;">state of the network provider</td> </tr> </tr> <tr> <td style="width:200px;">tags(*)</td><td style="width:500px;">the list of resource tags associated with network</td> <tr> <td style="width:180px; padding-left:25px;">account</td><td style="width:500px;">the account associated with the tag</td> </tr> <tr> <td style="width:180px; padding-left:25px;">customer</td><td style="width:500px;">customer associated with the tag</td> </tr> <tr> <td style="width:180px; padding-left:25px;">domain</td><td style="width:500px;">the domain associated with the tag</td> </tr> <tr> <td style="width:180px; padding-left:25px;">domainid</td><td style="width:500px;">the ID of the domain associated with the tag</td> </tr> <tr> <td style="width:180px; padding-left:25px;">domainpath</td><td style="width:500px;">path of the Domain associated with the tag</td> </tr> <tr> <td style="width:180px; padding-left:25px;">key</td><td style="width:500px;">tag key name</td> </tr> <tr> <td style="width:180px; padding-left:25px;">project</td><td style="width:500px;">the project name where tag belongs to</td> </tr> <tr> <td style="width:180px; padding-left:25px;">projectid</td><td style="width:500px;">the project id the tag belongs to</td> </tr> <tr> <td style="width:180px; padding-left:25px;">resourceid</td><td style="width:500px;">id of the resource</td> </tr> <tr> <td style="width:180px; padding-left:25px;">resourcetype</td><td style="width:500px;">resource type</td> </tr> <tr> <td style="width:180px; padding-left:25px;">value</td><td style="width:500px;">tag value</td> </tr> </tr> </table> </div> </div> </div> </div> </div> <div id="footer"> <div id="comments_thread"> <script type="text/javascript" src="https://comments.apache.org/show_comments.lua?site=test" async="true"></script> <noscript> <iframe width="930" height="500" src="https://comments.apache.org/iframe.lua?site=test&page=4.2.0/rootadmin"></iframe> </noscript> </div> <div id="footer_maincontroller"> Copyright © 2015 The Apache Software Foundation, Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0.</a> Apache, CloudStack, Apache CloudStack, the Apache CloudStack logo, the CloudMonkey logo and the Apache feather logo are trademarks of The Apache Software Foundation. </div> </div> </div> </div> </body> </html>

static/api/apidocs-4.20/apis/createNetwork.html (502 lines of code) (raw):