Manuals / Citrix Systems / Computer Equipment / Server

Citrix Systems 5.6 manual Pool commands, Pool parameters

Models: 5.6

1 235

Download 235 pages 37.88 Kb

Page 190

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 usersStorage 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 documentationAuthenticating users using Active Directory AD Managing usersConfiguring Active Directory authentication Upgrading from XenServerEnabling 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 CLITerminating all authenticated sessions using xe Removing access for a userListing subjects with access Terminating individual user sessions using xeRole Based Access Control Roles Rbac processUsers role can be changed in two ways Definitions of Rbac roles and permissionsPermissions available for each role Definitions of permissions WLBDefinitions of permissions Permission Allows Assignee To Rationale/CommentsPermission 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 XenServerTo 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 poolHow does XenServer compute the roles for the session? Hosts and resource pools overview Requirements for creating resource poolsCreating a resource pool Naming a resource poolCreating heterogeneous resource pools Adding shared storageTo 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 WarningConfiguration Requirements Restart prioritiesEnabling HA using the CLI Enabling HA on a XenServer poolShutting 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 HAPowering 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 valuesVirtual Disk Images VDIs Storage OverviewStorage Repositories SRs Physical Block Devices PBDsSummary of Storage objects Virtual Block Devices VBDsVirtual Disk Data Formats VHD-based VDIs VHD Chain CoalescingCreating 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 typesConverting between VDI formats Probing an SRFollowing parameters can be probed for each SR type Page To enable storage multipathing using the xe CLI Storage MultipathingStorage Repository Types Creating a local LVM SR lvm Local LVMLocal EXT3 VHD Creating a local EXT3 SR extEqualLogic UdevCreating a shared EqualLogic SR Parameter Name Description Optional? Creating a VDI using the CLI NetAppFlexVols AggregatesFAS Deduplication Access ControlThick or thin provisioning LicensesCreating 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 entriesParameter Name Description Optional? Hitachi NFS VHD LVM over hardware HBA Creating a shared NFS SR nfsCitrix StorageLink Gateway Cslg SRs Creating a shared StorageLink SRParameter name Description Optional? To create a Cslg SR Page Managing Storage Repositories Destroying or forgetting a SR Introducing an SRMoving 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 SRVirtual disk QoS settings Adjusting the disk IO schedulerPossible values of qosalgorithmparamsched are What is Dynamic Memory Control DMC? Concept of dynamic rangeDMC Behaviour Concept of static rangeHow does DMC Work? Memory constraints Supported operating systemsDisplay 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 overviewNetwork objects Using VLANs with host management interfacesUsing VLANs with virtual machines NetworksUsing VLANs with dedicated storage NICs NIC bondsInitial 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 VLANsCreating 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 CLIHostname Changing IP address configuration for a standalone hostChanging IP address configuration in resource pools DNS serversManagement interface Disabling management accessTo change the IP address of a pool master host To change the NIC used for the management interfaceVerifying NIC ordering NIC/PIF ordering in resource poolsAdding a new physical NIC Re-ordering NICsNetworking Troubleshooting Diagnosing network corruptionRecovering from a bad network configuration New Features Whats New?Workload Balancing Overview ChangesWorkload Balancing Installation Overview Workload Balancing Basic ConceptsSupported Operating Systems Workload Balancing System RequirementsSupported XenServer Versions Recommended HardwareSQL Server Database Authentication Requirements Workload Balancing Data Store RequirementsPreinstallation Considerations Operating System Language SupportInstalling Workload Balancing WLB Access Control PermissionsTo install Workload Balancing server To verify your Workload Balancing installation Configuring Firewalls Upgrading Workload BalancingUpgrading SQL Server Initializing Workload BalancingUpgrading Workload Balancing on the Same Operating System Upgrading Workload Balancing and the Operating SystemTo initialize Workload Balancing Authorization for Workload Balancing Configuring Workload Balancing Settings Configuring Antivirus SoftwareFixed To display the Workload Balancing Configuration dialog boxAdjusting the Optimization Mode ScheduledTo 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 Automatically102 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 RecommendationsHistorical Data Storage Time VM Optimization CriteriaNumber 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 serverAccepting Optimization Recommendations Administering Workload BalancingTo accept an optimization recommendation Reconfiguring a Pool to Use Another WLB Server Disabling Workload BalancingClick Update Credentials Updating Workload Balancing CredentialsUninstalling 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 ReportsTo generate a Workload Balancing report Using Workload Balancing Reports for TasksGenerating and Managing Workload Balancing Reports To subscribe to a Workload Balancing reportTo 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 ButtonsWorkload Balancing Report Glossary Host Health HistoryPool Optimization Performance History Pool Audit Log HistoryPool Health Audit Log Event NamesPool Health History Pool Optimization HistoryVirtual Machine Motion History Virtual Machine Performance HistoryTo backup host configuration and software BackupsTo backup pool metadata To backup a VMDR 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 SnapshotsSnapshots with memory Regular SnapshotsQuiesced Snapshots Creating a VM SnapshotTo 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 snapshotSnapshot Templates Creating a template from a snapshotExporting a snapshot to a template Advanced Notes for Quiesced Snapshots132 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 availableMonitoring and managing XenServer AlertsCustomizing Alerts Valid VM ElementsConfiguring Email Alerts Valid Host ElementsDetermining throughput of physical bus adapters Custom Fields and TagsCustom Searches To determine PBD throughputSending host log messages to a central server XenServer host logsTo write logs to a remote server XenCenter logs Userprofile%\AppData\Citrix\XenCenter\logs\XenCenter.logXe command-name argument=value argument=value Basic xe syntaxSpecial characters and syntax Command types Class-listParameter types Low-level param commandsClass-param-list uuid=uuid Low-level list commands Bond parameters Xe command referenceBonding commands Bond-createCD commands CD parametersCd-list Console commandsConsole parameters Cd-listparams=param1,param2,... parameter=parametervalueEvent classes Event commandsEvent-wait Host selectors Host XenServer host commandsHost parameters Parameter Name Description Type Syslogdestination Host-backup Host-backupfile-name=backupfilenamehost=hostnameHost-bugreport-upload Host-disableHost-emergency-management-reconfigure Host-crashdump-destroyHost-forget Host-enableHost-evacuate Host-get-system-statusHost-get-system-status-capabilities Attribute DescriptionLicense-server-address Host-is-in-emergency-modeHost-apply-edition License-server-portHost-license-view Host-management-disableHost-management-reconfigure Host-logs-downloadHost-reboot Host-power-onHost-set-power-on Host-restoreLog commands Message-create Message commandsMessage parameters Message-listSubnet/netmask/gateway Network commandsNetwork parameters 192.168.0.4Network-create Patch update commandsPatch parameters Network-destroyPBD commands PBD parametersPbd-destroy PIF commandsPbd-create Pbd-plugPIF parameters MACDhcp Pif-introduce Pif-forgetPif-forget uuid=uuidofpif Pool commands Pool parametersParameter Name Description Type Pool-designate-new-master Pool-emergency-reset-masterPool-ha-enable Pool-dump-databaseStorage Manager commands SM parametersSR commands SR parametersSr-forget Sr-createSr-destroy Sr-destroy uuid=sruuidSr-introduce Task commandsTask parameters Sr-probeTask-cancel Template commandsTask-cancel uuid=taskuuid Template parameters For memory-dynamic-max Uuid=vmuuid \ Parameter Name Description Type As not in database for YyyymmddThhmmss zNot in database for a Form yyyymmddThhmmss Update-upload Update commandsUser commands User-password-changeVBD commands VBD parametersVbd-create VDI commands VDI parameters Vdi-create Vdi-cloneVdi-copy Tree /local/domain/0/backendVdi-import Vdi-destroyVdi-forget Vdi-introduceVdi-unlock VIF commandsVIF parameters Vdi-unlockuuid=uuidofvditounlock force=trueUuid=vifuuid \ Vif-plug Vif-createVif-destroy Vif-unplugVM selectors Vlan commandsVM commands VM parametersParameter 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-cloneVm-data-source-forget Vm-copyVm-crashdump-list Vm-data-source-listVm-destroy Vm-data-source-queryVm-data-source-record Vm-disk-addVm-export Vm-disk-listVm-disk-remove Vm-importVm-memory-shadow-multiplier-set Vm-installVm-migrate Vm-resume Vm-rebootVm-reset-powerstate Vm-shutdownVm-suspend Vm-uninstallVm-start Vm-vcpu-hotplugWorkload Balancing commands Pool-certificate-list Pool-certificate-installPool-certificate-sync Pool-param-set Pool-deconfigure-wlbPool-retrieve-wlb-configuration Pool-retrieve-wlb-recommendationsPool-send-wlb-configuration Pool-send-wlb-configurationIndex