Package com.xensource.xenapi

Interface Summary
Types.Record Interface for all Record classes
 

Class Summary
ConnectionHelper  
Console A console
Console.Record Represents all the fields in a Console
Crashdump A VM crashdump
Crashdump.Record Represents all the fields in a Crashdump
Debug A basic class for testing
Debug.Record Represents all the fields in a Debug
Event Asynchronous event registration and handling
Event.Record Represents all the fields in a Event
Host A physical host
Host.Record Represents all the fields in a Host
HostCpu A physical CPU
HostCpu.Record Represents all the fields in a HostCpu
HostMetrics The metrics associated with a host
HostMetrics.Record Represents all the fields in a HostMetrics
Marshalling Marshalls Java types onto the wire.
Network A virtual network
Network.Record Represents all the fields in a Network
PBD The physical block devices through which hosts access SRs
PBD.Record Represents all the fields in a PBD
PIF A physical network interface (note separate VLANs are represented as several PIFs)
PIF.Record Represents all the fields in a PIF
PIFMetrics The metrics associated with a physical network interface
PIFMetrics.Record Represents all the fields in a PIFMetrics
Session A session
Session.Record Represents all the fields in a Session
SR A storage repository
SR.Record Represents all the fields in a SR
Task A long-running asynchronous task
Task.Record Represents all the fields in a Task
Types This class holds vital marshalling functions, enum types and exceptions.
User A user of the system
User.Record Represents all the fields in a User
VBD A virtual block device
VBD.Record Represents all the fields in a VBD
VBDMetrics The metrics associated with a virtual block device
VBDMetrics.Record Represents all the fields in a VBDMetrics
VDI A virtual disk image
VDI.Record Represents all the fields in a VDI
VIF A virtual network interface
VIF.Record Represents all the fields in a VIF
VIFMetrics The metrics associated with a virtual network device
VIFMetrics.Record Represents all the fields in a VIFMetrics
VM A virtual machine (or 'guest').
VM.Record Represents all the fields in a VM
VMGuestMetrics The metrics reported by the guest (as opposed to inferred from outside)
VMGuestMetrics.Record Represents all the fields in a VMGuestMetrics
VMMetrics The metrics associated with a VM
VMMetrics.Record Represents all the fields in a VMMetrics
VTPM A virtual TPM device
VTPM.Record Represents all the fields in a VTPM
 

Exception Summary
ConnectionHelper.NoConnectionOnThisThreadException  
Types.BadServerResponse Thrown if the response from the server contains an invalid status.
Types.DeviceAlreadyAttached The device is already attached to a VM
Types.DeviceAlreadyDetached The device is not currently attached
Types.DeviceAlreadyExists A device with the name given already exists on the selected VM
Types.EventsLost Some events have been lost from the queue and cannot be retrieved.
Types.HandleInvalid You gave an invalid handle.
Types.HostOffline You attempted an operation which involves a host which could not be contacted.
Types.InternalError The server failed to handle your request, due to an internal error.
Types.InvalidDevice The device name is invalid
Types.InvalidPatch The uploaded patch file is invalid
Types.InvalidValue The value given is invalid
Types.MapDuplicateKey You tried to add a key-value pair to a map, but that key is already there.
Types.MessageMethodUnknown You tried to call a method that does not exist.
Types.MessageParameterCountMismatch You tried to call a method with the incorrect number of parameters.
Types.NetworkAlreadyConnected You tried to create a PIF, but the network you tried to attach it to is already attached to some other PIF, and so the creation failed.
Types.NetworkContainsPif The network contains active PIFs and cannot be deleted
Types.NetworkContainsVif The network contains active VIFs and cannot be deleted
Types.NotImplemented The function is not implemented
Types.OperationNotAllowed You attempted an operation that was not allowed.
Types.PatchAlreadyApplied This patch has already been applied
Types.PifIsPhysical You tried to destroy a PIF, but it represents an aspect of the physical host configuration, and so cannot be destroyed.
Types.PifVlanExists You tried to create a PIF, but it already exists
Types.SessionAuthenticationFailed The credentials given by the user are incorrect, so access has been denied, and you have not been issued a session handle.
Types.SessionInvalid You gave an invalid session handle.
Types.SessionNotRegistered This session is not registered to receive events.
Types.SrFull The SR is full.
Types.SrHasPbd The SR is still connected to a host via a PBD.
Types.SrUnknownDriver The SR could not be connected because the driver was not recognised.
Types.SrVdiLockingFailed The operation could not proceed because necessary VDIs were already locked at the storage level.
Types.ValueNotSupported You attempted to set a value that is not supported by this implementation.
Types.VdiOtherOperationInProgress Another operation involving the VDI is currently in progress
Types.VlanTagInvalid You tried to create a VLAN, but the tag you gave was invalid -- it mmust be between 0 and 4095.
Types.VmBadPowerState You attempted an operation on a VM that was not in an appropriate power state at the time; for example, you attempted to start a VM that was already running.
Types.VmHvmRequired HVM is required for this operation
Types.VmIsTemplate The operation attempted is not valid for a template VM
Types.VmMigrateFailed An error occurred during the migration process.
Types.VmOtherOperationInProgress Another operation involving the VM is currently in progress
Types.VmRequiresNetwork You attempted to run a VM on a host which doesn't have a PIF on a Network needed by the VM.
Types.VmRequiresSr You attempted to run a VM on a host which doesn't have access to an SR needed by the VM.
Types.VmUnsafeBoot You attempted an operation on a VM that was judged to be unsafe by the server.
Types.XenAPIException Base class for all XenAPI Exceptions