boolean string integer date decimal architecture undefined x86_64 ppc64 logical_unit id string address string port integer target string username string password string portal string serial string vendor_id string product_id string lun_mapping integer size integer paths integer status volume_group_id string storage_domain_id string disk_id string agent_configuration network_mappings string broker_type address string port integer username string password string time_zone name string utc_offset string transparent_huge_pages enabled boolean configuration_type ovf payload_encoding base64 plaintext bios boot_menu boot_menu spm priority integer status watchdog model action id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string template template instance_type instance_type References to the virtual machines that are using this device. A device may be used by several virtual machines; for example, a shared disk my be used simultaneously by two or more virtual machines. <div class="paragraph"> <p>References to the virtual machines that are using this device. A device may be used by several virtual machines; for example, a shared disk my be used simultaneously by two or more virtual machines.</p> </div> author value Byron Gravenorst <bgraveno@redhat.com> date value 31 Oct 2016 status value updated_by_docs vms vm[] Don't use this element, use `vms` instead. <div class="paragraph"> <p>Don&#8217;t use this element, use <code>vms</code> instead.</p> </div> deprecated author value Byron Gravenorst <bgraveno@redhat.com> date value 31 Oct 2016 status value updated_by_docs vm vm bookmark value string id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string storage_connection_extension target string username string password string id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string host host snapshot_status ok locked in_preview ip_address_assignment ip ip assignment_method The enum describes whether vNIC to be implemented as a pass-through device or a virtual one. Currently it supports only 2 option, but there is a plan to add more in the future. <div class="paragraph"> <p>The enum describes whether vNIC to be implemented as a pass-through device or a virtual one. Currently it supports only 2 option, but there is a plan to add more in the future.</p> </div> vnic_pass_through_mode To be implemented as a pass-through device <div class="paragraph"> <p>To be implemented as a pass-through device</p> </div> enabled To be implemented as a virtual device <div class="paragraph"> <p>To be implemented as a virtual device</p> </div> disabled agent type string address string username string password string options option[] encrypt_options boolean concurrent boolean order integer port integer id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string host host gluster_volume volume_type transport_types [] replica_count integer stripe_count integer disperse_count integer redundancy_count integer options option[] status id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string cluster cluster bricks gluster_brick[] statistics statistic[] The OpenStack network provider can either be implemented by OpenStack Neutron, in which case the Neutron agent is automatically installed on the hosts, or it can be an external provider implementing the OpenStack API, in which case the virtual interface driver will be a custom solution installed manually. <div class="paragraph"> <p>The OpenStack network provider can either be implemented by OpenStack Neutron, in which case the Neutron agent is automatically installed on the hosts, or it can be an external provider implementing the OpenStack API, in which case the virtual interface driver will be a custom solution installed manually.</p> </div> open_stack_network_provider_type Indicates that the provider is OpenStack Neutron. The standard OpenStack Neutron agent will be used as the virtual interface driver. <div class="paragraph"> <p>Indicates that the provider is OpenStack Neutron. The standard OpenStack Neutron agent will be used as the virtual interface driver.</p> </div> neutron Indicates that the provider is an external one, implementing the OpenStack Neutron API. The virtual interface driver in this case is implemented by the external provider. <div class="paragraph"> <p>Indicates that the provider is an external one, implementing the OpenStack Neutron API. The virtual interface driver in this case is implemented by the external provider.</p> </div> external icon media_type string data string id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string open_stack_volume_type properties property[] id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string openstack_volume_provider open_stack_volume_provider This enumerated type is used to what type of operating system is used by the host. <div class="paragraph"> <p>This enumerated type is used to what type of operating system is used by the host.</p> </div> host_type The host contains a full RHEL, CentOS or Fedora installation. <div class="paragraph"> <p>The host contains a full RHEL, CentOS or Fedora installation.</p> </div> rhel The host contains a small scaled version of RHEL, CentOS or Fedora, used solely to host virtual machines. <div class="paragraph"> <p>The host contains a small scaled version of RHEL, CentOS or Fedora, used solely to host virtual machines.</p> </div> rhev_h The host is NGN (Next Generation Node) - a new implementation of RHEV_H which is like RHEL, CentOS or Fedora installation. The main difference between NGN and legacy RHEV-H is that NGN has a writeable file system and will handle its installation instead of pushing RPMs to it by the engine in legacy RHEV-H. <div class="paragraph"> <p>The host is NGN (Next Generation Node) - a new implementation of RHEV_H which is like RHEL, CentOS or Fedora installation. The main difference between NGN and legacy RHEV-H is that NGN has a writeable file system and will handle its installation instead of pushing RPMs to it by the engine in legacy RHEV-H.</p> </div> ovirt_node Describes how a disk is attached to a virtual machine. <div class="paragraph"> <p>Describes how a disk is attached to a virtual machine.</p> </div> author value Byron Gravenorst <bgraveno@redhat.com> date value 2 Nov 2016 status value updated_by_docs disk_attachment Defines whether the disk is bootable. <div class="paragraph"> <p>Defines whether the disk is bootable.</p> </div> author value Byron Gravenorst <bgraveno@redhat.com> date value 2 Nov 2016 status value updated_by_docs bootable boolean The type of interface driver used to connect the disk device to the virtual machine. <div class="paragraph"> <p>The type of interface driver used to connect the disk device to the virtual machine.</p> </div> author value Juan Hernandez <juan.hernandez@redhat.com> date value 4 Nov 2016 status value added interface This flag indicates if the disk is active in the virtual machine it's attached to. A disk attached to a virtual machine in an active status is connected to the virtual machine at run time and can be used. <div class="paragraph"> <p>This flag indicates if the disk is active in the virtual machine it&#8217;s attached to.</p> </div> <div class="paragraph"> <p>A disk attached to a virtual machine in an active status is connected to the virtual machine at run time and can be used.</p> </div> author value Tal Nisan <tnisan@redhat.com> Byron Gravenorst <bgraveno@redhat.com> date value 3 Nov 2016 status value updated_by_docs active boolean The logical name of the virtual machine's disk, as seen from inside the virtual machine. The logical name of a disk is reported only when the guest agent is installed and running inside the virtual machine. For example, if the guest operating system is Linux and the disk is connected via a VirtIO interface, the logical name will be reported as `/dev/vda`: [source,xml] ---- <disk_attachment> ... <logical_name>/dev/vda</logical_name> </disk_attachment> ---- If the guest operating system is Windows, the logical name will be reported as `\\.\PHYSICALDRIVE0`. <div class="paragraph"> <p>The logical name of the virtual machine&#8217;s disk, as seen from inside the virtual machine.</p> </div> <div class="paragraph"> <p>The logical name of a disk is reported only when the guest agent is installed and running inside the virtual machine.</p> </div> <div class="paragraph"> <p>For example, if the guest operating system is Linux and the disk is connected via a VirtIO interface, the logical name will be reported as <code>/dev/vda</code>:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-xml" data-lang="xml">&lt;disk_attachment&gt; ... &lt;logical_name&gt;/dev/vda&lt;/logical_name&gt; &lt;/disk_attachment&gt;</code></pre> </div> </div> <div class="paragraph"> <p>If the guest operating system is Windows, the logical name will be reported as <code>\\.\PHYSICALDRIVE0</code>.</p> </div> author value Idan Shaby <ishaby@redhat.com> Byron Gravenorst <bgraveno@redhat.com> date value 3 Nov 2016 status value updated_by_docs since value 4.0.2 logical_name string id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string The reference to the disk. <div class="paragraph"> <p>The reference to the disk.</p> </div> author value Byron Gravenorst <bgraveno@redhat.com> date value 3 Nov 2016 status value updated_by_docs disk disk The reference to the virtual machine. <div class="paragraph"> <p>The reference to the virtual machine.</p> </div> author value Byron Gravenorst <bgraveno@redhat.com> date value 3 Nov 2016 status value updated_by_docs vm vm The reference to the template. <div class="paragraph"> <p>The reference to the template.</p> </div> author value Tal Nisan <tnisan@redhat.com> Byron Gravenorst <bgraveno@redhat.com> date value 3 Nov 2016 status value updated_by_docs template template log_severity normal warning error alert open_stack_image_provider tenant_name string url string requires_authentication boolean username string password string authentication_url string properties property[] id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string certificates certificate[] images open_stack_image[] open_stack_network id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string openstack_network_provider open_stack_network_provider watchdog_model i6300esb vm_status unassigned down up powering_up paused migrating unknown not_responding wait_for_launch reboot_in_progress saving_state restoring_state suspended image_locked powering_down rng_device rate rate source graphics_type spice vnc disk_storage_type image lun cinder open_stack_subnet cidr string ip_version string gateway string dns_servers string[] id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string openstack_network open_stack_network vm_pool_type automatic manual numa_tune_mode strict interleave preferred This type contains references to special objects, like the blank template and the root of the hierarchy of tags. <div class="paragraph"> <p>This type contains references to special objects, like the blank template and the root of the hierarchy of tags.</p> </div> special_objects Reference to the blank template. <div class="paragraph"> <p>Reference to the blank template.</p> </div> blank_template template Reference to the root of the hierarchy of tags. <div class="paragraph"> <p>Reference to the root of the hierarchy of tags.</p> </div> root_tag tag boot_device cdrom hd network user domain_entry_id string department string logged_in boolean Name space where user resides. When using the authorization provider that stores users in the LDAP (see https://github.com/oVirt/ovirt-engine-extension-aaa-ldap[here] for details) this attribute equals to naming context of the LDAP. When using the built-in authorization provider that stores users in the database (see https://github.com/oVirt/ovirt-engine-extension-aaa-jdbc[here] for details) this attribute is ignored. <div class="paragraph"> <p>Name space where user resides. When using the authorization provider that stores users in the LDAP (see <a href="https://github.com/oVirt/ovirt-engine-extension-aaa-ldap">here</a> for details) this attribute equals to naming context of the LDAP. When using the built-in authorization provider that stores users in the database (see <a href="https://github.com/oVirt/ovirt-engine-extension-aaa-jdbc">here</a> for details) this attribute is ignored.</p> </div> author value Ondra Machacek <omachace@redhat.com> date value 14 Sep 2016 status value added namespace string last_name string Username of the user. The format depends on authorization provider type. In case of most LDAP providers it is value of the `uid` LDAP attribute. In case of Active Directory it is the user principal name (UPN). `UPN` or `uid` must be followed by authorization provider name. For example in case of LDAP using `uid` attribute it is: `myuser@myextension-authz`. In case of Active Directory using `UPN` it is: `myuser@mysubdomain.mydomain.com@myextension-authz`. This attribute is required parameter when adding new user. <div class="paragraph"> <p>Username of the user. The format depends on authorization provider type. In case of most LDAP providers it is value of the <code>uid</code> LDAP attribute. In case of Active Directory it is the user principal name (UPN). <code>UPN</code> or <code>uid</code> must be followed by authorization provider name. For example in case of LDAP using <code>uid</code> attribute it is: <code>myuser@myextension-authz</code>. In case of Active Directory using <code>UPN</code> it is: <code>myuser@mysubdomain.mydomain.com@myextension-authz</code>. This attribute is required parameter when adding new user.</p> </div> author value Ondra Machacek <omachace@redhat.com> date value 14 Sep 2016 status value added user_name string Same as `user_name` principal has different formats based on LDAP provider. In case of most LDAP providers it is value of the `uid` LDAP attribute. In case of Active Directory it is the user principal name (UPN). <div class="paragraph"> <p>Same as <code>user_name</code> principal has different formats based on LDAP provider. In case of most LDAP providers it is value of the <code>uid</code> LDAP attribute. In case of Active Directory it is the user principal name (UPN).</p> </div> author value Ondra Machacek <omachace@redhat.com> date value 14 Sep 2016 status value added principal string password string email string id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string domain domain roles role[] groups group[] permissions permission[] tags tag[] ssh_public_keys ssh_public_key[] job_status aborted failed finished started unknown Represents a physical NUMA node. Example XML representation: [source,xml] ---- <host_numa_node href="/ovirt-engine/api/hosts/0923f1ea/numanodes/007cf1ab" id="007cf1ab"> <cpu> <cores> <core> <index>0</index> </core> </cores> </cpu> <index>0</index> <memory>65536</memory> <node_distance>40 20 40 10</node_distance> <host href="/ovirt-engine/api/hosts/0923f1ea" id="0923f1ea"/> </host_numa_node> ---- <div class="paragraph"> <p>Represents a physical NUMA node.</p> </div> <div class="paragraph"> <p>Example XML representation:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-xml" data-lang="xml">&lt;host_numa_node href="/ovirt-engine/api/hosts/0923f1ea/numanodes/007cf1ab" id="007cf1ab"&gt; &lt;cpu&gt; &lt;cores&gt; &lt;core&gt; &lt;index&gt;0&lt;/index&gt; &lt;/core&gt; &lt;/cores&gt; &lt;/cpu&gt; &lt;index&gt;0&lt;/index&gt; &lt;memory&gt;65536&lt;/memory&gt; &lt;node_distance&gt;40 20 40 10&lt;/node_distance&gt; &lt;host href="/ovirt-engine/api/hosts/0923f1ea" id="0923f1ea"/&gt; &lt;/host_numa_node&gt;</code></pre> </div> </div> author value Andrej Krejcir <akrejcir@redhat.com> date value 14 Sep 2016 status value added numa_node index integer Memory of the NUMA node in MB. <div class="paragraph"> <p>Memory of the NUMA node in MB.</p> </div> author value Andrej Krejcir <akrejcir@redhat.com> date value 14 Sep 2016 status value added memory integer cpu cpu node_distance string id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string host host statistics statistic[] memory_policy guaranteed integer ballooning boolean over_commit memory_over_commit transparent_huge_pages transparent_huge_pages memory_over_commit percent integer image id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string storage_domain storage_domain kdump_status unknown disabled enabled Represents a MAC address pool. Example of a XML representatian of a MAC address pool: [source,xml] ---- <mac_pool href="/ovirt-engine/api/macpools/123" id="123"> <name>Default</name> <description>Default MAC pool</description> <allow_duplicates>false</allow_duplicates> <default_pool>true</default_pool> <ranges> <range> <from>00:1A:4A:16:01:51</from> <to>00:1A:4A:16:01:E6</to> </range> </ranges> </mac_pool> ---- <div class="paragraph"> <p>Represents a MAC address pool.</p> </div> <div class="paragraph"> <p>Example of a XML representatian of a MAC address pool:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-xml" data-lang="xml">&lt;mac_pool href="/ovirt-engine/api/macpools/123" id="123"&gt; &lt;name&gt;Default&lt;/name&gt; &lt;description&gt;Default MAC pool&lt;/description&gt; &lt;allow_duplicates&gt;false&lt;/allow_duplicates&gt; &lt;default_pool&gt;true&lt;/default_pool&gt; &lt;ranges&gt; &lt;range&gt; &lt;from&gt;00:1A:4A:16:01:51&lt;/from&gt; &lt;to&gt;00:1A:4A:16:01:E6&lt;/to&gt; &lt;/range&gt; &lt;/ranges&gt; &lt;/mac_pool&gt;</code></pre> </div> </div> author value Marcin Mirecki <mmirecki@redhat.com> date value 14 Sept 2016 status value added mac_pool Defines whether duplicate MAC addresses are permitted in the pool. If not specified defaults to `false`. <div class="paragraph"> <p>Defines whether duplicate MAC addresses are permitted in the pool. If not specified defaults to <code>false</code>.</p> </div> author value Marcin Mirecki <mmirecki@redhat.com> date value 22 Sept 2016 status value added allow_duplicates boolean Defines whether this is the default pool. If not specified defaults to `false`. <div class="paragraph"> <p>Defines whether this is the default pool. If not specified defaults to <code>false</code>.</p> </div> author value Marcin Mirecki <mmirecki@redhat.com> date value 22 Sept 2016 status value added default_pool boolean Defines the range of MAC addresses for the pool. Multiple ranges can be defined. <div class="paragraph"> <p>Defines the range of MAC addresses for the pool. Multiple ranges can be defined.</p> </div> author value Marcin Mirecki <mmirecki@redhat.com> date value 22 Sept 2016 status value added ranges range[] id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string se_linux_mode enforcing permissive disabled Affinity label is a label that can influence the VM scheduling. It is most often used to create a sub-cluster from available hosts. <div class="paragraph"> <p>Affinity label is a label that can influence the VM scheduling. It is most often used to create a sub-cluster from available hosts.</p> </div> affinity_label The `readOnly` property marks a label that can't be modified. This is mostly the case when listing internally generated labels. <div class="paragraph"> <p>The <code>readOnly</code> property marks a label that can&#8217;t be modified. This is mostly the case when listing internally generated labels.</p> </div> read_only boolean id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string List of hosts that were labeled using this scheduling label. <div class="paragraph"> <p>List of hosts that were labeled using this scheduling label.</p> </div> hosts host[] List of vms that were labeled using this scheduling label. <div class="paragraph"> <p>List of vms that were labeled using this scheduling label.</p> </div> vms vm[] access_protocol gluster nfs cifs scheduling_policy locked boolean default_policy boolean properties property[] id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string balances balance[] filters filter[] weight weight[] openstack_volume_authentication_key uuid string value string usage_type creation_date date id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string openstack_volume_provider open_stack_volume_provider range from string to string permission id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string role role user user group group data_center data_center cluster cluster host host storage_domain storage_domain vm vm vm_pool vm_pool template template disk disk Defines the bandwidth used by migration. <div class="paragraph"> <p>Defines the bandwidth used by migration.</p> </div> migration_bandwidth The way how the bandwidth is assigned. <div class="paragraph"> <p>The way how the bandwidth is assigned.</p> </div> assignment_method Custom bandwidth in Mbit/s. Will be applied only if the `assignmentMethod` attribute is `custom`. <div class="paragraph"> <p>Custom bandwidth in Mbit/s. Will be applied only if the <code>assignmentMethod</code> attribute is <code>custom</code>.</p> </div> custom_value integer entity_profile_detail profile_details profile_detail[] ssh_public_key content string id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string user user Represents virtual NUMA node. An example XML representation: [source, xml] ---- <vm_numa_node href="/ovirt-engine/api/vms/f1aa8209/numanodes/706cb6b0" id="706cb6b0"> <cpu> <cores> <core> <index>0</index> </core> </cores> </cpu> <index>0</index> <memory>1024</memory> <numa_node_pins> <numa_node_pin> <host_numa_node id="007cf1ab"/> <index>0</index> <pinned>true</pinned> </numa_node_pin> </numa_node_pins> <vm href="/ovirt-engine/api/vms/f1aa8209" id="f1aa8209"/> </vm_numa_node> ---- <div class="paragraph"> <p>Represents virtual NUMA node.</p> </div> <div class="paragraph"> <p>An example XML representation:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-xml" data-lang="xml">&lt;vm_numa_node href="/ovirt-engine/api/vms/f1aa8209/numanodes/706cb6b0" id="706cb6b0"&gt; &lt;cpu&gt; &lt;cores&gt; &lt;core&gt; &lt;index&gt;0&lt;/index&gt; &lt;/core&gt; &lt;/cores&gt; &lt;/cpu&gt; &lt;index&gt;0&lt;/index&gt; &lt;memory&gt;1024&lt;/memory&gt; &lt;numa_node_pins&gt; &lt;numa_node_pin&gt; &lt;host_numa_node id="007cf1ab"/&gt; &lt;index&gt;0&lt;/index&gt; &lt;pinned&gt;true&lt;/pinned&gt; &lt;/numa_node_pin&gt; &lt;/numa_node_pins&gt; &lt;vm href="/ovirt-engine/api/vms/f1aa8209" id="f1aa8209"/&gt; &lt;/vm_numa_node&gt;</code></pre> </div> </div> author value Andrej Krejcir <akrejcir@redhat.com> date value 14 Sep 2016 status value added virtual_numa_node numa_node_pins numa_node_pin[] index integer Memory of the NUMA node in MB. <div class="paragraph"> <p>Memory of the NUMA node in MB.</p> </div> author value Andrej Krejcir <akrejcir@redhat.com> date value 14 Sep 2016 status value added memory integer cpu cpu node_distance string id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string host host statistics statistic[] vm vm statistic values value[] kind type unit id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string disk disk host host host_nic host_nic host_numa_node numa_node nic nic vm vm brick gluster_brick step step gluster_volume gluster_volume The enum defines valid values for the IP protocol version. <div class="paragraph"> <p>The enum defines valid values for the IP protocol version.</p> </div> ip_version IPv4. <div class="paragraph"> <p>IPv4.</p> </div> v4 IPv6. <div class="paragraph"> <p>IPv6.</p> </div> v6 serial_number policy value string ksm enabled boolean merge_across_nodes boolean hook_content_type text binary disk_interface ide virtio_scsi virtio spapr_vscsi volume_group id string name string logical_units logical_unit[] skip_if_connectivity_broken enabled boolean threshold integer auto_numa_status disable enable unknown disk_type data system vnic_pass_through Defines if the vNIC to be implemented as a virtual device or as a pass-through to a host device. <div class="paragraph"> <p>Defines if the vNIC to be implemented as a virtual device or as a pass-through to a host device.</p> </div> mode brick_profile_detail profile_details profile_detail[] brick gluster_brick network_status operational non_operational nic_interface e1000 virtio rtl8139 rtl8139_virtio spapr_vlan pci_passthrough value_type decimal integer string resolution_type add copy iscsi_details initiator string port integer target string username string password string portal string address string serial string vendor_id string product_id string lun_mapping integer size integer paths integer status string volume_group_id string storage_domain_id string disk_id string vcpu_pin vcpu integer cpu_set string configuration type The document describing the virtual machine. Example of the OVF document: [source,xml] ---- <?xml version='1.0' encoding='UTF-8'?> <ovf:Envelope xmlns:ovf="http://schemas.dmtf.org/ovf/envelope/1/" xmlns:rasd="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_ResourceAllocationSettingData" xmlns:vssd="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_VirtualSystemSettingData" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" ovf:version="3.5.0.0"> <References/> <Section xsi:type="ovf:NetworkSection_Type"> <Info>List of networks</Info> <Network ovf:name="Network 1"/> </Section> <Section xsi:type="ovf:DiskSection_Type"> <Info>List of Virtual Disks</Info> </Section> <Content ovf:id="out" xsi:type="ovf:VirtualSystem_Type"> <CreationDate>2014/12/03 04:25:45</CreationDate> <ExportDate>2015/02/09 14:12:24</ExportDate> <DeleteProtected>false</DeleteProtected> <SsoMethod>guest_agent</SsoMethod> <IsSmartcardEnabled>false</IsSmartcardEnabled> <TimeZone>Etc/GMT</TimeZone> <default_boot_sequence>0</default_boot_sequence> <Generation>1</Generation> <VmType>1</VmType> <MinAllocatedMem>1024</MinAllocatedMem> <IsStateless>false</IsStateless> <IsRunAndPause>false</IsRunAndPause> <AutoStartup>false</AutoStartup> <Priority>1</Priority> <CreatedByUserId>fdfc627c-d875-11e0-90f0-83df133b58cc</CreatedByUserId> <IsBootMenuEnabled>false</IsBootMenuEnabled> <IsSpiceFileTransferEnabled>true</IsSpiceFileTransferEnabled> <IsSpiceCopyPasteEnabled>true</IsSpiceCopyPasteEnabled> <Name>VM_export</Name> <TemplateId>00000000-0000-0000-0000-000000000000</TemplateId> <TemplateName>Blank</TemplateName> <IsInitilized>false</IsInitilized> <Origin>3</Origin> <DefaultDisplayType>1</DefaultDisplayType> <TrustedService>false</TrustedService> <OriginalTemplateId>00000000-0000-0000-0000-000000000000</OriginalTemplateId> <OriginalTemplateName>Blank</OriginalTemplateName> <UseLatestVersion>false</UseLatestVersion> <Section ovf:id="70b4d9a7-4f73-4def-89ca-24fc5f60e01a" ovf:required="false" xsi:type="ovf:OperatingSystemSection_Type"> <Info>Guest Operating System</Info> <Description>other</Description> </Section> <Section xsi:type="ovf:VirtualHardwareSection_Type"> <Info>1 CPU, 1024 Memeory</Info> <System> <vssd:VirtualSystemType>ENGINE 3.5.0.0</vssd:VirtualSystemType> </System> <Item> <rasd:Caption>1 virtual cpu</rasd:Caption> <rasd:Description>Number of virtual CPU</rasd:Description> <rasd:InstanceId>1</rasd:InstanceId> <rasd:ResourceType>3</rasd:ResourceType> <rasd:num_of_sockets>1</rasd:num_of_sockets> <rasd:cpu_per_socket>1</rasd:cpu_per_socket> </Item> <Item> <rasd:Caption>1024 MB of memory</rasd:Caption> <rasd:Description>Memory Size</rasd:Description> <rasd:InstanceId>2</rasd:InstanceId> <rasd:ResourceType>4</rasd:ResourceType> <rasd:AllocationUnits>MegaBytes</rasd:AllocationUnits> <rasd:VirtualQuantity>1024</rasd:VirtualQuantity> </Item> <Item> <rasd:Caption>USB Controller</rasd:Caption> <rasd:InstanceId>3</rasd:InstanceId> <rasd:ResourceType>23</rasd:ResourceType> <rasd:UsbPolicy>DISABLED</rasd:UsbPolicy> </Item> </Section> </Content> </ovf:Envelope> ---- <div class="paragraph"> <p>The document describing the virtual machine.</p> </div> <div class="paragraph"> <p>Example of the OVF document:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-xml" data-lang="xml">&lt;?xml version='1.0' encoding='UTF-8'?&gt; &lt;ovf:Envelope xmlns:ovf="http://schemas.dmtf.org/ovf/envelope/1/" xmlns:rasd="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_ResourceAllocationSettingData" xmlns:vssd="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_VirtualSystemSettingData" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" ovf:version="3.5.0.0"&gt; &lt;References/&gt; &lt;Section xsi:type="ovf:NetworkSection_Type"&gt; &lt;Info&gt;List of networks&lt;/Info&gt; &lt;Network ovf:name="Network 1"/&gt; &lt;/Section&gt; &lt;Section xsi:type="ovf:DiskSection_Type"&gt; &lt;Info&gt;List of Virtual Disks&lt;/Info&gt; &lt;/Section&gt; &lt;Content ovf:id="out" xsi:type="ovf:VirtualSystem_Type"&gt; &lt;CreationDate&gt;2014/12/03 04:25:45&lt;/CreationDate&gt; &lt;ExportDate&gt;2015/02/09 14:12:24&lt;/ExportDate&gt; &lt;DeleteProtected&gt;false&lt;/DeleteProtected&gt; &lt;SsoMethod&gt;guest_agent&lt;/SsoMethod&gt; &lt;IsSmartcardEnabled&gt;false&lt;/IsSmartcardEnabled&gt; &lt;TimeZone&gt;Etc/GMT&lt;/TimeZone&gt; &lt;default_boot_sequence&gt;0&lt;/default_boot_sequence&gt; &lt;Generation&gt;1&lt;/Generation&gt; &lt;VmType&gt;1&lt;/VmType&gt; &lt;MinAllocatedMem&gt;1024&lt;/MinAllocatedMem&gt; &lt;IsStateless&gt;false&lt;/IsStateless&gt; &lt;IsRunAndPause&gt;false&lt;/IsRunAndPause&gt; &lt;AutoStartup&gt;false&lt;/AutoStartup&gt; &lt;Priority&gt;1&lt;/Priority&gt; &lt;CreatedByUserId&gt;fdfc627c-d875-11e0-90f0-83df133b58cc&lt;/CreatedByUserId&gt; &lt;IsBootMenuEnabled&gt;false&lt;/IsBootMenuEnabled&gt; &lt;IsSpiceFileTransferEnabled&gt;true&lt;/IsSpiceFileTransferEnabled&gt; &lt;IsSpiceCopyPasteEnabled&gt;true&lt;/IsSpiceCopyPasteEnabled&gt; &lt;Name&gt;VM_export&lt;/Name&gt; &lt;TemplateId&gt;00000000-0000-0000-0000-000000000000&lt;/TemplateId&gt; &lt;TemplateName&gt;Blank&lt;/TemplateName&gt; &lt;IsInitilized&gt;false&lt;/IsInitilized&gt; &lt;Origin&gt;3&lt;/Origin&gt; &lt;DefaultDisplayType&gt;1&lt;/DefaultDisplayType&gt; &lt;TrustedService&gt;false&lt;/TrustedService&gt; &lt;OriginalTemplateId&gt;00000000-0000-0000-0000-000000000000&lt;/OriginalTemplateId&gt; &lt;OriginalTemplateName&gt;Blank&lt;/OriginalTemplateName&gt; &lt;UseLatestVersion&gt;false&lt;/UseLatestVersion&gt; &lt;Section ovf:id="70b4d9a7-4f73-4def-89ca-24fc5f60e01a" ovf:required="false" xsi:type="ovf:OperatingSystemSection_Type"&gt; &lt;Info&gt;Guest Operating System&lt;/Info&gt; &lt;Description&gt;other&lt;/Description&gt; &lt;/Section&gt; &lt;Section xsi:type="ovf:VirtualHardwareSection_Type"&gt; &lt;Info&gt;1 CPU, 1024 Memeory&lt;/Info&gt; &lt;System&gt; &lt;vssd:VirtualSystemType&gt;ENGINE 3.5.0.0&lt;/vssd:VirtualSystemType&gt; &lt;/System&gt; &lt;Item&gt; &lt;rasd:Caption&gt;1 virtual cpu&lt;/rasd:Caption&gt; &lt;rasd:Description&gt;Number of virtual CPU&lt;/rasd:Description&gt; &lt;rasd:InstanceId&gt;1&lt;/rasd:InstanceId&gt; &lt;rasd:ResourceType&gt;3&lt;/rasd:ResourceType&gt; &lt;rasd:num_of_sockets&gt;1&lt;/rasd:num_of_sockets&gt; &lt;rasd:cpu_per_socket&gt;1&lt;/rasd:cpu_per_socket&gt; &lt;/Item&gt; &lt;Item&gt; &lt;rasd:Caption&gt;1024 MB of memory&lt;/rasd:Caption&gt; &lt;rasd:Description&gt;Memory Size&lt;/rasd:Description&gt; &lt;rasd:InstanceId&gt;2&lt;/rasd:InstanceId&gt; &lt;rasd:ResourceType&gt;4&lt;/rasd:ResourceType&gt; &lt;rasd:AllocationUnits&gt;MegaBytes&lt;/rasd:AllocationUnits&gt; &lt;rasd:VirtualQuantity&gt;1024&lt;/rasd:VirtualQuantity&gt; &lt;/Item&gt; &lt;Item&gt; &lt;rasd:Caption&gt;USB Controller&lt;/rasd:Caption&gt; &lt;rasd:InstanceId&gt;3&lt;/rasd:InstanceId&gt; &lt;rasd:ResourceType&gt;23&lt;/rasd:ResourceType&gt; &lt;rasd:UsbPolicy&gt;DISABLED&lt;/rasd:UsbPolicy&gt; &lt;/Item&gt; &lt;/Section&gt; &lt;/Content&gt; &lt;/ovf:Envelope&gt;</code></pre> </div> </div> author value Shmuel Melamud <smelamud@redhat.com> Byron Gravenorst <bgraveno@redhat.com> date value 4 Nov 2016 status value updated_by_docs data string device id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string template template instance_type instance_type References to the virtual machines that are using this device. A device may be used by several virtual machines; for example, a shared disk my be used simultaneously by two or more virtual machines. <div class="paragraph"> <p>References to the virtual machines that are using this device. A device may be used by several virtual machines; for example, a shared disk my be used simultaneously by two or more virtual machines.</p> </div> author value Byron Gravenorst <bgraveno@redhat.com> date value 31 Oct 2016 status value updated_by_docs vms vm[] Don't use this element, use `vms` instead. <div class="paragraph"> <p>Don&#8217;t use this element, use <code>vms</code> instead.</p> </div> deprecated author value Byron Gravenorst <bgraveno@redhat.com> date value 31 Oct 2016 status value updated_by_docs vm vm skip_if_sd_active enabled boolean se_linux mode usb enabled boolean type Represents pinning of a virtual NUMA node to a physical NUMA node. <div class="paragraph"> <p>Represents pinning of a virtual NUMA node to a physical NUMA node.</p> </div> author value Andrej Krejcir <akrejcir@redhat.com> date value 14 Sep 2016 status value added numa_node_pin Deprecated - has no function. <div class="paragraph"> <p>Deprecated - has no function.</p> </div> deprecated author value Andrej Krejcir <akrejcir@redhat.com> date value 14 Sep 2016 status value added host_numa_node numa_node Deprecated - should always be true. <div class="paragraph"> <p>Deprecated - should always be true.</p> </div> deprecated author value Andrej Krejcir <akrejcir@redhat.com> date value 14 Sep 2016 status value added pinned boolean Index of a physical NUMA node to which the virtual NUMA node is pinned. <div class="paragraph"> <p>Index of a physical NUMA node to which the virtual NUMA node is pinned.</p> </div> author value Andrej Krejcir <akrejcir@redhat.com> date value 14 Sep 2016 status value added index integer host_protocol xml stomp error_handling on_error external_host_group architecture_name string operating_system_name string domain_name string subnet_name string id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string external_host_provider external_host_provider template_status illegal locked ok sso methods method[] vm_affinity migratable user_migratable pinned payload files file[] volume_id string type kernel version version message_broker_type qpid rabbit_mq gluster_state up down unknown display_type vnc spice migration_options auto_converge compressed The bandwidth which is allowed to be used by the migrations. <div class="paragraph"> <p>The bandwidth which is allowed to be used by the migrations.</p> </div> bandwidth migration_bandwidth Reference to the migration policy as defined using `engine-config`. <div class="paragraph"> <p>Reference to the migration policy as defined using <code>engine-config</code>.</p> </div> policy migration_policy cpu_tune vcpu_pins vcpu_pin[] open_stack_provider tenant_name string url string requires_authentication boolean username string password string authentication_url string properties property[] id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string method id Represents a host NIC. For example, the XML representation of a host NIC looks like this: [source,xml] ---- <host_nic href="/ovirt-engine/api/hosts/123/nics/456" id="456"> <name>eth0</name> <boot_protocol>static</boot_protocol> <bridged>true</bridged> <custom_configuration>true</custom_configuration> <ip> <address>192.168.122.39</address> <gateway>192.168.122.1</gateway> <netmask>255.255.255.0</netmask> <version>v4</version> </ip> <ipv6> <gateway>::</gateway> <version>v6</version> </ipv6> <ipv6_boot_protocol>none</ipv6_boot_protocol> <mac> <address>52:54:00:0c:79:1d</address> </mac> <mtu>1500</mtu> <status>up</status> </host_nic> ---- <div class="paragraph"> <p>Represents a host NIC.</p> </div> <div class="paragraph"> <p>For example, the XML representation of a host NIC looks like this:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-xml" data-lang="xml">&lt;host_nic href="/ovirt-engine/api/hosts/123/nics/456" id="456"&gt; &lt;name&gt;eth0&lt;/name&gt; &lt;boot_protocol&gt;static&lt;/boot_protocol&gt; &lt;bridged&gt;true&lt;/bridged&gt; &lt;custom_configuration&gt;true&lt;/custom_configuration&gt; &lt;ip&gt; &lt;address&gt;192.168.122.39&lt;/address&gt; &lt;gateway&gt;192.168.122.1&lt;/gateway&gt; &lt;netmask&gt;255.255.255.0&lt;/netmask&gt; &lt;version&gt;v4&lt;/version&gt; &lt;/ip&gt; &lt;ipv6&gt; &lt;gateway&gt;::&lt;/gateway&gt; &lt;version&gt;v6&lt;/version&gt; &lt;/ipv6&gt; &lt;ipv6_boot_protocol&gt;none&lt;/ipv6_boot_protocol&gt; &lt;mac&gt; &lt;address&gt;52:54:00:0c:79:1d&lt;/address&gt; &lt;/mac&gt; &lt;mtu&gt;1500&lt;/mtu&gt; &lt;status&gt;up&lt;/status&gt; &lt;/host_nic&gt;</code></pre> </div> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added host_nic The MAC address of the NIC. <div class="paragraph"> <p>The MAC address of the NIC.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added mac mac ip ip ipv6 ip base_interface string vlan vlan bonding bonding boot_protocol ipv6_boot_protocol A link to the statistics of the NIC. <div class="paragraph"> <p>A link to the statistics of the NIC.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added statistics statistic[] check_connectivity boolean speed integer status mtu integer bridged boolean custom_configuration boolean override_configuration boolean network_labels network_label[] properties property[] The `ad_aggregator_id` property of a bond or bond slave, for bonds in mode 4. Bond mode 4 is the 802.3ad standard, also called dynamic link aggregation - https://en.wikipedia.org/wiki/Link_aggregation[Wikipedia] http://www.ieee802.org/3/hssg/public/apr07/frazier_01_0407.pdf[Presentation]. This is only valid for bonds in mode 4, or NICs (NIC - network interface card) which are part of a bond. It is not present for bonds in other modes, or NICs which are not part in a bond in mode 4. The `ad_aggregator_id` property indicates which of the bond slaves are active. The value of the `ad_aggregator_id` of an active slave is the same the value of the `ad_aggregator_id` property of the bond. This parameter is read only. Setting it will have no effect on the bond/NIC. It is retrieved from `/sys/class/net/bondX/bonding/ad_aggregator` file for a bond, and the `/sys/class/net/ensX/bonding_slave/ad_aggregator_id` file for a NIC. <div class="paragraph"> <p>The <code>ad_aggregator_id</code> property of a bond or bond slave, for bonds in mode 4. Bond mode 4 is the 802.3ad standard, also called dynamic link aggregation - <a href="https://en.wikipedia.org/wiki/Link_aggregation">Wikipedia</a> <a href="http://www.ieee802.org/3/hssg/public/apr07/frazier_01_0407.pdf">Presentation</a>. This is only valid for bonds in mode 4, or NICs (NIC - network interface card) which are part of a bond. It is not present for bonds in other modes, or NICs which are not part in a bond in mode 4. The <code>ad_aggregator_id</code> property indicates which of the bond slaves are active. The value of the <code>ad_aggregator_id</code> of an active slave is the same the value of the <code>ad_aggregator_id</code> property of the bond. This parameter is read only. Setting it will have no effect on the bond/NIC. It is retrieved from <code>/sys/class/net/bondX/bonding/ad_aggregator</code> file for a bond, and the <code>/sys/class/net/ensX/bonding_slave/ad_aggregator_id</code> file for a NIC.</p> </div> author value Marcin Mirecki <mmirecki@redhat.com> date value 10 Aug 2016 status value added since value 4.0.3 ad_aggregator_id integer For a SR-IOV physical function NIC describes its virtual functions configuration. <div class="paragraph"> <p>For a SR-IOV physical function NIC describes its virtual functions configuration.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added virtual_functions_configuration host_nic_virtual_functions_configuration id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string host host A reference to the network which the interface should be connected. A blank network id is allowed. <div class="paragraph"> <p>A reference to the network which the interface should be connected. A blank network id is allowed.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added network network qos qos For a SR-IOV virtual function NIC references to its physical function NIC. <div class="paragraph"> <p>For a SR-IOV virtual function NIC references to its physical function NIC.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added physical_function host_nic operating_system_info large_icon icon small_icon icon id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string job status start_time date end_time date last_updated date external boolean auto_cleared boolean id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string owner user steps step[] Describes virtual functions configuration for an SR-IOV enabled physical function NIC. <div class="paragraph"> <p>Describes virtual functions configuration for an SR-IOV enabled physical function NIC.</p> </div> host_nic_virtual_functions_configuration Maximum number of virtual functions the NIC supports. Read-only property. <div class="paragraph"> <p>Maximum number of virtual functions the NIC supports. Read-only property.</p> </div> max_number_of_virtual_functions integer Number of curently defined virtual functions. User-defined value between 0 and `maxNumberOfVirtualFunctions`. <div class="paragraph"> <p>Number of curently defined virtual functions. User-defined value between 0 and <code>maxNumberOfVirtualFunctions</code>.</p> </div> number_of_virtual_functions integer Defines whether all networks are allowed to be defined on the related virtual functions or specified ones only. <div class="paragraph"> <p>Defines whether all networks are allowed to be defined on the related virtual functions or specified ones only.</p> </div> all_networks_allowed boolean weight factor integer id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string scheduling_policy scheduling_policy scheduling_policy_unit scheduling_policy_unit open_stack_network_provider plugin_type agent_configuration agent_configuration Indicates whether the provider is read only. A read-only provider does not allow adding, modifying or deleting of networks or subnets. Port-related operations are allowed, as they are required for the provisioning of virtual nics. <div class="paragraph"> <p>Indicates whether the provider is read only. A read-only provider does not allow adding, modifying or deleting of networks or subnets. Port-related operations are allowed, as they are required for the provisioning of virtual nics.</p> </div> read_only boolean The type of provider. <div class="paragraph"> <p>The type of provider.</p> </div> type tenant_name string url string requires_authentication boolean username string password string authentication_url string properties property[] id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string certificates certificate[] networks open_stack_network[] subnets open_stack_subnet[] reported_device type mac mac ips ip[] id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string vm vm quota_cluster_limit vcpu_limit integer vcpu_usage integer memory_limit decimal memory_usage decimal id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string quota quota cluster cluster role mutable boolean administrative boolean id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string user user permits permit[] network_attachment ip_address_assignments ip_address_assignment[] properties property[] in_sync boolean reported_configurations reported_configuration[] id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string network network host_nic host_nic host host qos qos A list of possible phases for an <<types/image_transfer, image transfer>> entity. Each of these values defines a specific point in a transfer flow. Please refer to <<services/image_transfer, image transfer>> for further documentation. <div class="paragraph"> <p>A list of possible phases for an <a href="#types/image_transfer">image transfer</a> entity. Each of these values defines a specific point in a transfer flow.</p> </div> <div class="paragraph"> <p>Please refer to <a href="#services/image_transfer">image transfer</a> for further documentation.</p> </div> author value Amit Aviram <aaviram@redhat.com> date value 30 Aug 2016 status value added since value 4.0.4 image_transfer_phase An unknown phase, will only be set in cases of unpredictable errors. <div class="paragraph"> <p>An unknown phase, will only be set in cases of unpredictable errors.</p> </div> author value Amit Aviram <aaviram@redhat.com> date value 30 Aug 2016 status value added since value 4.0.4 unknown The initial phase of an added image transfer. It is set as long as the transfer session is establishing. Once the session is established, the phase will be changed to `transferring` <div class="paragraph"> <p>The initial phase of an added image transfer. It is set as long as the transfer session is establishing. Once the session is established, the phase will be changed to <code>transferring</code></p> </div> author value Amit Aviram <aaviram@redhat.com> date value 30 Aug 2016 status value added since value 4.0.4 initializing The phase where the transfer session is open, and the client can do I/O to the desired image using its preferred tools. <div class="paragraph"> <p>The phase where the transfer session is open, and the client can do I/O to the desired image using its preferred tools.</p> </div> author value Amit Aviram <aaviram@redhat.com> date value 30 Aug 2016 status value added since value 4.0.4 transferring The phase where the transfer had been resumed by the client calling <<services/image_transfer/methods/resume, resume>>. Resuming will start a new session, and after calling it, the phase should be changed to `transferring`, or `paused_system` in case of a failure. <div class="paragraph"> <p>The phase where the transfer had been resumed by the client calling <a href="#services/image_transfer/methods/resume">resume</a>. Resuming will start a new session, and after calling it, the phase should be changed to <code>transferring</code>, or <code>paused_system</code> in case of a failure.</p> </div> author value Amit Aviram <aaviram@redhat.com> date value 30 Aug 2016 status value added since value 4.0.4 resuming This phase stands for a situation in which the session was timed out, or if some other error occurred with this transfer, e.g, ovirt-imageio-daemon is not running in the selected host for transferring. For trying to resume the session, the client should call <<services/image_transfer/methods/resume, resume>>. After resuming, the phase will change to `resuming` <div class="paragraph"> <p>This phase stands for a situation in which the session was timed out, or if some other error occurred with this transfer, e.g, ovirt-imageio-daemon is not running in the selected host for transferring. For trying to resume the session, the client should call <a href="#services/image_transfer/methods/resume">resume</a>. After resuming, the phase will change to <code>resuming</code></p> </div> author value Amit Aviram <aaviram@redhat.com> date value 30 Aug 2016 status value added since value 4.0.4 paused_system This phase will be set as a result of an active pause call by the user, using <<services/image_transfer/methods/pause, pause>>. <div class="paragraph"> <p>This phase will be set as a result of an active pause call by the user, using <a href="#services/image_transfer/methods/pause">pause</a>.</p> </div> author value Amit Aviram <aaviram@redhat.com> date value 30 Aug 2016 status value added since value 4.0.4 paused_user This phase will be set as a result of the user actively cancelling the transfer, which can only be performed via the webadmin. <div class="paragraph"> <p>This phase will be set as a result of the user actively cancelling the transfer, which can only be performed via the webadmin.</p> </div> author value Amit Aviram <aaviram@redhat.com> date value 30 Aug 2016 status value added since value 4.0.4 cancelled This phase will be set when the user calls <<services/image_transfer/methods/finalize, finalize>>. Calling finalize is essential in order to finish the transfer session and using the targeted image. After finalizing, the phase will be changed to `finished_success` or `finished_failure`. Please refer to <<services/image_transfer, image transfer>> for further documentation. <div class="paragraph"> <p>This phase will be set when the user calls <a href="#services/image_transfer/methods/finalize">finalize</a>. Calling finalize is essential in order to finish the transfer session and using the targeted image. After finalizing, the phase will be changed to <code>finished_success</code> or <code>finished_failure</code>.</p> </div> <div class="paragraph"> <p>Please refer to <a href="#services/image_transfer">image transfer</a> for further documentation.</p> </div> author value Amit Aviram <aaviram@redhat.com> date value 30 Aug 2016 status value added since value 4.0.4 finalizing_success This phase can only be set by oVirt webadmin, and states that there was some error during the transfer and it is being finalized with failure. <div class="paragraph"> <p>This phase can only be set by oVirt webadmin, and states that there was some error during the transfer and it is being finalized with failure.</p> </div> author value Amit Aviram <aaviram@redhat.com> date value 30 Aug 2016 status value added since value 4.0.4 finalizing_failure States that the transfer session was successfully closed, and the targeted image was verified and ready to be used. After reaching this phase, the image transfer entity will soon be deleted. <div class="paragraph"> <p>States that the transfer session was successfully closed, and the targeted image was verified and ready to be used. After reaching this phase, the image transfer entity will soon be deleted.</p> </div> author value Amit Aviram <aaviram@redhat.com> date value 30 Aug 2016 status value added since value 4.0.4 finished_success States that the targeted image failed the verification, and cannot be used. After reaching this phase, the image transfer entity will soon be deleted, and the targeted image will be set to illegal. <div class="paragraph"> <p>States that the targeted image failed the verification, and cannot be used. After reaching this phase, the image transfer entity will soon be deleted, and the targeted image will be set to illegal.</p> </div> author value Amit Aviram <aaviram@redhat.com> date value 30 Aug 2016 status value added since value 4.0.4 finished_failure gluster_brick_advanced_details port integer pid integer device string mnt_options string fs_name string gluster_clients gluster_client[] memory_pools gluster_memory_pool[] id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string template template instance_type instance_type References to the virtual machines that are using this device. A device may be used by several virtual machines; for example, a shared disk my be used simultaneously by two or more virtual machines. <div class="paragraph"> <p>References to the virtual machines that are using this device. A device may be used by several virtual machines; for example, a shared disk my be used simultaneously by two or more virtual machines.</p> </div> author value Byron Gravenorst <bgraveno@redhat.com> date value 31 Oct 2016 status value updated_by_docs vms vm[] Don't use this element, use `vms` instead. <div class="paragraph"> <p>Don&#8217;t use this element, use <code>vms</code> instead.</p> </div> deprecated author value Byron Gravenorst <bgraveno@redhat.com> date value 31 Oct 2016 status value updated_by_docs vm vm permit administrative boolean id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string role role ssh port integer fingerprint string authentication_method user user id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string floppy file file id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string template template instance_type instance_type References to the virtual machines that are using this device. A device may be used by several virtual machines; for example, a shared disk my be used simultaneously by two or more virtual machines. <div class="paragraph"> <p>References to the virtual machines that are using this device. A device may be used by several virtual machines; for example, a shared disk my be used simultaneously by two or more virtual machines.</p> </div> author value Byron Gravenorst <bgraveno@redhat.com> date value 31 Oct 2016 status value updated_by_docs vms vm[] Don't use this element, use `vms` instead. <div class="paragraph"> <p>Don&#8217;t use this element, use <code>vms</code> instead.</p> </div> deprecated author value Byron Gravenorst <bgraveno@redhat.com> date value 31 Oct 2016 status value updated_by_docs vm vm external_host address string id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string external_host_provider external_host_provider vm status status_detail string stop_reason string start_time date stop_time date run_once boolean payloads payload[] The configuration of the virtual machine's placement policy. This configuration can be updated to pin a virtual machine to one or more hosts. NOTE: Virtual machines that are pinned to multiple hosts cannot be live migrated, but in the event of a host failure, any virtual machine configured to be highly available is automatically restarted on one of the other hosts to which the virtual machine is pinned. For example, to pin a virtual machine to two hosts, you would send a request like the following: [source] ---- PUT /api/vms/123 ---- With a request body like this: [source,xml] ---- <vm> <high_availability> <enabled>true</enabled> <priority>1</priority> </high_availability> <placement_policy> <hosts> <host> <name>Host1</name> </host> <host> <name>Host2</name> </host> </hosts> <affinity>pinned</affinity> </placement_policy> </vm> ---- <div class="paragraph"> <p>The configuration of the virtual machine&#8217;s placement policy.</p> </div> <div class="paragraph"> <p>This configuration can be updated to pin a virtual machine to one or more hosts.</p> </div> <div class="admonitionblock note"> <table> <tr> <td class="icon"> <div class="title">Note</div> </td> <td class="content"> Virtual machines that are pinned to multiple hosts cannot be live migrated, but in the event of a host failure, any virtual machine configured to be highly available is automatically restarted on one of the other hosts to which the virtual machine is pinned. </td> </tr> </table> </div> <div class="paragraph"> <p>For example, to pin a virtual machine to two hosts, you would send a request like the following:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code>PUT /api/vms/123</code></pre> </div> </div> <div class="paragraph"> <p>With a request body like this:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-xml" data-lang="xml">&lt;vm&gt; &lt;high_availability&gt; &lt;enabled&gt;true&lt;/enabled&gt; &lt;priority&gt;1&lt;/priority&gt; &lt;/high_availability&gt; &lt;placement_policy&gt; &lt;hosts&gt; &lt;host&gt; &lt;name&gt;Host1&lt;/name&gt; &lt;/host&gt; &lt;host&gt; &lt;name&gt;Host2&lt;/name&gt; &lt;/host&gt; &lt;/hosts&gt; &lt;affinity&gt;pinned&lt;/affinity&gt; &lt;/placement_policy&gt; &lt;/vm&gt;</code></pre> </div> </div> author value Phillip Bailey <phbailey@redhat.com> date value 14 Sep 2016 status value added placement_policy vm_placement_policy fqdn string use_latest_template_version boolean next_run_configuration_exists boolean numa_tune_mode guest_time_zone time_zone guest_operating_system guest_operating_system type The virtual machine's memory, in bytes. For example, in order to update a virtual machine to contain 1 GiB of memory send a request like this: [source] ---- PUT /ovirt-engine/api/vms/123 ---- With a request body like this: [source,xml] ---- <vm> <memory>1073741824</memory> </vm> ---- NOTE: Memory in the previous example is converted to bytes using the following formula: + 1 GiB = 2^30^ bytes = 1073741824 bytes. NOTE: Memory hot plug is supported from oVirt 3.6 onwards. You can use the example above to increase memory while the virtual machine is running. <div class="paragraph"> <p>The virtual machine&#8217;s memory, in bytes.</p> </div> <div class="paragraph"> <p>For example, in order to update a virtual machine to contain 1 GiB of memory send a request like this:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code>PUT /ovirt-engine/api/vms/123</code></pre> </div> </div> <div class="paragraph"> <p>With a request body like this:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-xml" data-lang="xml">&lt;vm&gt; &lt;memory&gt;1073741824&lt;/memory&gt; &lt;/vm&gt;</code></pre> </div> </div> <div class="admonitionblock note"> <table> <tr> <td class="icon"> <div class="title">Note</div> </td> <td class="content"> Memory in the previous example is converted to bytes using the following formula:<br> 1 GiB = 2<sup>30</sup> bytes = 1073741824 bytes. </td> </tr> </table> </div> <div class="admonitionblock note"> <table> <tr> <td class="icon"> <div class="title">Note</div> </td> <td class="content"> Memory hot plug is supported from oVirt 3.6 onwards. You can use the example above to increase memory while the virtual machine is running. </td> </tr> </table> </div> author value Yanir Quinn <yquinn@redhat.com> date value 14 Sep 2016 status value added memory integer The configuration of the CPU of the virtual machine. The sockets configuration can be updated without rebooting the virtual machine. The cores and the threads require a reboot in order to take place. For example, to change the number of sockets to 4 immediately and the number of cores and threads to 2 after reboot send a request: [source] ---- PUT /ovirt-engine/api/vms/123 ---- With a request body: [source,xml] ---- <vm> <cpu> <topology> <sockets>4</sockets> <cores>2</cores> <threads>2</threads> </topology> </cpu> </vm> ---- <div class="paragraph"> <p>The configuration of the CPU of the virtual machine.</p> </div> <div class="paragraph"> <p>The sockets configuration can be updated without rebooting the virtual machine. The cores and the threads require a reboot in order to take place.</p> </div> <div class="paragraph"> <p>For example, to change the number of sockets to 4 immediately and the number of cores and threads to 2 after reboot send a request:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code>PUT /ovirt-engine/api/vms/123</code></pre> </div> </div> <div class="paragraph"> <p>With a request body:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-xml" data-lang="xml">&lt;vm&gt; &lt;cpu&gt; &lt;topology&gt; &lt;sockets&gt;4&lt;/sockets&gt; &lt;cores&gt;2&lt;/cores&gt; &lt;threads&gt;2&lt;/threads&gt; &lt;/topology&gt; &lt;/cpu&gt; &lt;/vm&gt;</code></pre> </div> </div> author value Jenny Tokar <jtokar@redhat.com> date value 14 Sep 2016 status value added cpu cpu cpu_shares integer bios bios os operating_system creation_time date origin string stateless boolean delete_protected boolean high_availability high_availability display display sso sso rng_device rng_device console console domain domain usb usb soundcard_enabled boolean tunnel_migration boolean migration_downtime integer virtio_scsi virtio_scsi serial_number serial_number start_paused boolean migration migration_options io io custom_properties custom_property[] custom_emulated_machine string custom_cpu_model string time_zone time_zone small_icon icon large_icon icon initialization initialization memory_policy memory_policy Virtual machine custom compatibility version. This field allows to customize a virtual machine to its own compatibility version. If `custom_compatibility_version` is set, it overrides the cluster's compatibility version for this particular virtual machine. The compatibility version of a virtual machine is limited by the data center the virtual machine resides in and is checked against capabilities of the host the virtual machine is planned to run on. <div class="paragraph"> <p>Virtual machine custom compatibility version.</p> </div> <div class="paragraph"> <p>This field allows to customize a virtual machine to its own compatibility version. If <code>custom_compatibility_version</code> is set, it overrides the cluster&#8217;s compatibility version for this particular virtual machine.</p> </div> <div class="paragraph"> <p>The compatibility version of a virtual machine is limited by the data center the virtual machine resides in and is checked against capabilities of the host the virtual machine is planned to run on.</p> </div> custom_compatibility_version version id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string cluster cluster storage_domain storage_domain cpu_profile cpu_profile quota quota host host template template instance_type instance_type Link to the the list of network interface devices on the virtual machine. <div class="paragraph"> <p>Link to the the list of network interface devices on the virtual machine.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added nics nic[] snapshots snapshot[] vm_pool vm_pool cdroms cdrom[] floppies floppy[] reported_devices reported_device[] watchdogs watchdog[] permissions permission[] external_host_provider external_host_provider affinity_labels affinity_label[] applications application[] graphics_consoles graphics_console[] host_devices host_device[] katello_errata katello_erratum[] numa_nodes numa_node[] sessions session[] statistics statistic[] tags tag[] References to the disks attached to the virtual machine. <div class="paragraph"> <p>References to the disks attached to the virtual machine.</p> </div> disk_attachments disk_attachment[] console enabled boolean spm_status none contending spm network_configuration nics nic[] dns dns cpu_topology sockets integer cores integer threads integer template_version version_number integer version_name string base_template template Enumerated type describing all switch types currently supported by engine. <div class="paragraph"> <p>Enumerated type describing all switch types currently supported by engine.</p> </div> switch_type Type representing native switch. <div class="paragraph"> <p>Type representing native switch.</p> </div> legacy Type representing Open vSwitch. <div class="paragraph"> <p>Type representing Open vSwitch.</p> </div> ovs This type contains the information returned by root service of the API. <div class="paragraph"> <p>This type contains the information returned by root service of the API.</p> </div> api References to special objects, like the blank template and the root of the hierarchy of tags. <div class="paragraph"> <p>References to special objects, like the blank template and the root of the hierarchy of tags.</p> </div> special_objects special_objects Information about the product, like its name, the name of the vendor and the version. <div class="paragraph"> <p>Information about the product, like its name, the name of the vendor and the version.</p> </div> product_info product_info A summary containing the total number of relevant objects, like virtual machines, hosts and storage domains. <div class="paragraph"> <p>A summary containing the total number of relevant objects, like virtual machines, hosts and storage domains.</p> </div> summary api_summary The date and time when this information was generated. <div class="paragraph"> <p>The date and time when this information was generated.</p> </div> time date Represents a snapshot object. [source,xml] ---- <snapshot id="456" href="/ovirt-engine/api/vms/123/snapshots/456"> <actions> <link rel="restore" href="/ovirt-engine/api/vms/123/snapshots/456/restore"/> </actions> <vm id="123" href="/ovirt-engine/api/vms/123"/> <description>Virtual Machine 1 - Snapshot A</description> <type>active</type> <date>2010-08-16T14:24:29</date> <persist_memorystate>false</persist_memorystate> </snapshot> ---- <div class="paragraph"> <p>Represents a snapshot object.</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-xml" data-lang="xml">&lt;snapshot id="456" href="/ovirt-engine/api/vms/123/snapshots/456"&gt; &lt;actions&gt; &lt;link rel="restore" href="/ovirt-engine/api/vms/123/snapshots/456/restore"/&gt; &lt;/actions&gt; &lt;vm id="123" href="/ovirt-engine/api/vms/123"/&gt; &lt;description&gt;Virtual Machine 1 - Snapshot A&lt;/description&gt; &lt;type&gt;active&lt;/type&gt; &lt;date&gt;2010-08-16T14:24:29&lt;/date&gt; &lt;persist_memorystate&gt;false&lt;/persist_memorystate&gt; &lt;/snapshot&gt;</code></pre> </div> </div> author value Daniel Erez <derez@redhat.com> date value 14 Sep 2016 status value added snapshot date date snapshot_status persist_memorystate boolean snapshot_type status status_detail string stop_reason string start_time date stop_time date run_once boolean payloads payload[] The configuration of the virtual machine's placement policy. This configuration can be updated to pin a virtual machine to one or more hosts. NOTE: Virtual machines that are pinned to multiple hosts cannot be live migrated, but in the event of a host failure, any virtual machine configured to be highly available is automatically restarted on one of the other hosts to which the virtual machine is pinned. For example, to pin a virtual machine to two hosts, you would send a request like the following: [source] ---- PUT /api/vms/123 ---- With a request body like this: [source,xml] ---- <vm> <high_availability> <enabled>true</enabled> <priority>1</priority> </high_availability> <placement_policy> <hosts> <host> <name>Host1</name> </host> <host> <name>Host2</name> </host> </hosts> <affinity>pinned</affinity> </placement_policy> </vm> ---- <div class="paragraph"> <p>The configuration of the virtual machine&#8217;s placement policy.</p> </div> <div class="paragraph"> <p>This configuration can be updated to pin a virtual machine to one or more hosts.</p> </div> <div class="admonitionblock note"> <table> <tr> <td class="icon"> <div class="title">Note</div> </td> <td class="content"> Virtual machines that are pinned to multiple hosts cannot be live migrated, but in the event of a host failure, any virtual machine configured to be highly available is automatically restarted on one of the other hosts to which the virtual machine is pinned. </td> </tr> </table> </div> <div class="paragraph"> <p>For example, to pin a virtual machine to two hosts, you would send a request like the following:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code>PUT /api/vms/123</code></pre> </div> </div> <div class="paragraph"> <p>With a request body like this:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-xml" data-lang="xml">&lt;vm&gt; &lt;high_availability&gt; &lt;enabled&gt;true&lt;/enabled&gt; &lt;priority&gt;1&lt;/priority&gt; &lt;/high_availability&gt; &lt;placement_policy&gt; &lt;hosts&gt; &lt;host&gt; &lt;name&gt;Host1&lt;/name&gt; &lt;/host&gt; &lt;host&gt; &lt;name&gt;Host2&lt;/name&gt; &lt;/host&gt; &lt;/hosts&gt; &lt;affinity&gt;pinned&lt;/affinity&gt; &lt;/placement_policy&gt; &lt;/vm&gt;</code></pre> </div> </div> author value Phillip Bailey <phbailey@redhat.com> date value 14 Sep 2016 status value added placement_policy vm_placement_policy fqdn string use_latest_template_version boolean next_run_configuration_exists boolean numa_tune_mode guest_time_zone time_zone guest_operating_system guest_operating_system type The virtual machine's memory, in bytes. For example, in order to update a virtual machine to contain 1 GiB of memory send a request like this: [source] ---- PUT /ovirt-engine/api/vms/123 ---- With a request body like this: [source,xml] ---- <vm> <memory>1073741824</memory> </vm> ---- NOTE: Memory in the previous example is converted to bytes using the following formula: + 1 GiB = 2^30^ bytes = 1073741824 bytes. NOTE: Memory hot plug is supported from oVirt 3.6 onwards. You can use the example above to increase memory while the virtual machine is running. <div class="paragraph"> <p>The virtual machine&#8217;s memory, in bytes.</p> </div> <div class="paragraph"> <p>For example, in order to update a virtual machine to contain 1 GiB of memory send a request like this:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code>PUT /ovirt-engine/api/vms/123</code></pre> </div> </div> <div class="paragraph"> <p>With a request body like this:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-xml" data-lang="xml">&lt;vm&gt; &lt;memory&gt;1073741824&lt;/memory&gt; &lt;/vm&gt;</code></pre> </div> </div> <div class="admonitionblock note"> <table> <tr> <td class="icon"> <div class="title">Note</div> </td> <td class="content"> Memory in the previous example is converted to bytes using the following formula:<br> 1 GiB = 2<sup>30</sup> bytes = 1073741824 bytes. </td> </tr> </table> </div> <div class="admonitionblock note"> <table> <tr> <td class="icon"> <div class="title">Note</div> </td> <td class="content"> Memory hot plug is supported from oVirt 3.6 onwards. You can use the example above to increase memory while the virtual machine is running. </td> </tr> </table> </div> author value Yanir Quinn <yquinn@redhat.com> date value 14 Sep 2016 status value added memory integer The configuration of the CPU of the virtual machine. The sockets configuration can be updated without rebooting the virtual machine. The cores and the threads require a reboot in order to take place. For example, to change the number of sockets to 4 immediately and the number of cores and threads to 2 after reboot send a request: [source] ---- PUT /ovirt-engine/api/vms/123 ---- With a request body: [source,xml] ---- <vm> <cpu> <topology> <sockets>4</sockets> <cores>2</cores> <threads>2</threads> </topology> </cpu> </vm> ---- <div class="paragraph"> <p>The configuration of the CPU of the virtual machine.</p> </div> <div class="paragraph"> <p>The sockets configuration can be updated without rebooting the virtual machine. The cores and the threads require a reboot in order to take place.</p> </div> <div class="paragraph"> <p>For example, to change the number of sockets to 4 immediately and the number of cores and threads to 2 after reboot send a request:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code>PUT /ovirt-engine/api/vms/123</code></pre> </div> </div> <div class="paragraph"> <p>With a request body:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-xml" data-lang="xml">&lt;vm&gt; &lt;cpu&gt; &lt;topology&gt; &lt;sockets&gt;4&lt;/sockets&gt; &lt;cores&gt;2&lt;/cores&gt; &lt;threads&gt;2&lt;/threads&gt; &lt;/topology&gt; &lt;/cpu&gt; &lt;/vm&gt;</code></pre> </div> </div> author value Jenny Tokar <jtokar@redhat.com> date value 14 Sep 2016 status value added cpu cpu cpu_shares integer bios bios os operating_system creation_time date origin string stateless boolean delete_protected boolean high_availability high_availability display display sso sso rng_device rng_device console console domain domain usb usb soundcard_enabled boolean tunnel_migration boolean migration_downtime integer virtio_scsi virtio_scsi serial_number serial_number start_paused boolean migration migration_options io io custom_properties custom_property[] custom_emulated_machine string custom_cpu_model string time_zone time_zone small_icon icon large_icon icon initialization initialization memory_policy memory_policy Virtual machine custom compatibility version. This field allows to customize a virtual machine to its own compatibility version. If `custom_compatibility_version` is set, it overrides the cluster's compatibility version for this particular virtual machine. The compatibility version of a virtual machine is limited by the data center the virtual machine resides in and is checked against capabilities of the host the virtual machine is planned to run on. <div class="paragraph"> <p>Virtual machine custom compatibility version.</p> </div> <div class="paragraph"> <p>This field allows to customize a virtual machine to its own compatibility version. If <code>custom_compatibility_version</code> is set, it overrides the cluster&#8217;s compatibility version for this particular virtual machine.</p> </div> <div class="paragraph"> <p>The compatibility version of a virtual machine is limited by the data center the virtual machine resides in and is checked against capabilities of the host the virtual machine is planned to run on.</p> </div> custom_compatibility_version version id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string cluster cluster storage_domain storage_domain cpu_profile cpu_profile quota quota host host template template instance_type instance_type Link to the the list of network interface devices on the virtual machine. <div class="paragraph"> <p>Link to the the list of network interface devices on the virtual machine.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added nics nic[] snapshots snapshot[] vm_pool vm_pool cdroms cdrom[] floppies floppy[] reported_devices reported_device[] watchdogs watchdog[] permissions permission[] external_host_provider external_host_provider affinity_labels affinity_label[] applications application[] graphics_consoles graphics_console[] host_devices host_device[] katello_errata katello_erratum[] numa_nodes numa_node[] sessions session[] statistics statistic[] tags tag[] References to the disks attached to the virtual machine. <div class="paragraph"> <p>References to the disks attached to the virtual machine.</p> </div> disk_attachments disk_attachment[] vm vm This enum holds the types of all internal policy units types <div class="paragraph"> <p>This enum holds the types of all internal policy units types</p> </div> policy_unit_type filter weight load_balancing serial_number_policy host vm custom gluster_memory_pool type string hot_count integer cold_count integer padded_size integer alloc_count integer max_alloc integer pool_misses integer max_stdalloc integer id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string pm_proxy_type Fence proxy is selected from the same cluster as fenced host. <div class="paragraph"> <p>Fence proxy is selected from the same cluster as fenced host.</p> </div> author value Tomas Jelinek <tjelinek@redhat.com> date value 14 Sep 2016 status value added cluster Fence proxy is selected from the same data center as fenced host. <div class="paragraph"> <p>Fence proxy is selected from the same data center as fenced host.</p> </div> author value Tomas Jelinek <tjelinek@redhat.com> date value 14 Sep 2016 status value added dc Fence proxy is selected from a different data center than fenced host. <div class="paragraph"> <p>Fence proxy is selected from a different data center than fenced host.</p> </div> author value Tomas Jelinek <tjelinek@redhat.com> date value 14 Sep 2016 status value added other_dc quota_storage_limit limit integer usage decimal id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string quota quota storage_domain storage_domain gluster_brick server_id string brick_dir string status port integer pid integer device string mnt_options string fs_name string gluster_clients gluster_client[] memory_pools gluster_memory_pool[] id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string template template instance_type instance_type References to the virtual machines that are using this device. A device may be used by several virtual machines; for example, a shared disk my be used simultaneously by two or more virtual machines. <div class="paragraph"> <p>References to the virtual machines that are using this device. A device may be used by several virtual machines; for example, a shared disk my be used simultaneously by two or more virtual machines.</p> </div> author value Byron Gravenorst <bgraveno@redhat.com> date value 31 Oct 2016 status value updated_by_docs vms vm[] Don't use this element, use `vms` instead. <div class="paragraph"> <p>Don&#8217;t use this element, use <code>vms</code> instead.</p> </div> deprecated author value Byron Gravenorst <bgraveno@redhat.com> date value 31 Oct 2016 status value updated_by_docs vm vm gluster_volume gluster_volume statistics statistic[] cpu_profile id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string qos qos cluster cluster permissions permission[] Network filter enables to filter packets send to/from the VM's nic according to defined rules. There are several types of network filters supported based on libvirt. More details about the different network filters can be found https://libvirt.org/firewall.html[here]. In addition to libvirt's network filters, there are two additional network filters: The first called `vdsm-no-mac-spoofing`, composed of no-mac-spoofing and no-arp-mac-spoofing. The second called `ovirt-no-filter` is used when no network filter is to be defined for the VM's nic. `ovirt-no-filter` network filter is only used for internal implementation, and doesn't exist on the nics. This is a example of the XML representation: [source,xml] ---- <network_filter id="00000019-0019-0019-0019-00000000026c"> <name>example-filter</name> <version> <major>4</major> <minor>0</minor> <build>-1</build> <revision>-1</revision> </version> </network_filter> ---- If any part of the version is not present, it is represented by -1. <div class="paragraph"> <p>Network filter enables to filter packets send to/from the VM&#8217;s nic according to defined rules.</p> </div> <div class="paragraph"> <p>There are several types of network filters supported based on libvirt. More details about the different network filters can be found <a href="https://libvirt.org/firewall.html">here</a>.</p> </div> <div class="paragraph"> <p>In addition to libvirt&#8217;s network filters, there are two additional network filters: The first called <code>vdsm-no-mac-spoofing</code>, composed of no-mac-spoofing and no-arp-mac-spoofing. The second called <code>ovirt-no-filter</code> is used when no network filter is to be defined for the VM&#8217;s nic. <code>ovirt-no-filter</code> network filter is only used for internal implementation, and doesn&#8217;t exist on the nics.</p> </div> <div class="paragraph"> <p>This is a example of the XML representation:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-xml" data-lang="xml">&lt;network_filter id="00000019-0019-0019-0019-00000000026c"&gt; &lt;name&gt;example-filter&lt;/name&gt; &lt;version&gt; &lt;major&gt;4&lt;/major&gt; &lt;minor&gt;0&lt;/minor&gt; &lt;build&gt;-1&lt;/build&gt; &lt;revision&gt;-1&lt;/revision&gt; &lt;/version&gt; &lt;/network_filter&gt;</code></pre> </div> </div> <div class="paragraph"> <p>If any part of the version is not present, it is represented by -1.</p> </div> network_filter Represent the minimal supported version of the specific NetworkFilter for which it was first introduced. <div class="paragraph"> <p>Represent the minimal supported version of the specific NetworkFilter for which it was first introduced.</p> </div> version version id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string reported_device_type network instance_type status vm vm version template_version type The virtual machine's memory, in bytes. For example, in order to update a virtual machine to contain 1 GiB of memory send a request like this: [source] ---- PUT /ovirt-engine/api/vms/123 ---- With a request body like this: [source,xml] ---- <vm> <memory>1073741824</memory> </vm> ---- NOTE: Memory in the previous example is converted to bytes using the following formula: + 1 GiB = 2^30^ bytes = 1073741824 bytes. NOTE: Memory hot plug is supported from oVirt 3.6 onwards. You can use the example above to increase memory while the virtual machine is running. <div class="paragraph"> <p>The virtual machine&#8217;s memory, in bytes.</p> </div> <div class="paragraph"> <p>For example, in order to update a virtual machine to contain 1 GiB of memory send a request like this:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code>PUT /ovirt-engine/api/vms/123</code></pre> </div> </div> <div class="paragraph"> <p>With a request body like this:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-xml" data-lang="xml">&lt;vm&gt; &lt;memory&gt;1073741824&lt;/memory&gt; &lt;/vm&gt;</code></pre> </div> </div> <div class="admonitionblock note"> <table> <tr> <td class="icon"> <div class="title">Note</div> </td> <td class="content"> Memory in the previous example is converted to bytes using the following formula:<br> 1 GiB = 2<sup>30</sup> bytes = 1073741824 bytes. </td> </tr> </table> </div> <div class="admonitionblock note"> <table> <tr> <td class="icon"> <div class="title">Note</div> </td> <td class="content"> Memory hot plug is supported from oVirt 3.6 onwards. You can use the example above to increase memory while the virtual machine is running. </td> </tr> </table> </div> author value Yanir Quinn <yquinn@redhat.com> date value 14 Sep 2016 status value added memory integer The configuration of the CPU of the virtual machine. The sockets configuration can be updated without rebooting the virtual machine. The cores and the threads require a reboot in order to take place. For example, to change the number of sockets to 4 immediately and the number of cores and threads to 2 after reboot send a request: [source] ---- PUT /ovirt-engine/api/vms/123 ---- With a request body: [source,xml] ---- <vm> <cpu> <topology> <sockets>4</sockets> <cores>2</cores> <threads>2</threads> </topology> </cpu> </vm> ---- <div class="paragraph"> <p>The configuration of the CPU of the virtual machine.</p> </div> <div class="paragraph"> <p>The sockets configuration can be updated without rebooting the virtual machine. The cores and the threads require a reboot in order to take place.</p> </div> <div class="paragraph"> <p>For example, to change the number of sockets to 4 immediately and the number of cores and threads to 2 after reboot send a request:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code>PUT /ovirt-engine/api/vms/123</code></pre> </div> </div> <div class="paragraph"> <p>With a request body:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-xml" data-lang="xml">&lt;vm&gt; &lt;cpu&gt; &lt;topology&gt; &lt;sockets&gt;4&lt;/sockets&gt; &lt;cores&gt;2&lt;/cores&gt; &lt;threads&gt;2&lt;/threads&gt; &lt;/topology&gt; &lt;/cpu&gt; &lt;/vm&gt;</code></pre> </div> </div> author value Jenny Tokar <jtokar@redhat.com> date value 14 Sep 2016 status value added cpu cpu cpu_shares integer bios bios os operating_system creation_time date origin string stateless boolean delete_protected boolean high_availability high_availability display display sso sso rng_device rng_device console console domain domain usb usb soundcard_enabled boolean tunnel_migration boolean migration_downtime integer virtio_scsi virtio_scsi serial_number serial_number start_paused boolean migration migration_options io io custom_properties custom_property[] custom_emulated_machine string custom_cpu_model string time_zone time_zone small_icon icon large_icon icon initialization initialization memory_policy memory_policy Virtual machine custom compatibility version. This field allows to customize a virtual machine to its own compatibility version. If `custom_compatibility_version` is set, it overrides the cluster's compatibility version for this particular virtual machine. The compatibility version of a virtual machine is limited by the data center the virtual machine resides in and is checked against capabilities of the host the virtual machine is planned to run on. <div class="paragraph"> <p>Virtual machine custom compatibility version.</p> </div> <div class="paragraph"> <p>This field allows to customize a virtual machine to its own compatibility version. If <code>custom_compatibility_version</code> is set, it overrides the cluster&#8217;s compatibility version for this particular virtual machine.</p> </div> <div class="paragraph"> <p>The compatibility version of a virtual machine is limited by the data center the virtual machine resides in and is checked against capabilities of the host the virtual machine is planned to run on.</p> </div> custom_compatibility_version version id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string cluster cluster storage_domain storage_domain cpu_profile cpu_profile quota quota cdroms cdrom[] graphics_consoles graphics_console[] nics nic[] permissions permission[] tags tag[] watchdogs watchdog[] References to the disks attached to the template. <div class="paragraph"> <p>References to the disks attached to the template.</p> </div> disk_attachments disk_attachment[] ssh_authentication_method password publickey storage_domain_type data iso export image volume hook_status enabled disabled missing nic_status down up disk_profile id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string qos qos storage_domain storage_domain permissions permission[] storage_domain_status active inactive locked mixed unattached maintenance preparing_for_maintenance detaching activating unknown Enum representing boolean value that can be either set or inherited from higher level. Usual inheritance order is VM -> Cluster -> engine-config. <div class="paragraph"> <p>Enum representing boolean value that can be either set or inherited from higher level. Usual inheritance order is VM &#8594; Cluster &#8594; engine-config.</p> </div> inheritable_boolean Set value to true on this level. <div class="paragraph"> <p>Set value to true on this level.</p> </div> true Set value to false on this level. <div class="paragraph"> <p>Set value to false on this level.</p> </div> false Inherit value from higher level. <div class="paragraph"> <p>Inherit value from higher level.</p> </div> inherit gluster_brick_memory_info memory_pools gluster_memory_pool[] open_stack_volume_provider tenant_name string url string requires_authentication boolean username string password string authentication_url string properties property[] id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string data_center data_center certificates certificate[] volume_types open_stack_volume_type[] authentication_keys openstack_volume_authentication_key[] quota_mode_type enabled disabled audit disk_status illegal locked ok power_management_status Host is ON. <div class="paragraph"> <p>Host is ON.</p> </div> author value Tomas Jelinek <tjelinek@redhat.com> date value 14 Sep 2016 status value added on Host is OFF. <div class="paragraph"> <p>Host is OFF.</p> </div> author value Tomas Jelinek <tjelinek@redhat.com> date value 14 Sep 2016 status value added off Unknown status. <div class="paragraph"> <p>Unknown status.</p> </div> author value Tomas Jelinek <tjelinek@redhat.com> date value 14 Sep 2016 status value added unknown template status vm vm version template_version type The virtual machine's memory, in bytes. For example, in order to update a virtual machine to contain 1 GiB of memory send a request like this: [source] ---- PUT /ovirt-engine/api/vms/123 ---- With a request body like this: [source,xml] ---- <vm> <memory>1073741824</memory> </vm> ---- NOTE: Memory in the previous example is converted to bytes using the following formula: + 1 GiB = 2^30^ bytes = 1073741824 bytes. NOTE: Memory hot plug is supported from oVirt 3.6 onwards. You can use the example above to increase memory while the virtual machine is running. <div class="paragraph"> <p>The virtual machine&#8217;s memory, in bytes.</p> </div> <div class="paragraph"> <p>For example, in order to update a virtual machine to contain 1 GiB of memory send a request like this:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code>PUT /ovirt-engine/api/vms/123</code></pre> </div> </div> <div class="paragraph"> <p>With a request body like this:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-xml" data-lang="xml">&lt;vm&gt; &lt;memory&gt;1073741824&lt;/memory&gt; &lt;/vm&gt;</code></pre> </div> </div> <div class="admonitionblock note"> <table> <tr> <td class="icon"> <div class="title">Note</div> </td> <td class="content"> Memory in the previous example is converted to bytes using the following formula:<br> 1 GiB = 2<sup>30</sup> bytes = 1073741824 bytes. </td> </tr> </table> </div> <div class="admonitionblock note"> <table> <tr> <td class="icon"> <div class="title">Note</div> </td> <td class="content"> Memory hot plug is supported from oVirt 3.6 onwards. You can use the example above to increase memory while the virtual machine is running. </td> </tr> </table> </div> author value Yanir Quinn <yquinn@redhat.com> date value 14 Sep 2016 status value added memory integer The configuration of the CPU of the virtual machine. The sockets configuration can be updated without rebooting the virtual machine. The cores and the threads require a reboot in order to take place. For example, to change the number of sockets to 4 immediately and the number of cores and threads to 2 after reboot send a request: [source] ---- PUT /ovirt-engine/api/vms/123 ---- With a request body: [source,xml] ---- <vm> <cpu> <topology> <sockets>4</sockets> <cores>2</cores> <threads>2</threads> </topology> </cpu> </vm> ---- <div class="paragraph"> <p>The configuration of the CPU of the virtual machine.</p> </div> <div class="paragraph"> <p>The sockets configuration can be updated without rebooting the virtual machine. The cores and the threads require a reboot in order to take place.</p> </div> <div class="paragraph"> <p>For example, to change the number of sockets to 4 immediately and the number of cores and threads to 2 after reboot send a request:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code>PUT /ovirt-engine/api/vms/123</code></pre> </div> </div> <div class="paragraph"> <p>With a request body:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-xml" data-lang="xml">&lt;vm&gt; &lt;cpu&gt; &lt;topology&gt; &lt;sockets&gt;4&lt;/sockets&gt; &lt;cores&gt;2&lt;/cores&gt; &lt;threads&gt;2&lt;/threads&gt; &lt;/topology&gt; &lt;/cpu&gt; &lt;/vm&gt;</code></pre> </div> </div> author value Jenny Tokar <jtokar@redhat.com> date value 14 Sep 2016 status value added cpu cpu cpu_shares integer bios bios os operating_system creation_time date origin string stateless boolean delete_protected boolean high_availability high_availability display display sso sso rng_device rng_device console console domain domain usb usb soundcard_enabled boolean tunnel_migration boolean migration_downtime integer virtio_scsi virtio_scsi serial_number serial_number start_paused boolean migration migration_options io io custom_properties custom_property[] custom_emulated_machine string custom_cpu_model string time_zone time_zone small_icon icon large_icon icon initialization initialization memory_policy memory_policy Virtual machine custom compatibility version. This field allows to customize a virtual machine to its own compatibility version. If `custom_compatibility_version` is set, it overrides the cluster's compatibility version for this particular virtual machine. The compatibility version of a virtual machine is limited by the data center the virtual machine resides in and is checked against capabilities of the host the virtual machine is planned to run on. <div class="paragraph"> <p>Virtual machine custom compatibility version.</p> </div> <div class="paragraph"> <p>This field allows to customize a virtual machine to its own compatibility version. If <code>custom_compatibility_version</code> is set, it overrides the cluster&#8217;s compatibility version for this particular virtual machine.</p> </div> <div class="paragraph"> <p>The compatibility version of a virtual machine is limited by the data center the virtual machine resides in and is checked against capabilities of the host the virtual machine is planned to run on.</p> </div> custom_compatibility_version version id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string cluster cluster storage_domain storage_domain cpu_profile cpu_profile quota quota cdroms cdrom[] graphics_consoles graphics_console[] nics nic[] permissions permission[] tags tag[] watchdogs watchdog[] References to the disks attached to the template. <div class="paragraph"> <p>References to the disks attached to the template.</p> </div> disk_attachments disk_attachment[] external_discovered_host ip string mac string subnet_name string last_report string id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string external_host_provider external_host_provider qos_type storage cpu network hostnetwork katello_erratum title string type string issued date severity string solution string summary string packages package[] id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string host host vm vm scheduling_policy_unit type internal boolean enabled boolean properties property[] id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string os_type unassigned windows_xp windows_2003 windows_2008 other_linux other rhel_5 rhel_4 rhel_3 windows_2003x64 windows_7 windows_7x64 rhel_5x64 rhel_4x64 rhel_3x64 windows_2008x64 windows_2008r2x64 rhel_6 rhel_6x64 windows_8 windows_8x64 windows_2012x64 statistic_kind counter gauge external_system_type vdsm gluster dns servers host[] search_domains host[] hosted_engine configured boolean active boolean score integer global_maintenance boolean local_maintenance boolean gluster_volume_type distribute replicate distributed_replicate stripe distributed_stripe striped_replicate distributed_striped_replicate disperse distributed_disperse This type contains information about the product, including its name, the name of the vendor, and the version. <div class="paragraph"> <p>This type contains information about the product, including its name, the name of the vendor, and the version.</p> </div> product_info The name of the product, for example `oVirt Engine`. <div class="paragraph"> <p>The name of the product, for example <code>oVirt Engine</code>.</p> </div> name string The name of the vendor, for example `ovirt.org`. <div class="paragraph"> <p>The name of the vendor, for example <code>ovirt.org</code>.</p> </div> vendor string The version number of the product. <div class="paragraph"> <p>The version number of the product.</p> </div> version version value datum decimal detail string storage_format v1 v2 v3 file content string type string id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string storage_domain storage_domain product id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string io threads integer Describes user session to a virtual machine. <div class="paragraph"> <p>Describes user session to a virtual machine.</p> </div> author value Jakub Niedermertl <jniederm@redhat.com> date value 14 Sep 2016 status value added session Protocol used by the session. Currently not used, intended for info about how is user connected: SPICE, VNC, SSH, RDP. <div class="paragraph"> <p>Protocol used by the session.</p> </div> <div class="paragraph"> <p>Currently not used, intended for info about how is user connected: SPICE, VNC, SSH, RDP.</p> </div> author value Jakub Niedermertl <jniederm@redhat.com> date value 14 Sep 2016 status value added protocol string IP address user is connected from. Currently only available for console users. <div class="paragraph"> <p>IP address user is connected from.</p> </div> <div class="paragraph"> <p>Currently only available for console users.</p> </div> author value Jakub Niedermertl <jniederm@redhat.com> date value 14 Sep 2016 status value added ip ip Indicates if this is a console session. The value will be `true` for console users: SPICE or VNC, `false` for others: e.g. RDP, SSH. <div class="paragraph"> <p>Indicates if this is a console session.</p> </div> <div class="paragraph"> <p>The value will be <code>true</code> for console users: SPICE or VNC, <code>false</code> for others: e.g. RDP, SSH.</p> </div> author value Jakub Niedermertl <jniederm@redhat.com> date value 14 Sep 2016 status value added console_user boolean id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string User related to this session. If user is a console user, it is a link to real oVirt user. Otherwise only username is provided. <div class="paragraph"> <p>User related to this session.</p> </div> <div class="paragraph"> <p>If user is a console user, it is a link to real oVirt user. Otherwise only username is provided.</p> </div> author value Jakub Niedermertl <jniederm@redhat.com> date value 14 Sep 2016 status value added user user Link to virtual machine related to this session. <div class="paragraph"> <p>Link to virtual machine related to this session.</p> </div> author value Jakub Niedermertl <jniederm@redhat.com> date value 14 Sep 2016 status value added vm vm sso_method guest_agent vm_base type The virtual machine's memory, in bytes. For example, in order to update a virtual machine to contain 1 GiB of memory send a request like this: [source] ---- PUT /ovirt-engine/api/vms/123 ---- With a request body like this: [source,xml] ---- <vm> <memory>1073741824</memory> </vm> ---- NOTE: Memory in the previous example is converted to bytes using the following formula: + 1 GiB = 2^30^ bytes = 1073741824 bytes. NOTE: Memory hot plug is supported from oVirt 3.6 onwards. You can use the example above to increase memory while the virtual machine is running. <div class="paragraph"> <p>The virtual machine&#8217;s memory, in bytes.</p> </div> <div class="paragraph"> <p>For example, in order to update a virtual machine to contain 1 GiB of memory send a request like this:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code>PUT /ovirt-engine/api/vms/123</code></pre> </div> </div> <div class="paragraph"> <p>With a request body like this:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-xml" data-lang="xml">&lt;vm&gt; &lt;memory&gt;1073741824&lt;/memory&gt; &lt;/vm&gt;</code></pre> </div> </div> <div class="admonitionblock note"> <table> <tr> <td class="icon"> <div class="title">Note</div> </td> <td class="content"> Memory in the previous example is converted to bytes using the following formula:<br> 1 GiB = 2<sup>30</sup> bytes = 1073741824 bytes. </td> </tr> </table> </div> <div class="admonitionblock note"> <table> <tr> <td class="icon"> <div class="title">Note</div> </td> <td class="content"> Memory hot plug is supported from oVirt 3.6 onwards. You can use the example above to increase memory while the virtual machine is running. </td> </tr> </table> </div> author value Yanir Quinn <yquinn@redhat.com> date value 14 Sep 2016 status value added memory integer The configuration of the CPU of the virtual machine. The sockets configuration can be updated without rebooting the virtual machine. The cores and the threads require a reboot in order to take place. For example, to change the number of sockets to 4 immediately and the number of cores and threads to 2 after reboot send a request: [source] ---- PUT /ovirt-engine/api/vms/123 ---- With a request body: [source,xml] ---- <vm> <cpu> <topology> <sockets>4</sockets> <cores>2</cores> <threads>2</threads> </topology> </cpu> </vm> ---- <div class="paragraph"> <p>The configuration of the CPU of the virtual machine.</p> </div> <div class="paragraph"> <p>The sockets configuration can be updated without rebooting the virtual machine. The cores and the threads require a reboot in order to take place.</p> </div> <div class="paragraph"> <p>For example, to change the number of sockets to 4 immediately and the number of cores and threads to 2 after reboot send a request:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code>PUT /ovirt-engine/api/vms/123</code></pre> </div> </div> <div class="paragraph"> <p>With a request body:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-xml" data-lang="xml">&lt;vm&gt; &lt;cpu&gt; &lt;topology&gt; &lt;sockets&gt;4&lt;/sockets&gt; &lt;cores&gt;2&lt;/cores&gt; &lt;threads&gt;2&lt;/threads&gt; &lt;/topology&gt; &lt;/cpu&gt; &lt;/vm&gt;</code></pre> </div> </div> author value Jenny Tokar <jtokar@redhat.com> date value 14 Sep 2016 status value added cpu cpu cpu_shares integer bios bios os operating_system creation_time date origin string stateless boolean delete_protected boolean high_availability high_availability display display sso sso rng_device rng_device console console domain domain usb usb soundcard_enabled boolean tunnel_migration boolean migration_downtime integer virtio_scsi virtio_scsi serial_number serial_number start_paused boolean migration migration_options io io custom_properties custom_property[] custom_emulated_machine string custom_cpu_model string time_zone time_zone small_icon icon large_icon icon initialization initialization memory_policy memory_policy Virtual machine custom compatibility version. This field allows to customize a virtual machine to its own compatibility version. If `custom_compatibility_version` is set, it overrides the cluster's compatibility version for this particular virtual machine. The compatibility version of a virtual machine is limited by the data center the virtual machine resides in and is checked against capabilities of the host the virtual machine is planned to run on. <div class="paragraph"> <p>Virtual machine custom compatibility version.</p> </div> <div class="paragraph"> <p>This field allows to customize a virtual machine to its own compatibility version. If <code>custom_compatibility_version</code> is set, it overrides the cluster&#8217;s compatibility version for this particular virtual machine.</p> </div> <div class="paragraph"> <p>The compatibility version of a virtual machine is limited by the data center the virtual machine resides in and is checked against capabilities of the host the virtual machine is planned to run on.</p> </div> custom_compatibility_version version id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string cluster cluster storage_domain storage_domain cpu_profile cpu_profile quota quota profile_detail profile_type string duration integer statistics statistic[] block_statistics block_statistic[] fop_statistics fop_statistic[] guest_operating_system architecture string codename string distribution string kernel kernel family string version version vm_summary active integer migrating integer total integer initialization configuration configuration cloud_init cloud_init host_name string domain string timezone string authorized_ssh_keys string regenerate_ssh_keys boolean regenerate_ids boolean dns_servers string dns_search string nic_configurations nic_configuration[] windows_license_key string root_password string custom_script string input_locale string ui_language string system_locale string user_locale string user_name string active_directory_ou string org_name string Describes the capabilities supported by a specific cluster level. <div class="paragraph"> <p>Describes the capabilities supported by a specific cluster level.</p> </div> author value Byron Gravenorst <bgraveno@redhat.com> date value 3 Nov 2016 status value updated_by_docs cluster_level The CPU types supported by this cluster level. <div class="paragraph"> <p>The CPU types supported by this cluster level.</p> </div> author value Byron Gravenorst <bgraveno@redhat.com> date value 3 Nov 2016 status value updated_by_docs cpu_types cpu_type[] The permits supported by this cluster level. <div class="paragraph"> <p>The permits supported by this cluster level.</p> </div> author value Juan Hernandez <juan.hernandez@redhat.com> Byron Gravenorst <bgraveno@redhat.com> date value 3 Nov 2016 status value updated_by_docs permits permit[] id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string fencing_policy enabled boolean skip_if_sd_active skip_if_sd_active skip_if_connectivity_broken skip_if_connectivity_broken Describes a supported CPU type. <div class="paragraph"> <p>Describes a supported CPU type.</p> </div> author value Byron Gravenorst <bgraveno@redhat.com> date value 28 Oct 2016 status value updated_by_docs cpu_type The name of the CPU type, for example `Intel Conroe Family`. <div class="paragraph"> <p>The name of the CPU type, for example <code>Intel Conroe Family</code>.</p> </div> author value Byron Gravenorst <bgraveno@redhat.com> date value 28 Oct 2016 status value updated_by_docs name string The level of the CPU type. <div class="paragraph"> <p>The level of the CPU type.</p> </div> author value Byron Gravenorst <bgraveno@redhat.com> date value 28 Oct 2016 status value updated_by_docs level integer The architecture of the CPU. <div class="paragraph"> <p>The architecture of the CPU.</p> </div> author value Byron Gravenorst <bgraveno@redhat.com> date value 28 Oct 2016 status value updated_by_docs architecture boot devices [] This type contains an item of the API summary. Each item contains the total and active number of some kind of object. <div class="paragraph"> <p>This type contains an item of the API summary. Each item contains the total and active number of some kind of object.</p> </div> api_summary_item The total number of objects. <div class="paragraph"> <p>The total number of objects.</p> </div> total integer The total number of active objects. <div class="paragraph"> <p>The total number of active objects.</p> </div> active integer power_management Indicates whether power management configuration is enabled or disabled. <div class="paragraph"> <p>Indicates whether power management configuration is enabled or disabled.</p> </div> author value Tomas Jelinek <tjelinek@redhat.com> date value 14 Sep 2016 status value added enabled boolean The host name or IP address of the host. <div class="paragraph"> <p>The host name or IP address of the host.</p> </div> author value Tomas Jelinek <tjelinek@redhat.com> date value 14 Sep 2016 status value added address string A valid user name for power management. <div class="paragraph"> <p>A valid user name for power management.</p> </div> author value Tomas Jelinek <tjelinek@redhat.com> date value 14 Sep 2016 status value added username string A valid, robust password for power management. <div class="paragraph"> <p>A valid, robust password for power management.</p> </div> author value Tomas Jelinek <tjelinek@redhat.com> date value 14 Sep 2016 status value added password string Fencing options for the selected type= specified with the option name="" and value="" strings. <div class="paragraph"> <p>Fencing options for the selected type= specified with the option name="" and value="" strings.</p> </div> author value Tomas Jelinek <tjelinek@redhat.com> date value 14 Sep 2016 status value added options option[] Determines the power status of the host. <div class="paragraph"> <p>Determines the power status of the host.</p> </div> author value Tomas Jelinek <tjelinek@redhat.com> date value 14 Sep 2016 status value added status Determines the power management proxy. <div class="paragraph"> <p>Determines the power management proxy.</p> </div> author value Tomas Jelinek <tjelinek@redhat.com> date value 14 Sep 2016 status value added pm_proxies pm_proxy[] Specifies fence agent options when multiple fences are used. Use the order sub-element to prioritize the fence agents. Agents are run sequentially according to their order until the fence action succeeds. When two or more fence agents have the same order, they are run concurrently. Other sub-elements include type, ip, user, password, and options. <div class="paragraph"> <p>Specifies fence agent options when multiple fences are used.</p> </div> <div class="paragraph"> <p>Use the order sub-element to prioritize the fence agents. Agents are run sequentially according to their order until the fence action succeeds. When two or more fence agents have the same order, they are run concurrently. Other sub-elements include type, ip, user, password, and options.</p> </div> author value Tomas Jelinek <tjelinek@redhat.com> date value 14 Sep 2016 status value added agents agent[] Toggles the automated power control of the host in order to save energy. When set to true, the host will be automatically powered down if the cluster's load is low, and powered on again when required. This is set to true when a host is created, unless disabled by the user. <div class="paragraph"> <p>Toggles the automated power control of the host in order to save energy. When set to true, the host will be automatically powered down if the cluster&#8217;s load is low, and powered on again when required. This is set to true when a host is created, unless disabled by the user.</p> </div> author value Tomas Jelinek <tjelinek@redhat.com> date value 14 Sep 2016 status value added automatic_pm_enabled boolean Toggles whether to determine if kdump is running on the host before it is shut down. When set to `true`, the host will not shut down during a kdump process. This is set to `true` when a host has power management enabled, unless disabled by the user. <div class="paragraph"> <p>Toggles whether to determine if kdump is running on the host before it is shut down. When set to <code>true</code>, the host will not shut down during a kdump process. This is set to <code>true</code> when a host has power management enabled, unless disabled by the user.</p> </div> author value Tomas Jelinek <tjelinek@redhat.com> date value 14 Sep 2016 status value added kdump_detection boolean Fencing device code. A list of valid fencing device codes are available in the `capabilities` collection. <div class="paragraph"> <p>Fencing device code.</p> </div> <div class="paragraph"> <p>A list of valid fencing device codes are available in the <code>capabilities</code> collection.</p> </div> author value Tomas Jelinek <tjelinek@redhat.com> date value 14 Sep 2016 status value added type string custom_property name string value string regexp string pm_proxy type Represents a virtual disk device. <div class="paragraph"> <p>Represents a virtual disk device.</p> </div> author value Juan Hernandez <juan.hernandez@redhat.com> date value 4 Nov 2016 status value added disk alias string image_id string The virtual size of the disk, in bytes. This attribute is mandatory when creating a new disk. <div class="paragraph"> <p>The virtual size of the disk, in bytes.</p> </div> <div class="paragraph"> <p>This attribute is mandatory when creating a new disk.</p> </div> author value Juan Hernandez <juan.hernandez@redhat.com> date value 4 Nov 2016 status value added provisioned_size integer The actual size of the disk, in bytes. The actual size is the number of bytes actually used by the disk, and it will be smaller than the provisioned size for disks that use the `cow` format. <div class="paragraph"> <p>The actual size of the disk, in bytes.</p> </div> <div class="paragraph"> <p>The actual size is the number of bytes actually used by the disk, and it will be smaller than the provisioned size for disks that use the <code>cow</code> format.</p> </div> author value Juan Hernandez <juan.hernandez@redhat.com> date value 4 Nov 2016 status value added actual_size integer The status of the disk device. <div class="paragraph"> <p>The status of the disk device.</p> </div> author value Juan Hernandez <juan.hernandez@redhat.com> date value 4 Nov 2016 status value added status The type of interface driver used to connect the disk device to the virtual machine. IMPORTANT: This attribute only makes sense for disks that are actually connected to virtual machines, and in version 4 of the API it has been moved to the <<types/disk_attachment, DiskAttachment>> type. It is preserved here only for backwards compatibility, and it will be removed in the future. <div class="paragraph"> <p>The type of interface driver used to connect the disk device to the virtual machine.</p> </div> <div class="admonitionblock important"> <table> <tr> <td class="icon"> <div class="title">Important</div> </td> <td class="content"> This attribute only makes sense for disks that are actually connected to virtual machines, and in version 4 of the API it has been moved to the <a href="#types/disk_attachment">DiskAttachment</a> type. It is preserved here only for backwards compatibility, and it will be removed in the future. </td> </tr> </table> </div> deprecated author value Juan Hernandez <juan.hernandez@redhat.com> date value 4 Nov 2016 status value added interface The underlying storage format. <div class="paragraph"> <p>The underlying storage format.</p> </div> author value Juan Hernandez <juan.hernandez@redhat.com> date value 4 Nov 2016 status value added format Indicates if the physical storage for the disk should not be preallocated. <div class="paragraph"> <p>Indicates if the physical storage for the disk should not be preallocated.</p> </div> author value Juan Hernandez <juan.hernandez@redhat.com> date value 4 Nov 2016 status value added sparse boolean Indicates if the disk is marked as bootable. IMPORTANT: This attribute only makes sense for disks that are actually connected to virtual machines, and in version 4 of the API it has been moved to the <<types/disk_attachment, DiskAttachment>> type. It is preserved here only for backwards compatibility, and it will be removed in the future. <div class="paragraph"> <p>Indicates if the disk is marked as bootable.</p> </div> <div class="admonitionblock important"> <table> <tr> <td class="icon"> <div class="title">Important</div> </td> <td class="content"> This attribute only makes sense for disks that are actually connected to virtual machines, and in version 4 of the API it has been moved to the <a href="#types/disk_attachment">DiskAttachment</a> type. It is preserved here only for backwards compatibility, and it will be removed in the future. </td> </tr> </table> </div> deprecated author value Juan Hernandez <juan.hernandez@redhat.com> date value 4 Nov 2016 status value added bootable boolean Indicates if the disk can be attached to multiple virtual machines. IMPORTANT: When a disk is attached to multiple virtual machines it is the responsibility of the guest operating systems of those virtual machines to coordinate access to it, to avoid corruption of the data, for example using a shared file system like https://www.gluster.org[GlusterFS] or http://www.sourceware.org/cluster/gfs[GFS]. <div class="paragraph"> <p>Indicates if the disk can be attached to multiple virtual machines.</p> </div> <div class="admonitionblock important"> <table> <tr> <td class="icon"> <div class="title">Important</div> </td> <td class="content"> When a disk is attached to multiple virtual machines it is the responsibility of the guest operating systems of those virtual machines to coordinate access to it, to avoid corruption of the data, for example using a shared file system like <a href="https://www.gluster.org">GlusterFS</a> or <a href="http://www.sourceware.org/cluster/gfs">GFS</a>. </td> </tr> </table> </div> author value Juan Hernandez <juan.hernandez@redhat.com> date value 4 Nov 2016 status value added shareable boolean Indicates if the disk's blocks will be read back as zeros after it is deleted: - On block storage, the disk will be zeroed and only then deleted. - On file storage, since the file system already guarantees that previously removed blocks are read back as zeros, the disk will be deleted immediately. <div class="paragraph"> <p>Indicates if the disk&#8217;s blocks will be read back as zeros after it is deleted:</p> </div> <div class="ulist"> <ul> <li> <p>On block storage, the disk will be zeroed and only then deleted.</p> </li> <li> <p>On file storage, since the file system already guarantees that previously removed blocks are read back as zeros, the disk will be deleted immediately.</p> </li> </ul> </div> author value Idan Shaby <ishaby@redhat.com> date value 6 Nov 2016 status value added wipe_after_delete boolean Indicates if disk errors should not cause virtual machine to be paused and, instead, disk errors should be propagated to the the guest operating system. <div class="paragraph"> <p>Indicates if disk errors should not cause virtual machine to be paused and, instead, disk errors should be propagated to the the guest operating system.</p> </div> author value Juan Hernandez <juan.hernandez@redhat.com> date value 4 Nov 2016 status value added propagate_errors boolean Indicates if the disk is visible to the virtual machine. IMPORTANT: When adding a disk attachment to a virtual machine, the server accepts requests that don't contain this attribute, but the effect is then undefined. In some cases the disk will be automatically activated and in other cases it won't. To avoid issues it is strongly recommended to always include the this attribute with the desired value. <div class="paragraph"> <p>Indicates if the disk is visible to the virtual machine.</p> </div> <div class="admonitionblock important"> <table> <tr> <td class="icon"> <div class="title">Important</div> </td> <td class="content"> When adding a disk attachment to a virtual machine, the server accepts requests that don&#8217;t contain this attribute, but the effect is then undefined. In some cases the disk will be automatically activated and in other cases it won&#8217;t. To avoid issues it is strongly recommended to always include the this attribute with the desired value. </td> </tr> </table> </div> author value Juan Hernandez <juan.hernandez@redhat.com> date value 9 Nov 2016 status value added active boolean Indicates if the disk is in read-only mode. <div class="paragraph"> <p>Indicates if the disk is in read-only mode.</p> </div> author value Juan Hernandez <juan.hernandez@redhat.com> date value 4 Nov 2016 status value added read_only boolean lun_storage host_storage sgio uses_scsi_reservation boolean storage_type logical_name string id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string template template instance_type instance_type References to the virtual machines that are using this device. A device may be used by several virtual machines; for example, a shared disk my be used simultaneously by two or more virtual machines. <div class="paragraph"> <p>References to the virtual machines that are using this device. A device may be used by several virtual machines; for example, a shared disk my be used simultaneously by two or more virtual machines.</p> </div> author value Byron Gravenorst <bgraveno@redhat.com> date value 31 Oct 2016 status value updated_by_docs vms vm[] Don't use this element, use `vms` instead. <div class="paragraph"> <p>Don&#8217;t use this element, use <code>vms</code> instead.</p> </div> deprecated author value Byron Gravenorst <bgraveno@redhat.com> date value 31 Oct 2016 status value updated_by_docs vm vm storage_domain storage_domain The storage domains associated with this disk. NOTE: Only required when the first disk is being added to a virtual machine that was not itself created from a template. <div class="paragraph"> <p>The storage domains associated with this disk.</p> </div> <div class="admonitionblock note"> <table> <tr> <td class="icon"> <div class="title">Note</div> </td> <td class="content"> Only required when the first disk is being added to a virtual machine that was not itself created from a template. </td> </tr> </table> </div> author value Juan Hernandez <juan.hernandez@redhat.com> date value 4 Nov 2016 status value added storage_domains storage_domain[] quota quota disk_profile disk_profile snapshot snapshot openstack_volume_type open_stack_volume_type permissions permission[] statistics statistic[] certificate organization string subject string content string id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string vlan id integer nfs_version auto v3 v4 v4_1 version major integer minor integer build integer revision integer full_version string id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string mac address string vm_placement_policy affinity hosts host[] host_storage address string type path string mount_options string vfs_type string nfs_version The time in tenths of a second to wait for a response before retrying NFS requests. The value must be in the range of 0 to 65535. For more details see the description of the `timeo` mount option in the `nfs` man page. <div class="paragraph"> <p>The time in tenths of a second to wait for a response before retrying NFS requests. The value must be in the range of 0 to 65535. For more details see the description of the <code>timeo</code> mount option in the <code>nfs</code> man page.</p> </div> author value Juan Hernandez <juan.hernandez@redhat.com> Tahlia Richardson <trichard@redhat.com> date value 31 Oct 2016 status value updated_by_docs nfs_timeo integer The number of times to retry a request before attempting further recovery actions. The value must be in the range of 0 to 65535. For more details see the description of the `retrans` mount option in the `nfs` man page. <div class="paragraph"> <p>The number of times to retry a request before attempting further recovery actions. The value must be in the range of 0 to 65535. For more details see the description of the <code>retrans</code> mount option in the <code>nfs</code> man page.</p> </div> author value Juan Hernandez <juan.hernandez@redhat.com> Tahlia Richardson <trichard@redhat.com> date value 31 Oct 2016 status value updated_by_docs nfs_retrans integer port integer target string username string password string portal string logical_units logical_unit[] volume_group volume_group override_luns boolean id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string host host proxy_ticket value string nic_configuration name string ip ip boot_protocol on_boot boolean Defines the method how the migration bandwidth is assigned. <div class="paragraph"> <p>Defines the method how the migration bandwidth is assigned.</p> </div> migration_bandwidth_assignment_method Takes the bandwidth from QoS if QoS defined. If not, taken from detected link speed being used. If nothing detected, falls back to hypervisor_default value. <div class="paragraph"> <p>Takes the bandwidth from QoS if QoS defined. If not, taken from detected link speed being used. If nothing detected, falls back to hypervisor_default value.</p> </div> auto Custom defined bandwidth in Mbit/s. <div class="paragraph"> <p>Custom defined bandwidth in Mbit/s.</p> </div> custom Takes the value as configured on the hypervisor. <div class="paragraph"> <p>Takes the value as configured on the hypervisor.</p> </div> hypervisor_default display type address string port integer secure_port integer monitors integer single_qxl_pci boolean allow_override boolean certificate certificate smartcard_enabled boolean keyboard_layout string proxy string file_transfer_enabled boolean copy_paste_enabled boolean disconnect_action string migrate_on_error migrate do_not_migrate migrate_highly_available bonding options option[] slaves host_nic[] The `ad_partner_mac` property of the partner bond in mode 4. Bond mode 4 is the 802.3ad standard, also called dynamic link aggregation - https://en.wikipedia.org/wiki/Link_aggregation[Wikipedia], http://www.ieee802.org/3/hssg/public/apr07/frazier_01_0407.pdf[Presentation]. `ad_partner_mac` is the MAC address of the system (switch) at the other end of a bond. This parameter is read only. Setting it will have no effect on the bond. It is retrieved from `/sys/class/net/bondX/bonding/ad_partner_mac` file on the system where the bond is located. <div class="paragraph"> <p>The <code>ad_partner_mac</code> property of the partner bond in mode 4. Bond mode 4 is the 802.3ad standard, also called dynamic link aggregation - <a href="https://en.wikipedia.org/wiki/Link_aggregation">Wikipedia</a>, <a href="http://www.ieee802.org/3/hssg/public/apr07/frazier_01_0407.pdf">Presentation</a>. <code>ad_partner_mac</code> is the MAC address of the system (switch) at the other end of a bond. This parameter is read only. Setting it will have no effect on the bond. It is retrieved from <code>/sys/class/net/bondX/bonding/ad_partner_mac</code> file on the system where the bond is located.</p> </div> author value Marcin Mirecki <mmirecki@redhat.com> date value 10 Aug 2016 status value added since value 4.0.3 ad_partner_mac mac entity_external_status ok info warning error failure block_statistic statistics statistic[] snapshot_type regular active stateless preview graphics_console protocol port integer tls_port integer address string id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string vm vm template template instance_type instance_type Represents a quota object. An example XML representation of a quota: [source,xml] ---- <quota href="/ovirt-engine/api/datacenters/7044934e/quotas/dcad5ddc" id="dcad5ddc"> <name>My Quota</name> <description>A quota for my oVirt environment</description> <cluster_hard_limit_pct>0</cluster_hard_limit_pct> <cluster_soft_limit_pct>0</cluster_soft_limit_pct> <data_center href="/ovirt-engine/api/datacenters/7044934e" id="7044934e"/> <storage_hard_limit_pct>0</storage_hard_limit_pct> <storage_soft_limit_pct>0</storage_soft_limit_pct> </quota> ---- <div class="paragraph"> <p>Represents a quota object.</p> </div> <div class="paragraph"> <p>An example XML representation of a quota:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-xml" data-lang="xml">&lt;quota href="/ovirt-engine/api/datacenters/7044934e/quotas/dcad5ddc" id="dcad5ddc"&gt; &lt;name&gt;My Quota&lt;/name&gt; &lt;description&gt;A quota for my oVirt environment&lt;/description&gt; &lt;cluster_hard_limit_pct&gt;0&lt;/cluster_hard_limit_pct&gt; &lt;cluster_soft_limit_pct&gt;0&lt;/cluster_soft_limit_pct&gt; &lt;data_center href="/ovirt-engine/api/datacenters/7044934e" id="7044934e"/&gt; &lt;storage_hard_limit_pct&gt;0&lt;/storage_hard_limit_pct&gt; &lt;storage_soft_limit_pct&gt;0&lt;/storage_soft_limit_pct&gt; &lt;/quota&gt;</code></pre> </div> </div> author value Andrej Krejcir <akrejcir@redhat.com> date value 14 Sep 2016 status value added quota data_center data_center vms vm[] disks disk[] users user[] cluster_soft_limit_pct integer cluster_hard_limit_pct integer storage_soft_limit_pct integer storage_hard_limit_pct integer id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string permissions permission[] quota_cluster_limits quota_cluster_limit[] quota_storage_limits quota_storage_limit[] role_type admin user qos type max_throughput integer max_read_throughput integer max_write_throughput integer max_iops integer max_read_iops integer max_write_iops integer cpu_limit integer inbound_average integer inbound_peak integer inbound_burst integer outbound_average integer outbound_peak integer outbound_burst integer outbound_average_linkshare integer outbound_average_upperlimit integer outbound_average_realtime integer id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string data_center data_center rate bytes integer period integer hardware_information manufacturer string version string serial_number string product_name string uuid string family string supported_rng_sources [] fop_statistic name string statistics statistic[] application id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string vm vm port_mirroring Describes type of external hypervisor system. <div class="paragraph"> <p>Describes type of external hypervisor system.</p> </div> author value Martin Betak <mbetak@redhat.com> date value 27 Jul 2016 status value added since value 4.0.4 external_vm_provider_type kvm xen vmware cdrom file file id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string template template instance_type instance_type References to the virtual machines that are using this device. A device may be used by several virtual machines; for example, a shared disk my be used simultaneously by two or more virtual machines. <div class="paragraph"> <p>References to the virtual machines that are using this device. A device may be used by several virtual machines; for example, a shared disk my be used simultaneously by two or more virtual machines.</p> </div> author value Byron Gravenorst <bgraveno@redhat.com> date value 31 Oct 2016 status value updated_by_docs vms vm[] Don't use this element, use `vms` instead. <div class="paragraph"> <p>Don&#8217;t use this element, use <code>vms</code> instead.</p> </div> deprecated author value Byron Gravenorst <bgraveno@redhat.com> date value 31 Oct 2016 status value updated_by_docs vm vm Information describing the operating system. Used for virtual machines and hosts. <div class="paragraph"> <p>Information describing the operating system. Used for virtual machines and hosts.</p> </div> operating_system type string boot boot kernel string initrd string cmdline string Host kernel command line as reported by a running host. Read-only attribute. Attempts to change this attribute are silently ignored. NOTE: This attribute is currently only used for hosts. <div class="paragraph"> <p>Host kernel command line as reported by a running host.</p> </div> <div class="paragraph"> <p>Read-only attribute. Attempts to change this attribute are silently ignored.</p> </div> <div class="admonitionblock note"> <table> <tr> <td class="icon"> <div class="title">Note</div> </td> <td class="content"> This attribute is currently only used for hosts. </td> </tr> </table> </div> reported_kernel_cmdline string A custom part of the host kernel command line. This will be merged with the existing kernel command line. You must re-install and then reboot the host to apply the changes implemented by this attribute. Parameters merging: During each host deploy procedure, kernel parameters that were added in the previous host deploy procedure are removed using `grubby --update-kernel DEFAULT --remove-args <previous_custom_params>` and the current kernel command line customization is applied using `grubby --update-kernel DEFAULT --args <custom_params>`. The Engine internally keeps track of the last applied kernel parameters customization. NOTE: This attribute is currently only used for hosts. <div class="paragraph"> <p>A custom part of the host kernel command line. This will be merged with the existing kernel command line.</p> </div> <div class="paragraph"> <p>You must re-install and then reboot the host to apply the changes implemented by this attribute.</p> </div> <div class="paragraph"> <p>Parameters merging: During each host deploy procedure, kernel parameters that were added in the previous host deploy procedure are removed using <code>grubby --update-kernel DEFAULT --remove-args &lt;previous_custom_params&gt;</code> and the current kernel command line customization is applied using <code>grubby --update-kernel DEFAULT --args &lt;custom_params&gt;</code>. The Engine internally keeps track of the last applied kernel parameters customization.</p> </div> <div class="admonitionblock note"> <table> <tr> <td class="icon"> <div class="title">Note</div> </td> <td class="content"> This attribute is currently only used for hosts. </td> </tr> </table> </div> custom_kernel_cmdline string version version openstack_volume_authentication_key_usage_type ceph hook event_name string md5 string id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string host host ticket value string expiry integer high_availability enabled boolean priority integer disk_snapshot alias string image_id string The virtual size of the disk, in bytes. This attribute is mandatory when creating a new disk. <div class="paragraph"> <p>The virtual size of the disk, in bytes.</p> </div> <div class="paragraph"> <p>This attribute is mandatory when creating a new disk.</p> </div> author value Juan Hernandez <juan.hernandez@redhat.com> date value 4 Nov 2016 status value added provisioned_size integer The actual size of the disk, in bytes. The actual size is the number of bytes actually used by the disk, and it will be smaller than the provisioned size for disks that use the `cow` format. <div class="paragraph"> <p>The actual size of the disk, in bytes.</p> </div> <div class="paragraph"> <p>The actual size is the number of bytes actually used by the disk, and it will be smaller than the provisioned size for disks that use the <code>cow</code> format.</p> </div> author value Juan Hernandez <juan.hernandez@redhat.com> date value 4 Nov 2016 status value added actual_size integer The status of the disk device. <div class="paragraph"> <p>The status of the disk device.</p> </div> author value Juan Hernandez <juan.hernandez@redhat.com> date value 4 Nov 2016 status value added status The type of interface driver used to connect the disk device to the virtual machine. IMPORTANT: This attribute only makes sense for disks that are actually connected to virtual machines, and in version 4 of the API it has been moved to the <<types/disk_attachment, DiskAttachment>> type. It is preserved here only for backwards compatibility, and it will be removed in the future. <div class="paragraph"> <p>The type of interface driver used to connect the disk device to the virtual machine.</p> </div> <div class="admonitionblock important"> <table> <tr> <td class="icon"> <div class="title">Important</div> </td> <td class="content"> This attribute only makes sense for disks that are actually connected to virtual machines, and in version 4 of the API it has been moved to the <a href="#types/disk_attachment">DiskAttachment</a> type. It is preserved here only for backwards compatibility, and it will be removed in the future. </td> </tr> </table> </div> deprecated author value Juan Hernandez <juan.hernandez@redhat.com> date value 4 Nov 2016 status value added interface The underlying storage format. <div class="paragraph"> <p>The underlying storage format.</p> </div> author value Juan Hernandez <juan.hernandez@redhat.com> date value 4 Nov 2016 status value added format Indicates if the physical storage for the disk should not be preallocated. <div class="paragraph"> <p>Indicates if the physical storage for the disk should not be preallocated.</p> </div> author value Juan Hernandez <juan.hernandez@redhat.com> date value 4 Nov 2016 status value added sparse boolean Indicates if the disk is marked as bootable. IMPORTANT: This attribute only makes sense for disks that are actually connected to virtual machines, and in version 4 of the API it has been moved to the <<types/disk_attachment, DiskAttachment>> type. It is preserved here only for backwards compatibility, and it will be removed in the future. <div class="paragraph"> <p>Indicates if the disk is marked as bootable.</p> </div> <div class="admonitionblock important"> <table> <tr> <td class="icon"> <div class="title">Important</div> </td> <td class="content"> This attribute only makes sense for disks that are actually connected to virtual machines, and in version 4 of the API it has been moved to the <a href="#types/disk_attachment">DiskAttachment</a> type. It is preserved here only for backwards compatibility, and it will be removed in the future. </td> </tr> </table> </div> deprecated author value Juan Hernandez <juan.hernandez@redhat.com> date value 4 Nov 2016 status value added bootable boolean Indicates if the disk can be attached to multiple virtual machines. IMPORTANT: When a disk is attached to multiple virtual machines it is the responsibility of the guest operating systems of those virtual machines to coordinate access to it, to avoid corruption of the data, for example using a shared file system like https://www.gluster.org[GlusterFS] or http://www.sourceware.org/cluster/gfs[GFS]. <div class="paragraph"> <p>Indicates if the disk can be attached to multiple virtual machines.</p> </div> <div class="admonitionblock important"> <table> <tr> <td class="icon"> <div class="title">Important</div> </td> <td class="content"> When a disk is attached to multiple virtual machines it is the responsibility of the guest operating systems of those virtual machines to coordinate access to it, to avoid corruption of the data, for example using a shared file system like <a href="https://www.gluster.org">GlusterFS</a> or <a href="http://www.sourceware.org/cluster/gfs">GFS</a>. </td> </tr> </table> </div> author value Juan Hernandez <juan.hernandez@redhat.com> date value 4 Nov 2016 status value added shareable boolean Indicates if the disk's blocks will be read back as zeros after it is deleted: - On block storage, the disk will be zeroed and only then deleted. - On file storage, since the file system already guarantees that previously removed blocks are read back as zeros, the disk will be deleted immediately. <div class="paragraph"> <p>Indicates if the disk&#8217;s blocks will be read back as zeros after it is deleted:</p> </div> <div class="ulist"> <ul> <li> <p>On block storage, the disk will be zeroed and only then deleted.</p> </li> <li> <p>On file storage, since the file system already guarantees that previously removed blocks are read back as zeros, the disk will be deleted immediately.</p> </li> </ul> </div> author value Idan Shaby <ishaby@redhat.com> date value 6 Nov 2016 status value added wipe_after_delete boolean Indicates if disk errors should not cause virtual machine to be paused and, instead, disk errors should be propagated to the the guest operating system. <div class="paragraph"> <p>Indicates if disk errors should not cause virtual machine to be paused and, instead, disk errors should be propagated to the the guest operating system.</p> </div> author value Juan Hernandez <juan.hernandez@redhat.com> date value 4 Nov 2016 status value added propagate_errors boolean Indicates if the disk is visible to the virtual machine. IMPORTANT: When adding a disk attachment to a virtual machine, the server accepts requests that don't contain this attribute, but the effect is then undefined. In some cases the disk will be automatically activated and in other cases it won't. To avoid issues it is strongly recommended to always include the this attribute with the desired value. <div class="paragraph"> <p>Indicates if the disk is visible to the virtual machine.</p> </div> <div class="admonitionblock important"> <table> <tr> <td class="icon"> <div class="title">Important</div> </td> <td class="content"> When adding a disk attachment to a virtual machine, the server accepts requests that don&#8217;t contain this attribute, but the effect is then undefined. In some cases the disk will be automatically activated and in other cases it won&#8217;t. To avoid issues it is strongly recommended to always include the this attribute with the desired value. </td> </tr> </table> </div> author value Juan Hernandez <juan.hernandez@redhat.com> date value 9 Nov 2016 status value added active boolean Indicates if the disk is in read-only mode. <div class="paragraph"> <p>Indicates if the disk is in read-only mode.</p> </div> author value Juan Hernandez <juan.hernandez@redhat.com> date value 4 Nov 2016 status value added read_only boolean lun_storage host_storage sgio uses_scsi_reservation boolean storage_type logical_name string id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string template template instance_type instance_type References to the virtual machines that are using this device. A device may be used by several virtual machines; for example, a shared disk my be used simultaneously by two or more virtual machines. <div class="paragraph"> <p>References to the virtual machines that are using this device. A device may be used by several virtual machines; for example, a shared disk my be used simultaneously by two or more virtual machines.</p> </div> author value Byron Gravenorst <bgraveno@redhat.com> date value 31 Oct 2016 status value updated_by_docs vms vm[] Don't use this element, use `vms` instead. <div class="paragraph"> <p>Don&#8217;t use this element, use <code>vms</code> instead.</p> </div> deprecated author value Byron Gravenorst <bgraveno@redhat.com> date value 31 Oct 2016 status value updated_by_docs vm vm storage_domain storage_domain The storage domains associated with this disk. NOTE: Only required when the first disk is being added to a virtual machine that was not itself created from a template. <div class="paragraph"> <p>The storage domains associated with this disk.</p> </div> <div class="admonitionblock note"> <table> <tr> <td class="icon"> <div class="title">Note</div> </td> <td class="content"> Only required when the first disk is being added to a virtual machine that was not itself created from a template. </td> </tr> </table> </div> author value Juan Hernandez <juan.hernandez@redhat.com> date value 4 Nov 2016 status value added storage_domains storage_domain[] quota quota disk_profile disk_profile snapshot snapshot openstack_volume_type open_stack_volume_type permissions permission[] statistics statistic[] disk disk A summary containing the total number of relevant objects, like virtual machines, hosts and storage domains. <div class="paragraph"> <p>A summary containing the total number of relevant objects, like virtual machines, hosts and storage domains.</p> </div> api_summary The summary of virtual machines. <div class="paragraph"> <p>The summary of virtual machines.</p> </div> vms api_summary_item The summary of hosts. <div class="paragraph"> <p>The summary of hosts.</p> </div> hosts api_summary_item The summary of users. <div class="paragraph"> <p>The summary of users.</p> </div> users api_summary_item The summary of storage domains. <div class="paragraph"> <p>The summary of storage domains.</p> </div> storage_domains api_summary_item data_center local boolean storage_format The compatibility version of the data center. All clusters in this data center must already be set to at least this compatibility version. For example: [source] ---- GET /ovirt-engine/api/datacenters/123 ---- Will respond: [source,xml] ---- <data_center> ... <version> <major>4</major> <minor>0</minor> </version> ... </data_center> ---- To update the compatibility version, use: [source] ---- PUT /ovirt-engine/api/datacenters/123 ---- With a request body: [source,xml] ---- <data_center> <version> <major>4</major> <minor>1</minor> </version> </data_center> ---- <div class="paragraph"> <p>The compatibility version of the data center.</p> </div> <div class="paragraph"> <p>All clusters in this data center must already be set to at least this compatibility version.</p> </div> <div class="paragraph"> <p>For example:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code>GET /ovirt-engine/api/datacenters/123</code></pre> </div> </div> <div class="paragraph"> <p>Will respond:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-xml" data-lang="xml">&lt;data_center&gt; ... &lt;version&gt; &lt;major&gt;4&lt;/major&gt; &lt;minor&gt;0&lt;/minor&gt; &lt;/version&gt; ... &lt;/data_center&gt;</code></pre> </div> </div> <div class="paragraph"> <p>To update the compatibility version, use:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code>PUT /ovirt-engine/api/datacenters/123</code></pre> </div> </div> <div class="paragraph"> <p>With a request body:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-xml" data-lang="xml">&lt;data_center&gt; &lt;version&gt; &lt;major&gt;4&lt;/major&gt; &lt;minor&gt;1&lt;/minor&gt; &lt;/version&gt; &lt;/data_center&gt;</code></pre> </div> </div> author value Tomas Jelinek <tjelinek@redhat.com> Byron Gravenorst <bgraveno@redhat.com> date value 31 Oct 2016 status value updated_by_docs version version supported_versions version[] status quota_mode id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string Reference to the MAC pool used by this data center. <div class="paragraph"> <p>Reference to the MAC pool used by this data center.</p> </div> author value Byron Gravenorst <bgraveno@redhat.com> date value 31 Oct 2016 status value updated_by_docs mac_pool mac_pool Reference to storage domains attached to this data center. <div class="paragraph"> <p>Reference to storage domains attached to this data center.</p> </div> author value Byron Gravenorst <bgraveno@redhat.com> date value 31 Oct 2016 status value updated_by_docs storage_domains storage_domain[] Reference to clusters inside this data center. <div class="paragraph"> <p>Reference to clusters inside this data center.</p> </div> author value Byron Gravenorst <bgraveno@redhat.com> date value 31 Oct 2016 status value updated_by_docs clusters cluster[] Reference to networks attached to this data center. <div class="paragraph"> <p>Reference to networks attached to this data center.</p> </div> author value Byron Gravenorst <bgraveno@redhat.com> date value 31 Oct 2016 status value updated_by_docs networks network[] Reference to permissions assigned to this data center. <div class="paragraph"> <p>Reference to permissions assigned to this data center.</p> </div> author value Byron Gravenorst <bgraveno@redhat.com> date value 31 Oct 2016 status value updated_by_docs permissions permission[] Reference to quotas assigned to this data center. <div class="paragraph"> <p>Reference to quotas assigned to this data center.</p> </div> author value Byron Gravenorst <bgraveno@redhat.com> date value 31 Oct 2016 status value updated_by_docs quotas quota[] Reference to quality of service used by this data center. <div class="paragraph"> <p>Reference to quality of service used by this data center.</p> </div> author value Byron Gravenorst <bgraveno@redhat.com> date value 31 Oct 2016 status value updated_by_docs qoss qos[] Reference to ISCSI bonds used by this data center. <div class="paragraph"> <p>Reference to ISCSI bonds used by this data center.</p> </div> author value Byron Gravenorst <bgraveno@redhat.com> date value 31 Oct 2016 status value updated_by_docs iscsi_bonds iscsi_bond[] network_usage display The network will be used for Gluster(bricks) data traffic. <div class="paragraph"> <p>The network will be used for Gluster(bricks) data traffic.</p> </div> author value Sahina Bose <sabose@redhat.com> date value 23 Sep 2016 status value added gluster management migration vm vm_device_type floppy cdrom transport_type tcp rdma package name string hook_stage pre post unmanaged_network id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string host_nic host_nic host host host_device capability string product product vendor vendor iommu_group integer physical_function host_device virtual_functions integer placeholder boolean id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string host host parent_device host_device vm vm fence_type manual restart start stop status watchdog_action none reset poweroff pause dump The enum defines the options of the IP address assignment method to a NIC. <div class="paragraph"> <p>The enum defines the options of the IP address assignment method to a NIC.</p> </div> boot_protocol Stateless Address Auto-Configuration. The mechanism is defined by http://tools.ietf.org/html/rfc4862[RFC 4862]. Please refer to https://en.wikipedia.org/wiki/IPv6_address#Stateless_address_autoconfiguration[this wikipedia article]. NOTE: The value is valid for IPv6 addresses only. <div class="paragraph"> <p>Stateless Address Auto-Configuration. The mechanism is defined by <a href="http://tools.ietf.org/html/rfc4862">RFC 4862</a>. Please refer to <a href="https://en.wikipedia.org/wiki/IPv6_address#Stateless_address_autoconfiguration">this wikipedia article</a>.</p> </div> <div class="admonitionblock note"> <table> <tr> <td class="icon"> <div class="title">Note</div> </td> <td class="content"> The value is valid for IPv6 addresses only. </td> </tr> </table> </div> autoconf Dynamic Host Configuration Protocol. Please refer to https://en.wikipedia.org/wiki/Dynamic_Host_Configuration_Protocol[this wikipedia article]. <div class="paragraph"> <p>Dynamic Host Configuration Protocol. Please refer to <a href="https://en.wikipedia.org/wiki/Dynamic_Host_Configuration_Protocol">this wikipedia article</a>.</p> </div> dhcp Statically (by user) defined address, mask and gateway. <div class="paragraph"> <p>Statically (by user) defined address, mask and gateway.</p> </div> static No address configuration. <div class="paragraph"> <p>No address configuration.</p> </div> none rng_source random hwrng balance id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string scheduling_policy scheduling_policy scheduling_policy_unit scheduling_policy_unit step_status aborted failed finished started unknown nfs_profile_detail nfs_server_ip string profile_details profile_detail[] boot_menu enabled boolean external_provider url string requires_authentication boolean username string password string authentication_url string properties property[] id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string cloud_init host host authorized_keys authorized_key[] network_configuration network_configuration regenerate_ssh_keys boolean timezone string users user[] files file[] An affinity group represents a group of virtual machines with a defined relationship. <div class="paragraph"> <p>An affinity group represents a group of virtual machines with a defined relationship.</p> </div> author value Martin Sivak <msivak@redhat.com> date value 14 Sep 2016 status value added affinity_group Specifies whether the affinity group applies positive affinity or negative affinity to virtual machines that are members of that affinity group. <div class="paragraph"> <p>Specifies whether the affinity group applies positive affinity or negative affinity to virtual machines that are members of that affinity group.</p> </div> author value Martin Sivak <msivak@redhat.com> date value 14 Sep 2016 status value added positive boolean Specifies whether the affinity group uses hard or soft enforcement of the affinity applied to virtual machines that are members of that affinity group. <div class="paragraph"> <p>Specifies whether the affinity group uses hard or soft enforcement of the affinity applied to virtual machines that are members of that affinity group.</p> </div> author value Martin Sivak <msivak@redhat.com> date value 14 Sep 2016 status value added enforcing boolean id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string A reference to the cluster to which the affinity group applies. <div class="paragraph"> <p>A reference to the cluster to which the affinity group applies.</p> </div> author value Martin Sivak <msivak@redhat.com> date value 14 Sep 2016 status value added cluster cluster List of all virtual machines assigned to this affinity group. <div class="paragraph"> <p>List of all virtual machines assigned to this affinity group.</p> </div> author value Martin Sivak <msivak@redhat.com> date value 14 Sep 2016 status value added vms vm[] domain user user id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string groups group[] users user[] external_compute_resource provider string user string url string id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string external_host_provider external_host_provider virtio_scsi enabled boolean lun_status free used unusable external_host_provider url string requires_authentication boolean username string password string authentication_url string properties property[] id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string certificates certificate[] compute_resources external_compute_resource[] discovered_hosts external_discovered_host[] host_groups external_host_group[] hosts host[] step_enum validating executing finalizing rebalancing_volume removing_bricks unknown Represents the IP configuration of a network interface. <div class="paragraph"> <p>Represents the IP configuration of a network interface.</p> </div> author value Juan Hernandez <juan.hernandez@redhat.com> date value 3 Oct 2016 staus value added ip The text representation of the IP address. For example, an IPv4 address will be represented as follows: [source,xml] ---- <ip> <address>192.168.0.1</address> ... </ip> ---- An IPv6 address will be represented as follows: [source,xml] ---- <ip> <address>2620:52:0:20f0:4216:7eff:feaa:1b50</address> ... </ip> ---- <div class="paragraph"> <p>The text representation of the IP address.</p> </div> <div class="paragraph"> <p>For example, an IPv4 address will be represented as follows:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-xml" data-lang="xml">&lt;ip&gt; &lt;address&gt;192.168.0.1&lt;/address&gt; ... &lt;/ip&gt;</code></pre> </div> </div> <div class="paragraph"> <p>An IPv6 address will be represented as follows:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-xml" data-lang="xml">&lt;ip&gt; &lt;address&gt;2620:52:0:20f0:4216:7eff:feaa:1b50&lt;/address&gt; ... &lt;/ip&gt;</code></pre> </div> </div> author value Juan Hernandez <juan.hernandez@redhat.com> date value 3 Oct 2016 staus value added address string The network mask. <div class="paragraph"> <p>The network mask.</p> </div> author value Juan Hernandez <juan.hernandez@redhat.com> date value 3 Oct 2016 staus value added netmask string The address of the default gateway. <div class="paragraph"> <p>The address of the default gateway.</p> </div> author value Juan Hernandez <juan.hernandez@redhat.com> date value 3 Oct 2016 staus value added gateway string The version of the IP protocol. This attribute is optional, and when it isn't given the value will be inferred from the value of the `address` attribute. If that value is a valid IPv4 address, then it will be assumed that the value of this attribute is `v4`. If it is a valid IPv6 address, then it will be assumed that the value of this attribute is `v6`. NOTE: This inference of the IP version from the value of the `address` is implemented since version 4.1 of the engine, before that this attribute was mandatory. <div class="paragraph"> <p>The version of the IP protocol.</p> </div> <div class="paragraph"> <p>This attribute is optional, and when it isn&#8217;t given the value will be inferred from the value of the <code>address</code> attribute. If that value is a valid IPv4 address, then it will be assumed that the value of this attribute is <code>v4</code>. If it is a valid IPv6 address, then it will be assumed that the value of this attribute is <code>v6</code>.</p> </div> <div class="admonitionblock note"> <table> <tr> <td class="icon"> <div class="title">Note</div> </td> <td class="content"> This inference of the IP version from the value of the <code>address</code> is implemented since version 4.1 of the engine, before that this attribute was mandatory. </td> </tr> </table> </div> author value Juan Hernandez <juan.hernandez@redhat.com> date value 3 Oct 2016 staus value added version storage_domain type status external_status master boolean storage host_storage available integer used integer committed integer storage_format wipe_after_delete boolean import boolean warning_low_space_indicator integer critical_space_action_blocker integer id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string Host is only relevant at creation time. <div class="paragraph"> <p>Host is only relevant at creation time.</p> </div> host host This is used to link to the data center that the storage domain is attached to. It is preserved for backwards compatibility, as the storage domain may be attached to multiple data centers (if it is an ISO domain). Use the `dataCenters` element instead. <div class="paragraph"> <p>This is used to link to the data center that the storage domain is attached to. It is preserved for backwards compatibility, as the storage domain may be attached to multiple data centers (if it is an ISO domain). Use the <code>dataCenters</code> element instead.</p> </div> data_center data_center This is a set of links to the data centers that the storage domain is attached to. <div class="paragraph"> <p>This is a set of links to the data centers that the storage domain is attached to.</p> </div> data_centers data_center[] disks disk[] disk_profiles disk_profile[] disk_snapshots disk_snapshot[] files file[] images image[] permissions permission[] storage_connections storage_connection[] templates template[] vms vm[] vnic_profile port_mirroring boolean custom_properties custom_property[] pass_through vnic_pass_through id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string network network qos qos Network filter will enhance the admin ability to manage the network packets traffic from/to the participated VMs. <div class="paragraph"> <p>Network filter will enhance the admin ability to manage the network packets traffic from/to the participated VMs.</p> </div> network_filter network_filter permissions permission[] gluster_volume_profile_details brick_profile_details brick_profile_detail[] nfs_profile_details nfs_profile_detail[] id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string core index integer socket integer event code integer severity time date correlation_id string origin string custom_id integer flood_rate integer custom_data string id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string user user vm vm storage_domain storage_domain host host template template cluster cluster data_center data_center tag id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string host host vm vm user user group group template template parent tag reported_configuration name string expected_value string actual_value string in_sync boolean The underlying storage format of disks. <div class="paragraph"> <p>The underlying storage format of disks.</p> </div> author value Juan Hernandez <juan.hernandez@redhat.com> date value 4 Nov 2016 status value added disk_format The _Copy On Write_ format allows snapshots, with a small performance overhead. <div class="paragraph"> <p>The <em>Copy On Write</em> format allows snapshots, with a small performance overhead.</p> </div> author value Juan Hernandez <juan.hernandez@redhat.com> date value 4 Nov 2016 status value added cow The raw format does not allow snapshots, but offers improved performance. <div class="paragraph"> <p>The raw format does not allow snapshots, but offers improved performance.</p> </div> author value Juan Hernandez <juan.hernandez@redhat.com> date value 4 Nov 2016 status value added raw gluster_server_hook content_type status checksum string id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string host host data_center_status uninitialized up maintenance not_operational problematic contend This interface is intended to be the base for all types of the model that represents objects with an identifier. <div class="paragraph"> <p>This interface is intended to be the base for all types of the model that represents objects with an identifier.</p> </div> identified id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string cpu type string topology cpu_topology level integer name string speed decimal cpu_tune cpu_tune mode architecture cores core[] scsi_generic_i_o filtered unfiltered open_stack_image id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string openstack_image_provider open_stack_image_provider vm_pool size integer prestarted_vms integer max_user_vms integer display display rng_device rng_device soundcard_enabled boolean type use_latest_template_version boolean Virtual machine pool's stateful flag. Virtual machines from a stateful virtual machine pool are always started in stateful mode (stateless snapshot is not created). The state of the virtual machine is preserved even when the virtual machine is passed to a different user. <div class="paragraph"> <p>Virtual machine pool&#8217;s stateful flag.</p> </div> <div class="paragraph"> <p>Virtual machines from a stateful virtual machine pool are always started in stateful mode (stateless snapshot is not created). The state of the virtual machine is preserved even when the virtual machine is passed to a different user.</p> </div> stateful boolean id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string cluster cluster template template Reference to the instance type on which this pool is based. It can be set only on pool creation and cannot be edited. <div class="paragraph"> <p>Reference to the instance type on which this pool is based. It can be set only on pool creation and cannot be edited.</p> </div> instance_type instance_type vm vm permissions permission[] gluster_client host_name string client_port integer bytes_read integer bytes_written integer authorized_key key string id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string user user storage_type iscsi fcp nfs localfs posixfs glusterfs glance cinder group domain_entry_id string namespace string id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string domain domain Used only to represent the initial role assignments for a new group, thereafter modification of role assignments are only supported via the `roles` sub-collection. <div class="paragraph"> <p>Used only to represent the initial role assignments for a new group, thereafter modification of role assignments are only supported via the <code>roles</code> sub-collection.</p> </div> roles role[] permissions permission[] tags tag[] cpu_mode custom host_model host_passthrough option name string value string type string host address string status status_detail string certificate certificate external_status port integer Indicates if the host contains a full installation of the operating system or a scaled-down version intended only to host virtual machines. <div class="paragraph"> <p>Indicates if the host contains a full installation of the operating system or a scaled-down version intended only to host virtual machines.</p> </div> author value Tahlia Richardson <trichard@redhat.com> date value 31 Oct 2016 status value updated_by_docs type spm spm The version of VDSM. For example: [source] ---- GET /ovirt-engine/api/hosts/123 ---- This `GET` request will return the following output: [source,xml] ---- <host> ... <version> <build>999</build> <full_version>vdsm-4.18.999-419.gitcf06367.el7</full_version> <major>4</major> <minor>18</minor> <revision>0</revision> </version> ... </host> ---- <div class="paragraph"> <p>The version of VDSM.</p> </div> <div class="paragraph"> <p>For example:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code>GET /ovirt-engine/api/hosts/123</code></pre> </div> </div> <div class="paragraph"> <p>This <code>GET</code> request will return the following output:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-xml" data-lang="xml">&lt;host&gt; ... &lt;version&gt; &lt;build&gt;999&lt;/build&gt; &lt;full_version&gt;vdsm-4.18.999-419.gitcf06367.el7&lt;/full_version&gt; &lt;major&gt;4&lt;/major&gt; &lt;minor&gt;18&lt;/minor&gt; &lt;revision&gt;0&lt;/revision&gt; &lt;/version&gt; ... &lt;/host&gt;</code></pre> </div> </div> author value Tomas Jelinek <tjelinek@redhat.com> Tahlia Richardson <trichard@redhat.com> date value 31 Oct 2016 status value updated_by_docs version version hardware_information hardware_information power_management power_management ksm ksm transparent_huge_pages transparent_huge_pages iscsi iscsi_details When creating a new host, a root password is required if the password authentication method is chosen, but this is not subsequently included in the representation. <div class="paragraph"> <p>When creating a new host, a root password is required if the password authentication method is chosen, but this is not subsequently included in the representation.</p> </div> author value Tahlia Richardson <trichard@redhat.com> date value 31 Oct 2016 status value updated_by_docs root_password string ssh ssh cpu cpu memory integer max_scheduling_memory integer summary vm_summary override_iptables boolean protocol os operating_system libvirt_version version Optionally specify the display address of this host explicitly. <div class="paragraph"> <p>Optionally specify the display address of this host explicitly.</p> </div> author value Tahlia Richardson <trichard@redhat.com> date value 31 Oct 2016 status value updated_by_docs display display hosted_engine hosted_engine kdump_status se_linux se_linux auto_numa_status numa_supported boolean update_available boolean device_passthrough host_device_passthrough id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string cluster cluster hooks hook[] external_host_provider external_host_provider storage_connection_extensions storage_connection_extension[] affinity_labels affinity_label[] devices device[] agents agent[] katello_errata katello_erratum[] network_attachments network_attachment[] nics nic[] numa_nodes numa_node[] permissions permission[] statistics statistic[] storages host_storage[] tags tag[] unmanaged_networks unmanaged_network[] Logical network. An example of the JSON representation of a logical network: [source,json] ---- { "network" : [ { "data_center" : { "href" : "/ovirt-engine/api/datacenters/123", "id" : "123" }, "stp" : "false", "mtu" : "0", "usages" : { "usage" : [ "vm" ] }, "name" : "ovirtmgmt", "description" : "Management Network", "href" : "/ovirt-engine/api/networks/456", "id" : "456", "link" : [ { "href" : "/ovirt-engine/api/networks/456/permissions", "rel" : "permissions" }, { "href" : "/ovirt-engine/api/networks/456/vnicprofiles", "rel" : "vnicprofiles" }, { "href" : "/ovirt-engine/api/networks/456/labels", "rel" : "labels" } ] } ] } ---- An example of the XML representation of the same logical network: [source,xml] ---- <network href="/ovirt-engine/api/networks/456" id="456"> <name>ovirtmgmt</name> <description>Management Network</description> <link href="/ovirt-engine/api/networks/456/permissions" rel="permissions"/> <link href="/ovirt-engine/api/networks/456/vnicprofiles" rel="vnicprofiles"/> <link href="/ovirt-engine/api/networks/456/labels" rel="labels"/> <data_center href="/ovirt-engine/api/datacenters/123" id="123"/> <stp>false</stp> <mtu>0</mtu> <usages> <usage>vm</usage> </usages> </network> ---- <div class="paragraph"> <p>Logical network.</p> </div> <div class="paragraph"> <p>An example of the JSON representation of a logical network:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-json" data-lang="json">{ "network" : [ { "data_center" : { "href" : "/ovirt-engine/api/datacenters/123", "id" : "123" }, "stp" : "false", "mtu" : "0", "usages" : { "usage" : [ "vm" ] }, "name" : "ovirtmgmt", "description" : "Management Network", "href" : "/ovirt-engine/api/networks/456", "id" : "456", "link" : [ { "href" : "/ovirt-engine/api/networks/456/permissions", "rel" : "permissions" }, { "href" : "/ovirt-engine/api/networks/456/vnicprofiles", "rel" : "vnicprofiles" }, { "href" : "/ovirt-engine/api/networks/456/labels", "rel" : "labels" } ] } ] }</code></pre> </div> </div> <div class="paragraph"> <p>An example of the XML representation of the same logical network:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-xml" data-lang="xml">&lt;network href="/ovirt-engine/api/networks/456" id="456"&gt; &lt;name&gt;ovirtmgmt&lt;/name&gt; &lt;description&gt;Management Network&lt;/description&gt; &lt;link href="/ovirt-engine/api/networks/456/permissions" rel="permissions"/&gt; &lt;link href="/ovirt-engine/api/networks/456/vnicprofiles" rel="vnicprofiles"/&gt; &lt;link href="/ovirt-engine/api/networks/456/labels" rel="labels"/&gt; &lt;data_center href="/ovirt-engine/api/datacenters/123" id="123"/&gt; &lt;stp&gt;false&lt;/stp&gt; &lt;mtu&gt;0&lt;/mtu&gt; &lt;usages&gt; &lt;usage&gt;vm&lt;/usage&gt; &lt;/usages&gt; &lt;/network&gt;</code></pre> </div> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added network ip ip vlan vlan Specifies whether spanning tree protocol is enabled for the network. <div class="paragraph"> <p>Specifies whether spanning tree protocol is enabled for the network.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added stp boolean status display boolean Specifies the maximum transmission unit for the network. <div class="paragraph"> <p>Specifies the maximum transmission unit for the network.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added mtu integer Defines a set of usage elements for the network. Users can, for example, specify that the network is to be used for virtual machine traffic and also for display traffic with the `vm` and `display` values. <div class="paragraph"> <p>Defines a set of usage elements for the network.</p> </div> <div class="paragraph"> <p>Users can, for example, specify that the network is to be used for virtual machine traffic and also for display traffic with the <code>vm</code> and <code>display</code> values.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added usages [] required boolean profile_required boolean id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string A reference to the data center of which the network is a member. <div class="paragraph"> <p>A reference to the data center of which the network is a member.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added data_center data_center cluster cluster qos qos A reference to the labels assigned to the network. <div class="paragraph"> <p>A reference to the labels assigned to the network.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added network_labels network_label[] A reference to the permissions of the network. <div class="paragraph"> <p>A reference to the permissions of the network.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added permissions permission[] A reference to the profiles of the network. <div class="paragraph"> <p>A reference to the profiles of the network.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added vnic_profiles vnic_profile[] filter position integer id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string scheduling_policy_unit scheduling_policy_unit network_plugin_type open_vswitch vm_type desktop server step type number integer status start_time date end_time date external boolean external_type id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string parent_step step job job statistics statistic[] This type contains information regarding an image transfer being performed. <div class="paragraph"> <p>This type contains information regarding an image transfer being performed.</p> </div> author value Amit Aviram <aaviram@redhat.com> date value 30 Aug 2016 status value added since value 4.0.4 image_transfer The URL of the proxy server which the user should do I/O to. This attribute is available only if the image transfer entity is in <<types/image_transfer_phase, transferring>> phase. See `phase` for details. <div class="paragraph"> <p>The URL of the proxy server which the user should do I/O to. This attribute is available only if the image transfer entity is in <a href="#types/image_transfer_phase">transferring</a> phase. See <code>phase</code> for details.</p> </div> author value Amit Aviram <aaviram@redhat.com> date value 30 Aug 2016 status value added since value 4.0.4 proxy_url string The signed ticket that should be attached as an `Authentication` header in the HTTPS request for the proxy server to do I/O to (See `proxy_url` attribute). <div class="paragraph"> <p>The signed ticket that should be attached as an <code>Authentication</code> header in the HTTPS request for the proxy server to do I/O to (See <code>proxy_url</code> attribute).</p> </div> author value Amit Aviram <aaviram@redhat.com> date value 30 Aug 2016 status value added since value 4.0.4 signed_ticket string The current phase of the image transfer being made. Each transfer needs a managed session, which must be opened in order for the user to be able to do I/O to an image. Please refer to <<services/image_transfer, image transfer>> for further documentation. <div class="paragraph"> <p>The current phase of the image transfer being made. Each transfer needs a managed session, which must be opened in order for the user to be able to do I/O to an image. Please refer to <a href="#services/image_transfer">image transfer</a> for further documentation.</p> </div> author value Amit Aviram <aaviram@redhat.com> date value 30 Aug 2016 status value added since value 4.0.4 phase id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string The image which is targeted for I/O. <div class="paragraph"> <p>The image which is targeted for I/O.</p> </div> author value Amit Aviram <aaviram@redhat.com> date value 30 Aug 2016 status value added since value 4.0.4 image image The host which will be used to write to the image which is targeted for I/O. <div class="paragraph"> <p>The host which will be used to write to the image which is targeted for I/O.</p> </div> author value Amit Aviram <aaviram@redhat.com> date value 30 Aug 2016 status value added since value 4.0.4 host host external_status error failure info ok warning gluster_hook gluster_command string stage content_type checksum string content string conflict_status integer conflicts string status id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string cluster cluster server_hooks gluster_server_hook[] Describes parameters of virtual machine import operation from external system. <div class="paragraph"> <p>Describes parameters of virtual machine import operation from external system.</p> </div> author value Martin Betak <mbetak@redhat.com> date value 27 Jul 2016 status value added since value 4.0.4 external_vm_import Type of external virtual machine provider. <div class="paragraph"> <p>Type of external virtual machine provider.</p> </div> author value Martin Betak <mbetak@redhat.com> date value 27 Jul 2016 status value added since value 4.0.4 provider URL to be passed to the `virt-v2v` tool for conversion. Example: [source] ---- vpx://wmware_user@vcenter-host/DataCenter/Cluster/esxi-host?no_verify=1 ---- More examples can be found at http://libguestfs.org/virt-v2v.1.html. <div class="paragraph"> <p>URL to be passed to the <code>virt-v2v</code> tool for conversion.</p> </div> <div class="paragraph"> <p>Example:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code>vpx://wmware_user@vcenter-host/DataCenter/Cluster/esxi-host?no_verify=1</code></pre> </div> </div> <div class="paragraph"> <p>More examples can be found at <a href="http://libguestfs.org/virt-v2v.1.html" class="bare">http://libguestfs.org/virt-v2v.1.html</a>.</p> </div> author value Martin Betak <mbetak@redhat.com> date value 27 Jul 2016 status value added since value 4.0.4 url string Username to authenticate against external hypervisor system. <div class="paragraph"> <p>Username to authenticate against external hypervisor system.</p> </div> author value Martin Betak <mbetak@redhat.com> date value 27 Jul 2016 status value added since value 4.0.4 username string Password to authenticate against external hypervisor system. <div class="paragraph"> <p>Password to authenticate against external hypervisor system.</p> </div> author value Martin Betak <mbetak@redhat.com> date value 27 Jul 2016 status value added since value 4.0 password string Name of the virtual machine to be imported as is defined within the external system. <div class="paragraph"> <p>Name of the virtual machine to be imported as is defined within the external system.</p> </div> author value Martin Betak <mbetak@redhat.com> date value 27 Jul 2016 status value added since value 4.0.4 name string Specifies the disk allocation policy of resulting virtual machine: `true` for sparse, `false` for preallocated. <div class="paragraph"> <p>Specifies the disk allocation policy of resulting virtual machine: <code>true</code> for sparse, <code>false</code> for preallocated.</p> </div> author value Martin Betak <mbetak@redhat.com> date value 27 Jul 2016 status value added since value 4.0.4 sparse boolean Virtual machine entity used to specify the name of the newly created virtual machine. If name is not specified, the source virtual machine name will be used. <div class="paragraph"> <p>Virtual machine entity used to specify the name of the newly created virtual machine.</p> </div> <div class="paragraph"> <p>If name is not specified, the source virtual machine name will be used.</p> </div> author value Martin Betak <mbetak@redhat.com> date value 27 Jul 2016 status value added since value 4.0.4 vm vm Specifies the target cluster of the resulting virtual machine. <div class="paragraph"> <p>Specifies the target cluster of the resulting virtual machine.</p> </div> author value Martin Betak <mbetak@redhat.com> date value 27 Jul 2016 status value added since value 4.0.4 cluster cluster Specifies the target storage domain for converted disks. <div class="paragraph"> <p>Specifies the target storage domain for converted disks.</p> </div> author value Martin Betak <mbetak@redhat.com> date value 27 Jul 2016 status value added since value 4.0.4 storage_domain storage_domain Optionally specifies the cpu profile of the resulting virtual machine. <div class="paragraph"> <p>Optionally specifies the cpu profile of the resulting virtual machine.</p> </div> author value Martin Betak <mbetak@redhat.com> date value 27 Jul 2016 status value added since value 4.0.4 cpu_profile cpu_profile Optionally specifies the quota that will be applied to the resulting virtual machine. <div class="paragraph"> <p>Optionally specifies the quota that will be applied to the resulting virtual machine.</p> </div> author value Martin Betak <mbetak@redhat.com> date value 27 Jul 2016 status value added since value 4.0.4 quota quota Optional specification of host (using host's ID) to be used for the conversion process. If not specified, one is selected automatically. <div class="paragraph"> <p>Optional specification of host (using host&#8217;s ID) to be used for the conversion process. If not specified, one is selected automatically.</p> </div> author value Martin Betak <mbetak@redhat.com> date value 27 Jul 2016 status value added since value 4.0.4 host host Optional name of ISO carrying drivers that can be used during the virt-v2v conversion process. <div class="paragraph"> <p>Optional name of ISO carrying drivers that can be used during the virt-v2v conversion process.</p> </div> author value Martin Betak <mbetak@redhat.com> date value 27 Jul 2016 status value added since value 4.0.4 drivers_iso file statistic_unit bits_per_second bytes bytes_per_second count_per_second none percent seconds network_label id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string network network host_nic host_nic A policy describing how the migration is going to be treated (convergence, how many parallel migrations allowed). <div class="paragraph"> <p>A policy describing how the migration is going to be treated (convergence, how many parallel migrations allowed).</p> </div> migration_policy id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string host_device_passthrough enabled boolean property name string value string creation_status pending in_progress complete failed cluster cpu cpu memory_policy memory_policy The compatibility version of the cluster. All hosts in this cluster must support at least this compatibility version. For example: [source] ---- GET /ovirt-engine/api/clusters/123 ---- Will respond: [source,xml] ---- <cluster> ... <version> <major>4</major> <minor>0</minor> </version> ... </cluster> ---- To update the compatibility version, use: [source] ---- PUT /ovirt-engine/api/clusters/123 ---- With a request body: [source,xml] ---- <cluster> <version> <major>4</major> <minor>1</minor> </version> </cluster> ---- In order to update the cluster compatibility version, all hosts in the cluster must support the new compatibility version. <div class="paragraph"> <p>The compatibility version of the cluster.</p> </div> <div class="paragraph"> <p>All hosts in this cluster must support at least this compatibility version.</p> </div> <div class="paragraph"> <p>For example:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code>GET /ovirt-engine/api/clusters/123</code></pre> </div> </div> <div class="paragraph"> <p>Will respond:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-xml" data-lang="xml">&lt;cluster&gt; ... &lt;version&gt; &lt;major&gt;4&lt;/major&gt; &lt;minor&gt;0&lt;/minor&gt; &lt;/version&gt; ... &lt;/cluster&gt;</code></pre> </div> </div> <div class="paragraph"> <p>To update the compatibility version, use:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code>PUT /ovirt-engine/api/clusters/123</code></pre> </div> </div> <div class="paragraph"> <p>With a request body:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-xml" data-lang="xml">&lt;cluster&gt; &lt;version&gt; &lt;major&gt;4&lt;/major&gt; &lt;minor&gt;1&lt;/minor&gt; &lt;/version&gt; &lt;/cluster&gt;</code></pre> </div> </div> <div class="paragraph"> <p>In order to update the cluster compatibility version, all hosts in the cluster must support the new compatibility version.</p> </div> author value Tomas Jelinek <tjelinek@redhat.com> Byron Gravenorst <bgraveno@redhat.com> date value 25 Oct 2016 status value updated_by_docs version version supported_versions version[] error_handling error_handling virt_service boolean gluster_service boolean threads_as_cores boolean tunnel_migration boolean trusted_service boolean ha_reservation boolean optional_reason boolean maintenance_reason_required boolean ballooning_enabled boolean display display ksm ksm serial_number serial_number required_rng_sources [] fencing_policy fencing_policy migration migration_options Custom scheduling policy properties of the cluster. These optional properties override the properties of the scheduling policy specified by the `scheduling_policy` link, and apply only for this specific cluster. For example, to update the custom properties of the cluster, send a request: [source] ---- PUT /ovirt-engine/api/clusters/123 ---- With a request body: [source,xml] ---- <cluster> <custom_scheduling_policy_properties> <property> <name>HighUtilization</name> <value>70</value> </property> </custom_scheduling_policy_properties> </cluster> ---- Update operations using the `custom_scheduling_policy_properties` attribute will not update the the properties of the scheduling policy specified by the `scheduling_policy` link, they will only be reflected on this specific cluster. <div class="paragraph"> <p>Custom scheduling policy properties of the cluster. These optional properties override the properties of the scheduling policy specified by the <code>scheduling_policy</code> link, and apply only for this specific cluster.</p> </div> <div class="paragraph"> <p>For example, to update the custom properties of the cluster, send a request:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code>PUT /ovirt-engine/api/clusters/123</code></pre> </div> </div> <div class="paragraph"> <p>With a request body:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-xml" data-lang="xml">&lt;cluster&gt; &lt;custom_scheduling_policy_properties&gt; &lt;property&gt; &lt;name&gt;HighUtilization&lt;/name&gt; &lt;value&gt;70&lt;/value&gt; &lt;/property&gt; &lt;/custom_scheduling_policy_properties&gt; &lt;/cluster&gt;</code></pre> </div> </div> <div class="paragraph"> <p>Update operations using the <code>custom_scheduling_policy_properties</code> attribute will not update the the properties of the scheduling policy specified by the <code>scheduling_policy</code> link, they will only be reflected on this specific cluster.</p> </div> author value Yanir Quinn <yquinn@redhat.com> Byron Gravenorst <bgraveno@redhat.com> date value 25 Oct 2016 status value updated_by_docs since value 4.0.6 custom_scheduling_policy_properties property[] Type of switch to be used by all networks in given cluster. <div class="paragraph"> <p>Type of switch to be used by all networks in given cluster.</p> </div> author value Byron Gravenorst <bgraveno@redhat.com> date value 25 Oct 2016 status value updated_by_docs switch_type id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string Reference to the default scheduling policy used by this cluster. NOTE: The scheduling policy properties are taken by default from the referenced scheduling policy, but they are overridden by the properties specified in the `custom_scheduling_policy_properties` attribute for this cluster. <div class="paragraph"> <p>Reference to the default scheduling policy used by this cluster.</p> </div> <div class="admonitionblock note"> <table> <tr> <td class="icon"> <div class="title">Note</div> </td> <td class="content"> The scheduling policy properties are taken by default from the referenced scheduling policy, but they are overridden by the properties specified in the <code>custom_scheduling_policy_properties</code> attribute for this cluster. </td> </tr> </table> </div> author value Yanir Quinn <yquinn@redhat.com> Byron Gravenorst <bgraveno@redhat.com> date value 25 Oct 2016 status value updated_by_docs scheduling_policy scheduling_policy data_center data_center management_network network affinity_groups affinity_group[] cpu_profiles cpu_profile[] gluster_hooks gluster_hook[] gluster_volumes gluster_volume[] network_filters network_filter[] networks network[] permissions permission[] iscsi_bond id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string data_center data_center storage_connections storage_connection[] networks network[] Represents a storage server connection. Example: [source,xml] ---- <storage_connection id="123"> <address>mynfs.example.com</address> <type>nfs</type> <path>/exports/mydata</path> </storage_connection> ---- <div class="paragraph"> <p>Represents a storage server connection.</p> </div> <div class="paragraph"> <p>Example:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-xml" data-lang="xml">&lt;storage_connection id="123"&gt; &lt;address&gt;mynfs.example.com&lt;/address&gt; &lt;type&gt;nfs&lt;/type&gt; &lt;path&gt;/exports/mydata&lt;/path&gt; &lt;/storage_connection&gt;</code></pre> </div> </div> author value Daniel Erez <derez@redhat.com> date value 14 Sep 2016 status value added storage_connection address string type path string mount_options string vfs_type string nfs_version nfs_timeo integer nfs_retrans integer port integer target string username string password string portal string id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string host host vendor id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string Represents a NIC of a virtual machine. For example, the XML representation of a NIC will look like this: [source,xml] ---- <nic href="/ovirt-engine/api/vms/123/nics/456" id="456"> <name>nic1</name> <vm href="/ovirt-engine/api/vms/123" id="123"/> <interface>virtio</interface> <linked>true</linked> <mac> <address>02:00:00:00:00:00</address> </mac> <plugged>true</plugged> <vnic_profile href="/ovirt-engine/api/vnicprofiles/789" id="789"/> </nic> ---- <div class="paragraph"> <p>Represents a NIC of a virtual machine.</p> </div> <div class="paragraph"> <p>For example, the XML representation of a NIC will look like this:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-xml" data-lang="xml">&lt;nic href="/ovirt-engine/api/vms/123/nics/456" id="456"&gt; &lt;name&gt;nic1&lt;/name&gt; &lt;vm href="/ovirt-engine/api/vms/123" id="123"/&gt; &lt;interface&gt;virtio&lt;/interface&gt; &lt;linked&gt;true&lt;/linked&gt; &lt;mac&gt; &lt;address&gt;02:00:00:00:00:00&lt;/address&gt; &lt;/mac&gt; &lt;plugged&gt;true&lt;/plugged&gt; &lt;vnic_profile href="/ovirt-engine/api/vnicprofiles/789" id="789"/&gt; &lt;/nic&gt;</code></pre> </div> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added nic Defines if the NIC is linked to the virtual machine. <div class="paragraph"> <p>Defines if the NIC is linked to the virtual machine.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added linked boolean The type of driver used for the NIC. <div class="paragraph"> <p>The type of driver used for the NIC.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added interface The MAC address of the interface. <div class="paragraph"> <p>The MAC address of the interface.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added mac mac Defines if the NIC is plugged in to the virtual machine. <div class="paragraph"> <p>Defines if the NIC is plugged in to the virtual machine.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added plugged boolean boot_protocol on_boot boolean id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string template template instance_type instance_type References to the virtual machines that are using this device. A device may be used by several virtual machines; for example, a shared disk my be used simultaneously by two or more virtual machines. <div class="paragraph"> <p>References to the virtual machines that are using this device. A device may be used by several virtual machines; for example, a shared disk my be used simultaneously by two or more virtual machines.</p> </div> author value Byron Gravenorst <bgraveno@redhat.com> date value 31 Oct 2016 status value updated_by_docs vms vm[] Don't use this element, use `vms` instead. <div class="paragraph"> <p>Don&#8217;t use this element, use <code>vms</code> instead.</p> </div> deprecated author value Byron Gravenorst <bgraveno@redhat.com> date value 31 Oct 2016 status value updated_by_docs vm vm A reference to the network which the interface should be connected to. A blank network id is allowed. Usage of this element for creating or updating a NIC is deprecated, use `vnic_profile` instead. It is preserved because it is still in use by the `initialization` element, as a holder for IP addresses and other network details. <div class="paragraph"> <p>A reference to the network which the interface should be connected to. A blank network id is allowed.</p> </div> <div class="paragraph"> <p>Usage of this element for creating or updating a NIC is deprecated, use <code>vnic_profile</code> instead. It is preserved because it is still in use by the <code>initialization</code> element, as a holder for IP addresses and other network details.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added network network A link to the statistics for the NIC. <div class="paragraph"> <p>A link to the statistics for the NIC.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added statistics statistic[] vnic_profile vnic_profile network_labels network_label[] network_attachments network_attachment[] virtual_function_allowed_labels network_label[] virtual_function_allowed_networks network[] reported_devices reported_device[] usb_type legacy native host_status down error initializing installing install_failed maintenance non_operational non_responsive pending_approval preparing_for_maintenance connecting reboot unassigned up installing_os kdumping gluster_volume_status Volume is started, and can be mounted and used by clients. <div class="paragraph"> <p>Volume is started, and can be mounted and used by clients.</p> </div> up Volume needs to be started, for clients to be able to mount and use it. <div class="paragraph"> <p>Volume needs to be started, for clients to be able to mount and use it.</p> </div> down When the status cannot be determined due to host being non-responsive. <div class="paragraph"> <p>When the status cannot be determined due to host being non-responsive.</p> </div> unknown gluster_hook_status Hook is enabled in the cluster. <div class="paragraph"> <p>Hook is enabled in the cluster.</p> </div> enabled Hook is disabled in the cluster. <div class="paragraph"> <p>Hook is disabled in the cluster.</p> </div> disabled Unknown/missing hook status. <div class="paragraph"> <p>Unknown/missing hook status.</p> </div> missing gluster_brick_status Brick is in `up` state, the data can be stored or retrieved from it. <div class="paragraph"> <p>Brick is in <code>up</code> state, the data can be stored or retrieved from it.</p> </div> up Brick is in `down` state, the data cannot be stored or retrieved from it. <div class="paragraph"> <p>Brick is in <code>down</code> state, the data cannot be stored or retrieved from it.</p> </div> down When the status cannot be determined due to host being non-responsive. <div class="paragraph"> <p>When the status cannot be determined due to host being non-responsive.</p> </div> unknown fault reason string detail string grace_period expiry integer action status string fault fault grace_period grace_period job job async boolean bricks gluster_brick[] certificates certificate[] check_connectivity boolean clone boolean cluster cluster collapse_snapshots boolean connectivity_timeout integer data_center data_center deploy_hosted_engine boolean details gluster_volume_profile_details discard_snapshots boolean disk disk disks disk[] exclusive boolean fence_type string filter boolean fix_layout boolean force boolean host host image string import_as_template boolean is_attached boolean iscsi iscsi_details iscsi_targets string[] logical_units logical_unit[] maintenance_enabled boolean modified_bonds host_nic[] modified_labels network_label[] modified_network_attachments network_attachment[] option option pause boolean power_management power_management proxy_ticket proxy_ticket reason string removed_bonds host_nic[] removed_labels network_label[] removed_network_attachments network_attachment[] resolution_type string restore_memory boolean root_password string snapshot snapshot ssh ssh stop_gluster_service boolean storage_domain storage_domain storage_domains storage_domain[] succeeded boolean synchronized_network_attachments network_attachment[] template template ticket ticket undeploy_hosted_engine boolean use_cloud_init boolean use_sysprep boolean virtual_functions_configuration host_nic_virtual_functions_configuration vm vm id string A human readable name in plain text. <div class="paragraph"> <p>A human readable name in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added name string A human readable description in plain text. <div class="paragraph"> <p>A human readable description in plain text.</p> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added description string Free text containing comments about this object. <div class="paragraph"> <p>Free text containing comments about this object.</p> </div> comment string area value Network vnic_profiles add profile true true vnic_profile list profiles false false vnic_profile[] Sets the maximum number of profiles to return. If not specified all the profiles are returned. <div class="paragraph"> <p>Sets the maximum number of profiles to return. If not specified all the profiles are returned.</p> </div> max true true integer profile vnic_profile id false false string area value SLA scheduling_policy_unit get unit false false scheduling_policy_unit Indicates if the results should be filtered according to the permissions of the user. <div class="paragraph"> <p>Indicates if the results should be filtered according to the permissions of the user.</p> </div> filter true true boolean remove Indicates if the remove should be performed asynchronously. <div class="paragraph"> <p>Indicates if the remove should be performed asynchronously.</p> </div> async true true boolean area value Network virtual_function_allowed_network get network false false network remove Indicates if the remove should be performed asynchronously. <div class="paragraph"> <p>Indicates if the remove should be performed asynchronously.</p> </div> async true true boolean area value Network template_nics add nic true true nic list nics false false nic[] Sets the maximum number of NICs to return. If not specified all the NICs are returned. <div class="paragraph"> <p>Sets the maximum number of NICs to return. If not specified all the NICs are returned.</p> </div> max true true integer nic template_nic id false false string Single affinity label details. <div class="paragraph"> <p>Single affinity label details.</p> </div> affinity_label Retrieves details about a label. <div class="paragraph"> <p>Retrieves details about a label.</p> </div> get label false false affinity_label Updates a label. This call will update all metadata like name or description. <div class="paragraph"> <p>Updates a label.</p> </div> <div class="paragraph"> <p>This call will update all metadata like name or description.</p> </div> update label true true affinity_label Removes a label from system and clears all assignments of the removed label. <div class="paragraph"> <p>Removes a label from system and clears all assignments of the removed label.</p> </div> remove List all VMs with this label. <div class="paragraph"> <p>List all VMs with this label.</p> </div> vms affinity_label_vms List all Hosts with this label. <div class="paragraph"> <p>List all Hosts with this label.</p> </div> hosts affinity_label_hosts area value Infrastructure bookmarks add bookmark true true bookmark list bookmarks false false bookmark[] Sets the maximum number of bookmarks to return. If not specified all the bookmarks are returned. <div class="paragraph"> <p>Sets the maximum number of bookmarks to return. If not specified all the bookmarks are returned.</p> </div> max true true integer bookmark bookmark id false false string area value Network network_attachments add attachment true true network_attachment list attachments false false network_attachment[] Sets the maximum number of attachments to return. If not specified all the attachments are returned. <div class="paragraph"> <p>Sets the maximum number of attachments to return. If not specified all the attachments are returned.</p> </div> max true true integer attachment network_attachment id false false string area value Virtualization operating_system get operating_system false false operating_system_info area value Storage template_disks list disks false false disk[] Sets the maximum number of disks to return. If not specified all the disks are returned. <div class="paragraph"> <p>Sets the maximum number of disks to return. If not specified all the disks are returned.</p> </div> max true true integer disk template_disk id false false string This service doesn't add any new methods, it is just a placeholder for the annotation that specifies the path of the resource that manages the permissions assigned to the system object. <div class="paragraph"> <p>This service doesn&#8217;t add any new methods, it is just a placeholder for the annotation that specifies the path of the resource that manages the permissions assigned to the system object.</p> </div> area value Infrastructure system_permissions add permission true true permission list permissions false false permission[] Sub-resource locator method, returns individual permission resource on which the remainder of the URI is dispatched. <div class="paragraph"> <p>Sub-resource locator method, returns individual permission resource on which the remainder of the URI is dispatched.</p> </div> permission permission id false false string area value Virtualization vm_reported_device get reported_device false false reported_device area value Network snapshot_nics list nics false false nic[] Sets the maximum number of NICs to return. If not specified all the NICs are returned. <div class="paragraph"> <p>Sets the maximum number of NICs to return. If not specified all the NICs are returned.</p> </div> max true true integer nic snapshot_nic id false false string area value Network assigned_vnic_profiles add profile true true vnic_profile list profiles false false vnic_profile[] Sets the maximum number of profiles to return. If not specified all the profiles are returned. <div class="paragraph"> <p>Sets the maximum number of profiles to return. If not specified all the profiles are returned.</p> </div> max true true integer profile assigned_vnic_profile id false false string area value SLA quota_cluster_limits add limit true true quota_cluster_limit list limits false false quota_cluster_limit[] Sets the maximum number of limits to return. If not specified all the limits are returned. <div class="paragraph"> <p>Sets the maximum number of limits to return. If not specified all the limits are returned.</p> </div> max true true integer limit quota_cluster_limit id false false string Manages logical networks. The engine creates a default `ovirtmgmt` network on installation. This network acts as the management network for access to hypervisor hosts. This network is associated with the `Default` cluster and is a member of the `Default` data center. <div class="paragraph"> <p>Manages logical networks.</p> </div> <div class="paragraph"> <p>The engine creates a default <code>ovirtmgmt</code> network on installation. This network acts as the management network for access to hypervisor hosts. This network is associated with the <code>Default</code> cluster and is a member of the <code>Default</code> data center.</p> </div> area value Network author value Ori Ben Sasson <obensass@redhat.com> date value 20 Sep 2016 status value added networks Creates a new logical network, or associates an existing network with a data center. Creation of a new network requires the `name` and `data_center` elements. For example, to create a network named `mynetwork` for data center `123` send a request like this: [source] ---- POST /ovirt-engine/api/networks ---- With a request body like this: [source,xml] ---- <network> <name>mynetwork</name> <data_center id="123"/> </network> ---- To associate the existing network `456` with the data center `123` send a request like this: [source] ---- POST /ovirt-engine/api/datacenters/123/networks ---- With a request body like this: [source,xml] ---- <network> <name>ovirtmgmt</name> </network> ---- <div class="paragraph"> <p>Creates a new logical network, or associates an existing network with a data center.</p> </div> <div class="paragraph"> <p>Creation of a new network requires the <code>name</code> and <code>data_center</code> elements.</p> </div> <div class="paragraph"> <p>For example, to create a network named <code>mynetwork</code> for data center <code>123</code> send a request like this:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code>POST /ovirt-engine/api/networks</code></pre> </div> </div> <div class="paragraph"> <p>With a request body like this:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-xml" data-lang="xml">&lt;network&gt; &lt;name&gt;mynetwork&lt;/name&gt; &lt;data_center id="123"/&gt; &lt;/network&gt;</code></pre> </div> </div> <div class="paragraph"> <p>To associate the existing network <code>456</code> with the data center <code>123</code> send a request like this:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code>POST /ovirt-engine/api/datacenters/123/networks</code></pre> </div> </div> <div class="paragraph"> <p>With a request body like this:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-xml" data-lang="xml">&lt;network&gt; &lt;name&gt;ovirtmgmt&lt;/name&gt; &lt;/network&gt;</code></pre> </div> </div> author value Martin Mucha <mmucha@redhat.com> date value 24 Oct 2016 status value added add network true true network List logical networks. For example: [source] ---- GET /ovirt-engine/api/networks ---- Will respond: [source,xml] ---- <networks> <network href="/ovirt-engine/api/networks/123" id="123"> <name>ovirtmgmt</name> <description>Default Management Network</description> <link href="/ovirt-engine/api/networks/123/permissions" rel="permissions"/> <link href="/ovirt-engine/api/networks/123/vnicprofiles" rel="vnicprofiles"/> <link href="/ovirt-engine/api/networks/123/networklabels" rel="networklabels"/> <mtu>0</mtu> <stp>false</stp> <usages> <usage>vm</usage> </usages> <data_center href="/ovirt-engine/api/datacenters/456" id="456"/> </network> ... </networks> ---- <div class="paragraph"> <p>List logical networks.</p> </div> <div class="paragraph"> <p>For example:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code>GET /ovirt-engine/api/networks</code></pre> </div> </div> <div class="paragraph"> <p>Will respond:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-xml" data-lang="xml">&lt;networks&gt; &lt;network href="/ovirt-engine/api/networks/123" id="123"&gt; &lt;name&gt;ovirtmgmt&lt;/name&gt; &lt;description&gt;Default Management Network&lt;/description&gt; &lt;link href="/ovirt-engine/api/networks/123/permissions" rel="permissions"/&gt; &lt;link href="/ovirt-engine/api/networks/123/vnicprofiles" rel="vnicprofiles"/&gt; &lt;link href="/ovirt-engine/api/networks/123/networklabels" rel="networklabels"/&gt; &lt;mtu&gt;0&lt;/mtu&gt; &lt;stp&gt;false&lt;/stp&gt; &lt;usages&gt; &lt;usage&gt;vm&lt;/usage&gt; &lt;/usages&gt; &lt;data_center href="/ovirt-engine/api/datacenters/456" id="456"/&gt; &lt;/network&gt; ... &lt;/networks&gt;</code></pre> </div> </div> author value Ori Ben Sasson <obensass@redhat.com> date value 14 Sep 2016 status value added list networks false false network[] Sets the maximum number of networks to return. If not specified all the networks are returned. <div class="paragraph"> <p>Sets the maximum number of networks to return. If not specified all the networks are returned.</p> </div> max true true integer A query string used to restrict the returned networks. <div class="paragraph"> <p>A query string used to restrict the returned networks.</p> </div> search true true string Indicates if the search performed using the `search` parameter should be performed taking case into account. The default value is `true`, which means that case is taken into account. If you want to search ignoring case set it to `false`. <div class="paragraph"> <p>Indicates if the search performed using the <code>search</code> parameter should be performed taking case into account. The default value is <code>true</code>, which means that case is taken into account. If you want to search ignoring case set it to <code>false</code>.</p> </div> case_sensitive true true boolean network network id false false string Affinity groups service manages virtual machine relationships and dependencies. <div class="paragraph"> <p>Affinity groups service manages virtual machine relationships and dependencies.</p> </div> area value SLA author value Martin Sivak <msivak@redhat.com> date value 14 Sep 2016 status value added affinity_groups Create a new affinity group. Post a request like in the example below to create a new affinity group: [source] ---- POST /ovirt-engine/api/clusters/000-000/affinitygroups ---- And use the following example in its body: [source,xml] ---- <affinity_group> <name>AF_GROUP_001</name> <positive>true</positive> <enforcing>true</enforcing> </affinity_group> ---- <div class="paragraph"> <p>Create a new affinity group.</p> </div> <div class="paragraph"> <p>Post a request like in the example below to create a new affinity group:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code>POST /ovirt-engine/api/clusters/000-000/affinitygroups</code></pre> </div> </div> <div class="paragraph"> <p>And use the following example in its body:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-xml" data-lang="xml">&lt;affinity_group&gt; &lt;name&gt;AF_GROUP_001&lt;/name&gt; &lt;positive&gt;true&lt;/positive&gt; &lt;enforcing&gt;true&lt;/enforcing&gt; &lt;/affinity_group&gt;</code></pre> </div> </div> author value Martin Sivak <msivak@redhat.com> date value 14 Sep 2016 status value added add The affinity group object to create. <div class="paragraph"> <p>The affinity group object to create.</p> </div> author value Martin Sivak <msivak@redhat.com> date value 14 Sep 2016 status value added group true true affinity_group List existing affinity groups. <div class="paragraph"> <p>List existing affinity groups.</p> </div> author value Martin Sivak <msivak@redhat.com> date value 14 Sep 2016 status value added list The list of existing affinity groups. <div class="paragraph"> <p>The list of existing affinity groups.</p> </div> author value Martin Sivak <msivak@redhat.com> date value 14 Sep 2016 status value added groups false false affinity_group[] Sets the maximum number of affinity groups to return. If not specified all the affinity groups are returned. <div class="paragraph"> <p>Sets the maximum number of affinity groups to return. If not specified all the affinity groups are returned.</p> </div> max true true integer Access affinity group service that manages the affinity group specified by an id. <div class="paragraph"> <p>Access affinity group service that manages the affinity group specified by an id.</p> </div> author value Martin Sivak <msivak@redhat.com> date value 14 Sep 2016 status value added group affinity_group id false false string area value Storage disk_snapshot get snapshot false false disk_snapshot remove Indicates if the remove should be performed asynchronously. <div class="paragraph"> <p>Indicates if the remove should be performed asynchronously.</p> </div> async true true boolean area value SLA scheduling_policy get policy false false scheduling_policy Indicates if the results should be filtered according to the permissions of the user. <div class="paragraph"> <p>Indicates if the results should be filtered according to the permissions of the user.</p> </div> filter true true boolean update policy true true scheduling_policy Indicates if the update should be performed asynchronously. <div class="paragraph"> <p>Indicates if the update should be performed asynchronously.</p> </div> async true true boolean remove Indicates if the remove should be performed asynchronously. <div class="paragraph"> <p>Indicates if the remove should be performed asynchronously.</p> </div> async true true boolean filters filters weights weights balances balances area value Network network_attachment get attachment false false network_attachment update attachment true true network_attachment Indicates if the update should be performed asynchronously. <div class="paragraph"> <p>Indicates if the update should be performed asynchronously.</p> </div> async true true boolean remove Indicates if the remove should be performed asynchronously. <div class="paragraph"> <p>Indicates if the remove should be performed asynchronously.</p> </div> async true true boolean area value Storage disk_profiles add profile true true disk_profile list profile false false disk_profile[] Sets the maximum number of profiles to return. If not specified all the profiles are returned. <div class="paragraph"> <p>Sets the maximum number of profiles to return. If not specified all the profiles are returned.</p> </div> max true true integer disk_profile disk_profile id false false string area value Virtualization icon get icon false false icon This service represents one label to entity assignment when accessed using the entities/affinitylabels subcollection. <div class="paragraph"> <p>This service represents one label to entity assignment when accessed using the entities/affinitylabels subcollection.</p> </div> assigned_affinity_label Retrieves details about the attached label. <div class="paragraph"> <p>Retrieves details about the attached label.</p> </div> get label false false affinity_label Removes the label from an entity. Does not touch the label itself. <div class="paragraph"> <p>Removes the label from an entity. Does not touch the label itself.</p> </div> remove area value Virtualization cpu_profiles add profile true true cpu_profile list profile false false cpu_profile[] Sets the maximum number of profiles to return. If not specified all the profiles are returned. <div class="paragraph"> <p>Sets the maximum number of profiles to return. If not specified all the profiles are returned.</p> </div> max true true integer profile cpu_profile id false false string area value Network mac_pools Creates a new MAC address pool. Creation of a MAC address pool requires values for the `name` and `ranges` attributes. For example, to create MAC address pool send a request like this: [source] ---- POST /ovirt-engine/api/macpools ---- With a request body like this: [source,xml] ---- <mac_pool> <name>MACPool</name> <description>A MAC address pool</description> <allow_duplicates>true</allow_duplicates> <default_pool>false</default_pool> <ranges> <range> <from>00:1A:4A:16:01:51</from> <to>00:1A:4A:16:01:e6</to> </range> </ranges> </mac_pool> ---- <div class="paragraph"> <p>Creates a new MAC address pool.</p> </div> <div class="paragraph"> <p>Creation of a MAC address pool requires values for the <code>name</code> and <code>ranges</code> attributes.</p> </div> <div class="paragraph"> <p>For example, to create MAC address pool send a request like this:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code>POST /ovirt-engine/api/macpools</code></pre> </div> </div> <div class="paragraph"> <p>With a request body like this:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-xml" data-lang="xml">&lt;mac_pool&gt; &lt;name&gt;MACPool&lt;/name&gt; &lt;description&gt;A MAC address pool&lt;/description&gt; &lt;allow_duplicates&gt;true&lt;/allow_duplicates&gt; &lt;default_pool&gt;false&lt;/default_pool&gt; &lt;ranges&gt; &lt;range&gt; &lt;from&gt;00:1A:4A:16:01:51&lt;/from&gt; &lt;to&gt;00:1A:4A:16:01:e6&lt;/to&gt; &lt;/range&gt; &lt;/ranges&gt; &lt;/mac_pool&gt;</code></pre> </div> </div> author value Martin Mucha <mmucha@redhat.com> date value 14 Sep 2016 status value added add pool true true mac_pool list pools false false mac_pool[] Sets the maximum number of pools to return. If not specified all the pools are returned. <div class="paragraph"> <p>Sets the maximum number of pools to return. If not specified all the pools are returned.</p> </div> max true true integer mac_pool mac_pool id false false string This service manages a collection of all virtual machines assigned to an affinity group. <div class="paragraph"> <p>This service manages a collection of all virtual machines assigned to an affinity group.</p> </div> area value SLA author value Martin Sivak <msivak@redhat.com> date value 14 Sep 2016 status value added affinity_group_vms Add a virtual machine to the affinity group. For example to add the virtual machine 000-000 to affinity group 123-456 send a request to: [source] ---- POST /ovirt-engine/api/clusters/000-000/affinitygroups/123-456/vms ---- With the following body: [source,xml] ---- <vm id="000-000"/> ---- <div class="paragraph"> <p>Add a virtual machine to the affinity group.</p> </div> <div class="paragraph"> <p>For example to add the virtual machine 000-000 to affinity group 123-456 send a request to:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code>POST /ovirt-engine/api/clusters/000-000/affinitygroups/123-456/vms</code></pre> </div> </div> <div class="paragraph"> <p>With the following body:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-xml" data-lang="xml">&lt;vm id="000-000"/&gt;</code></pre> </div> </div> author value Martin Sivak <msivak@redhat.com> date value 14 Sep 2016 status value added add vm true true vm List all virtual machines assigned to this affinity group. <div class="paragraph"> <p>List all virtual machines assigned to this affinity group.</p> </div> author value Martin Sivak <msivak@redhat.com> date value 14 Sep 2016 status value added list vms false false vm[] Sets the maximum number of virtual machines to return. If not specified all the virtual machines are returned. <div class="paragraph"> <p>Sets the maximum number of virtual machines to return. If not specified all the virtual machines are returned.</p> </div> max true true integer Access the service that manages the virtual machine assignment to this affinity group. <div class="paragraph"> <p>Access the service that manages the virtual machine assignment to this affinity group.</p> </div> author value Martin Sivak <msivak@redhat.com> date value 14 Sep 2016 status value added vm affinity_group_vm id false false string area value SLA qos get qos false false qos update qos true true qos Indicates if the update should be performed asynchronously. <div class="paragraph"> <p>Indicates if the update should be performed asynchronously.</p> </div> async true true boolean remove Indicates if the remove should be performed asynchronously. <div class="paragraph"> <p>Indicates if the remove should be performed asynchronously.</p> </div> async true true boolean area value Infrastructure tags add tag true true tag list tags false false tag[] Sets the maximum number of tags to return. If not specified all the tags are returned. <div class="paragraph"> <p>Sets the maximum number of tags to return. If not specified all the tags are returned.</p> </div> max true true integer tag tag id false false string area value Infrastructure external_provider_certificate get certificate false false certificate area value Infrastructure events Adds an external event to the internal audit log. This is intended for integration with external systems that detect or produce events relevant for the administrator of the system. For example, an external monitoring tool may be able to detect that a file system is full inside the guest operating system of a virtual machine. This event can be added to the internal audit log sending a request like this: [source] ---- POST /ovirt-engine/api/events <event> <description>File system /home is full</description> <severity>alert</severity> <origin>mymonitor</origin> <custom_id>1467879754</custom_id> </event> ---- Events can also be linked to specific objects. For example, the above event could be linked to the specific virtual machine where it happened, using the `vm` link: [source] ---- POST /ovirt-engine/api/events <event> <description>File system /home is full</description> <severity>alert</severity> <origin>mymonitor</origin> <custom_id>1467879754</custom_id> <vm id="aae98225-5b73-490d-a252-899209af17e9"/> </event> ---- NOTE: When using links, like the `vm` in the previous example, only the `id` attribute is accepted. The `name` attribute, if provided, is simply ignored. <div class="paragraph"> <p>Adds an external event to the internal audit log.</p> </div> <div class="paragraph"> <p>This is intended for integration with external systems that detect or produce events relevant for the administrator of the system. For example, an external monitoring tool may be able to detect that a file system is full inside the guest operating system of a virtual machine. This event can be added to the internal audit log sending a request like this:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code>POST /ovirt-engine/api/events &lt;event&gt; &lt;description&gt;File system /home is full&lt;/description&gt; &lt;severity&gt;alert&lt;/severity&gt; &lt;origin&gt;mymonitor&lt;/origin&gt; &lt;custom_id&gt;1467879754&lt;/custom_id&gt; &lt;/event&gt;</code></pre> </div> </div> <div class="paragraph"> <p>Events can also be linked to specific objects. For example, the above event could be linked to the specific virtual machine where it happened, using the <code>vm</code> link:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code>POST /ovirt-engine/api/events &lt;event&gt; &lt;description&gt;File system /home is full&lt;/description&gt; &lt;severity&gt;alert&lt;/severity&gt; &lt;origin&gt;mymonitor&lt;/origin&gt; &lt;custom_id&gt;1467879754&lt;/custom_id&gt; &lt;vm id="aae98225-5b73-490d-a252-899209af17e9"/&gt; &lt;/event&gt;</code></pre> </div> </div> <div class="admonitionblock note"> <table> <tr> <td class="icon"> <div class="title">Note</div> </td> <td class="content"> When using links, like the <code>vm</code> in the previous example, only the <code>id</code> attribute is accepted. The <code>name</code> attribute, if provided, is simply ignored. </td> </tr> </table> </div> author value Juan Hernandez <juan.hernandez@redhat.com> date value 7 Jul 2016 status value added add event true true event Get list of events. [source] ---- GET /ovirt-engine/api/events ---- To the above request we get following reponse: [source,xml] ---- <events> <event href="/ovirt-engine/api/events/2" id="2"> <description>User admin@internal-authz logged out.</description> <code>31</code> <correlation_id>1e892ea9</correlation_id> <custom_id>-1</custom_id> <flood_rate>30</flood_rate> <origin>oVirt</origin> <severity>normal</severity> <time>2016-09-14T12:14:34.541+02:00</time> <user href="/ovirt-engine/api/users/57d91d48-00da-0137-0138-000000000244" id="57d91d48-00da-0137-0138-000000000244"/> </event> <event href="/ovirt-engine/api/events/1" id="1"> <description>User admin logged in.</description> <code>30</code> <correlation_id>1fbd81f4</correlation_id> <custom_id>-1</custom_id> <flood_rate>30</flood_rate> <origin>oVirt</origin> <severity>normal</severity> <time>2016-09-14T11:54:35.229+02:00</time> <user href="/ovirt-engine/api/users/57d91d48-00da-0137-0138-000000000244" id="57d91d48-00da-0137-0138-000000000244"/> </event> </events> ---- The following events occur: * id="1" - The API logs in the admin user account. * id="2" - The API logs out of the admin user account. <div class="paragraph"> <p>Get list of events.</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code>GET /ovirt-engine/api/events</code></pre> </div> </div> <div class="paragraph"> <p>To the above request we get following reponse:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-xml" data-lang="xml">&lt;events&gt; &lt;event href="/ovirt-engine/api/events/2" id="2"&gt; &lt;description&gt;User admin@internal-authz logged out.&lt;/description&gt; &lt;code&gt;31&lt;/code&gt; &lt;correlation_id&gt;1e892ea9&lt;/correlation_id&gt; &lt;custom_id&gt;-1&lt;/custom_id&gt; &lt;flood_rate&gt;30&lt;/flood_rate&gt; &lt;origin&gt;oVirt&lt;/origin&gt; &lt;severity&gt;normal&lt;/severity&gt; &lt;time&gt;2016-09-14T12:14:34.541+02:00&lt;/time&gt; &lt;user href="/ovirt-engine/api/users/57d91d48-00da-0137-0138-000000000244" id="57d91d48-00da-0137-0138-000000000244"/&gt; &lt;/event&gt; &lt;event href="/ovirt-engine/api/events/1" id="1"&gt; &lt;description&gt;User admin logged in.&lt;/description&gt; &lt;code&gt;30&lt;/code&gt; &lt;correlation_id&gt;1fbd81f4&lt;/correlation_id&gt; &lt;custom_id&gt;-1&lt;/custom_id&gt; &lt;flood_rate&gt;30&lt;/flood_rate&gt; &lt;origin&gt;oVirt&lt;/origin&gt; &lt;severity&gt;normal&lt;/severity&gt; &lt;time&gt;2016-09-14T11:54:35.229+02:00&lt;/time&gt; &lt;user href="/ovirt-engine/api/users/57d91d48-00da-0137-0138-000000000244" id="57d91d48-00da-0137-0138-000000000244"/&gt; &lt;/event&gt; &lt;/events&gt;</code></pre> </div> </div> <div class="paragraph"> <p>The following events occur:</p> </div> <div class="ulist"> <ul> <li> <p>id="1" - The API logs in the admin user account.</p> </li> <li> <p>id="2" - The API logs out of the admin user account.</p> </li> </ul> </div> author value Piotr Kliczewski <pkliczew@redhat.com> date value 14 Sep 2016 status value added list events false false event[] Indicates the identifier of the the first event that should be returned. The identifiers of events are strictly increasing, so when this parameter is used only the events with that identifiers equal or greater than the given value will be returned. For example, the following request will return only the events with identifiers greater or equal than `123`: [source] ---- GET /ovirt-engine/api/events?from=123 ---- This parameter is optional, and if not specified then the first event returned will be most recently generated. <div class="paragraph"> <p>Indicates the identifier of the the first event that should be returned. The identifiers of events are strictly increasing, so when this parameter is used only the events with that identifiers equal or greater than the given value will be returned. For example, the following request will return only the events with identifiers greater or equal than <code>123</code>:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code>GET /ovirt-engine/api/events?from=123</code></pre> </div> </div> <div class="paragraph"> <p>This parameter is optional, and if not specified then the first event returned will be most recently generated.</p> </div> author value Juan Hernandez <juan.hernandez@redhat.com> date value 6 Jul 2016 status value added from true true integer Sets the maximum number of events to return. If not specified all the events are returned. <div class="paragraph"> <p>Sets the maximum number of events to return. If not specified all the events are returned.</p> </div> max true true integer The events service provides search queries similar to other resource services. We can search by providing specific severity. [source] ---- GET /ovirt-engine/api/events?search=severity%3Dnormal ---- To the above request we get a list of events which severity is equal to `normal`: [source,xml] ---- <events> <event href="/ovirt-engine/api/events/2" id="2"> <description>User admin@internal-authz logged out.</description> <code>31</code> <correlation_id>1fbd81f4</correlation_id> <custom_id>-1</custom_id> <flood_rate>30</flood_rate> <origin>oVirt</origin> <severity>normal</severity> <time>2016-09-14T11:54:35.229+02:00</time> <user href="/ovirt-engine/api/users/57d91d48-00da-0137-0138-000000000244" id="57d91d48-00da-0137-0138-000000000244"/> </event> <event href="/ovirt-engine/api/events/1" id="1"> <description>Affinity Rules Enforcement Manager started.</description> <code>10780</code> <custom_id>-1</custom_id> <flood_rate>30</flood_rate> <origin>oVirt</origin> <severity>normal</severity> <time>2016-09-14T11:52:18.861+02:00</time> </event> </events> ---- A virtualization environment generates a large amount of events after a period of time. However, the API only displays a default number of events for one search query. To display more than the default, the API separates results into pages with the page command in a search query. The following search query tells the API to paginate results using a page value in combination with the sortby clause: [source] ---- sortby time asc page 1 ---- Below example paginates event resources. The URL-encoded request is: [source] ---- GET /ovirt-engine/api/events?search=sortby%20time%20asc%20page%201 ---- Increase the page value to view the next page of results. [source] ---- GET /ovirt-engine/api/events?search=sortby%20time%20asc%20page%202 ---- <div class="paragraph"> <p>The events service provides search queries similar to other resource services.</p> </div> <div class="paragraph"> <p>We can search by providing specific severity.</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code>GET /ovirt-engine/api/events?search=severity%3Dnormal</code></pre> </div> </div> <div class="paragraph"> <p>To the above request we get a list of events which severity is equal to <code>normal</code>:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-xml" data-lang="xml">&lt;events&gt; &lt;event href="/ovirt-engine/api/events/2" id="2"&gt; &lt;description&gt;User admin@internal-authz logged out.&lt;/description&gt; &lt;code&gt;31&lt;/code&gt; &lt;correlation_id&gt;1fbd81f4&lt;/correlation_id&gt; &lt;custom_id&gt;-1&lt;/custom_id&gt; &lt;flood_rate&gt;30&lt;/flood_rate&gt; &lt;origin&gt;oVirt&lt;/origin&gt; &lt;severity&gt;normal&lt;/severity&gt; &lt;time&gt;2016-09-14T11:54:35.229+02:00&lt;/time&gt; &lt;user href="/ovirt-engine/api/users/57d91d48-00da-0137-0138-000000000244" id="57d91d48-00da-0137-0138-000000000244"/&gt; &lt;/event&gt; &lt;event href="/ovirt-engine/api/events/1" id="1"&gt; &lt;description&gt;Affinity Rules Enforcement Manager started.&lt;/description&gt; &lt;code&gt;10780&lt;/code&gt; &lt;custom_id&gt;-1&lt;/custom_id&gt; &lt;flood_rate&gt;30&lt;/flood_rate&gt; &lt;origin&gt;oVirt&lt;/origin&gt; &lt;severity&gt;normal&lt;/severity&gt; &lt;time&gt;2016-09-14T11:52:18.861+02:00&lt;/time&gt; &lt;/event&gt; &lt;/events&gt;</code></pre> </div> </div> <div class="paragraph"> <p>A virtualization environment generates a large amount of events after a period of time. However, the API only displays a default number of events for one search query. To display more than the default, the API separates results into pages with the page command in a search query. The following search query tells the API to paginate results using a page value in combination with the sortby clause:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code>sortby time asc page 1</code></pre> </div> </div> <div class="paragraph"> <p>Below example paginates event resources. The URL-encoded request is:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code>GET /ovirt-engine/api/events?search=sortby%20time%20asc%20page%201</code></pre> </div> </div> <div class="paragraph"> <p>Increase the page value to view the next page of results.</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code>GET /ovirt-engine/api/events?search=sortby%20time%20asc%20page%202</code></pre> </div> </div> author value Piotr Kliczewski <pkliczew@redhat.com> date value 14 Sep 2016 status value added search true true string Indicates if the search performed using the `search` parameter should be performed taking case into account. The default value is `true`, which means that case is taken into account. If you want to search ignoring case set it to `false`. <div class="paragraph"> <p>Indicates if the search performed using the <code>search</code> parameter should be performed taking case into account. The default value is <code>true</code>, which means that case is taken into account. If you want to search ignoring case set it to <code>false</code>.</p> </div> case_sensitive true true boolean undelete Indicates if the un-delete should be performed asynchronously. <div class="paragraph"> <p>Indicates if the un-delete should be performed asynchronously.</p> </div> async true true boolean event event id false false string area value Virtualization vm_watchdog get watchdog false false watchdog update watchdog true true watchdog Indicates if the update should be performed asynchronously. <div class="paragraph"> <p>Indicates if the update should be performed asynchronously.</p> </div> async true true boolean remove Indicates if the remove should be performed asynchronously. <div class="paragraph"> <p>Indicates if the remove should be performed asynchronously.</p> </div> async true true boolean area value Storage attached_storage_domain This operation activates an attached storage domain. Once the storage domain is activated it is ready for use with the data center. [source] ---- POST /ovirt-engine/api/datacenters/123/storagedomains/456/activate ---- The activate action does not take any action specific parameters, so the request body should contain an empty `action`: [source,xml] ---- <action/> ---- <div class="paragraph"> <p>This operation activates an attached storage domain. Once the storage domain is activated it is ready for use with the data center.</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code>POST /ovirt-engine/api/datacenters/123/storagedomains/456/activate</code></pre> </div> </div> <div class="paragraph"> <p>The activate action does not take any action specific parameters, so the request body should contain an empty <code>action</code>:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-xml" data-lang="xml">&lt;action/&gt;</code></pre> </div> </div> author value Maor Lipchuk <mlipchuk@redhat.com> date value 14 Sep 2016 status value added activate Indicates if the activation should be performed asynchronously. <div class="paragraph"> <p>Indicates if the activation should be performed asynchronously.</p> </div> async true true boolean This operation deactivates an attached storage domain. Once the storage domain is deactivated it will not be used with the data center. [source] ---- POST /ovirt-engine/api/datacenters/123/storagedomains/456/deactivate ---- The deactivate action does not take any action specific parameters, so the request body should contain an empty `action`: [source,xml] ---- <action/> ---- <div class="paragraph"> <p>This operation deactivates an attached storage domain. Once the storage domain is deactivated it will not be used with the data center.</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code>POST /ovirt-engine/api/datacenters/123/storagedomains/456/deactivate</code></pre> </div> </div> <div class="paragraph"> <p>The deactivate action does not take any action specific parameters, so the request body should contain an empty <code>action</code>:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-xml" data-lang="xml">&lt;action/&gt;</code></pre> </div> </div> author value Maor Lipchuk <mlipchuk@redhat.com> date value 14 Sep 2016 status value added deactivate Indicates if the deactivation should be performed asynchronously. <div class="paragraph"> <p>Indicates if the deactivation should be performed asynchronously.</p> </div> async true true boolean get storage_domain false false storage_domain remove Indicates if the remove should be performed asynchronously. <div class="paragraph"> <p>Indicates if the remove should be performed asynchronously.</p> </div> async true true boolean disks disks area value Storage attached_storage_domains add storage_domain true true storage_domain list storage_domains false false storage_domain[] Sets the maximum number of storage domains to return. If not specified all the storage domains are returned. <div class="paragraph"> <p>Sets the maximum number of storage domains to return. If not specified all the storage domains are returned.</p> </div> max true true integer storage_domain attached_storage_domain id false false string area value Virtualization instance_type_watchdog get watchdog false false watchdog update watchdog true true watchdog Indicates if the update should be performed asynchronously. <div class="paragraph"> <p>Indicates if the update should be performed asynchronously.</p> </div> async true true boolean remove Indicates if the remove should be performed asynchronously. <div class="paragraph"> <p>Indicates if the remove should be performed asynchronously.</p> </div> async true true boolean area value SLA quota_storage_limit get limit false false quota_storage_limit remove Indicates if the update should be performed asynchronously. <div class="paragraph"> <p>Indicates if the update should be performed asynchronously.</p> </div> async true true boolean area value Infrastructure role get role false false role Removes the role. To remove the role you need to know its id, then send request like this: [source] ---- DELETE /ovirt-engine/api/roles/{role_id} ---- <div class="paragraph"> <p>Removes the role.</p> </div> <div class="paragraph"> <p>To remove the role you need to know its id, then send request like this:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code>DELETE /ovirt-engine/api/roles/{role_id}</code></pre> </div> </div> author value Ondra Machacek <omachace@redhat.com> date value 14 Sep 2016 status value added remove Indicates if the remove should be performed asynchronously. <div class="paragraph"> <p>Indicates if the remove should be performed asynchronously.</p> </div> async true true boolean Updates a role. You are allowed to update `name`, `description` and `administrative` attributes after role is created. Within this endpoint you can't add or remove roles permits you need to use <<services/permits, service>> that manages permits of role. For example to update role's `name`, `description` and `administrative` attributes send a request like this: [source] ---- PUT /ovirt-engine/api/roles/123 ---- With a request body like this: [source,xml] ---- <role> <name>MyNewRoleName</name> <description>My new description of the role</description> <administrative>true</administrative> </group> ---- <div class="paragraph"> <p>Updates a role. You are allowed to update <code>name</code>, <code>description</code> and <code>administrative</code> attributes after role is created. Within this endpoint you can&#8217;t add or remove roles permits you need to use <a href="#services/permits">service</a> that manages permits of role.</p> </div> <div class="paragraph"> <p>For example to update role&#8217;s <code>name</code>, <code>description</code> and <code>administrative</code> attributes send a request like this:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code>PUT /ovirt-engine/api/roles/123</code></pre> </div> </div> <div class="paragraph"> <p>With a request body like this:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-xml" data-lang="xml">&lt;role&gt; &lt;name&gt;MyNewRoleName&lt;/name&gt; &lt;description&gt;My new description of the role&lt;/description&gt; &lt;administrative&gt;true&lt;/administrative&gt; &lt;/group&gt;</code></pre> </div> </div> author value Ondra Machacek <omachace@redhat.com> date value 14 Sep 2016 status value added update role true true role Indicates if the update should be performed asynchronously. <div class="paragraph"> <p>Indicates if the update should be performed asynchronously.</p> </div> async true true boolean permits permits area value Network assigned_network get network false false network remove Indicates if the remove should be performed asynchronously. <div class="paragraph"> <p>Indicates if the remove should be performed asynchronously.</p> </div> async true true boolean update network true true network Indicates if the update should be performed asynchronously. <div class="paragraph"> <p>Indicates if the update should be performed asynchronously.</p> </div> async true true boolean Returns the details of the disks attached to a virtual machine in the export domain. <div class="paragraph"> <p>Returns the details of the disks attached to a virtual machine in the export domain.</p> </div> area value Storage author value Tal Nisan <tnisan@redhat.com> date value 6 Sep 2016 status value added since value 4.0.4 storage_domain_vm_disk_attachment Returns the details of the attachment with all its properties and a link to the disk. <div class="paragraph"> <p>Returns the details of the attachment with all its properties and a link to the disk.</p> </div> author value Tal Nisan <tnisan@redhat.com> date value 6 Sep 2016 status value added since value 4.0.4 get The disk attachment. <div class="paragraph"> <p>The disk attachment.</p> </div> author value Tal Nisan <tnisan@redhat.com> date value 6 Sep 2016 status value added since value 4.0.4 attachment false false disk_attachment area value Network host_nics list nics false false host_nic[] Sets the maximum number of NICs to return. If not specified all the NICs are returned. <div class="paragraph"> <p>Sets the maximum number of NICs to return. If not specified all the NICs are returned.</p> </div> max true true integer nic host_nic id false false string area value SLA vm_numa_node get node false false virtual_numa_node Updates a virtual NUMA node. An example of pinning a virtual NUMA node to a physical NUMA node on the host: [source] ---- PUT /ovirt-engine/api/vms/123/numanodes/456 ---- The request body should contain the following: [source,xml] ---- <vm_numa_node> <numa_node_pins> <numa_node_pin> <host_numa_node id="789"/> <index>0</index> <pinned>true</pinned> </numa_node_pin> </numa_node_pins> </vm_numa_node> ---- <div class="paragraph"> <p>Updates a virtual NUMA node.</p> </div> <div class="paragraph"> <p>An example of pinning a virtual NUMA node to a physical NUMA node on the host:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code>PUT /ovirt-engine/api/vms/123/numanodes/456</code></pre> </div> </div> <div class="paragraph"> <p>The request body should contain the following:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-xml" data-lang="xml">&lt;vm_numa_node&gt; &lt;numa_node_pins&gt; &lt;numa_node_pin&gt; &lt;host_numa_node id="789"/&gt; &lt;index&gt;0&lt;/index&gt; &lt;pinned&gt;true&lt;/pinned&gt; &lt;/numa_node_pin&gt; &lt;/numa_node_pins&gt; &lt;/vm_numa_node&gt;</code></pre> </div> </div> author value Andrej Krejcir <akrejcir@redhat.com> date value 14 Sep 2016 status value added update node true true virtual_numa_node Indicates if the update should be performed asynchronously. <div class="paragraph"> <p>Indicates if the update should be performed asynchronously.</p> </div> async true true boolean Removes a virtual NUMA node. An example of removing a virtual NUMA node: [source] ---- DELETE /ovirt-engine/api/vms/123/numanodes/456 ---- <div class="paragraph"> <p>Removes a virtual NUMA node.</p> </div> <div class="paragraph"> <p>An example of removing a virtual NUMA node:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code>DELETE /ovirt-engine/api/vms/123/numanodes/456</code></pre> </div> </div> author value Andrej Krejcir <akrejcir@redhat.com> date value 14 Sep 2016 status value added remove Indicates if the remove should be performed asynchronously. <div class="paragraph"> <p>Indicates if the remove should be performed asynchronously.</p> </div> async true true boolean area value Virtualization template_cdroms list cdroms false false cdrom[] Sets the maximum number of CDROMs to return. If not specified all the CDROMs are returned. <div class="paragraph"> <p>Sets the maximum number of CDROMs to return. If not specified all the CDROMs are returned.</p> </div> max true true integer cdrom template_cdrom id false false string area value Storage snapshot get snapshot false false snapshot remove Indicates if the remove should be performed asynchronously. <div class="paragraph"> <p>Indicates if the remove should be performed asynchronously.</p> </div> async true true boolean Restores a virtual machine snapshot. For example, to restore the snapshot with identifier `456` of virtual machine with identifier `123` send a request like this: [source] ---- POST /ovirt-engine/api/vms/123/snapshots/456/restore ---- With an empty `action` in the body: [source,xml] ---- <action/> ---- <div class="paragraph"> <p>Restores a virtual machine snapshot.</p> </div> <div class="paragraph"> <p>For example, to restore the snapshot with identifier <code>456</code> of virtual machine with identifier <code>123</code> send a request like this:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code>POST /ovirt-engine/api/vms/123/snapshots/456/restore</code></pre> </div> </div> <div class="paragraph"> <p>With an empty <code>action</code> in the body:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-xml" data-lang="xml">&lt;action/&gt;</code></pre> </div> </div> author value Daniel Erez <derez@redhat.com> date value 14 Sep 2016 status value added restore disks true true disk[] restore_memory true true boolean Indicates if the restore should be performed asynchronously. <div class="paragraph"> <p>Indicates if the restore should be performed asynchronously.</p> </div> async true true boolean cdroms snapshot_cdroms disks snapshot_disks nics snapshot_nics area value SLA scheduling_policies add policy true true scheduling_policy list policies false false scheduling_policy[] Sets the maximum number of policies to return. If not specified all the policies are returned. <div class="paragraph"> <p>Sets the maximum number of policies to return. If not specified all the policies are returned.</p> </div> max true true integer Indicates if the results should be filtered according to the permissions of the user. <div class="paragraph"> <p>Indicates if the results should be filtered according to the permissions of the user.</p> </div> filter true true boolean policy scheduling_policy id false false string area value SLA weights add weight true true weight list weights false false weight[] Sets the maximum number of weights to return. If not specified all the weights are returned. <div class="paragraph"> <p>Sets the maximum number of weights to return. If not specified all the weights are returned.</p> </div> max true true integer Indicates if the results should be filtered according to the permissions of the user. <div class="paragraph"> <p>Indicates if the results should be filtered according to the permissions of the user.</p> </div> filter true true boolean weight weight id false false string area value Virtualization vm_host_devices add device true true host_device list device false false host_device[] Sets the maximum number of devices to return. If not specified all the devices are returned. <div class="paragraph"> <p>Sets the maximum number of devices to return. If not specified all the devices are returned.</p> </div> max true true integer device vm_host_device id false false string area value Virtualization assigned_cpu_profile get profile false false cpu_profile remove Indicates if the remove should be performed asynchronously. <div class="paragraph"> <p>Indicates if the remove should be performed asynchronously.</p> </div> async true true boolean area value Network snapshot_nic get nic false false nic area value Virtualization host_device get device false false host_device This service manages image transfers, for performing Image I/O API in oVirt. Please refer to <<services/image_transfer, image transfer>> for further documentation. <div class="paragraph"> <p>This service manages image transfers, for performing Image I/O API in oVirt. Please refer to <a href="#services/image_transfer">image transfer</a> for further documentation.</p> </div> area value Storage author value Amit Aviram <aaviram@redhat.com> date value 30 Aug 2016 status value added since value 4.0.4 image_transfers Add a new image transfer. An image needs to be specified in order to make a new transfer. <div class="paragraph"> <p>Add a new image transfer. An image needs to be specified in order to make a new transfer.</p> </div> author value Amit Aviram <aaviram@redhat.com> date value 30 Aug 2016 status value added since value 4.0.4 add image_transfer true true image_transfer Retrieves the list of image transfers that are currently being performed. <div class="paragraph"> <p>Retrieves the list of image transfers that are currently being performed.</p> </div> author value Amit Aviram <aaviram@redhat.com> date value 30 Aug 2016 status value added since value 4.0.4 list image_transfer false false image_transfer[] Returns a reference to the service that manages an specific image transfer. <div class="paragraph"> <p>Returns a reference to the service that manages an specific image transfer.</p> </div> author value Amit Aviram <aaviram@redhat.com> date value 30 Aug 2016 status value added since value 4.0.4 image_transfer image_transfer id false false string area value Infrastructure external_provider import_certificates certificates true true certificate[] test_connectivity Indicates if the test should be performed asynchronously. <div class="paragraph"> <p>Indicates if the test should be performed asynchronously.</p> </div> async true true boolean certificates external_provider_certificates area value Infrastructure event get event false false event Removes an event from internal audit log. An event can be removed by sending following request [source] ---- DELETE /ovirt-engine/api/events/123 ---- <div class="paragraph"> <p>Removes an event from internal audit log.</p> </div> <div class="paragraph"> <p>An event can be removed by sending following request</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code>DELETE /ovirt-engine/api/events/123</code></pre> </div> </div> author value Piotr Kliczewski <pkliczew@redhat.com> date value 14 Sep 2016 status value added remove Indicates if the remove should be performed asynchronously. <div class="paragraph"> <p>Indicates if the remove should be performed asynchronously.</p> </div> async true true boolean area value Virtualization graphics_consoles add console true true graphics_console Lists all the configured graphics consoles of the virtual machine. <div class="paragraph"> <p>Lists all the configured graphics consoles of the virtual machine.</p> </div> author value Tomas Jelinek <tjelinek@redhat.com> date value 8 Jul 2016 status value added list consoles false false graphics_console[] Sets the maximum number of consoles to return. If not specified all the consoles are returned. <div class="paragraph"> <p>Sets the maximum number of consoles to return. If not specified all the consoles are returned.</p> </div> max true true integer Use the following query to obtain the current run-time configuration of the graphics consoles. [source] ---- GET /ovit-engine/api/vms/{vm:id}/graphicsconsoles?current=true ---- The default value is `false`. <div class="paragraph"> <p>Use the following query to obtain the current run-time configuration of the graphics consoles.</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code>GET /ovit-engine/api/vms/{vm:id}/graphicsconsoles?current=true</code></pre> </div> </div> <div class="paragraph"> <p>The default value is <code>false</code>.</p> </div> author value Tomas Jelinek <tjelinek@redhat.com> date value 8 Jul 2016 status value added current true true boolean console graphics_console id false false string Represents a readonly network filters sub-collection. The network filter enables to filter packets send to/from the VM's nic according to defined rules. For more information please refer to <<services/network_filter,NetworkFilter>> service documentation Network filters are supported in different versions, starting from version 3.0. A network filter is defined for each vnic profile. A vnic profile is defined for a specific network. A network can be assigned to several different clusters. In the future, each network will be defined in cluster level. Currently, each network is being defined at data center level. Potential network filters for each network are determined by the network's data center compatibility version V. V must be >= the network filter version in order to configure this network filter for a specific network. Please note, that if a network is assigned to cluster with a version supporting a network filter, the filter may not be available due to the data center version being smaller then the network filter's version. Example of listing all of the supported network filters for a specific cluster: [source] ---- GET http://localhost:8080/ovirt-engine/api/clusters/{cluster:id}/networkfilters ---- Output: [source,xml] ---- <network_filters> <network_filter id="00000019-0019-0019-0019-00000000026c"> <name>example-network-filter-a</name> <version> <major>4</major> <minor>0</minor> <build>-1</build> <revision>-1</revision> </version> </network_filter> <network_filter id="00000019-0019-0019-0019-00000000026b"> <name>example-network-filter-b</name> <version> <major>4</major> <minor>0</minor> <build>-1</build> <revision>-1</revision> </version> </network_filter> <network_filter id="00000019-0019-0019-0019-00000000026a"> <name>example-network-filter-a</name> <version> <major>3</major> <minor>0</minor> <build>-1</build> <revision>-1</revision> </version> </network_filter> </network_filters> ---- <div class="paragraph"> <p>Represents a readonly network filters sub-collection.</p> </div> <div class="paragraph"> <p>The network filter enables to filter packets send to/from the VM&#8217;s nic according to defined rules. For more information please refer to <a href="#services/network_filter">NetworkFilter</a> service documentation</p> </div> <div class="paragraph"> <p>Network filters are supported in different versions, starting from version 3.0.</p> </div> <div class="paragraph"> <p>A network filter is defined for each vnic profile.</p> </div> <div class="paragraph"> <p>A vnic profile is defined for a specific network.</p> </div> <div class="paragraph"> <p>A network can be assigned to several different clusters. In the future, each network will be defined in cluster level.</p> </div> <div class="paragraph"> <p>Currently, each network is being defined at data center level. Potential network filters for each network are determined by the network&#8217;s data center compatibility version V. V must be &gt;= the network filter version in order to configure this network filter for a specific network. Please note, that if a network is assigned to cluster with a version supporting a network filter, the filter may not be available due to the data center version being smaller then the network filter&#8217;s version.</p> </div> <div class="paragraph"> <p>Example of listing all of the supported network filters for a specific cluster:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code>GET http://localhost:8080/ovirt-engine/api/clusters/{cluster:id}/networkfilters</code></pre> </div> </div> <div class="paragraph"> <p>Output:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-xml" data-lang="xml">&lt;network_filters&gt; &lt;network_filter id="00000019-0019-0019-0019-00000000026c"&gt; &lt;name&gt;example-network-filter-a&lt;/name&gt; &lt;version&gt; &lt;major&gt;4&lt;/major&gt; &lt;minor&gt;0&lt;/minor&gt; &lt;build&gt;-1&lt;/build&gt; &lt;revision&gt;-1&lt;/revision&gt; &lt;/version&gt; &lt;/network_filter&gt; &lt;network_filter id="00000019-0019-0019-0019-00000000026b"&gt; &lt;name&gt;example-network-filter-b&lt;/name&gt; &lt;version&gt; &lt;major&gt;4&lt;/major&gt; &lt;minor&gt;0&lt;/minor&gt; &lt;build&gt;-1&lt;/build&gt; &lt;revision&gt;-1&lt;/revision&gt; &lt;/version&gt; &lt;/network_filter&gt; &lt;network_filter id="00000019-0019-0019-0019-00000000026a"&gt; &lt;name&gt;example-network-filter-a&lt;/name&gt; &lt;version&gt; &lt;major&gt;3&lt;/major&gt; &lt;minor&gt;0&lt;/minor&gt; &lt;build&gt;-1&lt;/build&gt; &lt;revision&gt;-1&lt;/revision&gt; &lt;/version&gt; &lt;/network_filter&gt; &lt;/network_filters&gt;</code></pre> </div> </div> area value Network network_filters Retrieves the representations of the network filters. <div class="paragraph"> <p>Retrieves the representations of the network filters.</p> </div> list filters false false network_filter[] network_filter network_filter id false false string area value Infrastructure statistic get statistic true true statistic Provides capability to import external virtual machines. <div class="paragraph"> <p>Provides capability to import external virtual machines.</p> </div> area value Virtualization author value Martin Betak <mbetak@redhat.com> date value 27 Jul 2016 status value added since value 4.0.4 external_vm_imports This operation is used to import a virtual machine from external hypervisor, such as KVM, XEN or VMware. For example import of a virtual machine from VMware can be facilitated using the following request: [source] ---- POST /externalvmimports ---- With request body of type <<types/external_vm_import,ExternalVmImport>>, for example: [source,xml] ---- <external_vm_import> <vm> <name>my_vm</name> </vm> <cluster id="360014051136c20574f743bdbd28177fd" /> <storage_domain id="8bb5ade5-e988-4000-8b93-dbfc6717fe50" /> <name>vm_name_as_is_in_vmware</name> <sparse>true</sparse> <username>vmware_user</username> <password>123456</password> <provider>VMWARE</provider> <url>vpx://wmware_user@vcenter-host/DataCenter/Cluster/esxi-host?no_verify=1</url> <drivers_iso id="virtio-win-1.6.7.iso" /> </external_vm_import> ---- <div class="paragraph"> <p>This operation is used to import a virtual machine from external hypervisor, such as KVM, XEN or VMware.</p> </div> <div class="paragraph"> <p>For example import of a virtual machine from VMware can be facilitated using the following request:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code>POST /externalvmimports</code></pre> </div> </div> <div class="paragraph"> <p>With request body of type <a href="#types/external_vm_import">ExternalVmImport</a>, for example:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-xml" data-lang="xml">&lt;external_vm_import&gt; &lt;vm&gt; &lt;name&gt;my_vm&lt;/name&gt; &lt;/vm&gt; &lt;cluster id="360014051136c20574f743bdbd28177fd" /&gt; &lt;storage_domain id="8bb5ade5-e988-4000-8b93-dbfc6717fe50" /&gt; &lt;name&gt;vm_name_as_is_in_vmware&lt;/name&gt; &lt;sparse&gt;true&lt;/sparse&gt; &lt;username&gt;vmware_user&lt;/username&gt; &lt;password&gt;123456&lt;/password&gt; &lt;provider&gt;VMWARE&lt;/provider&gt; &lt;url&gt;vpx://wmware_user@vcenter-host/DataCenter/Cluster/esxi-host?no_verify=1&lt;/url&gt; &lt;drivers_iso id="virtio-win-1.6.7.iso" /&gt; &lt;/external_vm_import&gt;</code></pre> </div> </div> author value Martin Betak <mbetak@redhat.com> date value 27 Jul 2016 status value added since value 4.0 add import true true external_vm_import Represents a roles sub-collection, for example scoped by user. <div class="paragraph"> <p>Represents a roles sub-collection, for example scoped by user.</p> </div> area value Infrastructure assigned_roles list roles false false role[] Sets the maximum number of roles to return. If not specified all the roles are returned. <div class="paragraph"> <p>Sets the maximum number of roles to return. If not specified all the roles are returned.</p> </div> max true true integer Sub-resource locator method, returns individual role resource on which the remainder of the URI is dispatched. <div class="paragraph"> <p>Sub-resource locator method, returns individual role resource on which the remainder of the URI is dispatched.</p> </div> role role id false false string area value Storage openstack_image_provider import_certificates certificates true true certificate[] test_connectivity Indicates if the test should be performed asynchronously. <div class="paragraph"> <p>Indicates if the test should be performed asynchronously.</p> </div> async true true boolean get provider false false open_stack_image_provider update provider true true open_stack_image_provider Indicates if the update should be performed asynchronously. <div class="paragraph"> <p>Indicates if the update should be performed asynchronously.</p> </div> async true true boolean remove Indicates if the remove should be performed asynchronously. <div class="paragraph"> <p>Indicates if the remove should be performed asynchronously.</p> </div> async true true boolean certificates external_provider_certificates images openstack_images area value Network openstack_network get network false false open_stack_network This operation imports an external network into oVirt. The network will be added to the data center specified. <div class="paragraph"> <p>This operation imports an external network into oVirt. The network will be added to the data center specified.</p> </div> import The data center into which the network is to be imported. Data center is mandatory, and can be specified using the `id` or `name` attributes, the rest of the attributes will be ignored. <div class="paragraph"> <p>The data center into which the network is to be imported. Data center is mandatory, and can be specified using the <code>id</code> or <code>name</code> attributes, the rest of the attributes will be ignored.</p> </div> data_center true true data_center Indicates if the import should be performed asynchronously. <div class="paragraph"> <p>Indicates if the import should be performed asynchronously.</p> </div> async true true boolean subnets openstack_subnets area value Storage openstack_image_providers add provider true true open_stack_image_provider list providers false false open_stack_image_provider[] Sets the maximum number of providers to return. If not specified all the providers are returned. <div class="paragraph"> <p>Sets the maximum number of providers to return. If not specified all the providers are returned.</p> </div> max true true integer provider openstack_image_provider id false false string area value Storage openstack_volume_authentication_key get key false false openstack_volume_authentication_key update key true true openstack_volume_authentication_key remove Indicates if the remove should be performed asynchronously. <div class="paragraph"> <p>Indicates if the remove should be performed asynchronously.</p> </div> async true true boolean area value Storage openstack_images Lists the images of a Glance image storage domain. <div class="paragraph"> <p>Lists the images of a Glance image storage domain.</p> </div> author value Daniel Erez <derez@redhat.com> date value 14 Sep 2016 status value added list images false false open_stack_image[] Sets the maximum number of images to return. If not specified all the images are returned. <div class="paragraph"> <p>Sets the maximum number of images to return. If not specified all the images are returned.</p> </div> max true true integer Returns a reference to the service that manages a specific image. <div class="paragraph"> <p>Returns a reference to the service that manages a specific image.</p> </div> author value @author Daniel Erez <derez@redhat.com> date value 14 Sep 2016 status value added image openstack_image id false false string area value Network openstack_network_providers The operation adds a new network provider to the system. If the `type` property is not present, a default value of `NEUTRON` will be used. <div class="paragraph"> <p>The operation adds a new network provider to the system. If the <code>type</code> property is not present, a default value of <code>NEUTRON</code> will be used.</p> </div> add provider true true open_stack_network_provider list providers false false open_stack_network_provider[] Sets the maximum number of providers to return. If not specified all the providers are returned. <div class="paragraph"> <p>Sets the maximum number of providers to return. If not specified all the providers are returned.</p> </div> max true true integer provider openstack_network_provider id false false string area value Storage openstack_volume_providers Adds a new volume provider. For example: [source] ---- POST /ovirt-engine/api/openstackvolumeproviders ---- With a request body like this: [source,xml] ---- <openstack_volume_provider> <name>mycinder</name> <url>https://mycinder.example.com:8776</url> <data_center> <name>mydc</name> </data_center> <requires_authentication>true</requires_authentication> <username>admin</username> <password>mypassword</password> <tenant_name>mytenant</tenant_name> </openstack_volume_provider> ---- <div class="paragraph"> <p>Adds a new volume provider.</p> </div> <div class="paragraph"> <p>For example:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code>POST /ovirt-engine/api/openstackvolumeproviders</code></pre> </div> </div> <div class="paragraph"> <p>With a request body like this:</p> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-xml" data-lang="xml">&lt;openstack_volume_provider&gt; &lt;name&gt;mycinder&lt;/name&gt; &lt;url&gt;https://mycinder.example.com:8776&lt;/url&gt; &lt;data_center&gt; &lt;name&gt;mydc&lt;/name&gt; &lt;/data_center&gt; &lt;requires_authentication&gt;true&lt;/requires_authentication&gt; &lt;us