org.ovirt.engine.sdk.decorators

Class VMNIC

java.lang.Object

org.ovirt.engine.sdk.entities.ActionableResource

org.ovirt.engine.sdk.entities.BaseResource

org.ovirt.engine.sdk.entities.BaseDevice

org.ovirt.engine.sdk.entities.NIC

org.ovirt.engine.sdk.decorators.VMNIC

public class VMNIC
extends NIC

VMNIC providing relation and functional services

to NIC.

Constructor Summary

Constructors

Constructor and Description
VMNIC(HttpProxyBroker proxy)

Method Summary

Modifier and Type	Method and Description
Action	activate(Action action) Performs activate action.
Action	activate(Action action, String correlationId) Performs activate action.
Action	deactivate(Action action) Performs deactivate action.
Action	deactivate(Action action, String correlationId) Performs deactivate action.
Response	delete() Deletes object.
Response	delete(Boolean async) Deletes object.
Response	delete(Boolean async, String correlationId) Deletes object.
VMNICReportedDevices	getReportedDevices() Gets the value of the VMNICReportedDevices property.
VMNICStatistics	getStatistics() Gets the value of the VMNICStatistics property.
VMNIC	update() Updates VMNIC object.
VMNIC	update(String correlationId) Updates VMNIC object.

Methods inherited from class org.ovirt.engine.sdk.entities.NIC

getActive, getBootProtocol, getInterface, getLinked, getMac, getNetwork, getOnBoot, getPlugged, getPortMirroring, getVnicProfile, isSetActive, isSetBootProtocol, isSetInterface, isSetLinked, isSetMac, isSetNetwork, isSetOnBoot, isSetPlugged, isSetPortMirroring, isSetReportedDevices, isSetStatistics, isSetVnicProfile, setActive, setBootProtocol, setInterface, setLinked, setMac, setNetwork, setOnBoot, setPlugged, setPortMirroring, setReportedDevices, setStatistics, setVnicProfile

Methods inherited from class org.ovirt.engine.sdk.entities.BaseDevice

getTemplate, getVm, isSetTemplate, isSetVm, setTemplate, setVm

Methods inherited from class org.ovirt.engine.sdk.entities.BaseResource

getComment, getCreationStatus, getDescription, getHref, getId, getLinks, getName, isSetComment, isSetCreationStatus, isSetDescription, isSetHref, isSetId, isSetLinks, isSetName, setComment, setCreationStatus, setDescription, setHref, setId, setName, unsetLinks

Methods inherited from class org.ovirt.engine.sdk.entities.ActionableResource

getActions, isSetActions, setActions

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VMNIC

public VMNIC(HttpProxyBroker proxy)

Parameters:

proxy - HttpProxyBroker

Method Detail

getReportedDevices

public VMNICReportedDevices getReportedDevices()

Gets the value of the VMNICReportedDevices property.

Overrides:

getReportedDevices in class NIC

Returns:

VMNICReportedDevices

getStatistics

public VMNICStatistics getStatistics()

Gets the value of the VMNICStatistics property.

Overrides:

getStatistics in class NIC

Returns:

VMNICStatistics

activate

public Action activate(Action action)
                throws org.apache.http.client.ClientProtocolException,
                       ServerException,
                       IOException

Performs activate action.

Parameters:

action - Action

Returns:

Action

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

activate

public Action activate(Action action,
                       String correlationId)
                throws org.apache.http.client.ClientProtocolException,
                       ServerException,
                       IOException

Performs activate action.

Parameters:

action - Action

correlationId -

    [any string]
    

Returns:

Action

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

update

public VMNIC update()
             throws org.apache.http.client.ClientProtocolException,
                    ServerException,
                    IOException

Updates VMNIC object.

Parameters:

nic - NIC

    Overload 1:

      update the network interface
      for the given virtual machine

      [nic.vnic_profile.id]
      [nic.linked]
      [nic.name]
      [nic.mac.address]
      [nic.interface]
      [nic.plugged]

    Overload 2:

      update the network interface
      for the given virtual machine
      with port mirroring options

      [nic.network.id|name]
      [nic.linked]
      [nic.name]
      [nic.mac.address]
      [nic.interface]
      [nic.port_mirroring.networks.network]
      [nic.plugged]
    

Returns:

VMNIC

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

update

public VMNIC update(String correlationId)
             throws org.apache.http.client.ClientProtocolException,
                    ServerException,
                    IOException

Updates VMNIC object.

Parameters:

nic - NIC

    Overload 1:

      update the network interface
      for the given virtual machine

      [nic.vnic_profile.id]
      [nic.linked]
      [nic.name]
      [nic.mac.address]
      [nic.interface]
      [nic.plugged]

    Overload 2:

      update the network interface
      for the given virtual machine
      with port mirroring options

      [nic.network.id|name]
      [nic.linked]
      [nic.name]
      [nic.mac.address]
      [nic.interface]
      [nic.port_mirroring.networks.network]
      [nic.plugged]
    

correlationId -

    [any string]
    

Returns:

VMNIC

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

delete

public Response delete()
                throws org.apache.http.client.ClientProtocolException,
                       ServerException,
                       IOException

Deletes object.

Returns:

Response

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

delete

public Response delete(Boolean async)
                throws org.apache.http.client.ClientProtocolException,
                       ServerException,
                       IOException

Deletes object.

Parameters:

async -

    [true|false]
    

Returns:

Response

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

delete

public Response delete(Boolean async,
                       String correlationId)
                throws org.apache.http.client.ClientProtocolException,
                       ServerException,
                       IOException

Deletes object.

Parameters:

correlationId -

    [any string]
    

async -

    [true|false]
    

Returns:

Response

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

deactivate

public Action deactivate(Action action)
                  throws org.apache.http.client.ClientProtocolException,
                         ServerException,
                         IOException

Performs deactivate action.

Parameters:

action - Action

Returns:

Action

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

deactivate

public Action deactivate(Action action,
                         String correlationId)
                  throws org.apache.http.client.ClientProtocolException,
                         ServerException,
                         IOException

Performs deactivate action.

Parameters:

action - Action

correlationId -

    [any string]
    

Returns:

Action

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.