Get List of Edge Gateways

To view the list of edge gateways, use the following request:

GET /edge_gateways.xml
GET /edge_gateways.json

XML Request Example 

curl -i -X GET http://onapp.test/edge_gateways.xml -u user:userpass

JSON Request Example 

 curl -i -X GET http://onapp.test/edge_gateways.json -u user:userpass

XML Output Example 

<edge_gateways type="array">
  <edge_gateway>
    <created_at type="datetime">2016-07-22T12:50:28+03:00</created_at>
     <description></description>
     <gateway_backing_config>compact</gateway_backing_config>
     <ha_enabled type="boolean">false</ha_enabled>
     <advanced_enabled type="boolean">false</advanced_enabled>
     <id type="integer">22</id>
     <identifier>059394f3-cbbe-421f-8623-2c34b0f5a385</identifier>
     <label>RK5</label>
     <status>1</status>
     <updated_at type="datetime">2016-07-22T12:50:28+03:00</updated_at>
     <use_default_route_for_dns_relay type="boolean">false</use_default_route_for_dns_relay>
     <vdc_id type="integer">124</vdc_id>
     <firewall_service>
       <created_at type="datetime">2016-07-22T12:50:28+03:00</created_at>
       <default_action>DROP</default_action>
       <enabled type="boolean">true</enabled>
       <id type="integer">64</id>
       <log_default_action type="boolean">false</log_default_action>
       <updated_at type="datetime">2016-07-22T12:50:28+03:00</updated_at>
     </firewall_service>
     <gateway_ipsec_vpn_service>
       <created_at type="datetime">2016-07-22T12:50:28+03:00</created_at>
       <enabled type="boolean">true</enabled>
       <id type="integer">66</id>
       <updated_at type="datetime">2016-07-22T12:50:28+03:00</updated_at>
     </gateway_ipsec_vpn_service>
     <nat_service>
       <created_at type="datetime">2016-07-22T12:50:28+03:00</created_at>
       <enabled type="boolean">true</enabled>
       <id type="integer">65</id>
       <updated_at type="datetime">2016-07-22T12:50:28+03:00</updated_at>
     </nat_service>
     </edge_gateway>
     <edge_gateway>...</edge_gateway>
   </edge_gateways>

Where:

created_at - the date in the [YYYY][MM][DD]T[hh][mm][ss]Z format

description - the description of the edge gateway by the admin

gateway_backing_config - the configuration of the edge gateway, can be: compact, full, full-4

ha_enabled - whether high availability option is enabled for this edge gateway or not

advanced_enabled - true, if edge gateway is advanced, otherwise false

id - ID of the edge gateway

identifier - the identifier of the edge gateway

label - the name of the edge gateway

status - edge gateway status

updated_at - the date in the [YYYY][MM][DD]T[hh][mm][ss]Z format

use_default_route_for_dns_relay - whether default route for dns relay is used or not 

vdc_id - ID of the vDC the edge gateway is associated with

firewall_service - an array of parameters related to the firewall service of the edge gateway:

created_at - the date in the [YYYY][MM][DD]T[hh][mm][ss]Z format

default_action - the default action of the firawall service: DROP or ALLOW

enabled - whether the firewall rule is enabled or not

id - ID of the firewall service

log_default_action - whether the default action will be logged or not

updated_at - the date in the [YYYY][MM][DD]T[hh][mm][ss]Z format

gateway_ipsec_vpn_service - an array of parameters related to the VPN service of the edge gateway:

created_at - the date in the [YYYY][MM][DD]T[hh][mm][ss]Z format

enabled - whether VPN service is enabled or not

id - ID of the VPN service

updated_at - the date in the [YYYY][MM][DD]T[hh][mm][ss]Z format

nat_service - an array of parameters related to the NAT service of the edge gateway:

created_at - the date in the [YYYY][MM][DD]T[hh][mm][ss]Z format

enabled - whether NAT service is enabled or not

id - ID of the NAT service

updated_at - the date in the [YYYY][MM][DD]T[hh][mm][ss]Z format


Page History

v. 5.4

  • added advanced_enabled parameter