Transcription
Citrix Provisioning 1811MCLI Programmer’s GuideRevision 1November 2018
Copyright and Trademark NoticeInformation in this document is subject to change without notice. Companies, names, and data used in examplesherein are fictitious unless otherwise noted. Other than printing one copy for personal use, no part of this documentmay be reproduced or transmitted in any form or by any means, electronic or mechanical, for any purpose, withoutthe express written permission of Citrix Systems, Inc.Copyright 2001—2018 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 Password Manager,Citrix Application Firewall, Citrix Application Gateway, Citrix Provisioning Services, Citrix Streaming Profiler,Citrix Streaming Client, Citrix Streaming Service, Citrix EdgeSight, Citrix WANScaler, Citrix SmoothRoaming,Citrix Authorized Learning Center, Citrix Subscription Advantage, Citrix Technical Support, and Speed Screen aretrademarks of Citrix Systems, Inc. in the United States and other countries.Copyright RSA Encryption 1996—1998 RSA Security Inc. All rights reserved.2
ContentsShort command list . 11MCLI Add . 11MCLI Delete . 11MCLI Get . 11MCLI Info . 12MCLI Run. 12MCLI RunWithReturn. 13MCLI Set . 14MCLI SetList. 14Commands by Object Type . 15Many . 15AuthGroup . 15Collection . 15Device . 15Disk . 16DiskLocator . 17Farm . 17FarmView. 17Server . 17Site. 18SiteView . 18Store . 18System . 18Task . 18UpdateTask . 19VirtualHostingPool. 19CeipData . 19CisData . 19Error codes . 19MCLI Add . 30MCLI Add AuthGroup . 30MCLI Add CeipData . 30MCLI Add CisData . 303
MCLI Add Collection . 31MCLI Add Device . 31MCLI Add DeviceWithPersonalvDisk . 33MCLI Add DiskLocator. 35MCLI Add DiskUpdateDevice . 36MCLI Add FarmView. 37MCLI Add Server . 37MCLI Add Site . 39MCLI Add SiteView . 39MCLI Add Store . 40MCLI Add UpdateTask . 40MCLI Add VirtualHostingPool . 41MCLI Delete . 42MCLI Delete AuthGroup . 42MCLI Delete Collection. 43MCLI Delete Device . 43MCLI Delete DeviceDiskCacheFile . 43MCLI Delete DiskLocator . 44MCLI Delete DiskUpdateDevice . 44MCLI Delete DiskVersion . 44MCLI Delete FarmView . 45MCLI Delete Server . 45MCLI Delete ServerStore . 45MCLI Delete Site . 45MCLI Delete SiteView. 45MCLI Delete Store. 45MCLI Delete UpdateTask. 46MCLI Delete VirtualHostingPool . 46MCLI Get . 46MCLI Get AdDomains. 46MCLI Get AuditActionParameters . 46MCLI Get AuditActionProperties . 46MCLI Get AuditActionSibling . 47MCLI Get AuditTrail . 474
MCLI Get AuthGroup . 52MCLI Get AuthGroupUsage . 52MCLI Get CeipData. 53MCLI Get CisData . 53MCLI Get Collection . 53MCLI Get CommandDescription . 55MCLI Get CommandFields . 55MCLI Get CommandParameters . 55MCLI Get CommandSortFields . 56MCLI Get CommandStandardParameters . 56MCLI Get Device . 56MCLI Get DeviceBootstraps . 60MCLI Get DeviceCustomProperty . 60MCLI Get DeviceDiskPrinters . 60MCLI Get DeviceDiskTempVersion . 61MCLI Get DeviceInfo . 62MCLI Get DevicePersonality . 67MCLI Get DeviceStatus . 67MCLI Get Disk. 68MCLI Get DiskInfo . 70MCLI Get DiskInventory . 73MCLI Get DiskLocator . 74MCLI Get DiskLocatorCustomProperty . 76MCLI Get DiskLocatorLock . 77MCLI Get DiskPrinters . 77MCLI Get DiskUpdateDevice . 78MCLI Get DiskUpdateStatus . 81MCLI Get DiskVersion . 82MCLI Get ExceptionDescriptions . 84MCLI Get Farm . 84MCLI Get FarmView . 85MCLI Get Groups . 86MCLI Get NewVersionDisks . 86MCLI Get Server. 865
MCLI Get ServerBiosBootstrap. 90MCLI Get ServerBootstrap . 91MCLI Get ServerBootstrapNames . 92MCLI Get ServerCustomProperty. 92MCLI Get ServerInfo . 93MCLI Get ServerStatus . 96MCLI Get ServerStore . 97MCLI Get Site . 97MCLI Get SiteView . 98MCLI Get Store . 99MCLI Get StoreSharedOrServerPath . 100MCLI Get Task. 100MCLI Get UndefinedDisks . 101MCLI Get UpdateTask . 102MCLI Get VirtualHostingPool . 103MCLI Get XDSite . 105MCLI Info . 105MCLI Info Group . 105MCLI Info LocalServer . 105MCLI Info MapiErrorCode . 105MCLI Info Version. 106MCLI Run. 106MCLI Run ActivateDevice . 106MCLI Run AddDeviceToDomain. 107MCLI Run AddDiskVersion . 107MCLI Run ApplyAutoUpdate . 108MCLI Run ArchiveAuditTrail . 108MCLI Run AssignAuthGroup . 108MCLI Run AssignDevice . 109MCLI Run AssignDisk. 109MCLI Run AssignDiskLocator . 110MCLI Run AssignServer. 110MCLI Run Boot . 110MCLI Run CancelTask . 1116
MCLI Run ClearTask . 111MCLI Run CopyPasteDevice . 111MCLI Run CopyPasteDisk . 112MCLI Run CopyPasteServer . 112MCLI Run CreateDirectory . 112MCLI Run CreateDiskCancel . 112MCLI Run DisableCollection . 113MCLI Run DisableDevice . 113MCLI Run DisableDeviceDiskLocator . 113MCLI Run DisableDiskLocator . 114MCLI Run DiskUpdateCancel . 114MCLI Run DiskUpdateStart . 114MCLI Run DisplayMessage . 115MCLI Run EnableCollection . 115MCLI Run EnableDevice . 115MCLI Run EnableDeviceDiskLocator. 116MCLI Run EnableDiskLocator . 116MCLI Run ExportDisk . 116MCLI Run ExportOemLicenses . 117MCLI Run ForceInventory . 117MCLI Run ImportDatabase . 117MCLI Run ImportDevices . 118MCLI Run ImportOemLicenses. 118MCLI Run MarkDown . 119MCLI Run MergeDisk . 119MCLI Run PromoteDiskVersion . 120MCLI Run Reboot. 120MCLI Run RemoveAuthGroup . 121MCLI Run RemoveDevice . 121MCLI Run RemoveDeviceFromDomain . 122MCLI Run RemoveDirectory. 122MCLI Run RemoveDisk . 123MCLI Run RemoveDiskLocator . 123MCLI Run ResetDatabaseConnection. 1237
MCLI Run ResetDeviceForDomain . 124MCLI Run RestartStreamService . 124MCLI Run RevertDiskVersion . 125MCLI Run SetOverrideVersion . 125MCLI Run SetupConnection . 125MCLI Run Shutdown . 126MCLI Run StartDeviceDiskTempVersionMode . 127MCLI Run StartStreamService . 127MCLI Run StopDeviceDiskTempVersionMode . 127MCLI Run StopStreamService . 128MCLI Run UnlockAllDisk . 128MCLI Run UnlockDisk . 129MCLI Run UnmapDisk . 129MCLI Run ValidateDirectory . 129MCLI RunWithReturn. 129MCLI RunWithReturn Boot . 129MCLI RunWithReturn CommandActions . 130MCLI RunWithReturn CreateDisk . 130MCLI RunWithReturn CreateDiskStatus . 131MCLI RunWithReturn CreateMaintenanceVersion . 131MCLI RunWithReturn DeviceCount . 131MCLI RunWithReturn DiskLocatorCount. 132MCLI RunWithReturn DisplayMessage . 132MCLI RunWithReturn Enabled . 133MCLI RunWithReturn Exists . 134MCLI RunWithReturn ImportDisk . 135MCLI RunWithReturn ListDirectories . 135MCLI RunWithReturn MaintenanceVersionExists . 136MCLI RunWithReturn MapDisk . 136MCLI RunWithReturn MappedDiskId . 137MCLI RunWithReturn MappedDriveLetter . 137MCLI RunWithReturn MinimumLastAutoAddDeviceNumber . 137MCLI RunWithReturn RebalanceDevices . 137MCLI RunWithReturn Reboot. 1388
MCLI RunWithReturn ReportBug . 139MCLI RunWithReturn ServerCount . 139MCLI RunWithReturn ServerName . 139MCLI RunWithReturn ServerStoreActiveDeviceCount . 139MCLI RunWithReturn Shutdown . 140MCLI RunWithReturn StoreFreeSpace . 141MCLI RunWithReturn TaskStatus . 141MCLI RunWithReturn UpdateBDM. 141MCLI RunWithReturn UploadCeip . 142MCLI Set . 142MCLI Set AuthGroup . 142MCLI Set CeipData . 142MCLI Set CisData. 142MCLI Set Collection . 143MCLI Set Device. 144MCLI Set Disk . 146MCLI Set DiskLocator. 147MCLI Set DiskUpdateDevice . 148MCLI Set DiskVersion . 149MCLI Set Farm . 149MCLI Set FarmView . 150MCLI Set Server . 150MCLI Set ServerBiosBootstrap . 153MCLI Set ServerBootstrap . 154MCLI Set ServerStore . 155MCLI Set Site . 155MCLI Set SiteView . 156MCLI Set Store .
Citrix, ICA (Independent Computing Architecture), NetScaler, and Program Neighborhood are registered trademarks; Citrix Presentation Server, Citrix Access Essentials, Citrix Access Gateway, Citrix Password Manager, Citrix Application Firewall, Citrix Application Gateway, Citrix Provisioning Services, Citrix Streaming Profiler,
