class OvirtSDK4::VnicProfilesService

Constants

ADD
LIST

Public Instance Methods

add(profile, opts = {}) click to toggle source

Add a vNIC profile.

For example to add vNIC profile `123` to network `456` send a request to:

source

POST /ovirt-engine/api/networks/456/vnicprofiles


With the following body:

source,xml

<vnic_profile id=“123”>

<name>new_vNIC_name</name>
<pass_through>
  <mode>disabled</mode>
</pass_through>
<port_mirroring>false</port_mirroring>

</vnic_profile>


Please note that there is a default network filter to each VNIC profile. For more details of how the default network filter is calculated please refer to the documentation in xref:services-network_filters.

NOTE: The automatically created vNIC profile for the external network will be without network filter.

The output of creating a new VNIC profile depends in the body arguments that were given. In case no network filter was given, the default network filter will be configured. For example:

source,xml

<vnic_profile href=“/ovirt-engine/api/vnicprofiles/123” id=“123”>

<name>new_vNIC_name</name>
<link href="/ovirt-engine/api/vnicprofiles/123/permissions" rel="permissions"/>
<pass_through>
  <mode>disabled</mode>
</pass_through>
<port_mirroring>false</port_mirroring>
<network href="/ovirt-engine/api/networks/456" id="456"/>
<network_filter href="/ovirt-engine/api/networkfilters/789" id="789"/>

</vnic_profile>


In case an empty network filter was given, no network filter will be configured for the specific VNIC profile regardless of the VNIC profile's default network filter. For example:

source,xml

<vnic_profile>

<name>no_network_filter</name>
<network_filter/>

</vnic_profile>


In case that a specific valid network filter id was given, the VNIC profile will be configured with the given network filter regardless of the VNIC profiles's default network filter. For example:

source,xml

<vnic_profile>

<name>user_choice_network_filter</name>
<network_filter id= "0000001b-001b-001b-001b-0000000001d5"/>

</vnic_profile>


@param profile [VnicProfile] The vNIC profile that is being added.

@param opts [Hash] Additional options.

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

# File lib/ovirtsdk4/services.rb, line 36605
def add(profile, opts = {})
  internal_add(profile, VnicProfile, ADD, opts)
end
list(opts = {}) click to toggle source

List all vNIC profiles.

The order of the returned list of vNIC profiles isn't guaranteed.

@param opts [Hash] Additional options.

@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 [Integer] :max Sets the maximum number of profiles to return. If not specified all the profiles are returned.

@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 [Array<VnicProfile>]

# File lib/ovirtsdk4/services.rb, line 36639
def list(opts = {})
  internal_get(LIST, opts)
end
profile_service(id) click to toggle source

Locates the `profile` service.

@param id [String] The identifier of the `profile`.

@return [VnicProfileService] A reference to the `profile` service.

# File lib/ovirtsdk4/services.rb, line 36650
def profile_service(id)
  VnicProfileService.new(self, id)
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 36661
def service(path)
  if path.nil? || path == ''
    return self
  end
  index = path.index('/')
  if index.nil?
    return profile_service(path)
  end
  return profile_service(path[0..(index - 1)]).service(path[(index + 1)..-1])
end