Package
Class
Tree
Deprecated
Index
Help
PREV NEXT
FRAMES
NO FRAMES
All Classes
A
B
C
D
E
F
G
H
I
L
M
N
O
P
R
S
T
U
V
W
A
attachDevice(String)
- Method in class org.libvirt.
VirDomain
Creates a virtual device attachment to backend.
B
blockStats(String)
- Method in class org.libvirt.
VirDomain
Returns block device (disk) stats for block devices attached to this domain.
C
callback(VirConnectCredential[])
- Method in class org.libvirt.
VirConnectAuth
The callback function that fills the credentials in
callback(VirConnectCredential[])
- Method in class org.libvirt.
VirConnectAuthDefault
challenge
- Variable in class org.libvirt.
VirConnectCredential
Additional challenge to show
close()
- Method in class org.libvirt.
VirConnect
Closes the connection to the hypervisor/driver.
coreDump(String, int)
- Method in class org.libvirt.
VirDomain
Dumps the core of this domain on a given file for analysis.
cores
- Variable in class org.libvirt.
VirNodeInfo
number of core per socket
cpu
- Variable in class org.libvirt.
VirVcpuInfo
cpus
- Variable in class org.libvirt.
VirNodeInfo
the number of active CPUs
cpuTime
- Variable in class org.libvirt.
VirDomainInfo
the CPU time used in nanoseconds
cpuTime
- Variable in class org.libvirt.
VirVcpuInfo
create()
- Method in class org.libvirt.
VirDomain
Launches this defined domain.
create()
- Method in class org.libvirt.
VirNetwork
Creates and starts this defined network.
credType
- Variable in class org.libvirt.
VirConnectAuth
List of supported VirConnectCredential.VirConnectCredentialType values
D
defresult
- Variable in class org.libvirt.
VirConnectCredential
Optional default result
destroy()
- Method in class org.libvirt.
VirDomain
Destroys this domain object.
destroy()
- Method in class org.libvirt.
VirNetwork
Destroy this network object.
detachDevice(String)
- Method in class org.libvirt.
VirDomain
Destroys a virtual device attachment to backend.
E
errs
- Variable in class org.libvirt.
VirDomainBlockStats
F
field
- Variable in class org.libvirt.
VirSchedParameter
Parameter name
finalize()
- Method in class org.libvirt.
VirConnect
finalize()
- Method in class org.libvirt.
VirNetwork
free()
- Method in class org.libvirt.
VirDomain
Frees this domain object.
free()
- Method in class org.libvirt.
VirNetwork
Frees this network object.
G
getAutostart()
- Method in class org.libvirt.
VirDomain
Provides a boolean value indicating whether the network is configured to be automatically started when the host machine boots.
getAutostart()
- Method in class org.libvirt.
VirNetwork
Provides a boolean value indicating whether this network is configured to be automatically started when the host machine boots.
getBridgeName()
- Method in class org.libvirt.
VirNetwork
Provides a bridge interface name to which a domain may connect a network interface in order to join this network.
getCapabilities()
- Method in class org.libvirt.
VirConnect
Provides capabilities of the hypervisor / driver.
getCode()
- Method in class org.libvirt.
VirError
Gets he error code
getConn()
- Method in class org.libvirt.
VirError
returns the Connection associated with the error, if available Deprecated, always throw an exception now
getConnect()
- Method in class org.libvirt.
VirDomain
Provides the connection object associated with a domain.
getConnect()
- Method in class org.libvirt.
VirNetwork
Provides the connection pointer associated with this network.
getDom()
- Method in class org.libvirt.
VirError
returns the Domain associated with the error, if available
getDomain()
- Method in class org.libvirt.
VirError
Tells What part of the library raised this error
getHostName()
- Method in class org.libvirt.
VirConnect
Returns the system hostname on which the hypervisor is running.
getID()
- Method in class org.libvirt.
VirDomain
Gets the hypervisor ID number for the domain
getInfo()
- Method in class org.libvirt.
VirDomain
Extract information about a domain.
getInt1()
- Method in class org.libvirt.
VirError
getInt2()
- Method in class org.libvirt.
VirError
getLevel()
- Method in class org.libvirt.
VirError
Tells how consequent is the error
getMaxMemory()
- Method in class org.libvirt.
VirDomain
Retrieve the maximum amount of physical memory allocated to a domain.
getMaxVcpus(String)
- Method in class org.libvirt.
VirConnect
Provides the maximum number of virtual CPUs supported for a guest VM of a specific type.
getMaxVcpus()
- Method in class org.libvirt.
VirDomain
Provides the maximum number of virtual CPUs supported for the guest VM.
getMessage()
- Method in class org.libvirt.
VirError
Returns human-readable informative error messag
getName()
- Method in class org.libvirt.
VirDomain
Gets the public name for this domain
getName()
- Method in class org.libvirt.
VirNetwork
Gets the public name for this network
getNet()
- Method in class org.libvirt.
VirError
Returns the network associated with the error, if available
getOSType()
- Method in class org.libvirt.
VirDomain
Gets the type of domain operation system.
getSchedulerParameters()
- Method in class org.libvirt.
VirDomain
Gets the scheduler parameters.
getSchedulerType()
- Method in class org.libvirt.
VirDomain
Gets the scheduler type.
getStr1()
- Method in class org.libvirt.
VirError
getStr2()
- Method in class org.libvirt.
VirError
getStr3()
- Method in class org.libvirt.
VirError
getType()
- Method in class org.libvirt.
VirConnect
Gets the name of the Hypervisor software used.
getTypeAsString()
- Method in class org.libvirt.
VirSchedBooleanParameter
getTypeAsString()
- Method in class org.libvirt.
VirSchedDoubleParameter
getTypeAsString()
- Method in class org.libvirt.
VirSchedIntParameter
getTypeAsString()
- Method in class org.libvirt.
VirSchedLongParameter
getTypeAsString()
- Method in class org.libvirt.
VirSchedParameter
Utility function for displaying the type
getTypeAsString()
- Method in class org.libvirt.
VirSchedUintParameter
getTypeAsString()
- Method in class org.libvirt.
VirSchedUlongParameter
getURI()
- Method in class org.libvirt.
VirConnect
Returns the URI (name) of the hypervisor connection.
getUUID()
- Method in class org.libvirt.
VirDomain
Get the UUID for this domain.
getUUID()
- Method in class org.libvirt.
VirNetwork
Gets the UUID for this network
getUUIDString()
- Method in class org.libvirt.
VirDomain
Gets the UUID for this domain as string.
getUUIDString()
- Method in class org.libvirt.
VirNetwork
Gets the UUID for a network as string.
getValueAsString()
- Method in class org.libvirt.
VirSchedBooleanParameter
getValueAsString()
- Method in class org.libvirt.
VirSchedDoubleParameter
getValueAsString()
- Method in class org.libvirt.
VirSchedIntParameter
getValueAsString()
- Method in class org.libvirt.
VirSchedLongParameter
getValueAsString()
- Method in class org.libvirt.
VirSchedParameter
Utility function for displaying the value
getValueAsString()
- Method in class org.libvirt.
VirSchedUintParameter
getValueAsString()
- Method in class org.libvirt.
VirSchedUlongParameter
getVcpusCpuMaps()
- Method in class org.libvirt.
VirDomain
Returns the cpumaps for this domain Only the lower 8 bits of each int in the array contain information.
getVcpusInfo()
- Method in class org.libvirt.
VirDomain
Extracts information about virtual CPUs of this domain
getVersion()
- Method in class org.libvirt.
VirConnect
Gets the version level of the Hypervisor running.
getVirError()
- Method in exception org.libvirt.
LibvirtException
Returns the underlying VirError objects that contains details about the cause of the exception
getXMLDesc(int)
- Method in class org.libvirt.
VirDomain
Provides an XML description of the domain.
getXMLDesc(int)
- Method in class org.libvirt.
VirNetwork
Provides an XML description of this network.
H
hasConn()
- Method in class org.libvirt.
VirError
Does this error has a valid Connection object attached? NOTE: deprecated, should return false
hasDom()
- Method in class org.libvirt.
VirError
Does this error has a valid VirDomain object attached? NOTE: deprecated, should return false
hasNet()
- Method in class org.libvirt.
VirError
Does this error has a valid VirNetwork object attached? NOTE: deprecated, should return false
I
interfaceStats(String)
- Method in class org.libvirt.
VirDomain
Returns network interface stats for interfaces attached to this domain.
L
LibvirtException
- Exception in
org.libvirt
This exception is thrown by all classes and methods of libvirt when the underlying libvirt library indicates an error
listDefinedDomains()
- Method in class org.libvirt.
VirConnect
Lists the names of the defined domains
listDefinedNetworks()
- Method in class org.libvirt.
VirConnect
Lists the inactive networks
listDomains()
- Method in class org.libvirt.
VirConnect
Lists the active domains.
listNetworks()
- Method in class org.libvirt.
VirConnect
Lists the active networks.
M
maxCpus()
- Method in class org.libvirt.
VirNodeInfo
maxMem
- Variable in class org.libvirt.
VirDomainInfo
the maximum memory in KBytes allowed
memory
- Variable in class org.libvirt.
VirDomainInfo
the memory in KBytes used by the domain
memory
- Variable in class org.libvirt.
VirNodeInfo
memory size in kilobytes
mhz
- Variable in class org.libvirt.
VirNodeInfo
expected CPU frequency
migrate(VirConnect, long, String, String, long)
- Method in class org.libvirt.
VirDomain
Migrate this domain object from its current host to the destination host given by dconn (a connection to the destination host).
model
- Variable in class org.libvirt.
VirNodeInfo
string indicating the CPU model
N
nodes
- Variable in class org.libvirt.
VirNodeInfo
the number of NUMA cell, 1 for uniform
nrVirtCpu
- Variable in class org.libvirt.
VirDomainInfo
the number of virtual CPUs for the domain
number
- Variable in class org.libvirt.
VirVcpuInfo
numOfDefinedDomains()
- Method in class org.libvirt.
VirConnect
Provides the number of inactive domains.
numOfDefinedNetworks()
- Method in class org.libvirt.
VirConnect
Provides the number of inactive networks.
numOfDomains()
- Method in class org.libvirt.
VirConnect
Provides the number of active domains.
numOfNetworks()
- Method in class org.libvirt.
VirConnect
Provides the number of active networks.
O
org.libvirt
- package org.libvirt
P
pinVcpu(int, int[])
- Method in class org.libvirt.
VirDomain
Dynamically changes the real CPUs which can be allocated to a virtual CPU.
prompt
- Variable in class org.libvirt.
VirConnectCredential
Prompt to show to user
R
rd_bytes
- Variable in class org.libvirt.
VirDomainBlockStats
rd_req
- Variable in class org.libvirt.
VirDomainBlockStats
reboot(int)
- Method in class org.libvirt.
VirDomain
Reboot this domain, the domain object is still usable there after but the domain OS is being stopped for a restart.
restore(String)
- Method in class org.libvirt.
VirConnect
Restores a domain saved to disk by VirDomain.save().
result
- Variable in class org.libvirt.
VirConnectCredential
Result to be filled with user response (or defresult)
resume()
- Method in class org.libvirt.
VirDomain
Resume this suspended domain, the process is restarted from the state where it was frozen by calling virSuspendDomain().
rx_bytes
- Variable in class org.libvirt.
VirDomainInterfaceStats
rx_drop
- Variable in class org.libvirt.
VirDomainInterfaceStats
rx_errs
- Variable in class org.libvirt.
VirDomainInterfaceStats
rx_packets
- Variable in class org.libvirt.
VirDomainInterfaceStats
S
save(String)
- Method in class org.libvirt.
VirDomain
Suspends this domain and saves its memory contents to a file on disk.
setAutostart(boolean)
- Method in class org.libvirt.
VirDomain
Configures the network to be automatically started when the host machine boots.
setAutostart(boolean)
- Method in class org.libvirt.
VirNetwork
Configures this network to be automatically started when the host machine boots.
setDom0Memory(long)
- Method in class org.libvirt.
VirConnect
change the amount of memory reserved to Domain0.
setMaxMemory(long)
- Method in class org.libvirt.
VirDomain
* Dynamically change the maximum amount of physical memory allocated to a domain.
setMemory(long)
- Method in class org.libvirt.
VirDomain
Dynamically changes the target amount of physical memory allocated to this domain.
setSchedulerParameters(VirSchedParameter[])
- Method in class org.libvirt.
VirDomain
Changes the scheduler parameters
setVcpus(int)
- Method in class org.libvirt.
VirDomain
Dynamically changes the number of virtual CPUs used by this domain.
shutdown()
- Method in class org.libvirt.
VirDomain
Shuts down this domain, the domain object is still usable there after but the domain OS is being stopped.
sockets
- Variable in class org.libvirt.
VirNodeInfo
number of CPU socket per node
state
- Variable in class org.libvirt.
VirDomainInfo
the running state, one of virDomainFlag
state
- Variable in class org.libvirt.
VirVcpuInfo
suspend()
- Method in class org.libvirt.
VirDomain
Suspends this active domain, the process is frozen without further access to CPU resources and I/O but the memory used by the domain at the hypervisor level will stay allocated.
T
threads
- Variable in class org.libvirt.
VirNodeInfo
number of threads per core
toString()
- Method in class org.libvirt.
VirDomainInfo
toString()
- Method in class org.libvirt.
VirError
tx_bytes
- Variable in class org.libvirt.
VirDomainInterfaceStats
tx_drop
- Variable in class org.libvirt.
VirDomainInterfaceStats
tx_errs
- Variable in class org.libvirt.
VirDomainInterfaceStats
tx_packets
- Variable in class org.libvirt.
VirDomainInterfaceStats
type
- Variable in class org.libvirt.
VirConnectCredential
One of virConnectCredentialType constants
U
undefine()
- Method in class org.libvirt.
VirDomain
undefines this domain but does not stop it if it is running
undefine()
- Method in class org.libvirt.
VirNetwork
Undefines this network but does not stop it if it is running
V
value
- Variable in class org.libvirt.
VirSchedBooleanParameter
The parameter value
value
- Variable in class org.libvirt.
VirSchedDoubleParameter
The parameter value
value
- Variable in class org.libvirt.
VirSchedIntParameter
value
- Variable in class org.libvirt.
VirSchedLongParameter
The parameter value
value
- Variable in class org.libvirt.
VirSchedUintParameter
The parameter value
value
- Variable in class org.libvirt.
VirSchedUlongParameter
The parameter value
valueOf(String)
- Static method in enum org.libvirt.
VirConnectCredential.VirConnectCredentialType
Returns the enum constant of this type with the specified name.
valueOf(String)
- Static method in enum org.libvirt.
VirDomainInfo.VirDomainState
Returns the enum constant of this type with the specified name.
valueOf(String)
- Static method in enum org.libvirt.
VirError.VirErrorDomain
Returns the enum constant of this type with the specified name.
valueOf(String)
- Static method in enum org.libvirt.
VirError.VirErrorLevel
Returns the enum constant of this type with the specified name.
valueOf(String)
- Static method in enum org.libvirt.
VirError.VirErrorNumber
Returns the enum constant of this type with the specified name.
valueOf(String)
- Static method in enum org.libvirt.
VirVcpuInfo.VirVcpuState
Returns the enum constant of this type with the specified name.
values()
- Static method in enum org.libvirt.
VirConnectCredential.VirConnectCredentialType
Returns an array containing the constants of this enum type, in the order they are declared.
values()
- Static method in enum org.libvirt.
VirDomainInfo.VirDomainState
Returns an array containing the constants of this enum type, in the order they are declared.
values()
- Static method in enum org.libvirt.
VirError.VirErrorDomain
Returns an array containing the constants of this enum type, in the order they are declared.
values()
- Static method in enum org.libvirt.
VirError.VirErrorLevel
Returns an array containing the constants of this enum type, in the order they are declared.
values()
- Static method in enum org.libvirt.
VirError.VirErrorNumber
Returns an array containing the constants of this enum type, in the order they are declared.
values()
- Static method in enum org.libvirt.
VirVcpuInfo.VirVcpuState
Returns an array containing the constants of this enum type, in the order they are declared.
VirConnect
- Class in
org.libvirt
The VirConnect object represents a connection to a local or remote hypervisor/driver.
VirConnect(String, boolean)
- Constructor for class org.libvirt.
VirConnect
Constructs a VirConnect object from the supplied URI.
VirConnect(String, VirConnectAuth, int)
- Constructor for class org.libvirt.
VirConnect
Constructs a VirConnect object from the supplied URI, using the supplied authentication callback
VirConnect(String)
- Constructor for class org.libvirt.
VirConnect
Constructs a read-write VirConnect object from the supplied URI.
VirConnectAuth
- Class in
org.libvirt
We diverge from the C implementation There is no explicit cbdata field, you should just add any extra data to the child class's instance.
VirConnectAuth()
- Constructor for class org.libvirt.
VirConnectAuth
VirConnectAuthDefault
- Class in
org.libvirt
VirConnectAuthDefault()
- Constructor for class org.libvirt.
VirConnectAuthDefault
VirConnectCredential
- Class in
org.libvirt
VirConnectCredential.VirConnectCredentialType
- Enum in
org.libvirt
VirDomain
- Class in
org.libvirt
VirDomainBlockStats
- Class in
org.libvirt
This class holds the counters for block device statistics.
VirDomainBlockStats()
- Constructor for class org.libvirt.
VirDomainBlockStats
virDomainCreateLinux(String, int)
- Method in class org.libvirt.
VirConnect
Launches a new Linux guest domain.
virDomainDefineXML(String)
- Method in class org.libvirt.
VirConnect
Defines a domain, but does not start it
VirDomainInfo
- Class in
org.libvirt
This object is returned by VirDomain.getInfo()
VirDomainInfo()
- Constructor for class org.libvirt.
VirDomainInfo
VirDomainInfo.VirDomainState
- Enum in
org.libvirt
VirDomainInterfaceStats
- Class in
org.libvirt
The VirDomain.interfaceStats method returns th network counters in this object
VirDomainInterfaceStats()
- Constructor for class org.libvirt.
VirDomainInterfaceStats
virDomainLookupByID(int)
- Method in class org.libvirt.
VirConnect
Finds a domain based on the hypervisor ID number.
virDomainLookupByName(String)
- Method in class org.libvirt.
VirConnect
Looks up a domain based on its name.
virDomainLookupByUUID(int[])
- Method in class org.libvirt.
VirConnect
Looks up a domain based on its UUID in array form.
virDomainLookupByUUIDString(String)
- Method in class org.libvirt.
VirConnect
Looks up a domain based on its UUID in String form.
VirError
- Class in
org.libvirt
VirError()
- Constructor for class org.libvirt.
VirError
VirError.VirErrorDomain
- Enum in
org.libvirt
VirError.VirErrorLevel
- Enum in
org.libvirt
VirError.VirErrorNumber
- Enum in
org.libvirt
VirErrorException
- Exception in
org.libvirt
This exception signals that a non-existing object was retrieved from the virError object
VirErrorException(String)
- Constructor for exception org.libvirt.
VirErrorException
virGetHypervisorVersion(String)
- Method in class org.libvirt.
VirConnect
Returns the version of the hypervisor against which the library was compiled.
virGetLibVirVersion()
- Method in class org.libvirt.
VirConnect
Gets the version of the native libvirt library that the JNI part is linked to.
VirNetwork
- Class in
org.libvirt
virNetworkCreateXML(String)
- Method in class org.libvirt.
VirConnect
Creates and starts a new virtual network.
virNetworkDefineXML(String)
- Method in class org.libvirt.
VirConnect
Defines a network, but does not create it.
virNetworkLookupByName(String)
- Method in class org.libvirt.
VirConnect
Looks up a network on the based on its name.
virNetworkLookupByUUID(int[])
- Method in class org.libvirt.
VirConnect
Looks up a network based on its UUID represented as an int array.
virNetworkLookupByUUIDString(String)
- Method in class org.libvirt.
VirConnect
Looks up a network based on its UUID represented as a String.
virNodeInfo()
- Method in class org.libvirt.
VirConnect
Returns a VirNodeInfo object describing the hardware configuration of the node.
VirNodeInfo
- Class in
org.libvirt
VirNodeInfo()
- Constructor for class org.libvirt.
VirNodeInfo
VirSchedBooleanParameter
- Class in
org.libvirt
Class for representing a boolean scheduler parameter
VirSchedBooleanParameter()
- Constructor for class org.libvirt.
VirSchedBooleanParameter
VirSchedDoubleParameter
- Class in
org.libvirt
Class for representing a double scheduler parameter
VirSchedDoubleParameter()
- Constructor for class org.libvirt.
VirSchedDoubleParameter
VirSchedIntParameter
- Class in
org.libvirt
VirSchedIntParameter()
- Constructor for class org.libvirt.
VirSchedIntParameter
VirSchedLongParameter
- Class in
org.libvirt
Class for representing a long int scheduler parameter
VirSchedLongParameter()
- Constructor for class org.libvirt.
VirSchedLongParameter
VirSchedParameter
- Class in
org.libvirt
The abstract parent of the actual VirSchedparameter classes
VirSchedParameter()
- Constructor for class org.libvirt.
VirSchedParameter
VirSchedUintParameter
- Class in
org.libvirt
Class for representing an unsigned int scheduler parameter
VirSchedUintParameter()
- Constructor for class org.libvirt.
VirSchedUintParameter
VirSchedUlongParameter
- Class in
org.libvirt
Class for representing an unsigned long int scheduler parameter
VirSchedUlongParameter()
- Constructor for class org.libvirt.
VirSchedUlongParameter
VirVcpuInfo
- Class in
org.libvirt
VirVcpuInfo()
- Constructor for class org.libvirt.
VirVcpuInfo
VirVcpuInfo.VirVcpuState
- Enum in
org.libvirt
W
wr_bytes
- Variable in class org.libvirt.
VirDomainBlockStats
wr_req
- Variable in class org.libvirt.
VirDomainBlockStats
A
B
C
D
E
F
G
H
I
L
M
N
O
P
R
S
T
U
V
W
Package
Class
Tree
Deprecated
Index
Help
PREV NEXT
FRAMES
NO FRAMES
All Classes