| <!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"> |
| <span> |
| Apache CloudStack 4.21.0.0 Root Admin API Reference |
| </span> |
| <p></p> |
| <h1>createVPC</h1> |
| <p>Creates a VPC</p> |
| </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;"><strong>Parameter Name</strong></td><td style="width:500px;">Description</td><td style="width:180px;">Required</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>name</strong></td><td style="width:500px;"><strong>the name of the VPC</strong></td><td style="width:180px;"><strong>true</strong></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>vpcofferingid</strong></td><td style="width:500px;"><strong>the ID of the VPC offering</strong></td><td style="width:180px;"><strong>true</strong></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>zoneid</strong></td><td style="width:500px;"><strong>the ID of the availability zone</strong></td><td style="width:180px;"><strong>true</strong></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>account</i></td><td style="width:500px;"><i>the account associated with the VPC. Must be used with the domainId parameter.</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>asnumber</i></td><td style="width:500px;"><i>the AS Number of the VPC tiers</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>bgppeerids</i></td><td style="width:500px;"><i>Ids of the Bgp Peer for the VPC</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>cidr</i></td><td style="width:500px;"><i>the cidr of the VPC. All VPC guest networks' cidrs should be within this CIDR</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>cidrsize</i></td><td style="width:500px;"><i>the CIDR size of VPC. For regular users, this is required for VPC with ROUTED mode.</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>displaytext</i></td><td style="width:500px;"><i>The display text of the VPC, defaults to its 'name'.</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>dns1</i></td><td style="width:500px;"><i>the first IPv4 DNS for the VPC</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>dns2</i></td><td style="width:500px;"><i>the second IPv4 DNS for the VPC</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>domainid</i></td><td style="width:500px;"><i>the domain ID associated with the VPC. If used with the account parameter returns the VPC associated with the account for the specified domain.</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>fordisplay</i></td><td style="width:500px;"><i>an optional field, whether to the display the vpc to the end user or not</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>ip6dns1</i></td><td style="width:500px;"><i>the first IPv6 DNS for the VPC</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>ip6dns2</i></td><td style="width:500px;"><i>the second IPv6 DNS for the VPC</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>networkdomain</i></td><td style="width:500px;"><i>VPC network domain. All networks inside the VPC will belong to this domain</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>projectid</i></td><td style="width:500px;"><i>create VPC for the project</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>publicmtu</i></td><td style="width:500px;"><i>MTU to be configured on the network VR's public facing interfaces</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>sourcenatipaddress</i></td><td style="width:500px;"><i>IPV4 address to be assigned to the public interface of the network router.This address will be used as source NAT address for the networks in ths VPC. |
| If an address is given and it cannot be acquired, an error will be returned and the network won´t be implemented,</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>start</i></td><td style="width:500px;"><i>If set to false, the VPC won't start (VPC VR will not get allocated) until its first network gets implemented. True by default.</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>userouteripresolver</i></td><td style="width:500px;"><i>(optional) for NSX based VPCs: when set to true, use the VR IP as nameserver, otherwise use DNS1 and DNS2</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| </table> |
| </div> |
| <div class="api_tablepanel"> |
| <h2>Response Tags</h2> |
| <table class="apitable"> |
| <tr class="hed"> |
| <td style="width:200px;"><strong>Response Name</strong></td><td style="width:500px;">Description</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>id</strong></td><td style="width:500px;">the id of the VPC</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>account</strong></td><td style="width:500px;">the owner of the VPC</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>asnumber</strong></td><td style="width:500px;">AS NUMBER</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>asnumberid</strong></td><td style="width:500px;">UUID of AS NUMBER</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>bgppeers</strong></td><td style="width:500px;">The BGP peers for the VPC</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>cidr</strong></td><td style="width:500px;">the cidr the VPC</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>created</strong></td><td style="width:500px;">the date this VPC was created</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>displaytext</strong></td><td style="width:500px;">an alternate display text of the VPC.</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>distributedvpcrouter</strong></td><td style="width:500px;">is VPC uses distributed router for one hop forwarding and host based network ACL's</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>dns1</strong></td><td style="width:500px;">the first IPv4 DNS for the VPC</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>dns2</strong></td><td style="width:500px;">the second IPv4 DNS for the VPC</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>domain</strong></td><td style="width:500px;">the domain name of the owner</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>domainid</strong></td><td style="width:500px;">the domain id of the VPC owner</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>domainpath</strong></td><td style="width:500px;">the domain path of the owner</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>fordisplay</strong></td><td style="width:500px;">is vpc for display to the regular user</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>icon</strong></td><td style="width:500px;">Base64 string representation of the resource icon</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>ip4routes</strong></td><td style="width:500px;">The routes for the VPC to ease adding route in upstream router</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>ip4routing</strong></td><td style="width:500px;">The IPv4 routing mode of VPC</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>ip6dns1</strong></td><td style="width:500px;">the first IPv6 DNS for the VPC</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>ip6dns2</strong></td><td style="width:500px;">the second IPv6 DNS for the VPC</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>ip6routes</strong></td><td style="width:500px;">The routes for the network to ease adding route in upstream router</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>name</strong></td><td style="width:500px;">the name of the VPC</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>network</strong></td><td style="width:500px;">the list of networks belongign to the VPC</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>networkdomain</strong></td><td style="width:500px;">the network domain of the VPC</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>project</strong></td><td style="width:500px;">the project name of the VPC</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>projectid</strong></td><td style="width:500px;">the project id of the VPC</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>publicmtu</strong></td><td style="width:500px;">MTU configured on the public interfaces of the VPC VR</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>redundantvpcrouter</strong></td><td style="width:500px;">if this VPC has redundant router</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>regionlevelvpc</strong></td><td style="width:500px;">true if VPC is region level</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>restartrequired</strong></td><td style="width:500px;">true VPC requires restart</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>state</strong></td><td style="width:500px;">state of the VPC. Can be Inactive/Enabled</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>vpcofferingid</strong></td><td style="width:500px;">vpc offering id the VPC is created from</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>vpcofferingname</strong></td><td style="width:500px;">vpc offering name the VPC is created from</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>zoneid</strong></td><td style="width:500px;">zone id of the vpc</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>zonename</strong></td><td style="width:500px;">the name of the zone the VPC belongs to</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>service(*)</strong></td><td style="width:500px;">the list of supported services</td> |
| <tr> |
| <td style="width:180px; padding-left:25px;"><strong>name</strong></td><td style="width:500px;">the service name</td> |
| </tr> |
| <tr> |
| <td style="width:180px; padding-left:25px;"><strong>capability(*)</strong></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;"><strong>provider(*)</strong></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;"><strong>tags(*)</strong></td><td style="width:500px;">the list of resource tags associated with the project</td> |
| <tr> |
| <td style="width:180px; padding-left:25px;"><strong>account</strong></td><td style="width:500px;">the account associated with the tag</td> |
| </tr> |
| <tr> |
| <td style="width:180px; padding-left:25px;"><strong>customer</strong></td><td style="width:500px;">customer associated with the tag</td> |
| </tr> |
| <tr> |
| <td style="width:180px; padding-left:25px;"><strong>domain</strong></td><td style="width:500px;">the domain associated with the tag</td> |
| </tr> |
| <tr> |
| <td style="width:180px; padding-left:25px;"><strong>domainid</strong></td><td style="width:500px;">the ID of the domain associated with the tag</td> |
| </tr> |
| <tr> |
| <td style="width:180px; padding-left:25px;"><strong>domainpath</strong></td><td style="width:500px;">path of the Domain associated with the tag</td> |
| </tr> |
| <tr> |
| <td style="width:180px; padding-left:25px;"><strong>key</strong></td><td style="width:500px;">tag key name</td> |
| </tr> |
| <tr> |
| <td style="width:180px; padding-left:25px;"><strong>project</strong></td><td style="width:500px;">the project name where tag belongs to</td> |
| </tr> |
| <tr> |
| <td style="width:180px; padding-left:25px;"><strong>projectid</strong></td><td style="width:500px;">the project id the tag belongs to</td> |
| </tr> |
| <tr> |
| <td style="width:180px; padding-left:25px;"><strong>resourceid</strong></td><td style="width:500px;">id of the resource</td> |
| </tr> |
| <tr> |
| <td style="width:180px; padding-left:25px;"><strong>resourcetype</strong></td><td style="width:500px;">resource type</td> |
| </tr> |
| <tr> |
| <td style="width:180px; padding-left:25px;"><strong>value</strong></td><td style="width:500px;">tag value</td> |
| </tr> |
| </tr> |
| </table> |
| </div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div id="footer"> |
| <div id="comments_thread"> |
| <script 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"> |
| <p> |
| 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> |
| <br> |
| Apache, CloudStack, Apache CloudStack, the Apache CloudStack logo, the CloudMonkey logo and the Apache feather logo are trademarks of The Apache Software Foundation. |
| </p> |
| </div> |
| </div> |
| </div> |
| </div> |
| </body> |
| </html> |
