To view the details of an edge gateway, use the following request:

GET /nsxt_edge_gateways/:id.xml
GET /nsxt_edge_gateways/:id.json

XML Request example 

curl -i -X GET http://onapp.test/nsxt_edge_gateways/22.xml -u user:userpass
CODE

JSON Request Example 

curl -i -X GET http://onapp.test/nsxt_edge_gateways/22.json -u user:userpass
CODE

XML Output Example 

<vcloud_nsxt_edge_gateway>
  <id type="integer">7</id>
  <identifier>8CCD754C-90EC-BA80-F46D-D06A9874029B</identifier>
  <label>plak4yrj35b0tdk9k51i4vgf5z3wn7rtzj5</label>
  <status nil="true"/>
  <description>Aut maxime eius officiis dolores sed modi nobis impedit.</description>
  <distributed_routing_enabled type="boolean">false</distributed_routing_enabled>
  <vdc_id type="integer">13</vdc_id>
  <created_at type="dateTime">2021-09-14T13:55:45Z</created_at>
  <updated_at type="dateTime">2021-09-14T13:55:45Z</updated_at>
  <firewalls_locked type="boolean">false</firewalls_locked>
  <ip_settings>
    <external_network_id type="integer">7</external_network_id>
    <ip_nets type="array">
      <ip_net>
        <ip_net_configuration_id type="integer">7</ip_net_configuration_id>
        <ip_address nil="true"/>
        <ip_net>10.0.23.0/24</ip_net>
        <sub_allocated_ip_ranges type="array">
          <sub_allocated_ip_range>
            <start_address>192.168.1.1</start_address>
            <end_address>192.168.1.10</end_address>
          </sub_allocated_ip_range>
        </sub_allocated_ip_ranges>
      </ip_net>
    </ip_nets>
  </ip_settings>
</vcloud_nsxt_edge_gateway>
CODE

Where:

id - ID of NSX-T edge gateway

identifier - identifier of NSX-T edge gateway

label - the name of NSX-T edge gateway

status - NSX-T edge gateway status

description - additional info about the edge gateway if any

distributed_routing_enabled - true if distributed routing is enabled for the edge gateway, otherwise false

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

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

firewalls_lockedtrue if transaction UpdateNsxtFirewallRulesOfEdgeGateway is in progress; otherwise false

ip_settings - the array of parameters that relates to IP settings

external_network_id - ID of the external network to which the edge gateway is connected

ip_nets - the array of parameters that relate to IP nets

ip_net_configuration_id - ID of IP net configuration

ip_address - external address, it is shown if ID address is enabled by default and used, otherwise true

sub_allocated_ip_ranges - the array that relates to sub-allocated IP ranges of the external network to the edge gateway

start_address - start address of sub-allocated IP range

end_address - end address of sub-allocated IP range


Page History

v. 6.6 Edge 4

Added the following arrays and parameters: ip_settings, external_network_idip_nets, ip_net_configuration_idip_address, ip_netsub_allocated_ip_ranges, start_address, end_address.