class OvirtSDK4::VnicProfilesService

Public Class Methods

new(connection, path) click to toggle source

Creates a new implementation of the service.

@param connection [Connection] The connection to be used by this service.

@param path [String] The relative path of this service, for example `vms/123/disks`.

@api private

# File lib/ovirtsdk4/services.rb, line 33800
def initialize(connection, path)
  @connection = connection
  @path = path
end

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 <<services/network_filters,NetworkFilters>>.

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.

@return [VnicProfile]

# File lib/ovirtsdk4/services.rb, line 33877
def add(profile, opts = {})
  if profile.is_a?(Hash)
    profile = OvirtSDK4::VnicProfile.new(profile)
  end
  query = {}
  request = HttpRequest.new(method: :POST, url: @path, query: query)
  begin
    writer = XmlWriter.new(nil, true)
    VnicProfileWriter.write_one(profile, writer)
    request.body = writer.string
  ensure
    writer.close
  end
  response = @connection.send(request)
  case response.code
  when 200, 201, 202
    begin
      reader = XmlReader.new(response.body)
      return VnicProfileReader.read_one(reader)
    ensure
      reader.close
    end
  else
    check_fault(response)
  end
end
list(opts = {}) click to toggle source

List all vNIC profiles.

@param opts [Hash] Additional options.

@option opts [Integer] :max Sets the maximum number of profiles to return. If not specified all the profiles are returned.

@return [Array<VnicProfile>]

# File lib/ovirtsdk4/services.rb, line 33913
def list(opts = {})
  query = {}
  value = opts[:max]
  unless value.nil?
    value = Writer.render_integer(value)
    query['max'] = value
  end
  request = HttpRequest.new(method: :GET, url: @path, query: query)
  response = @connection.send(request)
  case response.code
  when 200
    begin
      reader = XmlReader.new(response.body)
      return VnicProfileReader.read_many(reader)
    ensure
      reader.close
    end
  else
    check_fault(response)
  end
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 33942
def profile_service(id)
  VnicProfileService.new(@connection, "#{@path}/#{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 33953
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
to_s() click to toggle source

Returns an string representation of this service.

@return [String]

# File lib/ovirtsdk4/services.rb, line 33969
def to_s
  "#<#{VnicProfilesService}:#{@path}>"
end