xe – full command list reference with description for XenServer


appliance-assert-can-be-recovered

reqd params : uuid

optional params : database:

description : Test whether storage is available to recover this VM appliance.


appliance-create

reqd params : name-label

optional params : name-description

description : Create a VM appliance.


appliance-destroy

reqd params : uuid

optional params :

description : Destroy a VM appliance.


appliance-list

reqd params :

optional params : params, database:, uuid, name-label, name-description, VMs, allowed-operations, current-operations, VMs:contains, allowed-operations:contains, current-operations:contains

description : Lists all the appliances, filtering on the optional arguments. To filter on map parameters, use the syntax ‘map-param:key=value’


appliance-param-clear

reqd params : uuid, param-name

optional params :

description : Clears the specified parameter (param-name can be name-label,name-description,VMs,allowed-operations,current-operations).


appliance-param-get

reqd params : uuid, param-name

optional params : param-key, database:

description : Gets the parameter specified of the object. If the parameter is a map of key=value pairs, use ‘param-key=<key>’ to get the value associated with a particular key.




appliance-param-list

reqd params : uuid

optional params : database:

description : Lists all the parameters of the object specified by the uuid.


appliance-param-set

reqd params : uuid

optional params : name-label, name-description

description : Sets the parameter specified. If param-value is not given, the parameter is set to a null value. To set a (key,value) pair in a map parameter, use the syntax ‘map-param:key=value’.


appliance-recover

reqd params : uuid

optional params : database:, force

description : Recover a VM appliance from the database contained in the supplied VDI.


appliance-shutdown

reqd params : uuid

optional params : force

description : Shut down all VMs in a VM appliance.


appliance-start

reqd params : uuid

optional params : paused

description : Start a VM appliance.


audit-log-get

reqd params : filename

optional params : since

description : Write the audit log of the pool to <filename>




bond-create

reqd params : network-uuid, pif-uuids

optional params : mac, mode, properties:

description : Create a bonded interface from a list of existing PIF objects.


bond-destroy

reqd params : uuid

optional params :

description : Destroy a bonded interface.


bond-list

reqd params :

optional params : params, database:, uuid, master, slaves, mode, properties, primary-slave, links-up

description : Lists all the bonds, filtering on the optional arguments. To filter on map parameters, use the syntax ‘map-param:key=value’


bond-param-clear

reqd params : uuid, param-name

optional params :

description : Clears the specified parameter (param-name can be properties).


bond-param-get

reqd params : uuid, param-name

optional params : param-key, database:

description : Gets the parameter specified of the object. If the parameter is a map of key=value pairs, use ‘param-key=<key>’ to get the value associated with a particular key.


bond-param-list

reqd params : uuid

optional params : database:

description : Lists all the parameters of the object specified by the uuid.


bond-param-set

reqd params : uuid

optional params : properties:

description : Sets the parameter specified. If param-value is not given, the parameter is set to a null value. To set a (key,value) pair in a map parameter, use the syntax ‘map-param:key=value’.




bond-set-mode

reqd params : uuid, mode

optional params :

description : Change the bond mode.


cd-list

reqd params :

optional params : params

description : List the CDs available to be attached to VMs.


console

reqd params :

optional params : <vm-selectors>

description : Attach to a particular console. The simplest way to select the VM on which the operation is to be performed is by supplying the argument ‘vm=<name or uuid>’. VMs can also be specified by filtering the full list of VMs on the values of fields. For example, specifying ‘power-state=halted’ will select all VMs whose power-state field is equal to ‘halted’. Where multiple VMs are matching, the option ‘–multiple’ must be specified to perform the operation. The full list of fields that can be matched can be obtained by the command ‘xe vm-list params=all’. If no parameters to select VMs are given, the operation will be performed on all VMs.


console-list

reqd params :

optional params : params, database:, uuid, vm-uuid, vm-name-label, protocol, location, other-config

description : Lists all the consoles, filtering on the optional arguments. To filter on map parameters, use the syntax ‘map-param:key=value’


console-param-add

reqd params : uuid, param-name

optional params : param-key

description : Adds to a set or map parameter. If the parameter is a set, use param-key=<key to add>. If the parameter is a map, pass the values to add as ‘key=value’ pairs.


console-param-clear

reqd params : uuid, param-name

optional params :

description : Clears the specified parameter (param-name can be other-config).


console-param-get

reqd params : uuid, param-name

optional params : param-key, database:

description : Gets the parameter specified of the object. If the parameter is a map of key=value pairs, use ‘param-key=<key>’ to get the value associated with a particular key.




console-param-list

reqd params : uuid

optional params : database:

description : Lists all the parameters of the object specified by the uuid.


console-param-remove

reqd params : uuid, param-name, param-key

optional params :

description : Removes a member or a key,value pair from a set/map respectively.


console-param-set

reqd params : uuid

optional params : other-config:

description : Sets the parameter specified. If param-value is not given, the parameter is set to a null value. To set a (key,value) pair in a map parameter, use the syntax ‘map-param:key=value’.


diagnostic-compact

reqd params :

optional params :

description : Perform a major GC collection and heap compaction.


diagnostic-db-log

reqd params :

optional params :

description : Start logging the database operations. Warning: once started, this cannot be stopped.


diagnostic-db-stats

reqd params :

optional params :

description : Print db stats.


diagnostic-gc-stats

reqd params :

optional params :

description : Print GC stats.


diagnostic-license-status

reqd params :

optional params :

description : Help diagnose pool-wide licensing problems.




diagnostic-net-stats

reqd params :

optional params : uri, method, params

description : Print network stats.


diagnostic-timing-stats

reqd params :

optional params :

description : Print timing stats.


diagnostic-vdi-status

reqd params : uuid

optional params :

description : Query the locking and sharing status of a VDI.


diagnostic-vm-status

reqd params : uuid

optional params :

description : Query the hosts on which the VM can boot, check the sharing/locking status of all VBDs.


drtask-create

reqd params : type

optional params : device-config:, sr-whitelist

description : Create a disaster recovery task.


drtask-destroy

reqd params : uuid

optional params :

description : Destroy a disaster recovery task.


drtask-list

reqd params :

optional params : params, database:, uuid, introduced-SRs

description : Lists all the drtasks, filtering on the optional arguments. To filter on map parameters, use the syntax ‘map-param:key=value’




drtask-param-get

reqd params : uuid, param-name

optional params : param-key, database:

description : Gets the parameter specified of the object. If the parameter is a map of key=value pairs, use ‘param-key=<key>’ to get the value associated with a particular key.


drtask-param-list

reqd params : uuid

optional params : database:

description : Lists all the parameters of the object specified by the uuid.


event-wait

reqd params : class

optional params :

description : Wait for the event that satisfies the conditions given on the command line.


gpu-group-create

reqd params : name-label

optional params : name-description

description : Create an empty GPU group


gpu-group-destroy

reqd params : uuid

optional params :

description : Destroy a GPU group


gpu-group-get-remaining-capacity

reqd params : uuid, vgpu-type-uuid

optional params :

description : Calculate the number of VGPUs of the specified type which still be started in the group


gpu-group-list

reqd params :

optional params : params, database:, uuid, name-label, name-description, VGPU-uuids, PGPU-uuids, other-config, enabled-VGPU-types, supported-VGPU-types, allocation-algorithm, VGPU-uuids:contains, PGPU-uuids:contains

description : Lists all the gpu-groups, filtering on the optional arguments. To filter on map parameters, use the syntax ‘map-param:key=value’




gpu-group-param-add

reqd params : uuid, param-name

optional params : param-key

description : Adds to a set or map parameter. If the parameter is a set, use param-key=<key to add>. If the parameter is a map, pass the values to add as ‘key=value’ pairs.


gpu-group-param-clear

reqd params : uuid, param-name

optional params :

description : Clears the specified parameter (param-name can be name-label,name-description,VGPU-uuids,PGPU-uuids,other-config,allocation-algorithm).


gpu-group-param-get

reqd params : uuid, param-name

optional params : param-key, database:

description : Gets the parameter specified of the object. If the parameter is a map of key=value pairs, use ‘param-key=<key>’ to get the value associated with a particular key.


gpu-group-param-list

reqd params : uuid

optional params : database:

description : Lists all the parameters of the object specified by the uuid.


gpu-group-param-remove

reqd params : uuid, param-name, param-key

optional params :

description : Removes a member or a key,value pair from a set/map respectively.


gpu-group-param-set

reqd params : uuid

optional params : name-label, name-description, allocation-algorithm, other-config:

description : Sets the parameter specified. If param-value is not given, the parameter is set to a null value. To set a (key,value) pair in a map parameter, use the syntax ‘map-param:key=value’.


host-all-editions

reqd params :

optional params :

description : Get a list of all available editions.




host-apply-edition

reqd params : edition

optional params : host-uuid, license-server-address, license-server-port

description : Change to another edition, or reactivate the current edition after a license has expired. This may be subject to the successful checkout of an appropriate license.


host-backup

reqd params : file-name

optional params : <host-selectors>

description : Download a backup of the host’s control domain. The simplest way to select the host on which the operation is to be performed is by supplying the argument ‘host=<name or uuid>’. Hosts can also be specified by filtering the full list of hosts on the values of fields. For example, specifying ‘enabled=true’ will select all hosts whose ‘enabled’ field is equal to ‘true’. Where multiple hosts are matching, and the operation can be performed on multiple hosts, the option ‘–multiple’ must be specified to perform the operation. The full list of fields that can be matched can be obtained by the command ‘xe host-list params=all’. If no parameters to select hosts are given, the operation will be performed on all hosts.


host-bugreport-upload

reqd params :

optional params : url, http_proxy, <host-selectors>

description : Upload the output of xen-bugtool –yestoall on a specific host to the support website. The simplest way to select the host on which the operation is to be performed is by supplying the argument ‘host=<name or uuid>’. Hosts can also be specified by filtering the full list of hosts on the values of fields. For example, specifying ‘enabled=true’ will select all hosts whose ‘enabled’ field is equal to ‘true’. Where multiple hosts are matching, and the operation can be performed on multiple hosts, the option ‘–multiple’ must be specified to perform the operation. The full list of fields that can be matched can be obtained by the command ‘xe host-list params=all’. If no parameters to select hosts are given, the operation will be performed on all hosts.


host-call-plugin

reqd params : host-uuid, plugin, fn

optional params : args:

description : Calls the function within the plugin on the given host with optional arguments.


host-compute-free-memory

reqd params :

optional params : <host-selectors>

description : Computes the amount of free memory on the host. The simplest way to select the host on which the operation is to be performed is by supplying the argument ‘host=<name or uuid>’. Hosts can also be specified by filtering the full list of hosts on the values of fields. For example, specifying ‘enabled=true’ will select all hosts whose ‘enabled’ field is equal to ‘true’. Where multiple hosts are matching, and the operation can be performed on multiple hosts, the option ‘–multiple’ must be specified to perform the operation. The full list of fields that can be matched can be obtained by the command ‘xe host-list params=all’. If no parameters to select hosts are given, the operation will be performed on all hosts.


host-compute-memory-overhead

reqd params :

optional params : <host-selectors>

description : Computes the virtualization memory overhead of a host. The simplest way to select the host on which the operation is to be performed is by supplying the argument ‘host=<name or uuid>’. Hosts can also be specified by filtering the full list of hosts on the values of fields. For example, specifying ‘enabled=true’ will select all hosts whose ‘enabled’ field is equal to ‘true’. Where multiple hosts are matching, and the operation can be performed on multiple hosts, the option ‘–multiple’ must be specified to perform the operation. The full list of fields that can be matched can be obtained by the command ‘xe host-list params=all’. If no parameters to select hosts are given, the operation will be performed on all hosts.


host-cpu-info

reqd params :

optional params : uuid

description : Lists information about the host’s physical CPUs.




host-cpu-list

reqd params :

optional params : params, database:, uuid, host-uuid, number, vendor, speed, model, family, modelname, stepping, flags, utilisation

description : Lists all the host-cpus, filtering on the optional arguments. To filter on map parameters, use the syntax ‘map-param:key=value’


host-cpu-param-get

reqd params : uuid, param-name

optional params : param-key, database:

description : Gets the parameter specified of the object. If the parameter is a map of key=value pairs, use ‘param-key=<key>’ to get the value associated with a particular key.


host-cpu-param-list

reqd params : uuid

optional params : database:

description : Lists all the parameters of the object specified by the uuid.


host-crashdump-destroy

reqd params : uuid

optional params :

description : Delete a host crashdump from the server.


host-crashdump-list

reqd params :

optional params : params, database:, uuid, host-uuid, timestamp, size

description : Lists all the host-crashdumps, filtering on the optional arguments. To filter on map parameters, use the syntax ‘map-param:key=value’


host-crashdump-param-get

reqd params : uuid, param-name

optional params : param-key, database:

description : Gets the parameter specified of the object. If the parameter is a map of key=value pairs, use ‘param-key=<key>’ to get the value associated with a particular key.


host-crashdump-param-list

reqd params : uuid

optional params : database:

description : Lists all the parameters of the object specified by the uuid.


host-crashdump-upload

reqd params : uuid

optional params : url, http_proxy

description : Upload a host crash dump to the support website.




host-data-source-forget

reqd params : data-source

optional params : <host-selectors>

description : Stop recording the specified data source for a Host, and forget all of the recorded data. The simplest way to select the host on which the operation is to be performed is by supplying the argument ‘host=<name or uuid>’. Hosts can also be specified by filtering the full list of hosts on the values of fields. For example, specifying ‘enabled=true’ will select all hosts whose ‘enabled’ field is equal to ‘true’. Where multiple hosts are matching, and the operation can be performed on multiple hosts, the option ‘–multiple’ must be specified to perform the operation. The full list of fields that can be matched can be obtained by the command ‘xe host-list params=all’. If no parameters to select hosts are given, the operation will be performed on all hosts.


host-data-source-list

reqd params :

optional params : <host-selectors>

description : List the data sources that can be recorded for a Host. The simplest way to select the host on which the operation is to be performed is by supplying the argument ‘host=<name or uuid>’. Hosts can also be specified by filtering the full list of hosts on the values of fields. For example, specifying ‘enabled=true’ will select all hosts whose ‘enabled’ field is equal to ‘true’. Where multiple hosts are matching, and the operation can be performed on multiple hosts, the option ‘–multiple’ must be specified to perform the operation. The full list of fields that can be matched can be obtained by the command ‘xe host-list params=all’. If no parameters to select hosts are given, the operation will be performed on all hosts.


host-data-source-query

reqd params : data-source

optional params : <host-selectors>

description : Query the last value read from a Host data source. The simplest way to select the host on which the operation is to be performed is by supplying the argument ‘host=<name or uuid>’. Hosts can also be specified by filtering the full list of hosts on the values of fields. For example, specifying ‘enabled=true’ will select all hosts whose ‘enabled’ field is equal to ‘true’. Where multiple hosts are matching, and the operation can be performed on multiple hosts, the option ‘–multiple’ must be specified to perform the operation. The full list of fields that can be matched can be obtained by the command ‘xe host-list params=all’. If no parameters to select hosts are given, the operation will be performed on all hosts.


