-
XenAPI Classes
+
API Classes
Click on a class to view the associated fields and messages.
diff --git a/ocaml/doc/templates/branding.mustache b/ocaml/doc/templates/branding.mustache
index 3924445efe5..cadd4c898fe 100644
--- a/ocaml/doc/templates/branding.mustache
+++ b/ocaml/doc/templates/branding.mustache
@@ -13,12 +13,12 @@
*/
function make_title() {
- document.write('
Citrix XenServer Management API');
+ document.write('
Citrix Hypervisor Management API');
}
function make_header(t) {
html = '
'
- + '
'
+ + '
'
document.getElementById('header').innerHTML = html;
}
diff --git a/ocaml/idl/datamodel.ml b/ocaml/idl/datamodel.ml
index f3d48952dbf..de320006eca 100644
--- a/ocaml/idl/datamodel.ml
+++ b/ocaml/idl/datamodel.ml
@@ -2633,7 +2633,7 @@ module VDI = struct
~in_product_since:rel_boston
~params:[Ref _vdi, "self", "The VDI which contains the database to open"]
~result:(Ref _session, "A session which can be used to query the database")
- ~doc:"Load the metadata found on the supplied VDI and return a session reference which can be used in XenAPI calls to query its contents."
+ ~doc:"Load the metadata found on the supplied VDI and return a session reference which can be used in API calls to query its contents."
~allowed_roles:_R_POOL_OP
()
diff --git a/ocaml/idl/datamodel_host.ml b/ocaml/idl/datamodel_host.ml
index ef129ef2351..940f2961b2d 100644
--- a/ocaml/idl/datamodel_host.ml
+++ b/ocaml/idl/datamodel_host.ml
@@ -591,7 +591,7 @@ let host_query_ha = call ~flags:[`Session]
let call_plugin = call
~name:"call_plugin"
~in_product_since:rel_orlando
- ~doc:"Call a XenAPI plugin on this host"
+ ~doc:"Call an API plugin on this host"
~params:[Ref _host, "host", "The host";
String, "plugin", "The name of the plugin";
String, "fn", "The name of the function within the plugin";
@@ -614,7 +614,7 @@ let host_query_ha = call ~flags:[`Session]
~name:"call_extension"
~in_product_since:rel_ely
~custom_marshaller:true
- ~doc:"Call a XenAPI extension on this host"
+ ~doc:"Call an API extension on this host"
~params:[Ref _host, "host", "The host";
String, "call", "Rpc call for the extension";]
~result:(String, "Result from the extension")
@@ -1053,7 +1053,7 @@ let host_query_ha = call ~flags:[`Session]
let set_ssl_legacy = call
~name:"set_ssl_legacy"
~lifecycle:[Published, rel_dundee, ""]
- ~doc:"Enable/disable SSLv3 for interoperability with older versions of XenServer. When this is set to a different value, the host immediately restarts its SSL/TLS listening service; typically this takes less than a second but existing connections to it will be broken. XenAPI login sessions will remain valid."
+ ~doc:"Enable/disable SSLv3 for interoperability with older server versions. When this is set to a different value, the host immediately restarts its SSL/TLS listening service; typically this takes less than a second but existing connections to it will be broken. API login sessions will remain valid."
~params:[
Ref _host, "self", "The host";
Bool, "value", "True to allow SSLv3 and ciphersuites as used in old XenServer versions";
@@ -1430,7 +1430,7 @@ let host_query_ha = call ~flags:[`Session]
field ~qualifier:DynamicRO ~lifecycle:[Published, rel_boston, ""] ~ty:(Set (Ref _pci)) "PCIs" "List of PCI devices in the host";
field ~qualifier:DynamicRO ~lifecycle:[Published, rel_boston, ""] ~ty:(Set (Ref _pgpu)) "PGPUs" "List of physical GPUs in the host";
field ~qualifier:DynamicRO ~lifecycle:[Published, rel_inverness, ""] ~ty:(Set (Ref _pusb)) "PUSBs" "List of physical USBs in the host";
- field ~qualifier:StaticRO ~lifecycle:[Published, rel_dundee, ""] ~ty:Bool ~default_value:(Some (VBool true)) "ssl_legacy" "Allow SSLv3 protocol and ciphersuites as used by older XenServers. This controls both incoming and outgoing connections. When this is set to a different value, the host immediately restarts its SSL/TLS listening service; typically this takes less than a second but existing connections to it will be broken. XenAPI login sessions will remain valid.";
+ field ~qualifier:StaticRO ~lifecycle:[Published, rel_dundee, ""] ~ty:Bool ~default_value:(Some (VBool true)) "ssl_legacy" "Allow SSLv3 protocol and ciphersuites as used by older server versions. This controls both incoming and outgoing connections. When this is set to a different value, the host immediately restarts its SSL/TLS listening service; typically this takes less than a second but existing connections to it will be broken. API login sessions will remain valid.";
field ~qualifier:RW ~in_product_since:rel_tampa ~default_value:(Some (VMap [])) ~ty:(Map (String, String)) "guest_VCPUs_params" "VCPUs params to apply to all resident guests";
field ~qualifier:RW ~in_product_since:rel_cream ~default_value:(Some (VEnum "enabled")) ~ty:display "display" "indicates whether the host is configured to output its console to a physical display device";
field ~qualifier:DynamicRO ~in_product_since:rel_cream ~default_value:(Some (VSet [VInt 0L])) ~ty:(Set (Int)) "virtual_hardware_platform_versions" "The set of versions of the virtual hardware platform that the host can offer to its guests";
diff --git a/ocaml/idl/datamodel_vm.ml b/ocaml/idl/datamodel_vm.ml
index fd2126bc7c0..ade5d83f099 100644
--- a/ocaml/idl/datamodel_vm.ml
+++ b/ocaml/idl/datamodel_vm.ml
@@ -299,7 +299,7 @@ let power_behaviour =
let set_is_default_template = call
~name:"set_is_default_template"
~hide_from_docs:true
- ~lifecycle: [Published, rel_falcon, "Allows to define XenServer default templates"]
+ ~lifecycle: [Published, rel_falcon, "Allows to define default templates"]
~doc:"Makes the specified VM a default template."
~params:[
Ref _vm, "vm", "The VM that will become a default template";
@@ -1111,7 +1111,7 @@ let power_behaviour =
let call_plugin = call
~name:"call_plugin"
~in_product_since:rel_cream
- ~doc:"Call a XenAPI plugin on this vm"
+ ~doc:"Call an API plugin on this vm"
~params:[Ref _vm, "vm", "The vm";
String, "plugin", "The name of the plugin";
String, "fn", "The name of the function within the plugin";
@@ -1310,7 +1310,7 @@ let set_HVM_boot_policy = call ~flags:[`Session]
field ~ty:Int "user_version" "Creators of VMs and templates may store version information here.";
field ~effect:true ~ty:Bool "is_a_template" "true if this is a template. Template VMs can never be started, they are used only for cloning other VMs";
- field ~ty:Bool ~default_value:(Some (VBool false)) ~qualifier:DynamicRO ~writer_roles:_R_POOL_ADMIN ~lifecycle:[Published, rel_falcon, "Identifies XenServer default templates"] "is_default_template" "true if this is a default template. Default template VMs can never be started or migrated, they are used only for cloning other VMs";
+ field ~ty:Bool ~default_value:(Some (VBool false)) ~qualifier:DynamicRO ~writer_roles:_R_POOL_ADMIN ~lifecycle:[Published, rel_falcon, "Identifies default templates"] "is_default_template" "true if this is a default template. Default template VMs can never be started or migrated, they are used only for cloning other VMs";
field ~qualifier:DynamicRO ~ty:(Ref _vdi) "suspend_VDI" "The VDI that a suspend image is stored on. (Only has meaning if VM is currently suspended)";
field ~writer_roles:_R_VM_POWER_ADMIN ~qualifier:DynamicRO ~ty:(Ref _host) "resident_on" "the host the VM is currently resident on";
diff --git a/scripts/examples/python/shell.py b/scripts/examples/python/shell.py
index 076f0175e70..b62f103c094 100644
--- a/scripts/examples/python/shell.py
+++ b/scripts/examples/python/shell.py
@@ -114,4 +114,4 @@ def munge_types (str):
sys.exit(3)
sys.exit(0)
else:
- Shell().cmdloop('Welcome to the XenServer shell. (Try "VM.get_all")')
+ Shell().cmdloop('Welcome to the Citrix Hypervisor shell. (Try "VM.get_all")')
diff --git a/scripts/motd b/scripts/motd
index 1f8a791f6e3..3641a26a89e 100644
--- a/scripts/motd
+++ b/scripts/motd
@@ -1,6 +1,6 @@
-XenServer simulator VM
+Citrix Hypervisor simulator VM
Language bindings and examples are in /SDK
diff --git a/scripts/xe-backup-metadata b/scripts/xe-backup-metadata
index ccb3706bb0e..1d2fb8e76ca 100755
--- a/scripts/xe-backup-metadata
+++ b/scripts/xe-backup-metadata
@@ -5,7 +5,7 @@
trap "cleanup" TERM INT
if [ ! -e @INVENTORY@ ]; then
- echo Must run on a XenServer host.
+ echo Must run on a Citrix Hypervisor host.
exit 1
fi
diff --git a/scripts/xe-edit-bootloader b/scripts/xe-edit-bootloader
index 4e33d8d16be..561626488ff 100755
--- a/scripts/xe-edit-bootloader
+++ b/scripts/xe-edit-bootloader
@@ -5,7 +5,7 @@
# Script which lets you edit the grub.conf in a Linux guest virtual disk.
if [ ! -e @INVENTORY@ ]; then
- echo Must run on a XenServer host.
+ echo Must run on a Citrix Hypervisor host.
exit 1
fi
diff --git a/scripts/xe-restore-metadata b/scripts/xe-restore-metadata
index cda8b6671f5..78be9188c7f 100755
--- a/scripts/xe-restore-metadata
+++ b/scripts/xe-restore-metadata
@@ -3,7 +3,7 @@
# Citrix Systems Inc, 2008
if [ ! -e @INVENTORY@ ]; then
- echo Must run on a XenServer host.
+ echo Must run on a Citrix Hypervisor host.
exit 1
fi
diff --git a/scripts/xe-set-iscsi-iqn b/scripts/xe-set-iscsi-iqn
index 5c7da9cbb9a..0539bcba6d9 100755
--- a/scripts/xe-set-iscsi-iqn
+++ b/scripts/xe-set-iscsi-iqn
@@ -11,7 +11,7 @@ XE="@BINDIR@/xe"
configkey="iscsi_iqn"
if [ ! -f @INVENTORY@ ]; then
- echo Error: Not a XenServer host
+ echo Error: Not a Citrix Hypervisor host
exit 1
fi
diff --git a/scripts/xe-xentrace b/scripts/xe-xentrace
index 2a8051d1a08..f3adec93ab5 100755
--- a/scripts/xe-xentrace
+++ b/scripts/xe-xentrace
@@ -31,7 +31,7 @@ done
SIZE=$((${SIZE_GB} * 1024 * 1024 * 1024))
if [ ! -e @INVENTORY@ ]; then
- echo Must run on a XenServer host.
+ echo Must run on a Citrix Hypervisor host.
exit 1
fi