public class Connect
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
protected ConnectionPointer |
VCP
The native virConnectPtr.
|
Constructor and Description |
---|
Connect(java.lang.String uri)
Constructs a read-write Connect object from the supplied URI.
|
Connect(java.lang.String uri,
boolean readOnly)
Constructs a Connect object from the supplied URI.
|
Connect(java.lang.String uri,
ConnectAuth auth,
int flags)
Constructs a Connect object from the supplied URI, using the supplied
authentication callback
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
baselineCPU(java.lang.String[] xmlCPUs)
Computes the most feature-rich CPU which is compatible with all given
host CPUs.
|
int |
close()
Closes the connection to the hypervisor/driver.
|
CPUCompareResult |
compareCPU(java.lang.String xmlDesc)
Compares the given CPU description with the host CPU
|
static long |
connectionVersion(Connect conn)
Get the version of a connection.
|
static int[] |
convertUUIDBytes(byte[] bytes)
Helper function to convert bytes into ints for the UUID calls
|
static byte[] |
createUUIDBytes(int[] UUID)
Helper function to convert UUIDs into a stirng for the UUID calls
|
Device |
deviceCreateXML(java.lang.String xmlDesc)
Create a new device on the VM host machine, for example, virtual HBAs
created using vport_create.
|
Device |
deviceLookupByName(java.lang.String name)
Fetch a device based on its unique name
|
Domain |
domainCreateLinux(java.lang.String xmlDesc,
int flags)
Launches a new Linux guest domain.
|
Domain |
domainCreateXML(java.lang.String xmlDesc,
int flags)
Launch a new guest domain, based on an XML description
|
Domain |
domainDefineXML(java.lang.String xmlDesc)
Defines a domain, but does not start it
|
int |
domainEventDeregisterAny(int callbackID)
Removes an event callback.
|
int |
domainEventRegisterAny(Domain domain,
int eventId,
Libvirt.VirConnectDomainEventGenericCallback cb)
Adds a callback to receive notifications of arbitrary domain events
occurring on a domain.
|
Domain |
domainLookupByID(int id)
Finds a domain based on the hypervisor ID number.
|
Domain |
domainLookupByName(java.lang.String name)
Looks up a domain based on its name.
|
Domain |
domainLookupByUUID(int[] UUID)
Looks up a domain based on its UUID in array form.
|
Domain |
domainLookupByUUID(java.util.UUID uuid)
Fetch a domain based on its globally unique id
|
Domain |
domainLookupByUUIDString(java.lang.String UUID)
Looks up a domain based on its UUID in String form.
|
java.lang.String |
domainXMLFromNative(java.lang.String nativeFormat,
java.lang.String nativeConfig,
int flags)
Reads a native XML configuration document, and generates generates a
domain configuration file describing the domain.
|
java.lang.String |
domainXMLToNative(java.lang.String nativeFormat,
java.lang.String domainXML,
int flags)
Reads a domain XML configuration document, and generates generates a
native configuration file describing the domain.
|
protected void |
finalize() |
java.lang.String |
findStoragePoolSources(java.lang.String type,
java.lang.String srcSpecs,
int flags)
Talks to a storage backend and attempts to auto-discover the set of
available storage pool sources.
|
java.lang.String |
getCapabilities()
Provides capabilities of the hypervisor / driver.
|
long |
getCellsFreeMemory(int startCells,
int maxCells)
NUMA Support
|
long |
getFreeMemory()
Returns the free memory for the connection
|
java.lang.String |
getHostName()
Returns the system hostname on which the hypervisor is running.
|
long |
getHypervisorVersion(java.lang.String type)
Returns the version of the hypervisor against which the library was
compiled.
|
long |
getLibVirVersion()
Gets the version of the native libvirt library that the JNI part is
linked to.
|
int |
getMaxVcpus(java.lang.String type)
Provides the maximum number of virtual CPUs supported for a guest VM of a
specific type.
|
java.lang.String |
getType()
Gets the name of the Hypervisor software used.
|
java.lang.String |
getURI()
Returns the URI (name) of the hypervisor connection.
|
long |
getVersion()
Gets the version level of the Hypervisor running.
|
Interface |
interfaceDefineXML(java.lang.String xmlDesc)
Define an interface (or modify existing interface configuration)
|
Interface |
interfaceLookupByMACString(java.lang.String mac)
Try to lookup an interface on the given hypervisor based on its MAC.
|
Interface |
interfaceLookupByName(java.lang.String name)
Try to lookup an interface on the given hypervisor based on its name.
|
boolean |
isConnected()
Verify the connect is active.
|
int |
isEncrypted()
Determine if the connection is encrypted
|
int |
isSecure()
Determine if the connection is secure
|
java.lang.String[] |
listDefinedDomains()
Lists the names of the defined but inactive domains
|
java.lang.String[] |
listDefinedInterfaces()
Provides the list of names of defined interfaces on this host
|
java.lang.String[] |
listDefinedNetworks()
Lists the inactive networks
|
java.lang.String[] |
listDefinedStoragePools()
Provides the list of names of inactive storage pools.
|
java.lang.String[] |
listDevices(java.lang.String capabilityName)
List the names of the devices on this node
|
int[] |
listDomains()
Lists the active domains.
|
java.lang.String[] |
listInterfaces()
Provides the list of names of interfaces on this host
|
java.lang.String[] |
listNetworkFilters()
Lists the names of the network filters
|
java.lang.String[] |
listNetworks()
Lists the active networks.
|
java.lang.String[] |
listSecrets()
Retrieve the List UUIDs of defined secrets
|
java.lang.String[] |
listStoragePools()
Provides the list of names of active storage pools.
|
Network |
networkCreateXML(java.lang.String xmlDesc)
Creates and starts a new virtual network.
|
Network |
networkDefineXML(java.lang.String xmlDesc)
Defines a network, but does not create it.
|
NetworkFilter |
networkFilterDefineXML(java.lang.String xmlDesc)
Defines a networkFilter
|
NetworkFilter |
networkFilterLookupByName(java.lang.String name)
Fetch a network filter based on its unique name
|
NetworkFilter |
networkFilterLookupByUUID(int[] UUID)
Looks up a network filter based on its UUID in array form.
|
NetworkFilter |
networkFilterLookupByUUID(java.util.UUID uuid)
Fetch a network filter based on its globally unique id
|
NetworkFilter |
networkFilterLookupByUUIDString(java.lang.String UUID)
Looks up a network filter based on its UUID in String form.
|
Network |
networkLookupByName(java.lang.String name)
Looks up a network on the based on its name.
|
Network |
networkLookupByUUID(int[] UUID)
Deprecated.
use the UUIDString or UUID API.
|
Network |
networkLookupByUUID(java.util.UUID uuid)
Fetch a network based on its globally unique id
|
Network |
networkLookupByUUIDString(java.lang.String UUID)
Looks up a network based on its UUID represented as a String.
|
NodeInfo |
nodeInfo()
Returns a NodeInfo object describing the hardware configuration of the
node.
|
int |
numOfDefinedDomains()
Provides the number of inactive domains.
|
int |
numOfDefinedInterfaces()
Provides the number of defined interfaces.
|
int |
numOfDefinedNetworks()
Provides the number of inactive networks.
|
int |
numOfDefinedStoragePools()
Provides the number of inactive storage pools
|
int |
numOfDevices(java.lang.String capabilityName)
Provides the number of node devices.
|
int |
numOfDomains()
Provides the number of active domains.
|
int |
numOfInterfaces()
Provides the number of interfaces.
|
int |
numOfNetworkFilters()
Provides the number of network filters
|
int |
numOfNetworks()
Provides the number of active networks.
|
int |
numOfSecrets()
Fetch number of currently defined secrets.
|
int |
numOfStoragePools()
Provides the number of active storage pools
|
protected void |
processError()
call the error handling logic.
|
protected int |
processError(int ret)
Calls
processError() when the given libvirt return code
indicates an error. |
protected <T> T |
processError(T arg)
Calls
processError() if arg is null. |
void |
restore(java.lang.String from)
Restores a domain saved to disk by Domain.save().
|
Secret |
secretDefineXML(java.lang.String xmlDesc)
If XML specifies a UUID, locates the specified secret and replaces all
attributes of the secret specified by UUID by attributes specified in xml
(any attributes not specified in xml are discarded).
|
Secret |
secretLookupByUUID(int[] UUID)
Looks up a secret based on its UUID in array form.
|
Secret |
secretLookupByUUID(java.util.UUID uuid)
Fetch a secret based on its globally unique id
|
Secret |
secretLookupByUUIDString(java.lang.String UUID)
Looks up a secret based on its UUID in String form.
|
void |
setConnectionErrorCallback(Libvirt.VirErrorCallback callback) |
void |
setDom0Memory(long memory)
change the amount of memory reserved to Domain0.
|
static void |
setErrorCallback(Libvirt.VirErrorCallback callback)
Sets the error function to a user defined callback
|
StoragePool |
storagePoolCreateXML(java.lang.String xmlDesc,
int flags)
Create a new storage based on its XML description.
|
StoragePool |
storagePoolDefineXML(java.lang.String xml,
int flags)
Define a new inactive storage pool based on its XML description.
|
StoragePool |
storagePoolLookupByName(java.lang.String name)
Fetch a storage pool based on its unique name
|
StoragePool |
storagePoolLookupByUUID(int[] UUID)
Deprecated.
Use the UUIDString or UUID APIs.
|
StoragePool |
storagePoolLookupByUUID(java.util.UUID uuid)
Fetch a storage pool based on its globally unique id
|
StoragePool |
storagePoolLookupByUUIDString(java.lang.String UUID)
Fetch a storage pool based on its globally unique id
|
StorageVol |
storageVolLookupByKey(java.lang.String key)
Fetch a a storage volume based on its globally unique key
|
StorageVol |
storageVolLookupByPath(java.lang.String path)
Fetch a storage volume based on its locally (host) unique path
|
Stream |
streamNew(int flags)
Creates a new stream object which can be used to perform streamed I/O
with other public API function.
|
protected ConnectionPointer VCP
public Connect(java.lang.String uri) throws LibvirtException
uri
- The connection URILibvirtException
public Connect(java.lang.String uri, boolean readOnly) throws LibvirtException
uri
- The connection URIreadOnly
- Whether the connection is read-onlyLibvirtException
public Connect(java.lang.String uri, ConnectAuth auth, int flags) throws LibvirtException
uri
- The connection URIauth
- a ConnectAuth objectflags
- LibvirtException
public static long connectionVersion(Connect conn)
conn
- the connection to use.public static int[] convertUUIDBytes(byte[] bytes)
public static byte[] createUUIDBytes(int[] UUID)
public static void setErrorCallback(Libvirt.VirErrorCallback callback) throws LibvirtException
callback
- a Class to perform the callbackLibvirtException
public java.lang.String baselineCPU(java.lang.String[] xmlCPUs) throws LibvirtException
xmlCPUs
- array of XML descriptions of host CPUsLibvirtException
public int close() throws LibvirtException
LibvirtException
public CPUCompareResult compareCPU(java.lang.String xmlDesc) throws LibvirtException
xmlDesc
- LibvirtException
public Device deviceCreateXML(java.lang.String xmlDesc) throws LibvirtException
xmlDesc
- the device to createLibvirtException
public Device deviceLookupByName(java.lang.String name) throws LibvirtException
name
- name of device to fetchLibvirtException
public Domain domainCreateLinux(java.lang.String xmlDesc, int flags) throws LibvirtException
xmlDesc
- the Domain description in XMLflags
- an optional set of flags (unused)LibvirtException
public Domain domainCreateXML(java.lang.String xmlDesc, int flags) throws LibvirtException
xmlDesc
- LibvirtException
public Domain domainDefineXML(java.lang.String xmlDesc) throws LibvirtException
xmlDesc
- LibvirtException
public int domainEventDeregisterAny(int callbackID) throws LibvirtException
callbackID
- the callback to deregisterLibvirtException
public int domainEventRegisterAny(Domain domain, int eventId, Libvirt.VirConnectDomainEventGenericCallback cb) throws LibvirtException
domain
- option domain to limit the events monitoredeventId
- the events to monitorcb
- the callback function to use.LibvirtException
- on failurepublic Domain domainLookupByID(int id) throws LibvirtException
id
- the hypervisor idLibvirtException
public Domain domainLookupByName(java.lang.String name) throws LibvirtException
name
- the name of the domainLibvirtException
public Domain domainLookupByUUID(int[] UUID) throws LibvirtException
UUID
- the UUID as an unpacked int arrayLibvirtException
public Domain domainLookupByUUID(java.util.UUID uuid) throws LibvirtException
uuid
- a java UUIDLibvirtException
public Domain domainLookupByUUIDString(java.lang.String UUID) throws LibvirtException
UUID
- the UUID in canonical String representationLibvirtException
public java.lang.String domainXMLFromNative(java.lang.String nativeFormat, java.lang.String nativeConfig, int flags) throws LibvirtException
null
on errorLibvirtException
public java.lang.String domainXMLToNative(java.lang.String nativeFormat, java.lang.String domainXML, int flags) throws LibvirtException
null
on errorLibvirtException
protected void finalize() throws LibvirtException
finalize
in class java.lang.Object
LibvirtException
public java.lang.String findStoragePoolSources(java.lang.String type, java.lang.String srcSpecs, int flags) throws LibvirtException
type
- type of storage pool to discoversrcSpecs
- XML document specifying discovery sourcflags
- unusedLibvirtException
public java.lang.String getCapabilities() throws LibvirtException
LibvirtException
public long getCellsFreeMemory(int startCells, int maxCells) throws LibvirtException
LibvirtException
public long getFreeMemory() throws LibvirtException
LibvirtException
public java.lang.String getHostName() throws LibvirtException
LibvirtException
public long getHypervisorVersion(java.lang.String type) throws LibvirtException
type
- LibvirtException
public long getLibVirVersion() throws LibvirtException
LibvirtException
public int getMaxVcpus(java.lang.String type) throws LibvirtException
type
- LibvirtException
public java.lang.String getType() throws LibvirtException
LibvirtException
public java.lang.String getURI() throws LibvirtException
LibvirtException
public long getVersion() throws LibvirtException
LibvirtException
public Interface interfaceDefineXML(java.lang.String xmlDesc) throws LibvirtException
xmlDesc
- the interface to createLibvirtException
public Interface interfaceLookupByMACString(java.lang.String mac) throws LibvirtException
LibvirtException
public Interface interfaceLookupByName(java.lang.String name) throws LibvirtException
LibvirtException
public int isEncrypted() throws LibvirtException
LibvirtException
public int isSecure() throws LibvirtException
LibvirtException
public java.lang.String[] listDefinedDomains() throws LibvirtException
LibvirtException
public java.lang.String[] listDefinedInterfaces() throws LibvirtException
LibvirtException
public java.lang.String[] listDefinedNetworks() throws LibvirtException
LibvirtException
public java.lang.String[] listDefinedStoragePools() throws LibvirtException
LibvirtException
public java.lang.String[] listDevices(java.lang.String capabilityName) throws LibvirtException
capabilityName
- optional capability nameLibvirtException
public int[] listDomains() throws LibvirtException
LibvirtException
public java.lang.String[] listInterfaces() throws LibvirtException
LibvirtException
public java.lang.String[] listNetworkFilters() throws LibvirtException
LibvirtException
public java.lang.String[] listNetworks() throws LibvirtException
LibvirtException
public java.lang.String[] listSecrets() throws LibvirtException
LibvirtException
public java.lang.String[] listStoragePools() throws LibvirtException
LibvirtException
public Network networkCreateXML(java.lang.String xmlDesc) throws LibvirtException
xmlDesc
- the Network DescriptionLibvirtException
public Network networkDefineXML(java.lang.String xmlDesc) throws LibvirtException
xmlDesc
- LibvirtException
public NetworkFilter networkFilterDefineXML(java.lang.String xmlDesc) throws LibvirtException
xmlDesc
- the descirption of the filterLibvirtException
public NetworkFilter networkFilterLookupByName(java.lang.String name) throws LibvirtException
name
- name of network filter to fetchLibvirtException
public NetworkFilter networkFilterLookupByUUID(int[] UUID) throws LibvirtException
UUID
- the UUID as an unpacked int arrayLibvirtException
public NetworkFilter networkFilterLookupByUUID(java.util.UUID uuid) throws LibvirtException
uuid
- a java UUIDLibvirtException
public NetworkFilter networkFilterLookupByUUIDString(java.lang.String UUID) throws LibvirtException
UUID
- the UUID in canonical String representationLibvirtException
public Network networkLookupByName(java.lang.String name) throws LibvirtException
name
- name of the networkLibvirtException
@Deprecated public Network networkLookupByUUID(int[] UUID) throws LibvirtException
UUID
- the UUID as an unpacked int arrayLibvirtException
public Network networkLookupByUUID(java.util.UUID uuid) throws LibvirtException
uuid
- a java UUIDLibvirtException
public Network networkLookupByUUIDString(java.lang.String UUID) throws LibvirtException
UUID
- the UUID in canonical String representationLibvirtException
public NodeInfo nodeInfo() throws LibvirtException
LibvirtException
public int numOfDefinedDomains() throws LibvirtException
LibvirtException
public int numOfDefinedInterfaces() throws LibvirtException
LibvirtException
public int numOfDefinedNetworks() throws LibvirtException
LibvirtException
public int numOfDefinedStoragePools() throws LibvirtException
LibvirtException
public int numOfDevices(java.lang.String capabilityName) throws LibvirtException
LibvirtException
public int numOfDomains() throws LibvirtException
LibvirtException
public int numOfInterfaces() throws LibvirtException
LibvirtException
public int numOfNetworkFilters() throws LibvirtException
LibvirtException
public int numOfNetworks() throws LibvirtException
LibvirtException
public int numOfSecrets() throws LibvirtException
LibvirtException
public int numOfStoragePools() throws LibvirtException
LibvirtException
protected void processError() throws LibvirtException
LibvirtException
protected final int processError(int ret) throws LibvirtException
processError()
when the given libvirt return code
indicates an error.ret
- libvirt return code, indicating error if negative.ret
LibvirtException
protected final <T> T processError(T arg) throws LibvirtException
processError()
if arg
is null.arg
- An arbitrary object returned by libvirt.arg
LibvirtException
public void restore(java.lang.String from) throws LibvirtException
from
- the path of the saved file on the remote hostLibvirtException
public Secret secretDefineXML(java.lang.String xmlDesc) throws LibvirtException
xmlDesc
- the secret to createLibvirtException
public Secret secretLookupByUUID(int[] UUID) throws LibvirtException
UUID
- the UUID as an unpacked int arrayLibvirtException
public Secret secretLookupByUUID(java.util.UUID uuid) throws LibvirtException
uuid
- a java UUIDLibvirtException
public Secret secretLookupByUUIDString(java.lang.String UUID) throws LibvirtException
UUID
- the UUID in canonical String representationLibvirtException
public void setConnectionErrorCallback(Libvirt.VirErrorCallback callback) throws LibvirtException
LibvirtException
public void setDom0Memory(long memory) throws LibvirtException
memory
- in kilobytesLibvirtException
public StoragePool storagePoolCreateXML(java.lang.String xmlDesc, int flags) throws LibvirtException
xmlDesc
- XML description for new poolflags
- future flags, use 0 for nowLibvirtException
public StoragePool storagePoolDefineXML(java.lang.String xml, int flags) throws LibvirtException
xml
- XML description for new poolflags
- flags future flags, use 0 for nowLibvirtException
public StoragePool storagePoolLookupByName(java.lang.String name) throws LibvirtException
name
- name of pool to fetchLibvirtException
@Deprecated public StoragePool storagePoolLookupByUUID(int[] UUID) throws LibvirtException
UUID
- globally unique id of pool to fetchLibvirtException
public StoragePool storagePoolLookupByUUID(java.util.UUID uuid) throws LibvirtException
uuid
- a java UUIDLibvirtException
public StoragePool storagePoolLookupByUUIDString(java.lang.String UUID) throws LibvirtException
UUID
- globally unique id of pool to fetchLibvirtException
public StorageVol storageVolLookupByKey(java.lang.String key) throws LibvirtException
key
- globally unique keyLibvirtException
public StorageVol storageVolLookupByPath(java.lang.String path) throws LibvirtException
path
- locally unique pathLibvirtException
public Stream streamNew(int flags) throws LibvirtException
flags
- use Stream.VIR_STREAM_NONBLOCK if non-blocking is requiredLibvirtException
public boolean isConnected() throws LibvirtException
LibvirtException