org.ovirt.engine.sdk.decorators

Class VMs

java.lang.Object

org.ovirt.engine.sdk.common.Decorator

org.ovirt.engine.sdk.common.CollectionDecorator<VM,VMs,VM>

org.ovirt.engine.sdk.decorators.VMs

public class VMs
extends CollectionDecorator<VM,VMs,VM>

VMs providing relation and functional services

to VMs.

Constructor Summary

Constructors

Constructor and Description
VMs(HttpProxyBroker proxy)

Method Summary

Modifier and Type	Method and Description
VM	add(VM vm) Adds VM object.
VM	add(VM vm, String correlationId) Adds VM object.
VM	add(VM vm, String correlationId, String expect) Adds VM object.
VM	get(UUID id) Fetches VM object by id.
VM	getById(String id) Fetches VM object by id.
List<VM>	list() Lists VM objects.
List<VM>	list(String query, Boolean caseSensitive, Integer max) Lists VM objects.
List<VM>	list(String query, Boolean caseSensitive, Integer max, String allContent) Lists VM objects.

Methods inherited from class org.ovirt.engine.sdk.common.CollectionDecorator

get

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VMs

public VMs(HttpProxyBroker proxy)

Parameters:

proxy - HttpProxyBroker

Method Detail

list

public List<VM> list()
              throws org.apache.http.client.ClientProtocolException,
                     ServerException,
                     IOException

Lists VM objects.

Specified by:

list in class CollectionDecorator<VM,VMs,VM>

Returns:

List of VM

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

get

public VM get(UUID id)
       throws org.apache.http.client.ClientProtocolException,
              ServerException,
              IOException

Fetches VM object by id.

Specified by:

get in class CollectionDecorator<VM,VMs,VM>

Parameters:

id - entity id

Returns:

VM

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

getById

public VM getById(String id)
           throws org.apache.http.client.ClientProtocolException,
                  ServerException,
                  IOException

Fetches VM object by id.

Specified by:

getById in class CollectionDecorator<VM,VMs,VM>

Parameters:

id - entity id

Returns:

VM

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

list

public List<VM> list(String query,
                     Boolean caseSensitive,
                     Integer max)
              throws org.apache.http.client.ClientProtocolException,
                     ServerException,
                     IOException

Lists VM objects.

Parameters:

query -

    [search query]
    

caseSensitive -

    [true|false]
    

max -

    [max results]
    

Returns:

List of VM

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

list

public List<VM> list(String query,
                     Boolean caseSensitive,
                     Integer max,
                     String allContent)
              throws org.apache.http.client.ClientProtocolException,
                     ServerException,
                     IOException

Lists VM objects.

Parameters:

allContent -

    [true|false]
    

query -

    [search query]
    

caseSensitive -

    [true|false]
    

max -

    [max results]
    

Returns:

List of VM

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

add

public VM add(VM vm)
       throws org.apache.http.client.ClientProtocolException,
              ServerException,
              IOException

Adds VM object.

Parameters:

