Minimum allowed role: pool-operator
First published in XenServer 6.2 SP1 Tech-Preview.
Associates an IPv4 address with this VIF
Minimum allowed role: pool-operator
First published in XenServer 6.1.
Associates an IPv6 address with this VIF
Minimum allowed role: pool-operator
First published in XenServer 6.1.
Give a network a new purpose (if not present already)
Minimum allowed role: pool-admin
First published in XenServer 7.3.
Add a repository to the enabled set
Minimum allowed role: pool-operator
First published in 1.301.0.
Add a key-value pair to the pool-wide guest agent configuration
Minimum allowed role: pool-admin
First published in XenServer 7.0.
Add the given key-value pair to VM.VCPUs_params, and apply that value on the running VM
Minimum allowed role: vm-admin
First published in XenServer 4.0.
Apply the selected update to a host
Minimum allowed role: pool-operator
First published in XenServer 7.1.
Apply an edition to all hosts in the pool
Minimum allowed role: pool-operator
First published in XenServer 6.2.
apply all recommended guidances both on the host and on all HVM VMs on the host after updates are applied on the host
Minimum allowed role: pool-operator
Experimental.
apply updates from current enabled repository on a host
Minimum allowed role: pool-operator
First published in 1.301.0.
Returns an error if the VM is not considered agile e.g.
Throws an error if this VBD could not be attached to this VM if the VM were running.
Assert whether all SRs required to recover this VM are available.
Assert whether all SRs required to recover this VM appliance are available.
Returns an error if the VM could not boot on this host for some reason
Minimum allowed role: read-only
First published in XenServer 4.0.
Check this host can be evacuated.
Returns successfully if the given SR can host an HA statefile.
Assert whether a VM can be migrated to the specified destination.
VM.assertCanMigrateAsync(Connection c,
Map<String,String> dest,
Boolean live,
Map<VDI,SR> vdiMap,
Map<VIF,Network> vifMap,
Map<String,String> options,
Map<VGPU,GPUGroup> vgpuMap)
Assert whether a VM can be migrated to the specified destination.
Check to see whether this operation is acceptable in the current state of the system, raising an error if the operation is invalid for some reason
Minimum allowed role: read-only
First published in XenServer 4.0.
Returns successfully if the given SR supports database replication.
Run xen-bugtool --yestoall and upload the output to support
Minimum allowed role: pool-operator
First published in XenServer 4.0.
Call an API plugin on this host
Minimum allowed role: pool-admin
First published in XenServer 5.0.
Call an API plugin on this vm
Minimum allowed role: vm-operator
First published in XenServer 6.5 SP1.
Request that a task be cancelled.
Copy the TLS CA certificates and CRLs of the master to all slaves.
Checkpoints the specified VM, making a new VM.
Check if the pool is ready to be updated.
Attempt to cleanly shutdown the specified VM (Note: this may not be supported---e.g.
Attempt to cleanly shutdown the specified VM.
Perform a clean shutdown of all the VMs in the appliance
Minimum allowed role: pool-operator
First published in XenServer 6.0.
Computes the amount of free memory on the host.
Computes the virtualization memory overhead of a host.
Computes the virtualization memory overhead of a VM.
Configure IPv4 settings for this virtual interface
Minimum allowed role: vm-operator
First published in XenServer 7.0.
Configure IPv6 settings for this virtual interface
Minimum allowed role: vm-operator
First published in XenServer 7.0.
Configure proxy for RPM package repositories.
Configure periodic update synchronization to sync updates from a remote CDN
Minimum allowed role: pool-operator
Experimental.
Copy either a full VDI or the block differences between two VDIs into either a fresh VDI or an existing VDI.
Copy either a full VDI or the block differences between two VDIs into either a fresh VDI or an existing VDI.
Copied the specified VM, making a new VM.
Copy the BIOS strings from the given host to this VM
Minimum allowed role: vm-admin
First published in XenServer 5.6.
Create a new task object which must be manually destroyed.
Create an interface bond
Minimum allowed role: pool-operator
First published in XenServer 4.1.
Create an interface bond
Minimum allowed role: pool-operator
First published in XenServer 4.1.
Create an interface bond
Minimum allowed role: pool-operator
First published in XenServer 4.1.
Creates a Cluster object and one Cluster_host object as its first member
Minimum allowed role: pool-operator
First published in XenServer 7.6.
Add a new host to an existing cluster.
Create a new console instance, and return its handle.
Create a disaster recovery task which will query the supplied list of devices
Minimum allowed role: pool-operator
First published in XenServer 6.0.
Minimum allowed role: pool-operator
First published in XenServer 6.0.
Create a new network instance, and return its handle.
Enable SR-IOV on the specific PIF.
Create a new Observer instance, and return its handle.
Create a new PBD instance, and return its handle.
Create a new PVS_cache_storage instance, and return its handle.
Configure a VM/VIF to use a PVS proxy
Minimum allowed role: pool-operator
First published in XenServer 7.1.
Create a new secret instance, and return its handle.
Create a new Storage Repository and introduce it into the managed system, creating both SR record and PBD record to attach it to current host (with specified device_config parameters)
Minimum allowed role: pool-operator
First published in XenServer 4.0.
SR.createAsync(Connection c,
Host host,
Map<String,String> deviceConfig,
Long physicalSize,
String nameLabel,
String nameDescription,
String type,
String contentType,
Boolean shared,
Map<String,String> smConfig)
Create a new Storage Repository and introduce it into the managed system, creating both SR record and PBD record to attach it to current host (with specified device_config parameters)
Minimum allowed role: pool-operator
First published in XenServer 4.0.
Create a new subject instance, and return its handle.
Create a tunnel
Minimum allowed role: pool-operator
First published in XenServer 5.6 FP1.
Create a tunnel
Minimum allowed role: pool-operator
First published in XenServer 5.6 FP1.
Minimum allowed role: pool-admin
First published in XenServer 7.3.
Create a new VBD instance, and return its handle.
Create a new VDI instance, and return its handle.
Minimum allowed role: pool-operator
First published in XenServer 6.0.
Minimum allowed role: pool-operator
First published in XenServer 6.0.
Create a new VIF instance, and return its handle.
Create a VLAN mux/demuxer
Minimum allowed role: pool-operator
First published in XenServer 4.1.
NOT RECOMMENDED! VM.clone or VM.copy (or VM.import) is a better choice in almost all situations.
Create a new VM_appliance instance, and return its handle.
Create a new VMSS instance, and return its handle.
Create a new VTPM instance, and return its handle.
Create a new VUSB record in the database only
Minimum allowed role: pool-admin
First published in XenServer 7.3.
Take an exact copy of the VDI and return a reference to the new disk.
Take an exact copy of the VDI and return a reference to the new disk.
Clones the specified VM, making a new VM.
Minimum allowed role: Not Applicable
First published in XenServer 7.0.
Create a placeholder for a named binary blob of data that is associated with this host
Minimum allowed role: pool-operator
First published in XenServer 5.0.
Create a placeholder for a named binary blob of data that is associated with this host
Minimum allowed role: pool-operator
First published in XenServer 5.0.
Create a placeholder for a named binary blob of data that is associated with this pool
Minimum allowed role: pool-operator
First published in XenServer 5.0.
Create a placeholder for a named binary blob of data that is associated with this pool
Minimum allowed role: pool-operator
First published in XenServer 5.0.
Create a placeholder for a named binary blob of data that is associated with this pool
Minimum allowed role: pool-operator
First published in XenServer 5.0.
Create a placeholder for a named binary blob of data that is associated with this pool
Minimum allowed role: pool-operator
First published in XenServer 5.0.
Create a placeholder for a named binary blob of data that is associated with this SR
Minimum allowed role: pool-operator
First published in XenServer 5.0.
Create a placeholder for a named binary blob of data that is associated with this SR
Minimum allowed role: pool-operator
First published in XenServer 5.0.
Create a placeholder for a named binary blob of data that is associated with this VM
Minimum allowed role: vm-power-admin
First published in XenServer 5.0.
Create a placeholder for a named binary blob of data that is associated with this VM
Minimum allowed role: vm-power-admin
First published in XenServer 5.0.
Create PIFs, mapping a network to the same physical interface/VLAN on each host.
Create a pool-wide VLAN by taking the PIF.
Install a TLS CA-issued Certificate Revocation List, pool-wide.
List the names of all installed TLS CA-issued Certificate Revocation Lists.
Remove a pool-wide TLS CA-issued Certificate Revocation List.
Delete the data of the snapshot VDI, but keep its changed block tracking metadata.
Destroy a PIF database record.
PIF.dbIntroduceAsync(Connection c,
String device,
Network network,
Host host,
String MAC,
Long MTU,
Long VLAN,
Boolean physical,
Types.IpConfigurationMode ipConfigurationMode,
String IP,
String netmask,
String gateway,
String DNS,
Bond bondSlaveOf,
VLAN VLANMasterOf,
Boolean management,
Map<String,String> otherConfig,
Boolean disallowUnplug)
Create a new PIF record in the database only
Minimum allowed role: pool-operator
First published in XenServer 5.0.
PIF.dbIntroduceAsync(Connection c,
String device,
Network network,
Host host,
String MAC,
Long MTU,
Long VLAN,
Boolean physical,
Types.IpConfigurationMode ipConfigurationMode,
String IP,
String netmask,
String gateway,
String DNS,
Bond bondSlaveOf,
VLAN VLANMasterOf,
Boolean management,
Map<String,String> otherConfig,
Boolean disallowUnplug,
Types.Ipv6ConfigurationMode ipv6ConfigurationMode,
Set<String> IPv6,
String ipv6Gateway,
Types.PrimaryAddressType primaryAddressType)
Create a new PIF record in the database only
Minimum allowed role: pool-operator
First published in XenServer 5.0.
PIF.dbIntroduceAsync(Connection c,
String device,
Network network,
Host host,
String MAC,
Long MTU,
Long VLAN,
Boolean physical,
Types.IpConfigurationMode ipConfigurationMode,
String IP,
String netmask,
String gateway,
String DNS,
Bond bondSlaveOf,
VLAN VLANMasterOf,
Boolean management,
Map<String,String> otherConfig,
Boolean disallowUnplug,
Types.Ipv6ConfigurationMode ipv6ConfigurationMode,
Set<String> IPv6,
String ipv6Gateway,
Types.PrimaryAddressType primaryAddressType,
Boolean managed)
Create a new PIF record in the database only
Minimum allowed role: pool-operator
First published in XenServer 5.0.
PIF.dbIntroduceAsync(Connection c,
String device,
Network network,
Host host,
String MAC,
Long MTU,
Long VLAN,
Boolean physical,
Types.IpConfigurationMode ipConfigurationMode,
String IP,
String netmask,
String gateway,
String DNS,
Bond bondSlaveOf,
VLAN VLANMasterOf,
Boolean management,
Map<String,String> otherConfig,
Boolean disallowUnplug,
Types.Ipv6ConfigurationMode ipv6ConfigurationMode,
Set<String> IPv6,
String ipv6Gateway,
Types.PrimaryAddressType primaryAddressType,
Boolean managed,
Map<String,String> properties)
Create a new PIF record in the database only
Minimum allowed role: pool-operator
First published in XenServer 5.0.
Declare that a host is dead.
Permanently deconfigures workload balancing monitoring on this pool
Minimum allowed role: pool-operator
First published in XenServer 5.5.
Perform an orderly handover of the role of master to the referenced host.
Destroy an interface bond
Minimum allowed role: pool-operator
First published in XenServer 4.1.
Destroys a Cluster object and the one remaining Cluster_host member
Minimum allowed role: pool-operator
First published in XenServer 7.6.
Remove a host from an existing cluster.
Destroy the specified console instance.
Destroy the specified crashdump
Minimum allowed role: pool-operator
First published in XenServer 4.0.
Destroy the disaster recovery task, detaching and forgetting any SRs introduced which are no longer required
Minimum allowed role: pool-operator
First published in XenServer 6.0.
Minimum allowed role: pool-operator
First published in XenServer 6.0.
Destroy specified host record in database
Minimum allowed role: pool-operator
First published in XenServer 4.0.
Destroy specified host crash dump, removing it from the disk.
Destroy the specified network instance.
Disable SR-IOV on the specific PIF.
Destroy the specified Observer instance.
Destroy the specified PBD instance.
Removes the database entry.
Destroy the specified PVS_cache_storage instance.
remove (or switch off) a PVS proxy for this VM
Minimum allowed role: pool-operator
First published in XenServer 7.1.
Destroy the specified secret instance.
Destroy specified SR, removing SR-record from database and remove SR from disk.
Destroy the specified subject instance.
Destroy a tunnel
Minimum allowed role: pool-operator
First published in XenServer 5.6 FP1.
Minimum allowed role: pool-admin
First published in XenServer 7.3.
Destroy the specified VBD instance.
Destroy the specified VDI instance.
Minimum allowed role: pool-operator
First published in XenServer 6.0.
Destroy the specified VIF instance.
Destroy a VLAN mux/demuxer
Minimum allowed role: pool-operator
First published in XenServer 4.1.
Destroy the specified VM.
Destroy the specified VM_appliance instance.
Destroy the specified VMSS instance.
Destroy the specified VTPM instance, along with its state.
Removes a VUSB record from the database
Minimum allowed role: pool-admin
First published in XenServer 7.3.
Minimum allowed role: pool-operator
Experimental.
Disable cluster membership for an enabled cluster host.
Puts the host into a state in which no new VMs can be started.
Disable changed block tracking for the VDI.
Disable client certificate authentication on the pool
Minimum allowed role: pool-operator
First published in 1.318.0.
Minimum allowed role: pool-operator
First published in XenServer 6.0.
Disable console output to the physical display device next time this host boots
Minimum allowed role: pool-operator
First published in XenServer 6.5 SP1.
Minimum allowed role: pool-operator
First published in XenServer 6.5 SP1.
Turn off High Availability mode
Minimum allowed role: pool-operator
First published in XenServer 4.1.
This call disables pool-wide local storage caching
Minimum allowed role: pool-operator
First published in XenServer 5.6 FP1.
Disable the redo log if in use, unless HA is enabled.
Disable the proxy for RPM package repositories.
Get the host xen dmesg, and clear the buffer.
Instruct a pool master to eject a host from the pool
Minimum allowed role: pool-operator
First published in XenServer 4.0.
Remove the media from the device and leave it empty
Minimum allowed role: vm-operator
First published in XenServer 4.0.
Enable cluster membership for a disabled cluster host.
Puts the host into a state in which new VMs can be started.
Enable changed block tracking for the VDI.
Enable client certificate authentication on the pool
Minimum allowed role: pool-operator
First published in 1.318.0.
Minimum allowed role: pool-operator
First published in XenServer 6.0.
Enable console output to the physical display device next time this host boots
Minimum allowed role: pool-operator
First published in XenServer 6.5 SP1.
Minimum allowed role: pool-operator
First published in XenServer 6.5 SP1.
Turn on High Availability mode
Minimum allowed role: pool-operator
First published in XenServer 4.1.
This call attempts to enable pool-wide local storage caching
Minimum allowed role: pool-operator
First published in XenServer 5.6 FP1.
Enable the redo log on the given SR and start using it, unless HA is enabled.
Upgrades an LVHD SR to enable thin-provisioning.
Migrate all VMs off of this host, where possible.
Migrate all VMs off of this host, where possible.
Remove a host from an existing cluster forcefully.
Destroy the PIF object matching a particular network interface
Minimum allowed role: pool-operator
First published in XenServer 4.1.
forget a PVS server
Minimum allowed role: pool-operator
First published in XenServer 7.1.
Remove a site's meta data
Minimum allowed role: pool-operator
First published in XenServer 7.1.
Remove the repository record from the database
Minimum allowed role: pool-operator
First published in 1.301.0.
Remove the OVS manager of the pool and destroy the db record.
Removing specified SR-record from database, without attempting to remove SR from disk
Minimum allowed role: pool-operator
First published in XenServer 4.0.
Removes a VDI record from the database
Minimum allowed role: vm-admin
First published in XenServer 4.0.
Return a list of all the user subject-identifiers of all existing sessions
Minimum allowed role: read-only
First published in XenServer 5.5.
Get a reference to the task instance with the specified UUID.
This call returns the license state for the pool
Minimum allowed role: read-only
First published in XenServer 6.2.
Get the host's log file
Minimum allowed role: read-only
First published in XenServer 4.0.
Returns the management interface for the specified host
Minimum allowed role: pool-operator
First published in XenServer 6.1.
Returns the network used by the cluster for inter-host communication, i.e.
Return the list of hosts on which this VM may run.
Minimum allowed role: read-only
First published in XenServer 6.2 SP1 Tech-Preview.
Get the number of free SR-IOV VFs on the associated PIF
Minimum allowed role: read-only
First published in XenServer 7.5.
Minimum allowed role: read-only
First published in XenServer 6.2 SP1 Tech-Preview.
Gets xen's sched-gran on a host
Minimum allowed role: Not Applicable
First published in 1.271.0.
Get the installed server public TLS certificate.
List all the SR's that are required for the VM to be recovered
Minimum allowed role: read-only
First published in XenServer 6.5.
Get the list of SRs required by the VM appliance to recover.
Get the subtask_of field of the given task.
Return a set of VMs which prevent the host being evacuated, with per-VM error codes
Minimum allowed role: read-only
First published in XenServer 5.0.
Stop executing the specified VM without attempting a clean shutdown and immediately restart the VM.
Stop executing the specified VM without attempting a clean shutdown.
Perform a hard shutdown of all the VMs in the appliance
Minimum allowed role: pool-operator
First published in XenServer 6.0.
Return true if the extension is available on the host
Minimum allowed role: pool-admin
First published in XenServer 7.1.
Return true if the extension is available on the pool
Minimum allowed role: pool-admin
First published in XenServer 7.0.
Import an XVA from a URI
Minimum allowed role: pool-operator
First published in XenServer 7.0.
Import using a conversion service.
Initializes workload balancing monitoring on this pool with the specified wlb server
Minimum allowed role: pool-operator
First published in XenServer 5.5.
Insert new media into the device
Minimum allowed role: vm-operator
First published in XenServer 4.0.
Install a TLS CA certificate, pool-wide.
Install the TLS server certificate.
Create a PIF object matching a particular network interface
Minimum allowed role: pool-operator
First published in XenServer 4.1.
Create a PIF object matching a particular network interface
Minimum allowed role: pool-operator
First published in XenServer 4.1.
Introduce update VDI
Minimum allowed role: pool-operator
First published in XenServer 7.1.
introduce new PVS server
Minimum allowed role: pool-operator
First published in XenServer 7.1.
Introduce new PVS site
Minimum allowed role: pool-operator
First published in XenServer 7.1.
Add the configuration for a new repository
Minimum allowed role: pool-operator
First published in 1.301.0.
Introduce an SDN controller to the pool.
Introduce a new Storage Repository into the managed system
Minimum allowed role: pool-operator
First published in XenServer 4.0.
Introduce a new Storage Repository into the managed system
Minimum allowed role: pool-operator
First published in XenServer 4.0.
VDI.introduceAsync(Connection c,
String uuid,
String nameLabel,
String nameDescription,
SR SR,
Types.VdiType type,
Boolean sharable,
Boolean readOnly,
Map<String,String> otherConfig,
String location,
Map<String,String> xenstoreData)
Create a new VDI record in the database only
Minimum allowed role: vm-admin
First published in XenServer 4.1.
VDI.introduceAsync(Connection c,
String uuid,
String nameLabel,
String nameDescription,
SR SR,
Types.VdiType type,
Boolean sharable,
Boolean readOnly,
Map<String,String> otherConfig,
String location,
Map<String,String> xenstoreData,
Map<String,String> smConfig)
Create a new VDI record in the database only
Minimum allowed role: vm-admin
First published in XenServer 4.1.
VDI.introduceAsync(Connection c,
String uuid,
String nameLabel,
String nameDescription,
SR SR,
Types.VdiType type,
Boolean sharable,
Boolean readOnly,
Map<String,String> otherConfig,
String location,
Map<String,String> xenstoreData,
Map<String,String> smConfig,
Boolean managed,
Long virtualSize,
Long physicalUtilisation,
Pool metadataOfPool,
Boolean isASnapshot,
Date snapshotTime,
VDI snapshotOf)
Create a new VDI record in the database only
Minimum allowed role: vm-admin
First published in XenServer 4.1.
Instruct host to join a new pool
Minimum allowed role: pool-operator
First published in XenServer 4.0.
Instruct host to join a new pool
Minimum allowed role: pool-operator
First published in XenServer 4.0.
Apply a new license to a host
Minimum allowed role: pool-operator
First published in XenServer 6.5 SP1 Hotfix 31.
Remove any license file from the specified host, and switch that host to the unlicensed edition
Minimum allowed role: pool-operator
First published in XenServer 6.5 SP1 Hotfix 31.
Compare two VDIs in 64k block increments and report which blocks differ.
Log out all sessions associated to a user subject-identifier, except the session associated with the context calling this function
Minimum allowed role: pool-operator
First published in XenServer 5.5.
SR.makeAsync(Connection c,
Host host,
Map<String,String> deviceConfig,
Long physicalSize,
String nameLabel,
String nameDescription,
String type,
String contentType,
Map<String,String> smConfig)
Reconfigure the management network interface
Minimum allowed role: pool-operator
First published in XenServer 4.1.
Reconfigure the management network interface for all Hosts in the Pool
Minimum allowed role: pool-operator
First published in XenServer 7.3.
Returns the maximum amount of guest memory which will fit, together with overheads, in the supplied amount of physical memory.
Prepare to receive a VM, returning a token which can be passed to VM.migrate.
Migrate the VM to another host.
VM.migrateSendAsync(Connection c,
Map<String,String> dest,
Boolean live,
Map<VDI,SR> vdiMap,
Map<VIF,Network> vifMap,
Map<String,String> options,
Map<VGPU,GPUGroup> vgpuMap)
Migrate the VM to another host.
Move the specified VIF to the specified network, even while the VM is running
Minimum allowed role: vm-admin
First published in XenServer 7.1.
Load the metadata found on the supplied VDI and return a session reference which can be used in API calls to query its contents.
Activate the specified PBD, causing the referenced SR to be attached and scanned
Minimum allowed role: pool-operator
First published in XenServer 4.0.
Attempt to bring up a physical interface
Minimum allowed role: pool-operator
First published in XenServer 4.1.
Hotplug the specified VBD, dynamically attaching it to the running VM
Minimum allowed role: vm-admin
First published in XenServer 4.0.
Hotplug the specified VIF, dynamically attaching it to the running VM
Minimum allowed role: vm-admin
First published in XenServer 4.0.
Apply the selected update to all hosts in the pool
Minimum allowed role: pool-operator
First published in XenServer 7.1.
Removes the update's files from all hosts in the pool, but does not revert the update
Minimum allowed role: pool-operator
First published in XenServer 7.1.
Attempt to create a Cluster from the entire pool
Minimum allowed role: pool-operator
First published in XenServer 7.6.
Attempt to destroy the Cluster_host objects for all hosts in the pool and then destroy the Cluster.
Attempt to force destroy the Cluster_host objects, and then destroy the Cluster.
Migrate a VDI, which may be attached to a running guest, to a different SR.
Migrate a VM to another Host.
Resynchronise the cluster_host objects across the pool.
Attempt to power-on the host (if the capability exists).
Reset the power-state of the VM to halted in the database only.
Execute the precheck stage of the selected update on a host
Minimum allowed role: pool-operator
First published in XenServer 7.1.
Perform a backend-specific scan, using the given device_config.
Perform a backend-specific scan, using the given device_config.
Perform a backend-specific scan, using the given device_config.
Inspects the disk configuration contained within the VM's other_config, creates VDIs and VBDs and then executes any applicable post-install script.
Query the system services advertised by this VM and register them.
Check the VDI cache for the pool UUID of the database on this VDI.
Reconfigure the IP address settings for this interface
Minimum allowed role: pool-operator
First published in XenServer 4.1.
Reconfigure the IPv6 address settings for this interface
Minimum allowed role: pool-operator
First published in XenServer 6.1.
Recover the VM
Minimum allowed role: read-only
First published in XenServer 6.0.
Recover the VM appliance
Minimum allowed role: read-only
First published in XenServer 6.0.
Instruct a pool master, M, to try and contact its slaves and, if slaves are in emergency mode, reset their master address to M.
Replace the internal self-signed host certficate with a new one.
Minimum allowed role: pool-operator
First published in XenServer 6.2 SP1 Tech-Preview.
Remove a key-value pair from the pool-wide guest agent configuration
Minimum allowed role: pool-admin
First published in XenServer 7.0.
Removes an IPv4 address from this VIF
Minimum allowed role: pool-operator
First published in XenServer 6.1.
Removes an IPv6 address from this VIF
Minimum allowed role: pool-operator
First published in XenServer 6.1.
Remove a purpose from a network (if present)
Minimum allowed role: pool-admin
First published in XenServer 7.3.
Remove a repository from the enabled set
Minimum allowed role: pool-operator
First published in 1.301.0.
Delete the current TLS server certificate and replace by a new, self-signed one.
Assign a new UUID to telemetry data.
Restarts the agent after a 10 second pause.
Awaken the specified VM and resume it.
Awaken the specified VM and resume it on a particular Host.
Retrieves the pool optimization criteria from the workload balancing server
Minimum allowed role: read-only
First published in XenServer 5.5.
Retrieves recommended host migrations to perform when evacuating the host from the wlb server.
Retrieves vm migrate recommendations for the pool from the workload balancing server
Minimum allowed role: read-only
First published in XenServer 5.5.
Returns mapping of hosts to ratings, indicating the suitability of starting the VM at that location according to wlb.
Reverts the specified VM to a previous state.
Minimum allowed role: pool-admin
First published in Citrix Hypervisor 8.2 Hotfix 2.
Scan for physical interfaces on a host and create PIF objects to represent them
Minimum allowed role: pool-operator
First published in XenServer 4.1.
Minimum allowed role: pool-admin
First published in XenServer 7.3.
Refreshes the list of VDIs associated with an SR
Minimum allowed role: vm-power-admin
First published in XenServer 4.0.
Inject the given string as debugging keys into Xen
Minimum allowed role: pool-admin
First published in XenServer 4.0.
Send the given key as a sysrq to this VM.
Send the given body to the given host and port, using HTTPS, and print the response.
Send the named trigger to this VM.
Sets the pool optimization criteria for the workload balancing server
Minimum allowed role: pool-operator
First published in XenServer 5.5.
Sets the actions_after_crash parameter
Minimum allowed role: vm-admin
First published in XenServer 4.0.
Set the value of the allow_caching parameter.
Assign this VM to an appliance.
Set the attributes of an observer.
Set custom BIOS strings to this VM.
Set the components on which the observer will broadcast to.
Set custom UEFI certificates for a pool and all its hosts.
Set the default locking mode for VIFs attached to this network
Minimum allowed role: pool-operator
First published in XenServer 6.1.
Sets the PBD's device_config field
Minimum allowed role: pool-operator
First published in XenServer 4.1.
Set whether unplugging the PIF is allowed
Minimum allowed role: pool-operator
First published in XenServer 5.0.
Enable / disable this observer which will stop the observer from producing observability information
Minimum allowed role: pool-admin
Experimental.
Minimum allowed role: pool-operator
First published in XenServer 6.2 SP1 Tech-Preview.
Set the file/HTTP endpoints the observer sends data to
Minimum allowed role: pool-admin
Experimental.
Set the file name of the GPG public key of the repository
Minimum allowed role: pool-operator
Experimental.
Minimum allowed role: pool-operator
First published in XenServer 6.2 SP1 Tech-Preview.
Set the maximum number of host failures to consider in the HA VM restart planner
Minimum allowed role: pool-operator
First published in XenServer 5.0.
Controls whether, when the VM starts in HVM mode, its virtual hardware will include the emulated PCI device for which drivers may be available through Windows Update.
Sets the hosts that the observer is to be registered on
Minimum allowed role: pool-admin
Experimental.
updates the host firewall to open or close port 80 depending on the value
Minimum allowed role: pool-operator
Experimental.
updates all the host firewalls in the pool to open or close port 80 depending on the value
Minimum allowed role: pool-operator
Experimental.
Enable or disable IGMP Snooping on the pool.
Set the IPv4 addresses to which traffic on this VIF can be restricted
Minimum allowed role: pool-operator
First published in XenServer 6.1.
Set the IPv6 addresses to which traffic on this VIF can be restricted
Minimum allowed role: pool-operator
First published in XenServer 6.1.
Sets the initiator IQN for the host
Minimum allowed role: pool-operator
First published in XenServer 7.5.
Set the locking mode for this VIF
Minimum allowed role: pool-operator
First published in XenServer 6.1.
Set the memory allocation of this VM.
Set the minimum and maximum amounts of physical memory the VM is allowed to use.
Set the memory limits of this VM.
Set the static (ie boot-time) range of virtual memory that the VM is allowed to use.
Change the bond mode
Minimum allowed role: pool-operator
First published in XenServer 6.0.
Sets the mode of the VBD.
Specifies whether multipathing is enabled
Minimum allowed role: pool-operator
First published in XenServer 7.5.
Set the name description of the SR
Minimum allowed role: pool-operator
First published in XenServer 4.0.
Set the name description of the VDI.
Set the name label of the SR
Minimum allowed role: pool-operator
First published in XenServer 4.0.
Set the name label of the VDI.
Set VM placement NUMA affinity policy
Minimum allowed role: pool-admin
Experimental.
Set the value of the on_boot parameter.
Set this VM's boot order
Minimum allowed role: pool-operator
First published in XenServer 6.0.
Minimum allowed role: pool-admin
First published in XenServer 7.3.
Set the power-on-mode, host, user and password
Minimum allowed role: pool-operator
First published in XenServer 5.6 FP1.
Change the primary address type used by this PIF
Minimum allowed role: pool-operator
First published in XenServer 6.1.
Set the value of a property of the bond
Minimum allowed role: pool-operator
First published in XenServer 6.1.
Set the value of a property of the PIF
Minimum allowed role: pool-operator
First published in XenServer 6.5.
Update the PVS UUID of the PVS site
Minimum allowed role: pool-operator
First published in XenServer 7.1.
Set enabled set of repositories
Minimum allowed role: pool-operator
First published in 1.301.0.
Sets xen's sched-gran on a host.
Set the shadow memory multiplier on a running VM
Minimum allowed role: vm-power-admin
First published in XenServer 4.0.
Sets the shared flag on the SR
Minimum allowed role: pool-operator
First published in XenServer 4.0.
Set this VM's shutdown delay in seconds
Minimum allowed role: pool-operator
First published in XenServer 6.0.
Enable/disable SSLv3 for interoperability with older server versions.
Set this VM's start delay in seconds
Minimum allowed role: pool-operator
First published in XenServer 6.0.
Set this VM's suspend VDI, which must be indentical to its current one
Minimum allowed role: pool-operator
First published in XenServer 6.0.
Set the timestamp for the next telemetry data collection.
enable or disable periodic update synchronization depending on the value
Minimum allowed role: pool-operator
Experimental.
Set the number of VCPUs for a running VM
Minimum allowed role: vm-admin
First published in XenServer 4.0.
Attempts to first clean shutdown a VM and if it should fail then perform a hard shutdown on it.
For each VM in the appliance, try to shut it down cleanly.
Take a read-only snapshot of the VDI, returning a reference to the snapshot.
Take a read-only snapshot of the VDI, returning a reference to the snapshot.
Snapshots the specified VM, making a new VM.
Snapshots the specified VM, making a new VM.
Start all VMs in the appliance
Minimum allowed role: pool-operator
First published in XenServer 6.0.
Start the specified VM on a particular host.
Suspend the specified VM to disk.
Forcibly synchronise the database now
Minimum allowed role: pool-operator
First published in XenServer 4.0.
Sync with the enabled repository
Minimum allowed role: pool-operator
First published in 1.329.0.
Re-configure syslog logging
Minimum allowed role: pool-operator
First published in XenServer 4.1.
Remove a pool-wide TLS CA certificate.
Deactivate the specified PBD, causing the referenced SR to be detached and nolonger scanned
Minimum allowed role: pool-operator
First published in XenServer 4.0.
Attempt to bring down a physical interface
Minimum allowed role: pool-operator
First published in XenServer 4.1.
Hot-unplug the specified VBD, dynamically unattaching it from the running VM
Minimum allowed role: vm-admin
First published in XenServer 4.0.
Hot-unplug the specified VIF, dynamically unattaching it from the running VM
Minimum allowed role: vm-admin
First published in XenServer 4.0.
Unplug the vusb device from the vm.
Forcibly unplug the specified VBD
Minimum allowed role: vm-admin
First published in XenServer 4.0.
Forcibly unplug the specified VIF
Minimum allowed role: vm-admin
First published in XenServer 6.0.
Recomputes the list of acceptable operations
Minimum allowed role: pool-admin
First published in XenServer 4.0.
Refresh the fields on the SR object
Minimum allowed role: pool-operator
First published in XenServer 4.1.1.
Ask the storage backend to refresh the fields in the VDI object
Minimum allowed role: vm-admin
First published in XenServer 4.1.1.
Upload the specified host crash dump to a specified URL
Minimum allowed role: pool-operator
First published in XenServer 4.0.