host-data-source-record

reqd params : data-source

optional params : <host-selectors>

description : Record the specified data source for a Host. The simplest way to select the host on which the operation is to be performed is by supplying the argument ‘host=<name or uuid>’. Hosts can also be specified by filtering the full list of hosts on the values of fields. For example, specifying ‘enabled=true’ will select all hosts whose ‘enabled’ field is equal to ‘true’. Where multiple hosts are matching, and the operation can be performed on multiple hosts, the option ‘–multiple’ must be specified to perform the operation. The full list of fields that can be matched can be obtained by the command ‘xe host-list params=all’. If no parameters to select hosts are given, the operation will be performed on all hosts.


host-declare-dead

reqd params : uuid

optional params :

description : Declare that the the host is dead without contacting it explicitly. WARNING: This call is dangerous and can cause data loss if the host is not actually dead


host-disable

reqd params :

optional params : <host-selectors>

description : Disable the XE host. The simplest way to select the host on which the operation is to be performed is by supplying the argument ‘host=<name or uuid>’. Hosts can also be specified by filtering the full list of hosts on the values of fields. For example, specifying ‘enabled=true’ will select all hosts whose ‘enabled’ field is equal to ‘true’. Where multiple hosts are matching, and the operation can be performed on multiple hosts, the option ‘–multiple’ must be specified to perform the operation. The full list of fields that can be matched can be obtained by the command ‘xe host-list params=all’. If no parameters to select hosts are given, the operation will be performed on all hosts.




host-disable-display

reqd params : uuid

optional params :

description : Disable display for the host


host-disable-local-storage-caching

reqd params :

optional params : <host-selectors>

description : Disable local storage caching on the specified host The simplest way to select the host on which the operation is to be performed is by supplying the argument ‘host=<name or uuid>’. Hosts can also be specified by filtering the full list of hosts on the values of fields. For example, specifying ‘enabled=true’ will select all hosts whose ‘enabled’ field is equal to ‘true’. Where multiple hosts are matching, and the operation can be performed on multiple hosts, the option ‘–multiple’ must be specified to perform the operation. The full list of fields that can be matched can be obtained by the command ‘xe host-list params=all’. If no parameters to select hosts are given, the operation will be performed on all hosts.


host-dmesg

reqd params :

optional params : <host-selectors>

description : Get xen dmesg of the XE host. The simplest way to select the host on which the operation is to be performed is by supplying the argument ‘host=<name or uuid>’. Hosts can also be specified by filtering the full list of hosts on the values of fields. For example, specifying ‘enabled=true’ will select all hosts whose ‘enabled’ field is equal to ‘true’. Where multiple hosts are matching, and the operation can be performed on multiple hosts, the option ‘–multiple’ must be specified to perform the operation. The full list of fields that can be matched can be obtained by the command ‘xe host-list params=all’. If no parameters to select hosts are given, the operation will be performed on all hosts.


host-emergency-ha-disable

reqd params :

optional params : force

description : Disable HA on the local host. Only to be used to recover a pool with a broken HA setup.


host-emergency-management-reconfigure

reqd params : interface

optional params :

description : Reconfigure the management interface of this node: only use if the node is in emergency mode.


host-enable

reqd params :

optional params : <host-selectors>

description : Enable the XE host. The simplest way to select the host on which the operation is to be performed is by supplying the argument ‘host=<name or uuid>’. Hosts can also be specified by filtering the full list of hosts on the values of fields. For example, specifying ‘enabled=true’ will select all hosts whose ‘enabled’ field is equal to ‘true’. Where multiple hosts are matching, and the operation can be performed on multiple hosts, the option ‘–multiple’ must be specified to perform the operation. The full list of fields that can be matched can be obtained by the command ‘xe host-list params=all’. If no parameters to select hosts are given, the operation will be performed on all hosts.


host-enable-display

reqd params : uuid

optional params :

description : Enable display for the host




host-enable-local-storage-caching

reqd params : sr-uuid

optional params : <host-selectors>

description : Enable local storage caching on the specified host The simplest way to select the host on which the operation is to be performed is by supplying the argument ‘host=<name or uuid>’. Hosts can also be specified by filtering the full list of hosts on the values of fields. For example, specifying ‘enabled=true’ will select all hosts whose ‘enabled’ field is equal to ‘true’. Where multiple hosts are matching, and the operation can be performed on multiple hosts, the option ‘–multiple’ must be specified to perform the operation. The full list of fields that can be matched can be obtained by the command ‘xe host-list params=all’. If no parameters to select hosts are given, the operation will be performed on all hosts.


host-evacuate

reqd params :

optional params : <host-selectors>

description : Migrate all VMs off a host. The simplest way to select the host on which the operation is to be performed is by supplying the argument ‘host=<name or uuid>’. Hosts can also be specified by filtering the full list of hosts on the values of fields. For example, specifying ‘enabled=true’ will select all hosts whose ‘enabled’ field is equal to ‘true’. Where multiple hosts are matching, and the operation can be performed on multiple hosts, the option ‘–multiple’ must be specified to perform the operation. The full list of fields that can be matched can be obtained by the command ‘xe host-list params=all’. If no parameters to select hosts are given, the operation will be performed on all hosts.


host-forget

reqd params : uuid

optional params :

description : Forget about the host without contacting it explicitly. WARNING: this call is useful if the host to ‘forget’ is dead; however, if the host is live and part of the pool, you should consider using pool-eject instead.


host-get-cpu-features

reqd params :

optional params : uuid

description : Prints a hexadecimal representation of the host’s physical-CPU features.


host-get-server-certificate

reqd params :

optional params : <host-selectors>

description : Get the installed server SSL certificate. The simplest way to select the host on which the operation is to be performed is by supplying the argument ‘host=<name or uuid>’. Hosts can also be specified by filtering the full list of hosts on the values of fields. For example, specifying ‘enabled=true’ will select all hosts whose ‘enabled’ field is equal to ‘true’. Where multiple hosts are matching, and the operation can be performed on multiple hosts, the option ‘–multiple’ must be specified to perform the operation. The full list of fields that can be matched can be obtained by the command ‘xe host-list params=all’. If no parameters to select hosts are given, the operation will be performed on all hosts.


host-get-sm-diagnostics

reqd params : uuid

optional params :

description : Display per-host SM diagnostic information.


host-get-system-status

reqd params : filename

optional params : entries, output, <host-selectors>

description : Download system status into <filename>. Entries is a comma-separated list. Output may be ‘tar’, ‘tar.bz2’ (the default) or ‘zip’. The simplest way to select the host on which the operation is to be performed is by supplying the argument ‘host=<name or uuid>’. Hosts can also be specified by filtering the full list of hosts on the values of fields. For example, specifying ‘enabled=true’ will select all hosts whose ‘enabled’ field is equal to ‘true’. Where multiple hosts are matching, and the operation can be performed on multiple hosts, the option ‘–multiple’ must be specified to perform the operation. The full list of fields that can be matched can be obtained by the command ‘xe host-list params=all’. If no parameters to select hosts are given, the operation will be performed on all hosts.


host-get-system-status-capabilities

reqd params :

optional params : <host-selectors>

description : The simplest way to select the host on which the operation is to be performed is by supplying the argument ‘host=<name or uuid>’. Hosts can also be specified by filtering the full list of hosts on the values of fields. For example, specifying ‘enabled=true’ will select all hosts whose ‘enabled’ field is equal to ‘true’. Where multiple hosts are matching, and the operation can be performed on multiple hosts, the option ‘–multiple’ must be specified to perform the operation. The full list of fields that can be matched can be obtained by the command ‘xe host-list params=all’. If no parameters to select hosts are given, the operation will be performed on all hosts.




host-get-thread-diagnostics

reqd params : uuid

optional params :

description : Display per-host thread diagnostic information.


host-get-vms-which-prevent-evacuation

reqd params : uuid

optional params :

description : Return a list of VMs which prevent the evacuation of a specific host and display reasons for each one.


host-is-in-emergency-mode

reqd params :

optional params :

description : Query the target host to discover if it is in emergency mode.


host-license-add

reqd params : license-file

optional params : host-uuid

description : Add a license to a host.


host-license-remove

reqd params :

optional params : host-uuid

description : Remove any licensing applied to a host.


host-license-view

reqd params :

optional params : host-uuid

description : View the license parameters of the host.


host-list

reqd params :

optional params : params, database:, uuid, name-label, name-description, allowed-operations, current-operations, enabled, display, API-version-major, API-version-minor, API-version-vendor, API-version-vendor-implementation, logging, suspend-image-sr-uuid, crash-dump-sr-uuid, software-version, capabilities, other-config, cpu_info, chipset-info, hostname, address, supported-bootloaders, blobs, memory-overhead, memory-total, memory-free, memory-free-computed, host-metrics-live, patches, ha-statefiles, ha-network-peers, external-auth-type, external-auth-service-name, external-auth-configuration, edition, license-server, power-on-mode, power-on-config, local-cache-sr, tags, ssl-legacy, guest_VCPUs_params, virtual-hardware-platform-versions, allowed-operations:contains, current-operations:contains, capabilities:contains, supported-bootloaders:contains, patches:contains, tags:contains, virtual-hardware-platform-versions:contains

description : Lists all the hosts, filtering on the optional arguments. To filter on map parameters, use the syntax ‘map-param:key=value’




host-logs-download

reqd params :

optional params : file-name, <host-selectors>

description : Download a copy of the host logs. The simplest way to select the host on which the operation is to be performed is by supplying the argument ‘host=<name or uuid>’. Hosts can also be specified by filtering the full list of hosts on the values of fields. For example, specifying ‘enabled=true’ will select all hosts whose ‘enabled’ field is equal to ‘true’. Where multiple hosts are matching, and the operation can be performed on multiple hosts, the option ‘–multiple’ must be specified to perform the operation. The full list of fields that can be matched can be obtained by the command ‘xe host-list params=all’. If no parameters to select hosts are given, the operation will be performed on all hosts.


host-management-disable

reqd params :

optional params :

description : Disable the management interface of this node.


host-management-reconfigure

reqd params : pif-uuid

optional params :

description : Reconfigure the management interface of this node.


host-param-add

reqd params : uuid, param-name

optional params : param-key

description : Adds to a set or map parameter. If the parameter is a set, use param-key=<key to add>. If the parameter is a map, pass the values to add as ‘key=value’ pairs.


host-param-clear

reqd params : uuid, param-name

optional params :

description : Clears the specified parameter (param-name can be name-label,name-description,allowed-operations,current-operations,API-version-vendor-implementation,logging,suspend-image-sr-uuid,crash-dump-sr-uuid,software-version,capabilities,other-config,cpu_info,chipset-info,supported-bootloaders,patches,external-auth-configuration,license-server,power-on-config,tags,ssl-legacy,guest_VCPUs_params,virtual-hardware-platform-versions).


host-param-get

reqd params : uuid, param-name

optional params : param-key, database:

description : Gets the parameter specified of the object. If the parameter is a map of key=value pairs, use ‘param-key=<key>’ to get the value associated with a particular key.


host-param-list

reqd params : uuid

optional params : database:

description : Lists all the parameters of the object specified by the uuid.




host-param-remove

reqd params : uuid, param-name, param-key

optional params :

description : Removes a member or a key,value pair from a set/map respectively.


host-param-set

reqd params : uuid

optional params : name-label, name-description, suspend-image-sr-uuid, crash-dump-sr-uuid, ssl-legacy, logging:, other-config:, guest_VCPUs_params:

description : Sets the parameter specified. If param-value is not given, the parameter is set to a null value. To set a (key,value) pair in a map parameter, use the syntax ‘map-param:key=value’.


host-power-on

reqd params :

optional params : <host-selectors>

description : Power on the XE host. The simplest way to select the host on which the operation is to be performed is by supplying the argument ‘host=<name or uuid>’. Hosts can also be specified by filtering the full list of hosts on the values of fields. For example, specifying ‘enabled=true’ will select all hosts whose ‘enabled’ field is equal to ‘true’. Where multiple hosts are matching, and the operation can be performed on multiple hosts, the option ‘–multiple’ must be specified to perform the operation. The full list of fields that can be matched can be obtained by the command ‘xe host-list params=all’. If no parameters to select hosts are given, the operation will be performed on all hosts.


host-reboot

reqd params :

optional params : <host-selectors>

description : Reboot the XE host. The simplest way to select the host on which the operation is to be performed is by supplying the argument ‘host=<name or uuid>’. Hosts can also be specified by filtering the full list of hosts on the values of fields. For example, specifying ‘enabled=true’ will select all hosts whose ‘enabled’ field is equal to ‘true’. Where multiple hosts are matching, and the operation can be performed on multiple hosts, the option ‘–multiple’ must be specified to perform the operation. The full list of fields that can be matched can be obtained by the command ‘xe host-list params=all’. If no parameters to select hosts are given, the operation will be performed on all hosts.


host-restore

reqd params : file-name

optional params : <host-selectors>

description : Upload a backup of the host’s control domain. The simplest way to select the host on which the operation is to be performed is by supplying the argument ‘host=<name or uuid>’. Hosts can also be specified by filtering the full list of hosts on the values of fields. For example, specifying ‘enabled=true’ will select all hosts whose ‘enabled’ field is equal to ‘true’. Where multiple hosts are matching, and the operation can be performed on multiple hosts, the option ‘–multiple’ must be specified to perform the operation. The full list of fields that can be matched can be obtained by the command ‘xe host-list params=all’. If no parameters to select hosts are given, the operation will be performed on all hosts.


host-send-debug-keys

reqd params : host-uuid, keys

optional params :

description : Send specified hypervisor debug keys to specified host


host-set-hostname-live

reqd params : host-uuid, host-name

optional params : <host-selectors>

description : Sets the host name to the specified string. Both the API and lower-level system hostname are changed. The simplest way to select the host on which the operation is to be performed is by supplying the argument ‘host=<name or uuid>’. Hosts can also be specified by filtering the full list of hosts on the values of fields. For example, specifying ‘enabled=true’ will select all hosts whose ‘enabled’ field is equal to ‘true’. Where multiple hosts are matching, and the operation can be performed on multiple hosts, the option ‘–multiple’ must be specified to perform the operation. The full list of fields that can be matched can be obtained by the command ‘xe host-list params=all’. If no parameters to select hosts are given, the operation will be performed on all hosts.




host-set-power-on-mode

reqd params : power-on-mode

optional params : power-on-config, <host-selectors>

description : Sets the power-on mode for the XE host The simplest way to select the host on which the operation is to be performed is by supplying the argument ‘host=<name or uuid>’. Hosts can also be specified by filtering the full list of hosts on the values of fields. For example, specifying ‘enabled=true’ will select all hosts whose ‘enabled’ field is equal to ‘true’. Where multiple hosts are matching, and the operation can be performed on multiple hosts, the option ‘–multiple’ must be specified to perform the operation. The full list of fields that can be matched can be obtained by the command ‘xe host-list params=all’. If no parameters to select hosts are given, the operation will be performed on all hosts.


