Addenda to XenServer 7.1 LTSR PDF guides

The XenServer 7.1 PDF guides are no longer updated. This article includes addenda to the information in the guides.

Note:

Some of the addenda are already included in the English-language PDF guides, but not in the PDF guides for other languages. These addenda are marked with the note (Localized only).

Administrator’s Guide

2.1. Authenticating Users With Active Directory (AD)

  • (Localized only) Addition of the following text before the first note in the Understanding Active Directory Authentication in the XenServer Environment section: To qualify a user name, you must enter the user name in Down-Level Logon Name format. For example, mydomain\myuser.

  • (Localized only) Removal of the following example text from the first note in the Understanding Active Directory Authentication in the XenServer Environment section: (for example, enter either mydomain\myuser or myser@mydomain.com).

2.2.2. Definitions of RBAC Roles and Permissions

  • (Localized only) In the Definitions of Permissions table, updates to the Allows Assignee to cell of the VM create/destroy operations row:

    • Original text:
      • Install or delete
      • Clone VMs
      • Add, remove, and configure virtual disk/CD devices
      • Add, remove, and configure virtual network devices
      • Import/export VMs
      • VM configuration change
    • Updated text:
      • Install or delete
      • Clone/copy VMs
      • Add, remove, and configure virtual disk/CD devices
      • Add, remove, and configure virtual network devices
      • Import/export XVA files
      • VM configuration change

3.9.3. Restart Priorities

  • (Localized only) This section has been rewritten. The following content replaces the existing section:

3.9.3. Restart configuration settings

Virtual machines can be considered protected, best-effort or unprotected by HA. The value of ha-restartpriority defines whether a VM is treated as protected, best-effort, or unprotected. The restart behavior for VMs in each of these categories is different.

  • Protected HA guarantees to restart a protected VM that goes offline or whose host goes offline, provided the pool is not overcommitted and the VM is agile. If a protected VM cannot be restarted at the time of a server failure (for example, if the pool was overcommitted when the failure occurred), further attempts to start this VM are made when extra capacity becomes available in a pool, which might now succeed.

    ha-restart-priorityvalue: restart

  • Best-effort If the host where a best-effort VM is running goes offline, HA attempts to restart the best-effort VM on another host only after all protected VMs have been successfully restarted. HA makes only one attempt to restart a best-effort VM and if this attempt fails no further restart is attempted.

    ha-restart-priorityvalue: besteffort

  • Unprotected If an unprotected VM or the host it runs on is stopped, HA does not attempt to restart the VM.

    ha-restart-priorityvalue: An empty string

Note:

HA never stops or migrates a running VM to free resources for a protected or best-effort VM to be restarted.

If the pool experiences server failures and enters a state where the number of tolerable failures drops to zero, the protected VMs are no longer guaranteed to be restarted. If this condition is reached, a system alert is generated.

In this case, if an additional failure occurs, all VMs that have a restart priority set behave according to the best-effort behavior.

3.9.3.1. Start order

The start order is the order in which XenServer HA attempts to restart protected VMs if a failure occurs. The start order is determined by the values of the order property for each of the protected VMs.

The order property of a VM is used by HA and also by other features that start and shutdown VMs. Any VM can have the order property set, not just those marked as protected for HA. However, HA uses the order property for protected VMs only.

The value of the order property is an integer. The default value is 0, which is the highest priority. Protected VMs with an order value of 0 are restarted first by HA. The higher the value of the order property, the later in the sequence the VM is restarted.

You can set the value of the order property of a VM by using the command-line interface:

xe vm-param-set uuid=<VM_UUID> order=<int>

Or in XenCenter, in the Start Options panel for a VM, set Start order to the required value.


3.10.1. Enabling HA Using the CLI

  • (Localized only) Updates to step 2:

    • Original text: For each VM you wish to protect, set a restart priority. You can do this as follows:

       xe vm-param-set uuid=<vm_uuid> ha-restart-priority=<1> ha-always-run=true
      
    • Update text: For each VM you wish to protect, set a restart priority and start order. You can do this as follows:

       xe vm-param-set uuid=<vm_uuid> ha-restart-priority=restart order=<1>
      

3.10.2. Removing HA Protection from a VM using the CLI

  • (Localized only) Updates to this section.

    • Original text: To disable HA features for a VM, use the xe vm-param-set command to set the ha-always-run parameter to false. This does not clear the VM restart priority settings. You can enable HA for a VM again by setting the ha-always-run parameter to true.

    • Updated text: To disable HA features for a VM, use the xe vm-param-set command to set the ha-restart-priority parameter to be an empty string. This does not clear the start order settings. You can enable HA for a VM again by setting the ha-restart-priority parameter to restart or best-effort as appropriate.

