void
Minimum allowed role: pool-operator
First published in XenServer 6.2 SP1 Tech-Preview.
Minimum allowed role: pool-operator
First published in XenServer 6.2 SP1 Tech-Preview.
void
Associates an IPv4 address with this VIF
Minimum allowed role: pool-operator
First published in XenServer 6.1.
Associates an IPv4 address with this VIF
Minimum allowed role: pool-operator
First published in XenServer 6.1.
void
Associates an IPv6 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.
void
Give a network a new purpose (if not present already)
Minimum allowed role: pool-admin
First published in XenServer 7.3.
Give a network a new purpose (if not present already)
Minimum allowed role: pool-admin
First published in XenServer 7.3.
void
Add a repository to the enabled set
Minimum allowed role: pool-operator
First published in 1.301.0.
Add a repository to the enabled set
Minimum allowed role: pool-operator
First published in 1.301.0.
void
Add the given value to the tags field of the given host.
void
Add the given value to the tags field of the given network.
void
Add the given value to the tags field of the given pool.
void
Add the given value to the tags field of the given SR.
void
Add the given value to the tags field of the given VDI.
void
Add the given value to the tags field of the given VM.
void
void
void
void
void
Add the given key-value pair to the blocked_operations field of the given VM.
void
Add a key-value pair to the pool-wide guest agent configuration
Minimum allowed role: pool-admin
First published in XenServer 7.0.
Add a key-value pair to the pool-wide guest agent configuration
Minimum allowed role: pool-admin
First published in XenServer 7.0.
void
Add the given key-value pair to the guest_VCPUs_params field of the given host.
void
Add the given key-value pair to the gui_config field of the given pool.
void
Add the given key-value pair to the health_check_config field of the given pool.
void
Add the given key-value pair to the HVM/boot_params field of the given VM.
void
Add the given key-value pair to the license_server field of the given host.
void
Add the given key-value pair to the logging field of the given host.
void
Minimum allowed role: vm-admin
First published in Citrix Hypervisor 8.0.
void
Add the given key-value pair to the other_config field of the given Bond.
void
Add the given key-value pair to the other_config field of the given Cluster.
void
Add the given key-value pair to the other_config field of the given console.
void
Add the given key-value pair to the other_config field of the given crashdump.
void
Add the given key-value pair to the other_config field of the given GPU_group.
void
Add the given key-value pair to the other_config field of the given host.
void
Add the given key-value pair to the other_config field of the given host_cpu.
void
Add the given key-value pair to the other_config field of the given host_crashdump.
void
Add the given key-value pair to the other_config field of the given host_metrics.
void
Add the given key-value pair to the other_config field of the given host_patch.
void
Add the given key-value pair to the other_config field of the given network.
void
Add the given key-value pair to the other_config field of the given PBD.
void
Add the given key-value pair to the other_config field of the given PCI.
void
Add the given key-value pair to the other_config field of the given PGPU.
void
Add the given key-value pair to the other_config field of the given PIF.
void
Add the given key-value pair to the other_config field of the given PIF_metrics.
void
Add the given key-value pair to the other_config field of the given pool.
void
Add the given key-value pair to the other_config field of the given pool_patch.
void
Add the given key-value pair to the other_config field of the given pool_update.
void
Add the given key-value pair to the other_config field of the given PUSB.
void
Add the given key-value pair to the other_config field of the given secret.
void
Add the given key-value pair to the other_config field of the given session.
void
Add the given key-value pair to the other_config field of the given SM.
void
Add the given key-value pair to the other_config field of the given SR.
void
Add the given key-value pair to the other_config field of the given task.
void
Add the given key-value pair to the other_config field of the given tunnel.
void
Add the given key-value pair to the other_config field of the given USB_group.
void
Add the given key-value pair to the other_config field of the given user.
void
Add the given key-value pair to the other_config field of the given VBD.
void
void
Add the given key-value pair to the other_config field of the given VDI.
void
Add the given key-value pair to the other_config field of the given VGPU.
void
Add the given key-value pair to the other_config field of the given VIF.
void
Add the given key-value pair to the other_config field of the given VIF_metrics.
void
Add the given key-value pair to the other_config field of the given VLAN.
void
Add the given key-value pair to the other_config field of the given VM.
void
Add the given key-value pair to the other_config field of the given VM_guest_metrics.
void
Add the given key-value pair to the other_config field of the given VM_metrics.
void
Add the given key-value pair to the other_config field of the given VUSB.
void
Add the given key-value pair to the platform field of the given VM.
void
Add the given key-value pair to the qos/algorithm_params field of the given VBD.
void
Add the given key-value pair to the qos/algorithm_params field of the given VIF.
void
This call adds a new role to a subject
Minimum allowed role: pool-admin
First published in XenServer 5.6.
void
Minimum allowed role: pool-operator
First published in XenServer 7.2.
void
Add the given key-value pair to the sm_config field of the given SR.
void
Add the given key-value pair to the sm_config field of the given VDI.
void
Add the given key-value pair to the status field of the given tunnel.
void
Add the given key-value pair to the VCPUs/params field of the given VM.
void
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.
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.
void
Add the given key-value pair to the xenstore_data field of the given VDI.
void
Add the given key-value pair to the xenstore_data field of the given VM.
void
Apply the selected update to a host
Minimum allowed role: pool-operator
First published in XenServer 7.1.
Apply the selected update to a host
Minimum allowed role: pool-operator
First published in XenServer 7.1.
void
Change to another edition, or reactivate the current edition after a license has expired.
void
Change to another edition, or reactivate the current edition after a license has expired.
void
Apply an edition to all hosts in the pool
Minimum allowed role: pool-operator
First published in XenServer 6.2.
Apply an edition to all hosts in the pool
Minimum allowed role: pool-operator
First published in XenServer 6.2.
void
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 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.
apply updates from current enabled repository on a host
Minimum allowed role: pool-operator
First published in 1.301.0.
void
Returns an error if the VM is not considered agile e.g.
Returns an error if the VM is not considered agile e.g.
void
Throws an error if this VBD could not be attached to this VM if the VM were running.
Throws an error if this VBD could not be attached to this VM if the VM were running.
void
Assert whether all SRs required to recover this VM are available.
void
Assert whether all SRs required to recover this VM appliance are available.
Assert whether all SRs required to recover this VM are available.
Assert whether all SRs required to recover this VM appliance are available.
void
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.
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.
void
Check this host can be evacuated.
Check this host can be evacuated.
void
Returns successfully if the given SR can host an HA statefile.
Returns successfully if the given SR can host an HA statefile.
void
Assert whether a VM can be migrated to the specified destination.
void
VM.assertCanMigrate(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.
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.
void
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.
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.
void
Returns successfully if the given SR supports database replication.
Returns successfully if the given SR supports database replication.
void
This causes the RRDs to be backed up to the master
Minimum allowed role: pool-admin
First published in XenServer 5.0.
void
Run xen-bugtool --yestoall and upload the output to support
Minimum allowed role: pool-operator
First published in XenServer 4.0.
Run xen-bugtool --yestoall and upload the output to support
Minimum allowed role: pool-operator
First published in XenServer 4.0.
Call an API extension on this host
Minimum allowed role: pool-admin
First published in XenServer 7.1.
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.
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.
void
Request that a task be cancelled.
Request that a task be cancelled.
static void
static void
Copy the TLS CA certificates and CRLs of the master to all slaves.
Copy the TLS CA certificates and CRLs of the master to all slaves.
static void
static void
Change the account password; if your session is authenticated with root priviledges then the old_pwd is validated and the new_pwd is set regardless
Minimum allowed role: Not Applicable
First published in XenServer 4.0.
Checkpoints the specified VM, making a new VM.
Checkpoints the specified VM, making a new VM.
Check if the pool is ready to be updated.
Check if the pool is ready to be updated.
void
void
void
Attempt to cleanly shutdown the specified VM (Note: this may not be supported---e.g.
Attempt to cleanly shutdown the specified VM (Note: this may not be supported---e.g.
void
Attempt to cleanly shutdown the specified VM.
void
Perform a clean shutdown of all the VMs in the appliance
Minimum allowed role: pool-operator
First published in XenServer 6.0.
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 amount of free memory on the host.
Computes the virtualization memory overhead of a host.
Computes the virtualization memory overhead of a VM.
Computes the virtualization memory overhead of a host.
Computes the virtualization memory overhead of a VM.
void
Configure IPv4 settings for this virtual interface
Minimum allowed role: vm-operator
First published in XenServer 7.0.
Configure IPv4 settings for this virtual interface
Minimum allowed role: vm-operator
First published in XenServer 7.0.
void
Configure IPv6 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.
void
Configure proxy for RPM package repositories.
Configure proxy for RPM package repositories.
void
Configure periodic update synchronization to sync updates from a remote CDN
Minimum allowed role: pool-operator
Experimental.
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 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.
void
Copy the BIOS strings from the given host to this VM
Minimum allowed role: vm-admin
First published in XenServer 5.6.
Copy the BIOS strings from the given host to this VM
Minimum allowed role: vm-admin
First published in XenServer 5.6.
Create a placeholder for a binary blob
Minimum allowed role: pool-operator
First published in XenServer 5.0.
Create a placeholder for a binary blob
Minimum allowed role: pool-operator
First published in XenServer 5.0.
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.
Minimum allowed role: pool-operator
First published in XenServer 5.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.create(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 new task object which must be manually destroyed.
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.
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.
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.
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 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 PIFs, mapping a network to the same physical interface/VLAN on each host.
Create a pool-wide VLAN by taking the PIF.
Create a pool-wide VLAN by taking the PIF.
static void
Install a TLS CA-issued Certificate Revocation List, pool-wide.
Install a TLS CA-issued Certificate Revocation List, pool-wide.
List the names of all installed TLS CA-issued Certificate Revocation Lists.
List the names of all installed TLS CA-issued Certificate Revocation Lists.
static void
Remove a pool-wide TLS CA-issued Certificate Revocation List.
Remove a pool-wide TLS CA-issued Certificate Revocation List.
void
Delete the data of the snapshot VDI, but keep its changed block tracking metadata.
Delete the data of the snapshot VDI, but keep its changed block tracking metadata.
void
Destroy a PIF database record.
Destroy a PIF database record.
PIF.dbIntroduce(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.dbIntroduce(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.dbIntroduce(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.dbIntroduce(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.
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.
void
Declare that a host is dead.
Declare that a host is dead.
static void
Permanently deconfigures workload balancing monitoring on this pool
Minimum allowed role: pool-operator
First published in XenServer 5.5.
Permanently deconfigures workload balancing monitoring on this pool
Minimum allowed role: pool-operator
First published in XenServer 5.5.
static void
Perform an orderly handover of the role of master to the referenced host.
Perform an orderly handover of the role of master to the referenced host.
void
Minimum allowed role: pool-operator
First published in XenServer 5.0.
void
Destroy an interface bond
Minimum allowed role: pool-operator
First published in XenServer 4.1.
void
Destroys a Cluster object and the one remaining Cluster_host member
Minimum allowed role: pool-operator
First published in XenServer 7.6.
void
Remove a host from an existing cluster.
void
Destroy the specified console instance.
void
Destroy the specified crashdump
Minimum allowed role: pool-operator
First published in XenServer 4.0.
void
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.
void
Minimum allowed role: pool-operator
First published in XenServer 6.0.
void
Destroy specified host record in database
Minimum allowed role: pool-operator
First published in XenServer 4.0.
void
Destroy specified host crash dump, removing it from the disk.
void
void
Minimum allowed role: pool-operator
First published in XenServer 5.0.
void
Destroy the specified network instance.
void
Disable SR-IOV on the specific PIF.
void
Destroy the specified Observer instance.
void
Destroy the specified PBD instance.
void
void
void
Removes the database entry.
void
Destroy the specified PVS_cache_storage instance.
void
remove (or switch off) a PVS proxy for this VM
Minimum allowed role: pool-operator
First published in XenServer 7.1.
void
Destroy the specified secret instance.
void
Destroy specified SR, removing SR-record from database and remove SR from disk.
void
Destroy the specified subject instance.
void
Destroy the task object
Minimum allowed role: read-only
First published in XenServer 4.0.
void
Destroy a tunnel
Minimum allowed role: pool-operator
First published in XenServer 5.6 FP1.
void
Minimum allowed role: pool-admin
First published in XenServer 7.3.
void
void
Destroy the specified VBD instance.
void
Destroy the specified VDI instance.
void
Minimum allowed role: pool-operator
First published in XenServer 6.0.
void
Destroy the specified VIF instance.
void
Destroy a VLAN mux/demuxer
Minimum allowed role: pool-operator
First published in XenServer 4.1.
void
Destroy the specified VM.
void
Destroy the specified VM_appliance instance.
void
void
Destroy the specified VMSS instance.
void
Destroy the specified VTPM instance, along with its state.
void
Removes a VUSB record from the database
Minimum allowed role: pool-admin
First published in XenServer 7.3.
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.
static void
Minimum allowed role: pool-operator
Experimental.
Minimum allowed role: pool-operator
Experimental.
void
This call asynchronously detects if the external authentication configuration in any slave is different from that in the master and raises appropriate alerts
Minimum allowed role: pool-operator
First published in XenServer 5.5.
void
Disable cluster membership for an enabled cluster host.
void
Puts the host into a state in which no new VMs can be started.
Disable cluster membership for an enabled cluster host.
Puts the host into a state in which no new VMs can be started.
void
Disable changed block tracking for the VDI.
Disable changed block tracking for the VDI.
void
Disable client certificate authentication on the pool
Minimum allowed role: pool-operator
First published in 1.318.0.
Disable client certificate authentication on the pool
Minimum allowed role: pool-operator
First published in 1.318.0.
void
Minimum allowed role: pool-operator
First published in XenServer 6.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.
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.
Minimum allowed role: pool-operator
First published in XenServer 6.5 SP1.
void
This call disables external authentication on the local host
Minimum allowed role: pool-admin
First published in XenServer 5.5.
void
This call disables external authentication on all the hosts of the pool
Minimum allowed role: pool-admin
First published in XenServer 5.5.
static void
Turn off High Availability mode
Minimum allowed role: pool-operator
First published in XenServer 4.1.
Turn off High Availability mode
Minimum allowed role: pool-operator
First published in XenServer 4.1.
void
Disable the use of a local SR for caching purposes
Minimum allowed role: pool-operator
First published in XenServer 5.6 FP1.
void
This call disables pool-wide local storage caching
Minimum allowed role: pool-operator
First published in XenServer 5.6 FP1.
This call disables pool-wide local storage caching
Minimum allowed role: pool-operator
First published in XenServer 5.6 FP1.
static void
Disable the redo log if in use, unless HA is enabled.
Disable the redo log if in use, unless HA is enabled.
void
Disable the proxy for RPM package repositories.
Disable the proxy for RPM package repositories.
void
Get the host xen dmesg, and clear the buffer.
Get the host xen dmesg, and clear the buffer.
static void
Instruct a pool master to eject a host from the pool
Minimum allowed role: pool-operator
First published in XenServer 4.0.
void
Remove the media from the device and leave it empty
Minimum allowed role: vm-operator
First published in XenServer 4.0.
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.
static void
Disable TLS verification for this host only
Minimum allowed role: Not Applicable
First published in 1.290.0.
static void
This call disables HA on the local host.
static void
Reenable TLS verification for this host only
Minimum allowed role: Not Applicable
First published in 1.298.0.
static void
Instruct a slave already in a pool that the master has changed
Minimum allowed role: pool-operator
First published in XenServer 4.0.
static void
Delete the current TLS server certificate and replace by a new, self-signed one.
static void
Instruct host that's currently a slave to transition to being master
Minimum allowed role: pool-operator
First published in XenServer 4.0.
void
Enable cluster membership for a disabled cluster host.
void
Puts the host into a state in which new VMs can be started.
Enable cluster membership for a disabled cluster host.
Puts the host into a state in which new VMs can be started.
void
Enable changed block tracking for the VDI.
Enable changed block tracking for the VDI.
void
Enable client certificate authentication on the pool
Minimum allowed role: pool-operator
First published in 1.318.0.
Enable client certificate authentication on the pool
Minimum allowed role: pool-operator
First published in 1.318.0.
void
Minimum allowed role: pool-operator
First published in XenServer 6.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.
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.
Minimum allowed role: pool-operator
First published in XenServer 6.5 SP1.
void
This call enables external authentication on a host
Minimum allowed role: pool-admin
First published in XenServer 5.5.
void
This call enables external authentication on all the hosts of the pool
Minimum allowed role: pool-admin
First published in XenServer 5.5.
static void
Turn on High Availability mode
Minimum allowed role: pool-operator
First published in XenServer 4.1.
Turn on High Availability mode
Minimum allowed role: pool-operator
First published in XenServer 4.1.
void
Enable the use of a local SR for caching purposes
Minimum allowed role: pool-operator
First published in XenServer 5.6 FP1.
void
This call attempts to enable pool-wide local storage caching
Minimum allowed role: pool-operator
First published in XenServer 5.6 FP1.
This call attempts to enable pool-wide local storage caching
Minimum allowed role: pool-operator
First published in XenServer 5.6 FP1.
static void
Enable the redo log on the given SR and start using it, unless HA is enabled.
Enable the redo log on the given SR and start using it, unless HA is enabled.
void
Upgrades an LVHD SR to enable thin-provisioning.
Upgrades an LVHD SR to enable thin-provisioning.
static void
Enable TLS server certificate verification
Minimum allowed role: pool-admin
First published in 1.290.0.
void
Migrate all VMs off of this host, where possible.
void
Migrate all VMs off of this host, where possible.
Migrate all VMs off of this host, where possible.
Migrate all VMs off of this host, where possible.
void
Remove a host from an existing cluster forcefully.
Remove a host from an existing cluster forcefully.
void
Destroy the PIF object matching a particular network interface
Minimum allowed role: pool-operator
First published in XenServer 4.1.
void
forget a PVS server
Minimum allowed role: pool-operator
First published in XenServer 7.1.
void
Remove a site's meta data
Minimum allowed role: pool-operator
First published in XenServer 7.1.
void
Remove the repository record from the database
Minimum allowed role: pool-operator
First published in 1.301.0.
void
Remove the OVS manager of the pool and destroy the db record.
void
Removing specified SR-record from database, without attempting to remove SR from disk
Minimum allowed role: pool-operator
First published in XenServer 4.0.
void
Removes a VDI record from the database
Minimum allowed role: vm-admin
First published in XenServer 4.0.
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.
void
Forget the recorded statistics related to the specified data source
Minimum allowed role: pool-operator
First published in XenServer 5.0.
void
Forget the recorded statistics related to the specified data source
Minimum allowed role: pool-operator
First published in XenServer 7.0.
void
Forget the recorded statistics related to the specified data source
Minimum allowed role: vm-admin
First published in XenServer 5.0.
Blocking call which returns a new token and a (possibly empty) batch of events.
Minimum allowed role: read-only
First published in XenServer 5.0.
Get the access_PIF field of the given tunnel.
Get the actions/after_crash field of the given VM.
Get the actions/after_reboot field of the given VM.
Get the actions/after_shutdown field of the given VM.
Get the actions/after_softreboot field of the given VM.
Get the address field of the given host.
Get the address field of the given SDN_controller.
Get the addresses field of the given PVS_server.
Get the affinity field of the given VM.
Get the after_apply_guidance field of the given pool_patch.
Get the after_apply_guidance field of the given pool_update.
Return a list of all the blobs known to the system.
Return a list of all the Bonds known to the system.
Return a list of all the Certificates known to the system.
Return a list of all the Clusters known to the system.
Return a list of all the Cluster_hosts known to the system.
Return a list of all the consoles known to the system.
Return a list of all the DR_tasks known to the system.
Return a list of all the Features known to the system.
Return a list of all the GPU_groups known to the system.
Return a list of all the hosts known to the system.
Return a list of all the host_crashdumps known to the system.
Return a list of all the host_metrics instances known to the system.
Minimum allowed role: read-only
First published in XenServer 5.0.
Return a list of all the networks known to the system.
Return a list of all the network_sriovs known to the system.
Return a list of all the Observers known to the system.
Return a list of all the PBDs known to the system.
Return a list of all the PCIs known to the system.
Return a list of all the PGPUs known to the system.
Return a list of all the PIFs known to the system.
Return a list of all the PIF_metrics instances known to the system.
Return a list of all the pools known to the system.
Return a list of all the pool_updates known to the system.
Return a list of all the PUSBs known to the system.
Return a list of all the PVS_cache_storages known to the system.
Return a list of all the PVS_proxys known to the system.
Return a list of all the PVS_servers known to the system.
Return a list of all the PVS_sites known to the system.
Return a list of all the Repositorys known to the system.
Return a list of all the roles known to the system.
Return a list of all the SDN_controllers known to the system.
Return a list of all the secrets known to the system.
Return a list of all the SMs known to the system.
Return a list of all the SRs known to the system.
Return a list of all the subjects known to the system.
Return a list of all the tasks known to the system.
Return a list of all the tunnels known to the system.
Return a list of all the USB_groups known to the system.
Return a list of all the VBDs known to the system.
Return a list of all the VDIs known to the system.
Return a list of all the VGPUs known to the system.
Return a list of all the VGPU_types known to the system.
Return a list of all the VIFs known to the system.
Return a list of all the VLANs known to the system.
Return a list of all the VMs known to the system.
Return a list of all the VM_appliances known to the system.
Return a list of all the VM_guest_metrics instances known to the system.
Return a list of all the VM_metrics instances known to the system.
Return a list of all the VMSSs known to the system.
Return a list of all the VTPMs known to the system.
Return a list of all the VUSBs known to the system.
Get the allocation_algorithm field of the given GPU_group.
Get the allow_caching field of the given VDI.
Get the allowed_operations field of the given Cluster.
Get the allowed_operations field of the given Cluster_host.
Get the allowed_operations field of the given host.
Get the allowed_operations field of the given network.
Get the allowed_operations field of the given pool.
Get the allowed_operations field of the given SR.
Get the allowed_operations field of the given task.
Get the allowed_operations field of the given VBD.
Get the allowed_operations field of the given VDI.
Get the allowed_operations field of the given VIF.
Get the allowed_operations field of the given VM.
Get the allowed_operations field of the given VM_appliance.
Get the allowed_operations field of the given VTPM.
Get the allowed_operations field of the given VUSB.
Returns a list of the allowed values that a VBD device field can take
Minimum allowed role: read-only
First published in XenServer 4.0.
Returns a list of the allowed values that a VIF device field can take
Minimum allowed role: read-only
First published in XenServer 4.0.
Return a map of blob references to blob records for all blobs known to the system.
Return a map of Bond references to Bond records for all Bonds known to the system.
Return a map of Certificate references to Certificate records for all Certificates known to the system.
Return a map of Cluster references to Cluster records for all Clusters known to the system.
Return a map of Cluster_host references to Cluster_host records for all Cluster_hosts known to the system.
Return a map of console references to console records for all consoles known to the system.
Return a map of crashdump references to crashdump records for all crashdumps known to the system.
Return a map of DR_task references to DR_task records for all DR_tasks known to the system.
Return a map of Feature references to Feature records for all Features known to the system.
Return a map of GPU_group references to GPU_group records for all GPU_groups known to the system.
Return a map of host references to host records for all hosts known to the system.
Return a map of host_cpu references to host_cpu records for all host_cpus known to the system.
Return a map of host_crashdump references to host_crashdump records for all host_crashdumps known to the system.
Return a map of host_metrics references to host_metrics records for all host_metrics instances known to the system.
Return a map of host_patch references to host_patch records for all host_patchs known to the system.
Minimum allowed role: read-only
First published in XenServer 5.0.
Return a map of network references to network records for all networks known to the system.
Return a map of network_sriov references to network_sriov records for all network_sriovs known to the system.
Return a map of Observer references to Observer records for all Observers known to the system.
Return a map of PBD references to PBD records for all PBDs known to the system.
Return a map of PCI references to PCI records for all PCIs known to the system.
Return a map of PGPU references to PGPU records for all PGPUs known to the system.
Return a map of PIF references to PIF records for all PIFs known to the system.
Return a map of PIF_metrics references to PIF_metrics records for all PIF_metrics instances known to the system.
Return a map of pool references to pool records for all pools known to the system.
Return a map of pool_patch references to pool_patch records for all pool_patchs known to the system.
Return a map of pool_update references to pool_update records for all pool_updates known to the system.
Return a map of PUSB references to PUSB records for all PUSBs known to the system.
Return a map of PVS_cache_storage references to PVS_cache_storage records for all PVS_cache_storages known to the system.
Return a map of PVS_proxy references to PVS_proxy records for all PVS_proxys known to the system.
Return a map of PVS_server references to PVS_server records for all PVS_servers known to the system.
Return a map of PVS_site references to PVS_site records for all PVS_sites known to the system.
Return a map of Repository references to Repository records for all Repositorys known to the system.
Return a map of role references to role records for all roles known to the system.
Return a map of SDN_controller references to SDN_controller records for all SDN_controllers known to the system.
Return a map of secret references to secret records for all secrets known to the system.
Return a map of SM references to SM records for all SMs known to the system.
Return a map of SR references to SR records for all SRs known to the system.
Return a map of subject references to subject records for all subjects known to the system.
Return a map of task references to task records for all tasks known to the system.
Return a map of tunnel references to tunnel records for all tunnels known to the system.
Return a map of USB_group references to USB_group records for all USB_groups known to the system.
Return a map of VBD references to VBD records for all VBDs known to the system.
Return a map of VBD_metrics references to VBD_metrics records for all VBD_metrics instances known to the system.
Return a map of VDI references to VDI records for all VDIs known to the system.
Return a map of VGPU references to VGPU records for all VGPUs known to the system.
Return a map of VGPU_type references to VGPU_type records for all VGPU_types known to the system.
Return a map of VIF references to VIF records for all VIFs known to the system.
Return a map of VIF_metrics references to VIF_metrics records for all VIF_metrics instances known to the system.
Return a map of VLAN references to VLAN records for all VLANs known to the system.
Return a map of VM references to VM records for all VMs known to the system.
Return a map of VM_appliance references to VM_appliance records for all VM_appliances known to the system.
Return a map of VM_guest_metrics references to VM_guest_metrics records for all VM_guest_metrics instances known to the system.
Return a map of VM_metrics references to VM_metrics records for all VM_metrics instances known to the system.
Return a map of VMPP references to VMPP records for all VMPPs known to the system.
Return a map of VMSS references to VMSS records for all VMSSs known to the system.
Return a map of VTPM references to VTPM records for all VTPMs known to the system.
Return a map of VUSB references to VUSB records for all VUSBs known to the system.
Minimum allowed role: read-only
First published in XenServer 5.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.
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 the API_version/major field of the given host.
Get the API_version/minor field of the given host.
Get the API_version/vendor field of the given host.
Get the API_version/vendor_implementation field of the given host.
Get the appliance field of the given VM.
Get the applied field of the given host_patch.
Get the assigned_ips field of the given network.
Get the attached_PCIs field of the given VM.
Get the attributes field of the given Observer.
Get the auth_user_name field of the given session.
Get the auth_user_sid field of the given session.
Get the auto_update_mac field of the given Bond.
Get the backend field of the given VTPM.
Get the backtrace field of the given task.
Get the binary_url field of the given Repository.
Get the bios_strings field of the given host.
Get the bios_strings field of the given VM.
Get the blobs field of the given host.
Get the blobs field of the given network.
Get the blobs field of the given pool.
Get the blobs field of the given SR.
Get the blobs field of the given VM.
Get the blocked_operations field of the given VM.
Get the bond_master_of field of the given PIF.
Get the bond_slave_of field of the given PIF.
Get the bootable field of the given VBD.
Get the bridge field of the given network.
Get all the blob instances with the given label.
Get all the Feature instances with the given label.
Get all the GPU_group instances with the given label.
Get all the host instances with the given label.
Get all the network instances with the given label.
Get all the Observer instances with the given label.
Get all the pool_update instances with the given label.
Get all the PVS_site instances with the given label.
Get all the Repository instances with the given label.
Get all the role instances with the given label.
Get all the SM instances with the given label.
Get all the SR instances with the given label.
Get all the task instances with the given label.
Get all the USB_group instances with the given label.
Get all the VDI instances with the given label.
Get all the VM instances with the given label.
Get all the VM_appliance instances with the given label.
Get all the VMSS instances with the given label.
This call returns a list of roles given a permission
Minimum allowed role: read-only
First published in XenServer 5.6.
This call returns a list of roles given a permission name
Minimum allowed role: read-only
First published in XenServer 5.6.
Get a reference to the blob instance with the specified UUID.
Get a reference to the Bond instance with the specified UUID.
Get a reference to the Certificate instance with the specified UUID.
Get a reference to the Cluster instance with the specified UUID.
Get a reference to the Cluster_host instance with the specified UUID.
Get a reference to the console instance with the specified UUID.
Get a reference to the DR_task instance with the specified UUID.
Get a reference to the Feature instance with the specified UUID.
Get a reference to the GPU_group instance with the specified UUID.
Get a reference to the host instance with the specified UUID.
Get a reference to the host_crashdump instance with the specified UUID.
Get a reference to the host_metrics instance with the specified UUID.
Get a reference to the LVHD instance with the specified UUID.
Minimum allowed role: read-only
First published in XenServer 5.0.
Get a reference to the network instance with the specified UUID.
Get a reference to the network_sriov instance with the specified UUID.
Get a reference to the Observer instance with the specified UUID.
Get a reference to the PBD instance with the specified UUID.
Get a reference to the PCI instance with the specified UUID.
Get a reference to the PGPU instance with the specified UUID.
Get a reference to the PIF instance with the specified UUID.
Get a reference to the PIF_metrics instance with the specified UUID.
Get a reference to the pool instance with the specified UUID.
Get a reference to the pool_update instance with the specified UUID.
Get a reference to the PUSB instance with the specified UUID.
Get a reference to the PVS_cache_storage instance with the specified UUID.
Get a reference to the PVS_proxy instance with the specified UUID.
Get a reference to the PVS_server instance with the specified UUID.
Get a reference to the PVS_site instance with the specified UUID.
Get a reference to the Repository instance with the specified UUID.
Get a reference to the role instance with the specified UUID.
Get a reference to the SDN_controller instance with the specified UUID.
Get a reference to the secret instance with the specified UUID.
Get a reference to the session instance with the specified UUID.
Get a reference to the SM instance with the specified UUID.
Get a reference to the SR instance with the specified UUID.
Get a reference to the subject instance with the specified UUID.
Get a reference to the task instance with the specified UUID.
Get a reference to the tunnel instance with the specified UUID.
Get a reference to the USB_group instance with the specified UUID.
Get a reference to the VBD instance with the specified UUID.
Get a reference to the VDI instance with the specified UUID.
Get a reference to the VGPU instance with the specified UUID.
Get a reference to the VGPU_type instance with the specified UUID.
Get a reference to the VIF instance with the specified UUID.
Get a reference to the VLAN instance with the specified UUID.
Get a reference to the VM instance with the specified UUID.
Get a reference to the VM_appliance instance with the specified UUID.
Get a reference to the VM_guest_metrics instance with the specified UUID.
Get a reference to the VM_metrics instance with the specified UUID.
Get a reference to the VMSS instance with the specified UUID.
Get a reference to the VTPM instance with the specified UUID.
Get a reference to the VUSB instance with the specified UUID.
Get the cache_storage field of the given PVS_site.
Get the can_use_hotplug_vbd field of the given VM_guest_metrics.
Get the can_use_hotplug_vif field of the given VM_guest_metrics.
Get the capabilities field of the given host.
Get the capabilities field of the given PIF.
Get the carrier field of the given PIF_metrics.
Get the cbt_enabled field of the given VDI.
Get the certificates field of the given host.
Get the children field of the given VM.
Get the chipset_info field of the given host.
Get the class_name field of the given PCI.
Get the client_certificate field of the given session.
Get the client_certificate_auth_enabled field of the given pool.
Get the client_certificate_auth_name field of the given pool.
Get the cluster field of the given Cluster_host.
Get the cluster_config field of the given Cluster.
Get the clustered field of the given SR.
Get the cluster_hosts field of the given Cluster.
Get the cluster_stack field of the given Cluster.
Get the cluster_token field of the given Cluster.
Get the compatibility_metadata field of the given PGPU.
Get the compatibility_metadata field of the given VGPU.
Get the compatible_types_in_vm field of the given VGPU_type.
Get the components field of the given Observer.
Get the configuration field of the given SM.
Get the configuration_mode field of the given network_sriov.
Get the consoles field of the given VM.
Get the content_type field of the given SR.
Get the control_domain field of the given host.
Get the coordinator_bias field of the given pool.
Get the copyright field of the given SM.
Get the cpu_configuration field of the given host.
Get the cpu_info field of the given host.
Get the cpu_info field of the given pool.
Get the crashdumps field of the given host.
Get the crash_dumps field of the given VDI.
Get the crash_dumps field of the given VM.
Get the crash_dump_sr field of the given host.
Get the crash_dump_SR field of the given pool.
Get the created field of the given task.
Get the current_domain_type field of the given VM_metrics.
Return the ID of the next event to be generated by the system
Minimum allowed role: read-only
First published in XenServer 4.0.
Get the currently_attached field of the given PBD.
Get the currently_attached field of the given PIF.
Get the currently_attached field of the given PVS_proxy.
Get the currently_attached field of the given VBD.
Get the currently_attached field of the given VGPU.
Get the currently_attached field of the given VIF.
Get the currently_attached field of the given VUSB.
Get the current_operations field of the given Cluster.
Get the current_operations field of the given Cluster_host.
Get the current_operations field of the given host.
Get the current_operations field of the given network.
Get the current_operations field of the given pool.
Get the current_operations field of the given SR.
Get the current_operations field of the given task.
Get the current_operations field of the given VBD.
Get the current_operations field of the given VDI.
Get the current_operations field of the given VIF.
Get the current_operations field of the given VM.
Get the current_operations field of the given VM_appliance.
Get the current_operations field of the given VTPM.
Get the current_operations field of the given VUSB.
Get the custom_uefi_certificates field of the given pool.
Minimum allowed role: read-only
First published in XenServer 5.0.
Minimum allowed role: read-only
First published in XenServer 7.0.
Minimum allowed role: read-only
First published in XenServer 5.0.
Get the default_locking_mode field of the given network.
Get the default_SR field of the given pool.
Get the dependencies field of the given PCI.
Get the description field of the given PUSB.
Get the device field of the given PIF.
Get the device field of the given VBD.
Get the device field of the given VGPU.
Get the device field of the given VIF.
Get the device_config field of the given PBD.
Get the device_id field of the given PIF_metrics.
Get the device_name field of the given PCI.
Get the device_name field of the given PIF_metrics.
Get the disallow_unplug field of the given PIF.
Get the display field of the given host.
Get the DNS field of the given PIF.
Get the dom0_access field of the given PGPU.
Get the domain_type field of the given VM.
Get the domarch field of the given VM.
Get the domid field of the given VM.
Get the driver_filename field of the given SM.
Get the driver_name field of the given PCI.
Get the duplex field of the given PIF_metrics.
Get the edition field of the given host.
Get the editions field of the given host.
Get the empty field of the given VBD.
Get the enabled field of the given Cluster_host.
Get the enabled field of the given Feature.
Get the enabled field of the given host.
Get the enabled field of the given Observer.
Get the enabled field of the given VMSS.
Get the enabled_on_GPU_groups field of the given VGPU_type.
Get the enabled_on_PGPUs field of the given VGPU_type.
Get the enabled_VGPU_types field of the given GPU_group.
Get the enabled_VGPU_types field of the given PGPU.
Get the endpoints field of the given Observer.
Get the enforce_homogeneity field of the given pool_update.
Get the error_info field of the given task.
Get the experimental field of the given Feature.
Get the experimental field of the given VGPU_type.
Get the ext_auth_max_threads field of the given pool.
Get the external_auth_configuration field of the given host.
Get the external_auth_service_name field of the given host.
Get the external_auth_type field of the given host.
Get the extra_args field of the given VGPU.
Get the family field of the given host_cpu.
Get the features field of the given host.
Get the features field of the given host_cpu.
Get the features field of the given SM.
Get the fingerprint field of the given Certificate.
Get the finished field of the given task.
Get the first_port field of the given PVS_server.
Get the flags field of the given host_cpu.
Get the framebuffer_size field of the given VGPU_type.
Get the frequency field of the given VMSS.
Get the fullname field of the given user.
Get the gateway field of the given PIF.
Get the generation_id field of the given VM.
Get the gpgkey_path field of the given Repository.
Get the GPU_group field of the given PGPU.
Get the GPU_group field of the given VGPU.
Get the GPU_types field of the given GPU_group.
This calls queries the external directory service to obtain the transitively-closed set of groups that the the subject_identifier is member of.
Get the guest_agent_config field of the given pool.
Get the guest_metrics field of the given VM.
Get the guest_VCPUs_params field of the given host.
Get the gui_config field of the given pool.
Get the ha_allow_overcommit field of the given pool.
Get the ha_cluster_stack field of the given pool.
Get the ha_configuration field of the given pool.
Get the ha_enabled field of the given pool.
Get the ha_host_failures_to_tolerate field of the given pool.
Get the ha_network_peers field of the given host.
Get the ha_overcommitted field of the given pool.
Get the ha_plan_exists_for field of the given pool.
Get the hardware_platform_version field of the given VM.
Get the ha_restart_priority field of the given VM.
Get the hash field of the given Repository.
Get the ha_statefiles field of the given host.
Get the ha_statefiles field of the given pool.
Get the has_vendor_device field of the given VM.
Get the health_check_config field of the given pool.
Get the host field of the given Certificate.
Get the host field of the given Cluster_host.
Get the host field of the given Feature.
Get the host field of the given host_cpu.
Get the host field of the given host_crashdump.
Get the host field of the given host_patch.
Get the host field of the given PBD.
Get the host field of the given PCI.
Get the host field of the given PGPU.
Get the host field of the given PIF.
Get the host field of the given PUSB.
Get the host field of the given PVS_cache_storage.
Get the host_CPUs field of the given host.
Get the hostname field of the given host.
Get the host_patches field of the given pool_patch.
Get the hosts field of the given Observer.
Get the hosts field of the given pool_update.
Get the https_only field of the given host.
Get the hvm field of the given VM_metrics.
Get the HVM/boot_params field of the given VM.
Get the HVM/shadow_multiplier field of the given VM.
Get the identifier field of the given VGPU_type.
Get the igmp_snooping_enabled field of the given pool.
Get the igmp_snooping_status field of the given PIF.
Get the implementation field of the given VGPU_type.
Get the installation_size field of the given pool_update.
Get the install_time field of the given VM_metrics.
Get the introduced_by field of the given SR.
Get the introduced_SRs field of the given DR_task.
Get the IP field of the given PIF.
Get the ip_configuration_mode field of the given PIF.
Get the ipv4_addresses field of the given VIF.
Get the ipv4_allowed field of the given VIF.
Get the ipv4_configuration_mode field of the given VIF.
Get the ipv4_gateway field of the given VIF.
Get the IPv6 field of the given PIF.
Get the ipv6_addresses field of the given VIF.
Get the ipv6_allowed field of the given VIF.
Get the ipv6_configuration_mode field of the given PIF.
Get the ipv6_configuration_mode field of the given VIF.
Get the ipv6_gateway field of the given PIF.
Get the ipv6_gateway field of the given VIF.
Get the is_a_snapshot field of the given VDI.
Get the is_a_snapshot field of the given VM.
Get the is_a_template field of the given VM.
Get the is_control_domain field of the given VM.
Get the iscsi_iqn field of the given host.
Get the is_default_template field of the given VM.
Get the is_internal field of the given role.
Get the is_local_superuser field of the given session.
Get the is_protected field of the given VTPM.
Get the is_psr_pending field of the given pool.
Get the is_system_display_device field of the given PGPU.
Get the is_tools_iso field of the given VDI.
Get the is_tools_sr field of the given SR.
Get the is_unique field of the given VTPM.
Get the is_vmss_snapshot field of the given VM.
Get the joined field of the given Cluster_host.
Get the key field of the given pool_update.
Get the last_active field of the given session.
Get the last_boot_CPU_flags field of the given VM.
Get the last_booted_record field of the given VM.
Get the last_port field of the given PVS_server.
Get the last_run_time field of the given VMSS.
Get the last_software_update field of the given host.
Get the last_updated field of the given blob.
Get the last_updated field of the given host_metrics.
Get the last_updated field of the given PIF_metrics.
Get the last_updated field of the given VIF_metrics.
Get the last_updated field of the given VM_guest_metrics.
Get the last_updated field of the given VM_metrics.
Get the last_update_sync field of the given pool.
Get the latest_synced_updates_applied field of the given host.
Get the license_params field of the given host.
Get the license_server field of the given host.
This call returns the license state for the pool
Minimum allowed role: read-only
First published in XenServer 6.2.
This call returns the license state for the pool
Minimum allowed role: read-only
First published in XenServer 6.2.
Get the links_up field of the given Bond.
Get the live field of the given host_metrics.
Get the live field of the given VM_guest_metrics.
Get the live_patching_disabled field of the given pool.
Get the local_auth_max_threads field of the given pool.
Get the local_cache_enabled field of the given SR.
Get the local_cache_sr field of the given host.
Get the location field of the given console.
Get the location field of the given VDI.
Get the locking_mode field of the given VIF.
Get the host's log file
Minimum allowed role: read-only
First published in XenServer 4.0.
Get the host's log file
Minimum allowed role: read-only
First published in XenServer 4.0.
Get the logging field of the given host.
Get the logical_PIF field of the given network_sriov.
Get the MAC field of the given PIF.
Get the MAC field of the given VIF.
Get the MAC_autogenerated field of the given VIF.
Get the managed field of the given network.
Get the managed field of the given PIF.
Get the managed field of the given VDI.
Get the management field of the given PIF.
Returns the management interface for the specified host
Minimum allowed role: pool-operator
First published in XenServer 6.1.
Returns the management interface for the specified host
Minimum allowed role: pool-operator
First published in XenServer 6.1.
Get the master field of the given Bond.
Get the master field of the given pool.
Get the max_heads field of the given VGPU_type.
Get the max_resolution_x field of the given VGPU_type.
Get the max_resolution_y field of the given VGPU_type.
Get the memory/actual field of the given VM_metrics.
Get the memory/dynamic_max field of the given VM.
Get the memory/dynamic_min field of the given VM.
Get the memory/overhead field of the given host.
Get the memory/overhead field of the given VM.
Get the memory/static_max field of the given VM.
Get the memory/static_min field of the given VM.
Get the memory/total field of the given host_metrics.
Get the metadata_latest field of the given VDI.
Get the metadata_of_pool field of the given VDI.
Get the metadata_VDIs field of the given pool.
Get the metrics field of the given host.
Get the metrics field of the given PIF.
Get the metrics field of the given VM.
Get the migration_compression field of the given pool.
Get the mime_type field of the given blob.
Get the missing field of the given VDI.
Get the mode field of the given Bond.
Get the mode field of the given VBD.
Get the model field of the given host_cpu.
Get the modelname field of the given host_cpu.
Get the model_name field of the given VGPU_type.
Get the MTU field of the given network.
Get the MTU field of the given PIF.
Get the MTU field of the given VIF.
Get the multipathing field of the given host.
Get the name field of the given Certificate.
Get the name/description field of the given blob.
Get the name/description field of the given Feature.
Get the name/description field of the given GPU_group.
Get the name/description field of the given host.
Get the name/description field of the given host_patch.
Get the name/description field of the given network.
Get the name/description field of the given Observer.
Get the name_description field of the given pool.
Get the name/description field of the given pool_patch.
Get the name/description field of the given pool_update.
Get the name/description field of the given PVS_site.
Get the name/description field of the given Repository.
Get the name/description field of the given role.
Get the name/description field of the given SM.
Get the name/description field of the given SR.
Get the name/description field of the given task.
Get the name/description field of the given USB_group.
Get the name/description field of the given VDI.
Get the name/description field of the given VM.
Get the name/description field of the given VM_appliance.
Get the name/description field of the given VMPP.
Get the name/description field of the given VMSS.
Get the name/label field of the given blob.
Get the name/label field of the given Feature.
Get the name/label field of the given GPU_group.
Get the name/label field of the given host.
Get the name/label field of the given host_patch.
Get the name/label field of the given network.
Get the name/label field of the given Observer.
Get the name_label field of the given pool.
Get the name/label field of the given pool_patch.
Get the name/label field of the given pool_update.
Get the name/label field of the given PVS_site.
Get the name/label field of the given Repository.
Get the name/label field of the given role.
Get the name/label field of the given SM.
Get the name/label field of the given SR.
Get the name/label field of the given task.
Get the name/label field of the given USB_group.
Get the name/label field of the given VDI.
Get the name/label field of the given VM.
Get the name/label field of the given VM_appliance.
Get the name/label field of the given VMPP.
Get the name/label field of the given VMSS.
Get details specifying how to access this VDI via a Network Block Device server.
Get the nested_virt field of the given VM_metrics.
Get the netmask field of the given PIF.
Returns the network used by the cluster for inter-host communication, i.e.
Get the network field of the given PIF.
Get the network field of the given VIF.
Returns the network used by the cluster for inter-host communication, i.e.
Get the networks field of the given VM_guest_metrics.
Get the nomigrate field of the given VM_metrics.
Get the not_after field of the given Certificate.
Get the not_before field of the given Certificate.
Get the numa_affinity_policy field of the given host.
Get the number field of the given host_cpu.
Get the NVRAM field of the given VM.
Get the on_boot field of the given VDI.
Get the order field of the given VM.
Get the originator field of the given session.
Get the os_version field of the given VM_guest_metrics.
Get the other field of the given VM_guest_metrics.
Get the other_config field of the given Bond.
Get the other_config field of the given Cluster.
Get the other_config field of the given Cluster_host.
Get the other_config field of the given console.
Get the other_config field of the given crashdump.
Get the other_config field of the given GPU_group.
Get the other_config field of the given host.
Get the other_config field of the given host_cpu.
Get the other_config field of the given host_crashdump.
Get the other_config field of the given host_metrics.
Get the other_config field of the given host_patch.
Get the other_config field of the given network.
Get the other_config field of the given PBD.
Get the other_config field of the given PCI.
Get the other_config field of the given PGPU.
Get the other_config field of the given PIF.
Get the other_config field of the given PIF_metrics.
Get the other_config field of the given pool.
Get the other_config field of the given pool_patch.
Get the other_config field of the given pool_update.
Get the other_config field of the given PUSB.
Get the other_config field of the given secret.
Get the other_config field of the given session.
Get the other_config field of the given SM.
Get the other_config field of the given SR.
Get the other_config field of the given subject.
Get the other_config field of the given task.
Get the other_config field of the given tunnel.
Get the other_config field of the given USB_group.
Get the other_config field of the given user.
Get the other_config field of the given VBD.
Get the other_config field of the given VDI.
Get the other_config field of the given VGPU.
Get the other_config field of the given VIF.
Get the other_config field of the given VIF_metrics.
Get the other_config field of the given VLAN.
Get the other_config field of the given VM.
Get the other_config field of the given VM_guest_metrics.
Get the other_config field of the given VM_metrics.
Get the other_config field of the given VUSB.
Get the parent field of the given session.
Get the parent field of the given VM.
Get the passthrough_enabled field of the given PUSB.
Get the path field of the given PUSB.
Get the PBDs field of the given host.
Get the PBDs field of the given SR.
Get the PCI field of the given PGPU.
Get the PCI field of the given PIF.
Get the PCI field of the given VGPU.
Get the pci_bus_path field of the given PIF_metrics.
Get the pci_id field of the given PCI.
Get the PCIs field of the given host.
Get the pending_forget field of the given Cluster.
Get the pending_guidances field of the given host.
Get the pending_guidances field of the given VM.
This call returns a list of permissions given a role
Minimum allowed role: read-only
First published in XenServer 5.6.
This call returns a list of permission names given a role
Minimum allowed role: read-only
First published in XenServer 5.6.
This call returns a list of permission names given a subject
Minimum allowed role: read-only
First published in XenServer 5.6.
Get the persistence_backend field of the given VTPM.
Get the PGPUs field of the given GPU_group.
Get the PGPUs field of the given host.
Get the physical field of the given PIF.
Get the physical_PIF field of the given network_sriov.
Get the physical_size field of the given SR.
Get the physical_utilisation field of the given SR.
Get the physical_utilisation field of the given VDI.
Get the PIF field of the given Cluster_host.
Get the PIFs field of the given host.
Get the PIFs field of the given network.
Get the platform field of the given VM.
Get the policy_no_vendor_device field of the given pool.
Get the pool field of the given session.
Get the pool_applied field of the given pool_patch.
Get the pool_auto_join field of the given Cluster.
Get the pool_patch field of the given host_patch.
Get the pool_update field of the given pool_patch.
Get the port field of the given SDN_controller.
Return the list of hosts on which this VM may run.
Return the list of hosts on which this VM may run.
Get the power_on_config field of the given host.
Get the power_on_mode field of the given host.
Get the power_state field of the given VM.
Get the primary_address_type field of the given PIF.
Get the primary_slave field of the given Bond.
Get the product_desc field of the given PUSB.
Get the product_id field of the given PUSB.
Get the progress field of the given task.
Get the properties field of the given Bond.
Get the properties field of the given PIF.
Get the protocol field of the given console.
Get the protocol field of the given SDN_controller.
Get the protocol field of the given tunnel.
Get the proxies field of the given PVS_site.
Get the public field of the given blob.
Get the purpose field of the given network.
Get the PUSBs field of the given host.
Get the PUSBs field of the given USB_group.
Get the PV/args field of the given VM.
Get the PV/bootloader field of the given VM.
Get the PV/bootloader_args field of the given VM.
Get the PV_drivers_detected field of the given VM_guest_metrics.
Get the PV_drivers_version field of the given VM_guest_metrics.
Get the PV/kernel field of the given VM.
Get the PV/legacy_args field of the given VM.
Get the PV/ramdisk field of the given VM.
Get the PVS_uuid field of the given PVS_site.
Get the qos/algorithm_params field of the given VBD.
Get the qos/algorithm_params field of the given VIF.
Get the qos/algorithm_type field of the given VBD.
Get the qos/algorithm_type field of the given VIF.
Get the qos/supported_algorithms field of the given VBD.
Get the qos/supported_algorithms field of the given VIF.
Get the rbac_permissions field of the given session.
Get the read_only field of the given VDI.
Get the recommendations field of the given VM.
Get a record containing the current state of the given blob.
Get a record containing the current state of the given Bond.
Get a record containing the current state of the given Certificate.
Get a record containing the current state of the given Cluster.
Get a record containing the current state of the given Cluster_host.
Get a record containing the current state of the given console.
Get a record containing the current state of the given DR_task.
Get a record containing the current state of the given Feature.
Get a record containing the current state of the given GPU_group.
Get a record containing the current state of the given host.
Get a record containing the current state of the given host_crashdump.
Get a record containing the current state of the given host_metrics.
Get a record containing the current state of the given LVHD.
Minimum allowed role: read-only
First published in XenServer 5.0.
Get a record containing the current state of the given network.
Get a record containing the current state of the given network_sriov.
Get a record containing the current state of the given Observer.
Get a record containing the current state of the given PBD.
Get a record containing the current state of the given PCI.
Get a record containing the current state of the given PGPU.
Get a record containing the current state of the given PIF.
Get a record containing the current state of the given PIF_metrics.
Get a record containing the current state of the given pool.
Get a record containing the current state of the given pool_update.
Get a record containing the current state of the given PUSB.
Get a record containing the current state of the given PVS_cache_storage.
Get a record containing the current state of the given PVS_proxy.
Get a record containing the current state of the given PVS_server.
Get a record containing the current state of the given PVS_site.
Get a record containing the current state of the given Repository.
Get a record containing the current state of the given role.
Get a record containing the current state of the given SDN_controller.
Get a record containing the current state of the given secret.
Get a record containing the current state of the given session.
Get a record containing the current state of the given SM.
Get a record containing the current state of the given SR.
Get a record containing the current state of the given subject.
Get a record containing the current state of the given task.
Get a record containing the current state of the given tunnel.
Get a record containing the current state of the given USB_group.
Get a record containing the current state of the given VBD.
Get a record containing the current state of the given VDI.
Get a record containing the current state of the given VGPU.
Get a record containing the current state of the given VGPU_type.
Get a record containing the current state of the given VIF.
Get a record containing the current state of the given VLAN.
Get a record containing the current state of the given VM.
Get a record containing the current state of the given VM_appliance.
Get a record containing the current state of the given VM_guest_metrics.
Get a record containing the current state of the given VM_metrics.
Get a record containing the current state of the given VMSS.
Get a record containing the current state of the given VTPM.
Get a record containing the current state of the given VUSB.
Get the redo_log_enabled field of the given pool.
Get the redo_log_vdi field of the given pool.
Get the reference_label field of the given VM.
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.
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.
Get the repositories field of the given pool.
Get the repository_proxy_password field of the given pool.
Get the repository_proxy_url field of the given pool.
Get the repository_proxy_username field of the given pool.
Get the required_api_version field of the given SM.
Get the required_cluster_stack field of the given SM.
Get the requires_reboot field of the given network_sriov.
Get the requires_reboot field of the given VM.
Get the resident_on field of the given task.
Get the resident_on field of the given VGPU.
Get the resident_on field of the given VM.
Get the resident_VGPUs field of the given PGPU.
Get the resident_VMs field of the given host.
Get the restrictions field of the given pool.
Get the result field of the given task.
Get the retained_snapshots field of the given VMSS.
Get the roles field of the given subject.
Get the runtime_properties field of the given VBD.
Get the runtime_properties field of the given VIF.
Gets xen's sched-gran on a host
Minimum allowed role: Not Applicable
First published in 1.271.0.
Gets xen's sched-gran on a host
Minimum allowed role: Not Applicable
First published in 1.271.0.
Get the sched_policy field of the given host.
Get the schedule field of the given VMSS.
Get the scheduled_to_be_resident_on field of the given VGPU.
Get the scheduled_to_be_resident_on field of the given VM.
Get the serial field of the given PUSB.
Get the installed server public TLS certificate.
Get the installed server public TLS certificate.
This call queries the host's clock for the current time in the host's local timezone
Minimum allowed role: read-only
First published in XenServer 5.6 FP1.
Get the servers field of the given PVS_site.
This call queries the host's clock for the current time
Minimum allowed role: read-only
First published in XenServer 5.0.
Get the sharable field of the given VDI.
Get the shared field of the given SR.
Get the short_name field of the given user.
Get the shutdown_delay field of the given VM.
Minimum allowed role: read-only
First published in XenServer 5.0.
Get the site field of the given PVS_cache_storage.
Get the site field of the given PVS_proxy.
Get the site field of the given PVS_server.
Get the size field of the given blob.
Get the size field of the given host_crashdump.
Get the size field of the given host_patch.
Get the size field of the given pool_patch.
Get the size field of the given PVS_cache_storage.
Get the slaves field of the given Bond.
Get the sm_config field of the given SR.
Get the sm_config field of the given VDI.
Get the snapshot_info field of the given VM.
Get the snapshot_metadata field of the given VM.
Get the snapshot_of field of the given VDI.
Get the snapshot_of field of the given VM.
Get the snapshots field of the given VDI.
Get the snapshots field of the given VM.
Get the snapshot_schedule field of the given VM.
Get the snapshot_time field of the given VDI.
Get the snapshot_time field of the given VM.
Get the software_version field of the given host.
Get the source_url field of the given Repository.
Get the speed field of the given host_cpu.
Get the speed field of the given PIF_metrics.
Get the speed field of the given PUSB.
Get the SR field of the given PBD.
Get the SR field of the given PVS_cache_storage.
Get the SR field of the given VDI.
Get the sriov_logical_PIF_of field of the given PIF.
Get the sriov_physical_PIF_of field of the given PIF.
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.
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 start_delay field of the given VM.
Get the start_time field of the given VM_metrics.
Get the state field of the given VM_metrics.
Get the status field of the given PVS_proxy.
Get the status field of the given task.
Get the status field of the given tunnel.
Get the status_code field of the given VBD.
Get the status_code field of the given VIF.
Get the status_detail field of the given VBD.
Get the status_detail field of the given VIF.
Get the stepping field of the given host_cpu.
Get the storage_lock field of the given VBD.
Get the storage_lock field of the given VDI.
Get the subject field of the given session.
This call queries the external directory service to obtain the subject_identifier as a string from the human-readable subject_name
Minimum allowed role: read-only
First published in XenServer 5.5.
Get the subject_identifier field of the given subject.
This call queries the external directory service to obtain the user information (e.g.
Get the subroles field of the given role.
Get the subsystem_device_name field of the given PCI.
Get the subsystem_vendor_name field of the given PCI.
Get the subtask_of field of the given task.
Get the subtasks field of the given task.
Get the supported_bootloaders field of the given host.
Get the supported_on_GPU_groups field of the given VGPU_type.
Get the supported_on_PGPUs field of the given VGPU_type.
Return a set of all the SR types supported by the system
Minimum allowed role: read-only
First published in XenServer 4.0.
Get the supported_VGPU_max_capacities field of the given PGPU.
Get the supported_VGPU_types field of the given GPU_group.
Get the supported_VGPU_types field of the given PGPU.
Get the suspend_image_sr field of the given host.
Get the suspend_image_SR field of the given pool.
Get the suspend_SR field of the given VM.
Get the suspend_VDI field of the given VM.
Minimum allowed role: read-only
First published in XenServer 4.1.
Get the tag field of the given VLAN.
Get the tagged_PIF field of the given VLAN.
Get the tags field of the given host.
Get the tags field of the given network.
Get the tags field of the given pool.
Get the tags field of the given SR.
Get the tags field of the given VDI.
Get the tags field of the given VM.
Get the tasks field of the given session.
Get the telemetry_frequency field of the given pool.
Get the telemetry_next_collection field of the given pool.
Get the telemetry_uuid field of the given pool.
Get the this_host field of the given session.
Get the this_user field of the given session.
Get the timestamp field of the given host_crashdump.
Get the timestamp_applied field of the given host_patch.
Get the tls_verification_enabled field of the given host.
Get the tls_verification_enabled field of the given pool.
Get the token_timeout field of the given Cluster.
Get the token_timeout_coefficient field of the given Cluster.
Get the transportable_snapshot_id field of the given VM.
Get the transport_PIF field of the given tunnel.
Get the tunnel_access_PIF_of field of the given PIF.
Get the tunnel_transport_PIF_of field of the given PIF.
Get the type field of the given Certificate.
Get the type field of the given SM.
Get the type field of the given SR.
Get the type field of the given task.
Get the type field of the given VBD.
Get the type field of the given VDI.
Get the type field of the given VGPU.
Get the type field of the given VMSS.
Get the uefi_certificates field of the given pool.
Get the unpluggable field of the given VBD.
Get the untagged_PIF field of the given VLAN.
Get the update field of the given Repository.
Get the updates field of the given host.
Get the updates_requiring_reboot field of the given host.
Get the update_sync_day field of the given pool.
Get the update_sync_enabled field of the given pool.
Get the update_sync_frequency field of the given pool.
Get the USB_group field of the given PUSB.
Get the USB_group field of the given VUSB.
Get the userdevice field of the given VBD.
Get the user_version field of the given VM.
Get the utilisation field of the given host_cpu.
Get the uuid field of the given blob.
Get the uuid field of the given Bond.
Get the uuid field of the given Certificate.
Get the uuid field of the given Cluster.
Get the uuid field of the given Cluster_host.
Get the uuid field of the given console.
Get the uuid field of the given crashdump.
Get the uuid field of the given DR_task.
Get the uuid field of the given Feature.
Get the uuid field of the given GPU_group.
Get the uuid field of the given host.
Get the uuid field of the given host_cpu.
Get the uuid field of the given host_crashdump.
Get the uuid field of the given host_metrics.
Get the uuid field of the given host_patch.
Get the uuid field of the given LVHD.
Get the uuid field of the given network.
Get the uuid field of the given network_sriov.
Get the uuid field of the given Observer.
Get the uuid field of the given PBD.
Get the uuid field of the given PCI.
Get the uuid field of the given PGPU.
Get the uuid field of the given PIF.
Get the uuid field of the given PIF_metrics.
Get the uuid field of the given pool.
Get the uuid field of the given pool_patch.
Get the uuid field of the given pool_update.
Get the uuid field of the given PUSB.
Get the uuid field of the given PVS_cache_storage.
Get the uuid field of the given PVS_proxy.
Get the uuid field of the given PVS_server.
Get the uuid field of the given PVS_site.
Get the uuid field of the given Repository.
Get the uuid field of the given role.
Get the uuid field of the given SDN_controller.
Get the uuid field of the given secret.
Get the uuid field of the given session.
Get the uuid field of the given SM.
Get the uuid field of the given SR.
Get the uuid field of the given subject.
Get the uuid field of the given task.
Get the uuid field of the given tunnel.
Get the uuid field of the given USB_group.
Get the uuid field of the given user.
Get the uuid field of the given VBD.
Get the uuid field of the given VBD_metrics.
Get the uuid field of the given VDI.
Get the uuid field of the given VGPU.
Get the uuid field of the given VGPU_type.
Get the uuid field of the given VIF.
Get the uuid field of the given VIF_metrics.
Get the uuid field of the given VLAN.
Get the uuid field of the given VM.
Get the uuid field of the given VM_appliance.
Get the uuid field of the given VM_guest_metrics.
Get the uuid field of the given VM_metrics.
Get the uuid field of the given VMSS.
Get the uuid field of the given VTPM.
Get the uuid field of the given VUSB.
Get the validation_time field of the given session.
Get the value field of the given secret.
Get the VBDs field of the given VDI.
Get the VBDs field of the given VM.
Get the VCPUs/at_startup field of the given VM.
Get the VCPUs/CPU field of the given VM_metrics.
Get the VCPUs/flags field of the given VM_metrics.
Get the VCPUs/max field of the given VM.
Get the VCPUs/number field of the given VM_metrics.
Get the VCPUs/params field of the given VM.
Get the VCPUs/params field of the given VM_metrics.
Get the vdi field of the given pool_update.
Get the VDI field of the given crashdump.
Get the VDI field of the given PVS_cache_storage.
Get the VDI field of the given VBD.
Get the VDIs field of the given SR.
Get the vendor field of the given host_cpu.
Get the vendor field of the given SM.
Get the vendor_desc field of the given PUSB.
Get the vendor_id field of the given PIF_metrics.
Get the vendor_id field of the given PUSB.
Get the vendor_name field of the given PCI.
Get the vendor_name field of the given PIF_metrics.
Get the vendor_name field of the given VGPU_type.
Get the version field of the given Feature.
Get the version field of the given host_patch.
Get the version field of the given pool_patch.
Get the version field of the given pool_update.
Get the version field of the given PUSB.
Get the version field of the given SM.
Get the version field of the given VM.
Get the VGPUs field of the given GPU_group.
Get the VGPUs field of the given VGPU_type.
Get the VGPUs field of the given VM.
Get the VIF field of the given PVS_proxy.
Get the VIFs field of the given network.
Get the VIFs field of the given VM.
Get the virtual_allocation field of the given SR.
Get the virtual_hardware_platform_versions field of the given host.
Get the virtual_size field of the given VDI.
Get the VLAN field of the given PIF.
Get the VLAN_master_of field of the given PIF.
Get the VLAN_slave_of field of the given PIF.
Get the VM field of the given console.
Get the VM field of the given crashdump.
Get the VM field of the given VBD.
Get the VM field of the given VGPU.
Get the VM field of the given VIF.
Get the VM field of the given VTPM.
Get the VM field of the given VUSB.
Get the VMs field of the given VM_appliance.
Get the VMs field of the given VMSS.
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.
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.
Get the VTPMs field of the given VM.
Get the VUSBs field of the given USB_group.
Get the VUSBs field of the given VM.
Get the wlb_enabled field of the given pool.
Get the wlb_url field of the given pool.
Get the wlb_username field of the given pool.
Get the xenstore_data field of the given VDI.
Get the xenstore_data field of the given VM.
Returns the maximum number of host failures we could tolerate before we would be unable to restart the provided VMs
Minimum allowed role: read-only
First published in XenServer 5.0.
Returns the maximum number of host failures we could tolerate before we would be unable to restart configured VMs
Minimum allowed role: pool-operator
First published in XenServer 5.0.
Return a VM failover plan assuming a given subset of hosts fail
Minimum allowed role: pool-operator
First published in XenServer 5.0.
Returns true if a VM failover plan exists for up to 'n' host failures
Minimum allowed role: pool-operator
First published in XenServer 5.0.
static void
When this call returns the VM restart logic will not run for the requested number of seconds.
void
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 and immediately restart the VM.
void
Stop executing the specified VM without attempting a clean shutdown.
void
Perform a hard shutdown of all the VMs in the appliance
Minimum allowed role: pool-operator
First published in XenServer 6.0.
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.
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 an XVA from a URI
Minimum allowed role: pool-operator
First published in XenServer 7.0.
static void
Import using a conversion service.
Import using a conversion service.
static void
Initializes workload balancing monitoring on this pool with the specified wlb server
Minimum allowed role: pool-operator
First published in XenServer 5.5.
Initializes workload balancing monitoring on this pool with the specified wlb server
Minimum allowed role: pool-operator
First published in XenServer 5.5.
Injects an artificial event on the given object and returns the corresponding ID in the form of a token, which can be used as a point of reference for database events.
void
Insert new media into the device
Minimum allowed role: vm-operator
First published in XenServer 4.0.
Insert new media into the device
Minimum allowed role: vm-operator
First published in XenServer 4.0.
static void
Install a TLS CA certificate, pool-wide.
Install a TLS CA certificate, pool-wide.
void
Install the TLS server certificate.
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.introduce(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.introduce(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.introduce(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.
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.
static void
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.
static void
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.
void
Apply a new license to a host
Minimum allowed role: pool-operator
First published in XenServer 6.5 SP1 Hotfix 31.
Apply a new license to a host
Minimum allowed role: pool-operator
First published in XenServer 6.5 SP1 Hotfix 31.
void
void
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.
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.
Compare two VDIs in 64k block increments and report which blocks differ.
List all supported methods
Minimum allowed role: read-only
First published in XenServer 4.0.
static void
Log out of local session.
static void
Reconfigure the management network interface.
Attempt to authenticate the user, returning a session reference if successful
Minimum allowed role: read-only
First published in XenServer 4.0.
Attempt to authenticate the user, returning a session reference if successful
Minimum allowed role: read-only
First published in XenServer 4.0.
Attempt to authenticate the user, returning a session reference if successful
Minimum allowed role: read-only
First published in XenServer 4.0.
static void
Log out of a session
Minimum allowed role: read-only
First published in XenServer 4.0.
static void
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.
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.make(Connection c,
Host host,
Map<String,String> deviceConfig,
Long physicalSize,
String nameLabel,
String nameDescription,
String type,
String contentType,
Map<String,String> smConfig)
SR.makeAsync(Connection c,
Host host,
Map<String,String> deviceConfig,
Long physicalSize,
String nameLabel,
String nameDescription,
String type,
String contentType,
Map<String,String> smConfig)
static void
Disable the management network interface
Minimum allowed role: pool-operator
First published in XenServer 4.1.
static void
Reconfigure the management network interface
Minimum allowed role: pool-operator
First published in XenServer 4.1.
static void
Reconfigure the management network interface for all Hosts in the Pool
Minimum allowed role: pool-operator
First published in XenServer 7.3.
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.
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.
Prepare to receive a VM, returning a token which can be passed to VM.migrate.
Migrate the VM to another host.
VM.migrateSend(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.
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.
void
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.
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.
Load the metadata found on the supplied VDI and return a session reference which can be used in API calls to query its contents.
void
void
Activate the specified PBD, causing the referenced SR to be attached and scanned
Minimum allowed role: pool-operator
First published in XenServer 4.0.
void
Attempt to bring up a physical interface
Minimum allowed role: pool-operator
First published in XenServer 4.1.
void
Hotplug the specified VBD, dynamically attaching it to the running VM
Minimum allowed role: vm-admin
First published in XenServer 4.0.
void
Hotplug the specified VIF, dynamically attaching it to the running VM
Minimum allowed role: vm-admin
First published in XenServer 4.0.
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.
void
void
Apply the selected update to all hosts in the pool
Minimum allowed role: pool-operator
First published in XenServer 7.1.
Apply the selected update to all hosts in the pool
Minimum allowed role: pool-operator
First published in XenServer 7.1.
void
void
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.
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 create a Cluster from the entire pool
Minimum allowed role: pool-operator
First published in XenServer 7.6.
void
Attempt to destroy the Cluster_host objects for all hosts in the pool and then destroy the Cluster.
Attempt to destroy the Cluster_host objects for all hosts in the pool and then destroy the Cluster.
void
Attempt to force destroy the Cluster_host objects, 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.
void
Migrate a VM to another Host.
Migrate a VDI, which may be attached to a running guest, to a different SR.
Migrate a VM to another Host.
void
Resynchronise the cluster_host objects across the pool.
Resynchronise the cluster_host objects across the pool.
void
Attempt to power-on the host (if the capability exists).
Attempt to power-on the host (if the capability exists).
void
Reset the power-state of the VM to halted in the database only.
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.
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.
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.
void
Inspects the disk configuration contained within the VM's other_config, creates VDIs and VBDs and then executes any applicable post-install script.
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 latest value of the specified data source
Minimum allowed role: read-only
First published in XenServer 5.0.
Query the latest value of the specified data source
Minimum allowed role: read-only
First published in XenServer 7.0.
Query the latest value of the specified data source
Minimum allowed role: read-only
First published in XenServer 5.0.
Query the system services advertised by this VM and register them.
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.
Check the VDI cache for the pool UUID of the database on this VDI.
void
void
Reconfigure the IP address settings for this interface
Minimum allowed role: pool-operator
First published in XenServer 4.1.
Reconfigure the IP address settings for this interface
Minimum allowed role: pool-operator
First published in XenServer 4.1.
void
Reconfigure the IPv6 address settings for this interface
Minimum allowed role: pool-operator
First published in XenServer 6.1.
Reconfigure the IPv6 address settings for this interface
Minimum allowed role: pool-operator
First published in XenServer 6.1.
void
Start recording the specified data source
Minimum allowed role: pool-operator
First published in XenServer 5.0.
void
Start recording the specified data source
Minimum allowed role: pool-operator
First published in XenServer 7.0.
void
Start recording the specified data source
Minimum allowed role: vm-admin
First published in XenServer 5.0.
void
Recover the VM
Minimum allowed role: read-only
First published in XenServer 6.0.
void
Recover the VM appliance
Minimum allowed role: read-only
First published in XenServer 6.0.
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.
Instruct a pool master, M, to try and contact its slaves and, if slaves are in emergency mode, reset their master address to M.
void
void
Replace the internal self-signed host certficate with a new one.
Replace the internal self-signed host certficate with a new one.
static void
void
Minimum allowed role: pool-operator
First published in XenServer 6.2 SP1 Tech-Preview.
Minimum allowed role: pool-operator
First published in XenServer 6.2 SP1 Tech-Preview.
void
void
void
void
void
Remove the given key and its corresponding value from the blocked_operations field of the given VM.
void
Remove a key-value pair from the pool-wide guest agent configuration
Minimum allowed role: pool-admin
First published in XenServer 7.0.
Remove a key-value pair from the pool-wide guest agent configuration
Minimum allowed role: pool-admin
First published in XenServer 7.0.
void
Remove the given key and its corresponding value from the guest_VCPUs_params field of the given host.
void
Remove the given key and its corresponding value from the gui_config field of the given pool.
void
Remove the given key and its corresponding value from the health_check_config field of the given pool.
void
Remove the given key and its corresponding value from the HVM/boot_params field of the given VM.
void
Remove the given key and its corresponding value from the license_server field of the given host.
void
Remove the given key and its corresponding value from the logging field of the given host.
void
Minimum allowed role: vm-admin
First published in Citrix Hypervisor 8.0.
void
Remove the given key and its corresponding value from the other_config field of the given Bond.
void
Remove the given key and its corresponding value from the other_config field of the given Cluster.
void
Remove the given key and its corresponding value from the other_config field of the given console.
void
Remove the given key and its corresponding value from the other_config field of the given crashdump.
void
Remove the given key and its corresponding value from the other_config field of the given GPU_group.
void
Remove the given key and its corresponding value from the other_config field of the given host.
void
Remove the given key and its corresponding value from the other_config field of the given host_cpu.
void
Remove the given key and its corresponding value from the other_config field of the given host_crashdump.
void
Remove the given key and its corresponding value from the other_config field of the given host_metrics.
void
Remove the given key and its corresponding value from the other_config field of the given host_patch.
void
Remove the given key and its corresponding value from the other_config field of the given network.
void
Remove the given key and its corresponding value from the other_config field of the given PBD.
void
Remove the given key and its corresponding value from the other_config field of the given PCI.
void
Remove the given key and its corresponding value from the other_config field of the given PGPU.
void
Remove the given key and its corresponding value from the other_config field of the given PIF.
void
Remove the given key and its corresponding value from the other_config field of the given PIF_metrics.
void
Remove the given key and its corresponding value from the other_config field of the given pool.
void
Remove the given key and its corresponding value from the other_config field of the given pool_patch.
void
Remove the given key and its corresponding value from the other_config field of the given pool_update.
void
Remove the given key and its corresponding value from the other_config field of the given PUSB.
void
Remove the given key and its corresponding value from the other_config field of the given secret.
void
Remove the given key and its corresponding value from the other_config field of the given session.
void
Remove the given key and its corresponding value from the other_config field of the given SM.
void
Remove the given key and its corresponding value from the other_config field of the given SR.
void
Remove the given key and its corresponding value from the other_config field of the given task.
void
Remove the given key and its corresponding value from the other_config field of the given tunnel.
void
Remove the given key and its corresponding value from the other_config field of the given USB_group.
void
Remove the given key and its corresponding value from the other_config field of the given user.
void
Remove the given key and its corresponding value from the other_config field of the given VBD.
void
void
Remove the given key and its corresponding value from the other_config field of the given VDI.
void
Remove the given key and its corresponding value from the other_config field of the given VGPU.
void
Remove the given key and its corresponding value from the other_config field of the given VIF.
void
Remove the given key and its corresponding value from the other_config field of the given VIF_metrics.
void
Remove the given key and its corresponding value from the other_config field of the given VLAN.
void
Remove the given key and its corresponding value from the other_config field of the given VM.
void
Remove the given key and its corresponding value from the other_config field of the given VM_guest_metrics.
void
Remove the given key and its corresponding value from the other_config field of the given VM_metrics.
void
Remove the given key and its corresponding value from the other_config field of the given VUSB.
void
Remove the given key and its corresponding value from the platform field of the given VM.
void
Remove the given key and its corresponding value from the qos/algorithm_params field of the given VBD.
void
Remove the given key and its corresponding value from the qos/algorithm_params field of the given VIF.
void
This call removes a role from a subject
Minimum allowed role: pool-admin
First published in XenServer 5.6.
void
Minimum allowed role: pool-operator
First published in XenServer 7.2.
void
Remove the given key and its corresponding value from the sm_config field of the given SR.
void
Remove the given key and its corresponding value from the sm_config field of the given VDI.
void
Remove the given key and its corresponding value from the status field of the given tunnel.
void
Remove the given key and its corresponding value from the VCPUs/params field of the given VM.
void
Remove the given key and its corresponding value from the xenstore_data field of the given VDI.
void
Remove the given key and its corresponding value from the xenstore_data field of the given VM.
void
Removes an IPv4 address from this VIF
Minimum allowed role: pool-operator
First published in XenServer 6.1.
Removes an IPv4 address from this VIF
Minimum allowed role: pool-operator
First published in XenServer 6.1.
void
Removes an IPv6 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.
void
Remove a purpose from a network (if present)
Minimum allowed role: pool-admin
First published in XenServer 7.3.
Remove a purpose from a network (if present)
Minimum allowed role: pool-admin
First published in XenServer 7.3.
void
Remove a repository from the enabled set
Minimum allowed role: pool-operator
First published in 1.301.0.
Remove a repository from the enabled set
Minimum allowed role: pool-operator
First published in 1.301.0.
void
Remove the given value from the tags field of the given host.
void
Remove the given value from the tags field of the given network.
void
Remove the given value from the tags field of the given pool.
void
Remove the given value from the tags field of the given SR.
void
Remove the given value from the tags field of the given VDI.
void
Remove the given value from the tags field of the given VM.
void
void
Delete the current TLS server certificate and replace by a new, self-signed one.
Delete the current TLS server certificate and replace by a new, self-signed one.
void
Assign a new UUID to telemetry data.
Assign a new UUID to telemetry data.
void
void
void
Restarts the agent after a 10 second pause.
Restarts the agent after a 10 second pause.
void
Minimum allowed role: vm-power-admin
Experimental.
void
Awaken the specified VM and resume it.
Awaken the specified VM and resume it.
void
Awaken the specified VM and resume it on a particular Host.
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 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 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.
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.
void
Reverts the specified VM to a previous state.
Reverts the specified VM to a previous state.
static void
Minimum allowed role: pool-admin
First published in Citrix Hypervisor 8.2 Hotfix 2.
Minimum allowed role: pool-admin
First published in Citrix Hypervisor 8.2 Hotfix 2.
static void
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.
static void
Minimum allowed role: pool-admin
First published in XenServer 7.3.
void
Refreshes the list of VDIs associated with an SR
Minimum allowed role: vm-power-admin
First published in XenServer 4.0.
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.
void
Inject the given string as debugging keys into Xen
Minimum allowed role: pool-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.
void
Send the given key as a sysrq to this VM.
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 given body to the given host and port, using HTTPS, and print the response.
void
Send the named trigger to this VM.
Send the named trigger to this VM.
static void
Sets the pool optimization criteria for the workload balancing server
Minimum allowed role: pool-operator
First published in XenServer 5.5.
Sets the pool optimization criteria for the workload balancing server
Minimum allowed role: pool-operator
First published in XenServer 5.5.
void
Sets the actions_after_crash parameter
Minimum allowed role: vm-admin
First published in XenServer 4.0.
Sets the actions_after_crash parameter
Minimum allowed role: vm-admin
First published in XenServer 4.0.
void
Set the actions/after_reboot field of the given VM.
void
Set the actions/after_shutdown field of the given VM.
void
Set the actions/after_softreboot field of the given VM.
void
Set the address field of the given host.
void
Set the affinity field of the given VM.
void
void
Set the allocation_algorithm field of the given GPU_group.
void
Set the value of the allow_caching parameter.
Set the value of the allow_caching parameter.
void
Assign this VM to an appliance.
Assign this VM to an appliance.
void
void
void
void
void
void
Set the attributes of an observer.
Set the attributes of an observer.
void
void
void
void
void
void
Set custom BIOS strings to this VM.
Set custom BIOS strings to this VM.
void
Set the blocked_operations field of the given VM.
void
Set the bootable field of the given VBD.
void
Set the components on which the observer will broadcast to.
Set the components on which the observer will broadcast to.
void
Set the coordinator_bias field of the given pool.
void
void
Set the crash_dump_sr field of the given host.
void
Set the crash_dump_SR field of the given pool.
void
Set custom UEFI certificates for a pool and all its hosts.
Set custom UEFI certificates for a pool and all its hosts.
void
Set the default locking mode for VIFs attached to this network
Minimum allowed role: pool-operator
First published in XenServer 6.1.
Set the default locking mode for VIFs attached to this network
Minimum allowed role: pool-operator
First published in XenServer 6.1.
void
Set the default_SR field of the given pool.
void
Sets the PBD's device_config field
Minimum allowed role: pool-operator
First published in XenServer 4.1.
Sets the PBD's device_config field
Minimum allowed role: pool-operator
First published in XenServer 4.1.
void
Set whether unplugging the PIF is allowed
Minimum allowed role: pool-operator
First published in XenServer 5.0.
Set whether unplugging the PIF is allowed
Minimum allowed role: pool-operator
First published in XenServer 5.0.
void
Set the display field of the given host.
void
Set the VM.domain_type field of the given VM, which will take effect when it is next started
Minimum allowed role: vm-admin
First published in XenServer 7.5.
void
Enable / disable this observer which will stop the observer from producing observability information
Minimum allowed role: pool-admin
Experimental.
void
Set the enabled field of the given VMSS.
Enable / disable this observer which will stop the observer from producing observability information
Minimum allowed role: pool-admin
Experimental.
void
Minimum allowed role: pool-operator
First published in XenServer 6.2 SP1 Tech-Preview.
Minimum allowed role: pool-operator
First published in XenServer 6.2 SP1 Tech-Preview.
void
Set the file/HTTP endpoints the observer sends data to
Minimum allowed role: pool-admin
Experimental.
Set the file/HTTP endpoints the observer sends data to
Minimum allowed role: pool-admin
Experimental.
void
Set the task error info
Minimum allowed role: read-only
First published in 21.3.0.
void
Minimum allowed role: pool-operator
Experimental.
void
Set the extra_args field of the given VGPU.
void
Set the value of the frequency field
Minimum allowed role: pool-operator
First published in XenServer 7.2.
void
Set the fullname field of the given user.
void
Set the file name of the GPG public key of the repository
Minimum allowed role: pool-operator
Experimental.
Set the file name of the GPG public key of the repository
Minimum allowed role: pool-operator
Experimental.
void
Minimum allowed role: pool-operator
First published in XenServer 6.2 SP1 Tech-Preview.
Minimum allowed role: pool-operator
First published in XenServer 6.2 SP1 Tech-Preview.
void
Set the guest_VCPUs_params field of the given host.
void
Set the gui_config field of the given pool.
void
Set the ha_allow_overcommit field of the given pool.
void
void
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.
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.
void
Set the hardware_platform_version field of the given VM.
void
Set the value of the ha_restart_priority field
Minimum allowed role: pool-operator
First published in XenServer 5.0.
void
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.
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.
void
Set the health_check_config field of the given pool.
void
Set the hostname field of the given host.
void
Sets the host name to the specified string.
void
Sets the hosts that the observer is to be registered on
Minimum allowed role: pool-admin
Experimental.
Sets the hosts that the observer is to be registered on
Minimum allowed role: pool-admin
Experimental.
void
updates the host firewall to open or close port 80 depending on the value
Minimum allowed role: pool-operator
Experimental.
void
updates all the host firewalls in the pool to open or close port 80 depending on the value
Minimum allowed role: pool-operator
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.
void
Set the HVM/boot_params field of the given VM.
void
void
Set the shadow memory multiplier on a halted VM
Minimum allowed role: vm-power-admin
First published in XenServer 5.6.
void
Enable or disable IGMP Snooping on the pool.
Enable or disable IGMP Snooping on the pool.
void
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 IPv4 addresses to which traffic on this VIF can be restricted
Minimum allowed role: pool-operator
First published in XenServer 6.1.
void
Set the IPv6 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.
void
void
Set the is_a_template field of the given VM.
void
Sets the initiator IQN for the host
Minimum allowed role: pool-operator
First published in XenServer 7.5.
Sets the initiator IQN for the host
Minimum allowed role: pool-operator
First published in XenServer 7.5.
void
void
Set the is_psr_pending field of the given pool.
void
Minimum allowed role: Not Applicable
First published in XenServer 7.2.
void
Set the license_server field of the given host.
void
Set the live_patching_disabled field of the given pool.
void
Minimum allowed role: pool-operator
Experimental.
void
Set the locking mode for this VIF
Minimum allowed role: pool-operator
First published in XenServer 6.1.
Set the locking mode for this VIF
Minimum allowed role: pool-operator
First published in XenServer 6.1.
void
Set the logging field of the given host.
void
Set the memory allocation of this VM.
Set the memory allocation of this VM.
void
Set the value of the memory_dynamic_max field
Minimum allowed role: vm-power-admin
First published in XenServer 5.6.
void
Set the value of the memory_dynamic_min field
Minimum allowed role: vm-power-admin
First published in XenServer 5.6.
void
Set the minimum and maximum amounts of physical memory the VM is allowed to use.
Set the minimum and maximum amounts of physical memory the VM is allowed to use.
void
Set the memory limits of this VM.
Set the memory limits of this VM.
void
Set the value of the memory_static_max field
Minimum allowed role: vm-power-admin
First published in XenServer 5.0.
void
Set the value of the memory_static_min field
Minimum allowed role: vm-power-admin
First published in XenServer 5.6.
void
Set the static (ie boot-time) range of virtual memory that the VM is allowed to use.
Set the static (ie boot-time) range of virtual memory that the VM is allowed to use.
void
void
Set the migration_compression field of the given pool.
void
Change the bond mode
Minimum allowed role: pool-operator
First published in XenServer 6.0.
void
Sets the mode of the VBD.
Change the bond mode
Minimum allowed role: pool-operator
First published in XenServer 6.0.
Sets the mode of the VBD.
void
Set the MTU field of the given network.
void
Specifies whether multipathing is enabled
Minimum allowed role: pool-operator
First published in XenServer 7.5.
Specifies whether multipathing is enabled
Minimum allowed role: pool-operator
First published in XenServer 7.5.
void
Set the name/description field of the given blob.
void
Set the name/description field of the given GPU_group.
void
Set the name/description field of the given host.
void
Set the name/description field of the given network.
void
Set the name/description field of the given Observer.
void
Set the name_description field of the given pool.
void
Set the name/description field of the given PVS_site.
void
Set the name/description field of the given Repository.
void
Set the name description of the SR
Minimum allowed role: pool-operator
First published in XenServer 4.0.
void
Set the name/description field of the given USB_group.
void
Set the name description of the VDI.
void
Set the name/description field of the given VM.
void
Set the name/description field of the given VM_appliance.
void
Set the name/description field of the given VMPP.
void
Set the name/description field of the given VMSS.
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.
void
Set the name/label field of the given blob.
void
Set the name/label field of the given GPU_group.
void
Set the name/label field of the given host.
void
Set the name/label field of the given network.
void
Set the name/label field of the given Observer.
void
Set the name_label field of the given pool.
void
Set the name/label field of the given PVS_site.
void
Set the name/label field of the given Repository.
void
Set the name label of the SR
Minimum allowed role: pool-operator
First published in XenServer 4.0.
void
Set the name/label field of the given USB_group.
void
Set the name label of the VDI.
void
Set the name/label field of the given VM.
void
Set the name/label field of the given VM_appliance.
void
Set the name/label field of the given VMPP.
void
Set the name/label field of the given VMSS.
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.
void
Set VM placement NUMA affinity policy
Minimum allowed role: pool-admin
Experimental.
Set VM placement NUMA affinity policy
Minimum allowed role: pool-admin
Experimental.
void
Minimum allowed role: vm-admin
First published in Citrix Hypervisor 8.0.
void
Set the value of the on_boot parameter.
Set the value of the on_boot parameter.
void
Set this VM's boot order
Minimum allowed role: pool-operator
First published in XenServer 6.0.
Set this VM's boot order
Minimum allowed role: pool-operator
First published in XenServer 6.0.
void
Set the other_config field of the given Bond.
void
Set the other_config field of the given Cluster.
void
Set the other_config field of the given console.
void
Set the other_config field of the given crashdump.
void
Set the other_config field of the given GPU_group.
void
Set the other_config field of the given host.
void
Set the other_config field of the given host_cpu.
void
Set the other_config field of the given host_crashdump.
void
Set the other_config field of the given host_metrics.
void
Set the other_config field of the given host_patch.
void
Set the other_config field of the given network.
void
Set the other_config field of the given PBD.
void
Set the other_config field of the given PCI.
void
Set the other_config field of the given PGPU.
void
Set the other_config field of the given PIF.
void
Set the other_config field of the given PIF_metrics.
void
Set the other_config field of the given pool.
void
Set the other_config field of the given pool_patch.
void
Set the other_config field of the given pool_update.
void
Set the other_config field of the given PUSB.
void
Set the other_config field of the given secret.
void
Set the other_config field of the given session.
void
Set the other_config field of the given SM.
void
Set the other_config field of the given SR.
void
Set the other_config field of the given task.
void
Set the other_config field of the given tunnel.
void
Set the other_config field of the given USB_group.
void
Set the other_config field of the given user.
void
Set the other_config field of the given VBD.
void
void
Set the other_config field of the given VDI.
void
Set the other_config field of the given VGPU.
void
Set the other_config field of the given VIF.
void
Set the other_config field of the given VIF_metrics.
void
Set the other_config field of the given VLAN.
void
Set the other_config field of the given VM.
void
Set the other_config field of the given VM_guest_metrics.
void
Set the other_config field of the given VM_metrics.
void
Set the other_config field of the given VUSB.
void
Minimum allowed role: pool-admin
First published in XenServer 7.3.
Minimum allowed role: pool-admin
First published in XenServer 7.3.
void
void
Sets the SR's physical_size field
Minimum allowed role: pool-operator
First published in XenServer 4.1.
void
Set the platform field of the given VM.
void
Set the policy_no_vendor_device field of the given pool.
void
Set the power-on-mode, host, user and password
Minimum allowed role: pool-operator
First published in XenServer 5.6 FP1.
Set the power-on-mode, host, user and password
Minimum allowed role: pool-operator
First published in XenServer 5.6 FP1.
void
Change the primary address type used by this PIF
Minimum allowed role: pool-operator
First published in XenServer 6.1.
Change the primary address type used by this PIF
Minimum allowed role: pool-operator
First published in XenServer 6.1.
void
Set the task progress
Minimum allowed role: read-only
First published in Citrix Hypervisor 8.2.
void
Set the value of a property of the bond
Minimum allowed role: pool-operator
First published in XenServer 6.1.
void
Set the value of a property of the PIF
Minimum allowed role: pool-operator
First published in XenServer 6.5.
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.
void
void
Set the protocol field of the given tunnel.
void
Set the public field of the given blob.
void
Set the PV/args field of the given VM.
void
Set the PV/bootloader field of the given VM.
void
Set the PV/bootloader_args field of the given VM.
void
Set the PV/kernel field of the given VM.
void
Set the PV/legacy_args field of the given VM.
void
Set the PV/ramdisk field of the given VM.
void
Update the PVS UUID of the PVS site
Minimum allowed role: pool-operator
First published in XenServer 7.1.
Update the PVS UUID of the PVS site
Minimum allowed role: pool-operator
First published in XenServer 7.1.
void
Set the qos/algorithm_params field of the given VBD.
void
Set the qos/algorithm_params field of the given VIF.
void
Set the qos/algorithm_type field of the given VBD.
void
Set the qos/algorithm_type field of the given VIF.
void
Sets the VDI's read_only field
Minimum allowed role: vm-admin
First published in XenServer 4.0.
void
Set the recommendations field of the given VM.
void
Set enabled set of repositories
Minimum allowed role: pool-operator
First published in 1.301.0.
Set enabled set of repositories
Minimum allowed role: pool-operator
First published in 1.301.0.
void
Set the task result
Minimum allowed role: read-only
First published in 21.3.0.
void
Minimum allowed role: pool-operator
First published in XenServer 7.2.
void
Sets xen's sched-gran on a host.
Sets xen's sched-gran on a host.
void
Minimum allowed role: pool-operator
First published in XenServer 7.2.
void
Set the shadow memory multiplier on a running VM
Minimum allowed role: vm-power-admin
First published in XenServer 4.0.
Set the shadow memory multiplier on a running VM
Minimum allowed role: vm-power-admin
First published in XenServer 4.0.
void
Sets the VDI's sharable field
Minimum allowed role: vm-admin
First published in XenServer 5.5.
void
Sets the shared flag on the SR
Minimum allowed role: pool-operator
First published in XenServer 4.0.
Sets the shared flag on the SR
Minimum allowed role: pool-operator
First published in XenServer 4.0.
void
Set this VM's shutdown delay in seconds
Minimum allowed role: pool-operator
First published in XenServer 6.0.
Set this VM's shutdown delay in seconds
Minimum allowed role: pool-operator
First published in XenServer 6.0.
void
Set the sm_config field of the given SR.
void
Set the sm_config field of the given VDI.
void
Set the value of the snapshot schedule field
Minimum allowed role: pool-operator
First published in XenServer 7.2.
void
Enable/disable SSLv3 for interoperability with older server versions.
Enable/disable SSLv3 for interoperability with older server versions.
void
Set this VM's start delay in seconds
Minimum allowed role: pool-operator
First published in XenServer 6.0.
Set this VM's start delay in seconds
Minimum allowed role: pool-operator
First published in XenServer 6.0.
void
Set the task status
Minimum allowed role: read-only
First published in XenServer 7.2.
void
Set the status field of the given tunnel.
void
Set the suspend_image_sr field of the given host.
void
Set the suspend_image_SR field of the given pool.
void
Set the suspend_SR field of the given VM.
void
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 this VM's suspend VDI, which must be indentical to its current one
Minimum allowed role: pool-operator
First published in XenServer 6.0.
void
Set the tags field of the given host.
void
Set the tags field of the given network.
void
Set the tags field of the given pool.
void
Set the tags field of the given SR.
void
Set the tags field of the given VDI.
void
Set the tags field of the given VM.
void
Set the timestamp for the next telemetry data collection.
Set the timestamp for the next telemetry data collection.
void
Set the type field of the given VBD.
void
Minimum allowed role: pool-operator
First published in XenServer 7.2.
void
void
void
Set the unpluggable field of the given VBD.
void
enable or disable periodic update synchronization depending on the value
Minimum allowed role: pool-operator
Experimental.
enable or disable periodic update synchronization depending on the value
Minimum allowed role: pool-operator
Experimental.
void
Set the userdevice field of the given VBD.
void
Set the user_version field of the given VM.
void
Set the value field of the given secret.
void
Set the number of startup VCPUs for a halted VM
Minimum allowed role: vm-admin
First published in XenServer 5.6.
void
Set the maximum number of VCPUs for a halted VM
Minimum allowed role: vm-admin
First published in XenServer 5.6.
void
Set the number of VCPUs for a running VM
Minimum allowed role: vm-admin
First published in XenServer 4.0.
Set the number of VCPUs for a running VM
Minimum allowed role: vm-admin
First published in XenServer 4.0.
void
Set the VCPUs/params field of the given VM.
static void
void
Set the wlb_enabled field of the given pool.
void
void
Set the xenstore_data field of the given VDI.
void
Set the xenstore_data field of the given VM.
void
void
Attempts to first clean shutdown a VM and if it should fail then perform a hard shutdown on it.
void
For each VM in the appliance, try to shut it down cleanly.
static void
Shuts the agent down after a 10 second pause.
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.
Authenticate locally against a slave in emergency mode.
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.
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.
This call executes the snapshot schedule immediately
Minimum allowed role: pool-operator
First published in XenServer 7.2.
void
void
Start all VMs in the appliance
Minimum allowed role: pool-operator
First published in XenServer 6.0.
Start all VMs in the appliance
Minimum allowed role: pool-operator
First published in XenServer 6.0.
void
Start the specified VM on a particular host.
Start the specified VM on a particular host.
void
Suspend the specified VM to disk.
Suspend the specified VM to disk.
void
This causes the synchronisation of the non-database data (messages, RRDs and so on) stored on the master to be synchronised with the host
Minimum allowed role: pool-admin
First published in XenServer 5.0.
static void
Forcibly synchronise the database now
Minimum allowed role: pool-operator
First published in XenServer 4.0.
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.
Sync with the enabled repository
Minimum allowed role: pool-operator
First published in 1.329.0.
void
Re-configure syslog logging
Minimum allowed role: pool-operator
First published in XenServer 4.1.
Re-configure syslog logging
Minimum allowed role: pool-operator
First published in XenServer 4.1.
This call tests if a location is valid
Minimum allowed role: pool-operator
First published in XenServer 5.6 FP1.
static void
Remove a pool-wide TLS CA certificate.
Remove a pool-wide TLS CA certificate.
void
void
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.
void
Attempt to bring down a physical interface
Minimum allowed role: pool-operator
First published in XenServer 4.1.
void
Hot-unplug the specified VBD, dynamically unattaching it from the running VM
Minimum allowed role: vm-admin
First published in XenServer 4.0.
void
Hot-unplug the specified VIF, dynamically unattaching it from the running VM
Minimum allowed role: vm-admin
First published in XenServer 4.0.
void
Unplug the vusb device from the vm.
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.
void
Forcibly unplug the specified VBD
Minimum allowed role: vm-admin
First published in XenServer 4.0.
void
Forcibly unplug the specified VIF
Minimum allowed role: vm-admin
First published in XenServer 6.0.
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.
static void
void
Refresh the fields on the SR object
Minimum allowed role: pool-operator
First published in XenServer 4.1.1.
void
Ask the storage backend to refresh the fields in the VDI object
Minimum allowed role: vm-admin
First published in XenServer 4.1.1.
void
Recomputes the list of acceptable operations
Minimum allowed role: pool-admin
First published in XenServer 4.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.
void
Upload the specified host crash dump to a specified URL
Minimum allowed role: pool-operator
First published in XenServer 4.0.
Upload the specified host crash dump to a specified URL
Minimum allowed role: pool-operator
First published in XenServer 4.0.
void