Task commands, Task parameters, Sr-introduce | Citrix Systems 5.6

sr-introduce

sr-introduce name-label=<name>physical-size=<physical_size>type=<type> content-type=<content_type>uuid=<sr_uuid>

Just places an SR record into the database. The device-configparameters are specified by device- config:<parameter_key>=<parameter_value>, for example:

xe sr-introduce device-config:<device>=</dev/sdb1>

Note:

This command is never used in normal operation. It is an advanced operation which might be useful if an SR needs to be reconfigured as shared after it was created, or to help recover from various failure scenarios.

sr-probe

sr-probetype=<type> [host-uuid=<uuid_of_host>] [device-config:<config_name>=<value>]

Performs a backend-specific scan, using the provided device-configkeys. If the device-configis complete for the SR backend, then this will return a list of the SRs present on the device, if any. If the device-configparameters are only partial, then a backend-specific scan will be performed, returning results that will guide you in improving the remaining device-configparameters. The scan results are returned as backend-specific XML, printed out on the CLI.

The exact device-configparameters differ depending on the device type. See Storage for details of these parameters across the different storage backends.

sr-scan

sr-scan uuid=<sr_uuid>

Force an SR scan, syncing the xapi database with VDIs present in the underlying storage substrate.

Task commands

Commands for working with long-running asynchronous tasks. These are tasks such as starting, stopping, and suspending a Virtual Machine, which are typically made up of a set of other atomic subtasks that together accomplish the requested operation.

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

Task parameters

Tasks have the following parameters:

Parameter Name	Description	Type

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

name-label	the name of the Task	read only

176

Image 196

Citrix Systems 5.6 manual Task commands, Task parameters, Sr-introduce, Sr-probe, Sr-scan

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 User authentication Disabling external authenticationAllowing a user access to XenServer using the CLI Removing access for a user using the CLI Removing access for a user Listing subjects with accessTerminating all authenticated sessions using xe 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 Audit log xe CLI commands AuditingTo change a subjects Rbac role 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 High Availability HA OverviewOvercommitting Overcommitment Warning Configuration Requirements Restart priorities Enabling HA using the CLI Enabling HA on a XenServer pool Removing HA protection from a VM using the CLI Recovering an unreachable hostShutting down a host when HA is enabled 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 Storage Overview Storage Repositories SRsVirtual Disk Images VDIs 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 Creating a raw virtual disk using the xe CLI Upgrading LVM storage from XenServer 5.0 or earlierLVM performance considerations 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 Local LVM Local EXT3 VHDCreating a local LVM SR lvm 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 Access Control Thick or thin provisioningFAS Deduplication 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 Resizing an SR Converting local Fibre Channel SRs to shared SRsMoving Virtual Disk Images VDIs between 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 Using VLANs with host management interfaces Using VLANs with virtual machinesNetwork objects Networks Using VLANs with dedicated storage NICs NIC bonds Initial networking configuration Managing networking configurationCreating networks in a standalone server To add a new network using the CLI To connect a network to an external Vlan using the CLICreating networks in resource pools 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 Configuring a dedicated storage NIC Controlling Quality of Service QoSChanging networking configuration options To assign NIC functions using the xe CLI Changing IP address configuration for a standalone host Changing IP address configuration in resource poolsHostname DNS servers Disabling management access To change the IP address of a pool master hostManagement interface To change the NIC used for the management interface NIC/PIF ordering in resource pools Adding a new physical NICVerifying NIC ordering 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 Workload Balancing System Requirements Supported XenServer VersionsSupported Operating Systems 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 Initializing Workload Balancing Upgrading Workload Balancing on the Same Operating SystemUpgrading SQL Server Upgrading Workload Balancing and the Operating System To initialize Workload Balancing Authorization for Workload Balancing Configuring Workload Balancing Settings Configuring Antivirus Software To display the Workload Balancing Configuration dialog box Adjusting the Optimization ModeFixed 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 To enter maintenance mode with Workload Balancing enabled Working with Workload Balancing ReportsIntroduction Subscribing to Workload Balancing Reports Using Workload Balancing Reports for Tasks Generating and Managing Workload Balancing ReportsTo generate a Workload Balancing report To subscribe to a Workload Balancing report To navigate in a Workload Balancing Report To cancel a report subscriptionReport Toolbar Buttons Report Generation Features Displaying Workload Balancing ReportsTo print a Workload Balancing report 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 Backups To backup pool metadataTo backup host configuration and software 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 Regular Snapshots Quiesced SnapshotsSnapshots with memory 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 Custom Fields and Tags Custom SearchesDetermining 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 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 Xe command reference Bonding commandsBond parameters Bond-create CD commands CD parameters Console commands Console parametersCd-list 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-disable Host-emergency-management-reconfigureHost-bugreport-upload Host-crashdump-destroy Host-enable Host-evacuateHost-forget Host-get-system-status Host-get-system-status-capabilities Attribute Description Host-is-in-emergency-mode Host-apply-editionLicense-server-address License-server-port Host-management-disable Host-management-reconfigureHost-license-view Host-logs-download Host-power-on Host-set-power-onHost-reboot Host-restore Log commands Message commands Message parametersMessage-create Message-list Network commands Network parametersSubnet/netmask/gateway 192.168.0.4 Patch update commands Patch parametersNetwork-create Network-destroy PBD commands PBD parameters PIF commands Pbd-createPbd-destroy Pbd-plug PIF parameters MAC Dhcp Pif-introduce Pif-forgetPif-forget uuid=uuidofpif Pool commands Pool parameters Parameter Name Description Type Pool-emergency-reset-master Pool-ha-enablePool-designate-new-master Pool-dump-database Storage Manager commands SM parameters SR commands SR parameters Sr-create Sr-destroySr-forget Sr-destroy uuid=sruuid Task commands Task parametersSr-introduce 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 commands User commandsUpdate-upload User-password-change VBD commands VBD parameters Vbd-create VDI commands VDI parameters Vdi-clone Vdi-copyVdi-create Tree /local/domain/0/backend Vdi-destroy Vdi-forgetVdi-import Vdi-introduce VIF commands VIF parametersVdi-unlock Vdi-unlockuuid=uuidofvditounlock force=true Uuid=vifuuid \ Vif-create Vif-destroyVif-plug Vif-unplug Vlan commands VM commandsVM selectors 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-insert Vm-cd-listVm-cd-remove Vm-clone Vm-copy Vm-crashdump-listVm-data-source-forget Vm-data-source-list Vm-data-source-query Vm-data-source-recordVm-destroy Vm-disk-add Vm-disk-list Vm-disk-removeVm-export Vm-import Vm-memory-shadow-multiplier-set Vm-installVm-migrate Vm-reboot Vm-reset-powerstateVm-resume Vm-shutdown Vm-uninstall Vm-startVm-suspend Vm-vcpu-hotplug Workload Balancing commands Pool-certificate-list Pool-certificate-installPool-certificate-sync Pool-deconfigure-wlb Pool-retrieve-wlb-configurationPool-param-set Pool-retrieve-wlb-recommendations Pool-send-wlb-configuration Pool-send-wlb-configuration Index