4.1. Networking Support

  • (Localized only) Correction of the number of supported bonded network interfaces

    • Original text: XenServer supports up to 16 physical network interfaces (or up to 8 bonded network interfaces) per XenServer host and up to 7 virtual network interfaces per VM.
    • Updated text: XenServer supports up to 16 physical network interfaces (or up to 4 bonded network interfaces) per XenServer host and up to 7 virtual network interfaces per VM.

4.3.5. NIC Bonds

  • (Localized only) Addition of the following note: NIC bonds are not supported on NICs that carry FCoE traffic.

4.4.6. Creating NIC Bonds in Resource Pools

  • (Localized only) Removal of the following section:

    Note:

    If you are not using &BRAND_CONSOLE; for NIC bonding, the quickest way to create pool-wide NIC bonds is to create the bond on the master, and then restart the other pool members. Alternatively, you can use the service xapi restart command. This causes the bond and VLAN settings on the master to be inherited by each host. The management interface of each host must, however, be manually reconfigured.

    Follow the procedure in previous sections to create a NIC Bond, see Adding NIC Bonds to a New Pool.

5.1.1. Storage Repositories (SRs)

  • (Localized only) Updates to the following paragraph:

    • Original text Each XenServer host can use multiple SRs and different SR types simultaneously. These SRs can be shared between hosts or dedicated to particular hosts. Shared storage is pooled between multiple hosts within a defined resource pool. A shared SR must be network accessible to each host. All hosts in a single resource pool must have at least one shared SR in common.
    • Updated text Each XenServer host can use multiple SRs and different SR types simultaneously. These SRs can be shared between hosts or dedicated to particular hosts. Shared storage is pooled between multiple hosts within a defined resource pool. A shared SR must be network accessible to each host in the pool. All hosts in a single resource pool must have at least one shared SR in common. Shared storage cannot be shared between multiple pools.

5.8.4.1. Limitations and Caveats

  • (Localized only) Removal of the following limitation: VDIs with more than one snapshot cannot be migrated.

5.7 PVS-Accelerator

  • Addition of the following text to the note:

    • The PVS-Accelerator feature is not supported in resource pools that are managed by the vSwitch Controller.
    • If you are using XenServer 7.1 with Cumulative Update 2 or later applied, ensure that you update your PVS Accelerator Supplemental Pack to the latest version provided on the XenServer Product Download page for XenServer 7.1 Cumulative Update 2. This version of the PVS Accelerator Supplemental Pack is the same as the version provided for XenServer 7.6 CR.

5.7.3. Caching Operation

  • (Localized only) Addition of the following point to the list of considerations:

    • Do not use a large port range for PVS server communication. Setting a range of more than 20 ports is rarely necessary. A large port range can slow packet processing and increase the boot time of the XenServer control domain when using PVS-Accelerator.

6.1. What is Dynamic Memory Control (DMC)?

  • (Localized only) Addition of the following note:

    Note:

    Dynamic Memory Control is not supported with VMs that have a virtual GPU.

6.2.3. Updating Memory Properties

  • (Localized only) Updates to a note to remove an unsupported operation.

    Original note: To alter the static maximum of a VM – you will need to suspend or shut down the VM

    Updated note: To alter the static maximum of a VM – you must shut down the VM

9.2.2. Configuring Performance Alerts Using the xe CLI

  • (Localized only) Addition of the following section after the note that says “Multiple <variable> nodes are allowed”

    After setting the new configuration, use the following command to refresh perfmon for each host:

     xe host-call-plugin host=<host_uuid> plugin=perfmon fn=refresh
    

    If this is not done,there will be a delay before the new configuration takes effect,since by default, perfmon checks for new configuration once every thirty minutes. This default can be changed in /etc/sysconfig/perfmon.

A.4. Secrets

  • (Localized only) Addition of new section with the following content:

    XenServer provides a secrets mechanism to avoid passwords being stored in plaintext in command-line history or on API objects. XenCenter uses this feature automatically and it can also be used from the xe CLI for any command that requires a password.

    Note: Password secrets cannot be used to authenticate with a XenServer host from a remote instance of the xe CLI.

    To create a secret object, run the following command on your XenServer host.

     xe secret-create value=my-password
    

    A secret is created and stored on the XenServer host. The command outputs the UUID of the secret object. For example, 99945d96-5890-de2a-3899-8c04ef2521db. Append _secret to the name of the password argument to pass this UUID to any command that requires a password.

    Example: On the XenServer host where you created the secret, you can run the following command:

     xe sr-create device-config:location=sr_address device-config:type=cifs device-config:username=cifs_username  \
        device-config:cifspassword_secret=secret_uuid name-label="CIFS ISO SR" type="iso" content-type="io" shared="true"
    

