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.
Domain
Creates a virtual device attachment to backend.
B
blockStats(String)
- Method in class org.libvirt.
Domain
Returns block device (disk) stats for block devices attached to this domain.
C
callback(ConnectAuth.Credential[])
- Method in class org.libvirt.
ConnectAuth
The callback function that fills the credentials in
callback(ConnectAuth.Credential[])
- Method in class org.libvirt.
ConnectAuthDefault
challenge
- Variable in class org.libvirt.
ConnectAuth.Credential
Additional challenge to show
close()
- Method in class org.libvirt.
Connect
Closes the connection to the hypervisor/driver.
Connect
- Class in
org.libvirt
The Connect object represents a connection to a local or remote hypervisor/driver.
Connect(String, boolean)
- Constructor for class org.libvirt.
Connect
Constructs a Connect object from the supplied URI.
Connect(String, ConnectAuth, int)
- Constructor for class org.libvirt.
Connect
Constructs a Connect object from the supplied URI, using the supplied authentication callback
Connect(String)
- Constructor for class org.libvirt.
Connect
Constructs a read-write Connect object from the supplied URI.
ConnectAuth
- 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.
ConnectAuth()
- Constructor for class org.libvirt.
ConnectAuth
ConnectAuth.Credential
- Class in
org.libvirt
ConnectAuth.CredentialType
- Enum in
org.libvirt
ConnectAuthDefault
- Class in
org.libvirt
ConnectAuthDefault()
- Constructor for class org.libvirt.
ConnectAuthDefault
coreDump(String, int)
- Method in class org.libvirt.
Domain
Dumps the core of this domain on a given file for analysis.
cores
- Variable in class org.libvirt.
NodeInfo
number of core per socket
cpu
- Variable in class org.libvirt.
VcpuInfo
cpus
- Variable in class org.libvirt.
NodeInfo
the number of active CPUs
cpuTime
- Variable in class org.libvirt.
DomainInfo
the CPU time used in nanoseconds
cpuTime
- Variable in class org.libvirt.
VcpuInfo
create()
- Method in class org.libvirt.
Domain
Launches this defined domain.
create()
- Method in class org.libvirt.
Network
Creates and starts this defined network.
credType
- Variable in class org.libvirt.
ConnectAuth
List of supported ConnectCredential.CredentialType values
D
defresult
- Variable in class org.libvirt.
ConnectAuth.Credential
Optional default result
destroy()
- Method in class org.libvirt.
Domain
Destroys this domain object.
destroy()
- Method in class org.libvirt.
Network
Destroy this network object.
detachDevice(String)
- Method in class org.libvirt.
Domain
Destroys a virtual device attachment to backend.
Domain
- Class in
org.libvirt
DomainBlockStats
- Class in
org.libvirt
This class holds the counters for block device statistics.
DomainBlockStats()
- Constructor for class org.libvirt.
DomainBlockStats
domainCreateLinux(String, int)
- Method in class org.libvirt.
Connect
Launches a new Linux guest domain.
domainDefineXML(String)
- Method in class org.libvirt.
Connect
Defines a domain, but does not start it
DomainInfo
- Class in
org.libvirt
This object is returned by Domain.getInfo()
DomainInfo()
- Constructor for class org.libvirt.
DomainInfo
DomainInfo.DomainState
- Enum in
org.libvirt
DomainInterfaceStats
- Class in
org.libvirt
The Domain.interfaceStats method returns th network counters in this object
DomainInterfaceStats()
- Constructor for class org.libvirt.
DomainInterfaceStats
domainLookupByID(int)
- Method in class org.libvirt.
Connect
Finds a domain based on the hypervisor ID number.
domainLookupByName(String)
- Method in class org.libvirt.
Connect
Looks up a domain based on its name.
domainLookupByUUID(int[])
- Method in class org.libvirt.
Connect
Looks up a domain based on its UUID in array form.
domainLookupByUUIDString(String)
- Method in class org.libvirt.
Connect
Looks up a domain based on its UUID in String form.
E
Error
- Class in
org.libvirt
Error()
- Constructor for class org.libvirt.
Error
Error.ErrorDomain
- Enum in
org.libvirt
Error.ErrorLevel
- Enum in
org.libvirt
Error.ErrorNumber
- Enum in
org.libvirt
ErrorException
- Exception in
org.libvirt
This exception signals that a non-existing object was retrieved from the virError object
ErrorException(String)
- Constructor for exception org.libvirt.
ErrorException
errs
- Variable in class org.libvirt.
DomainBlockStats
F
field
- Variable in class org.libvirt.
SchedParameter
Parameter name
finalize()
- Method in class org.libvirt.
Connect
finalize()
- Method in class org.libvirt.
Network
free()
- Method in class org.libvirt.
Domain
Frees this domain object.
free()
- Method in class org.libvirt.
Network
Frees this network object.
G
getAutostart()
- Method in class org.libvirt.
Domain
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.
Network
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.
Network
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.
Connect
Provides capabilities of the hypervisor / driver.
getCode()
- Method in class org.libvirt.
Error
Gets he error code
getConn()
- Method in class org.libvirt.
Error
returns the Connection associated with the error, if available Deprecated, always throw an exception now
getConnect()
- Method in class org.libvirt.
Domain
Provides the connection object associated with a domain.
getConnect()
- Method in class org.libvirt.
Network
Provides the connection pointer associated with this network.
getDom()
- Method in class org.libvirt.
Error
returns the Domain associated with the error, if available
getDomain()
- Method in class org.libvirt.
Error
Tells What part of the library raised this error
getError()
- Method in exception org.libvirt.
LibvirtException
Returns the underlying Error objects that contains details about the cause of the exception
getHostName()
- Method in class org.libvirt.
Connect
Returns the system hostname on which the hypervisor is running.
GetHypervisorVersion(String)
- Method in class org.libvirt.
Connect
Returns the version of the hypervisor against which the library was compiled.
getID()
- Method in class org.libvirt.
Domain
Gets the hypervisor ID number for the domain
getInfo()
- Method in class org.libvirt.
Domain
Extract information about a domain.
getInt1()
- Method in class org.libvirt.
Error
getInt2()
- Method in class org.libvirt.
Error
getLevel()
- Method in class org.libvirt.
Error
Tells how consequent is the error
getLibVirVersion()
- Method in class org.libvirt.
Connect
Gets the version of the native libvirt library that the JNI part is linked to.
getMaxMemory()
- Method in class org.libvirt.
Domain
Retrieve the maximum amount of physical memory allocated to a domain.
getMaxVcpus(String)
- Method in class org.libvirt.
Connect
Provides the maximum number of virtual CPUs supported for a guest VM of a specific type.
getMaxVcpus()
- Method in class org.libvirt.
Domain
Provides the maximum number of virtual CPUs supported for the guest VM.
getMessage()
- Method in class org.libvirt.
Error
Returns human-readable informative error messag
getName()
- Method in class org.libvirt.
Domain
Gets the public name for this domain
getName()
- Method in class org.libvirt.
Network
Gets the public name for this network
getNet()
- Method in class org.libvirt.
Error
Returns the network associated with the error, if available
getOSType()
- Method in class org.libvirt.
Domain
Gets the type of domain operation system.
getSchedulerParameters()
- Method in class org.libvirt.
Domain
Gets the scheduler parameters.
getSchedulerType()
- Method in class org.libvirt.
Domain
Gets the scheduler type.
getStr1()
- Method in class org.libvirt.
Error
getStr2()
- Method in class org.libvirt.
Error
getStr3()
- Method in class org.libvirt.
Error
getType()
- Method in class org.libvirt.
Connect
Gets the name of the Hypervisor software used.
getTypeAsString()
- Method in class org.libvirt.
SchedBooleanParameter
getTypeAsString()
- Method in class org.libvirt.
SchedDoubleParameter
getTypeAsString()
- Method in class org.libvirt.
SchedIntParameter
getTypeAsString()
- Method in class org.libvirt.
SchedLongParameter
getTypeAsString()
- Method in class org.libvirt.
SchedParameter
Utility function for displaying the type
getTypeAsString()
- Method in class org.libvirt.
SchedUintParameter
getTypeAsString()
- Method in class org.libvirt.
SchedUlongParameter
getURI()
- Method in class org.libvirt.
Connect
Returns the URI (name) of the hypervisor connection.
getUUID()
- Method in class org.libvirt.
Domain
Get the UUID for this domain.
getUUID()
- Method in class org.libvirt.
Network
Gets the UUID for this network
getUUIDString()
- Method in class org.libvirt.
Domain
Gets the UUID for this domain as string.
getUUIDString()
- Method in class org.libvirt.
Network
Gets the UUID for a network as string.
getValueAsString()
- Method in class org.libvirt.
SchedBooleanParameter
getValueAsString()
- Method in class org.libvirt.
SchedDoubleParameter
getValueAsString()
- Method in class org.libvirt.
SchedIntParameter
getValueAsString()
- Method in class org.libvirt.
SchedLongParameter
getValueAsString()
- Method in class org.libvirt.
SchedParameter
Utility function for displaying the value
getValueAsString()
- Method in class org.libvirt.
SchedUintParameter
getValueAsString()
- Method in class org.libvirt.
SchedUlongParameter
getVcpusCpuMaps()
- Method in class org.libvirt.
Domain
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.
Domain
Extracts information about virtual CPUs of this domain
getVersion()
- Method in class org.libvirt.
Connect
Gets the version level of the Hypervisor running.
getXMLDesc(int)
- Method in class org.libvirt.
Domain
Provides an XML description of the domain.
getXMLDesc(int)
- Method in class org.libvirt.
Network
Provides an XML description of this network.
H
hasConn()
- Method in class org.libvirt.
Error
Does this error has a valid Connection object attached? NOTE: deprecated, should return false
hasDom()
- Method in class org.libvirt.
Error
Does this error has a valid Domain object attached? NOTE: deprecated, should return false
hasNet()
- Method in class org.libvirt.
Error
Does this error has a valid Network object attached? NOTE: deprecated, should return false
I
interfaceStats(String)
- Method in class org.libvirt.
Domain
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.
Connect
Lists the names of the defined domains
listDefinedNetworks()
- Method in class org.libvirt.
Connect
Lists the inactive networks
listDomains()
- Method in class org.libvirt.
Connect
Lists the active domains.
listNetworks()
- Method in class org.libvirt.
Connect
Lists the active networks.
M
maxCpus()
- Method in class org.libvirt.
NodeInfo
maxMem
- Variable in class org.libvirt.
DomainInfo
the maximum memory in KBytes allowed
memory
- Variable in class org.libvirt.
DomainInfo
the memory in KBytes used by the domain
memory
- Variable in class org.libvirt.
NodeInfo
memory size in kilobytes
mhz
- Variable in class org.libvirt.
NodeInfo
expected CPU frequency
migrate(Connect, long, String, String, long)
- Method in class org.libvirt.
Domain
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.
NodeInfo
string indicating the CPU model
N
Network
- Class in
org.libvirt
networkCreateXML(String)
- Method in class org.libvirt.
Connect
Creates and starts a new virtual network.
networkDefineXML(String)
- Method in class org.libvirt.
Connect
Defines a network, but does not create it.
networkLookupByName(String)
- Method in class org.libvirt.
Connect
Looks up a network on the based on its name.
networkLookupByUUID(int[])
- Method in class org.libvirt.
Connect
Looks up a network based on its UUID represented as an int array.
networkLookupByUUIDString(String)
- Method in class org.libvirt.
Connect
Looks up a network based on its UUID represented as a String.
nodeInfo()
- Method in class org.libvirt.
Connect
Returns a NodeInfo object describing the hardware configuration of the node.
NodeInfo
- Class in
org.libvirt
NodeInfo()
- Constructor for class org.libvirt.
NodeInfo
nodes
- Variable in class org.libvirt.
NodeInfo
the number of NUMA cell, 1 for uniform
nrVirtCpu
- Variable in class org.libvirt.
DomainInfo
the number of virtual CPUs for the domain
number
- Variable in class org.libvirt.
VcpuInfo
numOfDefinedDomains()
- Method in class org.libvirt.
Connect
Provides the number of inactive domains.
numOfDefinedNetworks()
- Method in class org.libvirt.
Connect
Provides the number of inactive networks.
numOfDomains()
- Method in class org.libvirt.
Connect
Provides the number of active domains.
numOfNetworks()
- Method in class org.libvirt.
Connect
Provides the number of active networks.
O
org.libvirt
- package org.libvirt
P
pinVcpu(int, int[])
- Method in class org.libvirt.
Domain
Dynamically changes the real CPUs which can be allocated to a virtual CPU.
prompt
- Variable in class org.libvirt.
ConnectAuth.Credential
Prompt to show to user
R
rd_bytes
- Variable in class org.libvirt.
DomainBlockStats
rd_req
- Variable in class org.libvirt.
DomainBlockStats
reboot(int)
- Method in class org.libvirt.
Domain
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.
Connect
Restores a domain saved to disk by Domain.save().
result
- Variable in class org.libvirt.
ConnectAuth.Credential
Result to be filled with user response (or defresult)
resume()
- Method in class org.libvirt.
Domain
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.
DomainInterfaceStats
rx_drop
- Variable in class org.libvirt.
DomainInterfaceStats
rx_errs
- Variable in class org.libvirt.
DomainInterfaceStats
rx_packets
- Variable in class org.libvirt.
DomainInterfaceStats
S
save(String)
- Method in class org.libvirt.
Domain
Suspends this domain and saves its memory contents to a file on disk.
SchedBooleanParameter
- Class in
org.libvirt
Class for representing a boolean scheduler parameter
SchedBooleanParameter()
- Constructor for class org.libvirt.
SchedBooleanParameter
SchedDoubleParameter
- Class in
org.libvirt
Class for representing a double scheduler parameter
SchedDoubleParameter()
- Constructor for class org.libvirt.
SchedDoubleParameter
SchedIntParameter
- Class in
org.libvirt
SchedIntParameter()
- Constructor for class org.libvirt.
SchedIntParameter
SchedLongParameter
- Class in
org.libvirt
Class for representing a long int scheduler parameter
SchedLongParameter()
- Constructor for class org.libvirt.
SchedLongParameter
SchedParameter
- Class in
org.libvirt
The abstract parent of the actual Schedparameter classes
SchedParameter()
- Constructor for class org.libvirt.
SchedParameter
SchedUintParameter
- Class in
org.libvirt
Class for representing an unsigned int scheduler parameter
SchedUintParameter()
- Constructor for class org.libvirt.
SchedUintParameter
SchedUlongParameter
- Class in
org.libvirt
Class for representing an unsigned long int scheduler parameter
SchedUlongParameter()
- Constructor for class org.libvirt.
SchedUlongParameter
setAutostart(boolean)
- Method in class org.libvirt.
Domain
Configures the network to be automatically started when the host machine boots.
setAutostart(boolean)
- Method in class org.libvirt.
Network
Configures this network to be automatically started when the host machine boots.
setDom0Memory(long)
- Method in class org.libvirt.
Connect
change the amount of memory reserved to Domain0.
setMaxMemory(long)
- Method in class org.libvirt.
Domain
* Dynamically change the maximum amount of physical memory allocated to a domain.
setMemory(long)
- Method in class org.libvirt.
Domain
Dynamically changes the target amount of physical memory allocated to this domain.
setSchedulerParameters(SchedParameter[])
- Method in class org.libvirt.
Domain
Changes the scheduler parameters
setVcpus(int)
- Method in class org.libvirt.
Domain
Dynamically changes the number of virtual CPUs used by this domain.
shutdown()
- Method in class org.libvirt.
Domain
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.
NodeInfo
number of CPU socket per node
state
- Variable in class org.libvirt.
DomainInfo
the running state, one of virDomainFlag
state
- Variable in class org.libvirt.
VcpuInfo
suspend()
- Method in class org.libvirt.
Domain
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.
NodeInfo
number of threads per core
toString()
- Method in class org.libvirt.
DomainInfo
toString()
- Method in class org.libvirt.
Error
tx_bytes
- Variable in class org.libvirt.
DomainInterfaceStats
tx_drop
- Variable in class org.libvirt.
DomainInterfaceStats
tx_errs
- Variable in class org.libvirt.
DomainInterfaceStats
tx_packets
- Variable in class org.libvirt.
DomainInterfaceStats
type
- Variable in class org.libvirt.
ConnectAuth.Credential
One of virConnectCredentialType constants
U
undefine()
- Method in class org.libvirt.
Domain
undefines this domain but does not stop it if it is running
undefine()
- Method in class org.libvirt.
Network
Undefines this network but does not stop it if it is running
V
value
- Variable in class org.libvirt.
SchedBooleanParameter
The parameter value
value
- Variable in class org.libvirt.
SchedDoubleParameter
The parameter value
value
- Variable in class org.libvirt.
SchedIntParameter
value
- Variable in class org.libvirt.
SchedLongParameter
The parameter value
value
- Variable in class org.libvirt.
SchedUintParameter
The parameter value
value
- Variable in class org.libvirt.
SchedUlongParameter
The parameter value
valueOf(String)
- Static method in enum org.libvirt.
ConnectAuth.CredentialType
Returns the enum constant of this type with the specified name.
valueOf(String)
- Static method in enum org.libvirt.
DomainInfo.DomainState
Returns the enum constant of this type with the specified name.
valueOf(String)
- Static method in enum org.libvirt.
Error.ErrorDomain
Returns the enum constant of this type with the specified name.
valueOf(String)
- Static method in enum org.libvirt.
Error.ErrorLevel
Returns the enum constant of this type with the specified name.
valueOf(String)
- Static method in enum org.libvirt.
Error.ErrorNumber
Returns the enum constant of this type with the specified name.
valueOf(String)
- Static method in enum org.libvirt.
VcpuInfo.VcpuState
Returns the enum constant of this type with the specified name.
values()
- Static method in enum org.libvirt.
ConnectAuth.CredentialType
Returns an array containing the constants of this enum type, in the order they are declared.
values()
- Static method in enum org.libvirt.
DomainInfo.DomainState
Returns an array containing the constants of this enum type, in the order they are declared.
values()
- Static method in enum org.libvirt.
Error.ErrorDomain
Returns an array containing the constants of this enum type, in the order they are declared.
values()
- Static method in enum org.libvirt.
Error.ErrorLevel
Returns an array containing the constants of this enum type, in the order they are declared.
values()
- Static method in enum org.libvirt.
Error.ErrorNumber
Returns an array containing the constants of this enum type, in the order they are declared.
values()
- Static method in enum org.libvirt.
VcpuInfo.VcpuState
Returns an array containing the constants of this enum type, in the order they are declared.
VcpuInfo
- Class in
org.libvirt
VcpuInfo()
- Constructor for class org.libvirt.
VcpuInfo
VcpuInfo.VcpuState
- Enum in
org.libvirt
W
wr_bytes
- Variable in class org.libvirt.
DomainBlockStats
wr_req
- Variable in class org.libvirt.
DomainBlockStats
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