| <!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.4.1 User API Reference |
| </span> |
| <p></p> |
| <h1>createVpnConnection</h1> |
| <p>Create site to site vpn connection</p> |
| </div> |
| <div class="api_titlebox_right"> |
| <a class="api_backbutton" href="../TOC_User.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>s2scustomergatewayid</strong></td><td style="width:500px;"><strong>id of the customer gateway</strong></td><td style="width:180px;"><strong>true</strong></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>s2svpngatewayid</strong></td><td style="width:500px;"><strong>id of the vpn gateway</strong></td><td style="width:180px;"><strong>true</strong></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>fordisplay</i></td><td style="width:500px;"><i>an optional field, whether to the display the vpn to the end user or not</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>passive</i></td><td style="width:500px;"><i>connection is passive or not</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 connection ID</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>account</strong></td><td style="width:500px;">the owner</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>cidrlist</strong></td><td style="width:500px;">guest cidr list of the customer gateway</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>created</strong></td><td style="width:500px;">the date and time the host was created</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 owner</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>dpd</strong></td><td style="width:500px;">if DPD is enabled for customer gateway</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>esplifetime</strong></td><td style="width:500px;">Lifetime of ESP SA of customer gateway</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>esppolicy</strong></td><td style="width:500px;">ESP policy of the customer gateway</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>fordisplay</strong></td><td style="width:500px;">is connection for display to the regular user</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>gateway</strong></td><td style="width:500px;">public ip address id of the customer gateway</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>ikelifetime</strong></td><td style="width:500px;">Lifetime of IKE SA of customer gateway</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>ikepolicy</strong></td><td style="width:500px;">IKE policy of the customer gateway</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>ipsecpsk</strong></td><td style="width:500px;">IPsec Preshared-Key of the customer gateway</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>passive</strong></td><td style="width:500px;">State of vpn connection</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>project</strong></td><td style="width:500px;">the project name</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>projectid</strong></td><td style="width:500px;">the project id</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>publicip</strong></td><td style="width:500px;">the public IP address</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>removed</strong></td><td style="width:500px;">the date and time the host was removed</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>s2scustomergatewayid</strong></td><td style="width:500px;">the customer gateway ID</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>s2svpngatewayid</strong></td><td style="width:500px;">the vpn gateway ID</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>state</strong></td><td style="width:500px;">State of vpn connection</td> |
| </tr> |
| </table> |
| </div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div id="footer"> |
| <div id="footer_mainmaster"> |
| <p>Copyright © 2014 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> |