class OvirtSDK4::ExternalHostGroupsService

Constants

LIST

Public Instance Methods

group_service(id) click to toggle source

This service manages hostgroup instance.

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

@return [ExternalHostGroupService] A reference to the `group` service.

# File lib/ovirtsdk4/services.rb, line 9734
def group_service(id)
  ExternalHostGroupService.new(self, id)
end
list(opts = {}) click to toggle source

Get host groups list from external host provider.

Host group is a term of host providers - the host group includes provision details. This API returns all possible hostgroups exposed by the external provider.

For example, to get the details of all host groups of provider `123`, send a request like this:

.… GET /ovirt-engine/api/externalhostproviders/123/hostgroups .…

The response will be like this:

source,xml

<external_host_groups>

<external_host_group href="/ovirt-engine/api/externalhostproviders/123/hostgroups/234" id="234">
  <name>rhel7</name>
  <architecture_name>x86_64</architecture_name>
  <domain_name>example.com</domain_name>
  <operating_system_name>RedHat 7.3</operating_system_name>
  <subnet_name>sat0</subnet_name>
  <external_host_provider href="/ovirt-engine/api/externalhostproviders/123" id="123"/>
</external_host_group>
...

</external_host_groups>


The order of the returned list of host groups 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 groups to return. If not specified all the groups 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<ExternalHostGroup>]

# File lib/ovirtsdk4/services.rb, line 9723
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 9745
def service(path)
  if path.nil? || path == ''
    return self
  end
  index = path.index('/')
  if index.nil?
    return group_service(path)
  end
  return group_service(path[0..(index - 1)]).service(path[(index + 1)..-1])
end