7.0
7.0
Docs menu
MENU

Edit Orchestration Model

To edit an orchestration model, use the following request:

1
2

PATCH /vcloud/templates/:id.xml
PATCH /vcloud/templates/:id.json

XML Request Example

1

curl -i -X PATCH http://onapp.test/vcloud/templates/12.xml -H 'Accept: application/xml' -H 'Content-type: application/xml' -u user:userpass -d '<vcloud-template><label>MyOrchestrationModel</label><hypervisor-id>11</hypervisor-id><provider-vdc-id>23</provider-vdc-id><vdc-model-type>allocation</vdc-model-type><cpu-allocation-min>1</cpu-allocation-min><cpu-allocation-max>12</cpu-allocation-max><cpu-allocation-default>1</cpu-allocation-default><cpu-allocation-customizable>1</cpu-allocation-customizable><cpu-allocation-visible>1</cpu-allocation-visible><cpu-guaranteed-min>1</cpu-guaranteed-min><cpu-guaranteed-max>100</cpu-guaranteed-max><cpu-guaranteed-default>10</cpu-guaranteed-default><cpu-guaranteed-customizable>1</cpu-guaranteed-customizable><cpu-guaranteed-visible>1</cpu-guaranteed-visible><memory-min>4</memory-min><memory-max>40</memory-max><memory-default>8</memory-default><memory-customizable>1</memory-customizable><memory-visible>1</memory-visible><memory-guaranteed-min>20</memory-guaranteed-min><memory-guaranteed-max>100</memory-guaranteed-max><memory-guaranteed-default>20</memory-guaranteed-default><memory-guaranteed-customizable>1</memory-guaranteed-customizable><memory-guaranteed-visible>1</memory-guaranteed-visible><vm-number-min>1</vm-number-min><vm-number-max>500</vm-number-max><vm-number-default>100</vm-number-default><vm-number-customizable>1</vm-number-customizable><vm-number-visible>1</vm-number-visible><default-network-pool>131cfd1d-97dd-4531-96cf-ce2dc2ac426f</default-network-pool><edge-gateway-name>MyEdgeGateway</edge-gateway-name><networks_to_create type="array"><network_to_create><name>Network-1</name><type>routed</type><network_address>11.11.1.1/24</network_address><dns>9.9.9.9</dns></network_to_create><netw... type="array"><data_store_to_create><label>*forvCloud8</label><id>44a2105b-47f1-4f21-a9de-43cfad2a82bd</id><min>0</min><max>999999</max><default>1000</default><data_store_customizable>true</data_store_customizable><data_store_visible>true</data_store_visible><use_it>true</use_it></data_store_to_create><data_store_to_create><label>BronzeStorageforvCloud8</label><id>b5e6e041-114a-45e0-909d-ee18971a9be9</id><min>0</min><max>999999</max><default>1000</default><data_store_customizable>true</data_store_customizable><data_store_visible>true</data_store_visible><use_it>true</use_it></data_store_to_create><data_store_to_create><label>GoldStorageforvCloud8</label><id>55abf6c6-6dcb-429d-9be0-61d6d38cf3e0</id><min>0</min><max>999999</max><default>1000</default><data_store_customizable>true</data_store_customizable><data_store_visible>true</data_store_visible><use_it>true</use_it></data_store_to_create></netw...></networks_to_create></vcloud-template>'

JSON Request Example

1

curl -i -X PATCH http://onapp.test/vcloud/templates/12.json -H 'Accept: application/json' -H 'Content-type: application/json' -u user:userpass -d '{"vcloud_template":{"label":"My Orchestration Model","hypervisor_id":"11","provider_vdc_id":"23","vdc_model_type":"allocation","cpu_allocation_min":"1","cpu_allocation_max":"12","cpu_allocation_default":"1","cpu_allocation_customizable":"1","cpu_allocation_visible":"1","cpu_guaranteed_min":"1","cpu_guaranteed_max":"100","cpu_guaranteed_default":"10","cpu_guaranteed_customizable":"1","cpu_guaranteed_visible":"1","memory_min":"4","memory_max":"40","memory_default":"8","memory_customizable":"1","memory_visible":"1","memory_guaranteed_min":"20","memory_guaranteed_max":"100","memory_guaranteed_default":"20","memory_guaranteed_customizable":"1","memory_guaranteed_visible":"1","vm_number_min":"1","vm_number_max":"500","vm_number_default":"100","vm_number_customizable":"1","vm_number_visible":"1","default_network_pool":"131cfd1d-44dd-4531-96cf-ce2dc2ac426f","edge_gateway_name":"MyEdgeGateway","networks_to_create":[{"name":"Network-1","type":"routed","network_address":"11.11.1.1/24","dns":"9.9.9.9"}, {"name":"Network-2","type":"routed","network_address":"11.11.2.1/24","dns":"9.9.4.4"}], "enable_thin_provisioning":"1","enable_fast_provisioning":"1","data_stores_to_create":[{"label":"* for vCloud 8","id":"44a2105b-47f1-4f21-a9de-43cfad2a82bd","min":"0","max":"999999","default":"1000","data_store_customizable":"true","data_store_visible":"true","use_it":"true"}, {"label":"Bronze Storage for vCloud 8","id":"b5e6e041-114a-45e0-909d-ee18971a9be9","min":"0","max":"999999","default":"1000","data_store_customizable":"true","data_store_visible":"true","use_it":"true"}, {"label":"Gold Storage for vCloud 8","id":"55abf6c6-6dcb-429d-9be0-61d6d38cf3e0","min":"0","max":"999999","default":"1000","data_store_customizable":"true","data_store_visible":"true","use_it":"true"}]}}'

