Get List of Provider Resource Pools

Ensure that Provider resource pools permissions are on. For more information about permissions refer to the Permissions section of this guide.

To view the list of provider vDCs, use the following request:

1
2
GET /provider_vdcs.xml
GET /provider_vdcs.json

XML Request Example

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

JSON Request Example

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

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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
<provider_vdcs type="array">
  <provider_vdc>
    <id type="integer">13</id>
    <label>pvDC 1 Cluster1</label>
    <cpu_allocated type="integer">0</cpu_allocated>
    <cpu_total type="integer">35880</cpu_total>
    <cpu_used type="integer">11692</cpu_used>
    <created_at type="datetime">2016-04-19T12:57:27+03:00</created_at>
    <enabled type="boolean">true</enabled>
    <hypervisor_id type="integer">24</hypervisor_id>
    <identifier>4b5330c2-449c-4b30-b156-fb4901c1235b</identifier>
    <memory_allocated type="integer">0</memory_allocated>
    <memory_total type="integer">50683</memory_total>
    <memory_used type="integer">18716</memory_used>
    <network_provider_type type="integer">1</network_provider_type>
    <updated_at type="datetime">2016-05-06T01:00:34+03:00</updated_at>
    <external_networks type="array">
      <external_network>
        <backing_type>DV_PORTGROUP</backing_type>
          <created_at type="datetime">2016-04-19T12:58:12+03:00</created_at>
          <default_nat_rule_number type="integer">9999</default_nat_rule_number>
          <default_outside_ip_address_id nil="true"/>
          <dns_suffix nil="true"/>
          <dvportgroup nil="true"/>
          <enabled type="boolean">false</enabled>
          <fence_mode>isolated</fence_mode>
          <gateway>69.168.237.1</gateway>
          <id type="integer">466</id>
          <identifier>00cfb7da-f5e4-4d3e-bcfd-f912aac4faf3</identifier>
          <ip_address_pool_id nil="true"/>
          <is_nated type="boolean">true</is_nated>
          <label>Public DC1</label>
          <netmask>255.255.255.0</netmask>
          <network_group_id type="integer">323</network_group_id>
          <parent_network_id nil="true"/>
          <prefix_size nil="true"/>
          <primary_dns nil="true"/>
          <secondary_dns nil="true"/>
          <shared type="boolean">false</shared>
          <updated_at type="datetime">2016-04-22T16:51:40+03:00</updated_at>
          <user_id nil="true"/>
          <vapp_id nil="true"/>
          <vdc_id nil="true"/>
          <vlan nil="true"/>
      </external_network>
      <external_network>...</external_network>
    </external_networks>
    <storage_policies type="array">
      <storage_policy>
        <closed type="boolean">false</closed>
        <created_at type="datetime">2016-04-19T12:57:27+03:00</created_at>
        <draas_id nil="true"/>
        <federation_enabled type="boolean">false</federation_enabled>
        <federation_id nil="true"/>
        <hypervisor_id type="integer">24</hypervisor_id>
        <id type="integer">304</id>
        <identifier>83a2105b-47f1-4f21-a9de-43cfad2a82bd</identifier>
        <label>* for vCD 8</label>
        <location_group_id nil="true"/>
        <preconfigured_only type="boolean">false</preconfigured_only>
        <provider_vdc_id type="integer">13</provider_vdc_id>
        <traded type="boolean">false</traded>
        <updated_at type="datetime">2016-04-19T12:57:27+03:00</updated_at>
        <default_max_iops type="integer">15000</default_max_iops>
        <default_burst_iops type="integer">15000</default_burst_iops>
        <min_disk_size type="integer">1</min_disk_size>
      </storage_policy>
      <storage_policy>...<storage_policy>
    </storage_policies>
    <network_pools type="array">
      <network_pool>
        <closed type="boolean">false</closed>
        <created_at type="datetime">2016-04-19T12:57:27+03:00</created_at>
        <draas_id nil="true"/>
        <federation_enabled type="boolean">false</federation_enabled>
        <federation_id nil="true"/>
        <hypervisor_id type="integer">24</hypervisor_id>
        <id type="integer">306</id>
        <identifier>routed-131cfd1d-97dd-4531-96cf-ce2dc2ac426f</identifier>
        <label>pvDC 1 Cluster1-VXLAN-NP Routed Networks for vCD 8</label>
        <location_group_id nil="true"/>
        <preconfigured_only type="boolean">false</preconfigured_only>
        <provider_vdc_id type="integer">13</provider_vdc_id>
        <traded type="boolean">false</traded>
        <updated_at type="datetime">2016-04-19T12:57:27+03:00</updated_at>
      </network_pool>
      <network_pool>...</network_pool>
    </network_pools>
  </provider_vdc>
  <provider_vdc>...</provider_vdc>