vm - VM

    Overload 1:

      add a virtual machine to the
      system from scratch

      vm.name
      vm.template.id|name
      vm.cluster.id|name
      [vm.instance_type.id|name]
      [vm.quota.id]
      [vm.timezone]
      [vm.os.boot]
      [vm.custom_properties.custom_property]
      [vm.os.type]
      [vm.usb.enabled]
      [vm.usb.type]
      [vm.type]
      [vm.os.initRd]
      [vm.display.monitors]
      [vm.display.single_qxl_pci]
      [vm.display.type]
      [vm.display.allow_override]
      [vm.display.smartcard_enabled]
      [vm.display.file_transfer_enabled]
      [vm.display.copy_paste_enabled]
      [vm.display.keyboard_layout]
      [vm.os.cmdline]
      [vm.cpu.topology.cores]
      [vm.cpu.architecture]
      [vm.memory]
      [vm.memory_policy.guaranteed]
      [vm.memory_policy.ballooning]
      [vm.high_availability.priority]
      [vm.high_availability.enabled]
      [vm.domain.name]
      [vm.description]
      [vm.comment]
      [vm.stateless]
      [vm.permissions.clone]
      [vm.delete_protected]
      [vm.sso.methods.method]
      [vm.rng_device.rate.bytes]
      [vm.rng_device.rate.period]
      [vm.rng_device.source]
      [vm.console.enabled]
      [vm.cpu.mode]
      [vm.cpu.topology.sockets]
      [vm.cpu_shares]
      [vm.placement_policy.affinity]
      [vm.placement_policy.host.id|name]
      [vm.origin]
      [vm.os.kernel]
      [vm.disks.clone]
      [vm.disks.disk]
      [vm.tunnel_migration]
      [vm.migration_downtime]
      [vm.virtio_scsi.enabled]
      [vm.soundcard_enabled]
      [vm.payloads.payload]
      [vm.initialization.configuration.type]
      [vm.initialization.configuration.data]
      [vm.cpu.cpu_tune.vcpu_pin]
      [vm.use_latest_template_version]
      [vm.serial_number.policy]
      [vm.serial_number.value]
      [vm.bios.boot_menu.enabled]
      [vm.numa_tune_mode]
      [vm.cpu_profile.id]

    Overload 2:

      add a virtual machine to the
      system by cloning from a
      snapshot

      vm.name
      vm.template.id|name
      vm.cluster.id|name
      vm.snapshots.snapshot
      [vm.quota.id]
      [vm.timezone]
      [vm.os.boot]
      [vm.custom_properties.custom_property]
      [vm.os.type]
      [vm.usb.enabled]
      [vm.usb.type]
      [vm.type]
      [vm.os.initRd]
      [vm.display.monitors]
      [vm.display.single_qxl_pci]
      [vm.display.type]
      [vm.display.allow_override]
      [vm.display.smartcard_enabled]
      [vm.display.file_transfer_enabled]
      [vm.display.copy_paste_enabled]
      [vm.display.keyboard_layout]
      [vm.os.cmdline]
      [vm.cpu.topology.cores]
      [vm.cpu_shares]
      [vm.cpu.architecture]
      [vm.memory]
      [vm.memory_policy.guaranteed]
      [vm.memory_policy.ballooning]
      [vm.high_availability.priority]
      [vm.high_availability.enabled]
      [vm.domain.name]
      [vm.description]
      [vm.comment]
      [vm.stateless]
      [vm.delete_protected]
      [vm.sso.methods.method]
      [vm.rng_device.rate.bytes]
      [vm.rng_device.rate.period]
      [vm.rng_device.source]
      [vm.console.enabled]
      [vm.cpu.topology.sockets]
      [vm.placement_policy.affinity]
      [vm.placement_policy.host.id|name]
      [vm.origin]
      [vm.os.kernel]
      [vm.tunnel_migration]
      [vm.migration_downtime]
      [vm.virtio_scsi.enabled]
      [vm.soundcard_enabled]
      [vm.payloads.payload]
      [vm.cpu.cpu_tune.vcpu_pin]
      [vm.serial_number.policy]
      [vm.serial_number.value]
      [vm.bios.boot_menu.enabled]
      [vm.numa_tune_mode]
      [vm.cpu_profile.id]

    Overload 3:

      add a virtual machine to the
      system from a configuration -
      requires the configuration
      type and the configuration
      data

      vm.initialization.configuration.type
      vm.initialization.configuration.data
      [vm.name]
      [vm.quota.id]
      [vm.timezone]
      [vm.os.boot]
      [vm.custom_properties.custom_property]
      [vm.os.type]
      [vm.usb.enabled]
      [vm.usb.type]
      [vm.type]
      [vm.os.initRd]
      [vm.display.monitors]
      [vm.display.type]
      [vm.display.allow_override]
      [vm.display.smartcard_enabled]
      [vm.display.file_transfer_enabled]
      [vm.display.copy_paste_enabled]
      [vm.display.keyboard_layout]
      [vm.os.cmdline]
      [vm.cpu.topology.cores]
      [vm.memory]
      [vm.memory_policy.guaranteed]
      [vm.memory_policy.ballooning]
      [vm.high_availability.priority]
      [vm.high_availability.enabled]
      [vm.domain.name]
      [vm.description]
      [vm.comment]
      [vm.stateless]
      [vm.permissions.clone]
      [vm.delete_protected]
      [vm.sso.methods.method]
      [vm.rng_device.rate.bytes]
      [vm.rng_device.rate.period]
      [vm.rng_device.source]
      [vm.cpu.mode]
      [vm.cpu.topology.sockets]
      [vm.placement_policy.affinity]
      [vm.placement_policy.host.id|name]
      [vm.origin]
      [vm.os.kernel]
      [vm.disks.clone]
      [vm.disks.disk]
      [vm.tunnel_migration]
      [vm.migration_downtime]
      [vm.virtio_scsi.enabled]
      [vm.payloads.payload]
      [vm.initialization.configuration.type]
      [vm.initialization.configuration.data]
      [vm.initialization.regenerate_ids]
      [vm.cpu.cpu_tune.vcpu_pin]
      [vm.serial_number.policy]
      [vm.serial_number.value]
      [vm.bios.boot_menu.enabled]
      [vm.numa_tune_mode]
      [vm.cpu_profile.id]
    

