class OvirtSDK4::FenceAgentsService
Constants
- ADD
- LIST
Public Instance Methods
Add a new fencing-agent to the host.
- source
POST /ovirt-engine/api/hosts/123/fenceagents
You should consult the /usr/sbin/fence_<agent_name> manual page for the legal parameters to [name1=value1, name2=value2,…] in the options field. If any parameter in options appears by name that means that it is mandatory. For example in <options>slot=7[,name1=value1, name2=value2,…]</options> slot is mandatory.
apc, bladecenter, wti fencing agent/s sample request:
- source,xml
-
<agent>
<type>apc</type> <order>1</order> <ip>192.168.1.101</ip> <user>user</user> <password>xxx</password> <port>9</port> <options>slot=7[,name1=value1, name2=value2,...]</options>
</agent>
apc_snmp, hpblade, ilo, ilo2, ilo_ssh, redfish, rsa fencing agent/s sample request:
- source,xml
-
<agent>
<type>apc_snmp</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>
cisco_ucs, drac5, eps fencing agent/s sample request:
- source,xml
-
<agent>
<type>cisco_ucs</type> <order>1</order> <ip>192.168.1.101</ip> <user>user</user> <password>xxx</password> <options>slot=7[,name1=value1, name2=value2,...]</options>
</agent>
drac7, ilo3, ilo4, ipmilan, rsb fencing agent/s sample request:
- source,xml
-
<agent>
<type>drac7</type> <order>1</order> <ip>192.168.1.101</ip> <user>user</user> <password>xxx</password> <options>[name1=value1, name2=value2,...]</options>
</agent>
@param agent [Agent] The `agent` 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 [Agent]
# File lib/ovirtsdk4/services.rb, line 10628 def add(agent, opts = {}) internal_add(agent, Agent, ADD, opts) end
Reference to service that manages a specific fence agent for this host.
@param id [String] The identifier of the `agent`.
@return [FenceAgentService] A reference to the `agent` service.
# File lib/ovirtsdk4/services.rb, line 10696 def agent_service(id) FenceAgentService.new(self, id) end
Returns the list of fencing agents configured for the host.
- source
GET /ovirt-engine/api/hosts/123/fenceagents
And here is sample response:
- source,xml
<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.
@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 agents to return. If not specified all the agents 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<Agent>]
# File lib/ovirtsdk4/services.rb, line 10684 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 10707 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