host-shutdown

reqd params :

optional params : <host-selectors>

description : Shutdown the XE host. The simplest way to select the host on which the operation is to be performed is by supplying the argument ‘host=<name or uuid>’. Hosts can also be specified by filtering the full list of hosts on the values of fields. For example, specifying ‘enabled=true’ will select all hosts whose ‘enabled’ field is equal to ‘true’. Where multiple hosts are matching, and the operation can be performed on multiple hosts, the option ‘–multiple’ must be specified to perform the operation. The full list of fields that can be matched can be obtained by the command ‘xe host-list params=all’. If no parameters to select hosts are given, the operation will be performed on all hosts.


host-shutdown-agent

reqd params :

optional params :

description : Shut down the agent on the local host.


host-sm-dp-destroy

reqd params : uuid, dp

optional params : allow-leak

description : Attempt to destroy and clean up a storage datapath on a host. If allow-leak=true is provided then it will delete all records of the datapath even if it could not be shutdown cleanly.


host-sync-data

reqd params :

optional params : <host-selectors>

description : Synchronise the non-database data stored on the pool master with the named XE host. The simplest way to select the host on which the operation is to be performed is by supplying the argument ‘host=<name or uuid>’. Hosts can also be specified by filtering the full list of hosts on the values of fields. For example, specifying ‘enabled=true’ will select all hosts whose ‘enabled’ field is equal to ‘true’. Where multiple hosts are matching, and the operation can be performed on multiple hosts, the option ‘–multiple’ must be specified to perform the operation. The full list of fields that can be matched can be obtained by the command ‘xe host-list params=all’. If no parameters to select hosts are given, the operation will be performed on all hosts.


host-syslog-reconfigure

reqd params : host-uuid

optional params :

description : Reconfigure syslog daemon.


log-get

reqd params :

optional params :

description : Return the log currently stored in the string logger.




log-get-keys

reqd params :

optional params :

description : List the keys known by the logger.


log-reopen

reqd params :

optional params :

description : Reopen all loggers (use this for rotating files).


log-set-output

reqd params : output

optional params : key, level

description : Set all loggers to the specified output (nil, stderr, string, file:<filename>, syslog:<something>).


lvhd-enable-thin-provisioning

reqd params : sr-uuid, initial-allocation, allocation-quantum

optional params :

description : Enable thin-provisioning on an LVHD SR.


message-create

reqd params : name, priority, body

optional params : vm-uuid, host-uuid, sr-uuid, pool-uuid

description : Create a message associated with a particular API object. Note exactly one of the optional parameters must be supplied.


message-destroy

reqd params : uuid

optional params :

description : Destroy an existing message.


message-list

reqd params :

optional params : params, database:, uuid, name, priority, class, obj-uuid, timestamp, body

description : Lists all the messages, filtering on the optional arguments. To filter on map parameters, use the syntax ‘map-param:key=value’


message-param-get

reqd params : uuid, param-name

optional params : param-key, database:

description : Gets the parameter specified of the object. If the parameter is a map of key=value pairs, use ‘param-key=<key>’ to get the value associated with a particular key.


message-param-list

reqd params : uuid

optional params : database:

description : Lists all the parameters of the object specified by the uuid.




network-create

reqd params : name-label

optional params : name-description, MTU

description : Create a new network.


network-destroy

reqd params : uuid

optional params :

description : Delete an existing network.


network-list

reqd params :

optional params : params, database:, uuid, name-label, name-description, VIF-uuids, PIF-uuids, MTU, bridge, other-config, blobs, tags, default-locking-mode, VIF-uuids:contains, PIF-uuids:contains, tags:contains

description : Lists all the networks, filtering on the optional arguments. To filter on map parameters, use the syntax ‘map-param:key=value’


network-param-add

reqd params : uuid, param-name

optional params : param-key

description : Adds to a set or map parameter. If the parameter is a set, use param-key=<key to add>. If the parameter is a map, pass the values to add as ‘key=value’ pairs.


network-param-clear

reqd params : uuid, param-name

optional params :

description : Clears the specified parameter (param-name can be name-label,name-description,VIF-uuids,PIF-uuids,MTU,other-config,tags,default-locking-mode).


network-param-get

reqd params : uuid, param-name

optional params : param-key, database:

description : Gets the parameter specified of the object. If the parameter is a map of key=value pairs, use ‘param-key=<key>’ to get the value associated with a particular key.


network-param-list

reqd params : uuid

optional params : database:

description : Lists all the parameters of the object specified by the uuid.


network-param-remove

reqd params : uuid, param-name, param-key

optional params :

description : Removes a member or a key,value pair from a set/map respectively.


network-param-set

reqd params : uuid

optional params : name-label, name-description, MTU, default-locking-mode, other-config:

description : Sets the parameter specified. If param-value is not given, the parameter is set to a null value. To set a (key,value) pair in a map parameter, use the syntax ‘map-param:key=value’.


patch-apply

reqd params : uuid, host-uuid

optional params :

description : Apply the previously uploaded patch to the specified host.




patch-clean

reqd params : uuid

optional params :

description : Delete a previously uploaded patch file.


patch-destroy

reqd params : uuid

optional params :

description : Remove an unapplied patch record and files from the server.


patch-list

reqd params :

optional params : params, database:, uuid, name-label, name-description, size, hosts, after-apply-guidance, hosts:contains, after-apply-guidance:contains

description : Lists all the patches, filtering on the optional arguments. To filter on map parameters, use the syntax ‘map-param:key=value’


patch-param-clear

reqd params : uuid, param-name

optional params :

description : Clears the specified parameter (param-name can be hosts,after-apply-guidance).


patch-param-get

reqd params : uuid, param-name

optional params : param-key, database:

description : Gets the parameter specified of the object. If the parameter is a map of key=value pairs, use ‘param-key=<key>’ to get the value associated with a particular key.


patch-param-list

reqd params : uuid

optional params : database:

description : Lists all the parameters of the object specified by the uuid.


patch-pool-apply

reqd params : uuid

optional params :

description : Apply the previously uploaded patch to all hosts in the pool.


patch-pool-clean

reqd params : uuid

optional params :

description : Delete a previously uploaded patch file on all hosts in the pool.


patch-precheck

reqd params : uuid, host-uuid

optional params :

description : Run the prechecks contained within the patch previously uploaded to the specified host.


patch-upload

reqd params : file-name

optional params :

description : Upload a patch file to the server.




pbd-create

reqd params : host-uuid, sr-uuid

optional params : device-config:

description : Create a PBD. The read-only device-config parameter can only be set on creation in the following manner. To
add a mapping of ‘path’ -> ‘/tmp’, the command line should contain the argument device-config:path=/tmp


pbd-destroy

reqd params : uuid

optional params :

description : Destroy the PBD.


pbd-list

reqd params :

optional params : params, database:, uuid, host, host-uuid, host-name-label, sr-uuid, sr-name-label, device-config, currently-attached, other-config

description : Lists all the pbds, filtering on the optional arguments. To filter on map parameters, use the syntax ‘map-param:key=value’


pbd-param-add

reqd params : uuid, param-name

optional params : param-key

description : Adds to a set or map parameter. If the parameter is a set, use param-key=<key to add>. If the parameter is a map, pass the values to add as ‘key=value’ pairs.


pbd-param-clear

reqd params : uuid, param-name

optional params :

description : Clears the specified parameter (param-name can be device-config,other-config).


pbd-param-get

reqd params : uuid, param-name

optional params : param-key, database:

description : Gets the parameter specified of the object. If the parameter is a map of key=value pairs, use ‘param-key=<key>’ to get the value associated with a particular key.


pbd-param-list

reqd params : uuid

optional params : database:

description : Lists all the parameters of the object specified by the uuid.


pbd-param-remove

reqd params : uuid, param-name, param-key

optional params :

description : Removes a member or a key,value pair from a set/map respectively.


pbd-param-set

reqd params : uuid

optional params : other-config:

description : Sets the parameter specified. If param-value is not given, the parameter is set to a null value. To set a (key,value) pair in a map parameter, use the syntax ‘map-param:key=value’.


pbd-plug

reqd params : uuid

optional params :

description : Attempt to plug in the PBD to the host. If this succeeds then the referenced SR (and the VDIs contained within) should be visible to the host.




pbd-unplug

reqd params : uuid

optional params :

description : Attempt to unplug the PBD from the host. If this succeeds then the referenced SR (and the VDIs contained within) should not be visible to the host.


pgpu-disable-dom0-access

reqd params : uuid

optional params :

description : Disable PGPU access to dom0.


pgpu-enable-dom0-access

reqd params : uuid

optional params :

description : Enable PGPU access to dom0.


pgpu-list

reqd params :

optional params : params, database:, uuid, vendor-name, device-name, dom0-access, is-system-display-device, gpu-group-uuid, gpu-group-name-label, host-uuid, host-name-label, pci-id, dependencies, other-config, supported-VGPU-types, enabled-VGPU-types, resident-VGPUs, dependencies:contains, enabled-VGPU-types:contains

description : Lists all the pgpus, filtering on the optional arguments. To filter on map parameters, use the syntax ‘map-param:key=value’


pgpu-param-add

reqd params : uuid, param-name

optional params : param-key

description : Adds to a set or map parameter. If the parameter is a set, use param-key=<key to add>. If the parameter is a map, pass the values to add as ‘key=value’ pairs.


pgpu-param-clear

reqd params : uuid, param-name

optional params :

description : Clears the specified parameter (param-name can be gpu-group-uuid,dependencies,other-config,enabled-VGPU-types).


pgpu-param-get

reqd params : uuid, param-name

optional params : param-key, database:

description : Gets the parameter specified of the object. If the parameter is a map of key=value pairs, use ‘param-key=<key>’ to get the value associated with a particular key.


pgpu-param-list

reqd params : uuid

optional params : database:

description : Lists all the parameters of the object specified by the uuid.


pgpu-param-remove

reqd params : uuid, param-name, param-key

optional params :

description : Removes a member or a key,value pair from a set/map respectively.


pgpu-param-set

reqd params : uuid

optional params : gpu-group-uuid, enabled-VGPU-types, other-config:

description : Sets the parameter specified. If param-value is not given, the parameter is set to a null value. To set a (key,value) pair in a map parameter, use the syntax ‘map-param:key=value’.




pif-forget

reqd params : uuid

optional params :

description : Destroy a PIF object on a particular host.


pif-introduce

reqd params : host-uuid, device

optional params : mac, managed

description : Create a new PIF object representing a physical interface on a host.


pif-list

reqd params :

optional params : params, database:, uuid, device, MAC, physical, managed, currently-attached, MTU, VLAN, bond-master-of, bond-slave-of, tunnel-access-PIF-of, tunnel-transport-PIF-of, management, network-uuid, network-name-label, host-uuid, host-name-label, IP-configuration-mode, IP, netmask, gateway, IPv6-configuration-mode, IPv6, IPv6-gateway, primary-address-type, DNS, properties, capabilities, io_read_kbs, io_write_kbs, carrier, vendor-id, vendor-name, device-id, device-name, speed, duplex, disallow-unplug, pci-bus-path, other-config, capabilities:contains

description : Lists all the pifs, filtering on the optional arguments. To filter on map parameters, use the syntax ‘map-param:key=value’


pif-param-add

reqd params : uuid, param-name

optional params : param-key

description : Adds to a set or map parameter. If the parameter is a set, use param-key=<key to add>. If the parameter is a map, pass the values to add as ‘key=value’ pairs.


pif-param-clear

reqd params : uuid, param-name

optional params :

description : Clears the specified parameter (param-name can be properties,capabilities,disallow-unplug,other-config).


pif-param-get

reqd params : uuid, param-name

optional params : param-key, database:

description : Gets the parameter specified of the object. If the parameter is a map of key=value pairs, use ‘param-key=<key>’ to get the value associated with a particular key.


pif-param-list

reqd params : uuid

optional params : database:

description : Lists all the parameters of the object specified by the uuid.


pif-param-remove

reqd params : uuid, param-name, param-key

optional params :

description : Removes a member or a key,value pair from a set/map respectively.


pif-param-set

reqd params : uuid

optional params : disallow-unplug, other-config:, properties:

description : Sets the parameter specified. If param-value is not given, the parameter is set to a null value. To set a (key,value) pair in a map parameter, use the syntax ‘map-param:key=value’.


pif-plug

reqd params : uuid

optional params :

description : Attempt to bring up a network interface.




pif-reconfigure-ip

reqd params : uuid, mode

optional params : IP, netmask, gateway, DNS

description : Reconfigure the IP address settings on a PIF.


pif-reconfigure-ipv6

reqd params : uuid, mode

optional params : IPv6, gateway, DNS

description : Reconfigure the IPv6 address settings on a PIF.


pif-scan

reqd params : host-uuid

optional params :

description : Scan for new physical interfaces on a host.


pif-set-primary-address-type

reqd params : uuid, primary_address_type

optional params :

description : Change the primary address type used by this PIF.


pif-unplug

reqd params : uuid

optional params :

description : Attempt to bring down a network interface.


pool-apply-edition

reqd params : edition

optional params : uuid, license-server-address, license-server-port

description : Apply an edition across the pool


pool-certificate-install

reqd params : filename

optional params :

description : Install an SSL certificate, pool-wide.


pool-certificate-list

reqd params :

optional params :

description : List all installed SSL certificates.


pool-certificate-sync

reqd params :

optional params :

description : Sync SSL certificates and certificate revocation lists from master to slaves.


pool-certificate-uninstall

reqd params : name

optional params :

description : Uninstall an SSL certificate.


pool-crl-install

reqd params : filename

optional params :

description : Install an SSL certificate revocation list, pool-wide.




pool-crl-list

reqd params :

optional params :

description : List all installed SSL certificate revocation lists.


pool-crl-uninstall

reqd params : name

optional params :

description : Uninstall an SSL certificate revocation list.


pool-deconfigure-wlb

reqd params :

optional params :

description : Permanently remove the configuration for workload balancing


pool-designate-new-master

reqd params : host-uuid

optional params :

description : Request an orderly handover of the role of master to another host.


pool-disable-external-auth

reqd params :

optional params : uuid, config:

description : Disables external authentication in all the hosts in a pool


pool-disable-local-storage-caching

reqd params : uuid

optional params :

description : Disable local storage caching across the pool


pool-disable-redo-log

reqd params :

optional params :

description : Disable the redo log if in use, unless HA is enabled.


pool-disable-ssl-legacy

reqd params :

optional params : uuid

description : Set ssl-legacy to False on each host.


pool-dump-database

reqd params : file-name

optional params :

description : Download a dump of the pool database.




pool-eject

reqd params : host-uuid

optional params :

description : Instruct host to leave an existing pool.


pool-emergency-reset-master

reqd params : master-address

optional params :

description : Instruct slave to reset master address.


pool-emergency-transition-to-master

reqd params :

optional params :

description : Instruct slave to become pool master.


pool-enable-external-auth

reqd params : auth-type, service-name

optional params : uuid, config:

description : Enables external authentication in all the hosts in a pool. Note that some values of auth-type will require particular config: values.


