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:



40462
40463
40464
 
# File 'lib/ovirtsdk4/services.rb', line 40462

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

#link_layer_discovery_protocol_elements_service ⇒ LinkLayerDiscoveryProtocolService

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

Returns:



40506
40507
40508
 
# File 'lib/ovirtsdk4/services.rb', line 40506

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

#network_attachments_service ⇒ NetworkAttachmentsService

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

Returns:



40515
40516
40517
 
# File 'lib/ovirtsdk4/services.rb', line 40515

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

#network_labels_service ⇒ NetworkLabelsService

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

Returns:



40524
40525
40526
 
# File 'lib/ovirtsdk4/services.rb', line 40524

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:



40564
40565
40566
40567
40568
40569
40570
40571
40572
40573
40574
40575
40576
40577
40578
40579
40580
40581
40582
40583
40584
40585
40586
40587
40588
40589
40590
40591
40592
40593
40594
40595
40596
40597
40598
40599
40600
40601
40602
40603
40604
40605
 
# File 'lib/ovirtsdk4/services.rb', line 40564

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_service ⇒ StatisticsService

Locates the statistics service.

Returns:



40533
40534
40535
 
# File 'lib/ovirtsdk4/services.rb', line 40533

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.



40497
40498
40499
 
# File 'lib/ovirtsdk4/services.rb', line 40497

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

#virtual_function_allowed_labels_service ⇒ NetworkLabelsService

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:



40543
40544
40545
 
# File 'lib/ovirtsdk4/services.rb', line 40543

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

#virtual_function_allowed_networks_service ⇒ VirtualFunctionAllowedNetworksService

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:



40553
40554
40555
 
# File 'lib/ovirtsdk4/services.rb', line 40553

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