Package com.xensource.xenapi

Class Types

java.lang.Object

com.xensource.xenapi.Types

public class Types
extends Object

This class holds enum types and exceptions.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Types.ActivationWhileNotFree	An activation key can only be applied when the edition is set to 'free'.
static class	Types.AddressViolatesLockingConstraint	The specified IP address violates the VIF locking configuration.
static enum	Types.AfterApplyGuidance
static enum	Types.AllocationAlgorithm
static class	Types.ApplyGuidanceFailed	Failed to apply guidance on a host after updating.
static class	Types.ApplyLivepatchFailed	Failed to apply a livepatch.
static class	Types.ApplyUpdatesFailed	Failed to apply updates on a host.
static class	Types.ApplyUpdatesInProgress	The operation could not be performed because applying updates is in progress.
static class	Types.AuthAlreadyEnabled	External authentication for this server is already enabled.
static class	Types.AuthDisableFailed	The host failed to disable external authentication.
static class	Types.AuthDisableFailedPermissionDenied	The host failed to disable external authentication.
static class	Types.AuthDisableFailedWrongCredentials	The host failed to disable external authentication.
static class	Types.AuthEnableFailed	The host failed to enable external authentication.
static class	Types.AuthEnableFailedDomainLookupFailed	The host failed to enable external authentication.
static class	Types.AuthEnableFailedInvalidAccount	The host failed to enable external authentication.
static class	Types.AuthEnableFailedInvalidOu	The host failed to enable external authentication.
static class	Types.AuthEnableFailedPermissionDenied	The host failed to enable external authentication.
static class	Types.AuthEnableFailedUnavailable	The host failed to enable external authentication.
static class	Types.AuthEnableFailedWrongCredentials	The host failed to enable external authentication.
static class	Types.AuthIsDisabled	External authentication is disabled, unable to resolve subject name.
static class	Types.AuthServiceError	Error querying the external directory service.
static class	Types.AuthUnknownType	Unknown type of external authentication.
static class	Types.BackupScriptFailed	The backup could not be performed because the backup script failed.
static class	Types.BadAsyncResult
static class	Types.BadServerResponse	Thrown if the response from the server contains an invalid status.
static class	Types.BallooningTimeoutBeforeMigration	Timeout trying to balloon down memory before VM migration.
static class	Types.BlockedRepoUrl	Cannot create the repository as the url is blocked, please check your settings.
static enum	Types.BondMode
static class	Types.BootloaderFailed	The bootloader returned an error
static class	Types.BridgeNameExists	The specified bridge already exists.
static class	Types.BridgeNotAvailable	Could not find bridge required by VM.
static class	Types.BundleRepoNotEnabled	Cannot sync bundle as the bundle repository is not enabled.
static class	Types.BundleRepositoryAlreadyExists	The bundle repository already exists.
static class	Types.BundleSyncFailed	Syncing with bundle repository failed.
static class	Types.BundleUnpackFailed	Failed to unpack bundle file.
static class	Types.CannotAddTunnelToBondSlave	This PIF is a bond member and cannot have a tunnel on it.
static class	Types.CannotAddTunnelToSriovLogical	This is a network SR-IOV logical PIF and cannot have a tunnel on it.
static class	Types.CannotAddTunnelToVlanOnSriovLogical	This is a vlan PIF on network SR-IOV and cannot have a tunnel on it.
static class	Types.CannotAddVlanToBondSlave	This PIF is a bond member and cannot have a VLAN on it.
static class	Types.CannotChangePifProperties	The properties of this PIF cannot be changed.
static class	Types.CannotContactHost	Cannot forward messages because the server cannot be contacted.
static class	Types.CannotCreateStateFile	An HA statefile could not be created, perhaps because no SR with the appropriate capability was found.
static class	Types.CannotDestroyDisasterRecoveryTask	The disaster recovery task could not be cleanly destroyed.
static class	Types.CannotDestroySystemNetwork	You tried to destroy a system network: these cannot be destroyed.
static class	Types.CannotEnableRedoLog	Could not enable redo log.
static class	Types.CannotEvacuateHost	This server cannot be evacuated.
static class	Types.CannotFetchPatch	The requested update could not be obtained from the coordinator.
static class	Types.CannotFindOemBackupPartition	The backup partition to stream the update to cannot be found.
static class	Types.CannotFindPatch	The requested update could not be found.
static class	Types.CannotFindStatePartition	This operation could not be performed because the state partition could not be found
static class	Types.CannotFindUpdate	The requested update could not be found.
static class	Types.CannotForgetSriovLogical	This is a network SR-IOV logical PIF and cannot do forget on it
static class	Types.CanNotPeriodicSyncUpdates	The currently enabled repositories do not support periodic automatic updates.
static class	Types.CannotPlugBondSlave	This PIF is a bond member and cannot be plugged.
static class	Types.CannotPlugVif	Cannot plug VIF
static class	Types.CannotResetControlDomain	The power-state of a control domain cannot be reset.
static class	Types.CannotRestartDeviceModel	Cannot restart device models of paused VMs residing on the host.
static class	Types.CanNotSyncUpdates	The currently enabled repositories do not support synchronization of updates.
static class	Types.CertificateAlreadyExists	A certificate already exists with the specified name.
static class	Types.CertificateCorrupt	The specified certificate is corrupt or unreadable.
static class	Types.CertificateDoesNotExist	The specified certificate does not exist.
static class	Types.CertificateLacksPurpose	No purpose is specified for the provided certificate.
static class	Types.CertificateLibraryCorrupt	The certificate library is corrupt or unreadable.
static class	Types.CertificateNameInvalid	The specified certificate name is invalid.
static enum	Types.CertificatePurpose
static enum	Types.CertificateType
static class	Types.ChangePasswordRejected	The system rejected the password change request; perhaps the new password was too short?
static enum	Types.Cls
static class	Types.ClusterAlreadyExists	A cluster already exists in the pool.
static class	Types.ClusterCreateInProgress	The operation could not be performed because cluster creation is in progress.
static class	Types.ClusterDoesNotHaveOneNode	An operation failed as it expected the cluster to have only one node but found multiple cluster_hosts.
static class	Types.ClusteredSrDegraded	An SR is using clustered local storage.
static class	Types.ClusterForceDestroyFailed	Force destroy failed on a Cluster_host while force destroying the cluster.
static class	Types.ClusterHostIsLast	The last cluster host cannot be destroyed.
static class	Types.ClusterHostNotJoined	Cluster_host operation failed as the cluster_host has not joined the cluster.
static enum	Types.ClusterHostOperation
static class	Types.ClusteringDisabled	An operation was attempted while clustering was disabled on the cluster_host.
static class	Types.ClusteringEnabled	An operation was attempted while clustering was enabled on the cluster_host.
static enum	Types.ClusterOperation
static class	Types.ClusterStackInUse	The cluster stack is still in use by at least one plugged PBD.
static class	Types.ConfigureRepositoriesInProgress	The operation could not be performed because other repository(ies) is(are) already being configured.
static enum	Types.ConsoleProtocol
static class	Types.CouldNotFindNetworkInterfaceWithSpecifiedDeviceNameAndMacAddress	Could not find a network interface with the specified device name and MAC address.
static class	Types.CouldNotImportDatabase	An error occurred while attempting to import a database from a metadata VDI
static class	Types.CouldNotUpdateIgmpSnoopingEverywhere	The IGMP Snooping setting cannot be applied for some of the host, network(s).
static class	Types.CpuFeatureMaskingNotSupported	The CPU does not support masking of features.
static class	Types.CrlAlreadyExists	A CRL already exists with the specified name.
static class	Types.CrlCorrupt	The specified CRL is corrupt or unreadable.
static class	Types.CrlDoesNotExist	The specified CRL does not exist.
static class	Types.CrlNameInvalid	The specified CRL name is invalid.
static class	Types.DbUniquenessConstraintViolation	You attempted an operation which would have resulted in duplicate keys in the database.
static class	Types.DefaultSrNotFound	The default SR reference does not point to a valid SR
static class	Types.DeviceAlreadyAttached	The device is already attached to a VM
static class	Types.DeviceAlreadyDetached	The device is not currently attached
static class	Types.DeviceAlreadyExists	A device with the name given already exists on the selected VM
static class	Types.DeviceAttachTimeout	A timeout happened while attempting to attach a device to a VM.
static class	Types.DeviceDetachRejected	The VM rejected the attempt to detach the device.
static class	Types.DeviceDetachTimeout	A timeout happened while attempting to detach a device from a VM.
static class	Types.DeviceNotAttached	The operation could not be performed because the VBD was not connected to the VM.
static class	Types.DisableSshFailed	Failed to disable SSH access.
static class	Types.DisableSshPartiallyFailed	Some of hosts failed to disable SSH access.
static class	Types.DiskVbdMustBeReadwriteForHvm	All VBDs of type 'disk' must be read/write for HVM guests
static class	Types.DomainBuilderError	An internal error generated by the domain builder.
static class	Types.DomainExists	The operation could not be performed because a domain still exists for the specified VM.
static enum	Types.DomainType
static class	Types.DuplicateMacSeed	This MAC seed is already in use by a VM in the pool
static class	Types.DuplicatePifDeviceName	A PIF with this specified device name already exists.
static class	Types.DuplicateVm	Cannot restore this VM because it would create a duplicate
static class	Types.EnableSshFailed	Failed to enable SSH access.
static class	Types.EnableSshPartiallyFailed	Some of hosts failed to enable SSH access.
static class	Types.EventFromTokenParseFailure	The event.from token could not be parsed.
static enum	Types.EventOperation
static class	Types.EventsLost	Some events have been lost from the queue and cannot be retrieved.
static class	Types.EventSubscriptionParseFailure	The server failed to parse your event subscription.
static class	Types.FailedToStartEmulator	An emulator required to run this VM failed to start
static class	Types.FeatureRequiresHvm	The VM is set up to use a feature that requires it to boot as HVM.
static class	Types.FeatureRestricted	The use of this feature is restricted.
static class	Types.FieldTypeError	The value specified is of the wrong type
static class	Types.GetHostUpdatesFailed	Failed to get available updates from a host.
static class	Types.GetUpdatesFailed	Failed to get available updates from the pool.
static class	Types.GpuGroupContainsNoPgpus	The GPU group does not contain any PGPUs.
static class	Types.GpuGroupContainsPgpu	The GPU group contains active PGPUs and cannot be deleted.
static class	Types.GpuGroupContainsVgpu	The GPU group contains active VGPUs and cannot be deleted.
static class	Types.HaAbortNewMaster	This server cannot accept the proposed new coordinator setting at this time.
static class	Types.HaCannotChangeBondStatusOfMgmtIface	This operation cannot be performed because creating or deleting a bond involving the management interface is not allowed while HA is on.
static class	Types.HaConstraintViolationNetworkNotShared	This operation cannot be performed because the referenced network is not properly shared.
static class	Types.HaConstraintViolationSrNotShared	This operation cannot be performed because the referenced SR is not properly shared.
static class	Types.HaDisableInProgress	The operation could not be performed because HA disable is in progress
static class	Types.HaEnableInProgress	The operation could not be performed because HA enable is in progress
static class	Types.HaFailedToFormLiveset	HA could not be enabled on the Pool because a liveset could not be formed: check storage and network heartbeat paths.
static class	Types.HaHeartbeatDaemonStartupFailed	The server could not join the liveset because the HA daemon failed to start.
static class	Types.HaHostCannotAccessStatefile	The server could not join the liveset because the HA daemon could not access the heartbeat disk.
static class	Types.HaHostCannotSeePeers	The operation failed because the HA software on the specified server could not see a subset of other servers.
static class	Types.HaHostIsArmed	The operation could not be performed while the server is still armed; it must be disarmed first.
static class	Types.HaIsEnabled	The operation could not be performed because HA is enabled on the Pool
static class	Types.HaLostStatefile	This server lost access to the HA statefile.
static class	Types.HandleInvalid	You gave an invalid object reference.
static class	Types.HaNoPlan	Cannot find a plan for placement of VMs as there are no other servers available.
static class	Types.HaNotEnabled	The operation could not be performed because HA is not enabled on the Pool
static class	Types.HaNotInstalled	The operation could not be performed because the HA software is not installed on this server.
static class	Types.HaOperationWouldBreakFailoverPlan	This operation cannot be performed because it would invalidate VM failover planning such that the system would be unable to guarantee to restart protected VMs after a Host failure.
static class	Types.HaPoolIsEnabledButHostIsDisabled	This server cannot join the pool because the pool has HA enabled but this server has HA disabled.
static class	Types.HaShouldBeFenced	Server cannot rejoin pool because it should have fenced (it is not in the coordinator's partition).
static class	Types.HaTooFewHosts	HA can only be enabled for 2 servers or more.
static enum	Types.HostAllowedOperations
static class	Types.HostBroken	This server failed in the middle of an automatic failover operation and needs to retry the failover action.
static class	Types.HostCannotAttachNetwork	Server cannot attach network (in the case of NIC bonding, this may be because attaching the network on this server would require other networks - that are currently active - to be taken down).
static class	Types.HostCannotDestroySelf	The pool coordinator host cannot be removed.
static class	Types.HostCannotReadMetrics	The metrics of this server could not be read.
static class	Types.HostCdDriveEmpty	The host CDROM drive does not contain a valid CD
static class	Types.HostDisabled	The specified server is disabled.
static class	Types.HostDisabledIndefinitely	The specified server is disabled and can only be re-enabled manually with Host.enable.
static class	Types.HostDisabledUntilReboot	The specified server is disabled and cannot be re-enabled until after it has rebooted.
static enum	Types.HostDisplay
static class	Types.HostDriverNoHardware	No hardware present for this host driver variant
static class	Types.HostEvacuateInProgress	This host is being evacuated.
static class	Types.HostEvacuationIsRequired	Host evacuation is required before applying updates.
static class	Types.HostHasNoManagementIp	The server failed to acquire an IP address on its management interface and therefore cannot contact the coordinator.
static class	Types.HostHasResidentVms	This server cannot be forgotten because there are user VMs still running.
static class	Types.HostInEmergencyMode	Cannot perform operation as the host is running in emergency mode.
static class	Types.HostInUse	This operation cannot be completed as the host is in use by (at least) the object of type and ref echoed below.
static class	Types.HostIsLive	This operation cannot be completed because the server is still live.
static class	Types.HostIsSlave	You cannot make regular API calls directly on a supporter.
static class	Types.HostItsOwnSlave	The host is its own supporter.
static class	Types.HostMasterCannotTalkBack	The coordinator reports that it cannot talk back to the supporter on the supplied management IP address.
static class	Types.HostNameInvalid	The server name is invalid.
static class	Types.HostNotDisabled	This operation cannot be performed because the host is not disabled.
static class	Types.HostNotEnoughFreeMemory	Not enough server memory is available to perform this operation.
static class	Types.HostNotEnoughPcpus	The host does not have enough pCPUs to run the VM.
static class	Types.HostNotLive	This operation cannot be completed as the server is not live.
static enum	Types.HostNtpMode
static enum	Types.HostNumaAffinityPolicy
static class	Types.HostOffline	You attempted an operation which involves a host which could not be contacted.
static class	Types.HostPendingMandatoryGuidanceNotEmpty	Operation could not be performed on the host because there is pending mandatory update guidance on it.
static class	Types.HostPowerOnModeDisabled	This operation cannot be completed because the server power on mode is disabled.
static enum	Types.HostSchedGran
static class	Types.HostsNotCompatible	The hosts in this pool are not compatible.
static class	Types.HostsNotHomogeneous	The hosts in this pool are not homogeneous.
static class	Types.HostStillBooting	The host toolstack is still initialising.
static class	Types.HostUnknownToMaster	The coordinator says the server is not known to it.
static class	Types.HostXapiVersionHigherThanCoordinator	The host xapi version is higher than the one in the coordinator
static class	Types.IllegalVbdDevice	The specified VBD device is not recognized: please use a non-negative integer
static class	Types.ImportError	The VM could not be imported.
static class	Types.ImportErrorAttachedDisksNotFound	The VM could not be imported because attached disks could not be found.
static class	Types.ImportErrorCannotHandleChunked	Cannot import VM using chunked encoding.
static class	Types.ImportErrorFailedToFindObject	The VM could not be imported because a required object could not be found.
static class	Types.ImportErrorPrematureEof	The VM could not be imported; the end of the file was reached prematurely.
static class	Types.ImportErrorSomeChecksumsFailed	Some data checksums were incorrect; the VM may be corrupt.
static class	Types.ImportErrorUnexpectedFile	The VM could not be imported because the XVA file is invalid: an unexpected file was encountered.
static class	Types.ImportIncompatibleVersion	The import failed because this export has been created by a different (incompatible) product version
static class	Types.IncompatibleClusterStackActive	This operation cannot be performed, because it is incompatible with the currently active HA cluster stack.
static class	Types.IncompatiblePifProperties	These PIFs cannot be bonded, because their properties are different.
static class	Types.IncompatibleStatefileSr	The specified SR is incompatible with the selected HA cluster stack.
static class	Types.InterfaceHasNoIp	The specified interface cannot be used because it has no IP address
static class	Types.InternalError	The server failed to handle your request, due to an internal error.
static class	Types.InvalidBaseUrl	The base url in the repository is invalid.
static class	Types.InvalidCidrAddressSpecified	A required parameter contained an invalid CIDR address (<addr>/<prefix length>)
static class	Types.InvalidClusterStack	The cluster stack provided is not supported.
static class	Types.InvalidDevice	The device name is invalid
static class	Types.InvalidEdition	The edition you supplied is invalid.
static class	Types.InvalidFeatureString	The given feature string is not valid.
static class	Types.InvalidGpgkeyPath	The GPG public key file name in the repository is invalid.
static class	Types.InvalidIpAddressSpecified	A required parameter contained an invalid IP address
static class	Types.InvalidNtpConfig	The NTP configuration is invalid.
static class	Types.InvalidPatch	The uploaded patch file is invalid
static class	Types.InvalidPatchWithLog	The uploaded patch file is invalid.
static class	Types.InvalidRepomdXml	The repomd.xml is invalid.
static class	Types.InvalidRepositoryDomainAllowlist	The repository domain allowlist has some invalid domains.
static class	Types.InvalidRepositoryProxyCredential	The repository proxy username/password is invalid.
static class	Types.InvalidRepositoryProxyUrl	The repository proxy URL is invalid.
static class	Types.InvalidUpdate	The uploaded update package is invalid.
static class	Types.InvalidUpdateinfoXml	The updateinfo.xml is invalid.
static class	Types.InvalidUpdateSyncDay	Invalid day of the week chosen for weekly update sync.
static class	Types.InvalidValue	The value given is invalid
static enum	Types.IpConfigurationMode
static enum	Types.Ipv6ConfigurationMode
static class	Types.IsTunnelAccessPif	Cannot create a VLAN or tunnel on top of a tunnel access PIF - use the underlying transport PIF instead.
static class	Types.JoiningHostCannotBeMasterOfOtherHosts	The server joining the pool cannot already be a coordinator of another pool.
static class	Types.JoiningHostCannotContainSharedSrs	The server joining the pool cannot contain any shared storage.
static class	Types.JoiningHostCannotHaveRunningOrSuspendedVms	The server joining the pool cannot have any running or suspended VMs.
static class	Types.JoiningHostCannotHaveRunningVms	The server joining the pool cannot have any running VMs.
static class	Types.JoiningHostCannotHaveVmsWithCurrentOperations	The host joining the pool cannot have any VMs with active tasks.
static class	Types.JoiningHostConnectionFailed	There was an error connecting to the host while joining it in the pool.
static class	Types.JoiningHostServiceFailed	There was an error connecting to the server.
static enum	Types.LatestSyncedUpdatesAppliedState
static class	Types.LicenceRestriction	This operation is not allowed because your license lacks a needed feature.
static class	Types.LicenseCannotDowngradeWhileInPool	Cannot downgrade license while in pool.
static class	Types.LicenseCheckoutError	The license for the edition you requested is not available.
static class	Types.LicenseDoesNotSupportPooling	This server cannot join a pool because its license does not support pooling.
static class	Types.LicenseDoesNotSupportXha	HA cannot be enabled because this server's license does not allow it.
static class	Types.LicenseExpired	Your license has expired.
static class	Types.LicenseFileDeprecated	This type of license file is for previous versions of the server.
static class	Types.LicenseHostPoolMismatch	Host and pool have incompatible licenses (editions).
static class	Types.LicenseProcessingError	There was an error processing your license.
static enum	Types.LivepatchStatus
static class	Types.LocationNotUnique	A VDI with the specified location already exists within the SR
static class	Types.MacDoesNotExist	The MAC address specified does not exist on this server.
static class	Types.MacInvalid	The MAC address specified is not valid.
static class	Types.MacStillExists	The MAC address specified still exists on this server.
static class	Types.MapDuplicateKey	You tried to add a key-value pair to a map, but that key is already there.
static class	Types.MemoryConstraintViolation	The dynamic memory range does not satisfy the following constraint.
static class	Types.MemoryConstraintViolationMaxpin	The dynamic memory range violates constraint static_min = dynamic_min = dynamic_max = static_max.
static class	Types.MemoryConstraintViolationOrder	The dynamic memory range violates constraint static_min <= dynamic_min <= dynamic_max <= static_max.
static class	Types.MessageDeprecated	This message has been deprecated.
static class	Types.MessageMethodUnknown	You tried to call a method that does not exist.
static class	Types.MessageParameterCountMismatch	You tried to call a method with the incorrect number of parameters.
static class	Types.MessageRemoved	This function is no longer available.
static class	Types.MirrorFailed	The VDI mirroring cannot be performed
static class	Types.MissingConnectionDetails	The license-server connection details (address or port) were missing or incomplete.
static class	Types.MultipleUpdateRepositoriesEnabled	There is more than one update repository being enabled.
static class	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.
static class	Types.NetworkContainsPif	The network contains active PIFs and cannot be deleted.
static class	Types.NetworkContainsVif	The network contains active VIFs and cannot be deleted.
static enum	Types.NetworkDefaultLockingMode
static class	Types.NetworkHasIncompatibleSriovPifs	The PIF is not compatible with the selected SR-IOV network
static class	Types.NetworkHasIncompatibleVlanOnSriovPifs	VLAN on the PIF is not compatible with the selected SR-IOV VLAN network
static class	Types.NetworkIncompatiblePurposes	You tried to add a purpose to a network but the new purpose is not compatible with an existing purpose of the network or other networks.
static class	Types.NetworkIncompatibleWithBond	The network is incompatible with bond
static class	Types.NetworkIncompatibleWithSriov	The network is incompatible with sriov
static class	Types.NetworkIncompatibleWithTunnel	The network is incompatible with tunnel
static class	Types.NetworkIncompatibleWithVlanOnBridge	The network is incompatible with vlan on bridge
static class	Types.NetworkIncompatibleWithVlanOnSriov	The network is incompatible with vlan on sriov
static enum	Types.NetworkOperations
static enum	Types.NetworkPurpose
static class	Types.NetworkSriovAlreadyEnabled	The PIF selected for the SR-IOV network is already enabled
static class	Types.NetworkSriovDisableFailed	Failed to disable SR-IOV on PIF
static class	Types.NetworkSriovEnableFailed	Failed to enable SR-IOV on PIF
static class	Types.NetworkSriovInsufficientCapacity	There is insufficient capacity for VF reservation
static class	Types.NetworkUnmanaged	The network is not managed by xapi.
static class	Types.NoClusterHostsReachable	No other cluster host was reachable when joining
static class	Types.NoCompatibleClusterHost	Clustering is not enabled on this host or pool.
static class	Types.NoHostsAvailable	There were no servers available to complete the specified operation.
static class	Types.NoMoreRedoLogsAllowed	The upper limit of active redo log instances was reached.
static class	Types.NoRepositoriesConfigured	No update repositories have been configured.
static class	Types.NoRepositoryEnabled	There is no repository being enabled.
static class	Types.NotAllowedOnOemEdition	This command is not allowed on the OEM edition.
static class	Types.NotAllowedWhenNtpIsEnabled	The operation is not allowed on the host when the NTP is enabled.
static class	Types.NotImplemented	The function is not implemented
static class	Types.NotInEmergencyMode	This pool is not in emergency mode.
static class	Types.NotSupportedDuringUpgrade	This operation is not supported during an upgrade.
static class	Types.NotSystemDomain	The given VM is not registered as a system domain.
static class	Types.NotTrustedCertificate	The provided certificate is not a trusted certificate.
static class	Types.NvidiaSriovMisconfigured	The NVidia GPU is not configured for SR-IOV as expected
static class	Types.NvidiaToolsError	Nvidia tools error.
static class	Types.ObjectNolongerExists	The specified object no longer exists.
static enum	Types.OnBoot
static enum	Types.OnCrashBehaviour
static class	Types.OnlyAllowedOnOemEdition	This command is only allowed on the OEM edition.
static enum	Types.OnNormalExit
static enum	Types.OnSoftrebootBehavior
static class	Types.OpenvswitchNotActive	This operation needs the OpenVSwitch networking backend to be enabled on all hosts in the pool.
static class	Types.OperationBlocked	You attempted an operation that was explicitly blocked (see the blocked_operations field of the given object).
static class	Types.OperationNotAllowed	You attempted an operation that was not allowed.
static class	Types.OperationPartiallyFailed	Some VMs belonging to the appliance threw an exception while carrying out the specified operation
static enum	Types.Origin
static class	Types.OtherOperationInProgress	Another operation involving the object is currently in progress
static class	Types.OutOfSpace	There is not enough space to upload the update
static class	Types.PatchAlreadyApplied	This patch has already been applied
static class	Types.PatchAlreadyExists	The uploaded patch file already exists
static class	Types.PatchApplyFailed	The patch apply failed.
static class	Types.PatchApplyFailedBackupFilesExist	The patch apply failed: there are backup files created while applying patch.
static class	Types.PatchIsApplied	The specified patch is applied and cannot be destroyed.
static class	Types.PatchPrecheckFailedIsoMounted	Tools ISO must be ejected from all running VMs.
static class	Types.PatchPrecheckFailedOutOfSpace	The patch pre-check stage failed: the server does not have enough space.
static class	Types.PatchPrecheckFailedPrerequisiteMissing	The patch pre-check stage failed: prerequisite patches are missing.
static class	Types.PatchPrecheckFailedUnknownError	The patch pre-check stage failed with an unknown error.
static class	Types.PatchPrecheckFailedVmRunning	The patch pre-check stage failed: there are one or more VMs still running on the server.
static class	Types.PatchPrecheckFailedWrongServerBuild	The patch pre-check stage failed: the server is of an incorrect build.
static class	Types.PatchPrecheckFailedWrongServerVersion	The patch pre-check stage failed: the server is of an incorrect version.
static class	Types.PbdExists	A PBD already exists connecting the SR to the server.
static enum	Types.PciDom0Access
static class	Types.PermissionDenied	Caller not allowed to perform this operation.
static enum	Types.PersistenceBackend
static class	Types.PgpuInsufficientCapacityForVgpu	There is insufficient capacity on this PGPU to run the VGPU.
static class	Types.PgpuInUseByVm	This PGPU is currently in use by running VMs.
static class	Types.PgpuNotCompatibleWithGpuGroup	PGPU type not compatible with destination group.
static class	Types.PifAllowsUnplug	The operation you requested cannot be performed because the specified PIF allows unplug.
static class	Types.PifAlreadyBonded	This operation cannot be performed because the pif is bonded.
static class	Types.PifBondMoreThanOneIp	Only one PIF on a bond is allowed to have an IP configuration.
static class	Types.PifBondNeedsMoreMembers	A bond must consist of at least two member interfaces
static class	Types.PifCannotBondCrossHost	You cannot bond interfaces across different servers.
static class	Types.PifConfigurationError	An unknown error occurred while attempting to configure an interface.
static class	Types.PifDeviceNotFound	The specified device was not found.
static class	Types.PifDoesNotAllowUnplug	The operation you requested cannot be performed because the specified PIF does not allow unplug.
static class	Types.PifHasFcoeSrInUse	The operation you requested cannot be performed because the specified PIF has FCoE SR in use.
static class	Types.PifHasNoNetworkConfiguration	PIF has no IP configuration (mode currently set to 'none')
static class	Types.PifHasNoV6NetworkConfiguration	PIF has no IPv6 configuration (mode currently set to 'none')
static enum	Types.PifIgmpStatus
static class	Types.PifIncompatiblePrimaryAddressType	The primary address types are not compatible
static class	Types.PifIsManagementInterface	The operation you requested cannot be performed because the specified PIF is the management interface.
static class	Types.PifIsNotPhysical	You tried to perform an operation which is only available on physical PIF
static class	Types.PifIsNotSriovCapable	The selected PIF is not capable of network SR-IOV
static class	Types.PifIsPhysical	You tried to destroy a PIF, but it represents an aspect of the physical host configuration, and so cannot be destroyed.
static class	Types.PifIsSriovLogical	You tried to create a bond on top of a network SR-IOV logical PIF - use the underlying physical PIF instead
static class	Types.PifIsVlan	You tried to create a VLAN on top of another VLAN - use the underlying physical PIF/bond instead
static class	Types.PifNotAttachedToHost	Cluster_host creation failed as the PIF provided is not attached to the host.
static class	Types.PifNotPresent	This host has no PIF on the given network.
static class	Types.PifSriovStillExists	The PIF is still related with a network SR-IOV
static class	Types.PifTunnelStillExists	Operation cannot proceed while a tunnel exists on this interface.
static class	Types.PifUnmanaged	The operation you requested cannot be performed because the specified PIF is not managed by xapi.
static class	Types.PifVlanExists	You tried to create a PIF, but it already exists.
static class	Types.PifVlanStillExists	Operation cannot proceed while a VLAN exists on this interface.
static enum	Types.PlacementPolicy
static enum	Types.PoolAllowedOperations
static class	Types.PoolAuthAlreadyEnabled	External authentication is already enabled for at least one server in this pool.
static class	Types.PoolAuthDisableFailed	The pool failed to disable the external authentication of at least one host.
static class	Types.PoolAuthDisableFailedInvalidAccount	External authentication has been disabled with errors: Some AD machine accounts were not disabled on the AD server due to invalid account.
static class	Types.PoolAuthDisableFailedPermissionDenied	External authentication has been disabled with errors: Your AD machine account was not disabled on the AD server as permission was denied.
static class	Types.PoolAuthDisableFailedWrongCredentials	External authentication has been disabled with errors: Some AD machine accounts were not disabled on the AD server due to invalid credentials.
static class	Types.PoolAuthEnableFailed	The pool failed to enable external authentication.
static class	Types.PoolAuthEnableFailedDomainLookupFailed	The pool failed to enable external authentication.
static class	Types.PoolAuthEnableFailedDuplicateHostname	The pool failed to enable external authentication.
static class	Types.PoolAuthEnableFailedInvalidAccount	The pool failed to enable external authentication.
static class	Types.PoolAuthEnableFailedInvalidOu	The pool failed to enable external authentication.
static class	Types.PoolAuthEnableFailedPermissionDenied	The pool failed to enable external authentication.
static class	Types.PoolAuthEnableFailedUnavailable	The pool failed to enable external authentication.
static class	Types.PoolAuthEnableFailedWrongCredentials	The pool failed to enable external authentication.
static enum	Types.PoolGuestSecurebootReadiness
static class	Types.PoolJoiningExternalAuthMismatch	Cannot join pool whose external authentication configuration is different.
static class	Types.PoolJoiningHostCaCertificatesConflict	The host joining the pool has different CA certificates from the pool coordinator while using the same name, uninstall them and try again.
static class	Types.PoolJoiningHostHasBonds	The host joining the pool must not have any bonds.
static class	Types.PoolJoiningHostHasNetworkSriovs	The host joining the pool must not have any network SR-IOVs.
static class	Types.PoolJoiningHostHasNonManagementVlans	The host joining the pool must not have any non-management vlans.
static class	Types.PoolJoiningHostHasTunnels	The host joining the pool must not have any tunnels.
static class	Types.PoolJoiningHostManagementVlanDoesNotMatch	The host joining the pool must have the same management vlan.
static class	Types.PoolJoiningHostMustHaveOnlyOneIpOnClusteringNetwork	The host joining the pool must have one and only one IP on the clustering network
static class	Types.PoolJoiningHostMustHavePhysicalManagementNic	The server joining the pool must have a physical management NIC (i.e.
static class	Types.PoolJoiningHostMustHaveSameApiVersion	The host joining the pool must have the same API version as the pool coordinator.
static class	Types.PoolJoiningHostMustHaveSameDbSchema	The host joining the pool must have the same database schema as the pool coordinator.
static class	Types.PoolJoiningHostMustHaveSameProductVersion	The server joining the pool must have the same product version as the pool coordinator.
static class	Types.PoolJoiningHostMustOnlyHavePhysicalPifs	The host joining the pool must not have any bonds, VLANs or tunnels.
static class	Types.PoolJoiningHostTrustedCertificatesConflict	The joining host has a trusted certificate identical to one on the pool coordinator but with different purpose.
static class	Types.PoolJoiningPoolCannotEnableClusteringOnVlanNetwork	The host attempted to join a pool with clustering enabled on a non-management VLAN network, which is not supported.
static class	Types.PoolJoiningSmFeaturesIncompatible	The host joining the pool has an incompatible set of sm features from the pool coordinator.
static enum	Types.PrimaryAddressType
static class	Types.ProvisionFailedOutOfSpace	The provision call failed because it ran out of space.
static class	Types.ProvisionOnlyAllowedOnTemplate	The provision call can only be invoked on templates, not regular VMs.
static class	Types.PusbVdiConflict	The VDI corresponding to this PUSB has existing VBDs.
static class	Types.PvsCacheStorageAlreadyPresent	The PVS site already has cache storage configured for the host.
static class	Types.PvsCacheStorageIsInUse	The PVS cache storage is in use by the site and cannot be removed.
static class	Types.PvsProxyAlreadyPresent	The VIF is already associated with a PVS proxy
static class	Types.PvsProxyPresentOnHigherVifDevice	The VM has a VIF, with a higher device number than the new VIF, that uses a PVS proxy.
static enum	Types.PvsProxyStatus
static class	Types.PvsServerAddressInUse	The address specified is already in use by an existing PVS_server object
static class	Types.PvsSiteContainsRunningProxies	The PVS site contains running proxies.
static class	Types.PvsSiteContainsServers	The PVS site contains servers and cannot be forgotten.
static class	Types.PvsVifMustBeFirstDevice	The VIF used by PVS proxy must be the one with the lowest device number
static class	Types.RbacPermissionDenied	RBAC permission denied.
static interface	Types.Record	Interface for all Record classes
static class	Types.RedoLogIsEnabled	The operation could not be performed because a redo log is enabled on the Pool.
static class	Types.RepoShouldBeSingleOneEnabled	If the bundle repository or remote_pool repository is enabled, it should be the only enabled repository of the pool.
static class	Types.RepositoryAlreadyExists	The repository already exists.
static class	Types.RepositoryCleanupFailed	Failed to clean up local repository on coordinator.
static class	Types.RepositoryIsInUse	The repository is in use.
static class	Types.ReposyncFailed	Syncing with remote YUM repository failed.
static class	Types.RequiredPifIsUnplugged	The operation you requested cannot be performed because the specified PIF is currently unplugged.
static class	Types.RestoreIncompatibleVersion	The restore could not be performed because this backup has been created by a different (incompatible) product version
static class	Types.RestoreScriptFailed	The restore could not be performed because the restore script failed.
static class	Types.RestoreTargetMgmtIfNotInBackup	The restore could not be performed because the server's current management interface is not in the backup.
static class	Types.RestoreTargetMissingDevice	The restore could not be performed because a network interface is missing
static class	Types.RoleAlreadyExists	Role already exists.
static class	Types.RoleNotFound	Role cannot be found.
static enum	Types.SdnControllerProtocol
static class	Types.ServerCertificateChainInvalid	The provided intermediate certificates are not in a PEM-encoded X509 format.
static class	Types.ServerCertificateExpired	The provided certificate has expired.
static class	Types.ServerCertificateInvalid	The provided certificate is not in a PEM-encoded X509 format.
static class	Types.ServerCertificateKeyAlgorithmNotSupported	The provided key uses an unsupported algorithm.
static class	Types.ServerCertificateKeyInvalid	The provided key is not in a PEM-encoded PKCS#8 format.
static class	Types.ServerCertificateKeyMismatch	The provided key does not match the provided certificate's public key.
static class	Types.ServerCertificateKeyRsaLengthNotSupported	The provided RSA key does not have a length between 2048 and 4096.
static class	Types.ServerCertificateKeyRsaMultiNotSupported	The provided RSA key is using more than 2 primes, expecting only 2.
static class	Types.ServerCertificateNotValidYet	The provided certificate is not valid yet.
static class	Types.ServerCertificateSignatureNotSupported	The provided certificate is not using one of the following SHA2 signature algorithms: SHA256, SHA512.
static class	Types.SessionAuthenticationFailed	The credentials given by the user are incorrect, so access has been denied, and you have not been issued a session handle.
static class	Types.SessionAuthorizationFailed	The credentials given by the user are correct, but the user could not be authorized, so access has been denied, and you have not been issued a session handle.
static class	Types.SessionInvalid	You gave an invalid session reference.
static class	Types.SessionNotRegistered	This session is not registered to receive events.
static class	Types.SetConsoleTimeoutPartiallyFailed	Some hosts failed to set console timeout.
static class	Types.SetSshAutoModePartiallyFailed	Some hosts failed to set SSH auto mode.
static class	Types.SetSshTimeoutPartiallyFailed	Some hosts failed to set SSH timeout.
static class	Types.SlaveRequiresManagementInterface	The management interface on a supporter cannot be disabled because the supporter would enter emergency mode.
static class	Types.SmPluginCommunicationFailure	The SM plug-in did not respond to a query.
static class	Types.SrAttachFailed	Attaching this SR failed.
static class	Types.SrBackendFailure	There was an SR backend failure.
static class	Types.SrDeviceInUse	The SR operation cannot be performed because a device underlying the SR is in use by the server.
static class	Types.SrDoesNotSupportMigration	Cannot migrate a VDI to or from an SR that doesn't support migration.
static class	Types.SrFull	The SR is full.
static class	Types.SrHasMultiplePbds	The SR.shared flag cannot be set to false while the SR remains connected to multiple servers.
static class	Types.SrHasNoPbds	The SR has no attached PBDs
static class	Types.SrHasPbd	The SR is still connected to a host via a PBD.
static enum	Types.SrHealth
static class	Types.SrIndestructible	The SR could not be destroyed because the 'indestructible' flag was set on it.
static enum	Types.SriovConfigurationMode
static class	Types.SrIsCacheSr	The SR is currently being used as a local cache SR.
static class	Types.SrNotAttached	The SR is not attached.
static class	Types.SrNotEmpty	The SR operation cannot be performed because the SR is not empty.
static class	Types.SrNotSharable	The PBD could not be plugged because the SR is in use by another host and is not marked as sharable.
static class	Types.SrOperationNotSupported	The SR backend does not support the operation (check the SR's allowed operations)
static class	Types.SrRequiresUpgrade	The operation cannot be performed until the SR has been upgraded
static class	Types.SrSourceSpaceInsufficient	The source SR does not have sufficient temporary space available to proceed the operation.
static class	Types.SrSuspendSpaceInsufficient	The suspend SR does not have sufficient free space to store the VM suspend image.
static class	Types.SrUnhealthy	The SR is currently unhealthy.
static class	Types.SrUnknownDriver	The SR could not be connected because the driver was not recognised.
static class	Types.SrUuidExists	An SR with that uuid already exists.
static class	Types.SrVdiLockingFailed	The operation could not proceed because necessary VDIs were already locked at the storage level.
static class	Types.SslVerifyError	The remote system's SSL certificate failed to verify against our certificate library.
static enum	Types.StorageOperations
static class	Types.SubjectAlreadyExists	Subject already exists.
static class	Types.SubjectCannotBeResolved	Subject cannot be resolved by the external directory service.
static class	Types.SuspendImageNotAccessible	The suspend image of a checkpoint is not accessible from the host on which the VM is running
static class	Types.SyncBundleInProgress	The operation could not be performed because syncing bundle is in progress.
static class	Types.SyncUpdatesInProgress	The operation could not be performed because syncing updates is in progress.
static class	Types.Sysprep	VM.sysprep error with details in the message
static class	Types.SystemStatusMustUseTarOnOem	You must use tar output to retrieve system status from an OEM server.
static class	Types.SystemStatusRetrievalFailed	Retrieving system status from the host failed.
static enum	Types.TaskAllowedOperations
static class	Types.TaskCancelled	The request was asynchronously canceled.
static enum	Types.TaskStatusType
static enum	Types.TelemetryFrequency
static class	Types.TelemetryNextCollectionTooLate	The next scheduled telemetry data collection is too far into the future.
static class	Types.TlsConnectionFailed	Cannot contact the other host using TLS on the specified address and port
static class	Types.TlsVerificationNotEnabledInPool	TLS verification has not been enabled in the pool successfully, please enable it in XC or run xe pool-enable-tls-verification instead.
static class	Types.TooBusy	The request was rejected because the server is too busy.
static class	Types.TooManyGroups	VM can only belong to one group.
static class	Types.TooManyPendingTasks	The request was rejected because there are too many pending tasks on the server.
static class	Types.TooManyStorageMigrates	You reached the maximal number of concurrently migrating VMs.
static class	Types.TooManyVusbs	The VM has too many VUSBs.
static class	Types.TransportPifNotConfigured	The tunnel transport PIF has no IP configuration set.
static enum	Types.TristateType
static class	Types.TrustedCertificateAlreadyExists	A trusted certificate already exists with the same purpose.
static class	Types.TrustedCertificateExpired	The provided certificate has expired.
static class	Types.TrustedCertificateInvalid	The provided certificate is not in a PEM-encoded X509 format.
static class	Types.TrustedCertificateNotValidYet	The provided certificate is not valid yet.
static enum	Types.TunnelProtocol
static class	Types.UnimplementedInSmBackend	You have attempted a function which is not implemented
static class	Types.UnknownBootloader	The requested bootloader is unknown
static enum	Types.UpdateAfterApplyGuidance
static class	Types.UpdateAlreadyApplied	This update has already been applied.
static class	Types.UpdateAlreadyAppliedInPool	This update has already been applied to all hosts in the pool.
static class	Types.UpdateAlreadyExists	The uploaded update already exists
static class	Types.UpdateApplyFailed	The update failed to apply.
static enum	Types.UpdateGuidances
static class	Types.UpdateinfoHashMismatch	The hash of updateinfo doesn't match with current one.
static class	Types.UpdateIsApplied	The specified update has been applied and cannot be destroyed.
static class	Types.UpdatePoolApplyFailed	The update cannot be applied for the following host(s).
static class	Types.UpdatePrecheckFailedConflictPresent	The update pre-check stage failed: conflicting update(s) are present.
static class	Types.UpdatePrecheckFailedGpgkeyNotImported	The update pre-check stage failed: RPM package validation requires a GPG key that is not present on the host.
static class	Types.UpdatePrecheckFailedOutOfSpace	The update pre-check stage failed: the server does not have enough space.
static class	Types.UpdatePrecheckFailedPrerequisiteMissing	The update pre-check stage failed: prerequisite update(s) are missing.
static class	Types.UpdatePrecheckFailedUnknownError	The update pre-check stage failed with an unknown error.
static class	Types.UpdatePrecheckFailedWrongServerVersion	The update pre-check stage failed: the server is of an incorrect version.
static enum	Types.UpdateSyncFrequency
static class	Types.UpdateSyncingRemotePoolCoordinatorConnectionFailed	There was an error connecting to the remote pool coordinator while syncing updates from it.
static class	Types.UpdateSyncingRemotePoolCoordinatorServiceFailed	There was an error connecting to the server while syncing updates from it.
static class	Types.UsbAlreadyAttached	The USB device is currently attached to a VM.
static class	Types.UsbGroupConflict	USB_groups are currently restricted to contain no more than one VUSB.
static class	Types.UsbGroupContainsNoPusbs	The USB group does not contain any PUSBs.
static class	Types.UsbGroupContainsPusb	The USB group contains active PUSBs and cannot be deleted.
static class	Types.UsbGroupContainsVusb	The USB group contains active VUSBs and cannot be deleted.
static class	Types.UserIsNotLocalSuperuser	Only the local superuser can perform this operation.
static class	Types.UuidInvalid	The uuid you supplied was invalid.
static class	Types.V6dFailure	There was a problem with the license daemon (v6d).
static class	Types.ValueNotSupported	You attempted to set a value that is not supported by this implementation.
static class	Types.VbdCdsMustBeReadonly	Read/write CDs are not supported
static class	Types.VbdIsEmpty	Operation could not be performed because the drive is empty
static enum	Types.VbdMode
static class	Types.VbdNotEmpty	Operation could not be performed because the drive is not empty
static class	Types.VbdNotRemovableMedia	Media could not be ejected because it is not removable
static class	Types.VbdNotUnpluggable	Drive could not be hot-unplugged because it is not marked as unpluggable
static enum	Types.VbdOperations
static class	Types.VbdTrayLocked	This VM has locked the DVD drive tray, so the disk cannot be ejected
static enum	Types.VbdType
static class	Types.VcpuMaxNotCoresPerSocketMultiple	VCPUs_max must be a multiple of cores-per-socket
static class	Types.VdiCbtEnabled	The requested operation is not allowed for VDIs with CBT enabled or VMs having such VDIs, and CBT is enabled for the specified VDI.
static class	Types.VdiContainsMetadataOfThisPool	The VDI could not be opened for metadata recovery as it contains the current pool's metadata.
static class	Types.VdiCopyFailed	The VDI copy action has failed
static class	Types.VdiHasRrds	The operation cannot be performed because this VDI has rrd stats
static class	Types.VdiIncompatibleType	This operation cannot be performed because the specified VDI is of an incompatible type (eg: an HA statefile cannot be attached to a guest)
static class	Types.VdiInUse	This operation cannot be performed because this VDI is in use by some other operation
static class	Types.VdiIsAPhysicalDevice	The operation cannot be performed on physical device
static class	Types.VdiIsEncrypted	The requested operation is not allowed because the specified VDI is encrypted.
static class	Types.VdiIsNotIso	This operation can only be performed on CD VDIs (iso files or CDROM drives)
static class	Types.VdiLocationMissing	This operation cannot be performed because the specified VDI could not be found in the specified SR
static class	Types.VdiMissing	This operation cannot be performed because the specified VDI could not be found on the storage substrate
static class	Types.VdiNeedsVmForMigrate	Cannot migrate a VDI which is not attached to a running VM.
static class	Types.VdiNoCbtMetadata	The requested operation is not allowed because the specified VDI does not have changed block tracking metadata.
static class	Types.VdiNotAvailable	This operation cannot be performed because this VDI could not be properly attached to the VM.
static class	Types.VdiNotInMap	This VDI was not mapped to a destination SR in VM.migrate_send operation
static class	Types.VdiNotManaged	This operation cannot be performed because the system does not manage this VDI
static class	Types.VdiNotSparse	The VDI is not stored using a sparse format.
static class	Types.VdiOnBootModeIncompatibleWithOperation	This operation is not permitted on VDIs in the 'on-boot=reset' mode, or on VMs having such VDIs.
static enum	Types.VdiOperations
static class	Types.VdiReadonly	The operation required write access but this VDI is read-only
static class	Types.VdiTooLarge	The VDI is too large.
static class	Types.VdiTooSmall	The VDI is too small.
static enum	Types.VdiType
static class	Types.VgpuDestinationIncompatible	The VGPU is not compatible with any PGPU in the destination.
static class	Types.VgpuGuestDriverLimit	The guest driver does not support VGPU migration.
static class	Types.VgpuSuspensionNotSupported	The VGPU configuration does not support suspension.
static enum	Types.VgpuTypeImplementation
static class	Types.VgpuTypeNoLongerSupported	VGPU type is no longer supported
static class	Types.VgpuTypeNotCompatible	Cannot create a virtual GPU that is incompatible with the existing types on the VM.
static class	Types.VgpuTypeNotCompatibleWithRunningType	The VGPU type is incompatible with one or more of the VGPU types currently running on this PGPU
static class	Types.VgpuTypeNotEnabled	VGPU type is not one of the PGPU's enabled types.
static class	Types.VgpuTypeNotSupported	VGPU type is not one of the PGPU's supported types.
static class	Types.VifInUse	Network has active VIFs
static enum	Types.VifIpv4ConfigurationMode
static enum	Types.VifIpv6ConfigurationMode
static enum	Types.VifLockingMode
static class	Types.VifNotInMap	This VIF was not mapped to a destination Network in VM.migrate_send operation
static enum	Types.VifOperations
static class	Types.VlanInUse	Operation cannot be performed because this VLAN is already in use.
static class	Types.VlanTagInvalid	You tried to create a VLAN, but the tag you gave was invalid -- it must be between 0 and 4094.
static enum	Types.VmApplianceOperation
static class	Types.VmAssignedToProtectionPolicy	This VM is assigned to a protection policy.
static class	Types.VmAssignedToSnapshotSchedule	This VM is assigned to a snapshot schedule.
static class	Types.VmAttachedToMoreThanOneVdiWithTimeoffsetMarkedAsResetOnBoot	You attempted to start a VM that's attached to more than one VDI with a timeoffset marked as reset-on-boot.
static class	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.
static class	Types.VmBiosStringsAlreadySet	The BIOS strings for this VM have already been set and cannot be changed.
static class	Types.VmCallPluginRateLimit	There is a minimal interval required between consecutive plug-in calls made on the same VM, please wait before retry.
static class	Types.VmCannotDeleteDefaultTemplate	You cannot delete the specified default template.
static class	Types.VmCheckpointResumeFailed	An error occured while restoring the memory image of the specified virtual machine
static class	Types.VmCheckpointSuspendFailed	An error occured while saving the memory image of the specified virtual machine
static class	Types.VmCrashed	The VM crashed
static class	Types.VmDuplicateVbdDevice	The specified VM has a duplicate VBD device and cannot be started.
static class	Types.VmFailedShutdownAcknowledgment	VM didn't acknowledge the need to shutdown.
static class	Types.VmFailedSuspendAcknowledgment	VM didn't acknowledge the need to suspend.
static class	Types.VmHalted	The VM unexpectedly halted
static class	Types.VmHasCheckpoint	Cannot migrate a VM which has a checkpoint.
static class	Types.VmHasNoSuspendVdi	VM cannot be resumed because it has no suspend VDI
static class	Types.VmHasPciAttached	This operation could not be performed, because the VM has one or more PCI devices passed through.
static class	Types.VmHasSriovVif	This operation could not be performed, because the VM has one or more SR-IOV VIFs.
static class	Types.VmHasTooManySnapshots	Cannot migrate a VM with more than one snapshot.
static class	Types.VmHasVgpu	This operation could not be performed, because the VM has one or more virtual GPUs.
static class	Types.VmHasVusbs	The operation is not allowed when the VM has VUSBs.
static class	Types.VmHostIncompatibleVersion	This VM operation cannot be performed on an older-versioned host during an upgrade.
static class	Types.VmHostIncompatibleVersionMigrate	Cannot migrate a VM to a destination host which is older than the source host.
static class	Types.VmHostIncompatibleVirtualHardwarePlatformVersion	You attempted to run a VM on a host that cannot provide the VM's required Virtual Hardware Platform version.
static class	Types.VmHvmRequired	HVM is required for this operation
static class	Types.VmIncompatibleWithThisHost	The VM is incompatible with the CPU features of this host.
static class	Types.VmIsImmobile	The VM is configured in a way that prevents it from being mobile.
static class	Types.VmIsPartOfAnAppliance	This operation is not allowed as the VM is part of an appliance.
static class	Types.VmIsProtected	This operation cannot be performed because the specified VM is protected by HA
static class	Types.VmIsTemplate	The operation attempted is not valid for a template VM
static class	Types.VmIsUsingNestedVirt	This operation is illegal because the VM is using nested virtualization.
static class	Types.VmLacksFeature	You attempted an operation on a VM which lacks the feature.
static class	Types.VmMemorySizeTooLow	The specified VM has too little memory to be started.
static class	Types.VmMigrateContactRemoteServiceFailed	Failed to contact service on the destination host.
static class	Types.VmMigrateFailed	An error occurred during the migration process.
static class	Types.VmMissingPvDrivers	You attempted an operation on a VM which requires PV drivers to be installed but the drivers were not detected.
static class	Types.VmNoCrashdumpSr	This VM does not have a crash dump SR specified.
static class	Types.VmNoEmptyCdVbd	The VM has no empty CD drive (VBD).
static class	Types.VmNonSuspendable	You attempted an operation on a VM which is not suspendable.
static class	Types.VmNoSuspendSr	This VM does not have a suspend SR specified.
static class	Types.VmNotResidentHere	The specified VM is not currently resident on the specified server.
static class	Types.VmNoVcpus	You need at least 1 VCPU to start a VM
static class	Types.VmOldPvDrivers	You attempted an operation on a VM which requires a more recent version of the PV drivers.
static enum	Types.VmOperations
static class	Types.VmPciBusFull	The VM does not have any free PCI slots
static enum	Types.VmPowerState
static enum	Types.VmppArchiveFrequency
static class	Types.VmppArchiveMoreFrequentThanBackup	Archive more frequent than backup.
static enum	Types.VmppArchiveTargetType
static enum	Types.VmppBackupFrequency
static enum	Types.VmppBackupType
static class	Types.VmppHasVm	There is at least one VM assigned to this protection policy.
static class	Types.VmPvDriversInUse	VM PV drivers still in use
static class	Types.VmRebooted	The VM unexpectedly rebooted
static class	Types.VmRequiresGpu	You attempted to run a VM on a host which doesn't have a pGPU available in the GPU group needed by the VM.
static class	Types.VmRequiresIommu	You attempted to run a VM on a host which doesn't have I/O virtualization (IOMMU/VT-d) enabled, which is needed by the VM.
static class	Types.VmRequiresNetwork	You attempted to run a VM on a host which doesn't have a PIF on a Network needed by the VM.
static class	Types.VmRequiresSr	You attempted to run a VM on a host which doesn't have access to an SR needed by the VM.
static class	Types.VmRequiresVdi	VM cannot be started because it requires a VDI which cannot be attached
static class	Types.VmRequiresVgpu	You attempted to run a VM on a host on which the vGPU required by the VM cannot be allocated on any pGPUs in the GPU_group needed by the VM.
static class	Types.VmRequiresVusb	You attempted to run a VM on a host on which the VUSB required by the VM cannot be allocated on any PUSBs in the USB_group needed by the VM.
static class	Types.VmRevertFailed	An error occured while reverting the specified virtual machine to the specified snapshot
static enum	Types.VmSecurebootCertificatesState
static enum	Types.VmSecurebootReadiness
static class	Types.VmsFailedToCooperate	The given VMs failed to release memory when instructed to do so
static class	Types.VmShutdownTimeout	VM failed to shutdown before the timeout expired
static class	Types.VmSnapshotWithQuiesceFailed	The quiesced-snapshot operation failed for an unexpected reason
static class	Types.VmSnapshotWithQuiesceNotSupported	The VSS plug-in is not installed on this virtual machine
static class	Types.VmSnapshotWithQuiescePluginDeosNotRespond	The VSS plug-in cannot be contacted
static class	Types.VmSnapshotWithQuiesceTimeout	The VSS plug-in has timed out
static enum	Types.VmssFrequency
static class	Types.VmssHasVm	There is at least one VM assigned to snapshot schedule.
static enum	Types.VmssType
static class	Types.VmSuspendTimeout	VM failed to suspend before the timeout expired
static class	Types.VmToImportIsNotNewerVersion	The VM cannot be imported unforced because it is either the same version or an older version of an existing VM.
static class	Types.VmTooManyVcpus	Too many VCPUs to start this VM
static enum	Types.VmUefiMode
static class	Types.VmUnsafeBoot	You attempted an operation on a VM that was judged to be unsafe by the server.
static class	Types.VtpmMaxAmountReached	The VM cannot be associated with more VTPMs.
static enum	Types.VtpmOperations
static enum	Types.VusbOperations
static class	Types.WlbAuthenticationFailed	Failed to authenticate with the WLB server, the provided credentials are invalid.
static class	Types.WlbConnectionRefused	WLB refused a connection to the server.
static class	Types.WlbConnectionReset	The connection to the WLB server was reset.
static class	Types.WlbDisabled	This pool has wlb-enabled set to false.
static class	Types.WlbInternalError	WLB reported an internal error.
static class	Types.WlbMalformedRequest	WLB rejected the server's request as malformed.
static class	Types.WlbMalformedResponse	WLB said something that the server wasn't expecting or didn't understand.
static class	Types.WlbNotInitialized	No WLB connection is configured.
static class	Types.WlbTimeout	The communication with the WLB server timed out.
static class	Types.WlbUnknownHost	The configured WLB server name failed to resolve in DNS.
static class	Types.WlbUrlInvalid	The WLB URL is invalid.
static class	Types.WlbXenserverAuthenticationFailed	WLB reported that the server rejected its configured authentication details.
static class	Types.WlbXenserverConnectionRefused	WLB reported that the server refused to let it connect (even though we're connecting perfectly fine in the other direction).
static class	Types.WlbXenserverMalformedResponse	WLB reported that the server said something to it that WLB wasn't expecting or didn't understand.
static class	Types.WlbXenserverTimeout	WLB reported that communication with the server timed out.
static class	Types.WlbXenserverUnknownHost	WLB reported that its configured server name for this server instance failed to resolve in DNS.
static class	Types.XapiHookFailed	3rd party xapi hook failed
static class	Types.XenAPIException	Base class for all XenAPI Exceptions
static class	Types.XenapiMissingPlugin	The requested plug-in could not be found.
static enum	Types.XenAPIObjects
static class	Types.XenapiPluginFailure	There was a failure communicating with the plug-in.
static class	Types.XenIncompatible	The current version of Xen or its control libraries is incompatible with the Toolstack.
static class	Types.XenVssReqErrorAddingVolumeToSnapsetFailed	Some volumes to be snapshot could not be added to the VSS snapshot set
static class	Types.XenVssReqErrorCreatingSnapshot	An attempt to create the snapshots failed
static class	Types.XenVssReqErrorCreatingSnapshotXmlString	Could not create the XML string generated by the transportable snapshot
static class	Types.XenVssReqErrorInitFailed	Initialization of the VSS requester failed
static class	Types.XenVssReqErrorNoVolumesSupported	Could not find any volumes supported by the VSS Provider
static class	Types.XenVssReqErrorPreparingWriters	An attempt to prepare VSS writers for the snapshot failed
static class	Types.XenVssReqErrorProvNotLoaded	The VSS Provider is not loaded
static class	Types.XenVssReqErrorStartSnapshotSetFailed	An attempt to start a new VSS snapshot failed
static class	Types.XmlrpcUnmarshalFailure	The server failed to unmarshal the XMLRPC message; it was expecting one element and received something else.

Constructor Summary

Constructors

Constructor	Description
Types()

Method Summary

Modifier and Type	Method	Description
static void	checkError(JsonRpcResponseError response)	Checks the provided server response was successful.
static Blob	toBlob(Task task, Connection connection)	Attempt to convert the Task's result to a Blob object.
static Bond	toBond(Task task, Connection connection)	Attempt to convert the Task's result to a Bond object.
static Certificate	toCertificate(Task task, Connection connection)	Attempt to convert the Task's result to a Certificate object.
static Cluster	toCluster(Task task, Connection connection)	Attempt to convert the Task's result to a Cluster object.
static ClusterHost	toClusterHost(Task task, Connection connection)	Attempt to convert the Task's result to a ClusterHost object.
static Console	toConsole(Task task, Connection connection)	Attempt to convert the Task's result to a Console object.
static Crashdump	toCrashdump(Task task, Connection connection)	Attempt to convert the Task's result to a Crashdump object.
static DriverVariant	toDriverVariant(Task task, Connection connection)	Attempt to convert the Task's result to a DriverVariant object.
static DRTask	toDRTask(Task task, Connection connection)	Attempt to convert the Task's result to a DRTask object.
static Feature	toFeature(Task task, Connection connection)	Attempt to convert the Task's result to a Feature object.
static GPUGroup	toGPUGroup(Task task, Connection connection)	Attempt to convert the Task's result to a GPUGroup object.
static Host	toHost(Task task, Connection connection)	Attempt to convert the Task's result to a Host object.
static HostCpu	toHostCpu(Task task, Connection connection)	Attempt to convert the Task's result to a HostCpu object.
static HostCrashdump	toHostCrashdump(Task task, Connection connection)	Attempt to convert the Task's result to a HostCrashdump object.
static HostDriver	toHostDriver(Task task, Connection connection)	Attempt to convert the Task's result to a HostDriver object.
static HostMetrics	toHostMetrics(Task task, Connection connection)	Attempt to convert the Task's result to a HostMetrics object.
static HostPatch	toHostPatch(Task task, Connection connection)	Attempt to convert the Task's result to a HostPatch object.
static LVHD	toLVHD(Task task, Connection connection)	Attempt to convert the Task's result to a LVHD object.
static Message	toMessage(Task task, Connection connection)	Attempt to convert the Task's result to a Message object.
static Network	toNetwork(Task task, Connection connection)	Attempt to convert the Task's result to a Network object.
static NetworkSriov	toNetworkSriov(Task task, Connection connection)	Attempt to convert the Task's result to a NetworkSriov object.
static Observer	toObserver(Task task, Connection connection)	Attempt to convert the Task's result to a Observer object.
static PBD	toPBD(Task task, Connection connection)	Attempt to convert the Task's result to a PBD object.
static PCI	toPCI(Task task, Connection connection)	Attempt to convert the Task's result to a PCI object.
static PGPU	toPGPU(Task task, Connection connection)	Attempt to convert the Task's result to a PGPU object.
static PIF	toPIF(Task task, Connection connection)	Attempt to convert the Task's result to a PIF object.
static PIFMetrics	toPIFMetrics(Task task, Connection connection)	Attempt to convert the Task's result to a PIFMetrics object.
static Pool	toPool(Task task, Connection connection)	Attempt to convert the Task's result to a Pool object.
static PoolPatch	toPoolPatch(Task task, Connection connection)	Attempt to convert the Task's result to a PoolPatch object.
static PoolUpdate	toPoolUpdate(Task task, Connection connection)	Attempt to convert the Task's result to a PoolUpdate object.
static PUSB	toPUSB(Task task, Connection connection)	Attempt to convert the Task's result to a PUSB object.
static PVSCacheStorage	toPVSCacheStorage(Task task, Connection connection)	Attempt to convert the Task's result to a PVSCacheStorage object.
static PVSProxy	toPVSProxy(Task task, Connection connection)	Attempt to convert the Task's result to a PVSProxy object.
static PVSServer	toPVSServer(Task task, Connection connection)	Attempt to convert the Task's result to a PVSServer object.
static PVSSite	toPVSSite(Task task, Connection connection)	Attempt to convert the Task's result to a PVSSite object.
static Repository	toRepository(Task task, Connection connection)	Attempt to convert the Task's result to a Repository object.
static Role	toRole(Task task, Connection connection)	Attempt to convert the Task's result to a Role object.
static SDNController	toSDNController(Task task, Connection connection)	Attempt to convert the Task's result to a SDNController object.
static Secret	toSecret(Task task, Connection connection)	Attempt to convert the Task's result to a Secret object.
static Session	toSession(Task task, Connection connection)	Attempt to convert the Task's result to a Session object.
static SM	toSM(Task task, Connection connection)	Attempt to convert the Task's result to a SM object.
static SR	toSR(Task task, Connection connection)	Attempt to convert the Task's result to a SR object.
static Subject	toSubject(Task task, Connection connection)	Attempt to convert the Task's result to a Subject object.
static Task	toTask(Task task, Connection connection)	Attempt to convert the Task's result to a Task object.
static Tunnel	toTunnel(Task task, Connection connection)	Attempt to convert the Task's result to a Tunnel object.
static USBGroup	toUSBGroup(Task task, Connection connection)	Attempt to convert the Task's result to a USBGroup object.
static User	toUser(Task task, Connection connection)	Attempt to convert the Task's result to a User object.
static VBD	toVBD(Task task, Connection connection)	Attempt to convert the Task's result to a VBD object.
static VBDMetrics	toVBDMetrics(Task task, Connection connection)	Attempt to convert the Task's result to a VBDMetrics object.
static VDI	toVDI(Task task, Connection connection)	Attempt to convert the Task's result to a VDI object.
static VGPU	toVGPU(Task task, Connection connection)	Attempt to convert the Task's result to a VGPU object.
static VGPUType	toVGPUType(Task task, Connection connection)	Attempt to convert the Task's result to a VGPUType object.
static VIF	toVIF(Task task, Connection connection)	Attempt to convert the Task's result to a VIF object.
static VIFMetrics	toVIFMetrics(Task task, Connection connection)	Attempt to convert the Task's result to a VIFMetrics object.
static VLAN	toVLAN(Task task, Connection connection)	Attempt to convert the Task's result to a VLAN object.
static VM	toVM(Task task, Connection connection)	Attempt to convert the Task's result to a VM object.
static VMAppliance	toVMAppliance(Task task, Connection connection)	Attempt to convert the Task's result to a VMAppliance object.
static VMGroup	toVMGroup(Task task, Connection connection)	Attempt to convert the Task's result to a VMGroup object.
static VMGuestMetrics	toVMGuestMetrics(Task task, Connection connection)	Attempt to convert the Task's result to a VMGuestMetrics object.
static VMMetrics	toVMMetrics(Task task, Connection connection)	Attempt to convert the Task's result to a VMMetrics object.
static VMPP	toVMPP(Task task, Connection connection)	Attempt to convert the Task's result to a VMPP object.
static VMSS	toVMSS(Task task, Connection connection)	Attempt to convert the Task's result to a VMSS object.
static VTPM	toVTPM(Task task, Connection connection)	Attempt to convert the Task's result to a VTPM object.
static VUSB	toVUSB(Task task, Connection connection)	Attempt to convert the Task's result to a VUSB object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Types

public Types()

Method Details

checkError

public static void checkError(JsonRpcResponseError response)
                       throws Types.XenAPIException,
Types.BadServerResponse

Checks the provided server response was successful. If the call failed, throws a XenAPIException. If the server returned an invalid response, throws a BadServerResponse. Otherwise, returns the server response as passed in.

Throws:

Types.XenAPIException

Types.BadServerResponse

toBond

public static Bond toBond(Task task,
 Connection connection)
                   throws IOException

Attempt to convert the Task's result to a Bond object. Will return null if the method cannot fetch a valid value from the Task object.

Parameters:

task - The task from which to fetch the result.

connection - The connection

Returns:

the instantiated object if a valid value was found, null otherwise.

Throws:

Types.BadServerResponse - if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during send or receive. This includes cases where a payload is invalid JSON.

toCertificate

public static Certificate toCertificate(Task task,
 Connection connection)
                                 throws IOException

Attempt to convert the Task's result to a Certificate object. Will return null if the method cannot fetch a valid value from the Task object.

Parameters:

task - The task from which to fetch the result.

connection - The connection

Returns:

the instantiated object if a valid value was found, null otherwise.

Throws:

Types.BadServerResponse - if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during send or receive. This includes cases where a payload is invalid JSON.

toCluster

public static Cluster toCluster(Task task,
 Connection connection)
                         throws IOException

Attempt to convert the Task's result to a Cluster object. Will return null if the method cannot fetch a valid value from the Task object.

Parameters:

task - The task from which to fetch the result.

connection - The connection

Returns:

the instantiated object if a valid value was found, null otherwise.

Throws:

Types.BadServerResponse - if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during send or receive. This includes cases where a payload is invalid JSON.

toClusterHost

public static ClusterHost toClusterHost(Task task,
 Connection connection)
                                 throws IOException

Attempt to convert the Task's result to a ClusterHost object. Will return null if the method cannot fetch a valid value from the Task object.

Parameters:

task - The task from which to fetch the result.

connection - The connection

Returns:

the instantiated object if a valid value was found, null otherwise.

Throws:

Types.BadServerResponse - if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during send or receive. This includes cases where a payload is invalid JSON.

toDRTask

public static DRTask toDRTask(Task task,
 Connection connection)
                       throws IOException

Attempt to convert the Task's result to a DRTask object. Will return null if the method cannot fetch a valid value from the Task object.

Parameters:

task - The task from which to fetch the result.

connection - The connection

Returns:

the instantiated object if a valid value was found, null otherwise.

Throws:

Types.BadServerResponse - if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during send or receive. This includes cases where a payload is invalid JSON.

toDriverVariant

public static DriverVariant toDriverVariant(Task task,
 Connection connection)
                                     throws IOException

Attempt to convert the Task's result to a DriverVariant object. Will return null if the method cannot fetch a valid value from the Task object.

Parameters:

task - The task from which to fetch the result.

connection - The connection

Returns:

the instantiated object if a valid value was found, null otherwise.

Throws:

Types.BadServerResponse - if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during send or receive. This includes cases where a payload is invalid JSON.

toFeature

public static Feature toFeature(Task task,
 Connection connection)
                         throws IOException

Attempt to convert the Task's result to a Feature object. Will return null if the method cannot fetch a valid value from the Task object.

Parameters:

task - The task from which to fetch the result.

connection - The connection

Returns:

the instantiated object if a valid value was found, null otherwise.

Throws:

Types.BadServerResponse - if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during send or receive. This includes cases where a payload is invalid JSON.

toGPUGroup

public static GPUGroup toGPUGroup(Task task,
 Connection connection)
                           throws IOException

Attempt to convert the Task's result to a GPUGroup object. Will return null if the method cannot fetch a valid value from the Task object.

Parameters:

task - The task from which to fetch the result.

connection - The connection

Returns:

the instantiated object if a valid value was found, null otherwise.

Throws:

Types.BadServerResponse - if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during send or receive. This includes cases where a payload is invalid JSON.

toHostDriver

public static HostDriver toHostDriver(Task task,
 Connection connection)
                               throws IOException

Attempt to convert the Task's result to a HostDriver object. Will return null if the method cannot fetch a valid value from the Task object.

Parameters:

task - The task from which to fetch the result.

connection - The connection

Returns:

the instantiated object if a valid value was found, null otherwise.

Throws:

Types.BadServerResponse - if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during send or receive. This includes cases where a payload is invalid JSON.

toLVHD

public static LVHD toLVHD(Task task,
 Connection connection)
                   throws IOException

Attempt to convert the Task's result to a LVHD object. Will return null if the method cannot fetch a valid value from the Task object.

Parameters:

task - The task from which to fetch the result.

connection - The connection

Returns:

the instantiated object if a valid value was found, null otherwise.

Throws:

Types.BadServerResponse - if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during send or receive. This includes cases where a payload is invalid JSON.

toObserver

public static Observer toObserver(Task task,
 Connection connection)
                           throws IOException

Attempt to convert the Task's result to a Observer object. Will return null if the method cannot fetch a valid value from the Task object.

Parameters:

task - The task from which to fetch the result.

connection - The connection

Returns:

the instantiated object if a valid value was found, null otherwise.

Throws:

Types.BadServerResponse - if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during send or receive. This includes cases where a payload is invalid JSON.

toPBD

public static PBD toPBD(Task task,
 Connection connection)
                 throws IOException

Attempt to convert the Task's result to a PBD object. Will return null if the method cannot fetch a valid value from the Task object.

Parameters:

task - The task from which to fetch the result.

connection - The connection

Returns:

the instantiated object if a valid value was found, null otherwise.

Throws:

Types.BadServerResponse - if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during send or receive. This includes cases where a payload is invalid JSON.

toPCI

public static PCI toPCI(Task task,
 Connection connection)
                 throws IOException

Attempt to convert the Task's result to a PCI object. Will return null if the method cannot fetch a valid value from the Task object.

Parameters:

task - The task from which to fetch the result.

connection - The connection

Returns:

the instantiated object if a valid value was found, null otherwise.

Throws:

Types.BadServerResponse - if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during send or receive. This includes cases where a payload is invalid JSON.

toPGPU

public static PGPU toPGPU(Task task,
 Connection connection)
                   throws IOException

Attempt to convert the Task's result to a PGPU object. Will return null if the method cannot fetch a valid value from the Task object.

Parameters:

task - The task from which to fetch the result.

connection - The connection

Returns:

the instantiated object if a valid value was found, null otherwise.

Throws:

Types.BadServerResponse - if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during send or receive. This includes cases where a payload is invalid JSON.

toPIF

public static PIF toPIF(Task task,
 Connection connection)
                 throws IOException

Attempt to convert the Task's result to a PIF object. Will return null if the method cannot fetch a valid value from the Task object.

Parameters:

task - The task from which to fetch the result.

connection - The connection

Returns:

the instantiated object if a valid value was found, null otherwise.

Throws:

Types.BadServerResponse - if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during send or receive. This includes cases where a payload is invalid JSON.

toPIFMetrics

public static PIFMetrics toPIFMetrics(Task task,
 Connection connection)
                               throws IOException

Attempt to convert the Task's result to a PIFMetrics object. Will return null if the method cannot fetch a valid value from the Task object.

Parameters:

task - The task from which to fetch the result.

connection - The connection

Returns:

the instantiated object if a valid value was found, null otherwise.

Throws:

Types.BadServerResponse - if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during send or receive. This includes cases where a payload is invalid JSON.

toPUSB

public static PUSB toPUSB(Task task,
 Connection connection)
                   throws IOException

Attempt to convert the Task's result to a PUSB object. Will return null if the method cannot fetch a valid value from the Task object.

Parameters:

task - The task from which to fetch the result.

connection - The connection

Returns:

the instantiated object if a valid value was found, null otherwise.

Throws:

Types.BadServerResponse - if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during send or receive. This includes cases where a payload is invalid JSON.

toPVSCacheStorage

public static PVSCacheStorage toPVSCacheStorage(Task task,
 Connection connection)
                                         throws IOException

Attempt to convert the Task's result to a PVSCacheStorage object. Will return null if the method cannot fetch a valid value from the Task object.

Parameters:

task - The task from which to fetch the result.

connection - The connection

Returns:

the instantiated object if a valid value was found, null otherwise.

Throws:

Types.BadServerResponse - if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during send or receive. This includes cases where a payload is invalid JSON.

toPVSProxy

public static PVSProxy toPVSProxy(Task task,
 Connection connection)
                           throws IOException

Attempt to convert the Task's result to a PVSProxy object. Will return null if the method cannot fetch a valid value from the Task object.

Parameters:

task - The task from which to fetch the result.

connection - The connection

Returns:

the instantiated object if a valid value was found, null otherwise.

Throws:

Types.BadServerResponse - if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during send or receive. This includes cases where a payload is invalid JSON.

toPVSServer

public static PVSServer toPVSServer(Task task,
 Connection connection)
                             throws IOException

Attempt to convert the Task's result to a PVSServer object. Will return null if the method cannot fetch a valid value from the Task object.

Parameters:

task - The task from which to fetch the result.

connection - The connection

Returns:

the instantiated object if a valid value was found, null otherwise.

Throws:

Types.BadServerResponse - if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during send or receive. This includes cases where a payload is invalid JSON.

toPVSSite

public static PVSSite toPVSSite(Task task,
 Connection connection)
                         throws IOException

Attempt to convert the Task's result to a PVSSite object. Will return null if the method cannot fetch a valid value from the Task object.

Parameters:

task - The task from which to fetch the result.

connection - The connection

Returns:

the instantiated object if a valid value was found, null otherwise.

Throws:

Types.BadServerResponse - if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during send or receive. This includes cases where a payload is invalid JSON.

toRepository

public static Repository toRepository(Task task,
 Connection connection)
                               throws IOException

Attempt to convert the Task's result to a Repository object. Will return null if the method cannot fetch a valid value from the Task object.

Parameters:

task - The task from which to fetch the result.

connection - The connection

Returns:

the instantiated object if a valid value was found, null otherwise.

Throws:

Types.BadServerResponse - if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during send or receive. This includes cases where a payload is invalid JSON.

toSDNController

public static SDNController toSDNController(Task task,
 Connection connection)
                                     throws IOException

Attempt to convert the Task's result to a SDNController object. Will return null if the method cannot fetch a valid value from the Task object.

Parameters:

task - The task from which to fetch the result.

connection - The connection

Returns:

the instantiated object if a valid value was found, null otherwise.

Throws:

Types.BadServerResponse - if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during send or receive. This includes cases where a payload is invalid JSON.

toSM

public static SM toSM(Task task,
 Connection connection)
               throws IOException

Attempt to convert the Task's result to a SM object. Will return null if the method cannot fetch a valid value from the Task object.

Parameters:

task - The task from which to fetch the result.

connection - The connection

Returns:

the instantiated object if a valid value was found, null otherwise.

Throws:

Types.BadServerResponse - if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during send or receive. This includes cases where a payload is invalid JSON.

toSR

public static SR toSR(Task task,
 Connection connection)
               throws IOException

Attempt to convert the Task's result to a SR object. Will return null if the method cannot fetch a valid value from the Task object.

Parameters:

task - The task from which to fetch the result.

connection - The connection

Returns:

the instantiated object if a valid value was found, null otherwise.

Throws:

Types.BadServerResponse - if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during send or receive. This includes cases where a payload is invalid JSON.

toUSBGroup

public static USBGroup toUSBGroup(Task task,
 Connection connection)
                           throws IOException

Attempt to convert the Task's result to a USBGroup object. Will return null if the method cannot fetch a valid value from the Task object.

Parameters:

task - The task from which to fetch the result.

connection - The connection

Returns:

the instantiated object if a valid value was found, null otherwise.

Throws:

Types.BadServerResponse - if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during send or receive. This includes cases where a payload is invalid JSON.

toVBD

public static VBD toVBD(Task task,
 Connection connection)
                 throws IOException

Attempt to convert the Task's result to a VBD object. Will return null if the method cannot fetch a valid value from the Task object.

Parameters:

task - The task from which to fetch the result.

connection - The connection

Returns:

the instantiated object if a valid value was found, null otherwise.

Throws:

Types.BadServerResponse - if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during send or receive. This includes cases where a payload is invalid JSON.

toVBDMetrics

public static VBDMetrics toVBDMetrics(Task task,
 Connection connection)
                               throws IOException

Attempt to convert the Task's result to a VBDMetrics object. Will return null if the method cannot fetch a valid value from the Task object.

Parameters:

task - The task from which to fetch the result.

connection - The connection

Returns:

the instantiated object if a valid value was found, null otherwise.

Throws:

Types.BadServerResponse - if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during send or receive. This includes cases where a payload is invalid JSON.

toVDI

public static VDI toVDI(Task task,
 Connection connection)
                 throws IOException

Attempt to convert the Task's result to a VDI object. Will return null if the method cannot fetch a valid value from the Task object.

Parameters:

task - The task from which to fetch the result.

connection - The connection

Returns:

the instantiated object if a valid value was found, null otherwise.

Throws:

Types.BadServerResponse - if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during send or receive. This includes cases where a payload is invalid JSON.

toVGPU

public static VGPU toVGPU(Task task,
 Connection connection)
                   throws IOException

Attempt to convert the Task's result to a VGPU object. Will return null if the method cannot fetch a valid value from the Task object.

Parameters:

task - The task from which to fetch the result.

connection - The connection

Returns:

the instantiated object if a valid value was found, null otherwise.

Throws:

Types.BadServerResponse - if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during send or receive. This includes cases where a payload is invalid JSON.

toVGPUType

public static VGPUType toVGPUType(Task task,
 Connection connection)
                           throws IOException

Attempt to convert the Task's result to a VGPUType object. Will return null if the method cannot fetch a valid value from the Task object.

Parameters:

task - The task from which to fetch the result.

connection - The connection

Returns:

the instantiated object if a valid value was found, null otherwise.

Throws:

Types.BadServerResponse - if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during send or receive. This includes cases where a payload is invalid JSON.

toVIF

public static VIF toVIF(Task task,
 Connection connection)
                 throws IOException

Attempt to convert the Task's result to a VIF object. Will return null if the method cannot fetch a valid value from the Task object.

Parameters:

task - The task from which to fetch the result.

connection - The connection

Returns:

the instantiated object if a valid value was found, null otherwise.

Throws:

Types.BadServerResponse - if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during send or receive. This includes cases where a payload is invalid JSON.

toVIFMetrics

public static VIFMetrics toVIFMetrics(Task task,
 Connection connection)
                               throws IOException

Attempt to convert the Task's result to a VIFMetrics object. Will return null if the method cannot fetch a valid value from the Task object.

Parameters:

task - The task from which to fetch the result.

connection - The connection

Returns:

the instantiated object if a valid value was found, null otherwise.

Throws:

Types.BadServerResponse - if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during send or receive. This includes cases where a payload is invalid JSON.

toVLAN

public static VLAN toVLAN(Task task,
 Connection connection)
                   throws IOException

Attempt to convert the Task's result to a VLAN object. Will return null if the method cannot fetch a valid value from the Task object.

Parameters:

task - The task from which to fetch the result.

connection - The connection

Returns:

the instantiated object if a valid value was found, null otherwise.

Throws:

Types.BadServerResponse - if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during send or receive. This includes cases where a payload is invalid JSON.

toVM

public static VM toVM(Task task,
 Connection connection)
               throws IOException

Attempt to convert the Task's result to a VM object. Will return null if the method cannot fetch a valid value from the Task object.

Parameters:

task - The task from which to fetch the result.

connection - The connection

Returns:

the instantiated object if a valid value was found, null otherwise.

Throws:

Types.BadServerResponse - if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during send or receive. This includes cases where a payload is invalid JSON.

toVMPP

public static VMPP toVMPP(Task task,
 Connection connection)
                   throws IOException

Attempt to convert the Task's result to a VMPP object. Will return null if the method cannot fetch a valid value from the Task object.

Parameters:

task - The task from which to fetch the result.

connection - The connection

Returns:

the instantiated object if a valid value was found, null otherwise.

Throws:

Types.BadServerResponse - if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during send or receive. This includes cases where a payload is invalid JSON.

toVMSS

public static VMSS toVMSS(Task task,
 Connection connection)
                   throws IOException

Attempt to convert the Task's result to a VMSS object. Will return null if the method cannot fetch a valid value from the Task object.

Parameters:

task - The task from which to fetch the result.

connection - The connection

Returns:

the instantiated object if a valid value was found, null otherwise.

Throws:

Types.BadServerResponse - if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during send or receive. This includes cases where a payload is invalid JSON.

toVMAppliance

public static VMAppliance toVMAppliance(Task task,
 Connection connection)
                                 throws IOException

Attempt to convert the Task's result to a VMAppliance object. Will return null if the method cannot fetch a valid value from the Task object.

Parameters:

task - The task from which to fetch the result.

connection - The connection

Returns:

the instantiated object if a valid value was found, null otherwise.

Throws:

Types.BadServerResponse - if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during send or receive. This includes cases where a payload is invalid JSON.

toVMGroup

public static VMGroup toVMGroup(Task task,
 Connection connection)
                         throws IOException

Attempt to convert the Task's result to a VMGroup object. Will return null if the method cannot fetch a valid value from the Task object.

Parameters:

task - The task from which to fetch the result.

connection - The connection

Returns:

the instantiated object if a valid value was found, null otherwise.

Throws:

Types.BadServerResponse - if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during send or receive. This includes cases where a payload is invalid JSON.

toVMGuestMetrics

public static VMGuestMetrics toVMGuestMetrics(Task task,
 Connection connection)
                                       throws IOException

Attempt to convert the Task's result to a VMGuestMetrics object. Will return null if the method cannot fetch a valid value from the Task object.

Parameters:

task - The task from which to fetch the result.

connection - The connection

Returns:

the instantiated object if a valid value was found, null otherwise.

Throws:

Types.BadServerResponse - if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during send or receive. This includes cases where a payload is invalid JSON.

toVMMetrics

public static VMMetrics toVMMetrics(Task task,
 Connection connection)
                             throws IOException

Attempt to convert the Task's result to a VMMetrics object. Will return null if the method cannot fetch a valid value from the Task object.

Parameters:

task - The task from which to fetch the result.

connection - The connection

Returns:

the instantiated object if a valid value was found, null otherwise.

Throws:

Types.BadServerResponse - if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during send or receive. This includes cases where a payload is invalid JSON.

toVTPM

public static VTPM toVTPM(Task task,
 Connection connection)
                   throws IOException

Attempt to convert the Task's result to a VTPM object. Will return null if the method cannot fetch a valid value from the Task object.

Parameters:

task - The task from which to fetch the result.

connection - The connection

Returns:

the instantiated object if a valid value was found, null otherwise.

Throws:

Types.BadServerResponse - if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during send or receive. This includes cases where a payload is invalid JSON.

toVUSB

public static VUSB toVUSB(Task task,
 Connection connection)
                   throws IOException

Attempt to convert the Task's result to a VUSB object. Will return null if the method cannot fetch a valid value from the Task object.

Parameters:

task - The task from which to fetch the result.

connection - The connection

Returns:

the instantiated object if a valid value was found, null otherwise.

Throws:

Types.BadServerResponse - if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during send or receive. This includes cases where a payload is invalid JSON.

toBlob

public static Blob toBlob(Task task,
 Connection connection)
                   throws IOException

Attempt to convert the Task's result to a Blob object. Will return null if the method cannot fetch a valid value from the Task object.

Parameters:

task - The task from which to fetch the result.

connection - The connection

Returns:

the instantiated object if a valid value was found, null otherwise.

Throws:

Types.BadServerResponse - if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during send or receive. This includes cases where a payload is invalid JSON.

toConsole

public static Console toConsole(Task task,
 Connection connection)
                         throws IOException

Attempt to convert the Task's result to a Console object. Will return null if the method cannot fetch a valid value from the Task object.

Parameters:

task - The task from which to fetch the result.

connection - The connection

Returns:

the instantiated object if a valid value was found, null otherwise.

Throws:

Types.BadServerResponse - if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during send or receive. This includes cases where a payload is invalid JSON.

toCrashdump

public static Crashdump toCrashdump(Task task,
 Connection connection)
                             throws IOException

Attempt to convert the Task's result to a Crashdump object. Will return null if the method cannot fetch a valid value from the Task object.

Parameters:

task - The task from which to fetch the result.

connection - The connection

Returns:

the instantiated object if a valid value was found, null otherwise.

Throws:

Types.BadServerResponse - if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during send or receive. This includes cases where a payload is invalid JSON.

toHost

public static Host toHost(Task task,
 Connection connection)
                   throws IOException

Attempt to convert the Task's result to a Host object. Will return null if the method cannot fetch a valid value from the Task object.

Parameters:

task - The task from which to fetch the result.

connection - The connection

Returns:

the instantiated object if a valid value was found, null otherwise.

Throws:

Types.BadServerResponse - if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during send or receive. This includes cases where a payload is invalid JSON.

toHostCpu

public static HostCpu toHostCpu(Task task,
 Connection connection)
                         throws IOException

Attempt to convert the Task's result to a HostCpu object. Will return null if the method cannot fetch a valid value from the Task object.

Parameters:

task - The task from which to fetch the result.

connection - The connection

Returns:

the instantiated object if a valid value was found, null otherwise.

Throws:

Types.BadServerResponse - if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during send or receive. This includes cases where a payload is invalid JSON.

toHostCrashdump

public static HostCrashdump toHostCrashdump(Task task,
 Connection connection)
                                     throws IOException

Attempt to convert the Task's result to a HostCrashdump object. Will return null if the method cannot fetch a valid value from the Task object.

Parameters:

task - The task from which to fetch the result.

connection - The connection

Returns:

the instantiated object if a valid value was found, null otherwise.

Throws:

Types.BadServerResponse - if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during send or receive. This includes cases where a payload is invalid JSON.

toHostMetrics

public static HostMetrics toHostMetrics(Task task,
 Connection connection)
                                 throws IOException

Attempt to convert the Task's result to a HostMetrics object. Will return null if the method cannot fetch a valid value from the Task object.

Parameters:

task - The task from which to fetch the result.

connection - The connection

Returns:

the instantiated object if a valid value was found, null otherwise.

Throws:

Types.BadServerResponse - if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during send or receive. This includes cases where a payload is invalid JSON.

toHostPatch

public static HostPatch toHostPatch(Task task,
 Connection connection)
                             throws IOException

Attempt to convert the Task's result to a HostPatch object. Will return null if the method cannot fetch a valid value from the Task object.

Parameters:

task - The task from which to fetch the result.

connection - The connection

Returns:

the instantiated object if a valid value was found, null otherwise.

Throws:

Types.BadServerResponse - if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during send or receive. This includes cases where a payload is invalid JSON.

toMessage

public static Message toMessage(Task task,
 Connection connection)
                         throws IOException

Attempt to convert the Task's result to a Message object. Will return null if the method cannot fetch a valid value from the Task object.

Parameters:

task - The task from which to fetch the result.

connection - The connection

Returns:

the instantiated object if a valid value was found, null otherwise.

Throws:

Types.BadServerResponse - if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during send or receive. This includes cases where a payload is invalid JSON.

toNetwork

public static Network toNetwork(Task task,
 Connection connection)
                         throws IOException

Attempt to convert the Task's result to a Network object. Will return null if the method cannot fetch a valid value from the Task object.

Parameters:

task - The task from which to fetch the result.

connection - The connection

Returns:

the instantiated object if a valid value was found, null otherwise.

Throws:

Types.BadServerResponse - if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during send or receive. This includes cases where a payload is invalid JSON.

toNetworkSriov

public static NetworkSriov toNetworkSriov(Task task,
 Connection connection)
                                   throws IOException

Attempt to convert the Task's result to a NetworkSriov object. Will return null if the method cannot fetch a valid value from the Task object.

Parameters:

task - The task from which to fetch the result.

connection - The connection

Returns:

the instantiated object if a valid value was found, null otherwise.

Throws:

Types.BadServerResponse - if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during send or receive. This includes cases where a payload is invalid JSON.

toPool

public static Pool toPool(Task task,
 Connection connection)
                   throws IOException

Attempt to convert the Task's result to a Pool object. Will return null if the method cannot fetch a valid value from the Task object.

Parameters:

task - The task from which to fetch the result.

connection - The connection

Returns:

the instantiated object if a valid value was found, null otherwise.

Throws:

Types.BadServerResponse - if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during send or receive. This includes cases where a payload is invalid JSON.

toPoolPatch

public static PoolPatch toPoolPatch(Task task,
 Connection connection)
                             throws IOException

Attempt to convert the Task's result to a PoolPatch object. Will return null if the method cannot fetch a valid value from the Task object.

Parameters:

task - The task from which to fetch the result.

connection - The connection

Returns:

the instantiated object if a valid value was found, null otherwise.

Throws:

Types.BadServerResponse - if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during send or receive. This includes cases where a payload is invalid JSON.

toPoolUpdate

public static PoolUpdate toPoolUpdate(Task task,
 Connection connection)
                               throws IOException

Attempt to convert the Task's result to a PoolUpdate object. Will return null if the method cannot fetch a valid value from the Task object.

Parameters:

task - The task from which to fetch the result.

connection - The connection

Returns:

the instantiated object if a valid value was found, null otherwise.

Throws:

Types.BadServerResponse - if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during send or receive. This includes cases where a payload is invalid JSON.

toRole

public static Role toRole(Task task,
 Connection connection)
                   throws IOException

Attempt to convert the Task's result to a Role object. Will return null if the method cannot fetch a valid value from the Task object.

Parameters:

task - The task from which to fetch the result.

connection - The connection

Returns:

the instantiated object if a valid value was found, null otherwise.

Throws:

Types.BadServerResponse - if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during send or receive. This includes cases where a payload is invalid JSON.

toSecret

public static Secret toSecret(Task task,
 Connection connection)
                       throws IOException

Attempt to convert the Task's result to a Secret object. Will return null if the method cannot fetch a valid value from the Task object.

Parameters:

task - The task from which to fetch the result.

connection - The connection

Returns:

the instantiated object if a valid value was found, null otherwise.

Throws:

Types.BadServerResponse - if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during send or receive. This includes cases where a payload is invalid JSON.

toSession

public static Session toSession(Task task,
 Connection connection)
                         throws IOException

Attempt to convert the Task's result to a Session object. Will return null if the method cannot fetch a valid value from the Task object.

Parameters:

task - The task from which to fetch the result.

connection - The connection

Returns:

the instantiated object if a valid value was found, null otherwise.

Throws:

Types.BadServerResponse - if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during send or receive. This includes cases where a payload is invalid JSON.

toSubject

public static Subject toSubject(Task task,
 Connection connection)
                         throws IOException

Attempt to convert the Task's result to a Subject object. Will return null if the method cannot fetch a valid value from the Task object.

Parameters:

task - The task from which to fetch the result.

connection - The connection

Returns:

the instantiated object if a valid value was found, null otherwise.

Throws:

Types.BadServerResponse - if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during send or receive. This includes cases where a payload is invalid JSON.

toTask

public static Task toTask(Task task,
 Connection connection)
                   throws IOException

Attempt to convert the Task's result to a Task object. Will return null if the method cannot fetch a valid value from the Task object.

Parameters:

task - The task from which to fetch the result.

connection - The connection

Returns:

the instantiated object if a valid value was found, null otherwise.

Throws:

Types.BadServerResponse - if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during send or receive. This includes cases where a payload is invalid JSON.

toTunnel

public static Tunnel toTunnel(Task task,
 Connection connection)
                       throws IOException

Attempt to convert the Task's result to a Tunnel object. Will return null if the method cannot fetch a valid value from the Task object.

Parameters:

task - The task from which to fetch the result.

connection - The connection

Returns:

the instantiated object if a valid value was found, null otherwise.

Throws:

Types.BadServerResponse - if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during send or receive. This includes cases where a payload is invalid JSON.

toUser

public static User toUser(Task task,
 Connection connection)
                   throws IOException

Attempt to convert the Task's result to a User object. Will return null if the method cannot fetch a valid value from the Task object.

Parameters:

task - The task from which to fetch the result.

connection - The connection

Returns:

the instantiated object if a valid value was found, null otherwise.

Throws:

Types.BadServerResponse - if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during send or receive. This includes cases where a payload is invalid JSON.