Returns:

VM

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

add

public VM add(VM vm,
              String correlationId)
       throws org.apache.http.client.ClientProtocolException,
              ServerException,
              IOException

Adds VM object.

Parameters:

vm - VM

    Overload 1:

      add a virtual machine to the
      system from scratch

      vm.name
      vm.template.id|name
      vm.cluster.id|name
      [vm.instance_type.id|name]
      [vm.quota.id]
      [vm.timezone]
      [vm.os.boot]
      [vm.custom_properties.custom_property]
      [vm.os.type]
      [vm.usb.enabled]
      [vm.usb.type]
      [vm.type]
      [vm.os.initRd]
      [vm.display.monitors]
      [vm.display.single_qxl_pci]
      [vm.display.type]
      [vm.display.allow_override]
      [vm.display.smartcard_enabled]
      [vm.display.file_transfer_enabled]
      [vm.display.copy_paste_enabled]
      [vm.display.keyboard_layout]
      [vm.os.cmdline]
      [vm.cpu.topology.cores]
      [vm.cpu.architecture]
      [vm.memory]
      [vm.memory_policy.guaranteed]
      [vm.memory_policy.ballooning]
      [vm.high_availability.priority]
      [vm.high_availability.enabled]
      [vm.domain.name]
      [vm.description]
      [vm.comment]
      [vm.stateless]
      [vm.permissions.clone]
      [vm.delete_protected]
      [vm.sso.methods.method]
      [vm.rng_device.rate.bytes]
      [vm.rng_device.rate.period]
      [vm.rng_device.source]
      [vm.console.enabled]
      [vm.cpu.mode]
      [vm.cpu.topology.sockets]
      [vm.cpu_shares]
      [vm.placement_policy.affinity]
      [vm.placement_policy.host.id|name]
      [vm.origin]
      [vm.os.kernel]
      [vm.disks.clone]
      [vm.disks.disk]
      [vm.tunnel_migration]
      [vm.migration_downtime]
      [vm.virtio_scsi.enabled]
      [vm.soundcard_enabled]
      [vm.payloads.payload]
      [vm.initialization.configuration.type]
      [vm.initialization.configuration.data]
      [vm.cpu.cpu_tune.vcpu_pin]
      [vm.use_latest_template_version]
      [vm.serial_number.policy]
      [vm.serial_number.value]
      [vm.bios.boot_menu.enabled]
      [vm.numa_tune_mode]
      [vm.cpu_profile.id]

    Overload 2:

      add a virtual machine to the
      system by cloning from a
      snapshot

      vm.name
      vm.template.id|name
      vm.cluster.id|name
      vm.snapshots.snapshot
      [vm.quota.id]
      [vm.timezone]
      [vm.os.boot]
      [vm.custom_properties.custom_property]
      [vm.os.type]
      [vm.usb.enabled]
      [vm.usb.type]
      [vm.type]
      [vm.os.initRd]
      [vm.display.monitors]
      [vm.display.single_qxl_pci]
      [vm.display.type]
      [vm.display.allow_override]
      [vm.display.smartcard_enabled]
      [vm.display.file_transfer_enabled]
      [vm.display.copy_paste_enabled]
      [vm.display.keyboard_layout]
      [vm.os.cmdline]
      [vm.cpu.topology.cores]
      [vm.cpu_shares]
      [vm.cpu.architecture]
      [vm.memory]
      [vm.memory_policy.guaranteed]
      [vm.memory_policy.ballooning]
      [vm.high_availability.priority]
      [vm.high_availability.enabled]
      [vm.domain.name]
      [vm.description]
      [vm.comment]
      [vm.stateless]
      [vm.delete_protected]
      [vm.sso.methods.method]
      [vm.rng_device.rate.bytes]
      [vm.rng_device.rate.period]
      [vm.rng_device.source]
      [vm.console.enabled]
      [vm.cpu.topology.sockets]
      [vm.placement_policy.affinity]
      [vm.placement_policy.host.id|name]
      [vm.origin]
      [vm.os.kernel]
      [vm.tunnel_migration]
      [vm.migration_downtime]
      [vm.virtio_scsi.enabled]
      [vm.soundcard_enabled]
      [vm.payloads.payload]
      [vm.cpu.cpu_tune.vcpu_pin]
      [vm.serial_number.policy]
      [vm.serial_number.value]
      [vm.bios.boot_menu.enabled]
      [vm.numa_tune_mode]
      [vm.cpu_profile.id]

    Overload 3:

      add a virtual machine to the
      system from a configuration -
      requires the configuration
      type and the configuration
      data

      vm.initialization.configuration.type
      vm.initialization.configuration.data
      [vm.name]
      [vm.quota.id]
      [vm.timezone]
      [vm.os.boot]
      [vm.custom_properties.custom_property]
      [vm.os.type]
      [vm.usb.enabled]
      [vm.usb.type]
      [vm.type]
      [vm.os.initRd]
      [vm.display.monitors]
      [vm.display.type]
      [vm.display.allow_override]
      [vm.display.smartcard_enabled]
      [vm.display.file_transfer_enabled]
      [vm.display.copy_paste_enabled]
      [vm.display.keyboard_layout]
      [vm.os.cmdline]
      [vm.cpu.topology.cores]
      [vm.memory]
      [vm.memory_policy.guaranteed]
      [vm.memory_policy.ballooning]
      [vm.high_availability.priority]
      [vm.high_availability.enabled]
      [vm.domain.name]
      [vm.description]
      [vm.comment]
      [vm.stateless]
      [vm.permissions.clone]
      [vm.delete_protected]
      [vm.sso.methods.method]
      [vm.rng_device.rate.bytes]
      [vm.rng_device.rate.period]
      [vm.rng_device.source]
      [vm.cpu.mode]
      [vm.cpu.topology.sockets]
      [vm.placement_policy.affinity]
      [vm.placement_policy.host.id|name]
      [vm.origin]
      [vm.os.kernel]
      [vm.disks.clone]
      [vm.disks.disk]
      [vm.tunnel_migration]
      [vm.migration_downtime]
      [vm.virtio_scsi.enabled]
      [vm.payloads.payload]
      [vm.initialization.configuration.type]
      [vm.initialization.configuration.data]
      [vm.initialization.regenerate_ids]
      [vm.cpu.cpu_tune.vcpu_pin]
      [vm.serial_number.policy]
      [vm.serial_number.value]
      [vm.bios.boot_menu.enabled]
      [vm.numa_tune_mode]
      [vm.cpu_profile.id]
    

