class OvirtSDK4::VmNicsService

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 31731
def initialize(connection, path)
  @connection = connection
  @path = path
end

Public Instance Methods

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

Adds a NIC to the virtual machine.

The following example adds a network interface named `mynic` using `virtio` and the `ovirtmgmt` network to the virtual machine.

source

POST /ovirt-engine/api/vms/123/nics


source,xml

<nic>

<interface>virtio</interface>
<name>mynic</name>
<network>
  <name>ovirtmgmt</name>
</network>

</nic>


The following example sends that request using `curl`:

source,bash

curl \ –request POST \ –header “Version: 4” \ –header “Content-Type: application/xml” \ –header “Accept: application/xml” \ –user “admin@internal:mypassword” \ –cacert /etc/pki/ovirt-engine/ca.pem \ –data ' <nic>

<name>mynic</name>
<network>
  <name>ovirtmgmt</name>
</network>

</nic> ' \ myengine.example.com/ovirt-engine/api/vms/123/nics


IMPORTANT

The hotplugging feature only supports virtual machine operating systems with hotplugging operations. Example operating systems include:

  • Red Hat Enterprise Linux 6

  • Red Hat Enterprise Linux 5

  • Windows Server 2008 and

  • Windows Server 2003

@param nic [Nic] The `nic` to add.

@param opts [Hash] Additional options.

@return [Nic]

# File lib/ovirtsdk4/services.rb, line 31797
def add(nic, opts = {})
  if nic.is_a?(Hash)
    nic = OvirtSDK4::Nic.new(nic)
  end
  query = {}
  request = HttpRequest.new(method: :POST, url: @path, query: query)
  begin
    writer = XmlWriter.new(nil, true)
    NicWriter.write_one(nic, 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 NicReader.read_one(reader)
    ensure
      reader.close
    end
  else
    check_fault(response)
  end
end
list(opts = {}) click to toggle source

Returns the representation of the object managed by this service.

@param opts [Hash] Additional options.

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

@return [Array<Nic>]

# File lib/ovirtsdk4/services.rb, line 31833
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 NicReader.read_many(reader)
    ensure
      reader.close
    end
  else
    check_fault(response)
  end
end
nic_service(id) click to toggle source

Locates the `nic` service.

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

@return [VmNicService] A reference to the `nic` service.

# File lib/ovirtsdk4/services.rb, line 31862
def nic_service(id)
  VmNicService.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 31873
def service(path)
  if path.nil? || path == ''
    return self
  end
  index = path.index('/')
  if index.nil?
    return nic_service(path)
  end
  return nic_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 31889
def to_s
  "#<#{VmNicsService}:#{@path}>"
end