pool-enable-local-storage-caching

reqd params : uuid

optional params :

description : Enable local storage caching across the pool


pool-enable-redo-log

reqd params : sr-uuid

optional params :

description : Enable the redo log on the given SR and start using it, unless HA is enabled.


pool-enable-ssl-legacy

reqd params :

optional params : uuid

description : Set ssl-legacy to True on each host.


pool-ha-compute-hypothetical-max-host-failures-to-tolerate

reqd params :

optional params : vm-uuid, restart-priority

description : Compute the maximum number of host failures to tolerate with the supplied, proposed protected VMs.


pool-ha-compute-max-host-failures-to-tolerate

reqd params :

optional params :

description : Compute the maximum number of host failures to tolerate under the current Pool configuration




pool-ha-disable

reqd params :

optional params :

description : Disable HA on this Pool.


pool-ha-enable

reqd params :

optional params : heartbeat-sr-uuids, ha-config:

description : Enable HA on this Pool.


pool-initialize-wlb

reqd params : wlb_url, wlb_username, wlb_password, xenserver_username, xenserver_password

optional params :

description : Initialize workload balancing for the current pool with the target wlb server


pool-join

reqd params : master-address, master-username, master-password

optional params : force

description : Instruct host to join an existing pool.


pool-list

reqd params :

optional params : params, database:, uuid, name-label, name-description, master, default-SR, crash-dump-SR, suspend-image-SR, supported-sr-types, other-config, allowed-operations, current-operations, ha-enabled, ha-configuration, ha-statefiles, ha-host-failures-to-tolerate, ha-plan-exists-for, ha-allow-overcommit, ha-overcommitted, blobs, wlb-url, wlb-username, wlb-enabled, wlb-verify-cert, gui-config, health-check-config, restrictions, tags, license-state, ha-cluster-stack, guest-agent-config, cpu_info, policy-no-vendor-device, allowed-operations:contains, current-operations:contains, tags:contains

description : Lists all the pools, filtering on the optional arguments. To filter on map parameters, use the syntax ‘map-param:key=value’


pool-param-add

reqd params : uuid, param-name

optional params : param-key

description : Adds to a set or map parameter. If the parameter is a set, use param-key=<key to add>. If the parameter is a map, pass the values to add as ‘key=value’ pairs.


pool-param-clear

reqd params : uuid, param-name

optional params :

description : Clears the specified parameter (param-name can be name-label,name-description,default-SR,crash-dump-SR,suspend-image-SR,other-config,allowed-operations,current-operations,ha-host-failures-to-tolerate,ha-allow-overcommit,wlb-enabled,wlb-verify-cert,gui-config,health-check-config,tags,guest-agent-config,cpu_info,policy-no-vendor-device).


pool-param-get

reqd params : uuid, param-name

optional params : param-key, database:

description : Gets the parameter specified of the object. If the parameter is a map of key=value pairs, use ‘param-key=<key>’ to get the value associated with a particular key.


pool-param-list

reqd params : uuid

optional params : database:

description : Lists all the parameters of the object specified by the uuid.




pool-param-remove

reqd params : uuid, param-name, param-key

optional params :

description : Removes a member or a key,value pair from a set/map respectively.


pool-param-set

reqd params : uuid

optional params : name-label, name-description, default-SR, crash-dump-SR, suspend-image-SR, ha-host-failures-to-tolerate, ha-allow-overcommit, wlb-enabled, wlb-verify-cert, policy-no-vendor-device, other-config:, gui-config:, health-check-config:, guest-agent-config:

description : Sets the parameter specified. If param-value is not given, the parameter is set to a null value. To set a (key,value) pair in a map parameter, use the syntax ‘map-param:key=value’.


pool-recover-slaves

reqd params :

optional params :

description : Instruct master to try and reset master-address of all slaves currently running in emergency mode.


pool-restore-database

reqd params : file-name

optional params : dry-run

description : Restore a dump of the pool database to the server.


pool-retrieve-wlb-configuration

reqd params :

optional params :

description : Retrieves the pool optimization criteria from the workload balancing server


pool-retrieve-wlb-diagnostics

reqd params :

optional params : filename

description :


pool-retrieve-wlb-recommendations

reqd params :

optional params :

description : Retrieves vm migrate recommendations for the pool from the workload balancing server


pool-retrieve-wlb-report

reqd params : report

optional params : filename

description :


pool-send-test-post

reqd params : dest-host, dest-port, body

optional params :

description : Send the given body to the given host and port, using HTTPS, and print the response. This is used for debugging the SSL layer.


pool-send-wlb-configuration

reqd params :

optional params : config:

description : Sets the pool optimization criteria for the workload balancing server


pool-sync-database

reqd params :

optional params :

description : Synchronise the current database across all hosts in the pool.


pool-vlan-create

reqd params : pif-uuid, vlan, network-uuid

optional params :

description : Create a new VLAN on each host in a pool.




role-list

reqd params :

optional params : params, database:, uuid, name, description

description : Lists all the roles, filtering on the optional arguments. To filter on map parameters, use the syntax ‘map-param:key=value’


role-param-get

reqd params : uuid, param-name

optional params : param-key, database:

description : Gets the parameter specified of the object. If the parameter is a map of key=value pairs, use ‘param-key=<key>’ to get the value associated with a particular key.


role-param-list

reqd params : uuid

optional params : database:

description : Lists all the parameters of the object specified by the uuid.


secret-create

reqd params : value

optional params :

description : Create a secret


secret-destroy

reqd params : uuid

optional params :

description : Destroy a secret


secret-list

reqd params :

optional params : params, database:, uuid, value

description : Lists all the secrets, filtering on the optional arguments. To filter on map parameters, use the syntax ‘map-param:key=value’


secret-param-clear

reqd params : uuid, param-name

optional params :

description : Clears the specified parameter (param-name can be value).


secret-param-get

reqd params : uuid, param-name

optional params : param-key, database:

description : Gets the parameter specified of the object. If the parameter is a map of key=value pairs, use ‘param-key=<key>’ to get the value associated with a particular key.


secret-param-list

reqd params : uuid

optional params : database:

description : Lists all the parameters of the object specified by the uuid.




secret-param-set

reqd params : uuid

optional params : value

description : Sets the parameter specified. If param-value is not given, the parameter is set to a null value. To set a (key,value) pair in a map parameter, use the syntax ‘map-param:key=value’.


session-subject-identifier-list

reqd params :

optional params :

description : Return a list of all the user subject ids of all externally-authenticated existing sessions


session-subject-identifier-logout

reqd params : subject-identifier

optional params :

description : Log out all externally-authenticated sessions associated to a user subject id


session-subject-identifier-logout-all

reqd params :

optional params :

description : Log out all externally-authenticated sessions


sm-list

reqd params :

optional params : params, database:, uuid, name-label, name-description, type, vendor, copyright, required-api-version, capabilities, features, configuration, driver-filename, required-cluster-stack

description : Lists all the sms, filtering on the optional arguments. To filter on map parameters, use the syntax ‘map-param:key=value’


sm-param-clear

reqd params : uuid, param-name

optional params :

description : Clears the specified parameter (param-name can be features).


sm-param-get

reqd params : uuid, param-name

optional params : param-key, database:

description : Gets the parameter specified of the object. If the parameter is a map of key=value pairs, use ‘param-key=<key>’ to get the value associated with a particular key.


sm-param-list

reqd params : uuid

optional params : database:

description : Lists all the parameters of the object specified by the uuid.


snapshot-clone

reqd params : new-name-label

optional params : uuid, new-name-description

description : Create a new template by cloning an existing snapshot, using storage-level fast disk clone operation where available.


snapshot-copy

reqd params : new-name-label

optional params : uuid, new-name-description, sr-uuid

description : Create a new template by copying an existing VM, but without using storage-level fast disk clone operation (even if this is available). The disk images of the copied VM are guaranteed to be ‘full images’ – i.e. not part of a CoW chain.




snapshot-destroy

reqd params :

optional params : uuid, snapshot-uuid

description : Destroy a snapshot. This leaves the storage associated with the snapshot intact. To delete storage too, use snapshot-uninstall.


snapshot-disk-list

reqd params :

optional params : uuid, snapshot-uuid, vbd-params, vdi-params, <vm-selectors>

description : List the disks on the selected VM(s). The simplest way to select the VM on which the operation is to be performed is by supplying the argument ‘vm=<name or uuid>’. VMs can also be specified by filtering the full list of VMs on the values of fields. For example, specifying ‘power-state=halted’ will select all VMs whose power-state field is equal to ‘halted’. Where multiple VMs are matching, the option ‘–multiple’ must be specified to perform the operation. The full list of fields that can be matched can be obtained by the command ‘xe vm-list params=all’. If no parameters to select VMs are given, the operation will be performed on all VMs.


snapshot-export-to-template

reqd params : filename, snapshot-uuid

optional params : preserve-power-state

description : Export a snapshot to <filename>.


snapshot-list

reqd params :

optional params : params, database:, uuid, name-label, name-description, user-version, is-a-template, is-a-snapshot, snapshot-of, snapshots, snapshot-time, snapshot-info, parent, children, is-control-domain, power-state, memory-actual, memory-target, memory-overhead, memory-static-max, memory-dynamic-max, memory-dynamic-min, memory-static-min, suspend-VDI-uuid, suspend-SR-uuid, VCPUs-params, VCPUs-max, VCPUs-at-startup, actions-after-shutdown, actions-after-reboot, actions-after-crash, console-uuids, platform, allowed-operations, current-operations, blocked-operations, allowed-VBD-devices, allowed-VIF-devices, possible-hosts, HVM-boot-policy, HVM-boot-params, HVM-shadow-multiplier, PV-kernel, PV-ramdisk, PV-args, PV-legacy-args, PV-bootloader, PV-bootloader-args, last-boot-CPU-flags, last-boot-record, resident-on, affinity, other-config, dom-id, recommendations, xenstore-data, ha-always-run, ha-restart-priority, blobs, start-time, install-time, VCPUs-number, VCPUs-utilisation, os-version, PV-drivers-version, PV-drivers-up-to-date, memory, disks, networks, PV-drivers-detected, other, live, guest-metrics-last-updated, can-use-hotplug-vbd, can-use-hotplug-vif, cooperative, tags, appliance, start-delay, shutdown-delay, order, version, generation-id, hardware-platform-version, has-vendor-device, console-uuids:contains, allowed-operations:contains, current-operations:contains, allowed-VBD-devices:contains, allowed-VIF-devices:contains, tags:contains

description : Lists all the snapshots, filtering on the optional arguments. To filter on map parameters, use the syntax ‘map-param:key=value’


snapshot-param-add

reqd params : uuid, param-name

optional params : param-key

description : Adds to a set or map parameter. If the parameter is a set, use param-key=<key to add>. If the parameter is a map, pass the values to add as ‘key=value’ pairs.


snapshot-param-clear

reqd params : uuid, param-name

optional params :

description : Clears the specified parameter (param-name can be name-label,name-description,user-version,is-a-template,memory-static-max,memory-dynamic-max,memory-dynamic-min,memory-static-min,suspend-VDI-uuid,suspend-SR-uuid,VCPUs-params,VCPUs-max,VCPUs-at-startup,actions-after-shutdown,actions-after-reboot,actions-after-crash,console-uuids,platform,allowed-operations,current-operations,blocked-operations,allowed-VBD-devices,allowed-VIF-devices,HVM-boot-policy,HVM-boot-params,HVM-shadow-multiplier,PV-kernel,PV-ramdisk,PV-args,PV-legacy-args,PV-bootloader,PV-bootloader-args,affinity,other-config,xenstore-data,ha-always-run,ha-restart-priority,VCPUs-utilisation,os-version,PV-drivers-version,memory,disks,networks,other,tags,appliance,start-delay,shutdown-delay,order,has-vendor-device).


snapshot-param-get

reqd params : uuid, param-name

optional params : param-key, database:

description : Gets the parameter specified of the object. If the parameter is a map of key=value pairs, use ‘param-key=<key>’ to get the value associated with a particular key.


snapshot-param-list

reqd params : uuid

optional params : database:

description : Lists all the parameters of the object specified by the uuid.


snapshot-param-remove

reqd params : uuid, param-name, param-key

optional params :

description : Removes a member or a key,value pair from a set/map respectively.




snapshot-param-set

reqd params : uuid

optional params : name-label, name-description, user-version, is-a-template, memory-static-max, memory-dynamic-max, memory-dynamic-min, memory-static-min, suspend-VDI-uuid, suspend-SR-uuid, VCPUs-max, VCPUs-at-startup, actions-after-shutdown, actions-after-reboot, actions-after-crash, HVM-boot-policy, HVM-shadow-multiplier, PV-kernel, PV-ramdisk, PV-args, PV-legacy-args, PV-bootloader, PV-bootloader-args, affinity, ha-always-run, ha-restart-priority, appliance, start-delay, shutdown-delay, order, has-vendor-device, VCPUs-params:, platform:, blocked-operations:, HVM-boot-params:, other-config:, xenstore-data:

description : Sets the parameter specified. If param-value is not given, the parameter is set to a null value. To set a (key,value) pair in a map parameter, use the syntax ‘map-param:key=value’.


snapshot-reset-powerstate

reqd params :

optional params : uuid, snapshot-uuid, force, <vm-selectors>

description : Force the VM powerstate to halted in the management toolstack database only. This command is used to recover a snapshot that is marked as ‘suspended’. This is a potentially dangerous operation: you must ensure that you do not need the memory image anymore (ie. you will not be able to resume your snapshot anymore). The simplest way to select the VM on which the operation is to be performed is by supplying the argument ‘vm=<name or uuid>’. VMs can also be specified by filtering the full list of VMs on the values of fields. For example, specifying ‘power-state=halted’ will select all VMs whose power-state field is equal to ‘halted’. Where multiple VMs are matching, the option ‘–multiple’ must be specified to perform the operation. The full list of fields that can be matched can be obtained by the command ‘xe vm-list params=all’. If no parameters to select VMs are given, the operation will be performed on all VMs.


snapshot-revert

reqd params :

optional params : uuid, snapshot-uuid

description : Revert an existing VM to a previous checkpointed or snapshotted state.


snapshot-uninstall

reqd params :

optional params : uuid, snapshot-uuid, force

description : Uninstall a snapshot. This operation will destroy those VDIs that are marked RW and connected to this snapshot only. To simply destroy the VM record, use snapshot-destroy.


sr-create

reqd params : name-label, type

optional params : host-uuid, device-config:, shared, physical-size, content-type, sm-config:

description : Create an SR, also a PBD. the device-config parameters can be specified by e.g. device-config:foo=baa.


sr-data-source-forget

reqd params : data-source

optional params : <sr-selectors>

description : Stop recording the specified data source for a SR, and forget all of the recorded data. The simplest way to select the SR on which the operation is to be performed is by supplying the argument ‘sr=<name or uuid>’. SRs can also be specified by filtering the full list of hosts on the values of fields. For example, specifying ‘enabled=true’ will select all hosts whose ‘enabled’ field is equal to ‘true’. Where multiple SRs are matching, and the operation can be performed on multiple SRs, the option ‘–multiple’ must be specified to perform the operation. The full list of fields that can be matched can be obtained by the command ‘xe sr-list params=all’. If no parameters to select SRs are given, the operation will be performed on all SRs.


