class OvirtSDK4::AffinityGroupVmsService
Constants
- ADD
- LIST
Public Instance Methods
Adds a virtual machine to the affinity group.
For example, to add the virtual machine `789` to the affinity group `456` of cluster `123`, send a request like this:
.… POST /ovirt-engine/api/clusters/123/affinitygroups/456/vms .…
With the following body:
- source,xml
<vm id=“789”/>
@param vm [Vm] The `vm` to add.
@param opts [Hash] Additional options.
@option opts [Hash] :headers ({}) Additional HTTP headers.
@option opts [Hash] :query ({}) Additional URL query parameters.
@option opts [Integer] :timeout (nil) The timeout for this request, in seconds. If no value is explicitly
given then the timeout set globally for the connection will be used.
@option opts [Boolean] :wait (true) If `true` wait for the response.
@return [Vm]
# File lib/ovirtsdk4/services.rb, line 1615 def add(vm, opts = {}) internal_add(vm, Vm, ADD, opts) end
List
all virtual machines assigned to this affinity group.
The order of the returned virtual machines isn't guaranteed.
@param opts [Hash] Additional options.
@option opts [String] :follow Indicates which inner links should be followed. The objects referenced by these links will be fetched as part
of the current request. See <<documents/003_common_concepts/follow, here>> for details.
@option opts [Integer] :max Sets the maximum number of virtual machines to return. If not specified, all the virtual machines are
returned.
@option opts [Hash] :headers ({}) Additional HTTP headers.
@option opts [Hash] :query ({}) Additional URL query parameters.
@option opts [Integer] :timeout (nil) The timeout for this request, in seconds. If no value is explicitly
given then the timeout set globally for the connection will be used.
@option opts [Boolean] :wait (true) If `true` wait for the response.
@return [Array<Vm>]
# File lib/ovirtsdk4/services.rb, line 1650 def list(opts = {}) internal_get(LIST, opts) end
Locates the service corresponding to the given path.
@param path [String] The path of the service.
@return [Service] A reference to the service.
# File lib/ovirtsdk4/services.rb, line 1672 def service(path) if path.nil? || path == '' return self end index = path.index('/') if index.nil? return vm_service(path) end return vm_service(path[0..(index - 1)]).service(path[(index + 1)..-1]) end
Access the service that manages the virtual machine assignment to this affinity group.
@param id [String] The identifier of the `vm`.
@return [AffinityGroupVmService] A reference to the `vm` service.
# File lib/ovirtsdk4/services.rb, line 1661 def vm_service(id) AffinityGroupVmService.new(self, id) end