class OvirtSDK4::VmNicsService

Constants

ADD
LIST

Public Instance Methods

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

Adds a NIC to the virtual machine.

The following example adds to the virtual machine `123` a network interface named `mynic` using `virtio` and the NIC profile `456`.

source

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


source,xml

<nic>

<name>mynic</name>
<interface>virtio</interface>
<vnic_profile id="456"/>

</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>
<interface>virtio</interface>
<vnic_profile id="456"/>

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

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

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

Returns the list of NICs of the virtual machine.

The order of the returned list of NICs 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 NICs to return. If not specified all the NICs 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<Nic>]

# File lib/ovirtsdk4/services.rb, line 34429
def list(opts = {})
  internal_get(LIST, opts)
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 34440
def nic_service(id)
  VmNicService.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 34451
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