static/api/apidocs-4.16/apis/listVpnConnections.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>listVpnConnections</h1> <p>Lists site to site vpn connection gateways</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;"><i>account</i></td><td style="width:500px;"><i>list resources by account. Must be used with the domainId parameter.</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>list only resources belonging to the domain specified</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>list resources by display flag; only ROOT admin is eligible to pass this parameter</i></td><td style="width:180px;"><i>false</i></td> </tr> <tr> <td style="width:200px;"><i>id</i></td><td style="width:500px;"><i>id of the vpn connection</i></td><td style="width:180px;"><i>false</i></td> </tr> <tr> <td style="width:200px;"><i>isrecursive</i></td><td style="width:500px;"><i>defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.</i></td><td style="width:180px;"><i>false</i></td> </tr> <tr> <td style="width:200px;"><i>keyword</i></td><td style="width:500px;"><i>List by keyword</i></td><td style="width:180px;"><i>false</i></td> </tr> <tr> <td style="width:200px;"><i>listall</i></td><td style="width:500px;"><i>If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false</i></td><td style="width:180px;"><i>false</i></td> </tr> <tr> <td style="width:200px;"><i>page</i></td><td style="width:500px;"><i></i></td><td style="width:180px;"><i>false</i></td> </tr> <tr> <td style="width:200px;"><i>pagesize</i></td><td style="width:500px;"><i></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>list objects by project</i></td><td style="width:180px;"><i>false</i></td> </tr> <tr> <td style="width:200px;"><i>vpcid</i></td><td style="width:500px;"><i>id of vpc</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. Multiple entries are separated by a single comma character (,).</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>forceencap</strong></td><td style="width:500px;">if Force NAT Encapsulation is enabled for 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>ikeversion</strong></td><td style="width:500px;">Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike</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>splitconnections</strong></td><td style="width:500px;">Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.</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="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/listVpnConnections.html (186 lines of code) (raw):