PvsADAccount

Read-Only Fields

Field	Type	Description
Domain	string	Domain the account is a member of.
DomainController	string	The name of the DC used to create the host’s computer account.
Name	string	Name of the Device for the account.
Sid	string	The value of the objectSID AD attribute of the same name for the Device’s computer account.

PvsAuditAction

Read-Only Fields

Field	Type	Description
Guid or AuditActionId	Guid	GUID of the action.
ObjectId	Guid	GUID of the object of the action.
ObjectName	string	Name of the object of the action. Max Length=1000
Path	string	Path of the object of the action. An example is Site\Collection for a Device. Default=”” Max Length=101
SiteId	Guid	GUID of the Site for the object of the action. 00000000-0000-0000-0000-000000000000 when not valid. Default=00000000-0000-0000-0000-000000000000
SubId	Guid	GUID of the Collection or Store of the action. 00000000-0000-0000-0000-000000000000 when not valid. Default=00000000-0000-0000-0000-000000000000
Type	uint	Type of object that action was performed on. Values are:       1 (AuthGroup),       2 (Collection),       3 (Device),       4 (Disk),       5 (DiskLocator),       6 (Farm),       7 (FarmView),       8 (Server),       9 (Site),       10 (SiteView),       11 (Store),       12 (System),       and 13 (UserGroup)

PvsAuditActionParameter

Read-Only Fields

Field	Type	Description
AuditActionId	Guid	GUID of the Audit Action used for Get and Set.
Name or AuditParameterName	string	Name of the parameter. Max Length=50
Value	string	Value of the parameter. Max Length=1000

PvsAuditActionProperty

Read-Only Fields

Field	Type	Description
AuditActionId	Guid	GUID of the Audit Action used for Get and Set.
Name or AuditPropertyName	string	Name of the property. Max Length=50
NewValue	string	New value of the Property. Default=”” Max Length=1000
OldValue	string	Previous value of the Property. Default=”” Max Length=1000

PvsAuditTrail

Read-Only Fields

Field	Type	Description
Action	uint	Name of the action taken. This is a number that is converted to a string for display. Values are:       1 (AddAuthGroup),       2 (AddCollection),       3 (AddDevice),       4 (AddDiskLocator),       5 (AddFarmView),       6 (AddServer),       7 (AddSite),       8 (AddSiteView),       9 (AddStore),       10 (AddUserGroup),       11 (AddVirtualHostingPool),       12 (AddUpdateTask),       13 (AddDiskUpdateDevice),       1001 (DeleteAuthGroup),       1002 (DeleteCollection),       1003 (DeleteDevice),       1004 (DeleteDeviceDiskCacheFile),       1005 (DeleteDiskLocator),       1006 (DeleteFarmView),       1007 (DeleteServer),       1008 (DeleteServerStore),       1009 (DeleteSite),       1010 (DeleteSiteView),       1011 (DeleteStore),       1012 (DeleteUserGroup),       1013 (DeleteVirtualHostingPool),       1014 (DeleteUpdateTask),       1015 (DeleteDiskUpdateDevice),       1016 (DeleteDiskVersion),       2001 (RunAddDeviceToDomain),       2002 (RunApplyAutoUpdate),       2003 (RunApplyIncrementalUpdate),       2004 (RunArchiveAuditTrail),       2005 (RunAssignAuthGroup),       2006 (RunAssignDevice),       2007 (RunAssignDiskLocator),       2008 (RunAssignServer),       2009 (RunWithReturnBoot),       2010 (RunCopyPasteDevice),       2011 (RunCopyPasteDisk),       2012 (RunCopyPasteServer),       2013 (RunCreateDirectory),       2014 (RunCreateDiskCancel),       2015 (RunDisableCollection),       2016 (RunDisableDevice),       2017 (RunDisableDeviceDiskLocator),       2018 (RunDisableDiskLocator),       2019 (RunDisableUserGroup),       2020 (RunDisableUserGroupDiskLocator),       2021 (RunWithReturnDisplayMessage),       2022 (RunEnableCollection),       2023 (RunEnableDevice),       2024 (RunEnableDeviceDiskLocator),       2025 (RunEnableDiskLocator),       2026 (RunEnableUserGroup),       2027 (RunEnableUserGroupDiskLocator),       2028 (RunExportOemLicenses),       2029 (RunImportDatabase),       2030 (RunImportDevices),       2031 (RunImportOemLicenses),       2032 (RunMarkDown),       2033 (RunWithReturnReboot),       2034 (RunRemoveAuthGroup),       2035 (RunRemoveDevice),       2036 (RunRemoveDeviceFromDomain),       2037 (RunRemoveDirectory),       2038 (RunRemoveDiskLocator),       2039 (RunResetDeviceForDomain),       2040 (RunResetDatabaseConnection),       2041 (RunRestartStreamingService),       2042 (RunWithReturnShutdown),       2043 (RunStartStreamingService),       2044 (RunStopStreamingService),       2045 (RunUnlockAllDisk),       2046 (RunUnlockDisk),       2047 (RunServerStoreVolumeAccess),       2048 (RunServerStoreVolumeMode),       2049 (RunMergeDisk),       2050 (RunRevertDiskVersion),       2051 (RunPromoteDiskVersion),       2052 (RunCancelDiskMaintenance),       2053 (RunActivateDevice),       2054 (RunAddDiskVersion),       2055 (RunExportDisk),       2056 (RunAssignDisk),       2057 (RunRemoveDisk),       2058 (RunDiskUpdateStart),       2059 (RunDiskUpdateCancel),       2060 (RunSetOverrideVersion),       2061 (RunCancelTask),       2062 (RunClearTask),       2063 (RunForceInventory),       2064 RunUpdateBDM,       2065 (RunStartDeviceDiskTempVersionMode),       2066 (RunStopDeviceDiskTempVersionMode),       3001 (RunWithReturnCreateDisk),       3002 (RunWithReturnCreateDiskStatus),       3003 (RunWithReturnMapDisk),       3004 (RunWithReturnRebalanceDevices),       3005 (RunWithReturnCreateMaintenanceVersion),       3006 (RunWithReturnImportDisk),       4001 (RunByteArrayInputImportDevices),       4002 (RunByteArrayInputImportOemLicenses),       5001 (RunByteArrayOutputArchiveAuditTrail),       5002 (RunByteArrayOutputExportOemLicenses),       6001 (SetAuthGroup),       6002 (SetCollection),       6003 (SetDevice),       6004 (SetDisk),       6005 (SetDiskLocator),       6006 (SetFarm),       6007 (SetFarmView),       6008 (SetServer),       6009 (SetServerBiosBootstrap),       6010 (SetServerBootstrap),       6011 (SetServerStore),       6012 (SetSite),       6013 (SetSiteView),       6014 (SetStore),       6015 (SetUserGroup),       6016 SetVirtualHostingPool,       6017 SetUpdateTask,       6018 SetDiskUpdateDevice,       7001 (SetListDeviceBootstraps),       7002 (SetListDeviceBootstrapsDelete),       7003 (SetListDeviceBootstrapsAdd),       7004 (SetListDeviceCustomProperty),       7005 (SetListDeviceCustomPropertyDelete),       7006 (SetListDeviceCustomPropertyAdd),       7007 (SetListDeviceDiskPrinters),       7008 (SetListDeviceDiskPrintersDelete),       7009 (SetListDeviceDiskPrintersAdd),       7010 (SetListDevicePersonality),       7011 (SetListDevicePersonalityDelete),       7012 (SetListDevicePersonalityAdd),       7013 (SetListDiskLocatorCustomProperty),       7014 (SetListDiskLocatorCustomPropertyDelete),       7015 (SetListDiskLocatorCustomPropertyAdd),       7016 (SetListServerCustomProperty),       7017 (SetListServerCustomPropertyDelete),       7018 (SetListServerCustomPropertyAdd),       7019 (SetListUserGroupCustomProperty),       7020 (SetListUserGroupCustomPropertyDelete),       and 7021 (SetListUserGroupCustomPropertyAdd)
Attachments	uint	An or’ed value that indicates if there are any details for this action. A value of 15 indicates that there are Children,       Sibling,       Parameters and Properties for the action. Values are:       0 (None),       1 (Children),       2 (Sibling),       4 (Parameters),       and 8 (Properties) Default=0
Guid or AuditActionId	Guid	GUID of the action.
Domain	string	Domain of the user that performed the action. Max Length=255
ObjectId	Guid	GUID of the object of the action. Default=00000000-0000-0000-0000-000000000000
ObjectName	string	Name of the object of the action. Default=”” Max Length=1000
ParentId	Guid	GUID of the parent action (one that triggered this action) if one exists. 00000000-0000-0000-0000-000000000000 when not valid. Default=00000000-0000-0000-0000-000000000000
Path	string	Path of the object of the action. An example is Site\Collection for a Device. Default=”” Max Length=101
RootId	Guid	GUID of the root action (one that triggered this group of actions) if one exists. 00000000-0000-0000-0000-000000000000 when not valid. Default=00000000-0000-0000-0000-000000000000
SiteId	Guid	GUID of the Site for the object of the action. 00000000-0000-0000-0000-000000000000 when not valid. Default=00000000-0000-0000-0000-000000000000
SubId	Guid	GUID of the Collection or Store of the action. 00000000-0000-0000-0000-000000000000 when not valid. Default=00000000-0000-0000-0000-000000000000
Time	DateTime	Date/Time the action occurred down to the millisecond. Has the date and time including milliseconds. Default=Empty
Type	uint	Type of object that action was performed on. Values are:       0 (Many),       1 (AuthGroup),       2 (Collection),       3 (Device),       4 (Disk),       5 (DiskLocator),       6 (Farm),       7 (FarmView),       8 (Server),       9 (Site),       10 (SiteView),       11 (Store),       12 (System),       and 13 (UserGroup)
UserName	string	User that performed the action. Max Length=255

PvsAuthGroup

Read/Write Fields

Field	Type	Description
Name or AuthGroupName	string	Name of the Active Directory or Windows Group. Max Length=450
Description	string	User description. Default=”” Max Length=250
IsReadOnly	bool	Indicates whether the administrative role is read-only(true) or read-write(false). Default=false

Read-Only Fields

Field	Type	Description
Guid or AuthGroupId	Guid	Read-only GUID that uniquely identifies this AuthGroup.
Role	uint	Role of the AuthGroup for a Collection. role can only be used with CollectionId or CollectionName. 300 is Collection Administrator, and 400 is Collection Operator. Default=999

PvsAuthGroupUsage

Read-Only Fields

Field	Type	Description
Guid or Id	Guid	GUID of the item. The item can be a Farm, Site or Collection. It will be 00000000-0000-0000-0000-000000000000 for Farm.
Name	string	Name of the item. The item can be a Farm, Site or Collection.
Role	uint	Role of the AuthGroup for the item. 100 is Farm Administrator, 200 is Site Administrator, 300 is Collection Administrator, and 400 is Collection Operator. Default=999

PvsCeipData

Read/Write Fields

Field	Type	Description
Enabled	uint	1 if CEIP is enabled, otherwise 0. Min=0, Max=1
InProgress	uint	1 if an upload is currently in progress, otherwise 0. Default=0
NextUpload	DateTime	Date and time next CEIP upload is due if enabled is 1. Default=Empty
OneTimeUpload	uint	1 to perform a one time upload. Default=0
ServerId	Guid	ID of server that is currently uploading, null if InProgress is 0. Default=00000000-0000-0000-0000-000000000000

Read-Only Field

Field	Type	Description
Uuid	Guid	CEIP UUID.

PvsCisData

Read/Write Fields

Field	Type	Description
Password	string	Password of the user required to obtain the token. This is required only by Set and Add
Path	string	Path where the last problem report bundle was saved Default=”” Max Length=255
UserName	string	Username used to obtain the token Default=”” Max Length=255

Read-Only Fields

Field	Type	Description
Guid or CisDataId	Guid	CIS UUID
UploadToken	string	Token for uploading bundles to CIS Default=”” Max Length=65535

PvsCollection

Read/Write Fields

Field	Type	Description
AutoAddNumberLength	uint	The maximum length of the Device Number for Auto Add. This length plus the AutoAddPrefix length plus the AutoAddSuffix length must be less than 16. Required that ((lenautoAddPrefix+lenautoAddSuffix)+AutoAddNumberLength)<=15. Min=3, Max=9, Default=4
AutoAddPrefix	string	The string put before the Device Number for Auto Add. Default=”” ASCII computer name characters no end digit Max Length=12
AutoAddSuffix	string	The string put after the Device Number for Auto Add. Default=”” ASCII computer name characters no begin digit Max Length=12
AutoAddZeroFill	bool	True when zeros be placed before the Device Number up to the AutoAddNumberLength for Auto Add, false otherwise. Default=true
Name or CollectionName	string	Name of the Collection. It is unique within the Site. Max Length=50
Description	string	User description. Default=”” Max Length=250
Enabled	bool	True when Devices in the Collection can be booted, false otherwise. Default=true
LastAutoAddDeviceNumber	uint	The Device Number of the last Auto Added Device. Default=0
ProvisioningType	uint	The provisioning facility which created the Devices in this Collection. 0 is PVS, 1 is Studio. Only writable when adding a colection. Min=0, Max=1, Default=0
TemplateDeviceId	Guid	GUID of a Device in the Collection whose settings are used for initial values of new Devices. Not used with templateDeviceName. Default=00000000-0000-0000-0000-000000000000
TemplateDeviceName	string	Name of a Device in the Collection whose settings are used for initial values of new Devices. Not used with TemplateDeviceId. Default=””

Read-Only Fields

Field	Type	Description
ActiveDeviceCount	uint	Read-only count of active Devices in this Collection. Default=0
Guid or CollectionId	Guid	Read-only GUID that uniquely identifies this Collection.
DeviceCount	uint	Read-only count of Devices in this Collection. Default=0
DeviceWithPVDCount	uint	Read-only count of Devices with Personal vDisk in this Collection. Default=0
MakActivateNeededCount	uint	Read-only count of active Devices that need MAK activation in this Collection. Default=0
Role	uint	Read-only Role of the user for this item. 100 is Farm Administrator, 200 is Site Administrator, 300 is Collection Administrator, and 400 is Collection Operator. Default=999
SiteId	Guid	GUID of the Site that this Collection is a member of. It is not used with SiteName.
SiteName	string	Name of the Site that this Collection is a member of. It is not used with SiteId.

PvsConnection

Read/Write Fields

Field	Type	Description
Domain	string	Domain name to use for Authentication. If it has a value, it will be *****. Default=””
Password	string	Password to use for Authentication. If it has a value, it will be *****. Default=””
Persist	string	True when the connection settings should be, for Set, or have been, for Get, saved to the registry.
Port	string	The Port to use to connect. Default=54321
Name or Server	string	Name or IP of the Server to connect to. Default=localhost
User	string	User name to use for Authentication. If it has a value, it will be *****. Default=””

Read-Only Field

Field	Type	Description
Connected	string	True when the Citrix.PVS.SnapIn is currently connected to the SoapServer with the settings in this PvsConnection.

PvsConnection can be created or modified using methods below:

• New-Object Citrix.PVS.SnapIn.PvsConnection: Creates default Server=localhost, Port=54321, and no authentication.
• New-Object Citrix.PVS.SnapIn.PvsConnection(Citrix.PVS.SnapIn copyFrom): Creates with settings of the copyFrom Citrix.PVS.SnapIn.
• SetServerToLocalHostDefaultSettings: Server=localhost, Port=54321, and no authentication.
• Copy(Citrix.PVS.SnapIn copyFrom): Modifies the settings to match the copyFrom Citrix.PVS.SnapIn.
• Equals(Citrix.PVS.SnapIn compareTo): Returns true when the settings match what is in the compareTo.

PvsDevice

Read/Write Fields

Field	Type	Description
AdPassword	string	The Active Directory machine account password. Do not set this field, it is only set internally by PVS. Default=”” ASCII Max Length=65535
AdSignature	uint	The signature of the Active Directory machine account password. Do not set this field, it is only set internally by PVS. Default=0
AdTimestamp	uint	The time the Active Directory machine account password was generated. Do not set this field, it is only set internally by PVS. Default=0
Authentication	uint	Device log in authentication. Choices are 0 for none, 1 for User Name/Password, and 2 for Extern. This cannot be Set for a Device with Personal vDisk. Min=0, Max=2, Default=0
BdmBoot	bool	Use PXE boot when set to false, BDM boot when set to true. Default is PXE Default=false
BdmCreated	DateTime	Timestamp when BDM device was created Default=Empty
BdmFormat	uint	1 use VHD for BDMboot, 2 use ISO, 3 use USB. Default=0
BdmType	uint	Use PXE boot when set to 0, BDM (Bios) boot when set to 1 and BDM (Uefi) boot when set to 2. Default=0
BdmUpdated	DateTime	Timestamp of the last BDM boot disk update. Default=Empty
BootFrom	uint	Device to boot from. Choices are 1 for vDisk, 2 for Hard Disk, and 3 for Floppy. This cannot be Set for a Device with Personal vDisk. Min=1, Max=3, Default=1
ClassName	string	Used by Automatic Update feature to match new versions of Disks to a Device. This cannot be Set for a Device with Personal vDisk. Default=”” Max Length=41
Description	string	User description. Default=”” Max Length=250
DeviceMac	PvsPhysicalAddress	Ethernet address can have the form XX-XX-XX-XX-XX-XX. Uniquely identifies the Device. Default=””
Name or DeviceName	string	Computer name with no spaces. ASCII computer name characters Max Length=15
DomainControllerName	string	The name of the DC used to create the host’s computer account. Do not set this field, it is only set internally by PVS. Default=”” Max Length=4000
DomainName	string	Fully qualified name of the domain that the Device belongs to. Do not set this field, it is only set internally by PVS. Default=”” Max Length=255
DomainObjectSID	string	The value of the objectSID AD attribute of the same name for the Device’s computer account. Do not set this field, it is only set internally by PVS. Default=”” Max Length=186
DomainTimeCreated	DateTime	The time that the computer account was created. Has the date and time including milliseconds. Do not set this field, it is only set internally by PVS. Default=Empty
EkPub	string	Client TPM EK public key Default=””
Enabled	bool	True when it can be booted, false otherwise. This cannot be Set for a Device with Personal vDisk. Default=true
EncryptionEpoch	UInt64	Timestamp of the encryption Key used to encrypt fields Default=0
LocalDiskEnabled	bool	If there is a local disk menu choice for the Device, this is true. This cannot be Set for a Device with Personal vDisk. Default=false
LocalWriteCacheDiskSize	uint	The size in GB to format the Device cache file disk. If the value is 0, then the disk is not formatted. Min=0, Max=2048, Default=0
LogLevel	uint	Level to perform logging at. Values are:       0 (None),       1 (Fatal),       2 (Error),       3 (Warning),       4 (Info),       and 5 (Debug). Min=0,       Max=6,       Default=4
Password	string	Password of user to authenticate before the boot process continues. This cannot be Set for a Device with Personal vDisk. Default=”” ASCII Max Length=65535
Port	uint	UDP port to use with Stream Service. Min=1025, Max=65534, Default=6901
ProvisioningType	uint	The provisioning facility which created the device. 0 is PVS, 1 is Studio. Only writable when adding a device. Min=0, Max=1, Default=0
SecurityPolicy	uint	Client security policy Expected values are 0, 2 or 10, Default=null.
Type	uint	1 when it performs test of Disks, 2 when it performs maintenance on Disks, 3 when it has a Personal vDisk, 4 when it has a Personal vDisk and performs tests, 0 otherwise. A Device with type 0 - 3 can only be Set to 0 - 3, and a Device with type 3 - 4 can only be Set to 3 - 4. Min=0, Max=4, Default=0
UpdatePageFileSettings	bool	Update pagefile settings Default=false
User	string	Name of user to authenticate before the boot process continues. This cannot be Set for a Device with Personal vDisk. Default=”” ASCII Max Length=20
WriteCacheDisk	string	Write cache disk number Default=”” Max Length=3
WriteCachePartition	string	Write cache disk partition number Default=”” Max Length=3
XsPvsProxyUuid	Guid	UUID of XenServer PVS_proxy Default=00000000-0000-0000-0000-000000000000

Read-Only Fields

Field	Type	Description
Active	bool	True if the Device is currently active, false otherwise. Default=false
CollectionId	Guid	GUID of the Collection this Device is to be a member of. It is not used with CollectionName.
CollectionName	string	Name of the Collection this Device is to be a member of. SiteName or SiteId must also be used.
Guid or DeviceId	Guid	Read-only GUID that uniquely identifies this Device.
HypVmId	string	Hypervisor VM ID for HCL Default=”” Max Length=65535
PvdDriveLetter	string	Read-only Personal vDisk Drive letter. Range is E to U and W to Z. Default=”” Max Length=1
Role	uint	Read-only Role of the user for this item. 100 is Farm Administrator, 200 is Site Administrator, 300 is Collection Administrator, and 400 is Collection Operator. Default=999
SiteId	Guid	GUID of the Site the CollectionName is to be a member of. This or SiteName is used with CollectionName.
SiteName	string	Name of the Site the CollectionName is to be a member of. This or SiteId is used with CollectionName.
Template	bool	True if the Device is the template in its Collection, false otherwise. Default=false
TemporaryVersionSet	bool	Read-only true when temporary version is set. Default=false
VirtualHostingPoolId	Guid	GUID that uniquely identifies the Virtual Hosting Pool for a VM. This is needed when Adding a VM device. Default=00000000-0000-0000-0000-000000000000

PvsDeviceBootstrap

Read-Only Fields

Name	Description
DeviceId	GUID of the Device.

PvsDeviceBootstrapList: Each one of these has these 2 fields:

• string Name or Bootstrap: Name of the bootstrap file. Max Length=259
• string MenuText: Text that is displayed in the Boot Menu. If this field has no value, the bootstrap value is used. Default=”” ASCII Max Length=64

PvsDeviceBootstrapList[] DeviceBootstrap: List of objects that can be changed with the methods below.

• Add(string bootstrap, string menuText): Used to add a PvsDeviceBootstrapList to the end of the array.
• Insert(int position, string bootstrap, string menuText): Used to insert a PvsDeviceBootstrapList array item at position. The position is 0 based.
• Remove(int position): Used to remove a PvsDeviceBootstrapList array item at position. The position is 0 based.
• Set(int position, string menuText): Used to set a PvsDeviceBootstrapList array item MenuText at position. The position is 0 based.
• Reorder(int oldPosition, int newPosition): Used to move a PvsDeviceBootstrapList array item from the oldPosition to the newPosition. The oldPosition and newPosition are 0 based.

PvsDeviceBootstrapList

Read/Write Fields

Field	Type	Description
Name or Bootstrap	string	Name of the bootstrap file. Max Length=259
MenuText	string	Text that is displayed in the Boot Menu. If this field has no value, the bootstrap value is used. Default=”” ASCII Max Length=64

PvsDeviceDiskTempVersion

Read-Only Fields

Field	Type	Description
Guid or DeviceId	Guid	Read-only GUID that uniquely identifies the Device with temporary version.
Name or DeviceName	string	Read-only Computer name that uniquely identifies the Device with temporary version. ASCII computer name characters
DiskLocatorId	Guid	Read-only GUID that uniquely identifies then Disk Locator with temporary version.
DiskLocatorName	string	Read-only Name of the Disk Locator File with temporary version. It is unique within the Store. ASCII
SiteId	Guid	Read-only GUID of the Site the Device and DiskLocator are a member of.
SiteName	string	Read-only Name of the Site the Device and DiskLocator are a member of.
StoreId	Guid	Read-only GUID of the Store that the Disk Locator is a member of.
StoreName	string	Read-only Name of the Store that the Disk Locator is a member of.
Version	uint	Read-only Disk version the temporary is for.

PvsDeviceInfo

Read-Only Fields

Field	Type	Description
Active	bool	True if the Device is currently active, false otherwise. Default=false
AdPassword	string	The Active Directory machine account password. Do not set this field, it is only set internally by PVS. Default=”” ASCII Max Length=65535
AdSignature	uint	The signature of the Active Directory machine account password. Do not set this field, it is only set internally by PVS. Default=0
AdTimestamp	uint	The time the Active Directory machine account password was generated. Do not set this field, it is only set internally by PVS. Default=0
Authentication	uint	Device log in authentication. Choices are 0 for none, 1 for User Name/Password, and 2 for Extern. This cannot be Set for a Device with Personal vDisk. Min=0, Max=2, Default=0
BdmBoot	bool	Use PXE boot when set to false, BDM boot when set to true. Default is PXE Default=false
BdmCreated	DateTime	Timestamp when BDM device was created Default=Empty
BdmFormat	uint	1 use VHD for BDMboot, 2 use ISO, 3 use USB. Default=0
BdmType	uint	Use PXE boot when set to 0, BDM (Bios) boot when set to 1 and BDM (Uefi) boot when set to 2. Default=0
BdmUpdated	DateTime	Timestamp of the last BDM boot disk update. Default=Empty
BootFrom	uint	Device to boot from. Choices are 1 for vDisk, 2 for Hard Disk, and 3 for Floppy. This cannot be Set for a Device with Personal vDisk. Min=1, Max=3, Default=1
ClassName	string	Used by Automatic Update feature to match new versions of Disks to a Device. This cannot be Set for a Device with Personal vDisk. Default=”” Max Length=41
CollectionId	Guid	GUID of the Collection this Device is to be a member of. It is not used with CollectionName.
CollectionName	string	Name of the Collection this Device is to be a member of. SiteName or SiteId must also be used.
Description	string	User description. Default=”” Max Length=250
Guid or DeviceId	Guid	Read-only GUID that uniquely identifies this Device.
DeviceMac	PvsPhysicalAddress	Ethernet address can have the form XX-XX-XX-XX-XX-XX. Uniquely identifies the Device. Default=””
Name or DeviceName	string	Computer name with no spaces. ASCII computer name characters Max Length=15
DiskFileName	string	Name of the Disk File including the extension. It is equal to “” if the Device is not active.
DiskLocatorId	Guid	Read-only GUID of the Disk Locator that the Device is using. It is equal to 00000000-0000-0000-0000-000000000000 if the Device is not active.
DiskLocatorName	string	Read-only name of the Disk Locator File that the Device is using. It is equal to the list of Disk Locator names for the Device if the Device is not active.
DiskVersion	uint	Read-only version of the Disk Locator File that the Device is using. It is equal to 0 if the Device is not active. Default=0
DiskVersionAccess	uint	State of the Disk Version. Values are:       0 (Production),       1 (Maintenance),       2 (MaintenanceHighestVersion),       3 (Override),       4 (Merge),       5 (MergeMaintenance),       6 (MergeTest),       and 7 (Test). It is equal to 0 if the Device is not active. Default=0
DomainControllerName	string	The name of the DC used to create the host’s computer account. Do not set this field, it is only set internally by PVS. Default=”” Max Length=4000
DomainName	string	Fully qualified name of the domain that the Device belongs to. Do not set this field, it is only set internally by PVS. Default=”” Max Length=255
DomainObjectSID	string	The value of the objectSID AD attribute of the same name for the Device’s computer account. Do not set this field, it is only set internally by PVS. Default=”” Max Length=186
DomainTimeCreated	DateTime	The time that the computer account was created. Has the date and time including milliseconds. Do not set this field, it is only set internally by PVS. Default=Empty
EkPub	string	Client TPM EK public key Default=””
Enabled	bool	True when it can be booted, false otherwise. This cannot be Set for a Device with Personal vDisk. Default=true
EncryptionEpoch	UInt64	Timestamp of the encryption Key used to encrypt fields Default=0
HypVmId	string	Hypervisor VM ID for HCL Default=”” Max Length=65535
Ip	System.Net.IPAddress	Read-only IPv4 Address of the Device. It is equal to 0.0.0.0 if the Device is not active or not using IPv4
Ipv6	string	Read-only IPv6 Address of the device. It is equal to “::” if the device is not active or not using IPv6 Default=0
License	uint	Oem Only: Read-only type of the license. Values are 0 when None, 1 or 2 when Desktop. It is equal to 0 if the Device is not active. Default=0
LicenseType	uint	0 when None, 1 for Desktop, 2 for Server, 5 for OEM SmartClient, 6 for XenApp, 7 for XenDesktop. It is equal to 0 if the Device is not active. Default=0
LocalDiskEnabled	bool	If there is a local disk menu choice for the Device, this is true. This cannot be Set for a Device with Personal vDisk. Default=false
LocalWriteCacheDiskSize	uint	The size in GB to format the Device cache file disk. If the value is 0, then the disk is not formatted. Min=0, Max=2048, Default=0
LogLevel	uint	Level to perform logging at. Values are:       0 (None),       1 (Fatal),       2 (Error),       3 (Warning),       4 (Info),       and 5 (Debug). Min=0,       Max=6,       Default=4
MakLicenseActivated	uint	Read-only indicator if MAK licensing is being used and is activated. Values are:       0 (MAK not used),       1 (Not Activated),       2 (Activated). It is equal to 0 if the Device is not active. Default=0
Model	string	Oem Only: Read-only model of the computer. Values are OptiPlex 745, 755, 320, 760, FX160, or Default. It is equal to “” if the Device is not active.
Password	string	Password of user to authenticate before the boot process continues. This cannot be Set for a Device with Personal vDisk. Default=”” ASCII Max Length=65535
Port	uint	UDP port to use with Stream Service. Min=1025, Max=65534, Default=6901
ProvisioningType	uint	The provisioning facility which created the device. 0 is PVS, 1 is Studio. Only writable when adding a device. Min=0, Max=1, Default=0
PvdDriveLetter	string	Read-only Personal vDisk Drive letter. Range is E to U and W to Z. Default=”” Max Length=1
Role	uint	Read-only Role of the user for this item. 100 is Farm Administrator, 200 is Site Administrator, 300 is Collection Administrator, and 400 is Collection Operator. Default=999
SecurityPolicy	uint	Client security policy Expected values are 0, 2 or 10, Default=null.
ServerId	Guid	Read-only GUID of the Server that the Device is using. It is equal to 00000000-0000-0000-0000-000000000000 if the Device is not active.
ServerIpConnection	System.Net.IPAddress	Read-only IPv4 Address of the Server that the Device is using. It is equal to 0.0.0.0 if the Device is not active or not using IPv4.
ServerIpv6Connection	string	Read-only IPv6 Address of the Server that the Device is using. It is equal to “::” if the Device is not active or not using IPv6. Default=0
ServerName	string	Read-only Name of the Server that the Device is using. It is equal to “” if the Device is not active.
ServerPortConnection	uint	Read-only Port of the Server that the Device is using. It is equal to 0 if the Device is not active. Default=0
SiteId	Guid	GUID of the Site the CollectionName is to be a member of. This or SiteName is used with CollectionName.
SiteName	string	Name of the Site the CollectionName is to be a member of. This or SiteId is used with CollectionName.
Status	string	1 or 2 numbers in the format n,n. They are the number of retries and if ram cache is being used, ram cache percent used. It is equal to “” if the Device is not active.
Template	bool	True if the Device is the template in its Collection, false otherwise. Default=false
TemporaryVersionSet	bool	Read-only true when temporary version is set. Default=false
Type	uint	1 when it performs test of Disks, 2 when it performs maintenance on Disks, 3 when it has a Personal vDisk, 4 when it has a Personal vDisk and performs tests, 0 otherwise. Min=0, Max=4, Default=0
UpdatePageFileSettings	bool	Update pagefile settings Default=false
User	string	Name of user to authenticate before the boot process continues. This cannot be Set for a Device with Personal vDisk. Default=”” ASCII Max Length=20
VirtualHostingPoolId	Guid	GUID that uniquely identifies the Virtual Hosting Pool for a VM. This is needed when Adding a VM device. Default=00000000-0000-0000-0000-000000000000
WriteCacheDisk	string	Write cache disk number Default=”” Max Length=3
WriteCachePartition	string	Write cache disk partition number Default=”” Max Length=3
XsPvsProxyUuid	Guid	UUID of XenServer PVS_proxy Default=00000000-0000-0000-0000-000000000000

PvsDevicePersonality

Read-Only Fields

Name	Description
DeviceId	GUID of the Device.

PvsDevicePersonalityList: Each one of these has these 2 fields:

• string Name: Name of the Device personality item. Max Length=250
• string Value: Value for the Device personality item. Max Length=1000

PvsDevicePersonalityList[] DevicePersonality: List of objects that can be changed with the methods below.

• Add(string name, string value): Used to add a PvsDevicePersonalityList to the end of the array.
• Insert(int position, string name, string value): Used to insert a PvsDevicePersonalityList array item at position. The position is 0 based.
• Remove(int position): Used to remove a PvsDevicePersonalityList array item at position. The position is 0 based.
• Set(int position, string value): Used to set a PvsDevicePersonalityList array item Value at position. The position is 0 based.
• Reorder(int oldPosition, int newPosition): Used to move a PvsDevicePersonalityList array item from the oldPosition to the newPosition. The oldPosition and newPosition are 0 based.

PvsDevicePersonalityList

Read/Write Fields

Field	Type	Description
Name	string	Name of the Device personality item. Max Length=250
Value	string	Value for the Device personality item. Max Length=1000

PvsDeviceStatus

Read-Only Fields

Field	Type	Description
Guid or DeviceId	Guid	Read-only GUID of the Device. Can be used with Get Device.
Name or DeviceName	string	Read-only Name of the Device. Can be used with Get Device.
DiskFileName	string	Name of the Disk File including the extension.
DiskLocatorId	Guid	Read-only GUID of the Disk Locator that the Device is using.
DiskLocatorName	string	Read-only name of the Disk Locator File that the Device is using.
DiskVersion	uint	Read-only version of the Disk Locator File that the Device is using. Default=0
DiskVersionAccess	uint	State of the Disk Version. Values are:       0 (Production),       1 (Maintenance),       2 (MaintenanceHighestVersion),       3 (Override),       4 (Merge),       5 (MergeMaintenance),       6 (MergeTest),       and 7 (Test) Default=0
Ip	System.Net.IPAddress	Read-only IPv4 Address of the Device.
Ipv6	string	Read-only IPv6 Address of the device Default=0
LicenseType	uint	0 when None, 1 for Desktop, 2 for Server, 5 for OEM SmartClient, 6 for XenApp, 7 for XenDesktop. Default=0
MakLicenseActivated	uint	Read-only indicator if MAK licensing is being used and is activated. Values are:       0 (MAK not used),       1 (Not Activated),       2 (Activated). Default=0
QuicCipherSuite	uint	Read-only The QUIC cipher suite that the Device is using for streaming. It is none if legacy protocol is used. Default=””
ServerId	Guid	Read-only GUID of the Server that the Device is using.
ServerIpConnection	System.Net.IPAddress	Read-only IPv4 Address of the Server that the Device is using.
ServerIpv6Connection	string	Read-only IPv6 Address of the Server that the Device is using. Default=0
ServerName	string	Read-only Name of the Server that the Device is using.
ServerPortConnection	uint	Read-only Port of the Server that the Device is using. Default=0
Status	string	1 or 2 numbers in the format n,n. They are the number of retries and if ram cache is being used, ram cache percent used.
StreamProtocol	uint	Read-only The stream protocol that the Device is using: 0(Legacy protocol), 1(QUIC protocol). Min=0, Max=1, Default=0

PvsDisk

Read/Write Fields

Field	Type	Description
AccelerateOfficeActivation	bool	Run script to activate office automatically.
ActivationDateEnabled	bool	Use activation date to activate image when set to true. Default false
ActiveDate	DateTime	Date to activate the disk if AutoUpdateEnabled and activationDateEnabled are true. Has the date. Empty when the AutoUpdateEnabled or activationDateEnabled are false.
AdPasswordEnabled	bool	Enable AD password management when set to true.
Author	string	User defined author. Max Length=40
AutoUpdateEnabled	bool	Automatically update this image for matching Devices when set to true. Default false
Build	UInt64	User defined build number. Min=0, Max=4294967295, Default=0
Class	string	Class of the Disk. Max Length=40
ClearCacheDisabled	string	Clear cached secrets disabled.
Company	string	User defined company. Max Length=40
Date	string	User defined date. Max Length=40
EnableSetLocalTime	string	Enable setting the local time bias on the disk version.
VHDX	bool	If VHDX is true, the format of the image is VHDX. Otherwise it is VHD. Default=false
HaEnabled	bool	Enable HA when set to true.
HardwareTarget	string	User defined hardware target. Max Length=127
ImageType	string	Type of this image (software type). Max Length=40
InternalName	string	User defined name. Max Length=63
LicenseMode	uint	0 (None), 1 (Multiple Activation Key), or 2 (Key Management Service). Min=0, Max=2, Default=0
LongDescription	string	Description of the Disk. Max Length=399
MajorRelease	UInt64	User defined major release number. Min=0, Max=4294967295, Default=0
MinorRelease	UInt64	User defined minor release number. Min=0, Max=4294967295, Default=0
OperatingSystem	string	Operating System of Disk. Max Length=250
OriginalFile	string	User defined original file. Max Length=127
OsType	string	Operating System Type of Disk. Max Length=40
PrinterManagementEnabled	bool	Invalid printers will be deleted from the Device when set to true.
SerialNumber	string	User defined serial number. Max Length=36
Title	string	User defined title. Max Length=40
WriteCacheSize	UInt64	RAM cache size (MB). Not 0 when used with Cache in Device RAM, and Cache in Device RAM with Overflow on Hard Disk. A value of 0 will disable the RAM use for Cache in Device RAM with Overflow on Hard Disk. Min=0, Max=131072, Default=0
WriteCacheType	uint	0 (Private), 1 (Cache on Server), 3 (Cache in Device RAM), 4 (Cache on Device Hard Disk), 7 (Cache on Server, Persistent), 9 (Cache in Device RAM with Overflow on Hard Disk), 10 (Private async), 11(Server persistent async), 12 (Cache in Device RAM with Overflow on Hard Disk async) Min=0, Max=12, Default=0

Read-Only Fields

Field	Type	Description
Guid or DiskLocatorId	Guid	GUID of the DiskLocator used for Get and Set.
DiskSize	UInt64	Read-only size of the image. The value is 0 when it is not available. Default=0
LogicalSectorSize	string	Logical Sector Size. Values are:       512,       4096,       Default=512
VhdBlockSize	uint	Block size in KB. For VHD it is only used with Dynamic type. Tested sizes for VHD are 512, 2048, and 16384. VHD Min=512, Max=16384, Default=2048. For VHDX it is used for all types. Tested size for VHDX is 32768. VHDX Min=1024, Max= 262144, Default=32768. Default=0

PvsDiskInfo

Read-Only Fields

Field	Type	Description
AccelerateOfficeActivation	bool	Run script to activate office automatically.
ActivationDateEnabled	bool	Use activation date to activate image when set to true. Default false
Active	bool	True if the DiskLocator is currently active, false otherwise. Default=false
ActiveDate	DateTime	Date to activate the disk if AutoUpdateEnabled and activationDateEnabled are true. Has the date. Empty when the AutoUpdateEnabled or activationDateEnabled are false.
AdPasswordEnabled	bool	Enable AD password management when set to true.
Author	string	User defined author. Max Length=40
AutoUpdateEnabled	bool	Automatically update this image for matching Devices when set to true. Default false
Build	UInt64	User defined build number. Min=0, Max=4294967295, Default=0
Class	string	Class of the Disk. Max Length=40
ClearCacheDisabled	string	Clear cached secrets disabled.
Company	string	User defined company. Max Length=40
Date	string	User defined date. Max Length=40
Description	string	User description. Default=”” Max Length=250
DeviceCount	uint	Read-only count of Devices. Default=0
Guid or DiskLocatorId	Guid	Read-only GUID that uniquely identifies this Disk Locator.
Name or DiskLocatorName	string	Name of the Disk Locator File. It is unique within the Store. ASCII Max Length=52
DiskSize	UInt64	Read-only size of the image. The value is 0 when it is not available. Default=0
DiskUpdateDeviceId	Guid	GUID of the DiskUpdateDevice that is used when updates are performed. Default=00000000-0000-0000-0000-000000000000
DiskUpdateDeviceName	string	Name of the DiskUpdateDevice that is used when updates are performed. Default=””
Enabled	bool	True when this disk can be booted, false otherwise. Default=true
EnabledForDevice	bool	True when this disk is enabled for the Device specified, false otherwise. This is only returned when a Device is specified. Default=true
EnableSetLocalTime	string	Enable setting the local time bias on the disk version.
VHDX	bool	If VHDX is true, the format of the image is VHDX. Otherwise it is VHD. Default=false
HaEnabled	bool	Enable HA when set to true.
HardwareTarget	string	User defined hardware target. Max Length=127
ImageType	string	Type of this image (software type). Max Length=40
InternalName	string	User defined name. Max Length=63
LicenseMode	uint	0 (None), 1 (Multiple Activation Key), or 2 (Key Management Service). Min=0, Max=2, Default=0
Locked	bool	True if the Disk is currently locked, false otherwise. Default=false
LogicalSectorSize	string	Logical Sector Size. Values are:       512,       4096,       Default=512
LongDescription	string	Description of the Disk. Max Length=399
MajorRelease	UInt64	User defined major release number. Min=0, Max=4294967295, Default=0
Mapped	bool	True if the Disk is currently mapped, false otherwise. Default=false
MenuText	string	Text that is displayed in the Boot Menu. If this field has no value, the name value is used. Default=”” ASCII Max Length=64
MinorRelease	UInt64	User defined minor release number. Min=0, Max=4294967295, Default=0
OperatingSystem	string	Operating System of Disk. Max Length=250
OriginalFile	string	User defined original file. Max Length=127
OsType	string	Operating System Type of Disk. Max Length=40
PrinterManagementEnabled	bool	Invalid printers will be deleted from the Device when set to true.
RebalanceEnabled	bool	True when this Server can automatically rebalance Devices, false otherwise. Default=false
RebalanceTriggerPercent	uint	Percent over fair load that triggers a dynamic Device rebalance. Min=5, Max=5000, Default=25
Role	uint	Read-only Role of the user for this item. 100 is Farm Administrator, 200 is Site Administrator, 300 is Collection Administrator, and 999 is read-only. Default=999
SerialNumber	string	User defined serial number. Max Length=36
ServerId	Guid	GUID of the single Server that this Disk Locator is assigned to. It is not used with ServerName. Default=00000000-0000-0000-0000-000000000000
ServerName	string	Name of the single Server that this Disk Locator is assigned to. It is not used with ServerId. Default=””
SiteId	Guid	GUID of the Site this DiskLocator is to be a member of. It is not used with SiteName.
SiteName	string	Name of the Site this DiskLocator is to be a member of. It is not used with SiteId.
StoreId	Guid	GUID of the Store that this Disk Locator is a member of. SiteName or SiteId must also be used. It is not used with StoreName.
StoreName	string	Name of the Store that this Disk Locator is a member of. SiteName or SiteId must also be used. It is not used with StoreId.
SubnetAffinity	uint	Qualifier for subnet affinity when assigning a Server. 0=None, 1=Best Effort, 2=Fixed. Min=0, Max=2, Default=0
TemporaryVersionSet	bool	Read-only true when temporary version(s) are set. Default=false
Title	string	User defined title. Max Length=40
VhdBlockSize	uint	Block size in KB. For VHD it is only used with Dynamic type. Tested sizes for VHD are 512, 2048, and 16384. VHD Min=512, Max=16384, Default=2048. For VHDX it is used for all types. Tested size for VHDX is 32768. VHDX Min=1024, Max= 262144, Default=32768. Default=0
WriteCacheSize	UInt64	RAM cache size (MB). Not 0 when used with Cache in Device RAM, and Cache in Device RAM with Overflow on Hard Disk. A value of 0 will disable the RAM use for Cache in Device RAM with Overflow on Hard Disk. Min=0, Max=131072, Default=0
WriteCacheType	uint	0 (Private), 1 (Cache on Server), 3 (Cache in Device RAM), 4 (Cache on Device Hard Disk), 7 (Cache on Server, Persistent), 9 (Cache in Device RAM with Overflow on Hard Disk), 10 (Private async), 11(Server persistent async), 12 (Cache in Device RAM with Overflow on Hard Disk async) Min=0, Max=12, Default=0

PvsDiskInventory

Read-Only Fields

Field	Type	Description
Active	string	1 if the Server is currently active, 2 if unknown, and 0 otherwise.
Guid or DiskLocatorId	Guid	GUID of the DiskLocator used for Get and Set.
FilePath	string	Path used to access the disk version from the Server. Empty if the information is not available.
FileTime	DateTime	Date/Time of the date version file. Has the date and time without milliseconds. Empty if the information is not available.
PropertiesTime	DateTime	Date/Time of the disk properties. Has the date and time without milliseconds. Empty if the information is not available.
ServerId	Guid	GUID of the Server that the Disk Version Inventory is being reported about.
ServerName	string	Name of the Server that the Disk Version Inventory is being reported about.
State	string	The number code of the inventory state. Values are:       0 (Up to date),       1 (version file is missing),       2 (version file is out of date),       3 (properties are missing),       4 (properties are out of date),       5 (server is not reachable).
Version	string	Version number. The base disk is version 0, the other version numbers are in part of the file name.

PvsDiskLocator

Read/Write Fields

Field	Type	Description
Description	string	User description. Default=”” Max Length=250
Enabled	bool	True when this disk can be booted, false otherwise. Default=true
MenuText	string	Text that is displayed in the Boot Menu. If this field has no value, the name value is used. Default=”” ASCII Max Length=64
RebalanceEnabled	bool	True when this Server can automatically rebalance Devices, false otherwise. Default=false
RebalanceTriggerPercent	uint	Percent over fair load that triggers a dynamic Device rebalance. Min=5, Max=5000, Default=25
ServerId	Guid	GUID of the single Server that this Disk Locator is assigned to. It is not used with ServerName. Default=00000000-0000-0000-0000-000000000000
ServerName	string	Name of the single Server that this Disk Locator is assigned to. It is not used with ServerId. Default=””
SubnetAffinity	uint	Qualifier for subnet affinity when assigning a Server. 0=None, 1=Best Effort, 2=Fixed. Min=0, Max=2, Default=0

Read-Only Fields

Field	Type	Description
Active	bool	True if the DiskLocator is currently active, false otherwise. Default=false
Guid or DiskLocatorId	Guid	Read-only GUID that uniquely identifies this Disk Locator.
Name or DiskLocatorName	string	Name of the Disk Locator File. It is unique within the Store. ASCII Max Length=52
DiskUpdateDeviceId	Guid	GUID of the DiskUpdateDevice that is used when updates are performed. Default=00000000-0000-0000-0000-000000000000
DiskUpdateDeviceName	string	Name of the DiskUpdateDevice that is used when updates are performed. Default=””
EnabledForDevice	bool	True when this disk is enabled for the Device specified, false otherwise. This is only returned when a Device is specified. Default=true
Mapped	bool	True if the Disk is currently mapped, false otherwise. Default=false
Role	uint	Read-only Role of the user for this item. 100 is Farm Administrator, 200 is Site Administrator, 300 is Collection Administrator, and 999 is read-only. Default=999
SiteId	Guid	GUID of the Site this DiskLocator is to be a member of. It is not used with SiteName.
SiteName	string	Name of the Site this DiskLocator is to be a member of. It is not used with SiteId.
StoreId	Guid	GUID of the Store that this Disk Locator is a member of. SiteName or SiteId must also be used. It is not used with StoreName.
StoreName	string	Name of the Store that this Disk Locator is a member of. SiteName or SiteId must also be used. It is not used with StoreId.
TemporaryVersionSet	bool	Read-only true when temporary version(s) are set. Default=false

PvsDiskLocatorLock

Read-Only Fields

Field	Type	Description
DeviceId	Guid	GUID of the Device that has the lock, will be 00000000-0000-0000-0000-000000000000 if a Server has the lock.
DeviceName	string	Name of the Device that has the lock, will not be included if a Server has the lock.
Exclusive	bool	True when the lock is exclusive, false when it is shared. Default=false
ReadOnly	bool	True when lock is because file system is read only, false when file system is read write Default=false
ServerId	Guid	GUID of the Server that has the lock, will be 00000000-0000-0000-0000-000000000000 if a Device has the lock.
ServerName	string	Name of the Server that has the lock, will not be included if a Device has the lock.

PvsDiskUpdateDevice

Read/Write Fields

Field	Type	Description
AdPassword	string	The Active Directory machine account password. Do not set this field, it is only set internally by PVS. Default=”” Max Length=65535
AdSignature	uint	The signature of the Active Directory machine account password. Do not set this field, it is only set internally by PVS. Default=0
AdTimestamp	uint	The time the Active Directory machine account password was generated. Do not set this field, it is only set internally by PVS. Default=0
Description	string	User description. Default=”” Max Length=250
DomainControllerName	string	The name of the DC used to create the host’s computer account. Do not set this field, it is only set internally by PVS. Default=”” Max Length=4000
DomainName	string	Fully qualified name of the domain that the Device belongs to. Do not set this field, it is only set internally by PVS. Default=”” Max Length=255
DomainObjectSID	string	The value of the objectSID AD attribute of the same name for the Device’s computer account. Do not set this field, it is only set internally by PVS. Default=”” Max Length=186
DomainTimeCreated	DateTime	The time that the computer account was created. Has the date and time including milliseconds. Do not set this field, it is only set internally by PVS. Default=Empty
LogLevel	uint	Level to perform logging at. Values are:       0 (None),       1 (Fatal),       2 (Error),       3 (Warning),       4 (Info),       and 5 (Debug). Min=0,       Max=6,       Default=4
Port	uint	UDP port to use with Stream Service. Min=1025, Max=65534, Default=6901

Read-Only Fields

Field	Type	Description
Active	bool	True if the Device is currently active, false otherwise. Default=false
Guid or DeviceId	Guid	Read-only GUID that uniquely identifies this Device.
DeviceMac	PvsPhysicalAddress	Ethernet address can have the form XX-XX-XX-XX-XX-XX. Uniquely identifies the Device. Default=””
Name or DeviceName	string	Computer name with no spaces. ASCII computer name characters Max Length=15
DiskLocatorId	Guid	GUID of the Disk Locator to update with this Device.
DiskLocatorName	string	Name of the Disk Locator File to update with this Device.
DiskVersion	uint	Read-only version of the Disk Locator File that the Device is using. It is equal to 0 if the Device is not active. Default=0
Ip	System.Net.IPAddress	Read-only IPv4 Address of the Device. It is equal to 0.0.0.0 if the Device is not active or not using IPv4
Ipv6	string	Read-only IPv6 Address of the device. It is equal to “::” if the device is not active or not using IPv6 Default=0
License	uint	Oem Only: Read-only type of the license. Values are 0 when None, 1 or 2 when Desktop. It is equal to 0 if the Device is not active. Default=0
LicenseType	uint	0 when None, 1 for Desktop, 2 for Server, 5 for OEM SmartClient, 6 for XenApp, 7 for XenDesktop. It is equal to 0 if the Device is not active. Default=0
MakLicenseActivated	uint	Read-only indicator if MAK licensing is being used and is activated. Values are:       0 (MAK not used),       1 (Not Activated),       2 (Activated). It is equal to 0 if the Device is not active. Default=0
Model	string	Oem Only: Read-only model of the computer. Values are OptiPlex 745, 755, 320, 760, FX160, or Default. It is equal to “” if the Device is not active.
ServerId	Guid	Read-only GUID of the Server that the Device is using. It is equal to 00000000-0000-0000-0000-000000000000 if the Device is not active.
ServerIpConnection	System.Net.IPAddress	Read-only IPv4 Address of the Server that the Device is using. It is equal to 0.0.0.0 if the Device is not active or not using IPv4.
ServerIpv6Connection	string	Read-only IPv6 Address of the Server that the Device is using. It is equal to “::” if the Device is not active or not using IPv6. Default=0
ServerName	string	Read-only Name of the Server that the Device is using. It is equal to “” if the Device is not active.
ServerPortConnection	uint	Read-only Port of the Server that the Device is using. It is equal to 0 if the Device is not active. Default=0
SiteId	Guid	GUID of the Site this Disk Update Device is to be a member of.
SiteName	string	Name of the Site this Disk Update Device is to be a member of.
Status	string	1 or 2 numbers in the format n,n. They are the number of retries and if ram cache is being used, ram cache percent used. It is equal to “” if the Device is not active.
StoreId	Guid	GUID of the Store that the Disk Locator is a member of.
StoreName	string	Name of the Store that the Disk Locator is a member of.
VirtualHostingPoolId	Guid	GUID of the Virtual Hosting Pool. It is not used with VirtualHostingPoolName. Default=00000000-0000-0000-0000-000000000000
VirtualHostingPoolName	string	Name of the Virtual Hosting Pool.

PvsDiskUpdateStatus

Read-Only Fields

Field	Type	Description
CurrentStatus	uint	Current status of the update. Values are:       0 (Ready),       1 (Update Pending),       2 (Preparing Image),       3 (Starting VM),       4 (Update In Progress),       5 (Stopping VM),       6 (Submitting Image),       7 (Reverting Image),       8 (Invalid),       9 (Aborted),       10 (Completed Successfully),       11 (No Updates) Min=0,       Max=11,       Default=0
CurrentStatusMessage	string	Message string that includes the results of the run. Default=”” Max Length=255
Description	string	User description of the Update Task.
DeviceId	Guid	GUID that Device being used to do the update.
DeviceName	string	Name of the Device being used to do the update.
DiskLocatorId	Guid	GUID of the Disk Locator to update.
Name or DiskLocatorName	string	Name of the Disk Locator File to update.
Guid or DiskUpdateTaskId	Guid	GUID that uniquely identifies this Update Task and Device relationship.
PreviousResult	uint	Status of the last run. Values are:       0 (Ready),       1 (Update Pending),       2 (Preparing Image),       3 (Starting VM),       4 (Update In Progress),       5 (Stopping VM),       6 (Submitting Image),       7 (Reverting Image),       8 (Invalid),       9 (Aborted),       10 (Completed Successfully),       11 (No Updates) Min=0,       Max=11,       Default=0
PreviousResultMessage	string	Message string that includes the results of the last run. Default=”” Max Length=255
SiteId	Guid	GUID of the Site that this Update Task Name is a member of.
SiteName	string	Name of the Site that this Update Task Name is a member of.
StoreId	Guid	GUID of the Store that the Disk Locator is a member of.
StoreName	string	Name of the Store that the Disk Locator is a member of.
UpdateTaskId	Guid	GUID that uniquely identifies the Update Task.
UpdateTaskName	string	Name of the Update Task.
VirtualHostingPoolId	Guid	GUID of the Virtual Hosting Pool being used for the update.
VirtualHostingPoolName	string	Name of the Virtual Hosting Pool being used for the update.

PvsDiskVersion

Read/Write Fields

Field	Type	Description
Description	string	User description. Default=”” Max Length=250
ScheduledDate	DateTime	Date/Time that the Disk Version is scheduled to become available. Has the date, hour and minute. Empty when the disk version is made available immediately. Default=Empty

Read-Only Fields

Field	Type	Description
Access	uint	Read-only access of the Disk Version. Values are:       0 (Production),       1 (Maintenance),       2 (MaintenanceHighestVersion),       3 (Override),       4 (Merge),       5 (MergeMaintenance),       6 (MergeTest),       and 7 (Test) Min=0,       Max=7,       Default=0
CanDelete	bool	Read-only true when the version can be deleted. Default=false
CanMerge	bool	Read-only true when the version can be update merged. Will be set for the highest version number. Default=false
CanMergeBase	bool	Read-only true when the version can be base merged. Will be set for the highest version number. Default=false
CanOverride	bool	Read-only true when the version can be set as the Override. Default=false
CanPromote	bool	Read-only true when the version can be promoted. Default=false
CanRevertMaintenance	bool	Read-only true when the version can be reverted to Maintenance Access. Default=false
CanRevertTest	bool	Read-only true when the version can be reverted to Test Access. Default=false
CanSetScheduledDate	bool	Read-only true when the version can have the scheduled date modified. Default=false
CreateDate	string	Read-only Date/Time that the Disk Version was created. Default=getdate
DeleteWhenFree	bool	Read-only true if the Disk Version is no longer needed because of a merge. If not current booted by a Device, it can be deleted. Default=false
DeviceCount	uint	Read-only count of Devices. Default=0
Name or DiskFileName	string	Name of the Disk File including the extension. Default=””
Guid or DiskLocatorId	Guid	GUID of the DiskLocator used for Get and Set.
GoodInventoryStatus	bool	True when the up to date file is accessible by all Servers, false otherwise. Default=false
IsPending	bool	Read-only true when the version ScheduledDate has not occurred. Default=false
LocalTimeBias	string	The time zone set in the vDisk version as the offset from UTC in minutes. -1 indicates vDisk timezone is not known or applicable. Default is -1 Default=-1 Max Length=5
TaskId	uint	When a Merge is occurring, this will be set with the task number of the process that is occurring. Default=””
TemporaryVersionSet	bool	Read-only true when temporary version(s) are set. Some changes cannot be made to the version when this is set. Default=false
Type	uint	Read-only type of the Disk Version. Values are:       0 (Base),       1 (Manual),       2 (Automatic),       3 (Merge),       and 4 (MergeBase) Min=0,       Max=4,       Default=0
Version	uint	Read-only version number. The base disk is version 0, the other version numbers are in part of the file name. Default=0

PvsFarm

Read/Write Fields

Field	Type	Description
AuditingEnabled	bool	True when Auditing is enabled, false otherwise. Default=false
AutoAddEnabled	bool	True when Auto Add is enabled, false otherwise. Default=false
AutomaticMergeEnabled	bool	True when Automatic Merge is enabled, false otherwise. If the number of versions becomes more than the MaxVersions value, a merge will occur at the end of PromoteDiskVersion. Default=true
DefaultDeviceLogLevel	uint	The default logging level used by newly created target devices. Values are:       0 (None),       1 (Fatal),       2 (Error),       3 (Warning),       4 (Info),       and 5 (Debug). Min=0,       Max=6,       Default=4
DefaultSiteId	Guid	GUID of the Site to place new Devices into automatically. Not used with defaultSiteName. Default=00000000-0000-0000-0000-000000000000
DefaultSiteName	string	Name of the Site to place new Devices into automatically. Not used with DefaultSiteId. Default=””
Description	string	User description. Default=”” Max Length=250
EncryptionStatus	uint	The current status for database encryption. 0 = Idle, 1 = Distributing Keys, 2= Re-encrypting database Min=0, Max=2, Default=0
FarmEpoch	UInt64	Timestamp when the Data Encryption Key (DEK) was created and stored in the Credential Wallet. Default=0
Name or FarmName	string	Name of the Farm. Default=”” Max Length=50
IsUsageDataScrambled	bool	Indicates whether the sensitive information needs to be scrambled (true) or not (false) when uploading usage telemetry data. Default = true. Default=true
LastAuditArchiveDate	DateTime	Last date of Audit Trail data that was Archived. Has the date. Default=Empty
LicenseServer	string	License server name. Default=”” Max Length=255
LicenseServerCertThumbprint	string	Stores the license server’s server certificate thumbprint when the server certificate is explicitly accepted by the administrator. NULL if no certificate is explicitly accepted. Default=”” Max Length=65535
LicenseServerPort	uint	License server port. Min=1025, Max=65534, Default=27000
LicenseSKU	uint	LicenseSKU. 0 for on-premises, 1 for cloud. Min=0, Max=1, Default=0
LicenseTradeUp	bool	License server trade up, when set to true. Default=false
LicenseWebServicesPort	uint	The license server web services for licensing port. Min=1025, Max=65534, Default=8083
MaxVersions	uint	Maximum number a versions of a Disk that can exist before a merge will automatically occur. Min=3, Max=50, Default=5
MergeMode	uint	Mode to place the version in after a merge has occurred. Values are:       0 (Production),       1 (Test) and 2 (Maintenance). Min=0,       Max=2,       Default=2
OfflineDatabaseSupportEnabled	bool	True when Offline Database Support is enabled, false otherwise. Default=false

Read-Only Fields

Field	Type	Description
AdGroupsEnabled	bool	Active Directory groups are used for authorization, when set to true. Windows groups are used when set to false. Default=false
CloudSetupActive	bool	True if farm is integrated with Citrix Cloud and all PVS servers have been registered with Citrix Cloud. Default=false
CustomerId	string	The Citrix Cloud customer ID if the SetupType is Citrix Cloud. Default=”” Max Length=128
CustomerName	string	The Citrix Cloud customer name if the SetupType is Citrix Cloud. Default=”” Max Length=256
DatabaseInstanceName	string	Read-only name of the database instance.
DatabaseName	string	Read-only name of the database.
DatabaseServerName	string	Read-only name of the database server.
EntitledState	string	Indicates the entitled state of PVS Farm with LAS. 0 (not entitled), 1 (entitled via LAS), 2 (entitled via V6)
EntitlementExpirationDate	string	Expiration date of the entitlement
FailoverPartnerInstanceName	string	Read-only name of the database server instance.
FailoverPartnerServerName	string	Read-only name of the database server.
Guid or FarmId	Guid	Read-only GUID that uniquely identifies this Farm.
IsReadOnly	string	Indicates whether the administrative role is read-only(true) or read-write(false).
KeyExchangeType	uint	The encryption key exchange type. 0=CredentialWallet, 1=Peer-2-Peer. Min=0, Max=1, Default=1
KeyRotationInitiatingServerFqdn	string	The FQDN of the Server who initiated the database encryption key rotation. Default=”” Max Length=1024
ManualKeyCyclingRequired	bool	Indicates if a manual encryption key rotation is required(true) or not(false). Default=false
MultiSubnetFailover	string	Read-only Database MultiSubnetFailover value
Role	uint	Read-only Role of the user for this item. 100 is Farm Administrator, and 999 is read-only. Default=999
SetupType	uint	Farm integration type. 0 for no integration, 1 for Citrix Cloud, 2 for Citrix Virtual Apps and Desktops. Min=0, Max=2, Default=0
XdSetupActive	bool	True if farm is integrated with Citrix Virtual Apps and Desktops and all PVS servers have been registered with the CVAD site. Default=false
XdSiteId	Guid	The CVAD site ID if the SetupType is Citrix Virtual Apps and Desktops. Default=00000000-0000-0000-0000-000000000000
XdSiteName	string	The CVAD site name if the SetupType is Citrix Virtual Apps and Desktops. Default=”” Max Length=256

PvsFarmView

Read/Write Fields

Field	Type	Description
Description	string	User description. Default=”” Max Length=250
Name or FarmViewName	string	name of the Farm View. Max Length=50

Read-Only Fields

Field	Type	Description
ActiveDeviceCount	uint	Read-only count of active Devices in this Farm View. Default=0
DeviceCount	uint	Read-only count of Devices in this Farm View. Default=0
Guid or FarmViewId	Guid	Read-only GUID that uniquely identifies this Farm View.
MakActivateNeededCount	uint	Read-only count of active Devices that need MAK activation in this Farm View. Default=0

PvsGroup

Read-Only Fields

Field	Type	Description
Guid	Guid	GUID of the Active Directory group. 00000000-0000-0000-0000-000000000000 for Windows groups.
Name	string	Name of the Group.

PvsKeyRotationPendingServers

Read-Only Fields

Field	Type	Description
Active	string	1 if the Server is currently active, 2 if unknown, and 0 otherwise.
Name or ServerName	string	Computer name with no spaces.
SiteName	string	Name of the Site.

PvsLocalServer

Read-Only Field

Field	Type	Description
Name or LocalServer	string	NetBios name of local server.

PvsNewDiskVersion

Read-Only Fields

Field	Type	Description
Name	string	Name of the disk file without the extension.
Status	uint	Status of the disk file. Values are:       0 (Valid),       1 (Missing Properties File),       2 (Access Denied),       3 (Access Denied and Missing Properties File),       4 (Invalid Disk File),       5 (Manifest Invalid)

PvsPhysicalAddress

Derived from System.Net.NetworkInformation.PhysicalAddress. GetString() returns a - delimited MAC address.

PvsScrambledDataReport

Read-Only Fields

Field	Type	Description
ScrambledData	string	The scrambled data field
Value	string	The real value of the scrambled data field

PvsServer

Read/Write Fields

Field	Type	Description
AdMaxPasswordAge	uint	Number of days before a password expires. Min=1, Max=30, Default=7
AdMaxPasswordAgeEnabled	bool	Age the password, when set to true. Default=false
BootPauseSeconds	uint	Number of seconds that a Device will pause during login if its server busy. Min=1, Max=60, Default=10
BuffersPerThread	uint	Number of buffers per worker thread. Min=1, Max=128, Default=24
BusyDbConnectionRetryCount	uint	Number of times a failed database connection will be retried. Min=0, Max=32767, Default=2
BusyDbConnectionRetryInterval	uint	Interval, in number of milliseconds, the server should wait before retrying to connect to a database. Min=0, Max=10000, Default=25
Description	string	User description. Default=”” Max Length=250
EventLoggingEnabled	bool	Enable event logging, when set to true. Default=true
FirstPort	uint	Number of the first UDP port for use by the Stream Service, First and Last must allow at least 5 ports. Min=1025, Max=65534, Default=6910
InitialQueryConnectionPoolSize	uint	Initial size of database connection pool for non-transactional queries. Min=1, Max=1000, Default=50
InitialTransactionConnectionPoolSize	uint	Initial size of database connection pool for transactional queries. Min=1, Max=1000, Default=50
IoBurstSize	uint	Number of bytes read/writes can send in a burst of packets. Required that IoBurstSize/(MaxTransmissionUnits-76)<=32. Min=4096, Max=61440, Default=32768
Ip	System.Net.IPAddress[]	One or more streaming IPv4 Addresses. If more than one address is included they are comma delimited. NOTE that an empty string results in no configured IPv4 addresses
Ipv6	string[]	One or more streaming IPv6 Addresses. If more than one address is included they are comma delimited. NOTE that an empty string results in no configured IPv6 addresses
LastBugReportAttempt	DateTime	Time that this server last attempted to upload or generate a bug report bundle. Default=Empty
LastBugReportResult	string	Status of the last bug report on this server. Default=”” Max Length=4000
LastBugReportStatus	string	Status of the last bug report on this server. Default=”” Max Length=250
LastBugReportSummary	string	Summary of the last bug report on this server. Default=”” Max Length=250
LastCeipUploadAttempt	DateTime	Time that this server last attempted a CEIP upload. Default=Empty
LastPort	uint	Number of the last UDP port for use by the Stream Service, First and Last must allow at least 5 ports. Min=1025, Max=65534, Default=6930
LicenseTimeout	uint	Amount of seconds before a license times out. Min=15, Max=300, Default=30
LocalConcurrentIoLimit	uint	Maximum concurrent IO transactions it performs for vDisks that are local. A value of 0 disables the feature. Min=0, Max=128, Default=4
LogFileBackupCopiesMax	uint	Maximum number of log file backups. Min=1, Max=50, Default=4
LogFileSizeMax	uint	Maximum size log files can reach in Megabytes. Min=1, Max=50, Default=5
LogLevel	uint	Level to perform logging at. Values are:       0 (None),       1 (Fatal),       2 (Error),       3 (Warning),       4 (Info),       5 (Debug),       and 6 (Trace). Min=0,       Max=6,       Default=4
MaxBootDevicesAllowed	uint	Maximum number of Devices allowed to boot simultaneously. Min=1, Max=1000, Default=500
MaxBootSeconds	uint	Maximum number of seconds for a Device to boot. Min=10, Max=900, Default=60
MaxQueryConnectionPoolSize	uint	Maximum size of database connection pool for non-transactional queries. Min=1, Max=32767, Default=1000
MaxTransactionConnectionPoolSize	uint	Maximum size of database connection pool for transactional queries. Min=1, Max=32767, Default=1000
MaxTransmissionUnits	uint	Ethernet maximum transmission unit size for the protocol for use for Server and Device. Required that IoBurstSize/(MaxTransmissionUnits-76)<=32. Min=502, Max=16426, Default=1506
NonBlockingIoEnabled	bool	Use non-Blocking IO, when set to true. Default=true
PowerRating	float	A strictly relative rating of this Server’s capabilities when compared to other Servers in the Store(s) it belongs too; can be used to help tune load balancing. Min=0.1, Max=1000, Default=1
QuicCipherSuites	uint	QuicCipherSuites Default=””
QuicPort	uint	QuicPort Default=0
QuicServerCertThumbPrint	string	QuicServerCertThumbPrint Default=”” Max Length=65535
QuicSettings	string	QuicSettings Default=”” Max Length=65535
QuicStreamPayloadLength	uint	QuicStreamPayloadLength Default=0
RefreshInterval	uint	Interval, in number of seconds, the server should wait before refreshing settings. If set to 0, unused database connections are never released. Min=0, Max=32767, Default=300
RemoteConcurrentIoLimit	uint	Maximum concurrent IO transactions it performs for vDisks that are remote. A value of 0 disables the feature. Min=0, Max=128, Default=4
SecurityPolicy	uint	SecurityPolicy Default=0
ServerCacheTimeout	uint	Number of seconds to wait before considering another Server is down. Min=5, Max=60, Default=8
ServerEpoch	UInt64	Timestamp when the registry data for that server has been re-encrypted with updated encryption scheme. Default=0
Name or ServerName	string	Computer name with no spaces. ASCII computer name characters Max Length=21
ThreadsPerPort	uint	Number of worker threads per IO port. Required that (threadPerPort * numberPorts * numberIPs) <= 1000. Min=1, Max=60, Default=8
TpmCurveId	uint	TPM ECC curve ID TPM_ECC_NIST_P256(3), TPM_ECC_NIST_P384(4), TPM_ECC_NIST_P521(5) Default=0
TpmHashAlg	uint	TPM hash algorithm, TPM_ALG_SHA256(0xb), TPM_ALG_SHA384(0xc), TPM_ALG_SHA512(0xd) Default=0
TpmKeyType	uint	TPM key type, TPM_ALG_RSA(1), TPM_ALG_ECC(0x23) Default=0
UnusedDbConnectionTimeout	uint	Interval, in number of seconds, a connection should go unused before it is to be released. Min=0, Max=32767, Default=300
VDiskCreatePacing	uint	VDisk create time pacing in milliseconds. Min=0, Max=5, Default=0

Read-Only Fields

Field	Type	Description
Active	uint	1 if the Server is currently active, 2 if unknown, and 0 otherwise. Min=0, Max=2, Default=0
CloudSetupActive	bool	True if farm is integrated with Citrix Cloud and this PVS server has been registered with Citrix Cloud. Default=false
IdentityPublicKey	string	PVS Server’s Identity Public key. This field is used for authentication in Peer-2-Peer communication between Servers. Default=”” Max Length=65535
ManagementIp	System.Net.IPAddress	IP address used for management communications between Servers. Default=0.0.0.0
Role	uint	Read-only Role of the user for this item. 100 is Farm Administrator, and 200 is Site Administrator. Default=999
ServerFqdn	string	Read-only fully qualified domain name. Default=”” Max Length=1024
Guid or ServerId	Guid	Read-only GUID that uniquely identifies this Server.
ServerRegistrationKeyStatus	uint	Status of the server registration key, 0 if valid, 1 if invalid, 2 if not present and 3 if failed to validate the registration key. Min=0, Max=4, Default=2
SiteId	Guid	GUID of the Site this Server is to be a member of. It is not used with SiteName.
SiteName	string	Name of the Site this Server is to be a member of. It is not used with SiteId.
TrustCertificate	string	A PEM-encoded certificate that will be used to establish trust for the server’s certificate for PvsRpc communication. Default=”” Max Length=65535
XdControllerAddress	string	The Citrix Virtual Apps and Desktops controller used to register this PVS server with a CVAD site. Default=”” Max Length=1024
XdSetupActive	bool	True if farm is integrated with Citrix Virtual Apps and Desktops and this PVS server has been registered with the CVAD site. Default=false

PvsServerBiosBootstrap

Read/Write Fields

Field	Type	Description
BootFromHdOnFail	bool	For network recovery reboot to hard drive when set to true, restore network connection when set to false. Default=false
Bootserver1_Ip	System.Net.IPAddress	1st boot server IP. Only used when Lookup is false.
Bootserver1_Port	uint	1st boot server port. Only used when Lookup is false. Min=1025, Max=65536, Default=6910
Bootserver2_Ip	System.Net.IPAddress	2nd boot server IP. Only used when Lookup is false. Default=0.0.0.0
Bootserver2_Port	uint	2nd boot server port. Only used when Lookup is false. Min=1025, Max=65536, Default=6910
Bootserver3_Ip	System.Net.IPAddress	3rd boot server IP. Only used when Lookup is false. Default=0.0.0.0
Bootserver3_Port	uint	3rd boot server port. Only used when Lookup is false. Min=1025, Max=65536, Default=6910
Bootserver4_Ip	System.Net.IPAddress	4th boot server IP. Only used when Lookup is false. Default=0.0.0.0
Bootserver4_Port	uint	4th boot server port. Only used when Lookup is false. Min=1025, Max=65536, Default=6910
DhcpEnabled	bool	Use DHCP to retrieve target device IP when set to true, otherwise use the static domain, dnsIpAddresstrue and dnsIpAddress2 settings. Default=true
DnsIpAddress1	System.Net.IPAddress	Primary DNS server IP. Only used when DhcpEnabled is false.
DnsIpAddress2	System.Net.IPAddress	Secondary DNS server IP. Only used when DhcpEnabled is false.
Domain	string	Domain of the primary and secondary DNS servers. Only used when DhcpEnabled is false.
Enabled	bool	Automatically update the BIOS on the target device with these setting when set to true, otherwise do not use these settings. Default=false
GeneralTimeout	uint	Login general timeout in milliseconds. Min=1000, Max=60000, Default=5000
InterruptSafeMode	bool	Interrupt safe mode (use if target device hangs during boot) when set to true. Default=false
Lookup	bool	Use DNS to find the Server when set to true with the ServerName host value, otherwise use the bootservertrue_Ip, bootservertrue_Port, bootserver2_Ip, bootserver2_Port, bootserver3_Ip, bootserver3_Port, bootserver4_Ip, and bootserver4_Port settings. Default=true
PaeMode	bool	PAE mode (use if PAE enabled in boot.ini of target device) when set to true. Default=false
PollingTimeout	uint	Login polling timeout in milliseconds. Min=1000, Max=60000, Default=5000
RecoveryTime	uint	When bootFromHdOnFail is 1, this is the number of seconds to wait before reboot to hard drive. Min=10, Max=60000, Default=50
Name or ServerName	string	Host to use for DNS lookup. Only used when Lookup is true. Default=IMAGESERVER1
VerboseMode	bool	Display verbose diagnostic information when set to true. Default=false

Read-Only Field

Field	Type	Description
Guid or ServerId	Guid	GUID of the Server used for Get and Set.

PvsServerBootstrap

Read/Write Fields

Field	Type	Description
BootFromHdOnFail	bool	For network recovery reboot to hard drive when set to true, restore network connection when set to false. Default=false
Bootserver1_Gateway	System.Net.IPAddress	1st boot server gateway. Default=0.0.0.0
Bootserver1_Ip	System.Net.IPAddress	1st boot server IP.
Bootserver1_Netmask	System.Net.IPAddress	1st boot server netmask. Default=0.0.0.0
Bootserver1_Port	uint	1st boot server port. Min=1025, Max=65536, Default=6910
Bootserver2_Gateway	System.Net.IPAddress	2nd boot server gateway. Default=0.0.0.0
Bootserver2_Ip	System.Net.IPAddress	2nd boot server IP. Default=0.0.0.0
Bootserver2_Netmask	System.Net.IPAddress	2nd boot server netmask. Default=0.0.0.0
Bootserver2_Port	uint	2nd boot server port. Min=1025, Max=65536, Default=6910
Bootserver3_Gateway	System.Net.IPAddress	3rd boot server gateway. Default=0.0.0.0
Bootserver3_Ip	System.Net.IPAddress	3rd boot server IP. Default=0.0.0.0
Bootserver3_Netmask	System.Net.IPAddress	3rd boot server netmask. Default=0.0.0.0
Bootserver3_Port	uint	3rd boot server port. Min=1025, Max=65536, Default=6910
Bootserver4_Gateway	System.Net.IPAddress	4th boot server gateway. Default=0.0.0.0
Bootserver4_Ip	System.Net.IPAddress	4th boot server IP. Default=0.0.0.0
Bootserver4_Netmask	System.Net.IPAddress	4th boot server netmask. Default=0.0.0.0
Bootserver4_Port	uint	4th boot server port. Min=1025, Max=65536, Default=6910
GeneralTimeout	uint	Login general timeout in milliseconds. Min=1000, Max=60000, Default=5000
InterruptSafeMode	bool	Interrupt safe mode (use if target device hangs during boot) when set to true. Default=false
PaeMode	bool	PAE mode (use if PAE enabled in boot.ini of target device) when set to true. Default=false
PollingTimeout	uint	Login polling timeout in milliseconds. Min=1000, Max=60000, Default=5000
RecoveryTime	uint	When bootFromHdOnFail is 1, this is the number of seconds to wait before reboot to hard drive. Min=10, Max=60000, Default=50
VerboseMode	bool	Display verbose diagnostic information when set to true. Default=false

Read-Only Fields

Field	Type	Description
Name	string	Name of the bootstrap file used to Get and Set.
Guid or ServerId	Guid	GUID of the Server used for Get and Set.

PvsServerBootstrapName

Read-Only Field

Field	Type	Description
Name	string	Bootstrap file name.

PvsServerInfo

Read-Only Fields

Field	Type	Description
Active	uint	1 if the Server is currently active, 2 if unknown, and 0 otherwise. Min=0, Max=2, Default=0
AdMaxPasswordAge	uint	Number of days before a password expires. Min=1, Max=30, Default=7
AdMaxPasswordAgeEnabled	bool	Age the password, when set to true. Default=false
BootPauseSeconds	uint	Number of seconds that a Device will pause during login if its server busy. Min=1, Max=60, Default=10
BuffersPerThread	uint	Number of buffers per worker thread. Min=1, Max=128, Default=24
BusyDbConnectionRetryCount	uint	Number of times a failed database connection will be retried. Min=0, Max=32767, Default=2
BusyDbConnectionRetryInterval	uint	Interval, in number of milliseconds, the server should wait before retrying to connect to a database. Min=0, Max=10000, Default=25
CloudSetupActive	bool	True if farm is integrated with Citrix Cloud and this PVS server has been registered with Citrix Cloud. Default=false
ContactIp	System.Net.IPAddress	Read-only contact IPv4 Address for the Server.
ContactIpv6	string	Read-only contact IPv6 Address for the Server.
ContactPort	string	Read-only contact port for the Server.
Description	string	User description. Default=”” Max Length=250
DeviceCount	uint	Read-only count of Devices. Default=0
EventLoggingEnabled	bool	Enable event logging, when set to true. Default=true
FirstPort	uint	Number of the first UDP port for use by the Stream Service, First and Last must allow at least 5 ports. Min=1025, Max=65534, Default=6910
IdentityPublicKey	string	PVS Server’s Identity Public key. This field is used for authentication in Peer-2-Peer communication between Servers. Default=”” Max Length=65535
InitialQueryConnectionPoolSize	uint	Initial size of database connection pool for non-transactional queries. Min=1, Max=1000, Default=50
InitialTransactionConnectionPoolSize	uint	Initial size of database connection pool for transactional queries. Min=1, Max=1000, Default=50
IoBurstSize	uint	Number of bytes read/writes can send in a burst of packets. Required that IoBurstSize/(MaxTransmissionUnits-76)<=32. Min=4096, Max=61440, Default=32768
Ip	System.Net.IPAddress[]	One or more streaming IPv4 Addresses. If more than one address is included they are comma delimited. NOTE that an empty string results in no configured IPv4 addresses
Ipv6	string[]	One or more streaming IPv6 Addresses. If more than one address is included they are comma delimited. NOTE that an empty string results in no configured IPv6 addresses
LastBugReportAttempt	DateTime	Time that this server last attempted to upload or generate a bug report bundle. Default=Empty
LastBugReportResult	string	Status of the last bug report on this server. Default=”” Max Length=4000
LastBugReportStatus	string	Status of the last bug report on this server. Default=”” Max Length=250
LastBugReportSummary	string	Summary of the last bug report on this server. Default=”” Max Length=250
LastCeipUploadAttempt	DateTime	Time that this server last attempted a CEIP upload. Default=Empty
LastPort	uint	Number of the last UDP port for use by the Stream Service, First and Last must allow at least 5 ports. Min=1025, Max=65534, Default=6930
LicenseTimeout	uint	Amount of seconds before a license times out. Min=15, Max=300, Default=30
LocalConcurrentIoLimit	uint	Maximum concurrent IO transactions it performs for vDisks that are local. A value of 0 disables the feature. Min=0, Max=128, Default=4
LogFileBackupCopiesMax	uint	Maximum number of log file backups. Min=1, Max=50, Default=4
LogFileSizeMax	uint	Maximum size log files can reach in Megabytes. Min=1, Max=50, Default=5
LogLevel	uint	Level to perform logging at. Values are:       0 (None),       1 (Fatal),       2 (Error),       3 (Warning),       4 (Info),       5 (Debug),       and 6 (Trace). Min=0,       Max=6,       Default=4
ManagementIp	System.Net.IPAddress	IP address used for management communications between Servers. Default=0.0.0.0
MaxBootDevicesAllowed	uint	Maximum number of Devices allowed to boot simultaneously. Min=1, Max=1000, Default=500
MaxBootSeconds	uint	Maximum number of seconds for a Device to boot. Min=10, Max=900, Default=60
MaxQueryConnectionPoolSize	uint	Maximum size of database connection pool for non-transactional queries. Min=1, Max=32767, Default=1000
MaxTransactionConnectionPoolSize	uint	Maximum size of database connection pool for transactional queries. Min=1, Max=32767, Default=1000
MaxTransmissionUnits	uint	Ethernet maximum transmission unit size for the protocol for use for Server and Device. Required that IoBurstSize/(MaxTransmissionUnits-76)<=32. Min=502, Max=16426, Default=1506
NonBlockingIoEnabled	bool	Use non-Blocking IO, when set to true. Default=true
PowerRating	float	A strictly relative rating of this Server’s capabilities when compared to other Servers in the Store(s) it belongs too; can be used to help tune load balancing. Min=0.1, Max=1000, Default=1
QuicCipherSuites	uint	QuicCipherSuites Default=””
QuicPort	uint	QuicPort Default=0
QuicServerCertThumbPrint	string	QuicServerCertThumbPrint Default=”” Max Length=65535
QuicSettings	string	QuicSettings Default=”” Max Length=65535
QuicStreamPayloadLength	uint	QuicStreamPayloadLength Default=0
RefreshInterval	uint	Interval, in number of seconds, the server should wait before refreshing settings. If set to 0, unused database connections are never released. Min=0, Max=32767, Default=300
RemoteConcurrentIoLimit	uint	Maximum concurrent IO transactions it performs for vDisks that are remote. A value of 0 disables the feature. Min=0, Max=128, Default=4
Role	uint	Read-only Role of the user for this item. 100 is Farm Administrator, and 200 is Site Administrator. Default=999
SecurityPolicy	uint	SecurityPolicy Default=0
ServerCacheTimeout	uint	Number of seconds to wait before considering another Server is down. Min=5, Max=60, Default=8
ServerEpoch	UInt64	Timestamp when the registry data for that server has been re-encrypted with updated encryption scheme. Default=0
ServerFqdn	string	Read-only fully qualified domain name. Default=”” Max Length=1024
Guid or ServerId	Guid	Read-only GUID that uniquely identifies this Server.
Name or ServerName	string	Computer name with no spaces. ASCII computer name characters Max Length=21
ServerRegistrationKeyStatus	uint	Status of the server registration key, 0 if valid, 1 if invalid, 2 if not present and 3 if failed to validate the registration key. Min=0, Max=4, Default=2
SiteId	Guid	GUID of the Site this Server is to be a member of. It is not used with SiteName.
SiteName	string	Name of the Site this Server is to be a member of. It is not used with SiteId.
ThreadsPerPort	uint	Number of worker threads per IO port. Required that (threadPerPort * numberPorts * numberIPs) <= 1000. Min=1, Max=60, Default=8
TpmCurveId	uint	TPM ECC curve ID TPM_ECC_NIST_P256(3), TPM_ECC_NIST_P384(4), TPM_ECC_NIST_P521(5) Default=0
TpmHashAlg	uint	TPM hash algorithm, TPM_ALG_SHA256(0xb), TPM_ALG_SHA384(0xc), TPM_ALG_SHA512(0xd) Default=0
TpmKeyType	uint	TPM key type, TPM_ALG_RSA(1), TPM_ALG_ECC(0x23) Default=0
TrustCertificate	string	A PEM-encoded certificate that will be used to establish trust for the server’s certificate for PvsRpc communication. Default=”” Max Length=65535
UnusedDbConnectionTimeout	uint	Interval, in number of seconds, a connection should go unused before it is to be released. Min=0, Max=32767, Default=300
VDiskCreatePacing	uint	VDisk create time pacing in milliseconds. Min=0, Max=5, Default=0
XdControllerAddress	string	The Citrix Virtual Apps and Desktops controller used to register this PVS server with a CVAD site. Default=”” Max Length=1024
XdSetupActive	bool	True if farm is integrated with Citrix Virtual Apps and Desktops and this PVS server has been registered with the CVAD site. Default=false

PvsServerStatus

Read-Only Fields

Field	Type	Description
DeviceCount	uint	Read-only count of Devices. Default=0
Ip	System.Net.IPAddress	Read-only contact IPv4 Address for the Server.
Ipv6	string	Read-only contact IPv6 Address for the Server. Default=0
Port	uint	Read-only contact port for the Server.
Guid or ServerId	Guid	Read-only GUID of the Server. Can be used with Get Server.
Name or ServerName	string	Read-only Name of the Server. Can be used with Get Server.
Status	uint	Status of the server, 0 if down, 1 if up and 2 if unknown. Default=0

PvsServerStore

Read/Write Fields

Field	Type	Description
CachePath	string[]	Cache path(s) that the Server uses with the Store. If none are specified the caches will be placed in the Store cachePath. Default=None
Path	string	Directory path that the Server uses to access the Store. Default=”” Max Length=255

Read-Only Fields

Field	Type	Description
ServerId	Guid	GUID of the server that uses the Store. ServerName can be used instead.
ServerName	string	Name of the server that uses the Store. ServerId can be used instead.
StoreId	Guid	GUID of the Store. StoreName can be used instead.
StoreName	string	Name of the Store. StoreId can be used instead.

PvsSite

Read/Write Fields

Field	Type	Description
DefaultCollectionId	Guid	GUID of the Collection to place new Devices into automatically. Not used with defaultCollectionName. Default=00000000-0000-0000-0000-000000000000
DefaultCollectionName	string	Name of the Collection to place new Devices into automatically. Not used with DefaultCollectionId. Default=””
Description	string	User description. Default=”” Max Length=250
DiskUpdateServerId	Guid	GUID of the Disk Update Server for the Site. Not used with DiskUpdateServerName. Default=00000000-0000-0000-0000-000000000000
DiskUpdateServerName	string	Name of the Disk Update Server for the Site. Not used with DiskUpdateServerId. Default=””
EnableDiskUpdate	bool	True when Disk Updated is enabled for the Site, false otherwise. Default=false
InventoryFilePollingInterval	uint	The number of seconds between polls for Disk changes in the Stores. Min=1, Max=600, Default=60
MakPassword	string	User password used for MAK activation. Default=”” Max Length=64
MakUser	string	User name used for MAK activation. Default=”” Max Length=64
Name or SiteName	string	Name of the Site. Max Length=50

Read-Only Fields

Field	Type	Description
EncryptionEpoch	UInt64	Timestamp of the encryption Key used to encrypt fields Default=0
ResourceLocationId	string	The Citrix Cloud resource location ID if the farm SetupType is cloud mode. Default=”” Max Length=64
ResourceLocationName	string	The Citrix Cloud resource location name if the farm SetupType is cloud mode. Default=”” Max Length=128
Role	uint	Read-only Role of the user for this item. 100 is Farm Administrator, 200 is Site Administrator, and 999 is read-only. Default=999
Guid or SiteId	Guid	Read-only GUID that uniquely identifies this Site.

PvsSiteView

Read/Write Fields

Field	Type	Description
Description	string	User description. Default=”” Max Length=250
Name or SiteViewName	string	Name of the Site View. Max Length=50

Read-Only Fields

Field	Type	Description
ActiveDeviceCount	uint	Read-only count of active Devices in this Site View. Default=0
DeviceCount	uint	Read-only count of Devices in this Site View. Default=0
DeviceWithPVDCount	uint	Read-only count of Devices with Personal vDisk in this Site View. Default=0
MakActivateNeededCount	uint	Read-only count of active Devices that need MAK activation in this Site View. Default=0
Role	uint	Read-only Role of the user for this item. 100 is Farm Administrator, and 200 is Site Administrator. Default=999
SiteId	Guid	GUID of the Site this View is to be a member of. It is not used with SiteName.
SiteName	string	Name of the Site this View is to be a member of. It is not used with SiteId.
Guid or SiteViewId	Guid	Read-only GUID that uniquely identifies this Site View.

PvsStore

Read/Write Fields

Field	Type	Description
CachePath	string[]	Default Cache path(s) that the Servers use with this Store. If none are specified the caches will be placed in the WriteCache subdirectory of the Store path. Default=None
Description	string	User description. Default=”” Max Length=250
Path	string	Default directory path that the Servers use to access this Store. Max Length=255
SiteId	Guid	GUID of the Site where Administrators of that Site can change this Store. Not used for Farm Stores. SiteName can be used instead. Default=00000000-0000-0000-0000-000000000000
SiteName	string	Name of the Site where Administrators of that Site can change this Store. Not used for Farm Stores. SiteId can be used instead. Default=””
Name or StoreName	string	Name of the Store. Max Length=50

Read-Only Fields

Field	Type	Description
PathType	string	Read-only field indicating if the vdisks are on a server’s local hard disk or on a remote share.
Role	uint	Read-only Role of the user for this item. 100 is Farm Administrator, 200 is Site Administrator, and 999 is read-only. Default=999
Guid or StoreId	Guid	Read-only GUID that uniquely identifies this Store.

PvsStoreSharedOrServerPath

Read-Only Fields

Field	Type	Description
Path	string	Directory path that the Servers use to access this Store.
StoreId	Guid	GUID of the Store.
StoreName	string	Name of the Store.

PvsTask

Read-Only Fields

Field	Type	Description
Command	string	Command being processed. Default=”” Max Length=50
CommandType	string	Type of the command. Values are:       Add,       Delete,       Get,       Info,       Run,       RunWithReturn,       Set and SetList. Default=”” Max Length=13
ExpirationTime	DateTime	Time the task record may be removed from the database if the task does not complete. Has the date and time without milliseconds.
Handle	uint	Handle to a running function.
Ip	System.Net.IPAddress	IPv4 Address of the remote host.
Ipv6	string	IPv6 Address of the remote host. Default=0
MapiException	string	Exception result in XML format. Default=””
Port	uint	Port number of the remote service.
Results	string	Result in XML format. Default=””
ServerFqdn	string	Qualified name of the server. Default=”” Max Length=1024
SiteId	Guid	GUID of the Site that this Task is being processed in. Default=00000000-0000-0000-0000-000000000000
SiteName	string	Name of the Site that that this Task is being processed in.
StartTime	DateTime	Time the task was started. Has the date and time without milliseconds.
State	uint	State of the Task. Values are:       0 (Processing),       1 (Cancelled),       and 2 (Complete). Min=0,       Max=2
TaskId	uint	Unique ID of the task.

PvsUndefinedDisk

Read-Only Fields

Field	Type	Description
VHDX	bool	If VHDX is true, the format of the image is VHDX. Otherwise it is VHD. Default=false
Name	string	Name of the disk file without the extension.
Status	uint	Status of the disk file. Values are:       0 (Valid),       1 (Missing Properties File),       2 (Access Denied),       3 (Access Denied and Missing Properties File),       4 (Invalid Disk File),       5 (Manifest Missing or Invalid),       6 (Both VHD and VHDX)

PvsUpdateTask

Read/Write Fields

Field	Type	Description
Date	uint[]	Days of the month. Numbers from 1-31 are the only valid values. This is used with Monthly Date recurrence. Default=”” Max Length=83
DayMask	uint	Days selected values. 1 = Monday, 2 = Tuesday, 4 = Wednesday, 8 = Thursday, 16 = Friday, 32 = Saturday, 64 = Sunday, 128 = Day. Default=0. This is used with Weekly and Monthly Type recurrence. Min=1, Max=255, Default=4
Description	string	User description. Default=”” Max Length=250
Domain	string	Domain to add the Disk Update Device(s) to. If not included, the first Domain Controller found on the Server is used. Default=”” Max Length=255
Enabled	bool	True when it will be processed, false otherwise. Default=true
EsdType	string	Esd to use. Valid values are SCCM or WSUS. If no value, a custom script is run on the client. Default=”” Max Length=50
Hour	uint	The hour of the day to perform the task. Min=0, Max=23, Default=0
Minute	uint	The minute of the hour to perform the task. Min=0, Max=59, Default=0
MonthlyOffset	uint	When to happen monthly. 0 = None, 1 = First, 2 = Second, 3 = Third, 4 = Forth, 5 = Last. This is used with Monthly Type recurrence. Min=0, Max=5, Default=3
OrganizationUnit	string	Organizational Unit to add the Disk Update Device(s) to. This parameter is optional. If it is not specified, the device is added to the built in Computers container. Child OU’s should be delimited with forward slashes, e.g. “ParentOU/ChildOU”. Special characters in an OU name, such as ‘”’, ‘#’, ‘+’, ‘,’, ‘;’, ‘>’, ‘=’, must be escaped with a backslash. For example, an OU called “commaIn,TheMiddle” must be specified as “commaIn\,TheMiddle”. The old syntax of delimiting child OU’s with a comma is still supported, but deprecated. Note that in this case, the child OU comes first, e.g. “ChildOU,ParentOU”. Default=”” Max Length=255
PostUpdateApprove	uint	Access to place the version in after the update has occurred. 0 = Production, 1 = Test, 2 = Maintenance. Min=0, Max=2, Default=0
PostUpdateScript	string	Script file to run after the update finishes. Default=”” Max Length=255
PostVmScript	string	Script file to run after the VM is unloaded. Default=”” Max Length=255
PreUpdateScript	string	Script file to run before the update starts. Default=”” Max Length=255
PreVmScript	string	Script file to run before the VM is loaded. Default=”” Max Length=255
Recurrence	uint	The update will reoccur on this schedule. 0 = None, 1 = Daily, 2 = Every Weekday, 3 = Weekly, 4 = Monthly Date, 5 = Monthly Type. Min=0, Max=5, Default=0
Name or UpdateTaskName	string	Name of the Update Task. It is unique within the Site. Max Length=50

Read-Only Fields

Field	Type	Description
SiteId	Guid	GUID of the Site that this Update Task is a member of. It is not used with SiteName.
SiteName	string	Name of the Site that this Update Task is a member of. It is not used with SiteId.
Guid or UpdateTaskId	Guid	Read-only GUID that uniquely identifies this Update Task.

PvsVersion

Read-Only Fields

Field	Type	Description
DbEdition	string	Edition of the database. If ‘Express Edition’, monitor dbSize.
DbSize	uint	Size of the database in MB. Monitor this value if the edition is ‘Express Edition’ and this value is close to reaching the 4000 MB maximum. Default=0
DbVersion	uint	Version of the database schema as a number. Default=0
MapiVersion	string	Version of the system in major.minor.point.build format.
MapiVersionNumber	uint	Internal version number of the system. It is a number that is increaed by 100 for each major and minor release. Point releases are the numbers between each 100. Value is 0 when the system does not support MapiVersionNumber. Default=0
SdkVersion	string	Version of the SDK in major.minor.build format.
Type	uint	Type of system. Values are 0 (Normal), 1 (OROM), and 2 (Secure). Default=0

PvsVirtualHostingPool

Read/Write Fields

Field	Type	Description
CredentialsUid	string	UUID of any record associated with the credentials Default=”” Max Length=65535
Datacenter	string	Datacenter of the Virtual Hosting Pool. Default=”” Max Length=250
DdcType	uint	Type of the DDC. 0 = Unset, 1 = Citrix Cloud, 2 = customer-managed. Min=0, Max=2, Default=0
Description	string	User description. Default=”” Max Length=250
EncryptionEpoch	UInt64	Timestamp of the encryption Key used to encrypt fields Default=0
Password	string	Password to use when logging into the Server.
PlatformVersion	string	Hypervisor Host Version Default=”” Max Length=250
Port	uint	Port of the Host Server. Min=80, Max=65534, Default=80
PrepopulateEnabled	bool	Enable prepopulate when set to true Default=false
Server	string	Name or IP of the Host Server. Max Length=255
ShutdownTimeout	uint	Timeout for shutdown. Min=2, Max=30, Default=10
Type	uint	Type of the Virtual Hosting Pool. 0 = Citrix XenServer, 1 = Microsoft SCVMM/Hyper-V, 2 = VMWare vSphere/ESX, 3 = Nutanix, 4 = Azure, 5 = GCP. Min=0, Max=255, Default=0
UpdateLimit	uint	Number of updates at the same time. Min=2, Max=1000, Default=1000
UpdateTimeout	uint	Timeout for updates. Min=2, Max=240, Default=60
UserName	string	Name to use when logging into the Server.
Name or VirtualHostingPoolName	string	Name of the Virtual Hosting Pool. It is unique within the Site. Max Length=50
XdHcCustomProperties	string	Custom Properties for HCL Connection Details object Default=”” Max Length=65535
XdHcHypervisorConnectionName	string	Hypervisor Connection Name for HCL Connection Details object Default=”” Max Length=250
XdHcHypervisorConnectionUid	string	Hypervisor Connection Uid for HCL Connection Details object Default=”” Max Length=250
XdHcRevision	string	Revision for HCL Connection Details object Default=”” Max Length=250
XdHcSslThumbprints	string	Ssl Thumbprints for HCL Connection Details object Default=”” Max Length=65535
XdHostingUnitUuid	Guid	UUID of XenDesktop Hosting Unit Default=00000000-0000-0000-0000-000000000000
XsPvsSiteUuid	Guid	UUID of XenServer PVS_site Default=00000000-0000-0000-0000-000000000000

Read-Only Fields

Field	Type	Description
SiteId	Guid	GUID of the Site that this Virtual Hosting Pool is a member of. It is not used with SiteName.
SiteName	string	Name of the Site that this Virtual Hosting Pool is a member of. It is not used with SiteId.
Guid or VirtualHostingPoolId	Guid	Read-only GUID that uniquely identifies this Virtual Hosting Pool.

PvsXDSite

Read/Write Field

Field	Type	Description
ConfigServices	string[]	XenDesktop Server addresses. Max Length=2000

Read-Only Field

Field	Type	Description
Guid or XdSiteId	Guid	GUID of the XenDesktop Site.