class OvirtSDK4::VmWatchdogsService

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

Public Instance Methods

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

Adds new watchdog to the virtual machine.

For example, to add a watchdog to a virtual machine, send a request like this:

source

POST /ovirt-engine/api/vms/123/watchdogs <watchdog>

<action>poweroff</action>
<model>i6300esb</model>

</watchdog>


with response body:

source,xml

<watchdog href=“/ovirt-engine/api/vms/123/watchdogs/00000000-0000-0000-0000-000000000000” id=“00000000-0000-0000-0000-000000000000”>

<vm href="/ovirt-engine/api/vms/123" id="123"/>
<action>poweroff</action>
<model>i6300esb</model>

</watchdog>


@param watchdog [Watchdog] The information about the watchdog.

The request data must contain `model` element (such as `i6300esb`) and `action` element
(one of `none`, `reset`, `poweroff`, `dump`, `pause`). The response data additionally
contains references to the added watchdog and to the virtual machine.

@param opts [Hash] Additional options.

@return [Watchdog]

# File lib/ovirtsdk4/services.rb, line 33160
def add(watchdog, opts = {})
  if watchdog.is_a?(Hash)
    watchdog = OvirtSDK4::Watchdog.new(watchdog)
  end
  query = {}
  request = HttpRequest.new(method: :POST, url: @path, query: query)
  begin
    writer = XmlWriter.new(nil, true)
    WatchdogWriter.write_one(watchdog, 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 WatchdogReader.read_one(reader)
    ensure
      reader.close
    end
  else
    check_fault(response)
  end
end
list(opts = {}) click to toggle source

The list of watchdogs of the virtual machine.

@param opts [Hash] Additional options.

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

@return [Array<Watchdog>]

# File lib/ovirtsdk4/services.rb, line 33196
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 WatchdogReader.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 33236
def service(path)
  if path.nil? || path == ''
    return self
  end
  index = path.index('/')
  if index.nil?
    return watchdog_service(path)
  end
  return watchdog_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 33252
def to_s
  "#<#{VmWatchdogsService}:#{@path}>"
end
watchdog_service(id) click to toggle source

Returns a reference to the service that manages a specific watchdog.

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

@return [VmWatchdogService] A reference to the `watchdog` service.

# File lib/ovirtsdk4/services.rb, line 33225
def watchdog_service(id)
  VmWatchdogService.new(@connection, "#{@path}/#{id}")
end