Class: OvirtSDK4::FenceAgentsService

Inherits:
Service
  • Object
show all
Defined in:
lib/ovirtsdk4/services.rb,
lib/ovirtsdk4/services.rb

Instance Method Summary collapse

Methods inherited from Service

#inspect, #to_s

Instance Method Details

#add(agent, opts = {}) ⇒ Agent

Add a new fencing-agent to the host.

Parameters:

  • agent (Agent)

    The agent to add.

  • opts (Hash) (defaults to: {})

    Additional options.

Options Hash (opts):

  • :headers (Hash) — default: {}

    Additional HTTP headers.

  • :query (Hash) — default: {}

    Additional URL query parameters.

  • :timeout (Integer) — default: 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.

  • :wait (Boolean) — default: true

    If true wait for the response.

Returns:



9471
9472
9473
# File 'lib/ovirtsdk4/services.rb', line 9471

def add(agent, opts = {})
  internal_add(agent, Agent, ADD, opts)
end

#agent_service(id) ⇒ FenceAgentService

Reference to service that manages a specific fence agent for this host.

Parameters:

  • id (String)

    The identifier of the agent.

Returns:



9539
9540
9541
# File 'lib/ovirtsdk4/services.rb', line 9539

def agent_service(id)
  FenceAgentService.new(self, id)
end

#list(opts = {}) ⇒ Array<Agent>

Returns the list of fencing agents configured for the host.

GET /ovirt-engine/api/hosts/123/fenceagents

And here is sample response:

<agents>
  <agent id="0">
    <type>apc</type>
    <order>1</order>
    <ip>192.168.1.101</ip>
    <user>user</user>
    <password>xxx</password>
    <port>9</port>
    <options>name1=value1, name2=value2</options>
  </agent>
</agents>

The order of the returned list of fencing agents isn’t guaranteed.

Parameters:

  • opts (Hash) (defaults to: {})

    Additional options.

Options Hash (opts):

  • :follow (String)

    Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.

  • :max (Integer)

    Sets the maximum number of agents to return. If not specified all the agents are returned.

  • :headers (Hash) — default: {}

    Additional HTTP headers.

  • :query (Hash) — default: {}

    Additional URL query parameters.

  • :timeout (Integer) — default: 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.

  • :wait (Boolean) — default: true

    If true wait for the response.

Returns:



9527
9528
9529
# File 'lib/ovirtsdk4/services.rb', line 9527

def list(opts = {})
  internal_get(LIST, opts)
end

#service(path) ⇒ Service

Locates the service corresponding to the given path.

Parameters:

  • path (String)

    The path of the service.

Returns:

  • (Service)

    A reference to the service.



9550
9551
9552
9553
9554
9555
9556
9557
9558
9559
# File 'lib/ovirtsdk4/services.rb', line 9550

def service(path)
  if path.nil? || path == ''
    return self
  end
  index = path.index('/')
  if index.nil?
    return agent_service(path)
  end
  return agent_service(path[0..(index - 1)]).service(path[(index +1)..-1])
end