class OvirtSDK4::AffinityGroupService

Public Class Methods

new(connection, path) click to toggle source

Creates a new implementation of the service.

@param connection [Connection] The connection to be used by this service.

@param path [String] The relative path of this service, for example `vms/123/disks`.

@api private

# File lib/ovirtsdk4/services.rb, line 769
def initialize(connection, path)
  @connection = connection
  @path = path
end

Public Instance Methods

get(opts = {}) click to toggle source

Retrieve the affinity group details.

source,xml

<affinity_group id=“00000000-0000-0000-0000-000000000000”>

<name>AF_GROUP_001</name>
<cluster id="00000000-0000-0000-0000-000000000000"/>
<positive>true</positive>
<enforcing>true</enforcing>

</affinity_group>


@param opts [Hash] Additional options.

@return [AffinityGroup]

# File lib/ovirtsdk4/services.rb, line 791
def get(opts = {})
  query = {}
  request = HttpRequest.new(method: :GET, url: @path, query: query)
  response = @connection.send(request)
  case response.code
  when 200
    begin
      reader = XmlReader.new(response.body)
      return AffinityGroupReader.read_one(reader)
    ensure
      reader.close
    end
  else
    check_fault(response)
  end
end
remove(opts = {}) click to toggle source

Remove the affinity group.

source

DELETE /ovirt-engine/api/clusters/000-000/affinitygroups/123-456


@param opts [Hash] Additional options.

@option opts [Boolean] :async Indicates if the remove should be performed asynchronously.

# File lib/ovirtsdk4/services.rb, line 819
def remove(opts = {})
  query = {}
  value = opts[:async]
  unless value.nil?
    value = Writer.render_boolean(value)
    query['async'] = value
  end
  request = HttpRequest.new(method: :DELETE, url: @path, query: query)
  response = @connection.send(request)
  unless response.code == 200
    check_fault(response)
  end
end
service(path) click to toggle source

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 894
def service(path)
  if path.nil? || path == ''
    return self
  end
  if path == 'vms'
    return vms_service
  end
  if path.start_with?('vms/')
    return vms_service.service(path[4..-1])
  end
  raise Error.new("The path \"#{path}\" doesn't correspond to any service")
end
to_s() click to toggle source

Returns an string representation of this service.

@return [String]

# File lib/ovirtsdk4/services.rb, line 912
def to_s
  "#<#{AffinityGroupService}:#{@path}>"
end
update(group, opts = {}) click to toggle source

Update the affinity group.

@param group [AffinityGroup] The affinity group. @param opts [Hash] Additional options.

@option opts [Boolean] :async Indicates if the update should be performed asynchronously.

@return [AffinityGroup]

# File lib/ovirtsdk4/services.rb, line 843
def update(group, opts = {})
  if group.is_a?(Hash)
    group = OvirtSDK4::AffinityGroup.new(group)
  end
  query = {}
  value = opts[:async]
  unless value.nil?
    value = Writer.render_boolean(value)
    query['async'] = value
  end
  request = HttpRequest.new(method: :PUT, url: @path, query: query)
  begin
    writer = XmlWriter.new(nil, true)
    AffinityGroupWriter.write_one(group, writer)
    request.body = writer.string
  ensure
    writer.close
  end
  response = @connection.send(request)
  case response.code
  when 200
    begin
      reader = XmlReader.new(response.body)
      return AffinityGroupReader.read_one(reader)
    ensure
      reader.close
    end
    return result
  else
    check_fault(response)
  end
end
vms_service() click to toggle source

Returns a reference to the service that manages the list of all virtual machines attached to this affinity group.

@return [AffinityGroupVmsService] A reference to `vms` service.

# File lib/ovirtsdk4/services.rb, line 883
def vms_service
  AffinityGroupVmsService.new(@connection, "#{@path}/vms")
end