Class: OvirtSDK4::HostNicsService

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

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

Returns the list of network interfaces of the host.

The order of the returned list of network interfaces isn’t guaranteed.

Parameters:

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

    Additional options.

Options Hash (opts):

  • :all_content (Boolean)

    Indicates if all of the attributes of the host network interface should be included in the response.

    By default the following attributes are excluded:

    • virtual_functions_configuration

    For example, to retrieve the complete representation of network interface '456' of host '123':

    GET /ovirt-engine/api/hosts/123/nics?all_content=true
    Note
    These attributes are not included by default because retrieving them impacts performance. They are seldom used and require additional queries to the database. Use this parameter with caution and only when specifically required.
  • :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 NICs to return. If not specified all the NICs 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:


12185
12186
12187
# File 'lib/ovirtsdk4/services.rb', line 12185

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

#nic_service(id) ⇒ HostNicService

Reference to the service that manages a single network interface.

Parameters:

  • id (String)

    The identifier of the nic.

Returns:


12196
12197
12198
# File 'lib/ovirtsdk4/services.rb', line 12196

def nic_service(id)
  HostNicService.new(self, id)
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.


12207
12208
12209
12210
12211
12212
12213
12214
12215
12216
# File 'lib/ovirtsdk4/services.rb', line 12207

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