7.0
7.0
Docs menu
MENU

Get Orchestration Model Details

To get the details of a particular orchestration model, use the following request:

1
2

GET /vcloud/templates/:template_id.xml
GET /vcloud/templates/:template_id.json

XML Request Example

1

curl -i -X GET http://onapp.test/vcloud/templates/12.xml -u user:userpass

JSON Request Example

1

curl -i -X GET http://onapp.test/vcloud/templates/12.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

<vcloud_template>
  <cpu_allocation_customizable type="boolean">true</cpu_allocation_customizable>
  <cpu_allocation_default type="integer">1</cpu_allocation_default>
  <cpu_allocation_max type="integer">12</cpu_allocation_max>
  <cpu_allocation_min type="integer">1</cpu_allocation_min>
  <cpu_allocation_visible type="boolean">true</cpu_allocation_visible>
  <cpu_guaranteed_customizable type="boolean">true</cpu_guaranteed_customizable>
  <cpu_guaranteed_default type="integer">10</cpu_guaranteed_default>
  <cpu_guaranteed_max type="integer">100</cpu_guaranteed_max>
  <cpu_guaranteed_min type="integer">1</cpu_guaranteed_min>
  <cpu_guaranteed_visible type="boolean">true</cpu_guaranteed_visible>
  <cpu_quota_customizable type="boolean">false</cpu_quota_customizable>
  <cpu_quota_default nil="true"/>
  <cpu_quota_max nil="true"/>
  <cpu_quota_min nil="true"/>
  <cpu_quota_visible type="boolean">false</cpu_quota_visible>
  <create_networks type="boolean">true</create_networks>
  <created_at type="datetime">2016-04-25T16:44:19+03:00</created_at>
  <data_stores_to_create type="array">
    <active_support_hash_with_indifferent_access>
      <label>* for vCD 8</label>
      <id>83a2105b-47f1-4f21-a9de-43cfad2a82bd</id>
      <min type="integer">0</min>
      <max type="integer">999999</max>
      <default type="integer">100</default>
      <data_store_visible type="boolean">true</data_store_visible>
      <data_store_customizable type="boolean">true</data_store_customizable>
      <use_it type="boolean">true</use_it>
    </active_support_hash_with_indifferent_access>
    <active_support_hash_with_indifferent_access>...</active_support_hash_with_indifferent_access>
  </data_stores_to_create>
  <default_network_pool>131cfd1d-97dd-4531-96cf-ce2dc2ac426f</default_network_pool>
  <deploy_edge_gateway type="boolean">true</deploy_edge_gateway>
  <edge_gateway_name>MyEdgeGateway</edge_gateway_name>
  <edge_gateway_network_id nil="true"/>
  <enable_fast_provisioning type="boolean">true</enable_fast_provisioning>
  <enable_thin_provisioning type="boolean">false</enable_thin_provisioning>
  <hypervisor_id type="integer">24</hypervisor_id>
  <id type="integer">6</id>
  <label>skdjhgfjshdf</label>
  <memory_customizable type="boolean">true</memory_customizable>
  <memory_default type="integer">8</memory_default>
  <memory_guaranteed_customizable type="boolean">true</memory_guaranteed_customizable>
  <memory_guaranteed_default type="integer">20</memory_guaranteed_default>
  <memory_guaranteed_max type="integer">100</memory_guaranteed_max>
  <memory_guaranteed_min type="integer">20</memory_guaranteed_min>
  <memory_guaranteed_visible type="boolean">true</memory_guaranteed_visible>
  <memory_max type="integer">40</memory_max>
  <memory_min type="integer">4</memory_min>
  <memory_quota_customizable type="boolean">false</memory_quota_customizable>
  <memory_quota_default nil="true"/>
  <memory_quota_max nil="true"/>
  <memory_quota_min nil="true"/>
  <memory_quota_visible type="boolean">false</memory_quota_visible>
  <memory_visible type="boolean">true</memory_visible>
  <networks_to_create type="array">
      <active_support_hash_with_indifferent_access>
        <name>DefaultName</name>
        <type>routed</type>
        <network_address>12.12.1.1/24</network_address>
        <dns>8.8.8.8</dns>
      </active_support_hash_with_indifferent_access>
    </networks_to_create>
  <provider_vdc_id type="integer">13</provider_vdc_id>
  <updated_at type="datetime">2016-04-25T16:45:55+03:00</updated_at>
  <vcpu_speed_customizable nil="true"/>
  <vcpu_speed_default nil="true"/>
  <vcpu_speed_max nil="true"/>
  <vcpu_speed_min nil="true"/>
  <vcpu_speed_visible nil="true"/>
  <vdc_model_type>allocation</vdc_model_type>
  <vm_number_customizable type="boolean">true</vm_number_customizable>
  <vm_number_default type="integer">100</vm_number_default>
  <vm_number_max type="integer">500</vm_number_max>
  <vm_number_min type="integer">1</vm_number_min>
  <vm_number_visible type="boolean">true</vm_number_visible>
</vcloud_template>

