| <!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_master"> |
| <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 v4.1.0 Root Admin API Reference |
| </span> |
| <p></p> |
| <h1>updatePortForwardingRule</h1> |
| <p>Updates a port forwarding rule. Only the private port and the virtual machine can be updated.</p> |
| </div> |
| <div class="api_titlebox_right"> |
| <a class="api_backbutton" href="../TOC_Root_Admin.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>ipaddressid</strong></td><td style="width:500px;"><strong>the IP address id of the port forwarding rule</strong></td><td style="width:180px;"><strong>true</strong></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>privateport</strong></td><td style="width:500px;"><strong>the private port of the port forwarding rule</strong></td><td style="width:180px;"><strong>true</strong></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>protocol</strong></td><td style="width:500px;"><strong>the protocol for the port fowarding rule. Valid values are TCP or UDP.</strong></td><td style="width:180px;"><strong>true</strong></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>publicport</strong></td><td style="width:500px;"><strong>the public port of the port forwarding rule</strong></td><td style="width:180px;"><strong>true</strong></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>privateip</i></td><td style="width:500px;"><i>the private IP address of the port forwarding rule</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>virtualmachineid</i></td><td style="width:500px;"><i>the ID of the virtual machine for the port forwarding rule</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 port forwarding rule</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>cidrlist</strong></td><td style="width:500px;">the cidr list to forward traffic from</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>ipaddress</strong></td><td style="width:500px;">the public ip address for the port forwarding rule</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>ipaddressid</strong></td><td style="width:500px;">the public ip address id for the port forwarding rule</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>privateendport</strong></td><td style="width:500px;">the ending port of port forwarding rule's private port range</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>privateport</strong></td><td style="width:500px;">the starting port of port forwarding rule's private port range</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>protocol</strong></td><td style="width:500px;">the protocol of the port forwarding rule</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>publicendport</strong></td><td style="width:500px;">the ending port of port forwarding rule's private port range</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>publicport</strong></td><td style="width:500px;">the starting port of port forwarding rule's public port range</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>state</strong></td><td style="width:500px;">the state of the rule</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>virtualmachinedisplayname</strong></td><td style="width:500px;">the VM display name for the port forwarding rule</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>virtualmachineid</strong></td><td style="width:500px;">the VM ID for the port forwarding rule</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>virtualmachinename</strong></td><td style="width:500px;">the VM name for the port forwarding rule</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>tags(*)</strong></td><td style="width:500px;">the list of resource tags associated with the rule</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="footer_mainmaster"> |
| <p>Copyright © 2012 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 and the Apache feather logo are trademarks of The Apache Software Foundation.</p> |
| </div> |
| </div> |
| </div> |
| </div> |
| </body> |
| </html> |
