class OvirtSDK4::AffinityGroupsService

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 1128
def initialize(connection, path)
  @connection = connection
  @path = path
end

Public Instance Methods

add(group, opts = {}) click to toggle source

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>


@param group [AffinityGroup] The affinity group object to create.

@param opts [Hash] Additional options.

@return [AffinityGroup]

# File lib/ovirtsdk4/services.rb, line 1160
def add(group, opts = {})
  if group.is_a?(Hash)
    group = OvirtSDK4::AffinityGroup.new(group)
  end
  query = {}
  request = HttpRequest.new(method: :POST, 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, 201, 202
    begin
      reader = XmlReader.new(response.body)
      return AffinityGroupReader.read_one(reader)
    ensure
      reader.close
    end
  else
    check_fault(response)
  end
end
group_service(id) click to toggle source

Access affinity group service that manages the affinity group specified by an id.

@param id [String] The identifier of the `group`.

@return [AffinityGroupService] A reference to the `group` service.

# File lib/ovirtsdk4/services.rb, line 1225
def group_service(id)
  AffinityGroupService.new(@connection, "#{@path}/#{id}")
end
list(opts = {}) click to toggle source

List existing affinity groups.

@param opts [Hash] Additional options.

@option opts [Integer] :max Sets the maximum number of affinity groups to return. If not specified all the affinity groups are returned.

@return [Array<AffinityGroup>]

# File lib/ovirtsdk4/services.rb, line 1196
def list(opts = {})
  query = {}
  value = opts[:max]
  unless value.nil?
    value = Writer.render_integer(value)
    query['max'] = value
  end
  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_many(reader)
    ensure
      reader.close
    end
  else
    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 1236
def service(path)
  if path.nil? || path == ''
    return self
  end
  index = path.index('/')
  if index.nil?
    return group_service(path)
  end
  return group_service(path[0..(index - 1)]).service(path[(index +1)..-1])
end
to_s() click to toggle source

Returns an string representation of this service.

@return [String]

# File lib/ovirtsdk4/services.rb, line 1252
def to_s
  "#<#{AffinityGroupsService}:#{@path}>"
end