Deploy Orchestration Model

To deploy an orchestration model, use the following request:

1
2
POST /vcloud/templates/:template_id/deploy.xml
POST /vcloud/templates/:template_id/deploy.json

XML Request example:

1
curl -i -X POST http://onapp.test/vcloud/templates/:template_id/deploy.xml -H 'Accept: application/xml' -H 'Content-type: application/xml' -u user:userpass -d '<vcloud_template><user_group_id>174</user_group_id><vdc_label>MyResourcePool1</vdc_label><cpu_allocation>1</cpu_allocation><cpu_guaranteed>10</cpu_guaranteed><vcpu_speed>0</vcpu_speed><cpu_quota>0</cpu_quota><memory>8</memory><memory_guaranteed>20</memory_guaranteed><memory_quota>0</memory_quota><vm_number>100</vm_number><storage_profile>47a2105b-47f1-4f21-a9de-43cfad2a82bd</storage_profile><networks_to_create type="array"><action_controller_parameters><name>DefaultName</name></action_controller_parameters></networks_to_create><data_stores_created type="array"><data_store_created><id>24a2105b-47f1-4f21-a9de-43cfad2a82bd</id><label>*forvCloud8</label><disk_space>1000</disk_space></data_store_created><data_store_created><id>b5e6e041-114a-45e0-909d-ee18971a9be9</id><label>BronzeStorageforvCloud8</label><disk_space>1000</disk_space></data_store_created><data_store_created><id>55abf6c6-6dcb-429d-9be0-61d6d38cf3e0</id><label>GoldStorageforvCloud8</label><disk_space>1000</disk_space></data_store_created></data_stores_created><edge_gateway_name>EdgeGatewayName</edge_gateway_name><default_gateway_ip_net_id>1532<use_default_route_for_dns_relay>1</use_default_route_for_dns_relay><networks_created><network_created><name>Name1</name></network_created><network_created><name>Name2</name></network_created></networks_created></default_gateway_ip_net_id></vcloud_template>'

JSON Request example:

1
curl -i -X POST http://onapp.test/vcloud/templates/:template_id/deploy.json -H 'Accept: application/json' -H 'Content-type: application/json' -u user:userpass -d '{"vcloud_template":{"user_group_id":"174","vdc_label":"My Resource Pool1","cpu_allocation":"1","cpu_guaranteed":"10","vcpu_speed":"0","cpu_quota":"0","memory":"8","memory_guaranteed":"20","memory_quota":"0","vm_number":"100","storage_profile":"55a2105b-47f1-4f21-a9de-43cfad2a82bd","networks_to_create":[{"name":"DefaultName"}],"data_stores_created":[{"id":"44a2105b-47f1-4f21-a9de-43cfad2a82bd","label":"* for vCloud 8","disk_space":"1000"}, {"id":"b5e6e041-114a-45e0-909d-ee18971a9be9","label":"Bronze Storage for vCloud 8","disk_space":"1000"}, {"id":"55abf6c6-6dcb-429d-9be0-61d6d38cf3e0","label":"Gold Storage for vCloud 8","disk_space":"1000"}, {"id":"55abf6c6-6dcb-429d-9be0-61d6d38cf3e0","label":"Gold Storage for vCloud 8","disk_space":"1000"}], "edge_gateway_name":"EdgeGatewayName", "edge_gateway_uplink_networks": ["", "1315", "1316"], "default_gateway_ip_net_id": "1532", "use_default_route_for_dns_relay": "1", "networks_created":[{"name":"Name1"}, {"name":"Name2"}]}}'

Where:

user_group_id - the ID of the organization with which the orchestration model will be associated
vdc_label - the label for a resource pool that will be created after the template is deployed
cpu_allocation - amount of CPU resources (GHZ) that will be allocated after the template is deployed
cpu_guaranteed - amount of guaranteed CPU allocation (%)
vcpu_speed - the vCPU speed in MHz that can be consumed after the template is deployed
cpu_quota - the CPU quota
memory - the amount of memory(MB) that will be allocated after the template is deployed
memory_guaranteed - amount of guaranteed memory allocation (%)
memory_quota - the memory quota
vm_number - the number of VSs that can be created after the template is deployed
storage_profile - the default storage policy
name - the name of the default network
edge_gateway_uplink_networks - array of IDs of external networks
- edge_gateway_uplink_network - ID of external network
data_stores_created - the array of parameters related to the data stores that will be allocated after the template is deployed
- id - id of the data store zone in which a data store will be created during the orchestration model deployment
- label - the name of the data store zone in which a data store will be created during the orchestration model deployment
- disk_space - the disk size for the data store that will be allocated after the template is deployed
edge_gateway_name - the name of the edge gateway
default_gateway_ip_net_id - the default gateway to be added to the IP net automatically
use_default_route_for_dns_relay - true if the default route for DNS relay is used; otherwise, false
networks_created - the list of the networks created
name - the name of the network

Page History:

v.6.1 Edge 2

Added the default_gateway_ip_net_id and use_default_route_for_dns_relay parameters

v.5.8

Added the edge_gateway_name, networks_created, and name parameters

v. 5.1:

Added edge_gateway_uplink_networks parameter
Added edge_gateway_uplink_network parameter