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>
    <advanced_enabled type="boolean">true</advanced_enabled>
    <created_at type="dateTime">2020-11-16T10:55:09Z</created_at>
    <description></description>
    <gateway_backing_config>compact</gateway_backing_config>
    <ha_enabled type="boolean">false</ha_enabled>
    <id type="integer">3</id>
    <identifier>02048021-8945-4942-944b-17ec1a9b5158</identifier>
    <label>RD_edge_second</label>
    <status>READY</status>
    <updated_at type="dateTime">2020-11-16T10:55:09Z</updated_at>
    <use_default_route_for_dns_relay type="boolean">false</use_default_route_for_dns_relay>
    <vdc_id type="integer">4</vdc_id>
    <firewall_service nil="true"/>
    <gateway_ipsec_vpn_service nil="true"/>
    <nat_service nil="true"/>
    <nsx_edge>
      <id type="integer">6</id>
      <label>vse-RD_edge_second</label>
      <identifier>edge-4</identifier>
      <manager_id type="integer">2</manager_id>
      <state>deployed</state>
      <status>GREEN</status>
      <created_at type="dateTime">2020-11-16T11:02:39Z</created_at>
      <updated_at type="dateTime">2020-11-16T11:02:39Z</updated_at>
    </nsx_edge>
  </edge_gateway>
  <edge_gateway>
    <advanced_enabled type="boolean">true</advanced_enabled>
    <created_at type="dateTime">2020-11-16T10:55:09Z</created_at>
    <description></description>
    <gateway_backing_config>compact</gateway_backing_config>
    <ha_enabled type="boolean">false</ha_enabled>
    <id type="integer">4</id>
    <identifier>984b2bd1-0b03-4327-b9fb-80abb4e9ae1a</identifier>
    <label>RD_edge_first</label>
    <status>READY</status>
    <updated_at type="dateTime">2020-11-16T10:55:09Z</updated_at>
    <use_default_route_for_dns_relay type="boolean">false</use_default_route_for_dns_relay>
    <vdc_id type="integer">4</vdc_id>
    <firewall_service nil="true"/>
    <gateway_ipsec_vpn_service nil="true"/>
    <nat_service nil="true"/>
    <nsx_edge>
      <id type="integer">5</id>
      <label>vse-RD_edge_first</label>
      <identifier>edge-3</identifier>
      <manager_id type="integer">2</manager_id>
      <state>deployed</state>
      <status>GREEN</status>
      <created_at type="dateTime">2020-11-16T11:02:37Z</created_at>
      <updated_at type="dateTime">2020-11-16T11:02:37Z</updated_at>
    </nsx_edge>
  </edge_gateway>
</edge_gateways>

Where:

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

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

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 - equal to nil if firewall service is imported into CP

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

nat_service - equal to nil if is the NAT service of the edge gateway is imported into CP

nsx_edge - an array of parameters related to the NSX edge:

id - ID of the NSX edge

label - the name of the NSX edge

identifier - the identifier of the NSX edge

manager_id - ID of NSX manager

state - indicates if the NSX edge is deployed 

status - indicates the status of the NSX edge

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

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

edge_gateway - an array of parameters related to the edge gateway:

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

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

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 - equal to nil if firewall service is imported into CP

gateway_ipsec_vpn_service - equal to nil if the VPN service of the edge gateway is enabled

nat_service - equal to nil if is the NAT service of the edge gateway is imported into CP


Page History

v. 6.4

  • added nsx_edge parameter together with the subsequent parameters (id, label, identifier, manager_id, state, status, created_at, updated_at)
  • added edge_gateway parameter together with the subsequent parameters (advanced_enabled, created_at, description, gateway_backing_config, ha_enabled, id, identifier, label, status, updated_at, use_default_route_for_dns_relay, vdc_id, firewall_service, gateway_ipsec_vpn_service, nat_service)

v. 5.4

  • added advanced_enabled parameter