Get List of vCloud External Networks

To view a list of external networks, use the following request:

1
2
GET /settings/external_networks.xml
GET /settings/external_networks.json

XML Request Example

1
curl -i -X GET -u 'user_email:api_key' --url http://onapp.test/settings/external_networks.xml -H 'Accept: application/xml' -H 'Content-type: application/xml'

JSON Request Example

1
curl -i -X GET -u 'user_email:api_key' --url http://onapp.test/settings/external_networks.json -H 'Accept: application/json' -H 'Content-type: application/json'

XML Output Example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
<external_networks type="array">
  <external_network>
      <id type="integer">3</id>
      <label>Network#17475</label>
      <identifier>asdf0000000004</identifier>
      <created_at type="dateTime">2021-12-01T16:09:14Z</created_at>
      <updated_at type="dateTime">2021-12-01T16:09:14Z</updated_at>
      <vlan nil="true"/>
      <network_group_id nil="true"/>
      <type>Networking::VCloud::ExternalNetwork</type>
      <user_id nil="true"/>
      <ip_address_pool_id nil="true"/>
      <default_outside_ip_address_id nil="true"/>
      <default_nat_rule_number type="integer">9999</default_nat_rule_number>
      <prefix_size nil="true"/>
      <is_nated type="boolean">false</is_nated>
      <vapp_id nil="true"/>
      <vdc_id nil="true"/>
      <enabled type="boolean">false</enabled>
      <gateway nil="true"/>
      <netmask nil="true"/>
      <primary_dns nil="true"/>
      <secondary_dns nil="true"/>
      <dns_suffix nil="true"/>
      <shared type="boolean">false</shared>
      <fence_mode nil="true"/>
      <vcenter_identifier nil="true"/>
      <parent_network_id nil="true"/>
      <openstack_id nil="true"/>
      <dv_switch_id nil="true"/>
      <vdc_group_id nil="true"/>
      <universal_router_id nil="true"/>
      <backing_type>UNKNOWN</backing_type>
      <ip_nets type="array">
        <ip_net>
          <cidr>69.168.237.0/24</cidr>
          <default_gateway>69.168.237.253</default_gateway>
          <ip_ranges type="array">
            <ip_range>
              <start_address>69.168.237.150</start_address>
              <end_address>69.168.237.190</end_address>
              <used_addresses type="array">
              </used_addresses>
            </ip_range>
          </ip_ranges>
        </ip_net>
        <ip_net>
          <cidr>10.0.23.0/24</cidr>
          <default_gateway nil="true"/>
          <ip_ranges type="array">
            <ip_range>
              <start_address>10.0.23.1</start_address>
              <end_address>10.0.23.11</end_address>
              <used_addresses type="array">
                <used_address>
                  <ip_address>192.168.0.7</ip_address>
                  <assigned nil="true"/>
                  <virtual_server type="array">
                  </virtual_server>
                </used_address>
              </used_addresses>
            </ip_range>
          </ip_ranges>
        </default_gateway>
      </ip_net>
    </ip_nets>
 </external_network>
</external_networks>

Where:

id - the ID of the external network
label - the name of the external network
identifier - the identifier of the external network
created_at - the date when the external network was created, in the [YYYY][MM][DD]T[hh][mm][ss]Z format
updated_at - the date when the external network was updated, in the [YYYY][MM][DD]T[hh][mm][ss]Z format
vlan - VLAN number
network_group_id - the ID of the network zone
type - the type of the network
user_id - the ID of the owner
ip_address_pool_id - the ID of the IP address pool
default_outside_ip_address_id - the ID of the outside IP address
default_nat_rule_number - the number of the default NAT rule
prefix_size - the prefix size of the subnet
is_nated - true if the NAT rule is used for translating the traffic; otherwise, false if you are using your firewall with an external IP address
vapp_id - the vApp associated with the external network
vdc_id - the resource pool associated with the external network
enabled - true if the external network is enabled; otherwise, false
gateway - the gateway associated with the network
netmask - the IP of the network mask
primary_dns - the IP address of the primary domain name system (DNS) server
secondary_dns - the IP address of the secondary domain name system (DNS) server
dns_suffix - the DNS suffix
shared - true if the external network is shared; otherwise, false
fence_mode - isolation type of the network
vcenter_identifier - the vCenter identifier of the external network
parent_network_id - the ID of the parent network
openstack_id - Openstack ID
dv_switch_id - DV Switch ID
vdc_group_id - the ID of the VDC (resource pool) group
universal_router_id - the ID of the universal router
backing_type - the backing type, can be standart, nsxt, or unknown
ip_nets - the array of IP nets of the external network
- ip_net - the IP net of the external network
  - cidr - CIDR
  - default_gateway - default gateway for an IP net
  - ip_ranges - the array of IP address ranges within the external network
    - ip_range - the range of IP addresses
      - start_address - the start address of an IP range
      - end_address - the end address of an IP range
      - used_addresses - the array of addresses used for the external network
        used_address - the address used for the external network
        ip_address - used IP address
        assigned - true if IP addresses are assigned to a virtual server; otherwise, false
        virtual_server - the array of virtual servers to which IP addresses are assigned

Page History

v. 6.7 Edge 1

Added the following arrays and parameters:
- type
- vcenter_identifier
- parent_network_id
- openstack_id
- dv_switch_id
- vdc_group_id
- universal_router_id
- backing_type
- ip_nets
- ip_net
- cidr
- default_gateway
- ip_ranges
- ip_range
- start_address
- end_address
- used_addresses
- used_address
- ip_address
- assigned
- virtual_server