Where:

  • label - the name of the orchestration model
  • hypervisor_id - the ID of the compute resource associated with the orchestration model
  • provider_vdc_id - the ID of the provider vDC that will be used when an organization vDC will be deployed from the orchestration model
  • vdc_model_type - the resource pool type: allocation, reservation or pay_as_you_go
  • cpu_allocation_min - the minimum amount of allocated CPU resources, that can 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_default - the default amount of allocated CPU resources, that will be set during orchestration model deployment
  • cpu_allocation_customizable - set to “1”, if you want the CPU allocation related parameters to be editable during orchestration model deployment, otherwise set to “0”
  • cpu_allocation_visible - set to “1”, if you want the CPU allocation related parameters to be visible during orchestration model deployment, otherwise set to “0”
  • cpu_guaranteed_min - the minimum amount of guaranteed CPU, that can 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_default - the default amount of guaranteed CPU, that will be set during orchestration model deployment
  • cpu_guaranteed_customizable - set to “1”, if you want the CPU guaranteed related parameters to be editable during orchestration model deployment, otherwise set to “0”
  • cpu_guaranteed_visible - set to “1”, if you want the CPU guaranteed related parameters to be visible during orchestration model deployment, otherwise set to “0”
  • memory_min - the minimum amount of allocated memory, that can be set during orchestration model deployment
  • memory_max - the maximum amount of allocated memory, that can be set during orchestration model deployment
  • memory_default - the default amount of allocated memory, that will be set during orchestration model deployment
  • memory_customizable - set to “1”, if you want the memory related parameters to be editable during orchestration model deployment, otherwise set to “0”
  • memory_visible - set to “1”, if you want the memory related parameters to be visible during orchestration model deployment, otherwise set to “0”
  • memory_guaranteed_min - the minimum amount of guaranteed memory allocation, that can 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_default - the default amount of guaranteed memory allocation, that will be set during orchestration model deployment
  • memory_guaranteed_customizable - set to “1”, if you want the memory guaranteed related parameters to be editable during orchestration model deployment, otherwise set to “0”
  • memory_guaranteed_visible - set to “1”, if you want the memory guaranteed related parameters to be visible during orchestration model deployment, otherwise set to “0”
  • vm_number_min - the minimum number of VSs, that will be set during orchestration model deployment
  • vm_number_max - the maximum number of VSs, that will be set during orchestration model deployment
  • vm_number_default - the default number of VSs, that will be set during orchestration model deployment
  • vm_number_customizable - set to “1”, if you want the VS number related parameters to be editable during orchestration model deployment, otherwise set to “0”
  • vm_number_visible - set to “1”, if you want the VS number related parameters to visible be during orchestration model deployment, otherwise set to “0”
  • default_network_pool - set a network pool
  • edge_gateway_name - fill in the label for the new edge gateway. The default name is MyEdgeGateway.
  • networks_to_create - 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 - fill in the network address
    • dns - DNS for the network
  • enable_thin_provisioning - set to “1” to enable thin provisioning, otherwise set to “0”
  • enable_fast_provisioning - set to “1” to enable fast provisioning, otherwise set to “0”
  • 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_customizable - set to “true” if you want that the data store size can be altered during orchestration model deployment, otherwise set to “false”
    • data_store_visible - set to “true” for the data store to be listed during orchestration model deployment, otherwise set to “false”.If the data store zone is not visible, a data store will still be created in it.
    • use_it - set to “true” for the data store to be created during orchestration model deployment, otherwise set to “false”