A.5.3.3. bond-destroy

  • (Localized only) Update to the example command.

    • Original text: host-bond-destroy uuid=<bond_uuid>

    • Updated text: bond-destroy uuid=<bond_uuid>

A.5.6.1. drtask-create

  • (Localized only) Update to the example command.

    • Original text: xe dr-task-create type=lvmoiscsi device-config:target=<target-ip-address> device-config:targetIQN=<targetIQN> device-config:SCSIid=<SCSIid> sr-whitelist=<sr-uuid-list>

    • Updated text: xe drtask-create type=lvmoiscsi device-config:target=<target-ip-address> device-config:targetIQN=<targetIQN> device-config:SCSIid=<SCSIid> sr-whitelist=<sr-uuid-list>

A.5.18. Template Commands

  • (Localized only) Addition of the following note.

    Note:

    Templates cannot be directly converted into VMs by setting the is-a-template parameter to false. Setting is-a-template parameter to false is not supported and results in a VM that cannot be started.

A.5.18.1. VM Template Parameters

  • (Localized only) Addition of the following text to the Description field of the is-a-template row of the table.

    After this value has been set to true it cannot be reset to false. Template VMs cannot be converted into VMs using this parameter.

  • (Localized only) Change to the text in the Description field of the ha-restart-priority row of the table to the following:

    restart or best effort

A.5.22.6. vdi-export

  • (Localized only) Addition of the following new section:

    vdi-export uuid=<uuid_of_vdi> filename=<filename_to import_from> [base=<uuid_of_base_vdi>] [format=<format>] [--progress]

    Export a VDI to the specified file name. You can export a VDI in one of the following formats:

    • raw
    • vhd

    The VHD format can be sparse. If there are unallocated blocks within the VDI, these blocks might be omitted from the VHD file, therefore making the VHD file smaller. You can export to VHD format from all supported VHDbased storage types (EXT, NFS). If you specify the base parameter, this command exports only those blocks that have changed between the exported VDI and the base VDI.

A.5.22.8. vdi-import

  • (Localized only) Update the content of this section to the following text:

    vdi-import uuid=<uuid_of_vdi> filename=<filename_to import_from> [format=<format>] [--progress]

    Import a VDI. You can import a VDI from one of the following formats:

    • raw
    • vhd

A.5.24.2. pool-vlan-create

  • (Localized only) Update to fix an error in a command.

    • Original text: vlan-create pif-uuid=<uuid_of_pif> vlan=<vlan_number> network-uuid=<uuid_of_network>

    • Updated text: pool-vlan-create pif-uuid=<uuid_of_pif> vlan=<vlan_number> network-uuid=<uuid_of_network>

A.5.25.1. VM Selectors

  • (Localized only) Update to fix an error in a command.

    • Original text: The full list of fields that can be matched can be obtained by the command xe vm-list params-all.

    • Updated text: The full list of fields that can be matched can be obtained by the command xe vm-list params=all.

A.5.25.2. VM Parameters

  • (Localized only) Addition of the following text to the Description field of the is-a-template row of the table.

    After this value has been set to true it cannot be reset to false. Template VMs cannot be converted into VMs using this parameter.

  • (Localized only) Update to the text in the Description field of the ha-restart-priority row of the table to the following:

    restart or best effort

Workload Balancing Administrator Guide

6.1.10.5. Changing the Database Maintenance Window

  • (Localized only) Addition of the following note after the first paragraph of the section:

    Note:

    To avoid a loss of Workload Balancing:

    • During the maintenance window, Workload Balancing server restarts. Ensure that you do not restart your VMs at the same time.
    • At other times, when restarting all VMs in your pool, do not restart the Workload Balancing server.

6.2 Upgrading Workload Balancing

  • (Localized only) This section has been removed and replaced with the following note:

    Online upgrading of Workload Balancing has been deprecated for security reasons. Customers cannot upgrade via yum repo anymore. Customers can upgrade WLB to the latest version by importing the latest WLB VPX downloadable at https://www.citrix.com/downloads/xenserver/product-software/.

vSwitch Controller User Guide

2.1 Deploying the vSwitch Controller Virtual Appliance

  • Addition of a note to this section that includes the following restriction:

    Note:

    vSwitch Controller is not supported in conjunction with the PVS-Accelerator feature. Do not use vSwitch controller to manage a resource pool that uses PVS-Accelerator.