static/api/apidocs-4.16/apis/updateNetwork.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"> <span> Apache CloudStack 4.16.0.0 Root Admin API Reference </span> <p></p> <h1>updateNetwork</h1> <p>Updates a network</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>id</strong></td><td style="width:500px;"><strong>the ID of the network</strong></td><td style="width:180px;"><strong>true</strong></td> </tr> <tr> <td style="width:200px;"><i>changecidr</i></td><td style="width:500px;"><i>Force update even if CIDR type is different</i></td><td style="width:180px;"><i>false</i></td> </tr> <tr> <td style="width:200px;"><i>customid</i></td><td style="width:500px;"><i>an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only</i></td><td style="width:180px;"><i>false</i></td> </tr> <tr> <td style="width:200px;"><i>displaynetwork</i></td><td style="width:500px;"><i>an optional field, whether to the display the network to the end user or not.</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 new display text for the network</i></td><td style="width:180px;"><i>false</i></td> </tr> <tr> <td style="width:200px;"><i>forced</i></td><td style="width:500px;"><i>Setting this to true will cause a forced network update,</i></td><td style="width:180px;"><i>false</i></td> </tr> <tr> <td style="width:200px;"><i>guestvmcidr</i></td><td style="width:500px;"><i>CIDR for guest VMs, CloudStack allocates IPs to guest VMs only from this CIDR</i></td><td style="width:180px;"><i>false</i></td> </tr> <tr> <td style="width:200px;"><i>hideipaddressusage</i></td><td style="width:500px;"><i>when true ip address usage for the network will not be exported by the listUsageRecords API</i></td><td style="width:180px;"><i>false</i></td> </tr> <tr> <td style="width:200px;"><i>name</i></td><td style="width:500px;"><i>the new name for the network</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>network domain</i></td><td style="width:180px;"><i>false</i></td> </tr> <tr> <td style="width:200px;"><i>networkofferingid</i></td><td style="width:500px;"><i>network offering ID</i></td><td style="width:180px;"><i>false</i></td> </tr> <tr> <td style="width:200px;"><i>updateinsequence</i></td><td style="width:500px;"><i>if true, we will update the routers one after the other. applicable only for redundant router based networks using virtual router as provider</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 network</td> </tr> <tr> <td style="width:200px;"><strong>account</strong></td><td style="width:500px;">the owner of the network</td> </tr> <tr> <td style="width:200px;"><strong>aclid</strong></td><td style="width:500px;">ACL Id associated with the VPC network</td> </tr> <tr> <td style="width:200px;"><strong>aclname</strong></td><td style="width:500px;">ACL name associated with the VPC network</td> </tr> <tr> <td style="width:200px;"><strong>acltype</strong></td><td style="width:500px;">acl type - access type to the network</td> </tr> <tr> <td style="width:200px;"><strong>broadcastdomaintype</strong></td><td style="width:500px;">Broadcast domain type of the network</td> </tr> <tr> <td style="width:200px;"><strong>broadcasturi</strong></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;"><strong>canusefordeploy</strong></td><td style="width:500px;">list networks available for vm deployment</td> </tr> <tr> <td style="width:200px;"><strong>cidr</strong></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;"><strong>created</strong></td><td style="width:500px;">the date this network was created</td> </tr> <tr> <td style="width:200px;"><strong>details</strong></td><td style="width:500px;">the details of the network</td> </tr> <tr> <td style="width:200px;"><strong>displaynetwork</strong></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;"><strong>displaytext</strong></td><td style="width:500px;">the displaytext of the network</td> </tr> <tr> <td style="width:200px;"><strong>dns1</strong></td><td style="width:500px;">the first DNS for the network</td> </tr> <tr> <td style="width:200px;"><strong>dns2</strong></td><td style="width:500px;">the second DNS for the network</td> </tr> <tr> <td style="width:200px;"><strong>domain</strong></td><td style="width:500px;">the domain name of the network owner</td> </tr> <tr> <td style="width:200px;"><strong>domainid</strong></td><td style="width:500px;">the domain id of the network owner</td> </tr> <tr> <td style="width:200px;"><strong>externalid</strong></td><td style="width:500px;">The external id of the network</td> </tr> <tr> <td style="width:200px;"><strong>gateway</strong></td><td style="width:500px;">the network's gateway</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>ip6cidr</strong></td><td style="width:500px;">the cidr of IPv6 network</td> </tr> <tr> <td style="width:200px;"><strong>ip6gateway</strong></td><td style="width:500px;">the gateway of IPv6 network</td> </tr> <tr> <td style="width:200px;"><strong>isdefault</strong></td><td style="width:500px;">true if network is default, false otherwise</td> </tr> <tr> <td style="width:200px;"><strong>ispersistent</strong></td><td style="width:500px;">list networks that are persistent</td> </tr> <tr> <td style="width:200px;"><strong>issystem</strong></td><td style="width:500px;">true if network is system, false otherwise</td> </tr> <tr> <td style="width:200px;"><strong>name</strong></td><td style="width:500px;">the name of the network</td> </tr> <tr> <td style="width:200px;"><strong>netmask</strong></td><td style="width:500px;">the network's netmask</td> </tr> <tr> <td style="width:200px;"><strong>networkcidr</strong></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;"><strong>networkdomain</strong></td><td style="width:500px;">the network domain</td> </tr> <tr> <td style="width:200px;"><strong>networkofferingavailability</strong></td><td style="width:500px;">availability of the network offering the network is created from</td> </tr> <tr> <td style="width:200px;"><strong>networkofferingconservemode</strong></td><td style="width:500px;">true if network offering is ip conserve mode enabled</td> </tr> <tr> <td style="width:200px;"><strong>networkofferingdisplaytext</strong></td><td style="width:500px;">display text of the network offering the network is created from</td> </tr> <tr> <td style="width:200px;"><strong>networkofferingid</strong></td><td style="width:500px;">network offering id the network is created from</td> </tr> <tr> <td style="width:200px;"><strong>networkofferingname</strong></td><td style="width:500px;">name of the network offering the network is created from</td> </tr> <tr> <td style="width:200px;"><strong>physicalnetworkid</strong></td><td style="width:500px;">the physical network id</td> </tr> <tr> <td style="width:200px;"><strong>project</strong></td><td style="width:500px;">the project name of the address</td> </tr> <tr> <td style="width:200px;"><strong>projectid</strong></td><td style="width:500px;">the project id of the ipaddress</td> </tr> <tr> <td style="width:200px;"><strong>receivedbytes</strong></td><td style="width:500px;">the total number of network traffic bytes received</td> </tr> <tr> <td style="width:200px;"><strong>redundantrouter</strong></td><td style="width:500px;">If the network has redundant routers enabled</td> </tr> <tr> <td style="width:200px;"><strong>related</strong></td><td style="width:500px;">related to what other network configuration</td> </tr> <tr> <td style="width:200px;"><strong>reservediprange</strong></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;"><strong>restartrequired</strong></td><td style="width:500px;">true network requires restart</td> </tr> <tr> <td style="width:200px;"><strong>sentbytes</strong></td><td style="width:500px;">the total number of network traffic bytes sent</td> </tr> <tr> <td style="width:200px;"><strong>specifyipranges</strong></td><td style="width:500px;">true if network supports specifying ip ranges, false otherwise</td> </tr> <tr> <td style="width:200px;"><strong>state</strong></td><td style="width:500px;">state of the network</td> </tr> <tr> <td style="width:200px;"><strong>strechedl2subnet</strong></td><td style="width:500px;">true if network can span multiple zones</td> </tr> <tr> <td style="width:200px;"><strong>subdomainaccess</strong></td><td style="width:500px;">true if users from subdomains can access the domain level network</td> </tr> <tr> <td style="width:200px;"><strong>traffictype</strong></td><td style="width:500px;">the traffic type of the network</td> </tr> <tr> <td style="width:200px;"><strong>type</strong></td><td style="width:500px;">the type of the network</td> </tr> <tr> <td style="width:200px;"><strong>vlan</strong></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;"><strong>vpcid</strong></td><td style="width:500px;">VPC the network belongs to</td> </tr> <tr> <td style="width:200px;"><strong>vpcname</strong></td><td style="width:500px;">Name of the VPC to which this network belongs</td> </tr> <tr> <td style="width:200px;"><strong>zoneid</strong></td><td style="width:500px;">zone id of the network</td> </tr> <tr> <td style="width:200px;"><strong>zonename</strong></td><td style="width:500px;">the name of the zone the network belongs to</td> </tr> <tr> <td style="width:200px;"><strong>zonesnetworkspans</strong></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;"><strong>service(*)</strong></td><td style="width:500px;">the list of 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 network</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>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 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"> <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>

static/api/apidocs-4.16/apis/updateNetwork.html (354 lines of code) (raw):