Template Commands, Task-cancel | Citrix Systems 6 guide

Parameter Name	Description	Type

subtasks	contains the UUID(s) of all the subtasks of	read only
	this task

task-cancel

task-cancel [uuid=<task_uuid>]

Direct the specified Task to cancel and return.

Template Commands

Commands for working with VM templates.

Templates are essentially VMs with the is-a-templateparameter set to true. A template is a "gold image" that contains all the various configuration settings to instantiate a specific VM. XenServer ships with a base set of templates, which are generic "raw" VMs that can boot an OS vendor installation CD (e.g. RHEL, CentOS, SLES, Windows). With XenServer you can create VMs, configure them in standard forms for your particular needs, and save a copy of them as templates for future use in VM deployment.

The template objects can be listed with the standard object listing command (xe template-list), and the parameters manipulated with the standard parameter commands. See the section called “Low-level Parameter Commands” for details.

Template Parameters

Templates have the following parameters:

Parameter Name	Description		Type

uuid	the	unique identifier/object	read only
	reference for the template

name-label	the name of the template		read/write

name-description	the description string of the		read/write
	template

user-version	string	for creators of VMs	read/write
	and templates to put version
	information

is-a-template	true if this is a template.		read/write
	Template VMs can never be
	started, they are used only for
	cloning other VMs

is-control-domain	true if this is a control domain		read only
	(domain 0 or a driver domain)

power-state	current power state; always		read only
	halted for a template

151

Image 169

Citrix Systems 6 manual Template Commands, Template Parameters, Task-cancel uuid=taskuuid

Contents