</provider_vdcs>

Where:

id - the ID of the provider resource pool
label - the name of the provider resource pool
cpu_allocated - the amount of CPU (MHz) allocated to this provider resource pool
cpu_total - the total amount of CPU on the provider resource pool
cpu_used - the number of used CPU resources
created_at - the date in the [YYYY][MM][DD]T[hh][mm][ss]Z format
enabled - true if the provider resource pool is enabled; otherwise, false
hypervisor_id - the ID of the compute resource
identifier - the identifier of the provider resource pool
memory_allocated - the amount of memory (MB) allocated to this provider resource pool
memory_total - the total amount of memory on the provider resource pool
memory_used - the amount of used memory (MB)
network_provider_type - the type of the network provider, where 1 stands for NSX-V, 2 stands for NSX-T, and 0 for none
updated_at - the date in the [YYYY][MM][DD]T[hh][mm][ss]Z format
external_networks - the array of parameters related to the external network(s) associated with the provider resource pool
- backing_type - NSX_TIER0 for NSX-T and DVPORT_GOUP for NSX-V
- created_at - the date in the [YYYY][MM][DD]T[hh][mm][ss]Z format
- default_nat_rule_number - default NAT rule
- default_outside_ip_address_id - ID of the outside IP address
- dns_suffix - the DNS suffix
- dvportgroup - the port group that backs this network
- enabled - whether the network is enabled or not
- fence_mode - isolation type of the network
- gateway - the gateway associated with the network
- id - the ID of the network
- identifier - the identifier of the network
- ip_address_pool_id - the ID of the IP Address Pool
- is_nated - true if the NAT is used for translating the traffic; false if you are using your own firewall with the external IP address
- label - the name of the network
- netmask - IP of the network mask
- network_group_id - network zone ID
- parent_network_id - not relevant to external networks
- prefix_size - subnet prefix size
- primary_dns - IP address of the primary domain name system (DNS) server
- secondary_dns - IP address of the secondary domain name system (DNS) server
- shared - whether this external network is shared or not
- updated_at - the date in the [YYYY][MM][DD]T[hh][mm][ss]Z format
- user_id - owner ID
- vapp_id - the vApp associated with the network
- vdc_id - the resource pool associated with the network
- vlan - VLAN number
storage_policies - the array of parameters related to the storage policies associated with the vDC
- closed - not relevant to storage policies
- created_at - the date in the [YYYY][MM][DD]T[hh][mm][ss]Z format
- draas_id - not relevant to storage policies
- federation_enabled - not relevant to storage policies
- federation_id - not relevant to storage policies
- hypervisor_id - the ID of the compute resource
- id - the ID of the storage policy
- identifier - the identifier of the storage policy
- label - the name of the storage policy
- location_group_id - the ID of a location group the storage policy is assigned to
- preconfigured_only - whether the storage policy can be used for creating Instance Package VSs only. When this option is enabled, the storage policy cannot be used during custom virtual server (VSs built by setting resources manually) creation.
- provider_vdc_id - the provider resource pool ID
- traded - not relevant to storage policies
- updated_at - the date in the [YYYY][MM][DD]T[hh][mm][ss]Z format
- default_max_iops - the default maximum IOPS value for the data store zone
- default_burst_iops - the default peak IOPS value
- min_disk_size - minimum disk size for the data store zone
network_pools - the array of parameters related to the network pool(s) associated with the vDC
- closed - not relevant to network pools
- created_at - the date in the [YYYY][MM][DD]T[hh][mm][ss]Z format
- draas_id - not relevant to network pools
- federation_enabled - not relevant to network pools
- federation_id - not relevant to network pools
- hypervisor_id - the ID of the compute resource
- id - the ID of the network pool
- identifier - the identifier of the network pool
- label - the name of the network pool
- location_group_id - the ID of a location group the network pool is assigned to
- preconfigured_only - whether the network pool can be used for creating Instance Package VSs only. When this option is enabled, the pool cannot be used during custom virtual server (VSs built by setting resources manually) creation.
- provider_vdc_id - the provider resource pool ID
- traded - not relevant to storage policies

Page History:

v. 6.6 Edge 4

Added the network_provider_type and backing_typе parameters.