sr-data-source-list

reqd params :

optional params : <sr-selectors>

description : List the data sources that can be recorded for a SR. The simplest way to select the SR on which the operation is to be performed is by supplying the argument ‘sr=<name or uuid>’. SRs can also be specified by filtering the full list of hosts on the values of fields. For example, specifying ‘enabled=true’ will select all hosts whose ‘enabled’ field is equal to ‘true’. Where multiple SRs are matching, and the operation can be performed on multiple SRs, the option ‘–multiple’ must be specified to perform the operation. The full list of fields that can be matched can be obtained by the command ‘xe sr-list params=all’. If no parameters to select SRs are given, the operation will be performed on all SRs.


sr-data-source-query

reqd params : data-source

optional params : <sr-selectors>

description : Query the last value read from a SR data source. The simplest way to select the SR on which the operation is to be performed is by supplying the argument ‘sr=<name or uuid>’. SRs can also be specified by filtering the full list of hosts on the values of fields. For example, specifying ‘enabled=true’ will select all hosts whose ‘enabled’ field is equal to ‘true’. Where multiple SRs are matching, and the operation can be performed on multiple SRs, the option ‘–multiple’ must be specified to perform the operation. The full list of fields that can be matched can be obtained by the command ‘xe sr-list params=all’. If no parameters to select SRs are given, the operation will be performed on all SRs.


sr-data-source-record

reqd params : data-source

optional params : <sr-selectors>

description : Record the specified data source for a SR. The simplest way to select the SR on which the operation is to be performed is by supplying the argument ‘sr=<name or uuid>’. SRs can also be specified by filtering the full list of hosts on the values of fields. For example, specifying ‘enabled=true’ will select all hosts whose ‘enabled’ field is equal to ‘true’. Where multiple SRs are matching, and the operation can be performed on multiple SRs, the option ‘–multiple’ must be specified to perform the operation. The full list of fields that can be matched can be obtained by the command ‘xe sr-list params=all’. If no parameters to select SRs are given, the operation will be performed on all SRs.




sr-destroy

reqd params : uuid

optional params :

description : Destroy the SR.


sr-disable-database-replication

reqd params : uuid

optional params :

description : Disable database replication to the SR.


sr-enable-database-replication

reqd params : uuid

optional params :

description : Enable database replication to the SR.


sr-forget

reqd params : uuid

optional params :

description : Forget about the SR.


sr-introduce

reqd params : name-label, type, uuid

optional params : shared, content-type

description : Introduces an SR (but does not create any PBDs).


sr-list

reqd params :

optional params : params, database:, uuid, name-label, name-description, host, allowed-operations, current-operations, VDIs, PBDs, virtual-allocation, physical-utilisation, physical-size, type, content-type, shared, introduced-by, is-tools-sr, other-config, sm-config, blobs, local-cache-enabled, tags, clustered, allowed-operations:contains, current-operations:contains, VDIs:contains, PBDs:contains, tags:contains

description : Lists all the srs, filtering on the optional arguments. To filter on map parameters, use the syntax ‘map-param:key=value’


sr-param-add

reqd params : uuid, param-name

optional params : param-key

description : Adds to a set or map parameter. If the parameter is a set, use param-key=<key to add>. If the parameter is a map, pass the values to add as ‘key=value’ pairs.


sr-param-clear

reqd params : uuid, param-name

optional params :

description : Clears the specified parameter (param-name can be name-label,name-description,allowed-operations,current-operations,VDIs,PBDs,shared,other-config,sm-config,tags).


sr-param-get

reqd params : uuid, param-name

optional params : param-key, database:

description : Gets the parameter specified of the object. If the parameter is a map of key=value pairs, use ‘param-key=<key>’ to get the value associated with a particular key.


sr-param-list

reqd params : uuid

optional params : database:

description : Lists all the parameters of the object specified by the uuid.




sr-param-remove

reqd params : uuid, param-name, param-key

optional params :

description : Removes a member or a key,value pair from a set/map respectively.


sr-param-set

reqd params : uuid

optional params : name-label, name-description, shared, other-config:

description : Sets the parameter specified. If param-value is not given, the parameter is set to a null value. To set a (key,value) pair in a map parameter, use the syntax ‘map-param:key=value’.


sr-probe

reqd params : type

optional params : host-uuid, device-config:, sm-config:

description : Perform a storage probe. The device-config parameters can be specified by e.g. device-config:devs=/dev/sdb1.


sr-scan

reqd params : uuid

optional params :

description : Force an SR scan, syncing database with VDIs present in underlying storage substrate.


sr-update

reqd params : uuid

optional params :

description : Refresh the fields of the SR object in the database.


subject-add

reqd params : subject-name

optional params :

description : Add a subject to the list of subjects that can access the pool


subject-list

reqd params :

optional params : params, database:, uuid, subject-identifier, other-config, roles, roles:contains

description : Lists all the subjects, filtering on the optional arguments. To filter on map parameters, use the syntax ‘map-param:key=value’


subject-param-clear

reqd params : uuid, param-name

optional params :

description : Clears the specified parameter (param-name can be other-config,roles).


subject-param-get

reqd params : uuid, param-name

optional params : param-key, database:

description : Gets the parameter specified of the object. If the parameter is a map of key=value pairs, use ‘param-key=<key>’ to get the value associated with a particular key.




subject-param-list

reqd params : uuid

optional params : database:

description : Lists all the parameters of the object specified by the uuid.


subject-remove

reqd params : subject-uuid

optional params :

description : Remove a subject from the list of subjects that can access the pool


subject-role-add

reqd params : uuid

optional params : role-name, role-uuid

description : Add a role to a subject


subject-role-remove

reqd params : uuid

optional params : role-name, role-uuid

description : Remove a role from a subject


task-cancel

reqd params : uuid

optional params :

description : Set a task to cancelling and return.


task-list

reqd params :

optional params : params, database:, uuid, name-label, name-description, subtask_of, subtasks, resident-on, status, progress, type, result, created, finished, error_info, allowed_operations, other-config

description : Lists all the tasks, filtering on the optional arguments. To filter on map parameters, use the syntax ‘map-param:key=value’


task-param-add

reqd params : uuid, param-name

optional params : param-key

description : Adds to a set or map parameter. If the parameter is a set, use param-key=<key to add>. If the parameter is a map, pass the values to add as ‘key=value’ pairs.


task-param-clear

reqd params : uuid, param-name

optional params :

description : Clears the specified parameter (param-name can be other-config).


task-param-get

reqd params : uuid, param-name

optional params : param-key, database:

description : Gets the parameter specified of the object. If the parameter is a map of key=value pairs, use ‘param-key=<key>’ to get the value associated with a particular key.


task-param-list

reqd params : uuid

optional params : database:

description : Lists all the parameters of the object specified by the uuid.




task-param-remove

reqd params : uuid, param-name, param-key

optional params :

description : Removes a member or a key,value pair from a set/map respectively.


task-param-set

reqd params : uuid

optional params : other-config:

description : Sets the parameter specified. If param-value is not given, the parameter is set to a null value. To set a (key,value) pair in a map parameter, use the syntax ‘map-param:key=value’.


template-export

reqd params : filename, template-uuid

optional params :

description : Export a template to <filename>.


template-list

reqd params :

optional params : params, database:, uuid, name-label, name-description, user-version, is-a-template, is-a-snapshot, snapshot-of, snapshots, snapshot-time, snapshot-info, parent, children, is-control-domain, power-state, memory-actual, memory-target, memory-overhead, memory-static-max, memory-dynamic-max, memory-dynamic-min, memory-static-min, suspend-VDI-uuid, suspend-SR-uuid, VCPUs-params, VCPUs-max, VCPUs-at-startup, actions-after-shutdown, actions-after-reboot, actions-after-crash, console-uuids, platform, allowed-operations, current-operations, blocked-operations, allowed-VBD-devices, allowed-VIF-devices, possible-hosts, HVM-boot-policy, HVM-boot-params, HVM-shadow-multiplier, PV-kernel, PV-ramdisk, PV-args, PV-legacy-args, PV-bootloader, PV-bootloader-args, last-boot-CPU-flags, last-boot-record, resident-on, affinity, other-config, dom-id, recommendations, xenstore-data, ha-always-run, ha-restart-priority, blobs, start-time, install-time, VCPUs-number, VCPUs-utilisation, os-version, PV-drivers-version, PV-drivers-up-to-date, memory, disks, networks, PV-drivers-detected, other, live, guest-metrics-last-updated, can-use-hotplug-vbd, can-use-hotplug-vif, cooperative, tags, appliance, start-delay, shutdown-delay, order, version, generation-id, hardware-platform-version, has-vendor-device, console-uuids:contains, allowed-operations:contains, current-operations:contains, allowed-VBD-devices:contains, allowed-VIF-devices:contains, tags:contains

description : Lists all the templates, filtering on the optional arguments. To filter on map parameters, use the syntax ‘map-param:key=value’


template-param-add

reqd params : uuid, param-name

optional params : param-key

description : Adds to a set or map parameter. If the parameter is a set, use param-key=<key to add>. If the parameter is a map, pass the values to add as ‘key=value’ pairs.


template-param-clear

reqd params : uuid, param-name

optional params :

description : Clears the specified parameter (param-name can be name-label,name-description,user-version,is-a-template,memory-static-max,memory-dynamic-max,memory-dynamic-min,memory-static-min,suspend-VDI-uuid,suspend-SR-uuid,VCPUs-params,VCPUs-max,VCPUs-at-startup,actions-after-shutdown,actions-after-reboot,actions-after-crash,console-uuids,platform,allowed-operations,current-operations,blocked-operations,allowed-VBD-devices,allowed-VIF-devices,HVM-boot-policy,HVM-boot-params,HVM-shadow-multiplier,PV-kernel,PV-ramdisk,PV-args,PV-legacy-args,PV-bootloader,PV-bootloader-args,affinity,other-config,xenstore-data,ha-always-run,ha-restart-priority,VCPUs-utilisation,os-version,PV-drivers-version,memory,disks,networks,other,tags,appliance,start-delay,shutdown-delay,order,has-vendor-device).


template-param-get

reqd params : uuid, param-name

optional params : param-key, database:

description : Gets the parameter specified of the object. If the parameter is a map of key=value pairs, use ‘param-key=<key>’ to get the value associated with a particular key.


template-param-list

reqd params : uuid

optional params : database:

description : Lists all the parameters of the object specified by the uuid.




template-param-remove

reqd params : uuid, param-name, param-key

optional params :

description : Removes a member or a key,value pair from a set/map respectively.


template-param-set

reqd params : uuid

optional params : name-label, name-description, user-version, is-a-template, memory-static-max, memory-dynamic-max, memory-dynamic-min, memory-static-min, suspend-VDI-uuid, suspend-SR-uuid, VCPUs-max, VCPUs-at-startup, actions-after-shutdown, actions-after-reboot, actions-after-crash, HVM-boot-policy, HVM-shadow-multiplier, PV-kernel, PV-ramdisk, PV-args, PV-legacy-args, PV-bootloader, PV-bootloader-args, affinity, ha-always-run, ha-restart-priority, appliance, start-delay, shutdown-delay, order, has-vendor-device, VCPUs-params:, platform:, blocked-operations:, HVM-boot-params:, other-config:, xenstore-data:

description : Sets the parameter specified. If param-value is not given, the parameter is set to a null value. To set a (key,value) pair in a map parameter, use the syntax ‘map-param:key=value’.


template-uninstall

reqd params : template-uuid

optional params : force

description : Uninstall a custom template. This operation will destroy those VDIs that are marked as ‘owned’ by this template


tunnel-create

reqd params : pif-uuid, network-uuid

optional params :

description : Create a new tunnel on a host.


tunnel-destroy

reqd params : uuid

optional params :

description : Destroy a tunnel.


tunnel-list

reqd params :

optional params : params, database:, uuid, access-PIF, transport-PIF, status, other-config

description : Lists all the tunnels, filtering on the optional arguments. To filter on map parameters, use the syntax ‘map-param:key=value’


tunnel-param-add

reqd params : uuid, param-name

optional params : param-key

description : Adds to a set or map parameter. If the parameter is a set, use param-key=<key to add>. If the parameter is a map, pass the values to add as ‘key=value’ pairs.


tunnel-param-clear

reqd params : uuid, param-name

optional params :

description : Clears the specified parameter (param-name can be other-config).


tunnel-param-get

reqd params : uuid, param-name

optional params : param-key, database:

description : Gets the parameter specified of the object. If the parameter is a map of key=value pairs, use ‘param-key=<key>’ to get the value associated with a particular key.


tunnel-param-list

reqd params : uuid

optional params : database:

description : Lists all the parameters of the object specified by the uuid.




tunnel-param-remove

reqd params : uuid, param-name, param-key

optional params :

description : Removes a member or a key,value pair from a set/map respectively.


tunnel-param-set

reqd params : uuid

optional params : other-config:

description : Sets the parameter specified. If param-value is not given, the parameter is set to a null value. To set a (key,value) pair in a map parameter, use the syntax ‘map-param:key=value’.


update-upload

reqd params : file-name, host-uuid

optional params :

description : Stream new update to the server.


user-password-change

reqd params : new

optional params : old

description : Change a user’s login password.


vbd-create

reqd params : vm-uuid, device

optional params : vdi-uuid, bootable, type, mode, unpluggable

description : Create a VBD. Appropriate values for the device field are listed in the parameter ‘allowed-VBD-devices’ on the VM. If no VDI is specified, an empty VBD will be created. The type parameter can be ‘Disk’ or ‘CD’, and the mode is ‘RO’ or ‘RW’.


vbd-destroy

reqd params : uuid

optional params :

description : Destroy a VBD.


vbd-eject

reqd params : uuid

optional params :

description : Remove the media from the drive represented by a VBD.


vbd-insert

reqd params : uuid, vdi-uuid

optional params :

description : Insert new media into the drive represented by a VBD.


vbd-list

reqd params :

optional params : params, database:, uuid, vm-uuid, vm-name-label, vdi-uuid, vdi-name-label, allowed-operations, current-operations, empty, device, userdevice, bootable, mode, type, unpluggable, currently-attached, attachable, storage-lock, status-code, status-detail, qos_algorithm_type, qos_algorithm_params, qos_supported_algorithms, other-config, io_read_kbs, io_write_kbs, allowed-operations:contains, current-operations:contains, qos_supported_algorithms:contains

description : Lists all the vbds, filtering on the optional arguments. To filter on map parameters, use the syntax ‘map-param:key=value’


vbd-param-add

reqd params : uuid, param-name

optional params : param-key

description : Adds to a set or map parameter. If the parameter is a set, use param-key=<key to add>. If the parameter is a map, pass the values to add as ‘key=value’ pairs.


vbd-param-clear

reqd params : uuid, param-name

optional params :

