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 HTTP/1.1
    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:



39902
39903
39904
 
# File 'lib/ovirtsdk4/services.rb', line 39902

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:



39946
39947
39948
 
# File 'lib/ovirtsdk4/services.rb', line 39946

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:



39955
39956
39957
 
# File 'lib/ovirtsdk4/services.rb', line 39955

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:



39964
39965
39966
 
# File 'lib/ovirtsdk4/services.rb', line 39964

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:



40004
40005
40006
40007
40008
40009
40010
40011
40012
40013
40014
40015
40016
40017
40018
40019
40020
40021
40022
40023
40024
40025
40026
40027
40028
40029
40030
40031
40032
40033
40034
40035
40036
40037
40038
40039
40040
40041
40042
40043
40044
40045
 
# File 'lib/ovirtsdk4/services.rb', line 40004

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:



39973
39974
39975
 
# File 'lib/ovirtsdk4/services.rb', line 39973

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.



39937
39938
39939
 
# File 'lib/ovirtsdk4/services.rb', line 39937

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:



39983
39984
39985
 
# File 'lib/ovirtsdk4/services.rb', line 39983

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:



39993
39994
39995
 
# File 'lib/ovirtsdk4/services.rb', line 39993

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