com.xensource.xenapi

Class NetworkSriov

java.lang.Object

com.xensource.xenapi.XenAPIObject

com.xensource.xenapi.NetworkSriov

public class NetworkSriov
extends XenAPIObject

network-sriov which connects logical pif and physical pif First published in XenServer 7.5.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NetworkSriov.Record Represents all the fields in a NetworkSriov

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	ref The XenAPI reference (OpaqueRef) to this object.

Method Summary

Methods

Modifier and Type	Method and Description
static NetworkSriov	create(Connection c, PIF pif, Network network) Enable SR-IOV on the specific PIF.
static Task	createAsync(Connection c, PIF pif, Network network) Enable SR-IOV on the specific PIF.
void	destroy(Connection c) Disable SR-IOV on the specific PIF.
Task	destroyAsync(Connection c) Disable SR-IOV on the specific PIF.
boolean	equals(java.lang.Object obj) If obj is a NetworkSriov, compares XenAPI references for equality.
static java.util.Set<NetworkSriov>	getAll(Connection c) Return a list of all the network_sriovs known to the system.
static java.util.Map<NetworkSriov,NetworkSriov.Record>	getAllRecords(Connection c) Return a map of network_sriov references to network_sriov records for all network_sriovs known to the system.
static NetworkSriov	getByUuid(Connection c, java.lang.String uuid) Get a reference to the network_sriov instance with the specified UUID.
Types.SriovConfigurationMode	getConfigurationMode(Connection c) Get the configuration_mode field of the given network_sriov.
PIF	getLogicalPIF(Connection c) Get the logical_PIF field of the given network_sriov.
PIF	getPhysicalPIF(Connection c) Get the physical_PIF field of the given network_sriov.
NetworkSriov.Record	getRecord(Connection c) Get a record containing the current state of the given network_sriov.
java.lang.Long	getRemainingCapacity(Connection c) Get the number of free SR-IOV VFs on the associated PIF First published in XenServer 7.5.
Task	getRemainingCapacityAsync(Connection c) Get the number of free SR-IOV VFs on the associated PIF First published in XenServer 7.5.
java.lang.Boolean	getRequiresReboot(Connection c) Get the requires_reboot field of the given network_sriov.
java.lang.String	getUuid(Connection c) Get the uuid field of the given network_sriov.
int	hashCode()
java.lang.String	toWireString()

Methods inherited from class com.xensource.xenapi.XenAPIObject

isNull

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

ref

protected final java.lang.String ref

The XenAPI reference (OpaqueRef) to this object.

Method Detail

toWireString

public java.lang.String toWireString()

Specified by:

toWireString in class XenAPIObject

Returns:

The XenAPI reference (OpaqueRef) to this object.

equals

public boolean equals(java.lang.Object obj)

If obj is a NetworkSriov, compares XenAPI references for equality.

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getRecord

public NetworkSriov.Record getRecord(Connection c)
                              throws Types.BadServerResponse,
                                     Types.XenAPIException,
                                     org.apache.xmlrpc.XmlRpcException

Get a record containing the current state of the given network_sriov. First published in XenServer 7.5.

Returns:

all fields from the object

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getByUuid

public static NetworkSriov getByUuid(Connection c,
                     java.lang.String uuid)
                              throws Types.BadServerResponse,
                                     Types.XenAPIException,
                                     org.apache.xmlrpc.XmlRpcException

Get a reference to the network_sriov instance with the specified UUID. First published in XenServer 7.5.

Parameters:

uuid - UUID of object to return

Returns:

reference to the object

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getUuid

public java.lang.String getUuid(Connection c)
                         throws Types.BadServerResponse,
                                Types.XenAPIException,
                                org.apache.xmlrpc.XmlRpcException

Get the uuid field of the given network_sriov. First published in XenServer 7.5.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getPhysicalPIF

public PIF getPhysicalPIF(Connection c)
                   throws Types.BadServerResponse,
                          Types.XenAPIException,
                          org.apache.xmlrpc.XmlRpcException

Get the physical_PIF field of the given network_sriov. First published in XenServer 7.5.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getLogicalPIF

