Edit Smart CloudBoot Compute Resource

To edit a smart CloudBoot compute resource, use the following request:

PUT /settings/assets/:asset_mac_address/hypervisors.xml
PUT /settings/assets/:asset_mac_address/hypervisors.json

XML Request Example

curl -i -X PUT http://onapp.test/settings/assets/00:0a:95:9d:68:16/hypervisors.xml -d '<hypervisor><label>smart</label><ip_address></ip_address><backup_ip_address></backup_ip_address><segregation_os_type>any</segregation_os_type><enabled>1</enabled><collect_stats>0</collect_stats><disable_failover>0</disable_failover><failover_recipe_id>get_if_config</failover_recipe_id><storage><disks
type="array"><disk><scsi>DC0710130DBA80013_TAII_DC0710130DBA80013</scsi><selected>1</selected></disk></disks><nics><mac>00:30:48:fd:74:c7</mac><type>1</type></nics><nics><mac>00:1b:21:6f:3a:ff</mac><type>3</type></nics></hardware_devices><mtu>1500</mtu><storage_controller_memory_size>640</storage_controller_memory_size><disks_per_storage_controller>4</disks_per_storage_controller><allow_unsafe_assigned_interrupts>0</allow_unsafe_assigned_interrupts><custom_config></custom_config></hypervisor>' -u account_email:API_key -H 'Accept: application/xml' -H 'Content-type: application/xml'

JSON Request Example

curl -i -X PUT http://onapp.test/settings/assets/00:0a:95:9d:68:16/hypervisors.json -d '{"hypervisor":{"label":"smart","ip_address":"","backup_ip_address":","segregation_os_type":"any","enabled":"1","collect_stats":"1","disable_failover":"1","failover_recipe_id":"get_if_config","passthrough_disks":"0",
"disks_per_storage_controller":"4", "allow_unsafe_assigned_interrupts":"1","custom_config":""}}' -u account_email:API_key -H 'Accept: application/json' -H 'Content-type: application/json'


hypervisor - an array of compute resource details:

  • label * - the name of the compute resource
  • ip_address - the compute resource IP address

    • When you change the Pxe IP address, you should reboot the CloudBoot compute resource immediately after saving the new settings. If you do not reboot the resource immediately, the Control Panel will fail to connect to the new IP address, causing failover transactions. You can reboot the compute resource manually from the console or use the Power Cycle command (if configured). 
      You cannot use the Reboot option on the CP UI to reboot the resource after changing the IP address. 
      You can also change the IP address of a CloudBoot compute resource that is offline and once the resource is booted, it will be available on the new IP Address.

    • If InfiniBand is enabled for CloudBoot, you should change the value of the cloud_boot pxe config after changing the Pxe IP address.
  • backup_ip_address - provisioning network IP address
  • segregation_os_type - an operating system type (can be Any OS, Windows only, or Non-Windows)
  • enabled - set 1 to enable this compute resource, otherwise set 0
  • collect_stats - set 1 to collect statistics for this compute resource, otherwise set 0
  • disable_failover - optional parameter. Set true to disable compute resource failover, otherwise false
  • failover_recipe_id - the ID of a recipe to run before the failover process
  • format_disks - set 1 to format compute resource's disks during creation, otherwise set 0
  • passthrough_disks - set 1 if the disks should be passed through to the storage nodes, otherwise set 0. This parameter is for Xen compute resources only.

hardware_devices - an array of compute resource disks' details:

  • disks - an array of compute resource disks, where:
    • scsi - SCSI inquiry product revision number
    • selected - set 1 to select a disk, otherwise set 0
  • mtu - maximum transferrable unit value. You can set the frame size from 1500 to 9000 bytes.

    The maximum transportation unit (MTU) is the maximum size of a unit that can be transmitted transferred via ethernet traffic. Any data that exceed the specified MTU value will be divided into smaller units before being transferred. The utilization of jumbo frames allows to reduce increase throughput and increase CPU utilization during large-size file transfers.

  • storage_controller_memory_size - specify the storage controller memory size (minimum 640 MB)
  • disks_per_storage_controller - specify the number of disks per controller virtual server. You can specify from 1 to 4 disks. By default, the controller virtual server is created per 4 disk drives

allow_unsafe_assigned_interrupts - set true if the compute resource does not support the interrupt remapping, otherwise set false. Note: With allow_unsafe_assigned_interrupts parameter enabled, smart server is exposed to the PCI passthrough MSI trap injection.

custom_config - specify any custom commands you want to run when compute resource is booted

PLEASE NOTE: It is currently only possible to set NICs and disk information parameters via UI.

Page History


  • changed storage to hardware_devices parameter


  • added the following parameters:
    • segregation_os_type
    • failover_recipe_id 


  • added the ip_address parameter