Package com.xensource.xenapi
Class VIF
java.lang.Object
com.xensource.xenapi.XenAPIObject
com.xensource.xenapi.VIF
A virtual network interface
First published in XenServer 4.0.
- Author:
- Cloud Software Group, Inc.
-
Nested Class Summary
Nested Classes -
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionvoid
addIpv4Allowed
(Connection c, String value) Associates an IPv4 address with this VIF Minimum allowed role: pool-operator First published in XenServer 6.1.addIpv4AllowedAsync
(Connection c, String value) Associates an IPv4 address with this VIF Minimum allowed role: pool-operator First published in XenServer 6.1.void
addIpv6Allowed
(Connection c, String value) Associates an IPv6 address with this VIF Minimum allowed role: pool-operator First published in XenServer 6.1.addIpv6AllowedAsync
(Connection c, String value) Associates an IPv6 address with this VIF Minimum allowed role: pool-operator First published in XenServer 6.1.void
addToOtherConfig
(Connection c, String key, String value) Add the given key-value pair to the other_config field of the given VIF.void
addToQosAlgorithmParams
(Connection c, String key, String value) Add the given key-value pair to the qos/algorithm_params field of the given VIF.void
configureIpv4
(Connection c, Types.VifIpv4ConfigurationMode mode, String address, String gateway) Configure IPv4 settings for this virtual interface Minimum allowed role: vm-operator First published in XenServer 7.0.configureIpv4Async
(Connection c, Types.VifIpv4ConfigurationMode mode, String address, String gateway) Configure IPv4 settings for this virtual interface Minimum allowed role: vm-operator First published in XenServer 7.0.void
configureIpv6
(Connection c, Types.VifIpv6ConfigurationMode mode, String address, String gateway) Configure IPv6 settings for this virtual interface Minimum allowed role: vm-operator First published in XenServer 7.0.configureIpv6Async
(Connection c, Types.VifIpv6ConfigurationMode mode, String address, String gateway) Configure IPv6 settings for this virtual interface Minimum allowed role: vm-operator First published in XenServer 7.0.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 the specified VIF instance.Destroy the specified VIF instance.boolean
If obj is a VIF, compares XenAPI references for equality.getAll
(Connection c) Return a list of all the VIFs known to the system.Get the allowed_operations field of the given VIF.static Map<VIF,
VIF.Record> Return a map of VIF references to VIF records for all VIFs known to the system.static VIF
getByUuid
(Connection c, String uuid) Get a reference to the VIF instance with the specified UUID.Get the currently_attached field of the given VIF.Get the current_operations field of the given VIF.Get the device field of the given VIF.Get the ipv4_addresses field of the given VIF.Get the ipv4_allowed field of the given VIF.Get the ipv4_configuration_mode field of the given VIF.Get the ipv4_gateway field of the given VIF.Get the ipv6_addresses field of the given VIF.Get the ipv6_allowed field of the given VIF.Get the ipv6_configuration_mode field of the given VIF.Get the ipv6_gateway field of the given VIF.Get the locking_mode field of the given VIF.getMAC
(Connection c) Get the MAC field of the given VIF.Get the MAC_autogenerated field of the given VIF.Deprecated.since XenServer 6.1getMTU
(Connection c) Get the MTU field of the given VIF.Get the network field of the given VIF.Get the other_config field of the given VIF.Get the qos/algorithm_params field of the given VIF.Get the qos/algorithm_type field of the given VIF.Get the qos/supported_algorithms field of the given VIF.Get a record containing the current state of the given VIF.Get the runtime_properties field of the given VIF.Get the status_code field of the given VIF.Get the status_detail field of the given VIF.Get the uuid field of the given VIF.getVM
(Connection c) Get the VM field of the given VIF.int
hashCode()
void
move
(Connection c, Network network) Move the specified VIF to the specified network, even while the VM is running Minimum allowed role: vm-admin First published in XenServer 7.1.moveAsync
(Connection c, Network network) Move the specified VIF to the specified network, even while the VM is running Minimum allowed role: vm-admin First published in XenServer 7.1.void
plug
(Connection c) Hotplug the specified VIF, dynamically attaching it to the running VM Minimum allowed role: vm-admin First published in XenServer 4.0.Hotplug the specified VIF, dynamically attaching it to the running VM Minimum allowed role: vm-admin First published in XenServer 4.0.void
removeFromOtherConfig
(Connection c, String key) Remove the given key and its corresponding value from the other_config field of the given VIF.void
Remove the given key and its corresponding value from the qos/algorithm_params field of the given VIF.void
removeIpv4Allowed
(Connection c, String value) Removes an IPv4 address from this VIF Minimum allowed role: pool-operator First published in XenServer 6.1.removeIpv4AllowedAsync
(Connection c, String value) Removes an IPv4 address from this VIF Minimum allowed role: pool-operator First published in XenServer 6.1.void
removeIpv6Allowed
(Connection c, String value) Removes an IPv6 address from this VIF Minimum allowed role: pool-operator First published in XenServer 6.1.removeIpv6AllowedAsync
(Connection c, String value) Removes an IPv6 address from this VIF Minimum allowed role: pool-operator First published in XenServer 6.1.void
setIpv4Allowed
(Connection c, Set<String> value) Set the IPv4 addresses to which traffic on this VIF can be restricted Minimum allowed role: pool-operator First published in XenServer 6.1.setIpv4AllowedAsync
(Connection c, Set<String> value) Set the IPv4 addresses to which traffic on this VIF can be restricted Minimum allowed role: pool-operator First published in XenServer 6.1.void
setIpv6Allowed
(Connection c, Set<String> value) Set the IPv6 addresses to which traffic on this VIF can be restricted Minimum allowed role: pool-operator First published in XenServer 6.1.setIpv6AllowedAsync
(Connection c, Set<String> value) Set the IPv6 addresses to which traffic on this VIF can be restricted Minimum allowed role: pool-operator First published in XenServer 6.1.void
setLockingMode
(Connection c, Types.VifLockingMode value) Set the locking mode for this VIF Minimum allowed role: pool-operator First published in XenServer 6.1.Set the locking mode for this VIF Minimum allowed role: pool-operator First published in XenServer 6.1.void
setOtherConfig
(Connection c, Map<String, String> otherConfig) Set the other_config field of the given VIF.void
setQosAlgorithmParams
(Connection c, Map<String, String> algorithmParams) Set the qos/algorithm_params field of the given VIF.void
setQosAlgorithmType
(Connection c, String algorithmType) Set the qos/algorithm_type field of the given VIF.void
unplug
(Connection c) Hot-unplug the specified VIF, dynamically unattaching it from the running VM Minimum allowed role: vm-admin First published in XenServer 4.0.Hot-unplug the specified VIF, dynamically unattaching it from the running VM Minimum allowed role: vm-admin First published in XenServer 4.0.void
Forcibly unplug the specified VIF Minimum allowed role: vm-admin First published in XenServer 6.0.Forcibly unplug the specified VIF Minimum allowed role: vm-admin First published in XenServer 6.0.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 VIF, compares XenAPI references for equality. -
hashCode
public int hashCode() -
getRecord
public VIF.Record getRecord(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get a record containing the current state of the given VIF. Minimum allowed role: read-only First published in XenServer 4.0.- 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getByUuid
public static VIF getByUuid(Connection c, String uuid) throws Types.BadServerResponse, Types.XenAPIException, IOException Get a reference to the VIF instance with the specified UUID. Minimum allowed role: read-only First published in XenServer 4.0.- 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
create
public static VIF create(Connection c, VIF.Record record) throws Types.BadServerResponse, Types.XenAPIException, IOException Create a new VIF instance, and return its handle. Minimum allowed role: vm-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onrecord
- All constructor arguments- Returns:
- reference to the newly created object
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
createAsync
public static Task createAsync(Connection c, VIF.Record record) throws Types.BadServerResponse, Types.XenAPIException, IOException Create a new VIF instance, and return its handle. Minimum allowed role: vm-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onrecord
- All constructor arguments- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
destroy
public void destroy(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Destroy the specified VIF instance. Minimum allowed role: vm-admin First published in XenServer 4.0.- 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
destroyAsync
public Task destroyAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Destroy the specified VIF instance. Minimum allowed role: vm-admin First published in XenServer 4.0.- 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getUuid
public String getUuid(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the uuid field of the given VIF. Minimum allowed role: read-only First published in XenServer 4.0.- 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getAllowedOperations
public Set<Types.VifOperations> getAllowedOperations(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the allowed_operations field of the given VIF. Minimum allowed role: read-only First published in XenServer 4.0.- 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getCurrentOperations
public Map<String,Types.VifOperations> getCurrentOperations(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the current_operations field of the given VIF. Minimum allowed role: read-only First published in XenServer 4.0.- 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getDevice
public String getDevice(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the device field of the given VIF. Minimum allowed role: read-only First published in XenServer 4.0.- 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getNetwork
public Network getNetwork(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the network field of the given VIF. Minimum allowed role: read-only First published in XenServer 4.0.- 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getVM
Get the VM field of the given VIF. Minimum allowed role: read-only First published in XenServer 4.0.- 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getMAC
public String getMAC(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the MAC field of the given VIF. Minimum allowed role: read-only First published in XenServer 4.0.- 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getMTU
Get the MTU field of the given VIF. Minimum allowed role: read-only First published in XenServer 4.0.- 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getOtherConfig
public Map<String,String> getOtherConfig(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the other_config field of the given VIF. Minimum allowed role: read-only First published in XenServer 4.0.- 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getCurrentlyAttached
public Boolean getCurrentlyAttached(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the currently_attached field of the given VIF. Minimum allowed role: read-only First published in XenServer 4.0.- 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getStatusCode
public Long getStatusCode(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the status_code field of the given VIF. Minimum allowed role: read-only First published in XenServer 4.0.- 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getStatusDetail
public String getStatusDetail(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the status_detail field of the given VIF. Minimum allowed role: read-only First published in XenServer 4.0.- 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getRuntimeProperties
public Map<String,String> getRuntimeProperties(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the runtime_properties field of the given VIF. Minimum allowed role: read-only First published in XenServer 4.0.- 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getQosAlgorithmType
public String getQosAlgorithmType(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the qos/algorithm_type field of the given VIF. Minimum allowed role: read-only First published in XenServer 4.0.- 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getQosAlgorithmParams
public Map<String,String> getQosAlgorithmParams(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the qos/algorithm_params field of the given VIF. Minimum allowed role: read-only First published in XenServer 4.0.- 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getQosSupportedAlgorithms
public Set<String> getQosSupportedAlgorithms(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the qos/supported_algorithms field of the given VIF. Minimum allowed role: read-only First published in XenServer 4.0.- 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getMetrics
@Deprecated(since="XenServer 6.1") public VIFMetrics getMetrics(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 6.1Get the metrics field of the given VIF. Minimum allowed role: read-only First published in XenServer 4.0.- 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getMACAutogenerated
public Boolean getMACAutogenerated(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the MAC_autogenerated field of the given VIF. Minimum allowed role: read-only First published in XenServer 5.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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getLockingMode
public Types.VifLockingMode getLockingMode(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the locking_mode field of the given VIF. Minimum allowed role: read-only First published in XenServer 6.1.- 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getIpv4Allowed
public Set<String> getIpv4Allowed(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the ipv4_allowed field of the given VIF. Minimum allowed role: read-only First published in XenServer 6.1.- 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getIpv6Allowed
public Set<String> getIpv6Allowed(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the ipv6_allowed field of the given VIF. Minimum allowed role: read-only First published in XenServer 6.1.- 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getIpv4ConfigurationMode
public Types.VifIpv4ConfigurationMode getIpv4ConfigurationMode(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the ipv4_configuration_mode field of the given VIF. Minimum allowed role: read-only First published in XenServer 7.0.- 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getIpv4Addresses
public Set<String> getIpv4Addresses(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the ipv4_addresses field of the given VIF. Minimum allowed role: read-only First published in XenServer 7.0.- 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getIpv4Gateway
public String getIpv4Gateway(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the ipv4_gateway field of the given VIF. Minimum allowed role: read-only First published in XenServer 7.0.- 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getIpv6ConfigurationMode
public Types.VifIpv6ConfigurationMode getIpv6ConfigurationMode(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the ipv6_configuration_mode field of the given VIF. Minimum allowed role: read-only First published in XenServer 7.0.- 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getIpv6Addresses
public Set<String> getIpv6Addresses(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the ipv6_addresses field of the given VIF. Minimum allowed role: read-only First published in XenServer 7.0.- 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getIpv6Gateway
public String getIpv6Gateway(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the ipv6_gateway field of the given VIF. Minimum allowed role: read-only First published in XenServer 7.0.- 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setOtherConfig
public void setOtherConfig(Connection c, Map<String, String> otherConfig) throws Types.BadServerResponse, Types.XenAPIException, IOExceptionSet the other_config field of the given VIF. Minimum allowed role: vm-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onotherConfig
- New value to set- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
addToOtherConfig
public void addToOtherConfig(Connection c, String key, String value) throws Types.BadServerResponse, Types.XenAPIException, IOException Add the given key-value pair to the other_config field of the given VIF. Minimum allowed role: vm-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onkey
- Key to addvalue
- Value to add- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
removeFromOtherConfig
public void removeFromOtherConfig(Connection c, String key) throws Types.BadServerResponse, Types.XenAPIException, IOException Remove the given key and its corresponding value from the other_config field of the given VIF. If the key is not in that Map, then do nothing. Minimum allowed role: vm-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onkey
- Key to remove- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setQosAlgorithmType
public void setQosAlgorithmType(Connection c, String algorithmType) throws Types.BadServerResponse, Types.XenAPIException, IOException Set the qos/algorithm_type field of the given VIF. Minimum allowed role: vm-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onalgorithmType
- New value to set- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setQosAlgorithmParams
public void setQosAlgorithmParams(Connection c, Map<String, String> algorithmParams) throws Types.BadServerResponse, Types.XenAPIException, IOExceptionSet the qos/algorithm_params field of the given VIF. Minimum allowed role: vm-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onalgorithmParams
- New value to set- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
addToQosAlgorithmParams
public void addToQosAlgorithmParams(Connection c, String key, String value) throws Types.BadServerResponse, Types.XenAPIException, IOException Add the given key-value pair to the qos/algorithm_params field of the given VIF. Minimum allowed role: vm-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onkey
- Key to addvalue
- Value to add- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
removeFromQosAlgorithmParams
public void removeFromQosAlgorithmParams(Connection c, String key) throws Types.BadServerResponse, Types.XenAPIException, IOException Remove the given key and its corresponding value from the qos/algorithm_params field of the given VIF. If the key is not in that Map, then do nothing. Minimum allowed role: vm-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onkey
- Key to remove- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
plug
Hotplug the specified VIF, dynamically attaching it to the running VM Minimum allowed role: vm-admin First published in XenServer 4.0.- 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
plugAsync
public Task plugAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Hotplug the specified VIF, dynamically attaching it to the running VM Minimum allowed role: vm-admin First published in XenServer 4.0.- 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
unplug
Hot-unplug the specified VIF, dynamically unattaching it from the running VM Minimum allowed role: vm-admin First published in XenServer 4.0.- 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
unplugAsync
public Task unplugAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Hot-unplug the specified VIF, dynamically unattaching it from the running VM Minimum allowed role: vm-admin First published in XenServer 4.0.- 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
unplugForce
public void unplugForce(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Forcibly unplug the specified VIF Minimum allowed role: vm-admin First published in XenServer 6.0.- 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
unplugForceAsync
public Task unplugForceAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Forcibly unplug the specified VIF Minimum allowed role: vm-admin First published in XenServer 6.0.- 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
move
public void move(Connection c, Network network) throws Types.BadServerResponse, Types.XenAPIException, IOException Move the specified VIF to the specified network, even while the VM is running Minimum allowed role: vm-admin First published in XenServer 7.1.- Parameters:
c
- The connection the call is made onnetwork
- The network to move it to- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
moveAsync
public Task moveAsync(Connection c, Network network) throws Types.BadServerResponse, Types.XenAPIException, IOException Move the specified VIF to the specified network, even while the VM is running Minimum allowed role: vm-admin First published in XenServer 7.1.- Parameters:
c
- The connection the call is made onnetwork
- The network to move it to- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setLockingMode
public void setLockingMode(Connection c, Types.VifLockingMode value) throws Types.BadServerResponse, Types.XenAPIException, IOException Set the locking mode for this VIF Minimum allowed role: pool-operator First published in XenServer 6.1.- Parameters:
c
- The connection the call is made onvalue
- The new locking mode for the VIF- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setLockingModeAsync
public Task setLockingModeAsync(Connection c, Types.VifLockingMode value) throws Types.BadServerResponse, Types.XenAPIException, IOException Set the locking mode for this VIF Minimum allowed role: pool-operator First published in XenServer 6.1.- Parameters:
c
- The connection the call is made onvalue
- The new locking mode for the VIF- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setIpv4Allowed
public void setIpv4Allowed(Connection c, Set<String> value) throws Types.BadServerResponse, Types.XenAPIException, IOException Set the IPv4 addresses to which traffic on this VIF can be restricted Minimum allowed role: pool-operator First published in XenServer 6.1.- Parameters:
c
- The connection the call is made onvalue
- The IP addresses which will be associated with the VIF- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setIpv4AllowedAsync
public Task setIpv4AllowedAsync(Connection c, Set<String> value) throws Types.BadServerResponse, Types.XenAPIException, IOException Set the IPv4 addresses to which traffic on this VIF can be restricted Minimum allowed role: pool-operator First published in XenServer 6.1.- Parameters:
c
- The connection the call is made onvalue
- The IP addresses which will be associated with the VIF- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
addIpv4Allowed
public void addIpv4Allowed(Connection c, String value) throws Types.BadServerResponse, Types.XenAPIException, IOException Associates an IPv4 address with this VIF Minimum allowed role: pool-operator First published in XenServer 6.1.- Parameters:
c
- The connection the call is made onvalue
- The IP address which will be associated with the VIF- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
addIpv4AllowedAsync
public Task addIpv4AllowedAsync(Connection c, String value) throws Types.BadServerResponse, Types.XenAPIException, IOException Associates an IPv4 address with this VIF Minimum allowed role: pool-operator First published in XenServer 6.1.- Parameters:
c
- The connection the call is made onvalue
- The IP address which will be associated with the VIF- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
removeIpv4Allowed
public void removeIpv4Allowed(Connection c, String value) throws Types.BadServerResponse, Types.XenAPIException, IOException Removes an IPv4 address from this VIF Minimum allowed role: pool-operator First published in XenServer 6.1.- Parameters:
c
- The connection the call is made onvalue
- The IP address which will be removed from the VIF- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
removeIpv4AllowedAsync
public Task removeIpv4AllowedAsync(Connection c, String value) throws Types.BadServerResponse, Types.XenAPIException, IOException Removes an IPv4 address from this VIF Minimum allowed role: pool-operator First published in XenServer 6.1.- Parameters:
c
- The connection the call is made onvalue
- The IP address which will be removed from the VIF- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setIpv6Allowed
public void setIpv6Allowed(Connection c, Set<String> value) throws Types.BadServerResponse, Types.XenAPIException, IOException Set the IPv6 addresses to which traffic on this VIF can be restricted Minimum allowed role: pool-operator First published in XenServer 6.1.- Parameters:
c
- The connection the call is made onvalue
- The IP addresses which will be associated with the VIF- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setIpv6AllowedAsync
public Task setIpv6AllowedAsync(Connection c, Set<String> value) throws Types.BadServerResponse, Types.XenAPIException, IOException Set the IPv6 addresses to which traffic on this VIF can be restricted Minimum allowed role: pool-operator First published in XenServer 6.1.- Parameters:
c
- The connection the call is made onvalue
- The IP addresses which will be associated with the VIF- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
addIpv6Allowed
public void addIpv6Allowed(Connection c, String value) throws Types.BadServerResponse, Types.XenAPIException, IOException Associates an IPv6 address with this VIF Minimum allowed role: pool-operator First published in XenServer 6.1.- Parameters:
c
- The connection the call is made onvalue
- The IP address which will be associated with the VIF- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
addIpv6AllowedAsync
public Task addIpv6AllowedAsync(Connection c, String value) throws Types.BadServerResponse, Types.XenAPIException, IOException Associates an IPv6 address with this VIF Minimum allowed role: pool-operator First published in XenServer 6.1.- Parameters:
c
- The connection the call is made onvalue
- The IP address which will be associated with the VIF- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
removeIpv6Allowed
public void removeIpv6Allowed(Connection c, String value) throws Types.BadServerResponse, Types.XenAPIException, IOException Removes an IPv6 address from this VIF Minimum allowed role: pool-operator First published in XenServer 6.1.- Parameters:
c
- The connection the call is made onvalue
- The IP address which will be removed from the VIF- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
removeIpv6AllowedAsync
public Task removeIpv6AllowedAsync(Connection c, String value) throws Types.BadServerResponse, Types.XenAPIException, IOException Removes an IPv6 address from this VIF Minimum allowed role: pool-operator First published in XenServer 6.1.- Parameters:
c
- The connection the call is made onvalue
- The IP address which will be removed from the VIF- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
configureIpv4
public void configureIpv4(Connection c, Types.VifIpv4ConfigurationMode mode, String address, String gateway) throws Types.BadServerResponse, Types.XenAPIException, IOException Configure IPv4 settings for this virtual interface Minimum allowed role: vm-operator First published in XenServer 7.0.- Parameters:
c
- The connection the call is made onmode
- Whether to use static or no IPv4 assignmentaddress
- The IPv4 address in <addr>/<prefix length> format (for static mode only)gateway
- The IPv4 gateway (for static mode only; leave empty to not set a gateway)- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
configureIpv4Async
public Task configureIpv4Async(Connection c, Types.VifIpv4ConfigurationMode mode, String address, String gateway) throws Types.BadServerResponse, Types.XenAPIException, IOException Configure IPv4 settings for this virtual interface Minimum allowed role: vm-operator First published in XenServer 7.0.- Parameters:
c
- The connection the call is made onmode
- Whether to use static or no IPv4 assignmentaddress
- The IPv4 address in <addr>/<prefix length> format (for static mode only)gateway
- The IPv4 gateway (for static mode only; leave empty to not set a gateway)- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
configureIpv6
public void configureIpv6(Connection c, Types.VifIpv6ConfigurationMode mode, String address, String gateway) throws Types.BadServerResponse, Types.XenAPIException, IOException Configure IPv6 settings for this virtual interface Minimum allowed role: vm-operator First published in XenServer 7.0.- Parameters:
c
- The connection the call is made onmode
- Whether to use static or no IPv6 assignmentaddress
- The IPv6 address in <addr>/<prefix length> format (for static mode only)gateway
- The IPv6 gateway (for static mode only; leave empty to not set a gateway)- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
configureIpv6Async
public Task configureIpv6Async(Connection c, Types.VifIpv6ConfigurationMode mode, String address, String gateway) throws Types.BadServerResponse, Types.XenAPIException, IOException Configure IPv6 settings for this virtual interface Minimum allowed role: vm-operator First published in XenServer 7.0.- Parameters:
c
- The connection the call is made onmode
- Whether to use static or no IPv6 assignmentaddress
- The IPv6 address in <addr>/<prefix length> format (for static mode only)gateway
- The IPv6 gateway (for static mode only; leave empty to not set a gateway)- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getAll
public static Set<VIF> getAll(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Return a list of all the VIFs known to the system. Minimum allowed role: read-only First published in XenServer 4.0.- 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getAllRecords
public static Map<VIF,VIF.Record> getAllRecords(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Return a map of VIF references to VIF records for all VIFs known to the system. Minimum allowed role: read-only First published in XenServer 4.0.- 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-