Citrix XenServer 6.0 Administrators Guide Trademarks Contents Storage ISO Configuring VM Memory Xen Memory Usage Disaster Recovery and Backup Monitoring and Managing XenServer 106 110 Page Host-bugreport-upload 129 Xiii Xiv Page Vm-compute-maximum-memory Workload Balancing Service Commands 186 Xviii Using XenServer reduces costs by Benefits of Using XenServerUsing XenServer increases flexibility by Introducing XenServer Administering XenServer New Features in XenServerXenServer Editions Distributed Virtual Switch Improvements Rolling Pool Upgrade WizardSimplified Installer Microsoft Scvmm and Scom Support XenServer Documentation VM Protection and RecoveryNFS Support for High Availability XenCenter Improvements XenCenter Term Authenticating Users With Active Directory ADXenServer CLI Term Upgrading XenServer Configuring Active Directory Authentication Port Protocol Use Active Directory integration Enabling external authentication on a pool User AuthenticationDisabling external authentication Allowing a user access to XenServer using the CLI Removing Access for a UserRemoving access for a user using the CLI Listing subjects with access Terminating all authenticated sessions using xe Role Based Access ControlTerminating individual user sessions using xe Leaving an AD Domain Rbac process Roles Users role can be changed in two ways Definitions of Rbac Roles and PermissionsPermissions available for each role WLB Permission Allows Assignee To Rationale/Comments Definitions of permissions Permission Allows Assignee To Rationale/Comments Report Generated or its recipient To List All the Available Defined Roles in XenServer Using Rbac with the CLI To Display a List of Current Subjects To Add a Subject to Rbac Run the command xe subject-add subject-name=AD user/groupTo Assign an Rbac Role to a Created subject To Change a Subjects Rbac Role Auditing Audit Log xe CLI CommandsHow Does XenServer Compute the Roles for the Session? To Obtain All Audit Records From the PoolPage Requirements for Creating Resource Pools Hosts and Resource Pools Overview Creating Heterogeneous Resource Pools Creating a Resource PoolNaming a resource pool Adding Shared Storage Adding NFS shared storage to a resource pool using the CLI To remove a host from a resource pool using the CLI Preparing a Pool of XenServer Hosts for MaintenanceRemoving a XenServer Host from a Resource Pool HA Overview High AvailabilityOvercommitting Overcommitment Warning Configuration RequirementsHost Fencing HA Restart Priority Restart Explanation Restart PrioritiesHA Always Run Explanation Removing HA Protection from a VM using the CLI Enabling HA Using the CLIEnabling HA on a XenServer Pool Recovering an Unreachable Host Host Power OnShutting Down a host When HA is Enabled Shutting Down a VM When it is Protected by HA To Enable Host Power On Using the CLI Using the CLI to Manage Host Power OnTo Turn on Hosts Remotely Using the CLI Sample Script Key/Value Pairs Result is only displayed when the script is unsuccessful Storage Repositories SRs Storage OverviewVirtual Disk Images VDIs Physical Block Devices PBDs Summary of Storage objects Virtual Block Devices VBDsVirtual Disk Data Formats VHD-based VDIs VHD Chain Coalescing LUN-based VDIs Local LVM Storage Repository TypesStorage type Maximum VDI size Udev Local EXT3 VHDCreating a Local LVM SR lvm Creating a Local EXT3 SR ext Software iSCSI Support XenServer Host iSCSI configurationCitrix StorageLink SRs Creating a Shared StorageLink SR Upgrading XenServer with StorageLink SRs Parameter name Description Optional? To Create a CSL SR Using XenCenter To Create a CSL SR Using the CLI Page Managing Hardware Host Bus Adapters HBAs Sample QLogic iSCSI HBA setup Removing HBA-based SAS, FC or iSCSI Device Entries LVM over iSCSIParameter Name Description Parameter Name Description Hitachi NFS VHD LVM over Hardware HBA Storage ConfigurationCreating Storage Repositories Creating a Shared NFS SR NFS LVM Performance Considerations Upgrading LVM Storage from XenServer 5.0 or EarlierVDI Types Converting Between VDI Formats Creating a Raw Virtual Disk Using the xe CLIProbing an SR Following parameters can be probed for each SR type Page Storage Multipathing To enable storage multipathing using the xe CLI MPP Rdac Driver Support for LSI Arrays Managing Storage RepositoriesDestroying or Forgetting a SR Introducing an SR Converting Local Fibre Channel SRs to Shared SRs Resizing an SR Moving Virtual Disk Images VDIs Between SRs Adjusting the Disk IO SchedulerCopying All of a VMs VDIs to a Different SR Copying Individual VDIs to a Different SR Reclaiming Space Using the Off Line Coalesce Tool Automatically Reclaiming Space When Deleting Snapshots Possible values of qosalgorithmparamsched are Virtual Disk QoS SettingsPage Concept of Dynamic Range What is Dynamic Memory Control DMC? DMC Behaviour Concept of Static RangeHow Does DMC Work? Supported Operating Systems Memory ConstraintsOperating System Supported Memory Limits Display the Static Memory Properties of a VM Xe CLI Commands Updating Memory Properties Display the Dynamic Memory Properties of a VM Update Individual Memory Properties Upgrade IssuesWorkload Balancing Interaction Name Default Description Setting Control Domain Memory Name Default Description Networking Support VSwitch Networks Network Objects XenServer Networking Overview VLANs NetworksNIC Bonds Page Switch Configuration Active-Active Bonding Active-Passive Bonding Initial Networking Configuration Managing Networking ConfigurationCross-Server Private networks Creating Networks in a Standalone Server To connect a network to an external Vlan using the CLI To add a new network using the CLICreating Networks in Resource Pools Creating VLANs Bonding two NICs Creating a NIC bondControlling the MAC Address of the Bond Reverting NIC bonds Creating NIC bonds in resource poolsAdding NIC bonds to new resource pools To assign NIC functions using the xe CLI Configuring a dedicated storage NICAdding NIC bonds to an existing pool Controlling the rate of outgoing data QoS Using SR-IOV Enabled NICsAssigning a SR-IOV NIC VF to a VM Networking Stack Configuration Methods Available Changing networking configuration options Changing IP address configuration in resource pools Changing IP address configuration for a standalone hostHostname DNS servers Disabling management access Networking TroubleshootingPrimary management interface Adding a new physical NIC Diagnosing network corruption Recovering from a bad network configuration Understanding XenServer DR Disaster Recovery and Backup DR Infrastructure Requirements Steps to Take After a Recovery Enabling Disaster Recovery in XenCenterDeployment Considerations Steps to Take Before a Disaster Recovering VMs and vApps in the Event of Disaster Failover Test Failover Recovery Wizard VApps Backing Up and Restoring XenServer Hosts and VMs Using the Manage vApps dialog box in XenCenterCreating vApps Value Description To backup host configuration and software To backup pool metadataTo backup a VM To backup VM metadata only Backing up pooled installations Backing up single host installationsBacking up XenServer hosts Backing up VMs To restore a running XenServer hostTo back up a XenServer host Restarting a crashed XenServer host Regular Snapshots VM SnapshotsQuiesced Snapshots Snapshots with memory To list all of the snapshots on a XenServer pool Creating a snapshot with memoryTo list the snapshots on a particular VM Deleting a snapshot Restoring a VM to its previous state Creating a template from a snapshot Snapshot TemplatesExporting a snapshot to a template Advanced Notes for Quiesced Snapshots Coping with machine failures VM Protection and RecoveryNaming convention for VM archive folders Member failures Opt/xensource/sm/resetvdis.py hostUUID Sruuid masterMaster failures Pool failures Coping with Failure due to Configuration ErrorsPhysical Machine failure To restore a VM when VM storage is not available To restore a pool with all hosts failed Alert Description Alerts Valid VM Elements Customizing Alerts Valid Host Elements Configuring Email Alerts Custom Searches Custom Fields and TagsDetermining throughput of physical bus adapters To determine PBD throughput Sending host log messages to a central server XenServer host logsTo write logs to a remote server Userprofile%\AppData\Citrix\XenCenter\logs\XenCenter.log XenCenter logs Basic xe Syntax Xe command-name argument=value argument=value Special Characters and Syntax Command TypesClass-list Parameter Types Low-level List Commands Low-level Parameter CommandsClass-param-list uuid=uuid Appliance Commands Xe Command ReferenceAppliance-assert-can-be-recovered Appliance Parameters Audit Commands CD Commands Bonding Commands Cd-listparams=param1,param2,... parameter=parametervalue Cd-list Disaster Recovery DR Commands Console CommandsConsole Parameters Drtask-create Vm-recover Vm-assert-can-be-recoveredSr-enable-database-replication Sr-disable-database-replication Event Classes Event CommandsClass name Description Event-wait GPU Commands GPU Group Parameters Vgpu-create Host CommandsVgpu-destroy Host Selectors Host Parameters Syslogdestination Yyyymmdd-hhmmss-ABC, where ABC is Host-disable Host-backupHost-bugreport-upload Host-crashdump-destroy Host-enable Host-emergency-management-reconfigureHost-evacuate Host-forget Attribute Description Host-get-system-status-capabilities Host-is-in-emergency-mode Host-management-disableHost-apply-edition Host-license-add Host-power-on Host-management-reconfigureHost-get-cpu-features Host-set-cpu-features Host-syslog-reconfigure Host-restoreHost-set-hostname-live Host-shutdown Host-data-source-record Host-data-source-listHost-data-source-forget Host-data-source-query Message Commands Log CommandsLog-set-output Message Parameters Message-destroy Network CommandsMessage-list Network Parameters Network-create Patch Update CommandsNetwork-destroy Patch Parameters PBD Commands Pbd-create PIF CommandsPbd-destroy Pbd-plug MAC PIF Parameters Full or half Pif-forget Pif-reconfigure-ipPif-introduce Pif-plug Pif-scan Pool CommandsPif-unplug Pool Parameters Pool-dump-database Pool-designate-new-master Pool-ha-enable Pool-emergency-reset-masterPool-ha-disable Pool-recover-slaves SR Commands Storage Manager CommandsSM Parameters SR Parameters User Sr-create Sr-forget Sr-destroySr-introduce Sr-probe Task Parameters Task Commands Task-cancel Template CommandsTask-cancel uuid=taskuuid Template Parameters For memory-dynamic-max Uuid=templateuuid \ Order Order or an YyyymmddThhmmss Not As not in database for Template-export Update Commands VBD Commands User CommandsUpdate-upload User-password-change Vbd-createvm-uuid=uuidofthevmdevice=devicevalue Vbd-create VDI Commands VDI VDI Parameters Vdi-copy Vdi-cloneVdi-create Local/domain/0/backend Vdi-forget Vdi-destroyVdi-import Vdi-introduce Vdi-snapshot VIF CommandsVdi-unlock VIF Parameters Disable 165 Vif-create Vlan CommandsVif-destroy Vif-plug VM Commands Parameter Name Description Type Uuid=vmuuid \ Order Value pair autopoweron true Vcpu-hotplug command Domain/domid/vm Vm-cd-eject Vm-cd-addVm-cd-insert Vm-cd-list Vm-compute-maximum-memory Vm-cloneVm-copy Vm-crashdump-list Vm-data-source-record Vm-data-source-listVm-data-source-forget Vm-data-source-query Vm-disk-add Vm-destroyVm-disk-list Vm-disk-remove Vm-import Vm-install Vm-reset-powerstate Vm-rebootVm-memory-shadow-multiplier-set Vm-migrate Vm-shutdown Vm-resumeVm-start Vm-suspend Workload Balancing XE Commands Pool-certificate-install Pool-retrieve-wlb-diagnosticsHost-retrieve-wlb-evacuate-recommendations Vm-retrieve-wlb-recommendations Pool-retrieve-wlb-configuration Pool-deconfigure-wlbPool-retrieve-wlb-recommendations Pool-retrieve-wlb-report Pool-send-wlb-configuration 185 Service Commands Editing the Workload Balancing configuration file Modifying the Workload Balancing configuration optionsTo run the wlbconfig command To edit the wlb.conf file Logging Trace Flag Benefit or Purpose Option Increasing the Detail in the Workload Balancing Log Logging Trace Flag Benefit or Purpose Option