API Reference - Error Handling¶

When a low-level transport error occurs, or a request is malformed at the HTTP or RPC level, the server may send an HTTP 500 error response, or the client may simulate the same. The client must be prepared to handle these errors, though they may be treated as fatal.

On the wire, these are transmitted in a form similar to this when using the XML-RPC protocol:

$curl -D - -X POST https://server -H 'Content-Type: application/xml' \
> -d '<?xml version="1.0"?>
> <methodCall>
>   <methodName>session.logout</methodName>
> </methodCall>'
HTTP/1.1 500 Internal Error
content-length: 297
content-type:text/html
connection:close
cache-control:no-cache, no-store

<html><body><h1>HTTP 500 internal server error</h1>An unexpected error occurred;
 please wait a while and try again. If the problem persists, please contact your
 support representative.<h1> Additional information </h1>Xmlrpc.Parse_error(&quo
t;close_tag&quot;, &quot;open_tag&quot;, _)</body></html>

When using the JSON-RPC protocol:

$curl -D - -X POST https://server/jsonrpc -H 'Content-Type: application/json' \
> -d '{
>     "jsonrpc": "2.0",
>     "method": "session.login_with_password",
>     "id": 0
> }'
HTTP/1.1 500 Internal Error
content-length: 308
content-type:text/html
connection:close
cache-control:no-cache, no-store

<html><body><h1>HTTP 500 internal server error</h1>An unexpected error occurred;
 please wait a while and try again. If the problem persists, please contact your
 support representative.<h1> Additional information </h1>Jsonrpc.Malformed_metho
d_request(&quot;{jsonrpc=...,method=...,id=...}&quot;)</body></html>

All other failures are reported with a more structured error response, to allow better automatic response to failures, proper internationalisation of any error message, and easier debugging.

On the wire, these are transmitted like this when using the XML-RPC protocol:

    <struct>
      <member>
        <name>Status</name>
        <value>Failure</value>
      </member>
      <member>
        <name>ErrorDescription</name>
        <value>
          <array>
            <data>
              <value>MAP_DUPLICATE_KEY</value>
              <value>Customer</value>
              <value>eSpiel Inc.</value>
              <value>eSpiel Incorporated</value>
            </data>
          </array>
        </value>
      </member>
    </struct>

Note that ErrorDescription value is an array of string values. The first element of the array is an error code; the remainder of the array are strings representing error parameters relating to that code. In this case, the client has attempted to add the mapping Customer -> eSpiel Incorporated to a Map, but it already contains the mapping Customer -> eSpiel Inc., and so the request has failed.

When using the JSON-RPC protocol v2.0, the above error is transmitted as:

{
    "jsonrpc": "2.0",
    "error": {
        "code": 1,
        "message": "MAP_DUPLICATE_KEY",
        "data": [
            "Customer","eSpiel Inc.","eSpiel Incorporated"
        ]
    },
    "id": 3
  }

Finally, when using the JSON-RPC protocol v1.0:

{
  "result": null,
  "error": [
      "MAP_DUPLICATE_KEY","Customer","eSpiel Inc.","eSpiel Incorporated"
  ],
  "id": "xyz"
}

Each possible error code is documented in the following section.

Error Codes¶

ACTIVATION_WHILE_NOT_FREE¶

An activation key can only be applied when the edition is set to 'free'.

No parameters.

ADDRESS_VIOLATES_LOCKING_CONSTRAINT¶

The specified IP address violates the VIF locking configuration.

Signature:

ADDRESS_VIOLATES_LOCKING_CONSTRAINT(address)

AUTH_ALREADY_ENABLED¶

External authentication for this server is already enabled.

Signature:

AUTH_ALREADY_ENABLED(current auth_type, current service_name)

AUTH_DISABLE_FAILED¶

The host failed to disable external authentication.

Signature:

AUTH_DISABLE_FAILED(message)

AUTH_DISABLE_FAILED_PERMISSION_DENIED¶

The host failed to disable external authentication.

Signature:

AUTH_DISABLE_FAILED_PERMISSION_DENIED(message)

AUTH_DISABLE_FAILED_WRONG_CREDENTIALS¶

The host failed to disable external authentication.

Signature:

AUTH_DISABLE_FAILED_WRONG_CREDENTIALS(message)

AUTH_ENABLE_FAILED¶

The host failed to enable external authentication.

Signature:

AUTH_ENABLE_FAILED(message)

AUTH_ENABLE_FAILED_DOMAIN_LOOKUP_FAILED¶

The host failed to enable external authentication.

Signature:

AUTH_ENABLE_FAILED_DOMAIN_LOOKUP_FAILED(message)

AUTH_ENABLE_FAILED_INVALID_ACCOUNT¶

The host failed to enable external authentication.

Signature:

AUTH_ENABLE_FAILED_INVALID_ACCOUNT(message)

AUTH_ENABLE_FAILED_INVALID_OU¶

The host failed to enable external authentication.

Signature:

AUTH_ENABLE_FAILED_INVALID_OU(message)

AUTH_ENABLE_FAILED_PERMISSION_DENIED¶

The host failed to enable external authentication.

Signature:

AUTH_ENABLE_FAILED_PERMISSION_DENIED(message)

AUTH_ENABLE_FAILED_UNAVAILABLE¶

The host failed to enable external authentication.

Signature:

AUTH_ENABLE_FAILED_UNAVAILABLE(message)

AUTH_ENABLE_FAILED_WRONG_CREDENTIALS¶

The host failed to enable external authentication.

Signature:

AUTH_ENABLE_FAILED_WRONG_CREDENTIALS(message)

AUTH_IS_DISABLED¶

External authentication is disabled, unable to resolve subject name.

No parameters.

AUTH_SERVICE_ERROR¶

Error querying the external directory service.

Signature:

AUTH_SERVICE_ERROR(message)

AUTH_UNKNOWN_TYPE¶

Unknown type of external authentication.

Signature:

AUTH_UNKNOWN_TYPE(type)

BACKUP_SCRIPT_FAILED¶

The backup could not be performed because the backup script failed.

Signature:

BACKUP_SCRIPT_FAILED(log)

BALLOONING_TIMEOUT_BEFORE_MIGRATION¶

Timeout trying to balloon down memory before VM migration. If the error occurs repeatedly, consider increasing the memory-dynamic-min value.

Signature:

