class OvirtSDK4::HostNicService

Constants

GET
UPDATE_VIRTUAL_FUNCTIONS_CONFIGURATION

Public Instance Methods

get(opts = {}) click to toggle source

Returns the representation of the object managed by this service.

@param opts [Hash] Additional options.

@option opts [Boolean] :all_content 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.

@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 [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 [HostNic]

# File lib/ovirtsdk4/services.rb, line 40462
def get(opts = {})
  internal_get(GET, opts)
end
network_attachments_service() click to toggle source

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

@return [NetworkAttachmentsService] A reference to `network_attachments` service.

# File lib/ovirtsdk4/services.rb, line 40515
def network_attachments_service
  @network_attachments_service ||= NetworkAttachmentsService.new(self, 'networkattachments')
end
network_labels_service() click to toggle source

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

@return [NetworkLabelsService] A reference to `network_labels` service.

# File lib/ovirtsdk4/services.rb, line 40524
def network_labels_service
  @network_labels_service ||= NetworkLabelsService.new(self, 'networklabels')
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 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() click to toggle source

Locates the `statistics` service.

@return [StatisticsService] A reference to `statistics` service.

# File lib/ovirtsdk4/services.rb, line 40533
def statistics_service
  @statistics_service ||= StatisticsService.new(self, 'statistics')
end
update_virtual_functions_configuration(opts = {}) click to toggle source

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.

@param opts [Hash] Additional options.

@option opts [Boolean] :async Indicates if the update should be performed asynchronously.

@option opts [HostNicVirtualFunctionsConfiguration] :virtual_functions_configuration

@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.

# 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() click to toggle source

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.

@return [NetworkLabelsService] A reference to `virtual_function_allowed_labels` service.

# 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() click to toggle source

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.

@return [VirtualFunctionAllowedNetworksService] A reference to `virtual_function_allowed_networks` service.

# File lib/ovirtsdk4/services.rb, line 40553
def virtual_function_allowed_networks_service
  @virtual_function_allowed_networks_service ||= VirtualFunctionAllowedNetworksService.new(self, 'virtualfunctionallowednetworks')
end