PowerShell cmdlet reference
This reference describes the 399 cmdlets in the XenServer PowerShell module: what each one does, its syntax and parameters, what it accepts from and returns to the pipeline, and examples of its use.
The same content is available in PowerShell itself. After importing the module, use
Get-Help with the name of a cmdlet, for example:
Get-Help Get-XenVM -Full
Get-Help Invoke-XenVM -Examples
The cmdlets are grouped by the class of object they work with. Two further groups hold the cmdlets for connecting to a pool and the cmdlets that transfer files over HTTP. For an introduction to the module, see Using the XenServer PowerShell module.
Cmdlets by group
| Group | Description |
|---|---|
| Connection and session cmdlets | Cmdlets for connecting to a XenServer pool, managing the sessions the other cmdlets run in, and building object references. |
| Auth cmdlets | |
| Bond cmdlets | A Network bond that combines physical network interfaces, also known as link aggregation. |
| Caller cmdlets | XAPI caller description and rate limiting. |
| Certificate cmdlets | An X509 certificate used for TLS connections. |
| Cluster cmdlets | Cluster-wide Cluster metadata. |
| ClusterHost cmdlets | Cluster member metadata. |
| Console cmdlets | A console. |
| Crashdump cmdlets | A VM crashdump. |
| DriverVariant cmdlets | UNSUPPORTED. |
| DRTask cmdlets | DR task. |
| Feature cmdlets | A new piece of functionality. |
| GPUGroup cmdlets | A group of compatible GPUs across the resource pool. |
| Host cmdlets | A physical host. |
| HostCpu cmdlets | A physical CPU. |
| HostCrashdump cmdlets | Represents a host crash dump. |
| HostDriver cmdlets | UNSUPPORTED. |
| HostMetrics cmdlets | The metrics associated with a host. |
| HostPatch cmdlets | Represents a patch stored on a server. |
| LVHD cmdlets | |
| Message cmdlets | A message for the attention of the administrator. |
| Network cmdlets | A virtual network. |
| NetworkSriov cmdlets | Network-sriov which connects logical pif and physical pif. |
| Observer cmdlets | Describes an observer which will control observability activity in the Toolstack. |
| PBD cmdlets | The physical block devices through which hosts access SRs. |
| PCI cmdlets | A PCI device. |
| PGPU cmdlets | A physical GPU (pGPU). |
| PIF cmdlets | A physical network interface (note separate VLANs are represented as several PIFs). |
| PIFMetrics cmdlets | The metrics associated with a physical network interface. |
| Pool cmdlets | Pool-wide information. |
| PoolPatch cmdlets | Pool-wide patches. |
| PoolUpdate cmdlets | Pool-wide updates to the host software. |
| PUSB cmdlets | A physical USB device. |
| PVSCacheStorage cmdlets | Describes the storage that is available to a PVS site for caching purposes. |
| PVSProxy cmdlets | A proxy connects a VM/VIF with a PVS site. |
| PVSServer cmdlets | Individual machine serving provisioning (block) data. |
| PVSSite cmdlets | Machines serving blocks of data for provisioning VMs. |
| RateLimit cmdlets | A rate limiter associated with one or more callers. |
| Repository cmdlets | Repository for updates. |
| Role cmdlets | A set of permissions associated with a subject. |
| SDNController cmdlets | Describes the SDN controller that is to connect with the pool. |
| Secret cmdlets | A secret. |
| SM cmdlets | A storage manager plugin. |
| SR cmdlets | A storage repository. |
| Subject cmdlets | A user or group that can log in xapi. |
| Task cmdlets | A long-running asynchronous task. |
| Tunnel cmdlets | A tunnel for network traffic. |
| USBGroup cmdlets | A group of compatible USBs across the resource pool. |
| User cmdlets | A user of the system. |
| VBD cmdlets | A virtual block device. |
| VBDMetrics cmdlets | The metrics associated with a virtual block device. |
| VDI cmdlets | A virtual disk image. |
| VGPU cmdlets | A virtual GPU (vGPU). |
| VGPUType cmdlets | A type of virtual GPU. |
| VIF cmdlets | A virtual network interface. |
| VIFMetrics cmdlets | The metrics associated with a virtual network device. |
| VLAN cmdlets | A VLAN mux/demux. |
| VM cmdlets | A virtual machine (or 'guest'). |
| VMAppliance cmdlets | VM appliance. |
| VMGroup cmdlets | A VM group. |
| VMGuestMetrics cmdlets | The metrics reported by the guest (as opposed to inferred from outside). |
| VMMetrics cmdlets | The metrics associated with a VM. |
| VMPP cmdlets | VM Protection Policy. |
| VMSS cmdlets | VM Snapshot Schedule. |
| VTPM cmdlets | A virtual TPM device. |
| VUSB cmdlets | Describes the vusb device. |
| File transfer cmdlets | Cmdlets that move data to and from a XenServer host over HTTP: exporting and importing VMs and disks, downloading logs, reports and performance data, and uploading updates. |