description : Clears the specified parameter (param-name can be allowed-operations,current-operations,userdevice,bootable,mode,type,unpluggable,qos_algorithm_type,qos_algorithm_params,qos_supported_algorithms,other-config).


vbd-param-get

reqd params : uuid, param-name

optional params : param-key, database:

description : Gets the parameter specified of the object. If the parameter is a map of key=value pairs, use ‘param-key=<key>’ to get the value associated with a particular key.




vbd-param-list

reqd params : uuid

optional params : database:

description : Lists all the parameters of the object specified by the uuid.


vbd-param-remove

reqd params : uuid, param-name, param-key

optional params :

description : Removes a member or a key,value pair from a set/map respectively.


vbd-param-set

reqd params : uuid

optional params : userdevice, bootable, mode, type, unpluggable, qos_algorithm_type, qos_algorithm_params:, other-config:

description : Sets the parameter specified. If param-value is not given, the parameter is set to a null value. To set a (key,value) pair in a map parameter, use the syntax ‘map-param:key=value’.


vbd-plug

reqd params : uuid

optional params :

description : Attempt to attach the VBD while the VM is in the running state.


vbd-unplug

reqd params : uuid

optional params : timeout, force

description : Attempt to detach the VBD while the VM is in the running state. If the optional argument ‘timeout=N’ is given then the command will wait for up to ‘N’ seconds for the unplug to complete. If the optional argument ‘force’ is given then it will be immediately unplugged.


vdi-clone

reqd params : uuid

optional params : driver-params-, new-name-label, new-name-description

description : Clone a specified VDI.


vdi-copy

reqd params : uuid

optional params : sr-uuid, base-vdi-uuid, into-vdi-uuid

description : Copy either a full VDI or the block differences between two VDIs either into a fresh VDI in a specified SR or into an existing VDI.


vdi-create

reqd params : sr-uuid, name-label, virtual-size

optional params : sm-config:, sharable, tags:, type

description : Create a VDI. Type is ‘system’ ‘user’ ‘suspend’ or ‘crashdump’.


vdi-destroy

reqd params : uuid

optional params :

description : Destroy a VDI.


vdi-export

reqd params : uuid, filename

optional params : format, base, progress

description : Export a VDI.


vdi-forget

reqd params : uuid

optional params :

description : Forget about a VDI.


vdi-import

reqd params : uuid, filename

optional params : format, progress

description : Import a raw VDI.




vdi-introduce

reqd params : uuid, sr-uuid, type, location

optional params : name-description, sharable, read-only, other-config:, xenstore-data:, sm-config:, name-label

description : Create a VDI object representing an existing disk.


vdi-list

reqd params :

optional params : params, database:, uuid, name-label, name-description, is-a-snapshot, snapshot-of, snapshots, snapshot-time, allowed-operations, current-operations, sr-uuid, sr-name-label, vbd-uuids, crashdump-uuids, virtual-size, physical-utilisation, location, type, sharable, read-only, storage-lock, managed, parent, missing, is-tools-iso, other-config, xenstore-data, sm-config, on-boot, allow-caching, metadata-latest, metadata-of-pool, tags, allowed-operations:contains, current-operations:contains, vbd-uuids:contains, crashdump-uuids:contains, tags:contains

description : Lists all the vdis, filtering on the optional arguments. To filter on map parameters, use the syntax ‘map-param:key=value’


vdi-param-add

reqd params : uuid, param-name

optional params : param-key

description : Adds to a set or map parameter. If the parameter is a set, use param-key=<key to add>. If the parameter is a map, pass the values to add as ‘key=value’ pairs.


vdi-param-clear

reqd params : uuid, param-name

optional params :

description : Clears the specified parameter (param-name can be name-label,name-description,allowed-operations,current-operations,vbd-uuids,crashdump-uuids,other-config,xenstore-data,sm-config,on-boot,allow-caching,tags).


vdi-param-get

reqd params : uuid, param-name

optional params : param-key, database:

description : Gets the parameter specified of the object. If the parameter is a map of key=value pairs, use ‘param-key=<key>’ to get the value associated with a particular key.


vdi-param-list

reqd params : uuid

optional params : database:

description : Lists all the parameters of the object specified by the uuid.


vdi-param-remove

reqd params : uuid, param-name, param-key

optional params :

description : Removes a member or a key,value pair from a set/map respectively.


vdi-param-set

reqd params : uuid

optional params : name-label, name-description, on-boot, allow-caching, other-config:

description : Sets the parameter specified. If param-value is not given, the parameter is set to a null value. To set a (key,value) pair in a map parameter, use the syntax ‘map-param:key=value’.


vdi-pool-migrate

reqd params : uuid, sr-uuid

optional params :

description : Migrate a VDI to a specified SR, while the VDI is attached to a running guest.


vdi-resize

reqd params : uuid, disk-size

optional params : online

description : Resize a VDI.


vdi-snapshot

reqd params : uuid

optional params : driver-params-

description : Snapshot a specified VDI.


vdi-unlock

reqd params : uuid

optional params : force

description : Attempt to unlock a VDI.


vdi-update

reqd params : uuid

optional params :

description : Refresh the fields of the VDI object in the database.


vgpu-create

reqd params : vm-uuid, gpu-group-uuid

optional params : vgpu-type-uuid

description : Create a vGPU.




vgpu-destroy

reqd params : uuid

optional params :

description : Destroy a vGPU.


vgpu-list

reqd params :

optional params : params, database:, uuid, vm-uuid, vm-name-label, gpu-group-uuid, gpu-group-name-label, currently-attached, other-config, type-uuid, type-model-name, resident-on

description : Lists all the vgpus, filtering on the optional arguments. To filter on map parameters, use the syntax ‘map-param:key=value’


vgpu-param-add

reqd params : uuid, param-name

optional params : param-key

description : Adds to a set or map parameter. If the parameter is a set, use param-key=<key to add>. If the parameter is a map, pass the values to add as ‘key=value’ pairs.


vgpu-param-clear

reqd params : uuid, param-name

optional params :

description : Clears the specified parameter (param-name can be other-config).


vgpu-param-get

reqd params : uuid, param-name

optional params : param-key, database:

description : Gets the parameter specified of the object. If the parameter is a map of key=value pairs, use ‘param-key=<key>’ to get the value associated with a particular key.


vgpu-param-list

reqd params : uuid

optional params : database:

description : Lists all the parameters of the object specified by the uuid.


vgpu-param-remove

reqd params : uuid, param-name, param-key

optional params :

description : Removes a member or a key,value pair from a set/map respectively.


vgpu-param-set

reqd params : uuid

optional params : other-config:

description : Sets the parameter specified. If param-value is not given, the parameter is set to a null value. To set a (key,value) pair in a map parameter, use the syntax ‘map-param:key=value’.


vgpu-type-list

reqd params :

optional params : params, database:, uuid, vendor-name, model-name, framebuffer-size, max-heads, max-resolution, supported-on-PGPUs, enabled-on-PGPUs, supported-on-GPU-groups, enabled-on-GPU-groups, VGPU-uuids, experimental

description : Lists all the vgpu-types, filtering on the optional arguments. To filter on map parameters, use the syntax ‘map-param:key=value’


vgpu-type-param-get

reqd params : uuid, param-name

optional params : param-key, database:

description : Gets the parameter specified of the object. If the parameter is a map of key=value pairs, use ‘param-key=<key>’ to get the value associated with a particular key.


vgpu-type-param-list

reqd params : uuid

optional params : database:

description : Lists all the parameters of the object specified by the uuid.


vif-configure-ipv4

reqd params : uuid, mode

optional params : address, gateway

description : Configure IPv4 settings on a VIF.


vif-configure-ipv6

reqd params : uuid, mode

optional params : address, gateway

description : Configure IPv6 settings on a VIF.




vif-create

reqd params : device, network-uuid, vm-uuid

optional params : mac

description : Create a VIF. Appropriate values for the device are listed in the parameter ‘allowed-VIF-devices’ on the VM. If specified, the MAC parameter is of the form aa:bb:cc:dd:ee:ff. If MAC is not specified the server will choose an appropriate MAC automatically.


vif-destroy

reqd params : uuid

optional params :

description : Destroy a VIF.


vif-list

reqd params :

optional params : params, database:, uuid, vm-uuid, vm-name-label, allowed-operations, current-operations, device, MAC, MAC-autogenerated, MTU, currently-attached, qos_algorithm_type, qos_algorithm_params, qos_supported_algorithms, other-config, network-uuid, network-name-label, io_read_kbs, io_write_kbs, locking-mode, ipv4-allowed, ipv6-allowed, ipv4-configuration-mode, ipv4-addresses, ipv4-gateway, ipv6-configuration-mode, ipv6-addresses, ipv6-gateway, allowed-operations:contains, current-operations:contains, qos_supported_algorithms:contains, ipv4-allowed:contains, ipv6-allowed:contains

description : Lists all the vifs, filtering on the optional arguments. To filter on map parameters, use the syntax ‘map-param:key=value’


vif-param-add

reqd params : uuid, param-name

optional params : param-key

description : Adds to a set or map parameter. If the parameter is a set, use param-key=<key to add>. If the parameter is a map, pass the values to add as ‘key=value’ pairs.


vif-param-clear

reqd params : uuid, param-name

optional params :

description : Clears the specified parameter (param-name can be allowed-operations,current-operations,qos_algorithm_type,qos_algorithm_params,qos_supported_algorithms,other-config,locking-mode,ipv4-allowed,ipv6-allowed).


vif-param-get

reqd params : uuid, param-name

optional params : param-key, database:

description : Gets the parameter specified of the object. If the parameter is a map of key=value pairs, use ‘param-key=<key>’ to get the value associated with a particular key.


vif-param-list

reqd params : uuid

optional params : database:

description : Lists all the parameters of the object specified by the uuid.


vif-param-remove

reqd params : uuid, param-name, param-key

optional params :

description : Removes a member or a key,value pair from a set/map respectively.


vif-param-set

reqd params : uuid

optional params : qos_algorithm_type, locking-mode, ipv4-allowed, ipv6-allowed, qos_algorithm_params:, other-config:

description : Sets the parameter specified. If param-value is not given, the parameter is set to a null value. To set a (key,value) pair in a map parameter, use the syntax ‘map-param:key=value’.


vif-plug

reqd params : uuid

optional params :

description : Attempt to attach the VIF while the VM is in the running state.


vif-unplug

reqd params : uuid

optional params : force

description : Attempt to detach the VIF while the VM is in the running state.


vlan-create

reqd params : pif-uuid, vlan, network-uuid

optional params :

description : Create a new VLAN on a host.




vlan-destroy

reqd params : uuid

optional params :

description : Destroy a VLAN.


vlan-list

reqd params :

optional params : params, database:, uuid, tagged-PIF, untagged-PIF, tag

description : Lists all the vlans, filtering on the optional arguments. To filter on map parameters, use the syntax ‘map-param:key=value’


vlan-param-get

reqd params : uuid, param-name

optional params : param-key, database:

description : Gets the parameter specified of the object. If the parameter is a map of key=value pairs, use ‘param-key=<key>’ to get the value associated with a particular key.


vlan-param-list

reqd params : uuid

optional params : database:

description : Lists all the parameters of the object specified by the uuid.


vm-assert-can-be-recovered

reqd params : uuid

optional params : database:

description : Test whether storage is available to recover this VM.


vm-call-plugin

reqd params : vm-uuid, plugin, fn

optional params : args:

description : Calls the function within the plugin on the given vm with optional arguments (args:key=value). To pass a “value” string with special characters in it (e.g. new line), an alternative syntax args:key:file=local_file can be used in place, where the content of local_file will be retrieved and assigned to “key” as a whole.


vm-cd-add

reqd params : cd-name, device

optional params : <vm-selectors>

description : Add a CD to the VM(s). The device field should be selected from the parameter ‘allowed-VBD-devices’ of the VM. The simplest way to select the VM on which the operation is to be performed is by supplying the argument ‘vm=<name or uuid>’. VMs can also be specified by filtering the full list of VMs on the values of fields. For example, specifying ‘power-state=halted’ will select all VMs whose power-state field is equal to ‘halted’. Where multiple VMs are matching, the option ‘–multiple’ must be specified to perform the operation. The full list of fields that can be matched can be obtained by the command ‘xe vm-list params=all’. If no parameters to select VMs are given, the operation will be performed on all VMs.


vm-cd-eject

reqd params :

optional params : <vm-selectors>

description : Eject a CD from the virtual CD drive. This command will only work if there is one and only one CD attached to the VM. When there are two or more CDs, please use the command ‘vbd-eject’ and specify the uuid of the VBD. The simplest way to select the VM on which the operation is to be performed is by supplying the argument ‘vm=<name or uuid>’. VMs can also be specified by filtering the full list of VMs on the values of fields. For example, specifying ‘power-state=halted’ will select all VMs whose power-state field is equal to ‘halted’. Where multiple VMs are matching, the option ‘–multiple’ must be specified to perform the operation. The full list of fields that can be matched can be obtained by the command ‘xe vm-list params=all’. If no parameters to select VMs are given, the operation will be performed on all VMs.


vm-cd-insert

reqd params : cd-name

optional params : <vm-selectors>

description : Insert a CD into the virtual CD drive. This command will only work if there is one and only one empty CD device attached to the VM. When there are two or more empty CD devices, please use the command ‘vbd-insert’ and specify the uuids of the VBD and of the VDI to insert. The simplest way to select the VM on which the operation is to be performed is by supplying the argument ‘vm=<name or uuid>’. VMs can also be specified by filtering the full list of VMs on the values of fields. For example, specifying ‘power-state=halted’ will select all VMs whose power-state field is equal to ‘halted’. Where multiple VMs are matching, the option ‘–multiple’ must be specified to perform the operation. The full list of fields that can be matched can be obtained by the command ‘xe vm-list params=all’. If no parameters to select VMs are given, the operation will be performed on all VMs.


vm-cd-list

reqd params :

optional params : vbd-params, vdi-params, <vm-selectors>

description : List the CDs currently attached to the VM(s). The simplest way to select the VM on which the operation is to be performed is by supplying the argument ‘vm=<name or uuid>’. VMs can also be specified by filtering the full list of VMs on the values of fields. For example, specifying ‘power-state=halted’ will select all VMs whose power-state field is equal to ‘halted’. Where multiple VMs are matching, the option ‘–multiple’ must be specified to perform the operation. The full list of fields that can be matched can be obtained by the command ‘xe vm-list params=all’. If no parameters to select VMs are given, the operation will be performed on all VMs.




vm-cd-remove

reqd params : cd-name

optional params : <vm-selectors>

description : Remove the selected CDs from the VM(s). The simplest way to select the VM on which the operation is to be performed is by supplying the argument ‘vm=<name or uuid>’. VMs can also be specified by filtering the full list of VMs on the values of fields. For example, specifying ‘power-state=halted’ will select all VMs whose power-state field is equal to ‘halted’. Where multiple VMs are matching, the option ‘–multiple’ must be specified to perform the operation. The full list of fields that can be matched can be obtained by the command ‘xe vm-list params=all’. If no parameters to select VMs are given, the operation will be performed on all VMs.