correlationId -

    [any string]
    

Returns:

VM

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

add

public VM add(VM vm,
              String correlationId,
              String expect)
       throws org.apache.http.client.ClientProtocolException,
              ServerException,
              IOException

Adds VM object.

Parameters:

vm - VM

    Overload 1:

      add a virtual machine to the
      system from scratch

      vm.name
      vm.template.id|name
      vm.cluster.id|name
      [vm.instance_type.id|name]
      [vm.quota.id]
      [vm.timezone]
      [vm.os.boot]
      [vm.custom_properties.custom_property]
      [vm.os.type]
      [vm.usb.enabled]
      [vm.usb.type]
      [vm.type]
      [vm.os.initRd]
      [vm.display.monitors]
      [vm.display.single_qxl_pci]
      [vm.display.type]
      [vm.display.allow_override]
      [vm.display.smartcard_enabled]
      [vm.display.file_transfer_enabled]
      [vm.display.copy_paste_enabled]
      [vm.display.keyboard_layout]
      [vm.os.cmdline]
      [vm.cpu.topology.cores]
      [vm.cpu.architecture]
      [vm.memory]
      [vm.memory_policy.guaranteed]
      [vm.memory_policy.ballooning]
      [vm.high_availability.priority]
      [vm.high_availability.enabled]
      [vm.domain.name]
      [vm.description]
      [vm.comment]
      [vm.stateless]
      [vm.permissions.clone]
      [vm.delete_protected]
      [vm.sso.methods.method]
      [vm.rng_device.rate.bytes]
      [vm.rng_device.rate.period]
      [vm.rng_device.source]
      [vm.console.enabled]
      [vm.cpu.mode]
      [vm.cpu.topology.sockets]
      [vm.cpu_shares]
      [vm.placement_policy.affinity]
      [vm.placement_policy.host.id|name]
      [vm.origin]
      [vm.os.kernel]
      [vm.disks.clone]
      [vm.disks.disk]
      [vm.tunnel_migration]
      [vm.migration_downtime]
      [vm.virtio_scsi.enabled]
      [vm.soundcard_enabled]
      [vm.payloads.payload]
      [vm.initialization.configuration.type]
      [vm.initialization.configuration.data]
      [vm.cpu.cpu_tune.vcpu_pin]
      [vm.use_latest_template_version]
      [vm.serial_number.policy]
      [vm.serial_number.value]
      [vm.bios.boot_menu.enabled]
      [vm.numa_tune_mode]
      [vm.cpu_profile.id]

    Overload 2:

      add a virtual machine to the
      system by cloning from a
      snapshot

      vm.name
      vm.template.id|name
      vm.cluster.id|name
      vm.snapshots.snapshot
      [vm.quota.id]
      [vm.timezone]
      [vm.os.boot]
      [vm.custom_properties.custom_property]
      [vm.os.type]
      [vm.usb.enabled]
      [vm.usb.type]
      [vm.type]
      [vm.os.initRd]
      [vm.display.monitors]
      [vm.display.single_qxl_pci]
      [vm.display.type]
      [vm.display.allow_override]
      [vm.display.smartcard_enabled]
      [vm.display.file_transfer_enabled]
      [vm.display.copy_paste_enabled]
      [vm.display.keyboard_layout]
      [vm.os.cmdline]
      [vm.cpu.topology.cores]
      [vm.cpu_shares]
      [vm.cpu.architecture]
      [vm.memory]
      [vm.memory_policy.guaranteed]
      [vm.memory_policy.ballooning]
      [vm.high_availability.priority]
      [vm.high_availability.enabled]
      [vm.domain.name]
      [vm.description]
      [vm.comment]
      [vm.stateless]
      [vm.delete_protected]
      [vm.sso.methods.method]
      [vm.rng_device.rate.bytes]
      [vm.rng_device.rate.period]
      [vm.rng_device.source]
      [vm.console.enabled]
      [vm.cpu.topology.sockets]
      [vm.placement_policy.affinity]
      [vm.placement_policy.host.id|name]
      [vm.origin]
      [vm.os.kernel]
      [vm.tunnel_migration]
      [vm.migration_downtime]
      [vm.virtio_scsi.enabled]
      [vm.soundcard_enabled]
      [vm.payloads.payload]
      [vm.cpu.cpu_tune.vcpu_pin]
      [vm.serial_number.policy]
      [vm.serial_number.value]
      [vm.bios.boot_menu.enabled]
      [vm.numa_tune_mode]
      [vm.cpu_profile.id]

    Overload 3:

      add a virtual machine to the
      system from a configuration -
      requires the configuration
      type and the configuration
      data

      vm.initialization.configuration.type
      vm.initialization.configuration.data
      [vm.name]
      [vm.quota.id]
      [vm.timezone]
      [vm.os.boot]
      [vm.custom_properties.custom_property]
      [vm.os.type]
      [vm.usb.enabled]
      [vm.usb.type]
      [vm.type]
      [vm.os.initRd]
      [vm.display.monitors]
      [vm.display.type]
      [vm.display.allow_override]
      [vm.display.smartcard_enabled]
      [vm.display.file_transfer_enabled]
      [vm.display.copy_paste_enabled]
      [vm.display.keyboard_layout]
      [vm.os.cmdline]
      [vm.cpu.topology.cores]
      [vm.memory]
      [vm.memory_policy.guaranteed]
      [vm.memory_policy.ballooning]
      [vm.high_availability.priority]
      [vm.high_availability.enabled]
      [vm.domain.name]
      [vm.description]
      [vm.comment]
      [vm.stateless]
      [vm.permissions.clone]
      [vm.delete_protected]
      [vm.sso.methods.method]
      [vm.rng_device.rate.bytes]
      [vm.rng_device.rate.period]
      [vm.rng_device.source]
      [vm.cpu.mode]
      [vm.cpu.topology.sockets]
      [vm.placement_policy.affinity]
      [vm.placement_policy.host.id|name]
      [vm.origin]
      [vm.os.kernel]
      [vm.disks.clone]
      [vm.disks.disk]
      [vm.tunnel_migration]
      [vm.migration_downtime]
      [vm.virtio_scsi.enabled]
      [vm.payloads.payload]
      [vm.initialization.configuration.type]
      [vm.initialization.configuration.data]
      [vm.initialization.regenerate_ids]
      [vm.cpu.cpu_tune.vcpu_pin]
      [vm.serial_number.policy]
      [vm.serial_number.value]
      [vm.bios.boot_menu.enabled]
      [vm.numa_tune_mode]
      [vm.cpu_profile.id]
    

correlationId -

    [any string]
    

expect -

    [201-created]
    

Returns:

VM

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.