Class: OvirtSDK4::HostNicService

Inherits:
MeasurableService 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

#get(opts = {}) ⇒ HostNic

Returns the representation of the object managed by this service.

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 network interface '456' of host '123':

    GET /ovirt-engine/api/hosts/123/nics/456?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.

  • :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:


39435
39436
39437
# File 'lib/ovirtsdk4/services.rb', line 39435

def get(opts = {})
  internal_get(GET, opts)
end

A reference to information elements received by LLDP on the NIC.

Returns:


39479
39480
39481
# File 'lib/ovirtsdk4/services.rb', line 39479

def link_layer_discovery_protocol_elements_service
  @link_layer_discovery_protocol_elements_service ||= LinkLayerDiscoveryProtocolService.new(self, 'linklayerdiscoveryprotocolelements')
end

#network_attachments_serviceNetworkAttachmentsService

Reference to the service that manages the network attachments assigned to this network interface.

Returns:


39488
39489
39490
# File 'lib/ovirtsdk4/services.rb', line 39488

def network_attachments_service
  @network_attachments_service ||= NetworkAttachmentsService.new(self, 'networkattachments')
end

#network_labels_serviceNetworkLabelsService

Reference to the service that manages the network labels assigned to this network interface.

Returns:


39497
39498
39499
# File 'lib/ovirtsdk4/services.rb', line 39497

def network_labels_service
  @network_labels_service ||= NetworkLabelsService.new(self, 'networklabels')
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.

Raises:


39537
39538
39539
39540
39541
39542
39543
39544
39545
39546
39547
39548
39549
39550
39551
39552
39553
39554
39555
39556
39557
39558
39559
39560
39561
39562
39563
39564
39565
39566
39567
39568
39569
39570
39571
39572
39573
39574
39575
39576
39577
39578
# File 'lib/ovirtsdk4/services.rb', line 39537

def service(path)
  if path.nil? || path == ''
    return self
  end
  if path == 'linklayerdiscoveryprotocolelements'
    return link_layer_discovery_protocol_elements_service
  end
  if path.start_with?('linklayerdiscoveryprotocolelements/')
    return link_layer_discovery_protocol_elements_service.service(path[35..-1])
  end
  if path == 'networkattachments'
    return network_attachments_service
  end
  if path.start_with?('networkattachments/')
    return network_attachments_service.service(path[19..-1])
  end
  if path == 'networklabels'
    return network_labels_service
  end
  if path.start_with?('networklabels/')
    return network_labels_service.service(path[14..-1])
  end
  if path == 'statistics'
    return statistics_service
  end
  if path.start_with?('statistics/')
    return statistics_service.service(path[11..-1])
  end
  if path == 'virtualfunctionallowedlabels'
    return virtual_function_allowed_labels_service
  end
  if path.start_with?('virtualfunctionallowedlabels/')
    return virtual_function_allowed_labels_service.service(path[29..-1])
  end
  if path == 'virtualfunctionallowednetworks'
    return virtual_function_allowed_networks_service
  end
  if path.start_with?('virtualfunctionallowednetworks/')
    return virtual_function_allowed_networks_service.service(path[31..-1])
  end
  raise Error.new("The path \"#{path}\" doesn't correspond to any service")
end

#statistics_serviceStatisticsService

Locates the statistics service.

Returns:


39506
39507
39508
# File 'lib/ovirtsdk4/services.rb', line 39506

def statistics_service
  @statistics_service ||= StatisticsService.new(self, 'statistics')
end

#update_virtual_functions_configuration(opts = {}) ⇒ Object

The action updates virtual function configuration in case the current resource represents an SR-IOV enabled NIC. The input should be consisted of at least one of the following properties:

  • allNetworksAllowed

  • numberOfVirtualFunctions

Please see the HostNicVirtualFunctionsConfiguration type for the meaning of the properties.

Parameters:

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

    Additional options.

Options Hash (opts):

  • :async (Boolean)

    Indicates if the update should be performed asynchronously.

  • :virtual_functions_configuration (HostNicVirtualFunctionsConfiguration)
  • :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.


39470
39471
39472
# File 'lib/ovirtsdk4/services.rb', line 39470

def update_virtual_functions_configuration(opts = {})
  internal_action(:updatevirtualfunctionsconfiguration, nil, UPDATE_VIRTUAL_FUNCTIONS_CONFIGURATION, opts)
end

#virtual_function_allowed_labels_serviceNetworkLabelsService

Retrieves sub-collection resource of network labels that are allowed on an the virtual functions in case that the current resource represents an SR-IOV physical function NIC.

Returns:


39516
39517
39518
# File 'lib/ovirtsdk4/services.rb', line 39516

def virtual_function_allowed_labels_service
  @virtual_function_allowed_labels_service ||= NetworkLabelsService.new(self, 'virtualfunctionallowedlabels')
end

#virtual_function_allowed_networks_serviceVirtualFunctionAllowedNetworksService

Retrieves sub-collection resource of networks that are allowed on an the virtual functions in case that the current resource represents an SR-IOV physical function NIC.

Returns:


39526
39527
39528
# File 'lib/ovirtsdk4/services.rb', line 39526

def virtual_function_allowed_networks_service
  @virtual_function_allowed_networks_service ||= VirtualFunctionAllowedNetworksService.new(self, 'virtualfunctionallowednetworks')
end