vm-checkpoint

reqd params : new-name-label

optional params : new-name-description, <vm-selectors>

description : Checkpoint an existing VM, using storage-level fast disk snapshot operation where available. The simplest way to select the VM on which the operation is to be performed is by supplying the argument ‘vm=<name or uuid>’. VMs can also be specified by filtering the full list of VMs on the values of fields. For example, specifying ‘power-state=halted’ will select all VMs whose power-state field is equal to ‘halted’. Where multiple VMs are matching, the option ‘–multiple’ must be specified to perform the operation. The full list of fields that can be matched can be obtained by the command ‘xe vm-list params=all’. If no parameters to select VMs are given, the operation will be performed on all VMs.


vm-clone

reqd params : new-name-label

optional params : new-name-description, <vm-selectors>

description : Clone an existing VM, using storage-level fast disk clone operation where available. The simplest way to select the VM on which the operation is to be performed is by supplying the argument ‘vm=<name or uuid>’. VMs can also be specified by filtering the full list of VMs on the values of fields. For example, specifying ‘power-state=halted’ will select all VMs whose power-state field is equal to ‘halted’. Where multiple VMs are matching, the option ‘–multiple’ must be specified to perform the operation. The full list of fields that can be matched can be obtained by the command ‘xe vm-list params=all’. If no parameters to select VMs are given, the operation will be performed on all VMs.


vm-compute-maximum-memory

reqd params : total

optional params : approximate, <vm-selectors>

description : Compute the maximum amount of guest memory given the VM’s configuration. By default give a precise limit, if approximate is set then allow some extra wiggle-room. The simplest way to select the VM on which the operation is to be performed is by supplying the argument ‘vm=<name or uuid>’. VMs can also be specified by filtering the full list of VMs on the values of fields. For example, specifying ‘power-state=halted’ will select all VMs whose power-state field is equal to ‘halted’. Where multiple VMs are matching, the option ‘–multiple’ must be specified to perform the operation. The full list of fields that can be matched can be obtained by the command ‘xe vm-list params=all’. If no parameters to select VMs are given, the operation will be performed on all VMs.


vm-compute-memory-overhead

reqd params :

optional params : <vm-selectors>

description : Computes the virtualization memory overhead of a VM. The simplest way to select the VM on which the operation is to be performed is by supplying the argument ‘vm=<name or uuid>’. VMs can also be specified by filtering the full list of VMs on the values of fields. For example, specifying ‘power-state=halted’ will select all VMs whose power-state field is equal to ‘halted’. Where multiple VMs are matching, the option ‘–multiple’ must be specified to perform the operation. The full list of fields that can be matched can be obtained by the command ‘xe vm-list params=all’. If no parameters to select VMs are given, the operation will be performed on all VMs.


vm-copy

reqd params : new-name-label

optional params : new-name-description, sr-uuid, <vm-selectors>

description : Copy an existing VM, but without using storage-level fast disk clone operation (even if this is available). The disk images of the copied VM are guaranteed to be ‘full images’ – i.e. not part of a CoW chain. The simplest way to select the VM on which the operation is to be performed is by supplying the argument ‘vm=<name or uuid>’. VMs can also be specified by filtering the full list of VMs on the values of fields. For example, specifying ‘power-state=halted’ will select all VMs whose power-state field is equal to ‘halted’. Where multiple VMs are matching, the option ‘–multiple’ must be specified to perform the operation. The full list of fields that can be matched can be obtained by the command ‘xe vm-list params=all’. If no parameters to select VMs are given, the operation will be performed on all VMs.


vm-copy-bios-strings

reqd params : host-uuid

optional params : <vm-selectors>

description : Copy the BIOS strings of the given host to the VM. The simplest way to select the VM on which the operation is to be performed is by supplying the argument ‘vm=<name or uuid>’. VMs can also be specified by filtering the full list of VMs on the values of fields. For example, specifying ‘power-state=halted’ will select all VMs whose power-state field is equal to ‘halted’. Where multiple VMs are matching, the option ‘–multiple’ must be specified to perform the operation. The full list of fields that can be matched can be obtained by the command ‘xe vm-list params=all’. If no parameters to select VMs are given, the operation will be performed on all VMs.


vm-crashdump-list

reqd params :

optional params : <vm-selectors>

description : List crashdumps associated with the selected VM(s). The simplest way to select the VM on which the operation is to be performed is by supplying the argument ‘vm=<name or uuid>’. VMs can also be specified by filtering the full list of VMs on the values of fields. For example, specifying ‘power-state=halted’ will select all VMs whose power-state field is equal to ‘halted’. Where multiple VMs are matching, the option ‘–multiple’ must be specified to perform the operation. The full list of fields that can be matched can be obtained by the command ‘xe vm-list params=all’. If no parameters to select VMs are given, the operation will be performed on all VMs.


vm-data-source-forget

reqd params : data-source

optional params : <vm-selectors>

description : Stop recording the specified data source for a VM, and forget all of the recorded data. The simplest way to select the VM on which the operation is to be performed is by supplying the argument ‘vm=<name or uuid>’. VMs can also be specified by filtering the full list of VMs on the values of fields. For example, specifying ‘power-state=halted’ will select all VMs whose power-state field is equal to ‘halted’. Where multiple VMs are matching, the option ‘–multiple’ must be specified to perform the operation. The full list of fields that can be matched can be obtained by the command ‘xe vm-list params=all’. If no parameters to select VMs are given, the operation will be performed on all VMs.


vm-data-source-list

reqd params :

optional params : <vm-selectors>

description : List the data sources that can be recorded for a VM. The simplest way to select the VM on which the operation is to be performed is by supplying the argument ‘vm=<name or uuid>’. VMs can also be specified by filtering the full list of VMs on the values of fields. For example, specifying ‘power-state=halted’ will select all VMs whose power-state field is equal to ‘halted’. Where multiple VMs are matching, the option ‘–multiple’ must be specified to perform the operation. The full list of fields that can be matched can be obtained by the command ‘xe vm-list params=all’. If no parameters to select VMs are given, the operation will be performed on all VMs.




vm-data-source-query

reqd params : data-source

optional params : <vm-selectors>

description : Query the last value read from a VM data source. The simplest way to select the VM on which the operation is to be performed is by supplying the argument ‘vm=<name or uuid>’. VMs can also be specified by filtering the full list of VMs on the values of fields. For example, specifying ‘power-state=halted’ will select all VMs whose power-state field is equal to ‘halted’. Where multiple VMs are matching, the option ‘–multiple’ must be specified to perform the operation. The full list of fields that can be matched can be obtained by the command ‘xe vm-list params=all’. If no parameters to select VMs are given, the operation will be performed on all VMs.


vm-data-source-record

reqd params : data-source

optional params : <vm-selectors>

description : Record the specified data source for a VM. The simplest way to select the VM on which the operation is to be performed is by supplying the argument ‘vm=<name or uuid>’. VMs can also be specified by filtering the full list of VMs on the values of fields. For example, specifying ‘power-state=halted’ will select all VMs whose power-state field is equal to ‘halted’. Where multiple VMs are matching, the option ‘–multiple’ must be specified to perform the operation. The full list of fields that can be matched can be obtained by the command ‘xe vm-list params=all’. If no parameters to select VMs are given, the operation will be performed on all VMs.


vm-destroy

reqd params : uuid

optional params :

description : Destroy a VM. This leaves the storage associated with the VM intact. To delete storage too, use vm-uninstall.


vm-disk-add

reqd params : disk-size, device

optional params : sr-uuid, <vm-selectors>

description : Add a new disk to the selected VM(s). The device field should be selected from the field ‘allowed-VBD-devices’ of the VM. The simplest way to select the VM on which the operation is to be performed is by supplying the argument ‘vm=<name or uuid>’. VMs can also be specified by filtering the full list of VMs on the values of fields. For example, specifying ‘power-state=halted’ will select all VMs whose power-state field is equal to ‘halted’. Where multiple VMs are matching, the option ‘–multiple’ must be specified to perform the operation. The full list of fields that can be matched can be obtained by the command ‘xe vm-list params=all’. If no parameters to select VMs are given, the operation will be performed on all VMs.


vm-disk-list

reqd params :

optional params : vbd-params, vdi-params, <vm-selectors>

description : List the disks on the selected VM(s). The simplest way to select the VM on which the operation is to be performed is by supplying the argument ‘vm=<name or uuid>’. VMs can also be specified by filtering the full list of VMs on the values of fields. For example, specifying ‘power-state=halted’ will select all VMs whose power-state field is equal to ‘halted’. Where multiple VMs are matching, the option ‘–multiple’ must be specified to perform the operation. The full list of fields that can be matched can be obtained by the command ‘xe vm-list params=all’. If no parameters to select VMs are given, the operation will be performed on all VMs.


vm-disk-remove

reqd params : device

optional params : <vm-selectors>

description : Remove a disk from the selected VM and destroy it. The simplest way to select the VM on which the operation is to be performed is by supplying the argument ‘vm=<name or uuid>’. VMs can also be specified by filtering the full list of VMs on the values of fields. For example, specifying ‘power-state=halted’ will select all VMs whose power-state field is equal to ‘halted’. Where multiple VMs are matching, the option ‘–multiple’ must be specified to perform the operation. The full list of fields that can be matched can be obtained by the command ‘xe vm-list params=all’. If no parameters to select VMs are given, the operation will be performed on all VMs.


vm-export

reqd params : filename

optional params : preserve-power-state, compress, <vm-selectors>

description : Export a VM to <filename>. The simplest way to select the VM on which the operation is to be performed is by supplying the argument ‘vm=<name or uuid>’. VMs can also be specified by filtering the full list of VMs on the values of fields. For example, specifying ‘power-state=halted’ will select all VMs whose power-state field is equal to ‘halted’. Where multiple VMs are matching, the option ‘–multiple’ must be specified to perform the operation. The full list of fields that can be matched can be obtained by the command ‘xe vm-list params=all’. If no parameters to select VMs are given, the operation will be performed on all VMs.


vm-import

reqd params :

optional params : filename, preserve, sr-uuid, force, host-username, host-password, type, remote-config, url, vdi:

description : Import a VM. If type=ESXServer is given, it will import from a VMWare server and ‘host-username’, ‘host-password’ and ‘remote-config’ are required. Otherwise, it will import from a file, and ‘filename’ is required. If the option preserve=true is given then as many settings as possible are restored, including VIF MAC addresses. The default is to regenerate VIF MAC addresses. The VDIs will be imported into the Pool’s default SR unless an override is provided. If the force option is given then any disk data checksum failures will be ignored. If the parameter ‘url’ is specified, xapi will attempt to import from that URL.


vm-install

reqd params : new-name-label

optional params : sr-name-label, sr-uuid, template, copy-bios-strings-from

description : Install a new VM from a template. The template parameter can match either the template name or the uuid.


vm-is-bios-customized

reqd params :

optional params : <vm-selectors>

description : Indicates whether the BIOS strings of the VM have been customized. The simplest way to select the VM on which the operation is to be performed is by supplying the argument ‘vm=<name or uuid>’. VMs can also be specified by filtering the full list of VMs on the values of fields. For example, specifying ‘power-state=halted’ will select all VMs whose power-state field is equal to ‘halted’. Where multiple VMs are matching, the option ‘–multiple’ must be specified to perform the operation. The full list of fields that can be matched can be obtained by the command ‘xe vm-list params=all’. If no parameters to select VMs are given, the operation will be performed on all VMs.




vm-list

reqd params :

optional params : params, database:, uuid, name-label, name-description, user-version, is-a-template, is-a-snapshot, snapshot-of, snapshots, snapshot-time, snapshot-info, parent, children, is-control-domain, power-state, memory-actual, memory-target, memory-overhead, memory-static-max, memory-dynamic-max, memory-dynamic-min, memory-static-min, suspend-VDI-uuid, suspend-SR-uuid, VCPUs-params, VCPUs-max, VCPUs-at-startup, actions-after-shutdown, actions-after-reboot, actions-after-crash, console-uuids, platform, allowed-operations, current-operations, blocked-operations, allowed-VBD-devices, allowed-VIF-devices, possible-hosts, HVM-boot-policy, HVM-boot-params, HVM-shadow-multiplier, PV-kernel, PV-ramdisk, PV-args, PV-legacy-args, PV-bootloader, PV-bootloader-args, last-boot-CPU-flags, last-boot-record, resident-on, affinity, other-config, dom-id, recommendations, xenstore-data, ha-always-run, ha-restart-priority, blobs, start-time, install-time, VCPUs-number, VCPUs-utilisation, os-version, PV-drivers-version, PV-drivers-up-to-date, memory, disks, networks, PV-drivers-detected, other, live, guest-metrics-last-updated, can-use-hotplug-vbd, can-use-hotplug-vif, cooperative, tags, appliance, start-delay, shutdown-delay, order, version, generation-id, hardware-platform-version, has-vendor-device, console-uuids:contains, allowed-operations:contains, current-operations:contains, allowed-VBD-devices:contains, allowed-VIF-devices:contains, tags:contains

description : Lists all the vms, filtering on the optional arguments. To filter on map parameters, use the syntax ‘map-param:key=value’


vm-memory-dynamic-range-set

reqd params : min, max

optional params : <vm-selectors>

description : Configure the dynamic memory range of a VM. The dynamic memory range defines soft lower and upper limits for a VM’s memory. It’s possible to change these fields when a VM is running or halted. The dynamic range must fit within the static range. The simplest way to select the VM on which the operation is to be performed is by supplying the argument ‘vm=<name or uuid>’. VMs can also be specified by filtering the full list of VMs on the values of fields. For example, specifying ‘power-state=halted’ will select all VMs whose power-state field is equal to ‘halted’. Where multiple VMs are matching, the option ‘–multiple’ must be specified to perform the operation. The full list of fields that can be matched can be obtained by the command ‘xe vm-list params=all’. If no parameters to select VMs are given, the operation will be performed on all VMs.


vm-memory-limits-set

reqd params : static-min, static-max, dynamic-min, dynamic-max

optional params : <vm-selectors>

description : Configure the memory limits of a VM. The simplest way to select the VM on which the operation is to be performed is by supplying the argument ‘vm=<name or uuid>’. VMs can also be specified by filtering the full list of VMs on the values of fields. For example, specifying ‘power-state=halted’ will select all VMs whose power-state field is equal to ‘halted’. Where multiple VMs are matching, the option ‘–multiple’ must be specified to perform the operation. The full list of fields that can be matched can be obtained by the command ‘xe vm-list params=all’. If no parameters to select VMs are given, the operation will be performed on all VMs.


vm-memory-shadow-multiplier-set

reqd params : multiplier

optional params : <vm-selectors>

description : Set the shadow memory multiplier of a VM which may be running. The simplest way to select the VM on which the operation is to be performed is by supplying the argument ‘vm=<name or uuid>’. VMs can also be specified by filtering the full list of VMs on the values of fields. For example, specifying ‘power-state=halted’ will select all VMs whose power-state field is equal to ‘halted’. Where multiple VMs are matching, the option ‘–multiple’ must be specified to perform the operation. The full list of fields that can be matched can be obtained by the command ‘xe vm-list params=all’. If no parameters to select VMs are given, the operation will be performed on all VMs.


