Pool-deconfigure-wlb, Pool-retrieve-wlb-report | Citrix Systems 6

pool-deconfigure-wlb

Permanently deletes all workload balancing configuration.

pool-retrieve-wlb-configuration

Prints all Workload Balancing configuration information to standard out.

pool-retrieve-wlb-recommendations

Prints all Workload Balancing recommendations to standard out.

pool-retrieve-wlb-report

Gets a Workload Balancing report of the specified type and saves it to the specified file. XenCenter uses this command when executing Workload Balancing reports. However, running this command from the CLI does not output report data in a graphical format. Outputting reports requires using the XenCenter Pool > View Workload Reports menu command. The available reports are:

•pool_health

•host_health_history

•optimization_performance_history

•pool_optimization_history

•pool_health_history

•vm_chargeback_history

•pool_audit_history

•vm_movement_history

•vm_performance_history

Example usage for each report type is shown below. The utcoffset parameter specifies the number of hours the pool's time zone is ahead or behind Coordinated Universal Time (UTC). For example, <-5>represents the Eastern Standard Time zone in North America, which is five hours behind UTC. The start parameter and end parameters specify the number of hours to report. For example specifying start=-3and end=0 will cause Workload Balancing to report on the last three hours of activity. LocaleCode represents the language for the report output. You can enter either <en> for English or <ja> for Japanese.

xe pool-retrieve-wlb-report report=pool_health \ LocaleCode=<en> \

Start=<-3>\ End=<0> \

PoolID=<c75f9ee9-422f-9cde-4781-24f6cbd9279c>\ UTCOffset=<-5>\ filename=/<pool_health>.txt \

xe pool-retrieve-wlb-report report=host_health_history \ Start=<-3>\

End=<0> \

PoolID=<c75f9ee9-422f-9cde-4781-24f6cbd9279c>\ HostID=<471626e5-8e8b-429b-9990-6013726d7e86>\ UTCOffset=<-5>\ filename=/<host_health_history.txt> \

xe pool-retrieve-wlb-report report=optimization_performance_history \ LocaleCode=<en> \

Start=-3 \ End=0 \

PoolID=c75f9ee9-422f-9cde-4781-24f6cbd9279c \ UTCOffset=-5 \ filename=</optimization_performance_history>.txt \

183

Image 201

Citrix Systems 6 manual Pool-deconfigure-wlb, Pool-retrieve-wlb-configuration, Pool-retrieve-wlb-recommendations

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 New Features in XenServer Administering 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 Authenticating Users With Active Directory AD XenCenter TermXenServer CLI Term Upgrading XenServer Configuring Active Directory Authentication Port Protocol Use Active Directory integration User Authentication Enabling external authentication on a poolDisabling 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 Definitions of Rbac Roles and Permissions Users role can be changed in two waysPermissions 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 a Resource Pool Creating Heterogeneous Resource PoolsNaming a resource pool Adding Shared Storage Adding NFS shared storage to a resource pool using the CLI Preparing a Pool of XenServer Hosts for Maintenance To remove a host from a resource pool using the CLIRemoving a XenServer Host from a Resource Pool High Availability HA OverviewOvercommitting Configuration Requirements Overcommitment WarningHost Fencing Restart Priorities HA Restart Priority Restart ExplanationHA Always Run Explanation Enabling HA Using the CLI Removing HA Protection from a VM 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 Using the CLI to Manage Host Power On To Enable Host Power On Using the CLITo 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 Storage Repository Types Local LVMStorage type Maximum VDI size Udev Local EXT3 VHDCreating a Local LVM SR lvm Creating a Local EXT3 SR ext XenServer Host iSCSI configuration Software iSCSI SupportCitrix 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 LVM over iSCSI Removing HBA-based SAS, FC or iSCSI Device EntriesParameter Name Description Parameter Name Description Hitachi NFS VHD LVM over Hardware HBA Storage ConfigurationCreating Storage Repositories Creating a Shared NFS SR NFS Upgrading LVM Storage from XenServer 5.0 or Earlier LVM Performance ConsiderationsVDI Types Creating a Raw Virtual Disk Using the xe CLI Converting Between VDI FormatsProbing 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? Concept of Static Range DMC BehaviourHow Does DMC Work? Memory Constraints Supported Operating SystemsOperating 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 Upgrade Issues Update Individual Memory PropertiesWorkload Balancing Interaction Name Default Description Setting Control Domain Memory Name Default Description Networking Support VSwitch Networks Network Objects XenServer Networking Overview Networks VLANsNIC Bonds Page Switch Configuration Active-Active Bonding Active-Passive Bonding Managing Networking Configuration Initial 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 Creating a NIC bond Bonding two NICsControlling the MAC Address of the Bond Creating NIC bonds in resource pools Reverting NIC bondsAdding NIC bonds to new resource pools Configuring a dedicated storage NIC To assign NIC functions using the xe CLIAdding NIC bonds to an existing pool Using SR-IOV Enabled NICs Controlling the rate of outgoing data QoSAssigning 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 single host installations Backing up pooled 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 Creating a snapshot with memory To list all of the snapshots on a XenServer poolTo list the snapshots on a particular VM Deleting a snapshot Restoring a VM to its previous state Snapshot Templates Creating a template from a snapshotExporting a snapshot to a template Advanced Notes for Quiesced Snapshots VM Protection and Recovery Coping with machine failuresNaming convention for VM archive folders Opt/xensource/sm/resetvdis.py hostUUID Sruuid master Member failuresMaster failures Coping with Failure due to Configuration Errors Pool failuresPhysical 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 XenServer host logs Sending host log messages to a central serverTo 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 Command Types Special Characters and SyntaxClass-list Parameter Types Low-level Parameter Commands Low-level List 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 Commands Event ClassesClass 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