Pool commands, Pool parameters | Citrix Systems 5.6 manual

pif-plug

pif-pluguuid=<uuid_of_pif>

Attempt to bring up the specified physical interface.

pif-reconfigure-ip

pif-reconfigure-ipuuid=<uuid_of_pif> [ mode=<dhcp> mode=<static> ] gateway=<network_gateway_address> IP=<static_ip_for_this_pif> netmask=<netmask_for_this_pif> [DNS=<dns_address>]

Modify the IP address of the PIF. For static IP configuration, set the mode parameter to static, with the gateway, IP, and netmask parameters set to the appropriate values. To use DHCP, set the mode parameter to DHCP and leave the static parameters undefined.

Note:

Using static IP addresses on physical network interfaces connected to a port on a switch using Spanning Tree Protocol with STP Fast Link turned off (or unsupported) results in a period during which there is no traffic.

pif-scan

pif-scanhost-uuid=<UUID of XenServer host>

Scan for new physical interfaces on a XenServer host.

pif-unplug

pif-unplug uuid=<uuid_of_pif>

Attempt to bring down the specified physical interface.

Pool commands

Commands for working with pools. A pool is an aggregate of one or more XenServer hosts. A pool uses one or more shared storage repositories so that the VMs running on one XenServer host in the pool can be migrated in near-real time (while still running, without needing to be shut down and brought back up) to another XenServer host in the pool. Each XenServer host is really a pool consisting of a single member by default. When a XenServer host is joined to a pool, it is designated as a member, and the pool it has joined becomes the master for the pool.

The singleton pool object can be listed with the standard object listing command (xe pool-list), and its parameters manipulated with the standard parameter commands. See the section called “Low-level param commands” for details.

Pool parameters

Pools have the following parameters:

Parameter Name	Description	Type

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

name-label	the name of the pool	read/write

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

170

Image 190

Citrix Systems 5.6 manual Pool commands, Pool parameters

Contents

Citrix XenServer 5.6 Administrators Guide Trademarks Table of Contents Managing users Storage ISO NFS VHD Configuring VM memory Viii Workload Balancing Page Page Backup and recovery 123 Monitoring and managing XenServer 136 Xiv Page Xvi Xvii Xviii Xix Index 214 Document Overview How this Guide relates to other documentation Authenticating users using Active Directory AD Managing users Configuring Active Directory authentication Upgrading from XenServer Enabling external authentication on a pool Allowing a user access to XenServer using the CLI User authenticationDisabling external authentication Removing access for a user using the CLI Terminating all authenticated sessions using xe Removing access for a userListing subjects with access Terminating individual user sessions using xe Role Based Access Control Roles Rbac process Users role can be changed in two ways Definitions of Rbac roles and permissionsPermissions available for each role Definitions of permissions WLB Definitions of permissions Permission Allows Assignee To Rationale/Comments Permission Allows Assignee To Rationale/Comments Permission Allows Assignee To Rationale/Comments Working with Rbac using the xe CLI To list all the available defined roles in XenServer 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 Audit log xe CLI commandsAuditing To obtain all audit records from the pool How does XenServer compute the roles for the session? Hosts and resource pools overview Requirements for creating resource pools Creating a resource pool Naming a resource pool Creating heterogeneous resource pools Adding shared storage To remove a host from a resource pool using the CLI Adding NFS shared storage to a resource pool using the CLIRemoving a XenServer host from a resource pool Overcommitting High AvailabilityHA Overview Overcommitment Warning Configuration Requirements Restart priorities Enabling HA using the CLI Enabling HA on a XenServer pool Shutting down a host when HA is enabled Removing HA protection from a VM using the CLIRecovering an unreachable host Shutting down a VM when it is protected by HA Powering on hosts remotely Host Power OnUsing the CLI to Manage Host Power On To turn on hosts remotely using the CLI To enable Host Power On using the CLIKey/Value Pairs Sample Script Possible values Virtual Disk Images VDIs Storage OverviewStorage Repositories SRs Physical Block Devices PBDs Summary of Storage objects Virtual Block Devices VBDsVirtual Disk Data Formats VHD-based VDIs VHD Chain Coalescing Creating Storage Repositories Storage configurationLUN-based VDIs LVM performance considerations Creating a raw virtual disk using the xe CLIUpgrading LVM storage from XenServer 5.0 or earlier VDI types Converting between VDI formats Probing an SR Following parameters can be probed for each SR type Page To enable storage multipathing using the xe CLI Storage Multipathing Storage Repository Types Creating a local LVM SR lvm Local LVMLocal EXT3 VHD Creating a local EXT3 SR ext EqualLogic UdevCreating a shared EqualLogic SR Parameter Name Description Optional? Creating a VDI using the CLI NetApp FlexVols Aggregates FAS Deduplication Access ControlThick or thin provisioning Licenses Creating a shared NetApp SR over iSCSI Managing VDIs in a NetApp SR Software iSCSI SupportTaking VDI snapshots with a NetApp SR Sample QLogic iSCSI HBA setup XenServer Host iSCSI configurationManaging Hardware Host Bus Adapters HBAs LVM over iSCSI Removing HBA-based SAS, FC or iSCSI device entries Parameter Name Description Optional? Hitachi NFS VHD LVM over hardware HBA Creating a shared NFS SR nfs Citrix StorageLink Gateway Cslg SRs Creating a shared StorageLink SR Parameter name Description Optional? To create a Cslg SR Page Managing Storage Repositories Destroying or forgetting a SR Introducing an SR Moving Virtual Disk Images VDIs between SRs Resizing an SRConverting local Fibre Channel SRs to shared SRs Copying all of a VMs VDIs to a different SR Virtual disk QoS settings Adjusting the disk IO scheduler Possible values of qosalgorithmparamsched are What is Dynamic Memory Control DMC? Concept of dynamic range DMC Behaviour Concept of static rangeHow does DMC Work? Memory constraints Supported operating systems Display the static memory properties of a VM Xe CLI commandsDisplay the dynamic memory properties of a VM Updating memory properties Update individual memory properties Upgrade issuesWorkload Balancing interaction Networking XenServer networking overview Network objects Using VLANs with host management interfacesUsing VLANs with virtual machines Networks Using VLANs with dedicated storage NICs NIC bonds Initial networking configuration Managing networking configurationCreating 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 Creating a NIC bond on a dual-NIC host Creating NIC bonds on a standalone hostBonding two NICs together Controlling the MAC address of the bond Creating NIC bonds in resource poolsReverting NIC bonds Adding NIC bonds to new resource pools Adding NIC bonds to an existing pool To add NIC bonds to the pool master and other hosts Changing networking configuration options Configuring a dedicated storage NICControlling Quality of Service QoS To assign NIC functions using the xe CLI Hostname Changing IP address configuration for a standalone hostChanging IP address configuration in resource pools DNS servers Management interface Disabling management accessTo change the IP address of a pool master host To change the NIC used for the management interface Verifying NIC ordering NIC/PIF ordering in resource poolsAdding a new physical NIC Re-ordering NICs Networking Troubleshooting Diagnosing network corruption Recovering from a bad network configuration New Features Whats New? Workload Balancing Overview Changes Workload Balancing Installation Overview Workload Balancing Basic Concepts Supported Operating Systems Workload Balancing System RequirementsSupported XenServer Versions Recommended Hardware SQL Server Database Authentication Requirements Workload Balancing Data Store Requirements Preinstallation Considerations Operating System Language Support Installing Workload Balancing WLB Access Control Permissions To install Workload Balancing server To verify your Workload Balancing installation Configuring Firewalls Upgrading Workload Balancing Upgrading SQL Server Initializing Workload BalancingUpgrading Workload Balancing on the Same Operating System Upgrading Workload Balancing and the Operating System To initialize Workload Balancing Authorization for Workload Balancing Configuring Workload Balancing Settings Configuring Antivirus Software Fixed To display the Workload Balancing Configuration dialog boxAdjusting the Optimization Mode Scheduled To set an optimization mode for all time periods Optimizing and Managing Power AutomaticallyTo edit or delete an automatic optimization interval Enabling Workload Balancing Power Management Accepting Optimization Recommendations Automatically 102 Changing the Critical Thresholds To select servers for power managementTo apply optimization recommendations automatically Default Settings for Critical Thresholds Tuning Metric WeightingsTo change the critical thresholds To edit metric weighting factors Excluding Hosts from Recommendations Historical Data Storage Time VM Optimization Criteria Number of Times an Optimization Recommendation is Made To configure VM Recommendation intervals To start a virtual machine on the optimal server To resume a virtual machine on the optimal server Accepting Optimization Recommendations Administering Workload BalancingTo accept an optimization recommendation Reconfiguring a Pool to Use Another WLB Server Disabling Workload Balancing Click Update Credentials Updating Workload Balancing Credentials Uninstalling Workload Balancing Entering Maintenance Mode with Workload Balancing EnabledCustomizing Workload Balancing Introduction To enter maintenance mode with Workload Balancing enabledWorking with Workload Balancing Reports Subscribing to Workload Balancing Reports To generate a Workload Balancing report Using Workload Balancing Reports for TasksGenerating and Managing Workload Balancing Reports To subscribe to a Workload Balancing report To navigate in a Workload Balancing Report To cancel a report subscriptionReport Toolbar Buttons To print a Workload Balancing report Report Generation FeaturesDisplaying Workload Balancing Reports Toolbar Buttons Workload Balancing Report Glossary Host Health History Pool Optimization Performance History Pool Audit Log History Pool Health Audit Log Event Names Pool Health History Pool Optimization History Virtual Machine Motion History Virtual Machine Performance History To backup host configuration and software BackupsTo backup pool metadata To backup a VM DR and metadata backup overview Full metadata backup and disaster recovery DRBackup and restore using xsconsole Moving SRs between hosts and Pools Using Portable SRs for Manual Multi-Site Disaster Recovery VM Snapshots Snapshots with memory Regular SnapshotsQuiesced Snapshots Creating a VM Snapshot To list all of the snapshots on a XenServer pool Creating a snapshot with memoryTo list the snapshots on a particular VM Restoring a VM to its previous state Deleting a snapshot Snapshot Templates Creating a template from a snapshot Exporting a snapshot to a template Advanced Notes for Quiesced Snapshots 132 Member failures Coping with machine failuresMaster failures Pool failures Coping with Failure due to Configuration ErrorsPhysical Machine failure To restore a pool with all hosts failed To restore a VM when VM storage is not available Monitoring and managing XenServer Alerts 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 Sending host log messages to a central server XenServer host logsTo write logs to a remote server XenCenter logs Userprofile%\AppData\Citrix\XenCenter\logs\XenCenter.log Xe command-name argument=value argument=value Basic xe syntax Special characters and syntax Command types Class-list Parameter types Low-level param commandsClass-param-list uuid=uuid Low-level list commands Bond parameters Xe command referenceBonding commands Bond-create CD commands CD parameters Cd-list Console commandsConsole parameters Cd-listparams=param1,param2,... parameter=parametervalue Event classes Event commandsEvent-wait Host selectors Host XenServer host commandsHost parameters Parameter Name Description Type Syslogdestination Host-backup Host-backupfile-name=backupfilenamehost=hostname Host-bugreport-upload Host-disableHost-emergency-management-reconfigure Host-crashdump-destroy Host-forget Host-enableHost-evacuate Host-get-system-status Host-get-system-status-capabilities Attribute Description License-server-address Host-is-in-emergency-modeHost-apply-edition License-server-port Host-license-view Host-management-disableHost-management-reconfigure Host-logs-download Host-reboot Host-power-onHost-set-power-on Host-restore Log commands Message-create Message commandsMessage parameters Message-list Subnet/netmask/gateway Network commandsNetwork parameters 192.168.0.4 Network-create Patch update commandsPatch parameters Network-destroy PBD commands PBD parameters Pbd-destroy PIF commandsPbd-create Pbd-plug PIF parameters MAC Dhcp Pif-introduce Pif-forgetPif-forget uuid=uuidofpif Pool commands Pool parameters Parameter Name Description Type Pool-designate-new-master Pool-emergency-reset-masterPool-ha-enable Pool-dump-database Storage Manager commands SM parameters SR commands SR parameters Sr-forget Sr-createSr-destroy Sr-destroy uuid=sruuid Sr-introduce Task commandsTask parameters Sr-probe Task-cancel Template commandsTask-cancel uuid=taskuuid Template parameters For memory-dynamic-max Uuid=vmuuid \ Parameter Name Description Type As not in database for YyyymmddThhmmss z Not in database for a Form yyyymmddThhmmss Update-upload Update commandsUser commands User-password-change VBD commands VBD parameters Vbd-create VDI commands VDI parameters Vdi-create Vdi-cloneVdi-copy Tree /local/domain/0/backend Vdi-import Vdi-destroyVdi-forget Vdi-introduce Vdi-unlock VIF commandsVIF parameters Vdi-unlockuuid=uuidofvditounlock force=true Uuid=vifuuid \ Vif-plug Vif-createVif-destroy Vif-unplug VM selectors Vlan commandsVM commands VM parameters Parameter Name Description Type Uuid=templateuuid \ Parameter Name Description Type Value pair autopoweron true VCPUs-number to a value Domain/domid/vm Vm-cd-eject Vm-cd-addVm-cd-ejectvm-selector=vmselectorvalue Vm-cd-remove Vm-cd-insertVm-cd-list Vm-clone Vm-data-source-forget Vm-copyVm-crashdump-list Vm-data-source-list Vm-destroy Vm-data-source-queryVm-data-source-record Vm-disk-add Vm-export Vm-disk-listVm-disk-remove Vm-import Vm-memory-shadow-multiplier-set Vm-installVm-migrate Vm-resume Vm-rebootVm-reset-powerstate Vm-shutdown Vm-suspend Vm-uninstallVm-start Vm-vcpu-hotplug Workload Balancing commands Pool-certificate-list Pool-certificate-installPool-certificate-sync Pool-param-set Pool-deconfigure-wlbPool-retrieve-wlb-configuration Pool-retrieve-wlb-recommendations Pool-send-wlb-configuration Pool-send-wlb-configuration Index