public class VIF extends XenAPIObject
Modifier and Type | Class and Description |
---|---|
static class |
VIF.Record
Represents all the fields in a VIF
|
Modifier and Type | Field and Description |
---|---|
protected java.lang.String |
ref
The XenAPI reference to this object.
|
Modifier and Type | Method and Description |
---|---|
void |
addToOtherConfig(Connection c,
java.lang.String key,
java.lang.String value)
Add the given key-value pair to the other_config field of the given VIF.
|
void |
addToQosAlgorithmParams(Connection c,
java.lang.String key,
java.lang.String value)
Add the given key-value pair to the qos/algorithm_params field of the given VIF.
|
static VIF |
create(Connection c,
VIF.Record record)
Create a new VIF instance, and return its handle.
|
static Task |
createAsync(Connection c,
VIF.Record record)
Create a new VIF instance, and return its handle.
|
void |
destroy(Connection c)
Destroy the specified VIF instance.
|
Task |
destroyAsync(Connection c)
Destroy the specified VIF instance.
|
boolean |
equals(java.lang.Object obj)
If obj is a VIF, compares XenAPI references for equality.
|
static java.util.Set<VIF> |
getAll(Connection c)
Return a list of all the VIFs known to the system.
|
java.util.Set<Types.VifOperations> |
getAllowedOperations(Connection c)
Get the allowed_operations field of the given VIF.
|
static java.util.Map<VIF,VIF.Record> |
getAllRecords(Connection c)
Return a map of VIF references to VIF records for all VIFs known to the system.
|
static VIF |
getByUuid(Connection c,
java.lang.String uuid)
Get a reference to the VIF instance with the specified UUID.
|
java.lang.Boolean |
getCurrentlyAttached(Connection c)
Get the currently_attached field of the given VIF.
|
java.util.Map<java.lang.String,Types.VifOperations> |
getCurrentOperations(Connection c)
Get the current_operations field of the given VIF.
|
java.lang.String |
getDevice(Connection c)
Get the device field of the given VIF.
|
java.lang.String |
getMAC(Connection c)
Get the MAC field of the given VIF.
|
java.lang.Boolean |
getMACAutogenerated(Connection c)
Get the MAC_autogenerated field of the given VIF.
|
VIFMetrics |
getMetrics(Connection c)
Get the metrics field of the given VIF.
|
java.lang.Long |
getMTU(Connection c)
Get the MTU field of the given VIF.
|
Network |
getNetwork(Connection c)
Get the network field of the given VIF.
|
java.util.Map<java.lang.String,java.lang.String> |
getOtherConfig(Connection c)
Get the other_config field of the given VIF.
|
java.util.Map<java.lang.String,java.lang.String> |
getQosAlgorithmParams(Connection c)
Get the qos/algorithm_params field of the given VIF.
|
java.lang.String |
getQosAlgorithmType(Connection c)
Get the qos/algorithm_type field of the given VIF.
|
java.util.Set<java.lang.String> |
getQosSupportedAlgorithms(Connection c)
Get the qos/supported_algorithms field of the given VIF.
|
VIF.Record |
getRecord(Connection c)
Get a record containing the current state of the given VIF.
|
java.util.Map<java.lang.String,java.lang.String> |
getRuntimeProperties(Connection c)
Get the runtime_properties field of the given VIF.
|
java.lang.Long |
getStatusCode(Connection c)
Get the status_code field of the given VIF.
|
java.lang.String |
getStatusDetail(Connection c)
Get the status_detail field of the given VIF.
|
java.lang.String |
getUuid(Connection c)
Get the uuid field of the given VIF.
|
VM |
getVM(Connection c)
Get the VM field of the given VIF.
|
int |
hashCode() |
void |
plug(Connection c)
Hotplug the specified VIF, dynamically attaching it to the running VM
|
Task |
plugAsync(Connection c)
Hotplug the specified VIF, dynamically attaching it to the running VM
|
void |
removeFromOtherConfig(Connection c,
java.lang.String key)
Remove the given key and its corresponding value from the other_config field of the given VIF.
|
void |
removeFromQosAlgorithmParams(Connection c,
java.lang.String key)
Remove the given key and its corresponding value from the qos/algorithm_params field of the given VIF.
|
void |
setOtherConfig(Connection c,
java.util.Map<java.lang.String,java.lang.String> otherConfig)
Set the other_config field of the given VIF.
|
void |
setQosAlgorithmParams(Connection c,
java.util.Map<java.lang.String,java.lang.String> algorithmParams)
Set the qos/algorithm_params field of the given VIF.
|
void |
setQosAlgorithmType(Connection c,
java.lang.String algorithmType)
Set the qos/algorithm_type field of the given VIF.
|
java.lang.String |
toWireString() |
void |
unplug(Connection c)
Hot-unplug the specified VIF, dynamically unattaching it from the running VM
|
Task |
unplugAsync(Connection c)
Hot-unplug the specified VIF, dynamically unattaching it from the running VM
|
public java.lang.String toWireString()
toWireString
in class XenAPIObject
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public VIF.Record getRecord(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public static VIF getByUuid(Connection c, java.lang.String uuid) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
uuid
- UUID of object to returnTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public static Task createAsync(Connection c, VIF.Record record) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
record
- All constructor argumentsTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public static VIF create(Connection c, VIF.Record record) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
record
- All constructor argumentsTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public Task destroyAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void destroy(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public java.lang.String getUuid(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public java.util.Set<Types.VifOperations> getAllowedOperations(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public java.util.Map<java.lang.String,Types.VifOperations> getCurrentOperations(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public java.lang.String getDevice(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public Network getNetwork(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public VM getVM(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public java.lang.String getMAC(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public java.lang.Long getMTU(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public java.util.Map<java.lang.String,java.lang.String> getOtherConfig(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public java.lang.Boolean getCurrentlyAttached(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public java.lang.Long getStatusCode(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public java.lang.String getStatusDetail(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public java.util.Map<java.lang.String,java.lang.String> getRuntimeProperties(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public java.lang.String getQosAlgorithmType(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public java.util.Map<java.lang.String,java.lang.String> getQosAlgorithmParams(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public java.util.Set<java.lang.String> getQosSupportedAlgorithms(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public VIFMetrics getMetrics(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public java.lang.Boolean getMACAutogenerated(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void setOtherConfig(Connection c, java.util.Map<java.lang.String,java.lang.String> otherConfig) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
otherConfig
- New value to setTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void addToOtherConfig(Connection c, java.lang.String key, java.lang.String value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
key
- Key to addvalue
- Value to addTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void removeFromOtherConfig(Connection c, java.lang.String key) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
key
- Key to removeTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void setQosAlgorithmType(Connection c, java.lang.String algorithmType) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
algorithmType
- New value to setTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void setQosAlgorithmParams(Connection c, java.util.Map<java.lang.String,java.lang.String> algorithmParams) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
algorithmParams
- New value to setTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void addToQosAlgorithmParams(Connection c, java.lang.String key, java.lang.String value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
key
- Key to addvalue
- Value to addTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void removeFromQosAlgorithmParams(Connection c, java.lang.String key) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
key
- Key to removeTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public Task plugAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void plug(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public Task unplugAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void unplug(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public static java.util.Set<VIF> getAll(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public static java.util.Map<VIF,VIF.Record> getAllRecords(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException