VIF Commands, Vdi-snapshot, Vdi-unlock | Citrix Systems 6 specification

vdi-snapshot

vdi-snapshotuuid=<uuid_of_the_vdi> [driver-params=<params>]

Produces a read-write version of a VDI that can be used as a reference for backup and/or template creation purposes. You can perform a backup from a snapshot rather than installing and running backup software inside the VM. The VM can continue running while external backup software streams the contents of the snapshot to the backup media. Similarly, a snapshot can be used as a "gold image" on which to base a template. A template can be made using any VDIs.

The optional driver-paramsmap parameter can be used for passing extra vendor-specific configuration information to the back end storage driver that the VDI is based on. See the storage vendor driver documentation for details.

A clone of a snapshot should always produce a writable VDI.

vdi-unlock

vdi-unlockuuid=<uuid_of_vdi_to_unlock> [force=true]

Attempts to unlock the specified VDIs. If force=true is passed to the command, it will force the unlocking operation.

VIF Commands

Commands for working with VIFs (Virtual network interfaces).

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

VIF Parameters

VIFs have the following parameters:

Parameter Name	Description			Type

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

vm-uuid	the	unique	identifier/object	read only
	reference for the VM that this
	VIF resides on

vm-name-label	the name of the VM that this VIF			read only
	resides on

allowed-operations	a list of the operations allowed			read only set parameter
	in this state

current-operations	a list of the operations that are			read only set parameter
	currently in progress on this VIF

device	integer label of this VIF,			read only
	indicating the order in which VIF
	backends were created

MAC	MAC address of VIF, as exposed			read only
	to the VM

164

Image 182

Citrix Systems 6 manual VIF Commands, Vdi-snapshot, VIF Parameters, Vdi-unlockuuid=uuidofvditounlock force=true

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 increases flexibility by Benefits of Using XenServerUsing XenServer reduces costs by Introducing XenServer XenServer Editions New Features in XenServerAdministering XenServer Simplified Installer Rolling Pool Upgrade WizardDistributed Virtual Switch Improvements Microsoft Scvmm and Scom Support NFS Support for High Availability VM Protection and RecoveryXenServer Documentation XenCenter Improvements XenServer CLI Term Authenticating Users With Active Directory ADXenCenter Term Configuring Active Directory Authentication Upgrading XenServer Active Directory integration Port Protocol Use Disabling external authentication User AuthenticationEnabling external authentication on a pool Removing access for a user using the CLI Removing Access for a UserAllowing a user access to XenServer using the CLI Listing subjects with access Terminating individual user sessions using xe Role Based Access ControlTerminating all authenticated sessions using xe Leaving an AD Domain Roles Rbac process Permissions available for each role Definitions of Rbac Roles and PermissionsUsers role can be changed in two ways WLB Definitions of permissions Permission Allows Assignee To Rationale/Comments Permission Allows Assignee To Rationale/Comments Report Generated or its recipient Using Rbac with the CLI To List All the Available Defined Roles in XenServer To Display a List of Current Subjects To Assign an Rbac Role to a Created subject Run the command xe subject-add subject-name=AD user/groupTo Add a Subject to Rbac To Change a Subjects Rbac Role How Does XenServer Compute the Roles for the Session? Audit Log xe CLI CommandsAuditing To Obtain All Audit Records From the PoolPage Hosts and Resource Pools Overview Requirements for Creating Resource Pools Naming a resource pool Creating a Resource PoolCreating Heterogeneous Resource Pools Adding NFS shared storage to a resource pool using the CLI Adding Shared Storage Removing a XenServer Host from a Resource Pool Preparing a Pool of XenServer Hosts for MaintenanceTo remove a host from a resource pool using the CLI Overcommitting High AvailabilityHA Overview Host Fencing Configuration RequirementsOvercommitment Warning HA Always Run Explanation Restart PrioritiesHA Restart Priority Restart Explanation Enabling HA on a XenServer Pool Enabling HA Using the CLIRemoving HA Protection from a VM using the CLI Shutting Down a host When HA is Enabled Host Power OnRecovering an Unreachable Host Shutting Down a VM When it is Protected by HA To Turn on Hosts Remotely Using the CLI Using the CLI to Manage Host Power OnTo Enable Host Power On Using the CLI Key/Value Pairs Sample Script Result is only displayed when the script is unsuccessful Virtual Disk Images VDIs Storage OverviewStorage Repositories SRs Physical Block Devices PBDs Virtual Disk Data Formats Virtual Block Devices VBDsSummary of Storage objects VHD-based VDIs LUN-based VDIs VHD Chain Coalescing Storage type Maximum VDI size Storage Repository TypesLocal LVM Creating a Local LVM SR lvm Local EXT3 VHDUdev Creating a Local EXT3 SR ext Citrix StorageLink SRs XenServer Host iSCSI configurationSoftware iSCSI Support Upgrading XenServer with StorageLink SRs Creating a Shared StorageLink SR To Create a CSL SR Using XenCenter Parameter name Description Optional? To Create a CSL SR Using the CLI Page Sample QLogic iSCSI HBA setup Managing Hardware Host Bus Adapters HBAs Parameter Name Description LVM over iSCSIRemoving HBA-based SAS, FC or iSCSI Device Entries Parameter Name Description Hitachi NFS VHD Creating Storage Repositories Storage ConfigurationLVM over Hardware HBA Creating a Shared NFS SR NFS VDI Types Upgrading LVM Storage from XenServer 5.0 or EarlierLVM Performance Considerations Probing an SR Creating a Raw Virtual Disk Using the xe CLIConverting Between VDI Formats Following parameters can be probed for each SR type Page To enable storage multipathing using the xe CLI Storage Multipathing Destroying or Forgetting a SR Managing Storage RepositoriesMPP Rdac Driver Support for LSI Arrays Introducing an SR Resizing an SR Converting Local Fibre Channel SRs to Shared SRs Copying All of a VMs VDIs to a Different SR Adjusting the Disk IO SchedulerMoving Virtual Disk Images VDIs Between SRs Copying Individual VDIs to a Different SR Automatically Reclaiming Space When Deleting Snapshots Reclaiming Space Using the Off Line Coalesce Tool Virtual Disk QoS Settings Possible values of qosalgorithmparamsched arePage What is Dynamic Memory Control DMC? Concept of Dynamic Range How Does DMC Work? Concept of Static RangeDMC Behaviour Operating System Supported Memory Limits Memory ConstraintsSupported Operating Systems Xe CLI Commands Display the Static Memory Properties of a VM Display the Dynamic Memory Properties of a VM Updating Memory Properties Workload Balancing Interaction Upgrade IssuesUpdate Individual Memory Properties Setting Control Domain Memory Name Default Description Name Default Description VSwitch Networks Networking Support XenServer Networking Overview Network Objects NIC Bonds NetworksVLANs Page Switch Configuration Active-Active Bonding Active-Passive Bonding Cross-Server Private networks Managing Networking ConfigurationInitial Networking Configuration Creating Networks in a Standalone Server Creating Networks in Resource Pools To add a new network using the CLITo connect a network to an external Vlan using the CLI Creating VLANs Controlling the MAC Address of the Bond Creating a NIC bondBonding two NICs Adding NIC bonds to new resource pools Creating NIC bonds in resource poolsReverting NIC bonds Adding NIC bonds to an existing pool Configuring a dedicated storage NICTo assign NIC functions using the xe CLI Assigning a SR-IOV NIC VF to a VM Using SR-IOV Enabled NICsControlling the rate of outgoing data QoS Changing networking configuration options Networking Stack Configuration Methods Available Hostname Changing IP address configuration for a standalone hostChanging IP address configuration in resource pools DNS servers Primary management interface Networking TroubleshootingDisabling management access Adding a new physical NIC Recovering from a bad network configuration Diagnosing network corruption Disaster Recovery and Backup Understanding XenServer DR DR Infrastructure Requirements Deployment Considerations Enabling Disaster Recovery in XenCenterSteps to Take After a Recovery Steps to Take Before a Disaster Recovering VMs and vApps in the Event of Disaster Failover Recovery Wizard Test Failover VApps Creating vApps Using the Manage vApps dialog box in XenCenterBacking Up and Restoring XenServer Hosts and VMs Value Description To backup a VM To backup pool metadataTo backup host configuration and software To backup VM metadata only Backing up XenServer hosts Backing up single host installationsBacking up pooled installations To back up a XenServer host To restore a running XenServer hostBacking up VMs Restarting a crashed XenServer host Quiesced Snapshots VM SnapshotsRegular Snapshots Snapshots with memory To list the snapshots on a particular VM Creating a snapshot with memoryTo list all of the snapshots on a XenServer pool Restoring a VM to its previous state Deleting a snapshot Exporting a snapshot to a template Snapshot TemplatesCreating a template from a snapshot Advanced Notes for Quiesced Snapshots Naming convention for VM archive folders VM Protection and RecoveryCoping with machine failures Master failures Opt/xensource/sm/resetvdis.py hostUUID Sruuid masterMember failures Physical Machine failure Coping with Failure due to Configuration ErrorsPool failures To restore a pool with all hosts failed To restore a VM when VM storage is not available Alerts Alert Description Customizing Alerts Valid VM Elements Configuring Email Alerts Valid Host Elements Determining throughput of physical bus adapters Custom Fields and TagsCustom Searches To determine PBD throughput To write logs to a remote server XenServer host logsSending host log messages to a central server XenCenter logs Userprofile%\AppData\Citrix\XenCenter\logs\XenCenter.log Xe command-name argument=value argument=value Basic xe Syntax Class-list Command TypesSpecial Characters and Syntax Parameter Types Class-param-list uuid=uuid Low-level Parameter CommandsLow-level List Commands Appliance-assert-can-be-recovered Xe Command ReferenceAppliance Commands Appliance Parameters Audit Commands Bonding Commands CD Commands Cd-list Cd-listparams=param1,param2,... parameter=parametervalue Console Parameters Console CommandsDisaster Recovery DR Commands Drtask-create Sr-enable-database-replication Vm-assert-can-be-recoveredVm-recover Sr-disable-database-replication Class name Description Event CommandsEvent Classes GPU Commands Event-wait GPU Group Parameters Vgpu-destroy Host CommandsVgpu-create Host Selectors Host Parameters Syslogdestination Yyyymmdd-hhmmss-ABC, where ABC is Host-bugreport-upload Host-backupHost-disable Host-crashdump-destroy Host-evacuate Host-emergency-management-reconfigureHost-enable Host-forget Host-get-system-status-capabilities Attribute Description Host-apply-edition Host-management-disableHost-is-in-emergency-mode Host-license-add Host-get-cpu-features Host-management-reconfigureHost-power-on Host-set-cpu-features Host-set-hostname-live Host-restoreHost-syslog-reconfigure Host-shutdown Host-data-source-forget Host-data-source-listHost-data-source-record Host-data-source-query Log-set-output Log CommandsMessage Commands Message Parameters Message-list Network CommandsMessage-destroy Network Parameters Network-destroy Patch Update CommandsNetwork-create Patch Parameters PBD Commands Pbd-destroy PIF CommandsPbd-create Pbd-plug PIF Parameters MAC Full or half Pif-introduce Pif-reconfigure-ipPif-forget Pif-plug Pif-unplug Pool CommandsPif-scan Pool Parameters Pool-designate-new-master Pool-dump-database Pool-ha-disable Pool-emergency-reset-masterPool-ha-enable Pool-recover-slaves SM Parameters Storage Manager CommandsSR Commands SR Parameters Sr-create User Sr-introduce Sr-destroySr-forget Sr-probe Task Commands Task Parameters Task-cancel uuid=taskuuid Template CommandsTask-cancel Template Parameters For memory-dynamic-max Uuid=templateuuid \ Order or an Order Not YyyymmddThhmmss As not in database for Update Commands Template-export Update-upload User CommandsVBD Commands User-password-change Vbd-create Vbd-createvm-uuid=uuidofthevmdevice=devicevalue VDI Commands VDI Parameters VDI Vdi-create Vdi-cloneVdi-copy Local/domain/0/backend Vdi-import Vdi-destroyVdi-forget Vdi-introduce Vdi-unlock VIF CommandsVdi-snapshot VIF Parameters Disable 165 Vif-destroy Vlan CommandsVif-create Vif-plug VM Commands Parameter Name Description Type Uuid=vmuuid \ Order Value pair autopoweron true Vcpu-hotplug command Domain/domid/vm Vm-cd-insert Vm-cd-addVm-cd-eject Vm-cd-list Vm-copy Vm-cloneVm-compute-maximum-memory Vm-crashdump-list Vm-data-source-forget Vm-data-source-listVm-data-source-record Vm-data-source-query Vm-disk-list Vm-destroyVm-disk-add Vm-disk-remove Vm-install Vm-import Vm-memory-shadow-multiplier-set Vm-rebootVm-reset-powerstate Vm-migrate Vm-start Vm-resumeVm-shutdown Vm-suspend Workload Balancing XE Commands Host-retrieve-wlb-evacuate-recommendations Pool-retrieve-wlb-diagnosticsPool-certificate-install Vm-retrieve-wlb-recommendations Pool-retrieve-wlb-recommendations Pool-deconfigure-wlbPool-retrieve-wlb-configuration Pool-retrieve-wlb-report Pool-send-wlb-configuration 185 Service Commands To run the wlbconfig command Modifying the Workload Balancing configuration optionsEditing the Workload Balancing configuration file To edit the wlb.conf file Increasing the Detail in the Workload Balancing Log Logging Trace Flag Benefit or Purpose Option Logging Trace Flag Benefit or Purpose Option