BALLOONING_TIMEOUT_BEFORE_MIGRATION(vm)

BOOTLOADER_FAILED¶

The bootloader returned an error

Signature:

BOOTLOADER_FAILED(vm, msg)

BRIDGE_NAME_EXISTS¶

The specified bridge already exists.

Signature:

BRIDGE_NAME_EXISTS(bridge)

BRIDGE_NOT_AVAILABLE¶

Could not find bridge required by VM.

Signature:

BRIDGE_NOT_AVAILABLE(bridge)

CANNOT_ADD_TUNNEL_TO_BOND_SLAVE¶

This PIF is a bond member and cannot have a tunnel on it.

Signature:

CANNOT_ADD_TUNNEL_TO_BOND_SLAVE(PIF)

CANNOT_ADD_TUNNEL_TO_SRIOV_LOGICAL¶

This is a network SR-IOV logical PIF and cannot have a tunnel on it.

Signature:

CANNOT_ADD_TUNNEL_TO_SRIOV_LOGICAL(PIF)

CANNOT_ADD_TUNNEL_TO_VLAN_ON_SRIOV_LOGICAL¶

This is a vlan PIF on network SR-IOV and cannot have a tunnel on it.

Signature:

CANNOT_ADD_TUNNEL_TO_VLAN_ON_SRIOV_LOGICAL(PIF)

CANNOT_ADD_VLAN_TO_BOND_SLAVE¶

This PIF is a bond member and cannot have a VLAN on it.

Signature:

CANNOT_ADD_VLAN_TO_BOND_SLAVE(PIF)

CANNOT_CHANGE_PIF_PROPERTIES¶

This properties of this PIF cannot be changed. Only the properties of non-bonded physical PIFs, or bond masters can be changed.

Signature:

CANNOT_CHANGE_PIF_PROPERTIES(PIF)

CANNOT_CONTACT_HOST¶

Cannot forward messages because the server cannot be contacted. The server may be switched off or there may be network connectivity problems.

Signature:

CANNOT_CONTACT_HOST(host)

CANNOT_CREATE_STATE_FILE¶

An HA statefile could not be created, perhaps because no SR with the appropriate capability was found.

No parameters.

CANNOT_DESTROY_DISASTER_RECOVERY_TASK¶

The disaster recovery task could not be cleanly destroyed.

Signature:

CANNOT_DESTROY_DISASTER_RECOVERY_TASK(reason)

CANNOT_DESTROY_SYSTEM_NETWORK¶

You tried to destroy a system network: these cannot be destroyed.

Signature:

CANNOT_DESTROY_SYSTEM_NETWORK(network)

CANNOT_ENABLE_REDO_LOG¶

Could not enable redo log.

Signature:

CANNOT_ENABLE_REDO_LOG(reason)

CANNOT_EVACUATE_HOST¶

This server cannot be evacuated.

Signature:

CANNOT_EVACUATE_HOST(errors)

CANNOT_FETCH_PATCH¶

The requested update could not be obtained from the master.

Signature:

CANNOT_FETCH_PATCH(uuid)

CANNOT_FIND_OEM_BACKUP_PARTITION¶

The backup partition to stream the update to cannot be found.

No parameters.

CANNOT_FIND_PATCH¶

The requested update could not be found. This can occur when you designate a new master or xe patch-clean. Please upload the update again.

No parameters.

CANNOT_FIND_STATE_PARTITION¶

This operation could not be performed because the state partition could not be found

No parameters.

CANNOT_FIND_UPDATE¶

The requested update could not be found. Please upload the update again. This can occur when you run xe update-pool-clean before xe update-apply.

No parameters.

CANNOT_FORGET_SRIOV_LOGICAL¶

This is a network SR-IOV logical PIF and cannot do forget on it

Signature:

CANNOT_FORGET_SRIOV_LOGICAL(PIF)

CANNOT_PLUG_BOND_SLAVE¶

This PIF is a bond member and cannot be plugged.

Signature:

CANNOT_PLUG_BOND_SLAVE(PIF)

CANNOT_PLUG_VIF¶

Cannot plug VIF

Signature:

CANNOT_PLUG_VIF(VIF)

CANNOT_RESET_CONTROL_DOMAIN¶

The power-state of a control domain cannot be reset.

Signature:

CANNOT_RESET_CONTROL_DOMAIN(vm)

CERTIFICATE_ALREADY_EXISTS¶

A certificate already exists with the specified name.

Signature:

CERTIFICATE_ALREADY_EXISTS(name)

CERTIFICATE_CORRUPT¶

The specified certificate is corrupt or unreadable.

Signature:

CERTIFICATE_CORRUPT(name)

CERTIFICATE_DOES_NOT_EXIST¶

The specified certificate does not exist.

Signature:

CERTIFICATE_DOES_NOT_EXIST(name)

CERTIFICATE_LIBRARY_CORRUPT¶

The certificate library is corrupt or unreadable.

No parameters.

CERTIFICATE_NAME_INVALID¶

The specified certificate name is invalid.

Signature:

CERTIFICATE_NAME_INVALID(name)

CHANGE_PASSWORD_REJECTED¶

The system rejected the password change request; perhaps the new password was too short?

Signature:

CHANGE_PASSWORD_REJECTED(msg)

CLUSTERED_SR_DEGRADED¶

An SR is using clustered local storage. It is not safe to reboot a host at the moment.

Signature:

CLUSTERED_SR_DEGRADED(sr)

CLUSTERING_DISABLED¶

An operation was attempted while clustering was disabled on the cluster_host.

Signature:

CLUSTERING_DISABLED(cluster_host)

CLUSTERING_ENABLED¶

An operation was attempted while clustering was enabled on the cluster_host.

Signature:

CLUSTERING_ENABLED(cluster_host)

CLUSTER_ALREADY_EXISTS¶

A cluster already exists in the pool.

No parameters.

CLUSTER_CREATE_IN_PROGRESS¶

The operation could not be performed because cluster creation is in progress.

No parameters.

CLUSTER_DOES_NOT_HAVE_ONE_NODE¶

An operation failed as it expected the cluster to have only one node but found multiple cluster_hosts.

Signature:

CLUSTER_DOES_NOT_HAVE_ONE_NODE(number_of_nodes)

CLUSTER_FORCE_DESTROY_FAILED¶

Force destroy failed on a Cluster_host while force destroying the cluster.

Signature:

CLUSTER_FORCE_DESTROY_FAILED(cluster)

CLUSTER_HOST_IS_LAST¶

The last cluster host cannot be destroyed. Destroy the cluster instead

Signature:

CLUSTER_HOST_IS_LAST(cluster_host)

CLUSTER_HOST_NOT_JOINED¶

Cluster_host operation failed as the cluster_host has not joined the cluster.

Signature:

CLUSTER_HOST_NOT_JOINED(cluster_host)

CLUSTER_STACK_IN_USE¶

The cluster stack is still in use by at least one plugged PBD.

Signature:

CLUSTER_STACK_IN_USE(cluster_stack)

COULD_NOT_FIND_NETWORK_INTERFACE_WITH_SPECIFIED_DEVICE_NAME_AND_MAC_ADDRESS¶

Could not find a network interface with the specified device name and MAC address.

Signature:

COULD_NOT_FIND_NETWORK_INTERFACE_WITH_SPECIFIED_DEVICE_NAME_AND_MAC_ADDRESS(device, mac)

COULD_NOT_IMPORT_DATABASE¶

An error occurred while attempting to import a database from a metadata VDI

Signature:

COULD_NOT_IMPORT_DATABASE(reason)

COULD_NOT_UPDATE_IGMP_SNOOPING_EVERYWHERE¶

The IGMP Snooping setting cannot be applied for some of the host, network(s).

No parameters.

CPU_FEATURE_MASKING_NOT_SUPPORTED¶

The CPU does not support masking of features.

Signature:

CPU_FEATURE_MASKING_NOT_SUPPORTED(details)

CRL_ALREADY_EXISTS¶

A CRL already exists with the specified name.

Signature:

CRL_ALREADY_EXISTS(name)

CRL_CORRUPT¶

The specified CRL is corrupt or unreadable.

Signature:

CRL_CORRUPT(name)

CRL_DOES_NOT_EXIST¶

The specified CRL does not exist.

Signature:

CRL_DOES_NOT_EXIST(name)

CRL_NAME_INVALID¶

The specified CRL name is invalid.

Signature:

CRL_NAME_INVALID(name)

DB_UNIQUENESS_CONSTRAINT_VIOLATION¶

You attempted an operation which would have resulted in duplicate keys in the database.

Signature:

DB_UNIQUENESS_CONSTRAINT_VIOLATION(table, field, value)

DEFAULT_SR_NOT_FOUND¶

The default SR reference does not point to a valid SR

Signature:

DEFAULT_SR_NOT_FOUND(sr)

DEVICE_ALREADY_ATTACHED¶

The device is already attached to a VM

Signature:

DEVICE_ALREADY_ATTACHED(device)

DEVICE_ALREADY_DETACHED¶

The device is not currently attached

Signature:

DEVICE_ALREADY_DETACHED(device)

DEVICE_ALREADY_EXISTS¶

A device with the name given already exists on the selected VM

Signature:

DEVICE_ALREADY_EXISTS(device)

DEVICE_ATTACH_TIMEOUT¶

A timeout happened while attempting to attach a device to a VM.

Signature:

DEVICE_ATTACH_TIMEOUT(type, ref)

DEVICE_DETACH_REJECTED¶

The VM rejected the attempt to detach the device.

Signature:

DEVICE_DETACH_REJECTED(type, ref, msg)

DEVICE_DETACH_TIMEOUT¶

A timeout happened while attempting to detach a device from a VM.

Signature:

DEVICE_DETACH_TIMEOUT(type, ref)

DEVICE_NOT_ATTACHED¶

The operation could not be performed because the VBD was not connected to the VM.

Signature:

DEVICE_NOT_ATTACHED(VBD)

DISK_VBD_MUST_BE_READWRITE_FOR_HVM¶

All VBDs of type 'disk' must be read/write for HVM guests

Signature:

DISK_VBD_MUST_BE_READWRITE_FOR_HVM(vbd)

DOMAIN_BUILDER_ERROR¶

An internal error generated by the domain builder.

Signature:

DOMAIN_BUILDER_ERROR(function, code, message)

DOMAIN_EXISTS¶

The operation could not be performed because a domain still exists for the specified VM.

Signature:

DOMAIN_EXISTS(vm, domid)

DUPLICATE_MAC_SEED¶

This MAC seed is already in use by a VM in the pool

Signature:

DUPLICATE_MAC_SEED(seed)

DUPLICATE_PIF_DEVICE_NAME¶

A PIF with this specified device name already exists.

Signature:

DUPLICATE_PIF_DEVICE_NAME(device)

DUPLICATE_VM¶

Cannot restore this VM because it would create a duplicate

Signature:

DUPLICATE_VM(vm)

EVENTS_LOST¶

Some events have been lost from the queue and cannot be retrieved.

No parameters.

EVENT_FROM_TOKEN_PARSE_FAILURE¶

The event.from token could not be parsed. Valid values include: '', and a value returned from a previous event.from call.

Signature:

EVENT_FROM_TOKEN_PARSE_FAILURE(token)

EVENT_SUBSCRIPTION_PARSE_FAILURE¶

The server failed to parse your event subscription. Valid values include: *, class-name, class-name/object-reference.

Signature:

EVENT_SUBSCRIPTION_PARSE_FAILURE(subscription)

FAILED_TO_START_EMULATOR¶

An emulator required to run this VM failed to start

Signature:

FAILED_TO_START_EMULATOR(vm, name, msg)

FEATURE_REQUIRES_HVM¶

The VM is set up to use a feature that requires it to boot as HVM.

Signature:

FEATURE_REQUIRES_HVM(details)

FEATURE_RESTRICTED¶

The use of this feature is restricted.

No parameters.

FIELD_TYPE_ERROR¶

The value specified is of the wrong type

Signature:

FIELD_TYPE_ERROR(field)

GPU_GROUP_CONTAINS_NO_PGPUS¶

The GPU group does not contain any PGPUs.

Signature:

GPU_GROUP_CONTAINS_NO_PGPUS(gpu_group)

GPU_GROUP_CONTAINS_PGPU¶

The GPU group contains active PGPUs and cannot be deleted.

Signature:

GPU_GROUP_CONTAINS_PGPU(pgpus)

GPU_GROUP_CONTAINS_VGPU¶

The GPU group contains active VGPUs and cannot be deleted.

Signature:

GPU_GROUP_CONTAINS_VGPU(vgpus)

HANDLE_INVALID¶

You gave an invalid object reference. The object may have recently been deleted. The class parameter gives the type of reference given, and the handle parameter echoes the bad value given.

Signature:

HANDLE_INVALID(class, handle)

HA_ABORT_NEW_MASTER¶

This server cannot accept the proposed new master setting at this time.

Signature:

HA_ABORT_NEW_MASTER(reason)

HA_CANNOT_CHANGE_BOND_STATUS_OF_MGMT_IFACE¶

This operation cannot be performed because creating or deleting a bond involving the management interface is not allowed while HA is on. In order to do that, disable HA, create or delete the bond then re-enable HA.

No parameters.

HA_CONSTRAINT_VIOLATION_NETWORK_NOT_SHARED¶

This operation cannot be performed because the referenced network is not properly shared. The network must either be entirely virtual or must be physically present via a currently_attached PIF on every host.

Signature:

HA_CONSTRAINT_VIOLATION_NETWORK_NOT_SHARED(network)

HA_CONSTRAINT_VIOLATION_SR_NOT_SHARED¶

This operation cannot be performed because the referenced SR is not properly shared. The SR must both be marked as shared and a currently_attached PBD must exist for each host.

Signature:

HA_CONSTRAINT_VIOLATION_SR_NOT_SHARED(SR)

HA_DISABLE_IN_PROGRESS¶

The operation could not be performed because HA disable is in progress

No parameters.

HA_ENABLE_IN_PROGRESS¶

The operation could not be performed because HA enable is in progress

No parameters.

HA_FAILED_TO_FORM_LIVESET¶

HA could not be enabled on the Pool because a liveset could not be formed: check storage and network heartbeat paths.

No parameters.

HA_HEARTBEAT_DAEMON_STARTUP_FAILED¶

The server could not join the liveset because the HA daemon failed to start.

No parameters.

HA_HOST_CANNOT_ACCESS_STATEFILE¶

The server could not join the liveset because the HA daemon could not access the heartbeat disk.

No parameters.

HA_HOST_CANNOT_SEE_PEERS¶

The operation failed because the HA software on the specified server could not see a subset of other servers. Check your network connectivity.

Signature:

HA_HOST_CANNOT_SEE_PEERS(host, all, subset)

HA_HOST_IS_ARMED¶

The operation could not be performed while the server is still armed; it must be disarmed first.

Signature:

HA_HOST_IS_ARMED(host)

HA_IS_ENABLED¶

The operation could not be performed because HA is enabled on the Pool

No parameters.

HA_LOST_STATEFILE¶

This server lost access to the HA statefile.

No parameters.

HA_NOT_ENABLED¶

The operation could not be performed because HA is not enabled on the Pool

No parameters.

HA_NOT_INSTALLED¶

The operation could not be performed because the HA software is not installed on this server.

Signature:

HA_NOT_INSTALLED(host)

HA_NO_PLAN¶

Cannot find a plan for placement of VMs as there are no other servers available.

No parameters.

HA_OPERATION_WOULD_BREAK_FAILOVER_PLAN¶

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.

No parameters.

HA_POOL_IS_ENABLED_BUT_HOST_IS_DISABLED¶

This server cannot join the pool because the pool has HA enabled but this server has HA disabled.

No parameters.

HA_SHOULD_BE_FENCED¶

Server cannot rejoin pool because it should have fenced (it is not in the master's partition).

Signature:

HA_SHOULD_BE_FENCED(host)

HA_TOO_FEW_HOSTS¶

HA can only be enabled for 2 servers or more. Note that 2 servers requires a pre-configured quorum tiebreak script.

No parameters.

HOSTS_NOT_COMPATIBLE¶

The hosts in this pool are not compatible.

No parameters.

HOSTS_NOT_HOMOGENEOUS¶

The hosts in this pool are not homogeneous.

Signature:

HOSTS_NOT_HOMOGENEOUS(reason)

HOST_BROKEN¶

This server failed in the middle of an automatic failover operation and needs to retry the failover action.

No parameters.

HOST_CANNOT_ATTACH_NETWORK¶

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).

Signature:

HOST_CANNOT_ATTACH_NETWORK(host, network)

HOST_CANNOT_DESTROY_SELF¶

The pool master host cannot be removed.

Signature:

HOST_CANNOT_DESTROY_SELF(host)

HOST_CANNOT_READ_METRICS¶

The metrics of this server could not be read.

No parameters.

HOST_CD_DRIVE_EMPTY¶

The host CDROM drive does not contain a valid CD

No parameters.

HOST_DISABLED¶

The specified server is disabled.

Signature:

HOST_DISABLED(host)

HOST_DISABLED_UNTIL_REBOOT¶

The specified server is disabled and cannot be re-enabled until after it has rebooted.

Signature:

HOST_DISABLED_UNTIL_REBOOT(host)

HOST_EVACUATE_IN_PROGRESS¶

This host is being evacuated.

Signature:

HOST_EVACUATE_IN_PROGRESS(host)

HOST_HAS_NO_MANAGEMENT_IP¶

The server failed to acquire an IP address on its management interface and therefore cannot contact the master.

No parameters.

HOST_HAS_RESIDENT_VMS¶

This server cannot be forgotten because there are user VMs still running.

Signature:

HOST_HAS_RESIDENT_VMS(host)

HOST_IN_EMERGENCY_MODE¶

Cannot perform operation as the host is running in emergency mode.

No parameters.

HOST_IN_USE¶

This operation cannot be completed as the host is in use by (at least) the object of type and ref echoed below.

Signature:

HOST_IN_USE(host, type, ref)

HOST_IS_LIVE¶

This operation cannot be completed because the server is still live.

Signature:

HOST_IS_LIVE(host)

HOST_IS_SLAVE¶

You cannot make regular API calls directly on a pool member. Please pass API calls via the master host.

Signature:

HOST_IS_SLAVE(Master IP address)

HOST_ITS_OWN_SLAVE¶

The host is its own pool member. Please use pool-emergency-transition-to-master or pool-emergency-reset-master.

No parameters.

HOST_MASTER_CANNOT_TALK_BACK¶

The master reports that it cannot talk back to the pool member on the supplied management IP address.

Signature:

HOST_MASTER_CANNOT_TALK_BACK(ip)

HOST_NAME_INVALID¶

The server name is invalid.

Signature:

HOST_NAME_INVALID(reason)

HOST_NOT_DISABLED¶

This operation cannot be performed because the host is not disabled. Please disable the host and then try again.

No parameters.

HOST_NOT_ENOUGH_FREE_MEMORY¶

Not enough server memory is available to perform this operation.

Signature:

HOST_NOT_ENOUGH_FREE_MEMORY(needed, available)

HOST_NOT_ENOUGH_PCPUS¶

The host does not have enough pCPUs to run the VM. It needs at least as many as the VM has vCPUs.

Signature:

HOST_NOT_ENOUGH_PCPUS(vcpus, pcpus)

HOST_NOT_LIVE¶

This operation cannot be completed as the server is not live.

No parameters.

HOST_OFFLINE¶

You attempted an operation which involves a host which could not be contacted.

Signature:

HOST_OFFLINE(host)

HOST_POWER_ON_MODE_DISABLED¶

This operation cannot be completed because the server power on mode is disabled.

No parameters.

HOST_STILL_BOOTING¶

The host toolstack is still initialising. Please wait.

No parameters.

HOST_UNKNOWN_TO_MASTER¶

The master says the server is not known to it. Is the server in the master's database and pointing to the correct master? Are all servers using the same pool secret?

Signature:

HOST_UNKNOWN_TO_MASTER(host)

ILLEGAL_VBD_DEVICE¶

The specified VBD device is not recognized: please use a non-negative integer

Signature:

ILLEGAL_VBD_DEVICE(vbd, device)

IMPORT_ERROR¶

The VM could not be imported.

Signature:

IMPORT_ERROR(msg)

IMPORT_ERROR_ATTACHED_DISKS_NOT_FOUND¶

The VM could not be imported because attached disks could not be found.

No parameters.

IMPORT_ERROR_CANNOT_HANDLE_CHUNKED¶

Cannot import VM using chunked encoding.

No parameters.

IMPORT_ERROR_FAILED_TO_FIND_OBJECT¶

The VM could not be imported because a required object could not be found.

Signature:

IMPORT_ERROR_FAILED_TO_FIND_OBJECT(id)

IMPORT_ERROR_PREMATURE_EOF¶

The VM could not be imported; the end of the file was reached prematurely.

No parameters.

IMPORT_ERROR_SOME_CHECKSUMS_FAILED¶

Some data checksums were incorrect; the VM may be corrupt.

No parameters.

IMPORT_ERROR_UNEXPECTED_FILE¶

The VM could not be imported because the XVA file is invalid: an unexpected file was encountered.

Signature:

IMPORT_ERROR_UNEXPECTED_FILE(filename_expected, filename_found)

IMPORT_INCOMPATIBLE_VERSION¶

The import failed because this export has been created by a different (incompatible) product version

No parameters.

INCOMPATIBLE_CLUSTER_STACK_ACTIVE¶

This operation cannot be performed, because it is incompatible with the currently active HA cluster stack.

Signature:

INCOMPATIBLE_CLUSTER_STACK_ACTIVE(cluster_stack)

INCOMPATIBLE_PIF_PROPERTIES¶

These PIFs cannot be bonded, because their properties are different.

No parameters.

INCOMPATIBLE_STATEFILE_SR¶

The specified SR is incompatible with the selected HA cluster stack.

Signature:

INCOMPATIBLE_STATEFILE_SR(SR type)

INTERFACE_HAS_NO_IP¶

The specified interface cannot be used because it has no IP address

Signature:

INTERFACE_HAS_NO_IP(interface)

INTERNAL_ERROR¶

The server failed to handle your request, due to an internal error. The given message may give details useful for debugging the problem.

Signature:

INTERNAL_ERROR(message)

INVALID_CIDR_ADDRESS_SPECIFIED¶

A required parameter contained an invalid CIDR address (<addr>/<prefix length>)

Signature:

INVALID_CIDR_ADDRESS_SPECIFIED(parameter)

INVALID_CLUSTER_STACK¶

The cluster stack provided is not supported.

Signature:

INVALID_CLUSTER_STACK(cluster_stack)

INVALID_DEVICE¶

The device name is invalid

Signature:

INVALID_DEVICE(device)

INVALID_EDITION¶

The edition you supplied is invalid.

Signature:

INVALID_EDITION(edition)

INVALID_FEATURE_STRING¶

The given feature string is not valid.

Signature:

INVALID_FEATURE_STRING(details)

INVALID_IP_ADDRESS_SPECIFIED¶

A required parameter contained an invalid IP address

Signature:

INVALID_IP_ADDRESS_SPECIFIED(parameter)

INVALID_PATCH¶

The uploaded patch file is invalid

No parameters.

INVALID_PATCH_WITH_LOG¶

The uploaded patch file is invalid. See attached log for more details.

Signature:

INVALID_PATCH_WITH_LOG(log)

INVALID_UPDATE¶

The uploaded update package is invalid.

Signature:

INVALID_UPDATE(info)

INVALID_VALUE¶

The value given is invalid

Signature:

INVALID_VALUE(field, value)

IS_TUNNEL_ACCESS_PIF¶

Cannot create a VLAN or tunnel on top of a tunnel access PIF - use the underlying transport PIF instead.

Signature:

IS_TUNNEL_ACCESS_PIF(PIF)

JOINING_HOST_CANNOT_BE_MASTER_OF_OTHER_HOSTS¶

The server joining the pool cannot already be a master of another pool.

No parameters.

JOINING_HOST_CANNOT_CONTAIN_SHARED_SRS¶

The server joining the pool cannot contain any shared storage.

No parameters.

JOINING_HOST_CANNOT_HAVE_RUNNING_OR_SUSPENDED_VMS¶

The server joining the pool cannot have any running or suspended VMs.

No parameters.

JOINING_HOST_CANNOT_HAVE_RUNNING_VMS¶

The server joining the pool cannot have any running VMs.

No parameters.

JOINING_HOST_CANNOT_HAVE_VMS_WITH_CURRENT_OPERATIONS¶

The host joining the pool cannot have any VMs with active tasks.

No parameters.

JOINING_HOST_CONNECTION_FAILED¶

There was an error connecting to the host while joining it in the pool.

No parameters.

JOINING_HOST_SERVICE_FAILED¶

There was an error connecting to the server. The service contacted didn't reply properly.

No parameters.

LICENCE_RESTRICTION¶

This operation is not allowed because your license lacks a needed feature. Please contact your support representative.

Signature:

LICENCE_RESTRICTION(feature)

LICENSE_CANNOT_DOWNGRADE_WHILE_IN_POOL¶

Cannot downgrade license while in pool. Please disband the pool first, then downgrade licenses on hosts separately.

No parameters.

LICENSE_CHECKOUT_ERROR¶

The license for the edition you requested is not available.

Signature:

LICENSE_CHECKOUT_ERROR(reason)

LICENSE_DOES_NOT_SUPPORT_POOLING¶

This server cannot join a pool because its license does not support pooling.

No parameters.

LICENSE_DOES_NOT_SUPPORT_XHA¶

HA cannot be enabled because this server's license does not allow it.

No parameters.

LICENSE_EXPIRED¶

Your license has expired. Please contact your support representative.

No parameters.

LICENSE_FILE_DEPRECATED¶

This type of license file is for previous versions of the server. Please upgrade to the new licensing system.

No parameters.

LICENSE_HOST_POOL_MISMATCH¶

Host and pool have incompatible licenses (editions).

No parameters.

LICENSE_PROCESSING_ERROR¶

There was an error processing your license. Please contact your support representative.

No parameters.

LOCATION_NOT_UNIQUE¶

A VDI with the specified location already exists within the SR

Signature:

LOCATION_NOT_UNIQUE(SR, location)

MAC_DOES_NOT_EXIST¶

The MAC address specified does not exist on this server.

Signature:

MAC_DOES_NOT_EXIST(MAC)

MAC_INVALID¶

The MAC address specified is not valid.

Signature:

MAC_INVALID(MAC)

MAC_STILL_EXISTS¶

The MAC address specified still exists on this server.

Signature:

MAC_STILL_EXISTS(MAC)

MAP_DUPLICATE_KEY¶

You tried to add a key-value pair to a map, but that key is already there.

Signature:

MAP_DUPLICATE_KEY(type, param_name, uuid, key)

MEMORY_CONSTRAINT_VIOLATION¶

The dynamic memory range does not satisfy the following constraint.

Signature:

MEMORY_CONSTRAINT_VIOLATION(constraint)

MEMORY_CONSTRAINT_VIOLATION_MAXPIN¶

The dynamic memory range violates constraint static_min = dynamic_min = dynamic_max = static_max.

Signature:

MEMORY_CONSTRAINT_VIOLATION_MAXPIN(reason)

MEMORY_CONSTRAINT_VIOLATION_ORDER¶

The dynamic memory range violates constraint static_min <= dynamic_min <= dynamic_max <= static_max.

No parameters.

MESSAGE_DEPRECATED¶

This message has been deprecated.

No parameters.

MESSAGE_METHOD_UNKNOWN¶

You tried to call a method that does not exist. The method name that you used is echoed.

Signature:

MESSAGE_METHOD_UNKNOWN(method)

MESSAGE_PARAMETER_COUNT_MISMATCH¶

You tried to call a method with the incorrect number of parameters. The fully-qualified method name that you used, and the number of received and expected parameters are returned.

Signature:

MESSAGE_PARAMETER_COUNT_MISMATCH(method, expected, received)

MESSAGE_REMOVED¶

This function is no longer available.

No parameters.

MIRROR_FAILED¶

The VDI mirroring cannot be performed

Signature:

MIRROR_FAILED(vdi)

MISSING_CONNECTION_DETAILS¶

The license-server connection details (address or port) were missing or incomplete.

No parameters.

NETWORK_ALREADY_CONNECTED¶

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.

Signature:

NETWORK_ALREADY_CONNECTED(network, connected PIF)

NETWORK_CONTAINS_PIF¶

The network contains active PIFs and cannot be deleted.

Signature:

NETWORK_CONTAINS_PIF(pifs)

NETWORK_CONTAINS_VIF¶

The network contains active VIFs and cannot be deleted.

Signature:

NETWORK_CONTAINS_VIF(vifs)

NETWORK_HAS_INCOMPATIBLE_SRIOV_PIFS¶

The PIF is not compatible with the selected SR-IOV network

Signature:

NETWORK_HAS_INCOMPATIBLE_SRIOV_PIFS(PIF, network)

NETWORK_HAS_INCOMPATIBLE_VLAN_ON_SRIOV_PIFS¶

VLAN on the PIF is not compatible with the selected SR-IOV VLAN network

Signature:

NETWORK_HAS_INCOMPATIBLE_VLAN_ON_SRIOV_PIFS(PIF, network)

NETWORK_INCOMPATIBLE_PURPOSES¶

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.

Signature:

NETWORK_INCOMPATIBLE_PURPOSES(new_purpose, conflicting_purpose)

NETWORK_INCOMPATIBLE_WITH_BOND¶

The network is incompatible with bond

Signature:

NETWORK_INCOMPATIBLE_WITH_BOND(network)

NETWORK_INCOMPATIBLE_WITH_SRIOV¶

The network is incompatible with sriov

Signature:

NETWORK_INCOMPATIBLE_WITH_SRIOV(network)

NETWORK_INCOMPATIBLE_WITH_TUNNEL¶

The network is incompatible with tunnel

Signature:

NETWORK_INCOMPATIBLE_WITH_TUNNEL(network)

NETWORK_INCOMPATIBLE_WITH_VLAN_ON_BRIDGE¶

The network is incompatible with vlan on bridge

Signature:

NETWORK_INCOMPATIBLE_WITH_VLAN_ON_BRIDGE(network)

NETWORK_INCOMPATIBLE_WITH_VLAN_ON_SRIOV¶

The network is incompatible with vlan on sriov

Signature:

NETWORK_INCOMPATIBLE_WITH_VLAN_ON_SRIOV(network)

NETWORK_SRIOV_ALREADY_ENABLED¶

The PIF selected for the SR-IOV network is already enabled

Signature:

NETWORK_SRIOV_ALREADY_ENABLED(PIF)

NETWORK_SRIOV_DISABLE_FAILED¶

Failed to disable SR-IOV on PIF

Signature:

NETWORK_SRIOV_DISABLE_FAILED(PIF, msg)

NETWORK_SRIOV_ENABLE_FAILED¶

Failed to enable SR-IOV on PIF

Signature:

NETWORK_SRIOV_ENABLE_FAILED(PIF, msg)

NETWORK_SRIOV_INSUFFICIENT_CAPACITY¶

There is insufficient capacity for VF reservation

Signature:

NETWORK_SRIOV_INSUFFICIENT_CAPACITY(network)

NETWORK_UNMANAGED¶

The network is not managed by xapi.

Signature:

NETWORK_UNMANAGED(network)

NOT_ALLOWED_ON_OEM_EDITION¶

This command is not allowed on the OEM edition.

Signature:

NOT_ALLOWED_ON_OEM_EDITION(command)

NOT_IMPLEMENTED¶

The function is not implemented

Signature:

NOT_IMPLEMENTED(function)

NOT_IN_EMERGENCY_MODE¶

This pool is not in emergency mode.

No parameters.

NOT_SUPPORTED_DURING_UPGRADE¶

This operation is not supported during an upgrade.

No parameters.

NOT_SYSTEM_DOMAIN¶

The given VM is not registered as a system domain. This operation can only be performed on a registered system domain.

Signature:

NOT_SYSTEM_DOMAIN(vm)

NO_CLUSTER_HOSTS_REACHABLE¶

No other cluster host was reachable when joining

Signature:

NO_CLUSTER_HOSTS_REACHABLE(cluster)

NO_COMPATIBLE_CLUSTER_HOST¶

Clustering is not enabled on this host or pool.

Signature:

NO_COMPATIBLE_CLUSTER_HOST(host)

NO_HOSTS_AVAILABLE¶

There were no servers available to complete the specified operation.

No parameters.

NO_MORE_REDO_LOGS_ALLOWED¶

The upper limit of active redo log instances was reached.

No parameters.

NVIDIA_SRIOV_MISCONFIGURED¶

The NVidia GPU is not configured for SR-IOV as expected

Signature:

NVIDIA_SRIOV_MISCONFIGURED(host, device_name)

NVIDIA_TOOLS_ERROR¶

Nvidia tools error. Please ensure that the latest Nvidia tools are installed

Signature:

NVIDIA_TOOLS_ERROR(host)

OBJECT_NOLONGER_EXISTS¶

The specified object no longer exists.

No parameters.

ONLY_ALLOWED_ON_OEM_EDITION¶

This command is only allowed on the OEM edition.

Signature:

ONLY_ALLOWED_ON_OEM_EDITION(command)

OPENVSWITCH_NOT_ACTIVE¶

This operation needs the OpenVSwitch networking backend to be enabled on all hosts in the pool.

No parameters.

OPERATION_BLOCKED¶

You attempted an operation that was explicitly blocked (see the blocked_operations field of the given object).

Signature:

OPERATION_BLOCKED(ref, code)

OPERATION_NOT_ALLOWED¶

You attempted an operation that was not allowed.

Signature:

OPERATION_NOT_ALLOWED(reason)

OPERATION_PARTIALLY_FAILED¶

Some VMs belonging to the appliance threw an exception while carrying out the specified operation

Signature:

OPERATION_PARTIALLY_FAILED(operation)

OTHER_OPERATION_IN_PROGRESS¶

Another operation involving the object is currently in progress

Signature:

OTHER_OPERATION_IN_PROGRESS(class, object)

OUT_OF_SPACE¶

There is not enough space to upload the update

Signature:

OUT_OF_SPACE(location)

PATCH_ALREADY_APPLIED¶

This patch has already been applied

Signature:

PATCH_ALREADY_APPLIED(patch)

PATCH_ALREADY_EXISTS¶

The uploaded patch file already exists

Signature:

PATCH_ALREADY_EXISTS(uuid)

PATCH_APPLY_FAILED¶

The patch apply failed. Please see attached output.

Signature:

PATCH_APPLY_FAILED(output)

PATCH_APPLY_FAILED_BACKUP_FILES_EXIST¶

The patch apply failed: there are backup files created while applying patch. Please remove these backup files before applying patch again.

Signature:

PATCH_APPLY_FAILED_BACKUP_FILES_EXIST(output)

PATCH_IS_APPLIED¶

The specified patch is applied and cannot be destroyed.

No parameters.

PATCH_PRECHECK_FAILED_ISO_MOUNTED¶

Tools ISO must be ejected from all running VMs.

Signature:

PATCH_PRECHECK_FAILED_ISO_MOUNTED(patch)

PATCH_PRECHECK_FAILED_OUT_OF_SPACE¶

The patch pre-check stage failed: the server does not have enough space.

Signature:

PATCH_PRECHECK_FAILED_OUT_OF_SPACE(patch, found_space, required_required)

PATCH_PRECHECK_FAILED_PREREQUISITE_MISSING¶

The patch pre-check stage failed: prerequisite patches are missing.

Signature:

PATCH_PRECHECK_FAILED_PREREQUISITE_MISSING(patch, prerequisite_patch_uuid_list)

PATCH_PRECHECK_FAILED_UNKNOWN_ERROR¶

The patch pre-check stage failed with an unknown error. See attached info for more details.

Signature:

PATCH_PRECHECK_FAILED_UNKNOWN_ERROR(patch, info)

PATCH_PRECHECK_FAILED_VM_RUNNING¶

The patch pre-check stage failed: there are one or more VMs still running on the server. All VMs must be suspended before the patch can be applied.

Signature:

PATCH_PRECHECK_FAILED_VM_RUNNING(patch)

PATCH_PRECHECK_FAILED_WRONG_SERVER_BUILD¶

The patch pre-check stage failed: the server is of an incorrect build.

Signature:

PATCH_PRECHECK_FAILED_WRONG_SERVER_BUILD(patch, found_build, required_build)

PATCH_PRECHECK_FAILED_WRONG_SERVER_VERSION¶

The patch pre-check stage failed: the server is of an incorrect version.

Signature:

PATCH_PRECHECK_FAILED_WRONG_SERVER_VERSION(patch, found_version, required_version)

PBD_EXISTS¶

A PBD already exists connecting the SR to the server.

Signature:

PBD_EXISTS(sr, host, pbd)

PERMISSION_DENIED¶

Caller not allowed to perform this operation.

Signature:

PERMISSION_DENIED(message)

PGPU_INSUFFICIENT_CAPACITY_FOR_VGPU¶

There is insufficient capacity on this PGPU to run the VGPU.

Signature:

PGPU_INSUFFICIENT_CAPACITY_FOR_VGPU(pgpu, vgpu_type)

PGPU_IN_USE_BY_VM¶

This PGPU is currently in use by running VMs.

Signature:

PGPU_IN_USE_BY_VM(VMs)

PGPU_NOT_COMPATIBLE_WITH_GPU_GROUP¶

PGPU type not compatible with destination group.

Signature:

PGPU_NOT_COMPATIBLE_WITH_GPU_GROUP(type, group_types)

PIF_ALLOWS_UNPLUG¶

The operation you requested cannot be performed because the specified PIF allows unplug.

Signature:

PIF_ALLOWS_UNPLUG(PIF)

PIF_ALREADY_BONDED¶

This operation cannot be performed because the pif is bonded.

Signature:

PIF_ALREADY_BONDED(PIF)

PIF_BOND_MORE_THAN_ONE_IP¶

Only one PIF on a bond is allowed to have an IP configuration.

No parameters.

PIF_BOND_NEEDS_MORE_MEMBERS¶

A bond must consist of at least two member interfaces

No parameters.

PIF_CANNOT_BOND_CROSS_HOST¶

You cannot bond interfaces across different servers.

No parameters.

PIF_CONFIGURATION_ERROR¶

An unknown error occurred while attempting to configure an interface.

Signature:

PIF_CONFIGURATION_ERROR(PIF, msg)

PIF_DEVICE_NOT_FOUND¶

The specified device was not found.

No parameters.

PIF_DOES_NOT_ALLOW_UNPLUG¶

The operation you requested cannot be performed because the specified PIF does not allow unplug.

Signature:

PIF_DOES_NOT_ALLOW_UNPLUG(PIF)

PIF_HAS_FCOE_SR_IN_USE¶

The operation you requested cannot be performed because the specified PIF has FCoE SR in use.

Signature:

PIF_HAS_FCOE_SR_IN_USE(PIF, SR)

PIF_HAS_NO_NETWORK_CONFIGURATION¶

PIF has no IP configuration (mode currently set to 'none')

Signature:

PIF_HAS_NO_NETWORK_CONFIGURATION(PIF)

PIF_HAS_NO_V6_NETWORK_CONFIGURATION¶

PIF has no IPv6 configuration (mode currently set to 'none')

Signature:

PIF_HAS_NO_V6_NETWORK_CONFIGURATION(PIF)

PIF_INCOMPATIBLE_PRIMARY_ADDRESS_TYPE¶

The primary address types are not compatible

Signature:

PIF_INCOMPATIBLE_PRIMARY_ADDRESS_TYPE(PIF)

PIF_IS_MANAGEMENT_INTERFACE¶

The operation you requested cannot be performed because the specified PIF is the management interface.

Signature:

PIF_IS_MANAGEMENT_INTERFACE(PIF)

PIF_IS_NOT_PHYSICAL¶

You tried to perform an operation which is only available on physical PIF

Signature:

PIF_IS_NOT_PHYSICAL(PIF)

PIF_IS_NOT_SRIOV_CAPABLE¶

The selected PIF is not capable of network SR-IOV

Signature:

PIF_IS_NOT_SRIOV_CAPABLE(PIF)

PIF_IS_PHYSICAL¶

You tried to destroy a PIF, but it represents an aspect of the physical host configuration, and so cannot be destroyed. The parameter echoes the PIF handle you gave.

Signature:

PIF_IS_PHYSICAL(PIF)

PIF_IS_SRIOV_LOGICAL¶

You tried to create a bond on top of a network SR-IOV logical PIF - use the underlying physical PIF instead

Signature:

PIF_IS_SRIOV_LOGICAL(PIF)

PIF_IS_VLAN¶

You tried to create a VLAN on top of another VLAN - use the underlying physical PIF/bond instead

Signature:

PIF_IS_VLAN(PIF)

PIF_NOT_ATTACHED_TO_HOST¶

Cluster_host creation failed as the PIF provided is not attached to the host.

Signature:

PIF_NOT_ATTACHED_TO_HOST(pif, host)

PIF_NOT_PRESENT¶

This host has no PIF on the given network.

Signature:

PIF_NOT_PRESENT(host, network)

PIF_SRIOV_STILL_EXISTS¶

The PIF is still related with a network SR-IOV

Signature:

PIF_SRIOV_STILL_EXISTS(PIF)

PIF_TUNNEL_STILL_EXISTS¶

Operation cannot proceed while a tunnel exists on this interface.

Signature:

PIF_TUNNEL_STILL_EXISTS(PIF)

PIF_UNMANAGED¶

The operation you requested cannot be performed because the specified PIF is not managed by xapi.

Signature:

PIF_UNMANAGED(PIF)

PIF_VLAN_EXISTS¶

You tried to create a PIF, but it already exists.

Signature:

PIF_VLAN_EXISTS(PIF)

PIF_VLAN_STILL_EXISTS¶

Operation cannot proceed while a VLAN exists on this interface.

Signature:

PIF_VLAN_STILL_EXISTS(PIF)

POOL_AUTH_ALREADY_ENABLED¶

External authentication is already enabled for at least one server in this pool.

Signature:

POOL_AUTH_ALREADY_ENABLED(host)

POOL_AUTH_DISABLE_FAILED¶

The pool failed to disable the external authentication of at least one host.

Signature:

POOL_AUTH_DISABLE_FAILED(host, message)

POOL_AUTH_DISABLE_FAILED_INVALID_ACCOUNT¶

External authentication has been disabled with errors: Some AD machine accounts were not disabled on the AD server due to invalid account.

Signature:

POOL_AUTH_DISABLE_FAILED_INVALID_ACCOUNT(host, message)

POOL_AUTH_DISABLE_FAILED_PERMISSION_DENIED¶

External authentication has been disabled with errors: Your AD machine account was not disabled on the AD server as permission was denied.

Signature:

POOL_AUTH_DISABLE_FAILED_PERMISSION_DENIED(host, message)

POOL_AUTH_DISABLE_FAILED_WRONG_CREDENTIALS¶

External authentication has been disabled with errors: Some AD machine accounts were not disabled on the AD server due to invalid credentials.

Signature:

POOL_AUTH_DISABLE_FAILED_WRONG_CREDENTIALS(host, message)