class OvirtSDK4::HostsService

Constants

ADD
LIST

Public Instance Methods

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

Creates a new host.

The host is created based on the attributes of the `host` parameter. The `name`, `address` and `root_password` properties are required.

For example, to add a host send the following request:

source

POST /ovirt-engine/api/hosts


With the following request body:

source,xml

<host>

<name>myhost</name>
<address>myhost.example.com</address>
<root_password>myrootpassword</root_password>

</host>


NOTE: The `root_password` element is only included in the client-provided initial representation and is not exposed in the representations returned from subsequent requests.

To add a hosted engine host, use the optional `deploy_hosted_engine` parameter:

source

POST /ovirt-engine/api/hosts?deploy_hosted_engine=true


@param host [Host] The host definition from which to create the new host is passed as parameter, and the newly created host

is returned.

@param opts [Hash] Additional options.

@option opts [Boolean] :deploy_hosted_engine When set to `true` it means this host should deploy also hosted engine components. Missing value is treated

as `true` i.e deploy. Omitting this parameter means `false` and will perform no operation in hosted engine
area.

@option opts [Boolean] :undeploy_hosted_engine When set to `true` it means this host should un-deploy hosted engine components and this host will not

function as part of the High Availability cluster. Missing value is treated as `true` i.e un-deploy.
Omitting this parameter means `false` and will perform no operation in hosted engine area.

@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 [Host]

# File lib/ovirtsdk4/services.rb, line 10139
def add(host, opts = {})
  internal_add(host, Host, ADD, opts)
end
host_service(id) click to toggle source

A Reference to service managing a specific host.

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

@return [HostService] A reference to the `host` service.

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

Get a list of all available hosts.

For example, to list the hosts send the following request:

.… GET /ovirt-engine/api/hosts .…

The response body will be something like this:

source,xml

<hosts>

<host href="/ovirt-engine/api/hosts/123" id="123">
  ...
</host>
<host href="/ovirt-engine/api/hosts/456" id="456">
  ...
</host>
...

</host>


@param opts [Hash] Additional options.

@option opts [Boolean] :case_sensitive Indicates if the search performed using the `search` parameter should be performed taking case into

account. The default value is `true`, which means that case is taken into account. If you want to search
ignoring case set it to `false`.

@option opts [Boolean] :filter Indicates if the results should be filtered according to the permissions of the user.

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

@option opts [String] :search A query string used to restrict the returned hosts.

@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<Host>]

# File lib/ovirtsdk4/services.rb, line 10199
def list(opts = {})
  internal_get(LIST, opts)
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 10221
def service(path)
  if path.nil? || path == ''
    return self
  end
  index = path.index('/')
  if index.nil?
    return host_service(path)
  end
  return host_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 10237
def to_s
  "#<#{HostsService}:#{@path}>"
end