vm-memory-static-range-set

reqd params : min, max

optional params : <vm-selectors>

description : Configure the static memory range of a VM. The static memory range defines hard lower and upper limits for a VM’s memory. It’s possible to change these fields only when a VM is halted. The static range must encompass the dynamic range. The simplest way to select the VM on which the operation is to be performed is by supplying the argument ‘vm=<name or uuid>’. VMs can also be specified by filtering the full list of VMs on the values of fields. For example, specifying ‘power-state=halted’ will select all VMs whose power-state field is equal to ‘halted’. Where multiple VMs are matching, the option ‘–multiple’ must be specified to perform the operation. The full list of fields that can be matched can be obtained by the command ‘xe vm-list params=all’. If no parameters to select VMs are given, the operation will be performed on all VMs.


vm-memory-target-set

reqd params : target

optional params : <vm-selectors>

description : Set the memory target for a halted or running VM. The given value must be within the range defined by the VM’s memory_static_min and memory_static_max values. The simplest way to select the VM on which the operation is to be performed is by supplying the argument ‘vm=<name or uuid>’. VMs can also be specified by filtering the full list of VMs on the values of fields. For example, specifying ‘power-state=halted’ will select all VMs whose power-state field is equal to ‘halted’. Where multiple VMs are matching, the option ‘–multiple’ must be specified to perform the operation. The full list of fields that can be matched can be obtained by the command ‘xe vm-list params=all’. If no parameters to select VMs are given, the operation will be performed on all VMs.


vm-migrate

reqd params :

optional params : live, host, host-uuid, remote-master, remote-username, remote-password, remote-network, force, copy, vif:, vdi:, <vm-selectors>

description : Migrate the selected VM(s). The parameter ‘–live’ will migrate the VM without shutting it down. The ‘host’ parameter matches can be either the name or the uuid of the host. If you are migrating a VM to a remote pool, you will need to specify the remote-master, remote-username, and remote-password parameters. remote-master is the network address of the master host. To migrate to a particular host within a remote pool, you may additionally specify the host or host-uuid parameters. Also for cross-pool migration, setting ‘copy=true’ will enable the copy mode so that a stopped vm can be copied, instead of migrating, to the destination pool. The vif and vdi mapping parameters take the form ‘vif:<source vif uuid>=<dest network uuid>’ and ‘vdi:<source vdi uuid>=<dest sr uuid>’. Unfortunately, destination uuids cannot be tab-completed. The simplest way to select the VM on which the operation is to be performed is by supplying the argument ‘vm=<name or uuid>’. VMs can also be specified by filtering the full list of VMs on the values of fields. For example, specifying ‘power-state=halted’ will select all VMs whose power-state field is equal to ‘halted’. Where multiple VMs are matching, the option ‘–multiple’ must be specified to perform the operation. The full list of fields that can be matched can be obtained by the command ‘xe vm-list params=all’. If no parameters to select VMs are given, the operation will be performed on all VMs.




vm-param-add

reqd params : uuid, param-name

optional params : param-key

description : Adds to a set or map parameter. If the parameter is a set, use param-key=<key to add>. If the parameter is a map, pass the values to add as ‘key=value’ pairs.


vm-param-clear

reqd params : uuid, param-name

optional params :

description : Clears the specified parameter (param-name can be name-label,name-description,user-version,is-a-template,memory-static-max,memory-dynamic-max,memory-dynamic-min,memory-static-min,suspend-VDI-uuid,suspend-SR-uuid,VCPUs-params,VCPUs-max,VCPUs-at-startup,actions-after-shutdown,actions-after-reboot,actions-after-crash,console-uuids,platform,allowed-operations,current-operations,blocked-operations,allowed-VBD-devices,allowed-VIF-devices,HVM-boot-policy,HVM-boot-params,HVM-shadow-multiplier,PV-kernel,PV-ramdisk,PV-args,PV-legacy-args,PV-bootloader,PV-bootloader-args,affinity,other-config,xenstore-data,ha-always-run,ha-restart-priority,VCPUs-utilisation,os-version,PV-drivers-version,memory,disks,networks,other,tags,appliance,start-delay,shutdown-delay,order,has-vendor-device).


vm-param-get

reqd params : uuid, param-name

optional params : param-key, database:

description : Gets the parameter specified of the object. If the parameter is a map of key=value pairs, use ‘param-key=<key>’ to get the value associated with a particular key.


vm-param-list

reqd params : uuid

optional params : database:

description : Lists all the parameters of the object specified by the uuid.


vm-param-remove

reqd params : uuid, param-name, param-key

optional params :

description : Removes a member or a key,value pair from a set/map respectively.


vm-param-set

reqd params : uuid

optional params : name-label, name-description, user-version, is-a-template, memory-static-max, memory-dynamic-max, memory-dynamic-min, memory-static-min, suspend-VDI-uuid, suspend-SR-uuid, VCPUs-max, VCPUs-at-startup, actions-after-shutdown, actions-after-reboot, actions-after-crash, HVM-boot-policy, HVM-shadow-multiplier, PV-kernel, PV-ramdisk, PV-args, PV-legacy-args, PV-bootloader, PV-bootloader-args, affinity, ha-always-run, ha-restart-priority, appliance, start-delay, shutdown-delay, order, has-vendor-device, VCPUs-params:, platform:, blocked-operations:, HVM-boot-params:, other-config:, xenstore-data:

description : Sets the parameter specified. If param-value is not given, the parameter is set to a null value. To set a (key,value) pair in a map parameter, use the syntax ‘map-param:key=value’.


vm-pause

reqd params :

optional params : <vm-selectors>

description : Pause a running VM. Note this operation does not free the associated memory (see ‘vm-suspend’). The simplest way to select the VM on which the operation is to be performed is by supplying the argument ‘vm=<name or uuid>’. VMs can also be specified by filtering the full list of VMs on the values of fields. For example, specifying ‘power-state=halted’ will select all VMs whose power-state field is equal to ‘halted’. Where multiple VMs are matching, the option ‘–multiple’ must be specified to perform the operation. The full list of fields that can be matched can be obtained by the command ‘xe vm-list params=all’. If no parameters to select VMs are given, the operation will be performed on all VMs.


vm-reboot

reqd params :

optional params : force, <vm-selectors>

description : Reboot the selected VM(s). The simplest way to select the VM on which the operation is to be performed is by supplying the argument ‘vm=<name or uuid>’. VMs can also be specified by filtering the full list of VMs on the values of fields. For example, specifying ‘power-state=halted’ will select all VMs whose power-state field is equal to ‘halted’. Where multiple VMs are matching, the option ‘–multiple’ must be specified to perform the operation. The full list of fields that can be matched can be obtained by the command ‘xe vm-list params=all’. If no parameters to select VMs are given, the operation will be performed on all VMs.


vm-recover

reqd params : uuid

optional params : database:, force

description : Recover a VM from the database contained in the supplied VDI.


vm-reset-powerstate

reqd params :

optional params : force, <vm-selectors>

description : Force the VM powerstate to halted in the management toolstack database only. This command is used to recover a VM that is marked as ‘running’, but is known to be on a dead slave host that will not recover. This is a potentially dangerous operation: you must ensure that the VM you are forcing to ‘halted’ is definitely not running anywhere. The simplest way to select the VM on which the operation is to be performed is by supplying the argument ‘vm=<name or uuid>’. VMs can also be specified by filtering the full list of VMs on the values of fields. For example, specifying ‘power-state=halted’ will select all VMs whose power-state field is equal to ‘halted’. Where multiple VMs are matching, the option ‘–multiple’ must be specified to perform the operation. The full list of fields that can be matched can be obtained by the command ‘xe vm-list params=all’. If no parameters to select VMs are given, the operation will be performed on all VMs.




vm-resume

reqd params :

optional params : force, on, <vm-selectors>

description : Resume the selected VM(s). The simplest way to select the VM on which the operation is to be performed is by supplying the argument ‘vm=<name or uuid>’. VMs can also be specified by filtering the full list of VMs on the values of fields. For example, specifying ‘power-state=halted’ will select all VMs whose power-state field is equal to ‘halted’. Where multiple VMs are matching, the option ‘–multiple’ must be specified to perform the operation. The full list of fields that can be matched can be obtained by the command ‘xe vm-list params=all’. If no parameters to select VMs are given, the operation will be performed on all VMs.


vm-retrieve-wlb-recommendations

reqd params :

optional params : <vm-selectors>

description : Retrieve the workload balancing recommendations for the selected VM. The simplest way to select the VM on which the operation is to be performed is by supplying the argument ‘vm=<name or uuid>’. VMs can also be specified by filtering the full list of VMs on the values of fields. For example, specifying ‘power-state=halted’ will select all VMs whose power-state field is equal to ‘halted’. Where multiple VMs are matching, the option ‘–multiple’ must be specified to perform the operation. The full list of fields that can be matched can be obtained by the command ‘xe vm-list params=all’. If no parameters to select VMs are given, the operation will be performed on all VMs.


vm-shutdown

reqd params :

optional params : force, <vm-selectors>

description : Shutdown the selected VM(s). The optional argument –force will forcibly shut down the VM. The simplest way to select the VM on which the operation is to be performed is by supplying the argument ‘vm=<name or uuid>’. VMs can also be specified by filtering the full list of VMs on the values of fields. For example, specifying ‘power-state=halted’ will select all VMs whose power-state field is equal to ‘halted’. Where multiple VMs are matching, the option ‘–multiple’ must be specified to perform the operation. The full list of fields that can be matched can be obtained by the command ‘xe vm-list params=all’. If no parameters to select VMs are given, the operation will be performed on all VMs.


vm-snapshot

reqd params : new-name-label

optional params : new-name-description, <vm-selectors>

description : Snapshot an existing VM, using storage-level fast disk snapshot operation where available. The simplest way to select the VM on which the operation is to be performed is by supplying the argument ‘vm=<name or uuid>’. VMs can also be specified by filtering the full list of VMs on the values of fields. For example, specifying ‘power-state=halted’ will select all VMs whose power-state field is equal to ‘halted’. Where multiple VMs are matching, the option ‘–multiple’ must be specified to perform the operation. The full list of fields that can be matched can be obtained by the command ‘xe vm-list params=all’. If no parameters to select VMs are given, the operation will be performed on all VMs.


vm-snapshot-with-quiesce

reqd params : new-name-label

optional params : new-name-description, <vm-selectors>

description : Snapshot an existing VM with quiesce, using storage-level fast disk snapshot operation where available. The simplest way to select the VM on which the operation is to be performed is by supplying the argument ‘vm=<name or uuid>’. VMs can also be specified by filtering the full list of VMs on the values of fields. For example, specifying ‘power-state=halted’ will select all VMs whose power-state field is equal to ‘halted’. Where multiple VMs are matching, the option ‘–multiple’ must be specified to perform the operation. The full list of fields that can be matched can be obtained by the command ‘xe vm-list params=all’. If no parameters to select VMs are given, the operation will be performed on all VMs.


vm-start

reqd params :

optional params : force, on, paused, <vm-selectors>

description : Start the selected VM(s). Where pooling is enabled, the host on which to start can be specified with the ‘on’ parameter that takes a uuid. The optional parameter ‘–force’ will bypass any hardware-compatibility warnings. The simplest way to select the VM on which the operation is to be performed is by supplying the argument ‘vm=<name or uuid>’. VMs can also be specified by filtering the full list of VMs on the values of fields. For example, specifying ‘power-state=halted’ will select all VMs whose power-state field is equal to ‘halted’. Where multiple VMs are matching, the option ‘–multiple’ must be specified to perform the operation. The full list of fields that can be matched can be obtained by the command ‘xe vm-list params=all’. If no parameters to select VMs are given, the operation will be performed on all VMs.


vm-suspend

reqd params :

optional params : <vm-selectors>

description : Suspend the selected VM(s). The simplest way to select the VM on which the operation is to be performed is by supplying the argument ‘vm=<name or uuid>’. VMs can also be specified by filtering the full list of VMs on the values of fields. For example, specifying ‘power-state=halted’ will select all VMs whose power-state field is equal to ‘halted’. Where multiple VMs are matching, the option ‘–multiple’ must be specified to perform the operation. The full list of fields that can be matched can be obtained by the command ‘xe vm-list params=all’. If no parameters to select VMs are given, the operation will be performed on all VMs.




vm-uninstall

reqd params :

optional params : force, <vm-selectors>

description : Uninstall a VM. This operation will destroy those VDIs that are marked RW and connected to this VM only. To simply destroy the VM record, use vm-destroy. The simplest way to select the VM on which the operation is to be performed is by supplying the argument ‘vm=<name or uuid>’. VMs can also be specified by filtering the full list of VMs on the values of fields. For example, specifying ‘power-state=halted’ will select all VMs whose power-state field is equal to ‘halted’. Where multiple VMs are matching, the option ‘–multiple’ must be specified to perform the operation. The full list of fields that can be matched can be obtained by the command ‘xe vm-list params=all’. If no parameters to select VMs are given, the operation will be performed on all VMs.


vm-unpause

reqd params :

optional params : <vm-selectors>

description : Unpause a paused VM. The simplest way to select the VM on which the operation is to be performed is by supplying the argument ‘vm=<name or uuid>’. VMs can also be specified by filtering the full list of VMs on the values of fields. For example, specifying ‘power-state=halted’ will select all VMs whose power-state field is equal to ‘halted’. Where multiple VMs are matching, the option ‘–multiple’ must be specified to perform the operation. The full list of fields that can be matched can be obtained by the command ‘xe vm-list params=all’. If no parameters to select VMs are given, the operation will be performed on all VMs.


vm-vcpu-hotplug

reqd params : new-vcpus

optional params : <vm-selectors>

description : Dynamically adjust the number of VCPUs available to running VM. The simplest way to select the VM on which the operation is to be performed is by supplying the argument ‘vm=<name or uuid>’. VMs can also be specified by filtering the full list of VMs on the values of fields. For example, specifying ‘power-state=halted’ will select all VMs whose power-state field is equal to ‘halted’. Where multiple VMs are matching, the option ‘–multiple’ must be specified to perform the operation. The full list of fields that can be matched can be obtained by the command ‘xe vm-list params=all’. If no parameters to select VMs are given, the operation will be performed on all VMs.


vm-vif-list

reqd params :

optional params : <vm-selectors>

description : List the VIFs present on selected VM. The simplest way to select the VM on which the operation is to be performed is by supplying the argument ‘vm=<name or uuid>’. VMs can also be specified by filtering the full list of VMs on the values of fields. For example, specifying ‘power-state=halted’ will select all VMs whose power-state field is equal to ‘halted’. Where multiple VMs are matching, the option ‘–multiple’ must be specified to perform the operation. The full list of fields that can be matched can be obtained by the command ‘xe vm-list params=all’. If no parameters to select VMs are given, the operation will be performed on all VMs.



Comments and Discussions
Linux Forum