public PIF getLogicalPIF(Connection c)
                  throws Types.BadServerResponse,
                         Types.XenAPIException,
                         org.apache.xmlrpc.XmlRpcException

Get the logical_PIF field of the given network_sriov. First published in XenServer 7.5.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getRequiresReboot

public java.lang.Boolean getRequiresReboot(Connection c)
                                    throws Types.BadServerResponse,
                                           Types.XenAPIException,
                                           org.apache.xmlrpc.XmlRpcException

Get the requires_reboot field of the given network_sriov. First published in XenServer 7.5.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getConfigurationMode

public Types.SriovConfigurationMode getConfigurationMode(Connection c)
                                                  throws Types.BadServerResponse,
                                                         Types.XenAPIException,
                                                         org.apache.xmlrpc.XmlRpcException

Get the configuration_mode field of the given network_sriov. First published in XenServer 7.5.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

createAsync

public static Task createAsync(Connection c,
               PIF pif,
               Network network)
                        throws Types.BadServerResponse,
                               Types.XenAPIException,
                               org.apache.xmlrpc.XmlRpcException

Enable SR-IOV on the specific PIF. It will create a network-sriov based on the specific PIF and automatically create a logical PIF to connect the specific network. First published in XenServer 7.5.

Parameters:

pif - PIF on which to enable SR-IOV

network - Network to connect SR-IOV virtual functions with VM VIFs

Returns:

Task

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

create

public static NetworkSriov create(Connection c,
                  PIF pif,
                  Network network)
                           throws Types.BadServerResponse,
                                  Types.XenAPIException,
                                  org.apache.xmlrpc.XmlRpcException

Enable SR-IOV on the specific PIF. It will create a network-sriov based on the specific PIF and automatically create a logical PIF to connect the specific network. First published in XenServer 7.5.

Parameters:

pif - PIF on which to enable SR-IOV

network - Network to connect SR-IOV virtual functions with VM VIFs

Returns:

The reference of the created network_sriov object

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

destroyAsync

public Task destroyAsync(Connection c)
                  throws Types.BadServerResponse,
                         Types.XenAPIException,
                         org.apache.xmlrpc.XmlRpcException

Disable SR-IOV on the specific PIF. It will destroy the network-sriov and the logical PIF accordingly. First published in XenServer 7.5.

Returns:

Task

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

destroy

public void destroy(Connection c)
             throws Types.BadServerResponse,
                    Types.XenAPIException,
                    org.apache.xmlrpc.XmlRpcException

Disable SR-IOV on the specific PIF. It will destroy the network-sriov and the logical PIF accordingly. First published in XenServer 7.5.

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getRemainingCapacityAsync

public Task getRemainingCapacityAsync(Connection c)
                               throws Types.BadServerResponse,
                                      Types.XenAPIException,
                                      org.apache.xmlrpc.XmlRpcException

Get the number of free SR-IOV VFs on the associated PIF First published in XenServer 7.5.

Returns:

Task

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getRemainingCapacity

public java.lang.Long getRemainingCapacity(Connection c)
                                    throws Types.BadServerResponse,
                                           Types.XenAPIException,
                                           org.apache.xmlrpc.XmlRpcException

Get the number of free SR-IOV VFs on the associated PIF First published in XenServer 7.5.

Returns:

The number of free SR-IOV VFs on the associated PIF

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getAll

public static java.util.Set<NetworkSriov> getAll(Connection c)
                                          throws Types.BadServerResponse,
                                                 Types.XenAPIException,
                                                 org.apache.xmlrpc.XmlRpcException

Return a list of all the network_sriovs known to the system. First published in XenServer 7.5.

Returns:

references to all objects

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getAllRecords

public static java.util.Map<NetworkSriov,NetworkSriov.Record> getAllRecords(Connection c)
                                                                     throws Types.BadServerResponse,
                                                                            Types.XenAPIException,
                                                                            org.apache.xmlrpc.XmlRpcException

Return a map of network_sriov references to network_sriov records for all network_sriovs known to the system. First published in XenServer 7.5.

Returns:

records of all objects

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException