Citrix Virtual Apps and Desktops SDK


Gets the status of a preparation machine being used by an AppDisk.


Get-AppLibAppDiskPreparationMachineStatus -AppDiskUid <Guid> [-BearerToken <String>] [-AdminAddress <String>] [<CommonParameters>]

Get-AppLibAppDiskPreparationMachineStatus [-AppDiskName] <String> [-BearerToken <String>] [-AdminAddress <String>] [<CommonParameters>]

Detailed Description

Machines within a Machine Catalog are reserved temporarily during a number of AppDisk operations, including creation and import. This cmdlet returns the machine name, power state and registration state of the machine currently assigned as the preparation machine for the given AppDisk. If the AppDisk has no associated preparation machine, no result will be returned.


Name Description Required? Pipeline Input Default Value
AppDiskName The name of the AppDisk. true false  
AppDiskUid The unique identifier of the AppDisk. true true (ByPropertyName)  
BearerToken Specifies the bearer token assigned to the calling user false false  
AdminAddress Specifies the address of a XenDesktop controller the PowerShell snap-in will connect to. You can provide this as a host name or an IP address. false false Localhost. Once a value is provided by any cmdlet, this value becomes the default.

Input Type

Return Values

This Object Provides Details Of The Appdisk Preparation Machine And Contains The Following Information:
Appdiskuid <Guid>
The Unique Identifier For The Appdisk.
Appdiskname <String>
The Name Of The Appdisk.
Machinename <String>
The Name Of The Preparation Machine.
Powerstate <Citrix.Applibrary.Sdk.Brokerpowerstate>
The Current Power State Of The Machine. Possible Values Are: Unmanaged, Unknown, Unavailable, Off,
On, Suspended, Turningon, Turningoff, Suspending, Resuming.
Registrationstate <Citrix.Applibrary.Sdk.Brokerregistrationstate>
Indicates The Registration State Of The Machine. Possible Values Are: Unregistered, Initializing,
Registered, Agenterror.


In the case of failure, the following errors can result.
Error Codes
An error occurred in the service while attempting a database operation.
The operation could not be completed because the database for the service is not configured.
An error occurred in the service while attempting a database operation - communication with the database failed
for various reasons.
An error occurred while communicating with the service.
The user does not have administrative rights to perform this operation.
An unexpected error occurred. To locate more details, see the Windows event logs on the controller being used or examine the XenDesktop logs.


Example 1

PS C:\> Get-AppLibAppDiskPreparationMachineStatus -AppDiskName Disk1

AppDiskName       : Disk1

AppDiskUid        : 7585f0de-192e-4847-a6d8-22713c3a2f42

MachineName       : WWCO\Machine01

PowerState        : On

RegistrationState : Registered


Gets the status of the preparation machine currently associated with the given AppDisk.