Where:

  • cpu_allocation_customizable - whether the CPU allocation related parameters are editable during orchestration model deployment
  • cpu_allocation_default - the default amount of allocated CPU resources, that will be set during orchestration model deployment
  • cpu_allocation_max - the maximum amount of allocated CPU resources, that can be set during orchestration model deployment
  • cpu_allocation_min - the minimum amount of allocated CPU resources , that can be set during orchestration model deployment
  • cpu_allocation_visible - whether the CPU allocation related parameters will be visible during orchestration model deployment
  • cpu_guaranteed_customizable - whether the CPU guaranteed related parameters will be editable during orchestration model deployment
  • cpu_guaranteed_default - the default amount of guaranteed CPU, that will be set during orchestration model deployment
  • cpu_guaranteed_max - the maximum amount of guaranteed CPU, that can be set during orchestration model deployment
  • cpu_guaranteed_min - the minimum amount of guaranteed CPU, that can be set during orchestration model deployment
  • cpu_guaranteed_visible - whether the CPU guaranteed related parameters will be visible during orchestration model deployment
  • cpu_quota_customizable - whether the CPU quota related parameters will be editable during orchestration model deployment
  • cpu_quota_default - the default CPU quota, that will be set during orchestration model deployment
  • cpu_quota_max - the maximum CPU quota, that can be set during orchestration model deployment
  • cpu_quota_min - the minimum CPU quota, that can be set during orchestration model deployment
  • cpu_quota_visible - whether the CPU quota related parameters will be visible during orchestration model deployment
  • create_to_networks - the array of parameters related to the networks that will be created when the orchestration model is deployed
    • name - the label for the network
    • type - the type of the network: routed, isolated or direct
    • network_address - the network address
    • dns - DNS for the network
  • created_at - the date in the [YYYY][MM][DD]T[hh][mm][ss]Z format
  • data_stores_to_create - the array of parameters related to the data stores that will be created when the orchestration model is deployed
    • label - the label of the data store zone in which a data store will be created during orchestration model deployment
    • id - the ID of the data store zone in which a data store will be created during orchestration model deployment
    • min - the minimum data store size that can be requested during orchestration model deployment
    • max - the maximum data store size that can be requested during orchestration model deployment
    • default - the default data store size that will be set during orchestration model deployment
    • data_store_visible - whether the data store related parameters will be visible during orchestration model deployment
    • data_store_customizable - whether the data store related parameters will be editable during orchestration model deployment
    • use_it - whether the data store will be created during orchestration model deployment
  • default_network_pool - the network pool
  • deploy_edge_gateway - whether an edge gateway will be deployed during orchestration model deployment
  • edge_gateway_name - the label for the new edge gateway. The default name is MyEdgeGateway.
  • edge_gateway_network_id - the ID of the edge gateway network
  • enable_fast_provisioning - whether fast provisioning is enabled
  • enable_thin_provisioning - whether thin provisioning is enabled
  • hypervisor_id - the ID of the compute resource associated with the orchestration model
  • id - the ID of the orchestration model
  • label - the name of the orchestration model
  • memory_customizable - whether memory related parameters are editable during orchestration model deployment
  • memory_default - the default amount of allocated memory, that will be set during orchestration model deployment
  • memory_guaranteed_customizable - whether memory guaranteed related parameters are editable during orchestration model deployment
  • memory_guaranteed_default - the default amount of guaranteed memory allocation, that will be set during orchestration model deployment
  • memory_guaranteed_max - the maximum amount of guaranteed memory allocation, that can be set during orchestration model deployment
  • memory_guaranteed_min - the minimum amount of guaranteed memory allocation, that can be set during orchestration model deployment
  • memory_guaranteed_visible - whether memory guaranteed related parameters are visible during orchestration model deployment
  • memory_max - the maximum amount of allocated memory, that can be set during orchestration model deployment
  • memory_min - the minimum amount of allocated memory, that can be set during orchestration model deployment
  • memory_quota_customizable - whether memory quota related parameters are editable during orchestration model deployment
  • memory_quota_default - the default amount of memory which can be used, that will be set during orchestration model deployment
  • memory_quota_max - the maximum amount of memory which can be used, that can be set during orchestration model deployment
  • memory_quota_min - the minimum amount of memory which can be used, that can be set during orchestration model deployment
  • memory_quota_visible - whether memory quota related parameters are visible during orchestration model deployment
  • memory_visible - whether memory related parameters are visible during orchestration model deployment
  • provider_vdc_id - the ID of the provider vDC that will be used when an organization vDC will be deployed from the orchestration model
  • updated_at - the date in the [YYYY][MM][DD]T[hh][mm][ss]Z format
  • vcpu_speed_customizable - whether vCPU speed related parameters are editable during orchestration model deployment
  • vcpu_speed_default - the default vCPU speed in MHz, that will be set during orchestration model deployment
  • vcpu_speed_max - the maximum vCPU speed in MHz, that can be set during orchestration model deployment
  • vcpu_speed_min - the minimum vCPU speed in MHz, that can be set during orchestration model deployment
  • vcpu_speed_visible - whether vCPU speed related parameters are visible during orchestration model deployment
  • vdc_model_type - the resource pool type
  • vm_number_customizable - whether VS number related parameters are editable during orchestration model deployment
  • vm_number_default - the default number of VSs, that will be set during orchestration model deployment
  • vm_number_max - the maximum number of VSs, that can be set during orchestration model deployment
  • vm_number_min - the minimum number of VSs, that can be set during orchestration model deployment
  • vm_number_visible - whether VS number related parameters are visible during orchestration model deployment

Page History

v. 5.1

  • Removed the edge_gateway_uplink_network_id parameter