Transcription
Citrix Provisioning Services 7.15PowerShell with Objects Programmer’s GuideRevision 1August 2017
Copyright and Trademark NoticeInformation in this document is subject to change without notice. Companies, names, and data used inexamples herein are fictitious unless otherwise noted. Other than printing one copy for personal use, nopart of this document may be reproduced or transmitted in any form or by any means, electronic ormechanical, for any purpose, without the express written permission of Citrix Systems, Inc.Copyright 2001—2017 Citrix Systems, Inc. All rights reserved.Citrix, ICA (Independent Computing Architecture), NetScaler, and Program Neighborhood are registeredtrademarks; Citrix Presentation Server, Citrix Access Essentials, Citrix Access Gateway, Citrix PasswordManager, Citrix Application Firewall, Citrix Application Gateway, Citrix Provisioning Services, CitrixStreaming Profiler, Citrix Streaming Client, Citrix Streaming Service, Citrix EdgeSight, Citrix WANScaler,Citrix SmoothRoaming, Citrix Authorized Learning Center, Citrix Subscription Advantage, Citrix TechnicalSupport, and Speed Screen are trademarks of Citrix Systems, Inc. in the United States and othercountries.Copyright RSA Encryption 1996—1998 RSA Security Inc. All rights reserved.
Table of ContentsIntroduction . 12Using the PowerShell Programmer Interface with Objects . 12Installation of PowerShell Snap-In . 12Registration of McliPSSnapIn.dll using Import-Module . 12Registration of Citrix.PVS.SnapIn.dll using Add-PSSnapin . 1264-bit Registration . 1232-bit Registration . 12Alternative Registration of Citrix.PVS.SnapIn.dll in PowerShell . 1364-bit Registration in PowerShell . 1332-bit Registration in PowerShell . 13Uninstall of PowerShell Snap-In . 13Unregister of Citrix.PVS.SnapIn.dll . 1364-bit Unregister. 1332-bit Unregister. 13Alternative Unregister of Citrix.PVS.SnapIn.dll in PowerShell . 1364-bit Unregister in PowerShell . 1332-bit Unregister in PowerShell . 14Setup of the SOAP Server Communication . 14Set-PvsConnection . 14Command Specific Help . 16Error Handling . 16Short cmdlet list . 17Cmdlet by Object Type . 21Many . 21AuthGroup . 22CeipData. 22CisData . 22Collection . 22Device . 22Disk. 23DiskLocator . 25
Farm . 25FarmView . 25Server . 25Site . 26SiteView. 26Store . 26System. 26Task . 27UpdateTask . 27Error codes. 27Objects, in the Citrix.PVS.SnapIn Namespace . 42PvsADAccount . 42PvsAuditAction . 42PvsAuditActionParameter . 43PvsAuditActionProperty . 43PvsAuditTrail . 43PvsAuthGroup . 45PvsAuthGroupUsage . 45PvsCeipData . 45PvsCisData . 46PvsCollection . 46PvsConnection . 47PvsDevice . 48PvsDeviceBootstrap . 50PvsDeviceBootstrapList . 50PvsDeviceDiskTempVersion . 50PvsDeviceInfo . 51PvsDevicePersonality . 54PvsDevicePersonalityList . 54PvsDeviceStatus. 54PvsDisk . 55PvsDiskInfo . 56PvsDiskInventory . 59
PvsDiskLocator . 59PvsDiskLocatorLock . 60PvsDiskUpdateDevice . 61PvsDiskUpdateStatus . 62PvsDiskVersion. 63PvsFarm . 64PvsFarmView . 65PvsGroup . 66PvsLocalServer. 66PvsNewDiskVersion . 66PvsPhysicalAddress . 66PvsServer . 66PvsServerBiosBootstrap . 68PvsServerBootstrap . 70PvsServerBootstrapName . 71PvsServerInfo . 71PvsServerStatus . 73PvsServerStore. 73PvsSite . 74PvsSiteView . 74PvsStore . 75PvsStoreSharedOrServerPath . 75PvsTask . 76PvsUndefinedDisk . 76PvsUpdateTask . 76PvsVersion . 78PvsVirtualHostingPool . 78PvsXDSite . 79Cmdlets . 79Add-PvsDeviceToDomain . 79Add-PvsDeviceToView . 82Add-PvsDiskLocatorToDevice . 83Add-PvsDiskToUpdateTask. 86
Add-PvsDiskVersion . 88Clear-PvsConnection . 89Clear-PvsTask . 89Copy-PvsDeviceProperties . 90Copy-PvsDiskProperties . 93Copy-PvsServerProperties . 94Disable-PvsDeviceDiskLocator . 94Dismount-PvsDisk . 95Enable-PvsDeviceDiskLocator . 96Export-PvsAuditTrail . 96Export-PvsDisk . 97Export-PvsOemLicenses . 98Get-PvsADAccount . 101Get-PvsAuditActionParameter . 101Get-PvsAuditActionProperty . 102Get-PvsAuditActionSibling . 103Get-PvsAuditTrail. 104Get-PvsAuthGroup . 111Get-PvsAuthGroupUsage . 113Get-PvsCeipData . 113Get-PvsCisData . 114Get-PvsCollection . 114Get-PvsConnection. 116Get-PvsCreateDiskStatus . 117Get-PvsDevice . 118Get-PvsDeviceBootstrap . 122Get-PvsDeviceCount . 122Get-PvsDeviceDiskLocatorEnabled . 123Get-PvsDeviceDiskTempVersion. 124Get-PvsDeviceInfo . 126Get-PvsDevicePersonality . 131Get-PvsDeviceStatus. 132Get-PvsDirectory . 134
Get-PvsDisk . 135Get-PvsDiskInfo . 137Get-PvsDiskInventory . 141Get-PvsDiskLocator . 143Get-PvsDiskLocatorCount . 146Get-PvsDiskLocatorLock . 146Get-PvsDiskUpdateDevice . 147Get-PvsDiskUpdateStatus . 151Get-PvsDiskVersion. 153Get-PvsExists . 156Get-PvsFarm . 158Get-PvsFarmView. 159Get-PvsGroup . 160Get-PvsLocalServer. 161Get-PvsMaintenanceVersionExists. 161Get-PvsMinimumLastAutoAddDeviceNumber . 162Get-PvsMountedDisk . 163Get-PvsMountedDriveLetter . 164Get-PvsNewDiskVersion . 164Get-PvsServer . 165Get-PvsServerBiosBootstrap . 169Get-PvsServerBootstrap . 170Get-PvsServerBootstrapName . 172Get-PvsServerCount. 172Get-PvsServerInfo . 172Get-PvsServerName.
trademarks; Citrix Presentation Server, Citrix Access Essentials, Citrix Access Gateway, Citrix Password Manager, Citrix Application Firewall, Citrix Application Gateway, Citrix Provisioning Services, Citrix . string Password: Password to use for Authen
