Package com.xensource.xenapi
Class NetworkSriov
java.lang.Object
com.xensource.xenapi.XenAPIObject
com.xensource.xenapi.NetworkSriov
network-sriov which connects logical pif and physical pif
First published in XenServer 7.5.
- Author:
- Cloud Software Group, Inc.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
Represents all the fields in a NetworkSriov -
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionstatic 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
Disable SR-IOV on the specific PIF.Disable SR-IOV on the specific PIF.boolean
If obj is a NetworkSriov, compares XenAPI references for equality.static Set<NetworkSriov>
getAll
(Connection c) Return a list of all the network_sriovs known to the system.static Map<NetworkSriov,
NetworkSriov.Record> Return a map of network_sriov references to network_sriov records for all network_sriovs known to the system.static NetworkSriov
getByUuid
(Connection c, String uuid) Get a reference to the network_sriov instance with the specified UUID.Get the configuration_mode field of the given network_sriov.Get the logical_PIF field of the given network_sriov.Get the physical_PIF field of the given network_sriov.Get a record containing the current state of the given network_sriov.Get the number of free SR-IOV VFs on the associated PIF Minimum allowed role: read-only First published in XenServer 7.5.Get the number of free SR-IOV VFs on the associated PIF Minimum allowed role: read-only First published in XenServer 7.5.Get the requires_reboot field of the given network_sriov.Get the uuid field of the given network_sriov.int
hashCode()
Methods inherited from class com.xensource.xenapi.XenAPIObject
isNull
-
Field Details
-
ref
The XenAPI reference (OpaqueRef) to this object.
-
-
Method Details
-
toWireString
- Specified by:
toWireString
in classXenAPIObject
- Returns:
- The XenAPI reference (OpaqueRef) to this object.
-
equals
If obj is a NetworkSriov, compares XenAPI references for equality. -
hashCode
public int hashCode() -
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. Minimum allowed role: read-only First published in XenServer 7.5.- Parameters:
c
- The connection the call is made on- Returns:
- all fields from the object
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
getByUuid
public static NetworkSriov getByUuid(Connection c, String uuid) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Get a reference to the network_sriov instance with the specified UUID. Minimum allowed role: read-only First published in XenServer 7.5.- Parameters:
c
- The connection the call is made onuuid
- UUID of object to return- Returns:
- reference to the object
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
getUuid
public String getUuid(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Get the uuid field of the given network_sriov. Minimum allowed role: read-only First published in XenServer 7.5.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
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. Minimum allowed role: read-only First published in XenServer 7.5.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
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. Minimum allowed role: read-only First published in XenServer 7.5.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
getRequiresReboot
public Boolean getRequiresReboot(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Get the requires_reboot field of the given network_sriov. Minimum allowed role: read-only First published in XenServer 7.5.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
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. Minimum allowed role: read-only First published in XenServer 7.5.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
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. Minimum allowed role: pool-operator First published in XenServer 7.5.- Parameters:
c
- The connection the call is made onpif
- PIF on which to enable SR-IOVnetwork
- Network to connect SR-IOV virtual functions with VM VIFs- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
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. Minimum allowed role: pool-operator First published in XenServer 7.5.- Parameters:
c
- The connection the call is made onpif
- PIF on which to enable SR-IOVnetwork
- Network to connect SR-IOV virtual functions with VM VIFs- Returns:
- The reference of the created network_sriov object
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
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. Minimum allowed role: pool-operator First published in XenServer 7.5.- Parameters:
c
- The connection the call is made on- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
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. Minimum allowed role: pool-operator First published in XenServer 7.5.- Parameters:
c
- The connection the call is made on- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
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 Minimum allowed role: read-only First published in XenServer 7.5.- Parameters:
c
- The connection the call is made on- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
getRemainingCapacity
public 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 Minimum allowed role: read-only First published in XenServer 7.5.- Parameters:
c
- The connection the call is made on- Returns:
- The number of free SR-IOV VFs on the associated PIF
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
getAll
public static 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. Minimum allowed role: read-only First published in XenServer 7.5.- Parameters:
c
- The connection the call is made on- Returns:
- references to all objects
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
getAllRecords
public static 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. Minimum allowed role: read-only First published in XenServer 7.5.- Parameters:
c
- The connection the call is made on- Returns:
- records of all objects
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-