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 11565 def initialize(connection, path) @connection = connection @path = path end
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:
POST /ovirt-engine/api/hosts
With the following request body:
<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:
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.
@return [Host]
# File lib/ovirtsdk4/services.rb, line 11619 def add(host, opts = {}) if host.is_a?(Hash) host = OvirtSDK4::Host.new(host) end query = {} value = opts[:deploy_hosted_engine] unless value.nil? value = Writer.render_boolean(value) query['deploy_hosted_engine'] = value end value = opts[:undeploy_hosted_engine] unless value.nil? value = Writer.render_boolean(value) query['undeploy_hosted_engine'] = value end request = HttpRequest.new(method: :POST, url: @path, query: query) begin writer = XmlWriter.new(nil, true) HostWriter.write_one(host, 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 HostReader.read_one(reader) ensure reader.close end else check_fault(response) end end
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 11737 def host_service(id) HostService.new(@connection, "#{@path}/#{id}") end
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:
<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.
@return [Array<Host>]
# File lib/ovirtsdk4/services.rb, line 11694 def list(opts = {}) query = {} value = opts[:case_sensitive] unless value.nil? value = Writer.render_boolean(value) query['case_sensitive'] = value end value = opts[:filter] unless value.nil? value = Writer.render_boolean(value) query['filter'] = value end value = opts[:max] unless value.nil? value = Writer.render_integer(value) query['max'] = value end value = opts[:search] unless value.nil? query['search'] = 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 HostReader.read_many(reader) ensure reader.close end else check_fault(response) end 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 11748 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
Returns an string representation of this service.
@return [String]
# File lib/ovirtsdk4/services.rb, line 11764 def to_s "#<#{HostsService}:#{@path}>" end