Get Compute Zone Details

To get the details for a particular compute zone, use the following request:

GET /settings/hypervisor_zones/:id.xml
GET /settings/hypervisor_zones/:id.json

XML Request Example

curl -i -X GET -H 'Accept: application/xml' -H 'Content-type: application/xml' -u account_email:API_key --url http://onapp.test/settings/hypervisor_zones/1.xml

JSON Request Example

curl -i -X GET -H 'Accept: application/json' -H 'Content-type: application/json' -u account_email:API_key --url http://onapp.test/settings/hypervisor_zones/1.json 

XML Output Example

  <id type="integer">2</id>
  <created_at type="dateTime">2023-02-27T15:39:59Z</created_at>
  <updated_at type="dateTime">2023-02-27T15:39:59Z</updated_at>
  <location_group_id type="integer">2</location_group_id>
  <federation_enabled type="boolean">false</federation_enabled>
  <federation_id nil="true"/>
  <traded type="boolean">false</traded>
  <closed type="boolean">false</closed>
  <hypervisor_id nil="true"/>
  <draas_id nil="true"/>
  <preconfigured_only type="boolean">false</preconfigured_only>
  <provider_vdc_id nil="true"/>
  <additional_fields nil="true"/>
  <datacenter_id nil="true"/>
  <max_host_free_memory nil="true"/>
  <max_host_cpu nil="true"/>
  <prefer_local_reads type="boolean">false</prefer_local_reads>
  <network_failure type="boolean">false</network_failure>
  <storage_channel nil="true"/>
  <run_sysprep type="boolean">true</run_sysprep>
  <failover_timeout type="integer">15</failover_timeout>
  <cpu_units type="integer">1000</cpu_units>
  <supplier_version nil="true"/>
  <supplier_provider nil="true"/>
  <provider_name nil="true"/>
  <scheduled_for_deletion nil="true"/>
  <cpu_flags_enabled type="boolean">false</cpu_flags_enabled>
  <cpu_flags type="array"/>
  <tier nil="true"/>
  <supports_virtual_server_motion nil="true"/>
  <custom_config nil="true"/>
  <override_hot_migration_configuration type="boolean">false</override_hot_migration_configuration>
  <simultaneous_hot_migrations_per_hypervisor type="integer">5</simultaneous_hot_migrations_per_hypervisor>
  <simultaneous_hot_migrations_per_hypervisor_group nil="true"/>


created_at - the date in the [YYYY][MM][DD]T[hh][mm][ss]Z format

updated_at - the date when the compute zone was updated in the [YYYY][MM][DD]T[hh][mm][ss]Z format

default_gateway - external gateway IP address used for the VMware utilization with the external firewall. All virtual machines within a compute zone will be rerouted to this gateway

closed - true, if the federated zone is suspended by a buyer, otherwise false

federation_id - the ID of a compute zone at the market

federation_enabled - true, if federation is enabled by seller, otherwise false

vlan - address of a VLAN the default gateway is located on. 

hypervisor_id - the ID of a compute resource 

id - the compute zone ID

label* - title of a compute zone

location_group_id - ID of a location group the compute zone is assigned to

preconfigured_only - whether the zone can be used for creating Instance Package VSs only. When this option is enabled, the zone cannot be used during custom virtual server (VSs built by setting resources manually) creation.

traded - true, if the zone came from the Federation and was subscribed to by the user

network_failure - true, if all compute resources in the compute zone failed

prefer_local_reads - 1 if the network throughput dependency for read-heavy workloads, otherwise set 0. When the Use Local Read Path feature is enabled, reads go over the local software bridge to a local replica of the data rather than traverse a physical NIC + switch

recovery_type - specify the compute resource selection algorithm, which will be used on virtual server provisioning and recovery:

  • roundrobin - set the roundrobin type to select the compute resource with maximum free RAM during the VS recovery
  • fillnext - select the fillnext type to select the compute resource with the minimum required free RAM. This option allows filling compute resource as tightly as possible before starting to use the next appliance in the zone

release_resource_type - specify the release resource type. The release resource option allows freeing up compute resource resources by over-committing RAM, CPU, and CPU shares of virtual servers that are shut down. 

  • memory_guarantee - the actual free compute resource memory is calculated. All virtual servers residing on the compute resource will be able to start. 

  • ballooning - free compute resource memory is calculated with the ability to use memory over-committing. The ballooning option is only available for KVM compute resources. NOTE: Virtual server may be migrated to another compute resource if there is not enough memory for it to start up on the compute resource with the ballooning option enabled. 

     Do not use the ballooning option if there is at least one edge or storage server within the compute zone. 

  • only_started_vms - only the free memory of running virtual servers is calculated.

    By default, the compute zone is created with the Memory Guarantee option enabled. In this case, the release resources option is not used. Then, to enable resource over-committing you should choose either the Ballooning or Only Started VS option.

failover_timeout - time period for which the iterations will run during the failover

run-sysprep - set 1 to enable Windows virtual server deployment without running sysprep

server_type - specify the type of servers that will reside within this compute zone:

  • virtual  - choose the virtual type to create a Xen, KVM, VMware, or CloudBoot zone
  • smart - choose the smart server type to create a smart server zone
  • baremetal - choose the baremetal server type to create a baremetal server zone

storage_channel - storage channel for the communication

max_host_free_memory  - compute resource with maximum RAM value in this zone

max_host_cpu - compute resource with maximum RAM value in this zone

cpu_units - the number of CPU units applied to a compute resource

cpu_flags - an array of CPU flags enabled for this compute zone

cpu_flags_enabled - true if CPU flags are enabled for the compute zone; otherwise false

(lightbulb)hot_migration_auto_converge - select the preferable type of auto-converge functionality.

  • minor - auto-converge with default CPU throttling during migration
  • moderate - auto-converge with moderate CPU throttling
  • aggressive - auto-converge with aggressive CPU throttling

(lightbulb)override_hot_migration_configuration - set true to enable overriding hot migration configuration, otherwise set false. 

(lightbulb)simultaneous_hot_migrations_per_hypervisor - the maximum amount of transactions per compute resource, the default value is 5. If not set or set to 0, the total count of Hot Migration Transactions is not limited.

(lightbulb)simultaneous_hot_migrations_per_hypervisor_group - the maximum amount of transactions per compute zone. If not set or set to 0, the total count of Hot Migration Transactions is not limited.

Page History

v. 6.8

  • added the following parameters:
    • hot_migration_auto_converge
    • override_hot_migration_configuration
    • simultaneous_hot_migrations_per_hypervisor
    • simultaneous_hot_migrations_per_hypervisor_group

v. 4.2

  • added the following parameters:
    • preconfigured_only
    • cpu_flags
    • cpu_flags_enabled

v. 4.1

  • added the following parameters:
    • closed
    • federation_id
    • federation_enabled
    • hypervisor_id
    • traded

v. 3.3

  • added cpu_units parameter

v. 3.1

  • added the following parameters:
    • server_type
    • release_resource_type
    • recovery_type
    • run_sysprep
    • failover_timeout
    • storage_channel
    • max_host_free_memory 
    • max_host_cpu