Download full document:

Citrix Provisioning Services 7.12

PowerShell with Objects Programmer’s Guide

Introduction

Use Provisioning Services’ programming interfaces to manageyour implementation from a command line or from scripts. Only users withcorrect administrative privileges can use programming commands.Non-administrators, that do not have elevated privileges and attempt to use thesecommands, will receive the ‘Invalid access’ message.

Four different programming interfaces exist:

·Management Command Line Interface (MCLI)

·Simple Object Access Protocol (SOAP) Server Programmer Interface

·PowerShell Programmer Interface with Objects

·PowerShell Programmer Interface (Deprecated)

This document provides the information needed to use thisinterface.

Using the PowerShell Programmer Interface withObjects

Use the information that follows to manage a ProvisioningService’s implementation from the PowerShell Interface with Objects.

Installation of PowerShell Snap-In

The PowerShell snap-in (Citrix.PVS.SnapIn.dll) can beinstalled using the Provisioning Server Console install.

Registration of McliPSSnapIn.dll usingImport-Module

If the snap-in later needs to be registered in PowerShell,this can be manually done by running one of the following command inPowerShell. The path where the Citrix.PVS.SnapIn.dll is installed needs to beused.

Import-Module “path\Citrix.PVS.SnapIn.dll”

Registration of Citrix.PVS.SnapIn.dll usingAdd-PSSnapin

If the snap-in later needs to be registered in PowerShell,this can be manually done by running one of the following commands at the DOScommand prompt. After the command is run and PowerShell is started, the snap-inneeds to be added using the command “Add-PSSnapin -Name Citrix.PVS.SnapIn”.

64-bit Registration

%systemroot%\Microsoft.NET\Framework64\v4.0.30319\installutil.exeCitrix.PVS.SnapIn.dll

32-bit Registration

%systemroot%\Microsoft.NET\Framework\v4.0.30319\installutil.exeCitrix.PVS.SnapIn.dll

Alternative Registration of Citrix.PVS.SnapIn.dllin PowerShell

Another way to register is by running one of the followingcommands at the PowerShell command prompt:

64-bit Registration in PowerShell

$installutil= $env:systemroot + '\Microsoft.NET\Framework64\v4.0.30319\installutil.exe'

;$installutilCitrix.PVS.SnapIn.dll

Add-PSSnapin-Name Citrix.PVS.SnapIn

32-bit Registration in PowerShell

$installutil= $env:systemroot + '\Microsoft.NET\Framework32\v4.0.30319\installutil.exe'

;$installutilCitrix.PVS.SnapIn.dll

Add-PSSnapin-Name Citrix.PVS.SnapIn

Uninstall of PowerShell Snap-In

The PowerShell snap-in (Citrix.PVS.SnapIn.dll) can beuninstalled using the Provisioning Server Console install.

Unregister of Citrix.PVS.SnapIn.dll

The snap-in needs to be unregistered from PowerShell, thiscan be manually done by running one of the following commands at the DOScommand prompt:

64-bit Unregister

%systemroot%\Microsoft.NET\Framework64\v4.0.30319\installutil.exe-u Citrix.PVS.SnapIn.dll

32-bit Unregister

%systemroot%\Microsoft.NET\Framework\v4.0.30319\installutil.exe-u Citrix.PVS.SnapIn.dll

Alternative Unregister of Citrix.PVS.SnapIn.dll inPowerShell

Another way to unregister is by running one of the followingcommands at the PowerShell command prompt:

64-bit Unregister in PowerShell

$installutil= $env:systemroot + '\Microsoft.NET\Framework64\v4.0.30319\installutil.exe'

;$installutil-u Citrix.PVS.SnapIn.dll

32-bit Unregister in PowerShell

$installutil= $env:systemroot + '\Microsoft.NET\Framework32\v4.0.30319\installutil.exe'

;$installutil-u Citrix.PVS.SnapIn.dll

Setup of the SOAP Server Communication

Unless the defaults are fine, use this command to set thevalues for the SOAP Server connection:

Set-PvsConnection

Set the SoapServer connection, and if -Persist isspecified the connection settings are saved in the registry. A PvsConnectionobject can be used as the parameter.

Required

PvsConnection Connection: PvsConnection object withchanged property value(s) to be set. The object can come from a pileline.

These values are in the PvsConnection object, andonly will be set if the value has changed.

string Name or Server: Name or IP of the Server toconnect to. Default=localhost

string Port: The Port to use to connect.Default=54321

string User: User name to use for Authentication. Ifit has a value, it will be *****. Default=""

string Domain: Domain name to use forAuthentication. If it has a value, it will be *****. Default=""

string Password: Password to use for Authentication.If it has a value, it will be *****. Default=""

string Persist: True when the connection settingsshould be, for Set, or have been, for Get, saved to the registry.

PvsConnection can be created or modified usingmethods below:

New-Object Citrix.PVS.SnapIn.PvsConnection: Createsdefault Server=localhost, Port=54321, and no authentication.

New-ObjectCitrix.PVS.SnapIn.PvsConnection(Citrix.PVS.SnapIn copyFrom): Creates withsettings of the copyFrom Citrix.PVS.SnapIn.

SetServerToLocalHostDefaultSettings:Server=localhost, Port=54321, and no authentication.

Copy(Citrix.PVS.SnapIn copyFrom): Modifies thesettings to match the copyFrom Citrix.PVS.SnapIn.

Equals(Citrix.PVS.SnapIn compareTo): Returns truewhen the settings match what is in the compareTo.

When Connection is not passed, the parameters beloware used:

Optional field values to set:

string Name or Server: Name or IP of the Server toconnect to. Default=localhost

string Port: The Port to use to connect.Default=54321

string User: User name to use for Authentication. Ifit has a value, it will be *****. Default=""

string Domain: Domain name to use forAuthentication. If it has a value, it will be *****. Default=""

string Password: Password to use for Authentication.If it has a value, it will be *****. Default=""

string Persist: True when the connection settingsshould be, for Set, or have been, for Get, saved to the registry.

Optional

SwitchParameter PassThru: If -PassThru is specified,the resulting PvsConnection object is returned.

SwitchParameter Confirm: The impact of thisoperation is "low". If -Confirm is specified, the operation will beconfirmed. $ConfirmPreference can be set to "low" to haveconfirmation without the Confirm parameter.

EXAMPLE 1: Set PvsConnection for Individual Fields

Get the PvsConnection into a $o variable. Change the$o field values and then Set the PvsConnection with the result.

$o = Get-PvsConnection -Fields Port

$o.Port = 54322

Set-PvsConnection $o

The -Fields parameter with only the needed fieldsspecified makes the Get work faster because only those fields are retrieved.

EXAMPLE 2: Set PvsConnection for a Field Using Pipe

Get the PvsConnection into a $o variable for thefield that has the wrong value. Change the $o field to the correct value and thenSet the PvsConnection with the result.

Get-PvsConnection -Fields Port | Where-Object{$_.Port -ne 54322} | foreach { $o = $_; $o.Port = 54322; $o } |Set-PvsConnection

The -Fields parameter with only the needed fieldsspecified makes the Get work faster because only those fields are retrieved.

The "foreach { $o = $_; $o.X = Y; $o }"sets the field X to value Y and returns the object again so it can be piped tothe Set command for update.

EXAMPLE 3: Set PvsConnection Port with Parameter

Set the PvsConnection Port using the Port parameterinstead of a PvsConnection object.

Set-PvsConnection -Port 54322

This is the only Set command that has fieldparameters.

Command Specific Help

All of the documentation for specific commands is includedin the command-line help by calling Get-Help and the name of the command, forexample “Get-Help Get-PvsDevice”. The documentation for the specific commandincludes information about the object that is may get or set. The documentationof all of the objects is included in the “Objects, in the Citrix.PVS.SnapInNamespace” section.

Error Handling

For the Citrix.PVS.SnapIn, if an error occurs, aPvsException will be in the Exception member of the $error. The “Error codes”information is included in this document.

The members of a PvsException are:

InnerException:The exception that occured. This exception maybe an EAException or otherstandard Exception.

ToString():Has the formatted full Message of the InnerException.

If theInnerException GetType().Name equals "EAException", then The membersof it are:

returnCode: The number, as shown below in the Error codes. The name of theerror, for example "NotImplemented", is not included in theEAException.

Message: The message, as shown below in the Error codes. The [v1], [v2], [v3],[v4], and [v5] will be replaced with values as required.

Details: Has the Details for the EAException if there are any. OtherException,ManagementInterfaceError and PvsStatusException will have Details.

ToString(): Has the Message as shown below in the Error codes. If there isDetails, it will be returned or included, and if partialReturn, they will beincluded.

partialReturn: Might have a list of EAException objects if any of the itemsprocessed during the command had any issues.

Severity: Can have the values Critical, Error, Warning or Duplicate.

Source: Has the value that is displayed in the Console as a Title or Type forthe error.

Short cmdlet list

Add-PvsDeviceToDomain

Add-PvsDeviceToView

Add-PvsDiskLocatorToDevice

Add-PvsDiskToUpdateTask

Add-PvsDiskVersion

Clear-PvsConnection

Clear-PvsTask

Copy-PvsDeviceProperties

Copy-PvsDiskProperties

Copy-PvsServerProperties

Disable-PvsDeviceDiskLocator

Dismount-PvsDisk

Enable-PvsDeviceDiskLocator

Export-PvsAuditTrail

Export-PvsDisk

Export-PvsOemLicenses

Get-PvsADAccount

Get-PvsAuditActionParameter

Get-PvsAuditActionProperty

Get-PvsAuditActionSibling

Get-PvsAuditTrail

Get-PvsAuthGroup

Get-PvsAuthGroupUsage

Get-PvsCeipData

Get-PvsCisData

Get-PvsCollection

Get-PvsConnection

Get-PvsCreateDiskStatus

Get-PvsDevice

Get-PvsDeviceBootstrap

Get-PvsDeviceCount

Get-PvsDeviceDiskLocatorEnabled

Get-PvsDeviceDiskTempVersion

Get-PvsDeviceInfo

Get-PvsDevicePersonality

Get-PvsDeviceStatus

Get-PvsDirectory

Get-PvsDisk

Get-PvsDiskInfo

Get-PvsDiskInventory

Get-PvsDiskLocator

Get-PvsDiskLocatorCount

Get-PvsDiskLocatorLock

Get-PvsDiskUpdateDevice

Get-PvsDiskUpdateStatus

Get-PvsDiskVersion

Get-PvsExists

Get-PvsFarm

Get-PvsFarmView

Get-PvsGroup

Get-PvsLocalServer

Get-PvsMaintenanceVersionExists

Get-PvsMinimumLastAutoAddDeviceNumber

Get-PvsMountedDisk

Get-PvsMountedDriveLetter

Get-PvsNewDiskVersion

Get-PvsServer

Get-PvsServerBiosBootstrap

Get-PvsServerBootstrap

Get-PvsServerBootstrapName

Get-PvsServerCount

Get-PvsServerInfo

Get-PvsServerName

Get-PvsServerStatus

Get-PvsServerStore

Get-PvsServerStoreActiveDeviceCount

Get-PvsSite

Get-PvsSiteView

Get-PvsStore

Get-PvsStoreFreeSpace

Get-PvsStoreSharedOrServerPath

Get-PvsTask

Get-PvsTaskStatus

Get-PvsUndefinedDisk

Get-PvsUpdateTask

Get-PvsUploadCeip

Get-PvsVersion

Get-PvsVirtualHostingPool

Get-PvsXDSite

Grant-PvsAuthGroup

Import-PvsDevices

Import-PvsDisk

Import-PvsOemLicenses

Invoke-PvsActivateDeviceMAK

Invoke-PvsMarkDown

Invoke-PvsPromoteDiskVersion

Invoke-PvsRebalanceDevices

Invoke-PvsRevertDiskVersion

Merge-PvsDisk

Mount-PvsDisk

Move-PvsDeviceToCollection

Move-PvsServerToSite

New-PvsAuthGroup

New-PvsCeipData

New-PvsCisData

New-PvsCollection

New-PvsDevice

New-PvsDeviceWithPersonalvDisk

New-PvsDirectory

New-PvsDiskLocator

New-PvsDiskMaintenanceVersion

New-PvsDiskUpdateDevice

New-PvsFarmView

New-PvsServer

New-PvsSite

New-PvsSiteView

New-PvsStore

New-PvsUpdateTask

New-PvsVirtualHostingPool

Remove-PvsAuthGroup

Remove-PvsCollection

Remove-PvsDevice

Remove-PvsDeviceDiskCacheFile

Remove-PvsDeviceFromDomain

Remove-PvsDeviceFromView

Remove-PvsDirectory

Remove-PvsDiskFromUpdateTask

Remove-PvsDiskLocator

Remove-PvsDiskLocatorFromDevice

Remove-PvsDiskUpdateDevice

Remove-PvsDiskVersion

Remove-PvsFarmView

Remove-PvsServer

Remove-PvsServerStore

Remove-PvsSite

Remove-PvsSiteView

Remove-PvsStore

Remove-PvsUpdateTask

Remove-PvsVirtualHostingPool

Reset-PvsDatabase

Reset-PvsDeviceForDomain

Restart-PvsStreamService

Revoke-PvsAuthGroup

Set-PvsAuthGroup

Set-PvsCeipData

Set-PvsCisData

Set-PvsCollection

Set-PvsConnection

Set-PvsDevice

Set-PvsDeviceBootstrap

Set-PvsDevicePersonality

Set-PvsDisk

Set-PvsDiskLocator

Set-PvsDiskUpdateDevice

Set-PvsDiskVersion

Set-PvsFarm

Set-PvsFarmView

Set-PvsOverrideVersion

Set-PvsServer

Set-PvsServerBiosBootstrap

Set-PvsServerBootstrap

Set-PvsServerStore

Set-PvsSite

Set-PvsSiteView

Set-PvsStore

Set-PvsUpdateTask

Set-PvsVirtualHostingPool

Set-PvsXDSite

Start-PvsAutoUpdate

Start-PvsCreateDisk

Start-PvsDeviceBoot

Start-PvsDeviceDiskTempVersionMode

Start-PvsDeviceReboot

Start-PvsDeviceShutdown

Start-PvsDeviceUpdateBdm

Start-PvsDisplayMessage

Start-PvsReportBug

Start-PvsStreamService

Start-PvsUpdateTask

Stop-PvsCreateDisk

Stop-PvsDeviceDiskTempVersionMode

Stop-PvsStreamService

Stop-PvsTask

Stop-PvsUpdateTask

Test-PvsDirectory

Unlock-PvsAllDisk

Unlock-PvsDisk

Update-PvsInventory

Cmdlet by Object Type

Many

Clear-PvsConnection

Get-PvsAuditActionParameter

Get-PvsAuditActionProperty

Get-PvsAuditActionSibling

Get-PvsAuditTrail

Get-PvsConnection

Get-PvsExists

Reset-PvsDatabase

Set-PvsConnection

AuthGroup

Get-PvsAuthGroup

Get-PvsAuthGroupUsage

Grant-PvsAuthGroup

New-PvsAuthGroup

Remove-PvsAuthGroup

Revoke-PvsAuthGroup

Set-PvsAuthGroup

CeipData

Get-PvsCeipData

Get-PvsUploadCeip

New-PvsCeipData

Set-PvsCeipData

CisData

Get-PvsCisData

New-PvsCisData

Set-PvsCisData

Collection

Get-PvsCollection

Get-PvsMinimumLastAutoAddDeviceNumber

New-PvsCollection

Remove-PvsCollection

Set-PvsCollection

Device

Add-PvsDeviceToDomain

Add-PvsDeviceToView

Copy-PvsDeviceProperties

Disable-PvsDeviceDiskLocator

Enable-PvsDeviceDiskLocator

Export-PvsOemLicenses

Get-PvsDevice

Get-PvsDeviceBootstrap

Get-PvsDeviceCount

Get-PvsDeviceDiskLocatorEnabled

Get-PvsDeviceDiskTempVersion

Get-PvsDeviceInfo

Get-PvsDevicePersonality

Get-PvsDeviceStatus

Import-PvsDevices

Import-PvsOemLicenses

Invoke-PvsActivateDeviceMAK

Invoke-PvsMarkDown

Move-PvsDeviceToCollection

New-PvsDevice

New-PvsDeviceWithPersonalvDisk

Remove-PvsDevice

Remove-PvsDeviceDiskCacheFile

Remove-PvsDeviceFromDomain

Remove-PvsDeviceFromView

Reset-PvsDeviceForDomain

Set-PvsDevice

Set-PvsDeviceBootstrap

Set-PvsDevicePersonality

Start-PvsDeviceBoot

Start-PvsDeviceDiskTempVersionMode

Start-PvsDeviceReboot

Start-PvsDeviceShutdown

Start-PvsDeviceUpdateBdm

Start-PvsDisplayMessage

Stop-PvsDeviceDiskTempVersionMode

Disk

Add-PvsDiskToUpdateTask

Add-PvsDiskVersion

Copy-PvsDiskProperties

Dismount-PvsDisk

Export-PvsDisk

Get-PvsCreateDiskStatus

Get-PvsDisk

Get-PvsDiskInfo

Get-PvsDiskInventory

Get-PvsDiskUpdateDevice

Get-PvsDiskUpdateStatus

Get-PvsDiskVersion

Get-PvsMaintenanceVersionExists

Get-PvsMountedDisk

Get-PvsMountedDriveLetter

Get-PvsNewDiskVersion

Get-PvsUndefinedDisk

Get-PvsVirtualHostingPool

Import-PvsDisk

Invoke-PvsPromoteDiskVersion

Invoke-PvsRevertDiskVersion

Merge-PvsDisk

Mount-PvsDisk

New-PvsDiskMaintenanceVersion

New-PvsDiskUpdateDevice

New-PvsVirtualHostingPool

Remove-PvsDiskFromUpdateTask

Remove-PvsDiskUpdateDevice

Remove-PvsDiskVersion

Remove-PvsVirtualHostingPool

Set-PvsDisk

Set-PvsDiskUpdateDevice

Set-PvsDiskVersion

Set-PvsOverrideVersion

Set-PvsVirtualHostingPool

Start-PvsCreateDisk

Stop-PvsCreateDisk

Unlock-PvsAllDisk

Unlock-PvsDisk

Update-PvsInventory

DiskLocator

Add-PvsDiskLocatorToDevice

Get-PvsDiskLocator

Get-PvsDiskLocatorCount

Get-PvsDiskLocatorLock

New-PvsDiskLocator

Remove-PvsDiskLocator

Remove-PvsDiskLocatorFromDevice

Set-PvsDiskLocator

Farm

Export-PvsAuditTrail

Get-PvsFarm

Get-PvsXDSite

Set-PvsFarm

Set-PvsXDSite

FarmView

Get-PvsFarmView

New-PvsFarmView

Remove-PvsFarmView

Set-PvsFarmView

Server

Copy-PvsServerProperties

Get-PvsDirectory

Get-PvsServer

Get-PvsServerBiosBootstrap

Get-PvsServerBootstrap

Get-PvsServerBootstrapName

Get-PvsServerCount

Get-PvsServerInfo

Get-PvsServerName

Get-PvsServerStatus

Get-PvsServerStore

Get-PvsServerStoreActiveDeviceCount

Invoke-PvsRebalanceDevices

Move-PvsServerToSite

New-PvsDirectory

New-PvsServer

Remove-PvsDirectory

Remove-PvsServer

Remove-PvsServerStore

Restart-PvsStreamService

Set-PvsServer

Set-PvsServerBiosBootstrap

Set-PvsServerBootstrap

Set-PvsServerStore

Start-PvsAutoUpdate

Start-PvsReportBug

Start-PvsStreamService

Stop-PvsStreamService

Test-PvsDirectory

Site

Get-PvsSite

Get-PvsStoreSharedOrServerPath

New-PvsSite

Remove-PvsSite

Set-PvsSite

SiteView

Get-PvsSiteView

New-PvsSiteView

Remove-PvsSiteView

Set-PvsSiteView

Store

Get-PvsStore

Get-PvsStoreFreeSpace

New-PvsStore

Remove-PvsStore

Set-PvsStore

System

Get-PvsADAccount

Get-PvsGroup

Get-PvsLocalServer

Get-PvsVersion

Task

Clear-PvsTask

Get-PvsTask

Get-PvsTaskStatus

Stop-PvsTask

UpdateTask

Get-PvsUpdateTask

New-PvsUpdateTask

Remove-PvsUpdateTask

Set-PvsUpdateTask

Start-PvsUpdateTask

Stop-PvsUpdateTask

Error codes

For the Citrix.PVS.SnapIn, if an error occurs, aPvsException will be in the Exception member of the $error.

The members of a PvsException are:

InnerException: The exception that occured. Thisexception maybe an EAException or other standard Exception.

ToString(): Has the formatted full Message of theInnerException.

If the InnerException GetType().Name equals"EAException", then The members of it are:

returnCode: The number, as shown below in the Errorcodes. The name of the error, for example "NotImplemented", is notincluded in the EAException.

Message: The message, as shown below in the Errorcodes. The [v1], [v2], [v3], [v4], and [v5] will be replaced with values asrequired.

Details: Has the Details for the EAException ifthere are any. OtherException, ManagementInterfaceError and PvsStatusExceptionwill have Details.

ToString(): Has the Message as shown below in theError codes. If there is Details, it will be returned or included, and ifpartialReturn, they will be included.

partialReturn: Might have a list of EAExceptionobjects if any of the items processed during the command had any issues.

Severity: Can have the values Critical, Error, Warningor Duplicate.

Source: Has the value that is displayed in theConsole as a Title or Type for the error.

0 Success: The command succeeded.

1 NotImplemented: The [v1] feature has not beenimplemented.

2 InvalidCommand: The [v1] command does not exist.

3 InvalidField: The [v1] field does not exist.

4 InvalidFieldFormat: The [v1] field is notformatted properly, the correct format is [v2].

5 InvalidParameter: The [v1] parameter is not valid.

6 InvalidParameterFormat: The [v1] parameter is notformatted property, the correct format is [v2].

7 ReadOnlyField: Unable to change the [v1] fieldbecause it is read-only.

8 RequiredFieldMissing: The required [v1] field ismissing.

9 RequiredFieldsMissing: The required [v1] or [v2]field is missing.

10 RequiredParameterMissing: The required [v1]parameter is missing.

11 RequiredParametersMissing: The required [v1] or[v2] parameter is missing.

12 InternalIdAndNameFieldsMustBeDefined: An internalerror occurred. The [v1] field is not the next FieldSettings object after theID.

13 NoFarmAccess: The domain/user does not haveaccess to the Farm.

14 InvalidForeignKeyValue: The [v1] field with value[v2] is an invalid foreign key.

15 SetupError: The system was not configuredcorrectly.

16 Executing: The [v1] command can only be calledone at a time. Wait for the command to finish before running again.

17 NoDiskMapped: A vDisk has not yet been mapped.

18 DatabaseError: A database error occurred.

19 DuplicateKey: To avoid creating a duplicate key,the Add or Set command was cancelled.

20 DatabaseErrorMissed: An internal error occurred.An uncaught database error occurred.

21 AddCommandFailed: No objects were added duringthe last 'Add' command.

22 InsufficientPrivileges: Access denied. Theappropriate privileges are not assigned to perform this task.

23 ZeroObjectsAffected: No object was added,updated, or deleted in the last operation.

24 OtherException: An unexpected MAPI erroroccurred.

25 InvalidFieldLength: The [v1] field value is toolong, maximum length is [v2].

26 InvalidFieldValueMinMax: The [v1] field value isinvalid, the minimum is [v2] and the maximum is [v3].

27 InvalidFieldValue: The [v1] field can only havevalues [v2] or [v3].

28 TooManyParameters: More parameters were specifiedthan permitted.

29 TooFewParameters: Not enough identifyingparameters specified.

30 FollowingParametersMissing: To use the [v1]parameter, [v2] or [v3] must also be used.

31 InconsistentData: The action is canceled becausethe Store directory date/times does not match. Update the Store directories tomatch.

32 DatabaseOpenFailed: Unable to contact thedatabase server. Ensure Provisioning Services is configured correctly.

33 DatabaseVersionWrong: The wrong database versionis being used. Found version number: [v1] Expected version number:[v2]

34 DatabaseVersionNotFound: The database versionnumber does not exist or was not found. Ensure Provisioning Services isconfigured correctly.

35 SomeRequiredParametersMissing: Requiredparameters are missing.

36 PartialError: The following items failed:

item1 Error message...

item2 Error message...

37 NoItemsToProcess: There are no items to process.

38 NoDefaultCollectionDefined: Unable to add aDevice until a default Collection is set.

39 NoDefaultSiteDefined: A default Site is not set,no Devices can be added.

40 InvalidCollection: The specified Collection doesnot exist.

41 InvalidAuthGroup: The specified AuthGroup doesnot exist.

42 InvalidGroup: The specified Group does not exist.

43 InvalidDevice: The specified Device does notexist.

44 InvalidDiskLocator: The specified vDisk does notexist.

45 InvalidServer: The specified Server does notexist.

46 InvalidServerSite: Server specified is not in theSite specified.

47 InvalidStoreSite: Store specified is not for theSite specified.

48 InvalidSiteView: The specified Site View does notexist.

49 InvalidSite: The specified Site does not exist.

50 InvalidDeviceDiskLocator: The specified Device orvDisk does not exist.

51 InvalidDeviceImport: Import failed because thefile must have Device Name, Mac Address, Site Name, and Collection Name, andthey must be tab or comma-delimited.

52 InvalidServerFrom: The Server to copy [v1]=[v2]was not found.

53 InvalidServerTo: No Server to copy to ([v1]=[v2])was found.

54 InvalidDeviceFrom: The Device to copy [v1]=[v2]was not found.

55 InvalidDeviceTo: No Devices to copy to are found.

56 InvalidDiskFrom: The vDisk to copy [v1]=[v2] wasnot found.

57 InvalidDiskTo: No vDisk to copy to ([v1]=[v2])was found.

58 InvalidDiskPath: The path '[v1]' to the vDiskfile is not found.

59 VDiskFileNotFound: [v1]: vDisk file was notfound.

60 InvalidDiskServer: There is no Server that canserve the vDisk [v1] or the Store to which this vDisk belongs. Verify that oneor more Servers belonging to the Store are online and that there is sufficientfree space for the operation you are attempting.

61 InvalidDiskForServer: Server [v1] cannot accessall versions of vDisk [v2], the vDisk was updated on at least one other Server.

62 SameSiteRequired: Objects within the same Sitemust be selected.

63 TooFewFields: Not enough fields for a record.

64 ADerrorDC: Unable to connect to the DomainController (if any) or the default rootDSE. Error code: [v1], message: [v2],provider: [v3].

65 ADerrorOU: Unable to get the Organizational Unitsetting (if any). Error code: [v1], message: [v2], provider: [v3].

66 ADerrorDefaultContainer: Unable to get thedefault computer accounts container (default location is Active Directoryroot> Computers). Error code: [v1], message: [v2], provider: [v3].

67 ADerrorCreate: Unable to create the computeraccount in Active Directory. Ensure the account does not already exist and thatthe appropriate permissions are available to perform this task. Error code:[v1], message: [v2], provider: [v3].

68 ADerrorNewAccount: Unable to get the newlycreated Active Directory computer account. Error code: [v1], message: [v2],provider: [v3].

69 ADerrorSam: Unable to set the Active DirectorysamAccountName property. Ensure the appropriate permissions exist to performthis task. Error code: [v1], message: [v2], provider: [v3].

70 ADerrorUserAccount: Unable to set the ActiveDirectory userAccountControl property. Ensure the appropriate permissions existto perform this task. Error code: [v1], message: [v2], provider: [v3].

71 ADerrorSave: Unable to save Active Directorychange. Ensure the appropriate permissions exist to perform this task. Errorcode: [v1], message: [v2], provider: [v3].

72 ADerrorSetPassword: Unable to set a new passwordfor this user account. Ensure the appropriate permissions exist to perform thistask. Error code: [v1], message: [v2], provider: [v3].

73 ADerrorAddTrustee: Unable to add trustee (ifany). Error code: [v1], message: [v2], provider: [v3].

74 ADerrorEnableAccount: Unable to enable the ActiveDirectory account. Error code: [v1], message: [v3], provider: [v2].

75 ADerrorAlreadyExists: The computer name isalready in use. Error code: [v1], message: [v3], provider: [v2]. Select aunique name for this machine.

76 ADerrorGeneral: A general Active Directory erroroccurred. Error code: [v1], message: [v2], provider: [v3].

77 ADerrorDirectorySearch: Unable to find ActiveDirectory items meeting the search criteria entered. Error code: [v1], message:[v2], provider: [v3].

78 ADerrorSearchComputerAccount: Unable to performthe computer accounts search. Error code: [v1], message: [v2], provider: [v3].

79 ADerrorComputerAccountNotFound: Specifiedcomputer account not found. Error code: [v1], message: [v2], provider: [v3].

80 ADerrorComputerAccountHold: This computer accountis currently unavailable. Ensure that Active Directory is running properly.Error code: [v1], message: [v2], provider: [v3].

81 ADerrorComputerAccountMove: Failed to move thecomputer account to the target organizational unit set (also returned if callerlacks permission). Error code: [v1], message: [v2], provider: [v3].

82 ADerrorDelete: Unable to delete this computeraccount. Ensure the appropriate permissions exist to perform this task. Errorcode: [v1], message: [v2], provider: [v3].

83 ADerrorPasswordGeneration: Unable to generatethis password. Ensure the appropriate permissions exist to perform this task.

84 MapDiskNoDriver: Unable to map vDisk because adriver was not found.

85 MapDiskDeniedByServer: Unable to map the vDisk.Mapping was denied by the Server.

86 MapDiskLocalAccessDenied: Unable to map thevDisk. Denied local access.

87 MapDiskMiniportError: Unable to map vDisk becauseof a Miniport error.

88 UnmapDiskFailed: Failed to unmap a vDisk.

89 DuplicateDisk: The vDisk [v1] already exists on[v2] at [v3].

90 DuplicateDiskLocator: A DiskLocator: [v1] alreadyexists on Site: [v2].

91 DiskCreationInProgress: The vDisk [v1] is beingcreated on [v2] at [v3].

92 InvalidServerStore: A database integrity erroroccurred. The Server is not set to deliver vDisks from the Store, but shouldbe.

93 InvalidStore: The specified Store does not exist.

94 InvalidFarmView: Farm View specified does notexist.

95 InvalidStorePath: Store path is empty.

96 ManagementInterfaceError:

Management Interface: Undefined error.

Management Interface: Database interface isinaccessible.

Management Interface: Database interface library isinaccessible.

Management Interface: The database access library isa version incompatible with the Management Server.

Management Interface: Database interface library isinvalid.

Management Interface: Database interface could notbe created.

Management Interface: Database could not be opened.

Management Interface: Database is in use.

Management Interface: Database error occurred.

Management Interface: Not implemented.

Management Interface: Registry entry was not found.

Management Interface: Request was not created.

Management Interface: Operating System erroroccurred.

Management Interface: vDisk error.

Management Interface: vDisk header is incomplete.

Management Interface: vDisk footer is incomplete.

Management Interface: vDisk boot record isincomplete.

Management Interface: vDisk boot sector isincomplete.

Management Interface: vDisk size is below theminimum.

Management Interface: vDisk size is above themaximum.

Management Interface: vDisk boot record template isinaccessible.

Management Interface: vDisk boot sector template isinaccessible.

Management Interface: vDisk lock was not found.

Management Interface: vDisk has exclusive lock.

Management Interface: vDisk has shared lock.

Management Interface: vDisk lock error.

Management Interface: vDisk format is incompatible.

Management Interface: vDisk prefooter is incomplete.

Management Interface: vDisk creation is in progress.

Management Interface: vDisk creation information wasnot found.

Management Interface: vDisk creation cancellationwas requested.

Management Interface: vDisk file was not found.

Management Interface: vDisk file path was not found.

Management Interface: vDisk file access was denied.

Management Interface: Cancelled.

Management Interface: Registry key for the productis inaccessible.

Management Interface: Registry key for theinstallation folder is inaccessible.

Management Interface: Registry key for the managementinterface is inaccessible.

Management Interface: Registry key for the databasepath is inaccessible.

Management Interface: Registry key for themanagement interface IP address is inaccessible.

Management Interface: Buffer size is too small.

Management Interface: Buffer size is too large.

Management Interface: Unknown error.

Management Interface: Remote Server failed to relaya request.

Management Interface: Remote Server is not servicingthe Device.

Management Interface: Remote Server or Devicerefused the request.

Management Interface: Local Server failed tocomplete a request to a Server or Device.

Management Interface: Local Server failed tocomplete a request to a Server.

Management Interface: Remote requests were disabledbecause of an initialization error.

Management Interface: Remote request failed.

Management Interface: Remote request timed out.

Management Interface: Remote request result was notfound.

Management Interface: Remote request receiver failedto initialize.

Management Interface: Management command failed forall objects.

Management Interface: Failed to get the presharedkey in secure version.

Management Interface: VHD Error.

Management Interface: vDisk properties were lost.

Management Interface: Insufficient Memory.

Management Interface: The network path was notfound.

Management Interface: The network name cannot befound.

Management Interface: File already exists.

Management Interface: The geometry of the vDisk isnot accessible.

Management Interface: Unable to create the vDiskbecause the store media is read-only.

Management Interface: vDisk file is being used byanother process.

97 ServerTimeout: Server did not respond to arequest in time.

98 NotFound: [v1] not found.

99 AccountRetrieve: Account information for user[v1] was not found.

100 ActiveDevice: The task cannot be performed onactive Devices. Shut down the Devices before attempting to perform the task.

101 ActiveDiskLocator: The task cannot be performedon active vDisks. Shut down the Devices that are using the vDisks beforeattempting to perform the task.

102 AssignedDiskLocator: Unable to delete a vDiskthat is currently assigned to a Device. Unassign all Devices, then delete thevDisk.

103 ActiveServer: The task cannot be performed onactive Servers. Shut down the Servers before attempting to perform the task.

104 NotEnoughFreeDiskSpace: There is not enough freedisk space to create the vDisk.

105 InvalidDiskName: The vDisk name has one or moreinvalid characters. The invalid characters are < > | " \ / : * ?.

106 CannotDeleteLastAuthGroup: Deleting the lastAuthorization Group causes the system to be inoperable.

107 CannotDeleteUsedAuthGroup: An AuthorizationGroup that is currently in use cannot be deleted.

108 ServerStartFailed: The Server did not startsuccessfully. Ensure the appropriate permissions exist for the service account.

109 ServerStopFailed: The Server did not stopsuccessfully.

110 LockOwnerNotFound: The Device that owns the lockwas not found, the vDisk was not unlocked.

111 PossiblySharedVDisk: Unable to delete File [v1].It is possible that the file is being referenced in other Sites or Stores.

112 StorePathInaccessible: The Store path [v1] isinaccessible.

113 InvalidAction: The [v1] action does not exist.

114 InvalidObjectType: The [v1] objectType does notexist.

115 TooManyRecords: The amount of data returnedusing Get is too large. Use GetFirst and GetNext instead of Get.

116 InvalidUserGroup: The specified UserGroup doesnot exist.

117 InvalidAuditAction: The specified AuditActiondoes not exist.

118 LoginFailed: The database login failed. Ensurethe appropriate permissions exist to access the database.

119 DatabaseConnectionError: Unable to connect tothe database. Restore the connection in order to manage the farm.

120 CreateTriggersParsing: Unable to parse thedatabase script 'CreateTriggers' at: [v1]

121 CreateStoredProcParsing: Unable to parse thedatabase script 'CreateStoredProcedures' at: [v1]

122 MediaIsReadOnly: Management Interface: Unable tocreate the vDisk because the store media is read-only.

123 ConnectedDeviceForVirtualHostingPool: Unable todelete this VM from a machine catalog because it is connected to a DeliveryGroup.

124 ADerrorDN: Unable to get the distinguishedNameproperty. Ensure the appropriate Active Directory permissions exist to performthis task. Error code: [v1], message: [v2], provider: [v3].

125 ADerrorGetSecDes: Unable to get the ActiveDirectory Security Descriptor property. Error code: [v1], message: [v2],provider: [v3].

126 ADerrorSetSecDes: Unable to set the ActiveDirectory Security Descriptor property. Ensure the appropriate permissionsexist to perform this task. Error code: [v1], message: [v2], provider: [v3].

127 ADerrorDNSHostName: Unable to set the DNS HostName property (dNSHostName). Ensure the appropriate permissions exist toperform this task. Error code: [v1], message: [v2], provider: [v3].

128 ADerrorDisplayName: Unable to set thedisplayName property. Error code: [v1], message: [v2], provider: [v3].

129 ADerrorBind: This device was unable to bind tothe Domain Controller. Ensure the Domain Controller is running. Error code:[v1], message: [v2], provider: [v3].

130 ADerrorGetSPN: Unable to get an Active DirectoryService Principal Name. Error code: [v1], message: [v2], provider: [v3].

131 ADerrorWriteSPN: Unable to write the ActiveDirectory Service Principal Name. Error code: [v1], message: [v2], provider:[v3]

132 ADerrorSearch: Unable to perform the requestedSearch. Error code: [v1], message: [v2], provider: [v3].

133 ADerrorMoveToOU: Unable to move the ActiveDirectory account to the requested Organizational Unit. Ensure the appropriatepermissions exist to perform this task. Error code: [v1], message: [v2],provider: [v3].

134 ADerrorDeleteAccount: Unable to delete thiscomputer account. Ensure the appropriate permissions exist to deleteaccounts. Error code: [v1], message: [v2], provider: [v3].

135 ADerrorBadParameters: Incorrect parameters sentto Provisioning Services from Studio. Error code: [v1], message:[v2], provider: [v3].

136 VolumeInUse: The volume is being used.

137 VolumeAccessDenied: Volume access is denied.

138 VolumeUnknownVolume: An unknown volume wasspecified.

139 VolumeGeneralError: An error occured whenexecuting a volume command.

140 MaintenanceServerError: Action cannot beperformed, [v1] is a maintenance server for [v2].

141 NotManagedStore: The action cannot be performedbecause the store is not managed.

142 PathNotExist: The path does not exist on thegiven Server.

143 PathNoCreatePermission: The path does not havethe appropriate create permissions.

144 PathNoReadPermission: The path does not have theappropriate read permissions.

145 PathNoWritePermission: The path does not havethe appropriate write permissions.

146 PathNoDeletePermission: The path does not havethe appropriate delete permissions.

147 IPCProtocolError: An internal error occurred. Afield is missing from the process communication protocol data.

148 InvalidStoreServer: No active Server can servethe Store [v1].

149 ConstraintCheck: A database constraint caused anAdd or Update to be stopped.

150 VamtNotFound: The Volume Activation ManagementTool cannot be found.

151 ADerrorCannotGetObjectSID: Cannot returnobjectSID. Error code: [v1], message: [v2], provider: [v3].

152 ADerrorCannotDisableAccount: Cannot disable theActive Directory account at this time. Ensure that all account users are loggedoff before attempting to disable the account. Error code: [v1], message: [v2],provider: [v3].

153 ADerrorFailedToChangePassword: Unable to resetthe machine account password. Ensure the appropriate permissions exist toperform this Active Directory task. Error code: [v1], message: [v2], provider:[v3].

154 ADerrorFailedToCopyDCName: Unable to copy theDomain Controller name. Error code: [v1], message: [v2], provider: [v3].

155 ADerrorDCNameIsTooLong: The Domain Controllername entered exceeds the maximum character length of [v4]. Error code: [v1],message: [v2], provider: [v3].

156 SiteMakUserPassword: The Site's makUser andmakPassword fields must have values.

157 VamtError: See the log for additional errordetails.

158 InactiveDevice: Device specified is not active.

159 DiskIsInPrivateMode: This task cannot beperformed because the vDisk is in private image mode.

160 AlreadyInChangeMode: Unable to complete this operation,vDisk is already in Maintenance, Merge, or Test mode.

161 CannotCreateMaintenanceDisk: Cannot createmaintenance vDisk.

162 CannotEnterMaintenanceMode: To place a vDisk inMaintenance Mode requires using a Server. No Server is available at this time.

163 NotInMaintenanceMode: Unable to perform thisaction because the vDisk is not in Maintenance Mode.

164 NoVersionForMaintenanceMode: Unable to placethis vDisk in Maintenance Mode because the highest version is not found.

165 NoVersionFound: Unable to perform this actionbecause a version record was not found in the database.

166 Obsolete: The [v1] feature is obsolete.

167 DatabaseWarning: A database warning occurred.

168 DatabaseSQL: A database SQL error occurred.

169 DatabaseResource: A database resource erroroccurred.

170 InvalidUpdateTask: The specified UpdateTask doesnot exist.

171 InvalidVirtualHostingPool: The specifiedVirtualHostingPool does not exist.

172 RemoteCommand: An exception occurred executing acommand on a remote Server.

173 IpcNotConfigured: An internal error occurred.The process communication interface must be configured before executing remotecommands.

174 DiskAlreadSetForUpdate: The vDisk is already setfor Update with Device [v1] in Site [v2].

175 InvalidDiskVersion: The vDisk Version specifiedis not valid.

176 HostResolution: Could not resolve the host namefor [v1].

177 InProcess: The remote task is taking longer thanexpected. TaskId: [v1]

178 DateMustBeInFuture: The [v1] must be in thefuture.

179 InvalidRemoteReturn: The remote command did notreturn valid data.

180 InvalidParameterValueMinMax: The [v1] parametervalue is invalid, the minimum is [v2] and the maximum is [v3].

181 InvalidParameterNotNumeric: The [v1] parametervalue is invalid, it is not numeric.

182 InvalidParameterNotGuid: The [v1] parametervalue is invalid, it is not a GUID.

183 PassThroughMessage: [v1]

184 DiskUpdateNotEnabled: The Automatic vDisk Updateoption must be enabled and the vDisk Update Server must be defined. Set thesein the Site properties.

185 PvsStatusException:

Windows API error occurred, number 0xE000FFFF.

SQL error occurred, number 0xE001FFFF.

Manager error occurred. Error number 0xE002FFFF.

StreamProcess error occurred. Error number0xE003FFFF.

Stream Database error occurred. Error number0xE004FFFF.

Management error occurred. Error number 0xE005FFFF.

Shutdown in progress; request ignored. Error number0xE0050001.

CreateDiffDisk: Malformed packet; missing one ormore arguments. Error number 0xE0050002.

DeleteDiffDisk: Malformed file name; cannot parsedirectory and name. Error number 0xE0050003.

DeleteDiffDisk: Malformed packet; missing one ormore arguments. Error number 0xE0050004.

IPC: Failed to read mtGetLocks parameters. Errornumber 0xE0050005.

IPC: Failed to read mtGetLockStatus parameters.Error number 0xE0050006.

IPC: Failed to read mtLock parameters. Error number0xE0050007.

IPC: Failed to read mtUnlock parameters. Errornumber 0xE0050008.

MergeDisk event: Malformed packet; unknown messagetype. Error number 0xE0050009.

MergeDisk event: Unknown target request ID. Errornumber 0xE005000A.

MergeDisk event: Malformed packet; missing one ormore arguments. Error number 0xE005000B.

MergeDisk: Malformed packet; missing one or morearguments. Error number 0xE005000C.

ValidateDisk: Malformed packet; missing one or morearguments. Error number 0xE005000D.

VHD Library error occurred. Error number 0xE006FFFF.

VHD Library: Not implemented. Error number0xE0060001.

VHD Library: Handle pointer is invalid. Error number0xE0060002.

VHD Library: Length of the path exceeds the limit ofthe file system. Error number 0xE0060003.

VHD Library: Name is empty. Error number 0xE0060004.

VHD Library: Length of the name exceeds the limit ofthe file system. Error number 0xE0060005.

VHD Library: Size of a parameter was too big. Errornumber 0xE0060006.

VHD Library: Size of a parameter was too small.Error number 0xE0060007.

VHD Library: The media is write protected. Errornumber 0xE0060008.

VHD Library: Type is invalid. Error number0xE0060009.

VHD Library: Footer is incomplete. Error number0xE006000A.

VHD Library: Failed to read or write the entire VHDHeader. Error number 0xE006000B.

VHD Library: Failed to read or write the entire VHDBlock Allocation Table. Error number 0xE006000C.

VHD Library: Failed to read or write all of the VHDproperties. Error number 0xE006000D.

VHD Library: VHD footer is corrupt. Error number0xE006000E.

VHD Library: VHD header is corrupt. Error number0xE006000F.

VHD Library: Failed to read or write the VHDobjects. Error number 0xE0060010.

VHD Library: Destination string is too small. Errornumber 0xE0060011.

VHD Library: Destination string pointer is NULL.Error number 0xE0060012.

VHD Library: Source string pointer is NULL. Errornumber 0xE0060013.

VHD Library: Offset is before the beginning of theVHD data area. Error number 0xE0060014.

VHD Library: Offset is after the end of the VHD dataarea. Error number 0xE0060015.

VHD Library: Failed to allocate memory because itwas unavailable. Error number 0xE0060016.

VHD Library: Caller cancelled the last createrequest. Error number 0xE0060017.

VHD Library: Failed to read or write all of the dataas requested. Error number 0xE0060018.

VHD Library: Failed to create a Universal UniqueIdentification for a VHD. Error number 0xE0060019.

VHD Library: Failed to find the VHD properties.Error number 0xE006001A.

VHD Library: Failed to read or write the entiresector bitmap within a block. Error number 0xE006001B.

VHD Library: Failed to read or write the entireblock. Error number 0xE006001C.

VHD Library: Failed to open the file that representsthe VHD. Error number 0xE006001D.

VHD Library: Requested number of bytes exceeds theremainder of bytes in a block. Error number 0xE006001E.

VHD Library: Accessed past end of the VHD file. Errornumber 0xE006001F.

VHD Library: Differencing VHD Unique ID (UUID)differs to parent VHD Unique ID. Error number 0xE0060020.

VHD Library: Differencing VHD timestamp differs toparent VHD last modified time. Error number 0xE0060021.

VHD Library: Failed to read or write the entire VHDBlock Allocation Table Map. Error number 0xE0060022.

IPC error occurred. Error number 0xE007FFFF.

There was an unknown transmission error. Errornumber 0xE0070001.

No response received for successful send. Errornumber 0xA0070002.

Message processor timed out. Error number0xE0070003.

Retry limit exhausted. Error number 0xE0070004.

Message recipient task is not active. Error number0xE0070005.

Socket send/recv cannot be retried. Error number0xE0070006.

Port shutdown due to connection opens exhausted.Error number 0xE0070007.

Port shutdown due to flood of junk packets. Errornumber 0xE0070008.

Port shutdown due to receive retries exhausted.Error number 0xE0070009.

Transport does not support fragmentation. Errornumber 0xE007000A.

One or more packet fragments are missing. Errornumber 0xE007000B.

Error sending message. Error number 0xE0070100.

Message acknowledgement timeout. Error number0xA0070101.

Command timeout. Error number 0xE0070102.

Not implemented. Error number 0xE0070103.

Error verifying message port number, must be >= 0and <= 65535. Error number 0xE0070104.

Command initialization failed. Error number0xE0070105.

Start of IPC failed. Error number 0xE0070106.

Stop of IPC failed. Error number 0xE0070107.

Memory allocation failure. Error number 0xE0070108.

Internal error, failure to wait long enough for acommunication response to be received. Error number 0xE0070109.

Disk Update error occurred. Error number 0xE008FFFF.

Inventory error occurred. Error number 0xE009FFFF.

Inventory Table: Failed to start thread. Errornumber 0xE0090001.

Inventory Table: Invalid Entry. Error number0xE0090002.

Inventory Table: Failed to initialize inventory.Error number 0xE0090003.

Shutdown in progress; request ignored. Error number0xE0090004.

Get Disk Inventory: Parameters bad. Error number0xE0090033.

Populate database: Failed offline. Error number0xE0090065.

Populate database: Server get by name failed. Errornumber 0xE0090066.

Populate database: Uninitialized. Error number 0xE0090067.

Populate database: Get host name failed. Errornumber 0xE0090068.

Populate database: Char conversion failed. Errornumber 0xE0090069.

Populate database: Initialization failed. Errornumber 0xE009006A.

Populate database: Database open failed. Errornumber 0xE009006B.

Populate database: Get all disk locators failed.Error number 0xE009006C.

Inventory Table: Not yet implemented. Error number0xE009006D.

Notifier error occurred. Error number 0xE00AFFFF.

MAPI error occurred. Error number 0xE00BFFFF.

186 TaskCancelled: Task [v1] is cancelled and is notrunning.

187 TaskCompleted: Task [v1] has been completed andis not running.

188 TaskInProgress: Task [v1] is running and cannotbe processed.

189 InvalidTask: The specified Task does not exist.

190 InventoryServerCannotContactDatabase: TheInventory Service cannot contact the database.

191 ServerOffline: The Server is offline.

192 ServerStateUnknown: The Server state is unknown.

193 HighestVersionIsPending: Could not complete thisaction because the highest vDisk version is still pending. Thescheduled date for the version has not occurred yet.

194 MergeInvalidWithCurrentVersions: Merge is notvalid with the current versions that exist.

195 DiskInventoryError: vDisk versions are not up todate on all Servers that access this vDisk. Update all Servers with the latestversions of the vDisk files.

196 VDiskFileNotFoundWarning: [v1]: vDisk file wasnot found because it was deleted.

197 CannotAssignActiveServer: Stop the Server beforeattempting to assign the Server to a different site.

198 CannotAssignServerWithActiveDevice: Beforeattempting to assign the Server to a different site, shut down Devicesconnecting to the Server, then shut down the Server.

199 MappedDiskLocator: The vDisk is mapped andcannot be changed.

200 InvalidTemplateDevice: The Template Device mustbe a Production Device that does not have a Personal vDisk.

201 DeviceWithPersonalVDiskInvalid: Unable toprocess a Device that uses a personal vDisk.

202 CreatingDisk: Server is creating a vDisk sochange cannot be done.

203 AssignedDiskLocatorToDeviceWithPersonalvDisk:Unable to delete a vDisk if the vDisk is currently assigned to a Device thatuses a Personal vDisk. Unassign the Device, then delete the vDisk.

204 InvalidMacAddress: The MAC address for this VMis invalid. Configure the VM with a valid MAC address.

205 CannotGetMacFromHypervisor: The hypervisor didnot return the MAC address for this VM: [v1]

206 Win32SystemException: A system error occurred.

207 RemoteManagementIpCannotBeResolved: Unable toresolve the management IP for Server [v1].

208 LocalManagementIpNotSet: The management IP forlocal server [v1] is not set in registry IPC\IPv4Address.

209 PerformVolumeMaintenanceTaskPermissions: Ensurethe Service Account user has the appropriate 'Perform volume maintenance task'permissions.

210 CannotLoginToVirtualHostingPool: Unable to logon to the virtual hosting pool [v1]. Ensure that the hypervisior server isrunning properly.

211 VirtualHostingPoolNotSetForDevice: ThevirtualHostingPoolId for device [v1] with bdmBoot must be set.

212 ActiveBdmBootDeviceCannotProcess: The BootDevice Manager [v1] did not process successfully.

213 CannotMovePvdDeviceToAnotherSite: Personal vDiskDevices cannot be moved to another site.

214 XenDesktopSiteInvalid: XenDesktop Site forDevices is not valid, the XenDesktop Site is: [v1]

215 XenDesktopServiceListOutOfDate: XenDesktop Site[v1] is not reachable, check that the Citrix PVS Soap Server service user hasXenDesktop permissions and network connectivity.

216 NoXenDesktopServiceForPersonalVDiskCapability:No XenDesktop service found for Personal vDisk capability.

217 InsufficientPermissionsToPreparePersonalVDisks:The user account for the Citrix PVS Soap Server has insufficient permissions toprepare Personal vDisks.

218 NotEnoughFreeDiskSpaceForManifest: There is notenough free disk space to create the manifest.

219 OperationCannotBeDoneOnlyPvdDevicesAssigned:Operation cannot be done, only Personal vDisk Devices are assigned.

220 DiskFormatCannotBeSetToVHD: The format cannot beset to VHD since no VHD vDisk file is found in the path, [v1], for Server,[v2].

221 DiskFormatCannotBeSetToVHDX: The format cannotbe set to VHDX since no VHDX vDisk file is found in the path, [v1], for Server,[v2].

222 TemporaryVersionIsSet: This task cannot beperformed because a temporary version is set.

223 DiskIsUsingPersistentCacheOnServer: A temporaryversion cannot be used for a vDisk that is using persistent cache on server.

224 UploadAlreadyInProgress: An upload is already inprogress by Server [v1].

225 FieldMustBeNull: Field [v1] must be null.

226 DuplicateData: Record already exists in [v1]table for Farm.

227 CisUploadTokenGenerateError: Error generatingupload token for My Citrix username [v1] ([v2]).

228 InvalidCredentials: The username or password isincorrect.

229 NoWriteAccessToFolders: No write access tofolders [v1] or [v2].

230 ReportCreationError: Error creating problemreport: [v1].

4100 ADerrorUnexpectedError: An unexpected ActiveDirectory related error occured. Ensure the appropriate permissions exist toperform this task. Error code: [v1], message: [v2], provider: [v3].

Objects, in the Citrix.PVS.SnapIn Namespace

PvsADAccount

Read-Only Fields

string Domain: Domain the account is a member of.

string DomainController: The name of the DC used tocreate the host's computer account.

string Name: Name of the Device for the account.

string Sid: The value of the objectSID AD attributeof the same name for the Device's computer account.

PvsAuditAction

Read-Only Fields

Guid Guid or AuditActionId: GUID of the action.

Guid ObjectId: GUID of the object of the action.

string ObjectName: Name of the object of the action.Max Length=1000

string Path: Path of the object of the action. Anexample is Site\Collection for a Device. Default="" Max Length=101

Guid SiteId: GUID of the Site for the object of theaction. 00000000-0000-0000-0000-000000000000 when not valid.Default=00000000-0000-0000-0000-000000000000

Guid SubId: GUID of the Collection or Store of theaction. 00000000-0000-0000-0000-000000000000 when not valid.Default=00000000-0000-0000-0000-000000000000

uint Type: Type of object that action was performedon. 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

Guid AuditActionId: GUID of the Audit Action usedfor Get and Set.

string Name or AuditParameterName: Name of theparameter. Max Length=50

string Value: Value of the parameter. MaxLength=1000

PvsAuditActionProperty

Read-Only Fields

Guid AuditActionId: GUID of the Audit Action usedfor Get and Set.

string Name or AuditPropertyName: Name of theproperty. Max Length=50

string NewValue: New value of the Property.Default="" Max Length=1000

string OldValue: Previous value of the Property.Default="" Max Length=1000

PvsAuditTrail

Read-Only Fields

uint Action: Name of the action taken. This is anumber 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), 2064RunUpdateBDM, 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), 6016SetVirtualHostingPool, 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)

uint Attachments: An or'ed value that indicates ifthere are any details for this action. A value of 15 indicates that there areChildren, Sibling, Parameters and Properties for the action. Values are: 0(None), 1 (Children), 2 (Sibling), 4 (Parameters), and 8 (Properties) Default=0

Guid Guid or AuditActionId: GUID of the action.

string Domain: Domain of the user that performed theaction. Max Length=255

Guid ObjectId: GUID of the object of the action. Default=00000000-0000-0000-0000-000000000000

string ObjectName: Name of the object of the action.Default="" Max Length=1000

Guid ParentId: GUID of the parent action (one thattriggered this action) if one exists. 00000000-0000-0000-0000-000000000000 whennot valid. Default=00000000-0000-0000-0000-000000000000

string Path: Path of the object of the action. Anexample is Site\Collection for a Device. Default="" Max Length=101

Guid RootId: GUID of the root action (one thattriggered this group of actions) if one exists.00000000-0000-0000-0000-000000000000 when not valid.Default=00000000-0000-0000-0000-000000000000

Guid SiteId: GUID of the Site for the object of theaction. 00000000-0000-0000-0000-000000000000 when not valid.Default=00000000-0000-0000-0000-000000000000

Guid SubId: GUID of the Collection or Store of theaction. 00000000-0000-0000-0000-000000000000 when not valid.Default=00000000-0000-0000-0000-000000000000

DateTime Time: Date/Time the action occurred down tothe millisecond. Has the date and time including milliseconds. Default=Empty

uint Type: Type of object that action was performedon. 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)

string UserName: User that performed the action. MaxLength=255

PvsAuthGroup

Read/Write Fields

string Name or AuthGroupName: Name of the ActiveDirectory or Windows Group. Max Length=450

string Description: User description.Default="" Max Length=250

Read-Only Fields

Guid Guid or AuthGroupId: Read-only GUID thatuniquely identifies this AuthGroup.

uint Role: Role of the AuthGroup for a Collection.role can only be used with CollectionId or CollectionName. 300 is CollectionAdministrator, and 400 is Collection Operator. Default=999

PvsAuthGroupUsage

Read-Only Fields

Guid Guid or Id: GUID of the item. The item can be aFarm, Site or Collection. It will be 00000000-0000-0000-0000-000000000000 forFarm.

string Name: Name of the item. The item can be aFarm, Site or Collection.

uint Role: Role of the AuthGroup for the item. 100is Farm Administrator, 200 is Site Administrator, 300 is CollectionAdministrator, and 400 is Collection Operator. Default=999

PvsCeipData

Read/Write Fields

uint Enabled: 1 if CEIP is enabled, otherwise 0.Min=0, Max=1

uint InProgress: 1 if an upload is currently inprogress, otherwise 0. Default=0

DateTime NextUpload: Date and time next CEIP uploadis due if enabled is 1. Default=Empty

uint OneTimeUpload: 1 to perform a one time upload.

Guid ServerId: ID of server that is currentlyuploading, null if InProgress is 0.Default=00000000-0000-0000-0000-000000000000

Read-Only Field

Guid Uuid: CEIP UUID.

PvsCisData

Read/Write Fields

string Password: Password of the user required toobtain the token. This is required only by Set and Add

string Path: Path where the last problem reportbundle was saved Default="" Max Length=255

string UserName: Username used to obtain the tokenDefault="" Max Length=255

Read-Only Fields

Guid Guid or CisDataId: CIS UUID

string UploadToken: Token for uploading bundles toCIS Default="" Max Length=10

PvsCollection

Read/Write Fields

uint AutoAddNumberLength: The maximum length of theDevice Number for Auto Add. This length plus the AutoAddPrefix length plus theAutoAddSuffix length must be less than 16. Required that((lenautoAddPrefix+lenautoAddSuffix)+AutoAddNumberLength)<=15. Min=3, Max=9,Default=4

string AutoAddPrefix: The string put before theDevice Number for Auto Add. Default="" ASCII computer name charactersno end digit Max Length=12

string AutoAddSuffix: The string put after theDevice Number for Auto Add. Default="" ASCII computer name charactersno begin digit Max Length=12

bool AutoAddZeroFill: True when zeros be placed beforethe Device Number up to the AutoAddNumberLength for Auto Add, false otherwise.Default=true

string Name or CollectionName: Name of theCollection. It is unique within the Site. Max Length=50

string Description: User description.Default="" Max Length=250

bool Enabled: True when Devices in the Collectioncan be booted, false otherwise. Default=true

uint LastAutoAddDeviceNumber: The Device Number ofthe last Auto Added Device. Default=0

Guid TemplateDeviceId: GUID of a Device in theCollection whose settings are used for initial values of new Devices. Not usedwith templateDeviceName. Default=00000000-0000-0000-0000-000000000000

string TemplateDeviceName: Name of a Device in theCollection whose settings are used for initial values of new Devices. Not usedwith TemplateDeviceId. Default=""

Read-Only Fields

uint ActiveDeviceCount: Read-only count of activeDevices in this Collection. Default=0

Guid Guid or CollectionId: Read-only GUID thatuniquely identifies this Collection.

uint DeviceCount: Read-only count of Devices in thisCollection. Default=0

uint DeviceWithPVDCount: Read-only count of Deviceswith Personal vDisk in this Collection. Default=0

uint MakActivateNeededCount: Read-only count ofactive Devices that need MAK activation in this Collection. Default=0

uint Role: Read-only Role of the user for this item.100 is Farm Administrator, 200 is Site Administrator, 300 is CollectionAdministrator, and 400 is Collection Operator. Default=999

Guid SiteId: GUID of the Site that this Collectionis a member of. It is not used with SiteName.

string SiteName: Name of the Site that thisCollection is a member of. It is not used with SiteId.

PvsConnection

Read/Write Fields

string Domain: Domain name to use forAuthentication. If it has a value, it will be *****. Default=""

string Password: Password to use for Authentication.If it has a value, it will be *****. Default=""

string Persist: True when the connection settingsshould be, for Set, or have been, for Get, saved to the registry.

string Port: The Port to use to connect.Default=54321

string Name or Server: Name or IP of the Server toconnect to. Default=localhost

string User: User name to use for Authentication. Ifit has a value, it will be *****. Default=""

Read-Only Field

string Connected: True when the Citrix.PVS.SnapIn iscurrently connected to the SoapServer with the settings in this PvsConnection.

PvsConnection can be created or modified usingmethods below:

New-Object Citrix.PVS.SnapIn.PvsConnection: Createsdefault Server=localhost, Port=54321, and no authentication.

New-ObjectCitrix.PVS.SnapIn.PvsConnection(Citrix.PVS.SnapIn copyFrom): Creates withsettings of the copyFrom Citrix.PVS.SnapIn.

SetServerToLocalHostDefaultSettings:Server=localhost, Port=54321, and no authentication.

Copy(Citrix.PVS.SnapIn copyFrom): Modifies thesettings to match the copyFrom Citrix.PVS.SnapIn.

Equals(Citrix.PVS.SnapIn compareTo): Returns truewhen the settings match what is in the compareTo.

PvsDevice

Read/Write Fields

uint AdSignature: The signature of the Active Directorymachine account password. Do not set this field, it is only set internally byPVS. Default=0

uint AdTimestamp: The time the Active Directorymachine account password was generated. Do not set this field, it is only setinternally by PVS. Default=0

uint Authentication: Device log in authentication.Choices are 0 for none, 1 for User Name/Password, and 2 for Extern. This cannotbe Set for a Device with Personal vDisk. Min=0, Max=2, Default=0

bool BdmBoot: Use PXE boot when set to false, BDMboot when set to true. Default is PXE Default=false

DateTime BdmCreated: Timstamp when BDM device wascreated Default=Empty

uint BdmFormat: 1 use VHD for BDMboot, 2 use ISO, 3use USB. Default=0

uint BdmType: Use PXE boot when set to 0, BDM (Bios)boot when set to 1 and BDM (Uefi) boot when set to 2. Default=0

DateTime BdmUpdated: Timestamp of the last BDM bootdisk update. Default=Empty

uint BootFrom: Device to boot from. Choices are 1for vDisk, 2 for Hard Disk, and 3 for Floppy. This cannot be Set for a Devicewith Personal vDisk. Min=1, Max=3, Default=1

string ClassName: Used by Automatic Update featureto match new versions of Disks to a Device. This cannot be Set for a Devicewith Personal vDisk. Default="" Max Length=41

string Description: User description.Default="" Max Length=250

PvsPhysicalAddress DeviceMac: Ethernet address canhave the form XX-XX-XX-XX-XX-XX. Uniquely identifies the Device.

string Name or DeviceName: Computer name with nospaces. ASCII computer name characters Max Length=15

string DomainControllerName: The name of the DC usedto create the host's computer account. Do not set this field, it is only setinternally by PVS. Default="" Max Length=4000

string DomainName: Fully qualified name of thedomain that the Device belongs to. Do not set this field, it is only setinternally by PVS. Default="" Max Length=255

string DomainObjectSID: The value of the objectSIDAD attribute of the same name for the Device's computer account. Do not setthis field, it is only set internally by PVS. Default="" MaxLength=186

DateTime DomainTimeCreated: The time that thecomputer account was created. Has the date and time including milliseconds. Donot set this field, it is only set internally by PVS. Default=Empty

bool Enabled: True when it can be booted, falseotherwise. This cannot be Set for a Device with Personal vDisk. Default=true

bool LocalDiskEnabled: If there is a local disk menuchoice for the Device, this is true. This cannot be Set for a Device withPersonal vDisk. Default=false

uint LocalWriteCacheDiskSize: The size in GB toformat the Device cache file disk. If the value is 0, then the disk is notformatted. Min=0, Max=2048, Default=0

uint LogLevel: Level to perform logging at. Valuesare: 0 (None), 1 (Fatal), 2 (Error), 3 (Warning), 4 (Info), 5 (Debug), and 6(Trace). Min=0, Max=6, Default=0

string Password: Password of user to authenticatebefore the boot process continues. This cannot be Set for a Device withPersonal vDisk. Default="" ASCII Max Length=100

uint Port: UDP port to use with Stream Service.Min=1025, Max=65534, Default=6901

uint Type: 1 when it performs test of Disks, 2 whenit performs maintenance on Disks, 3 when it has a Personal vDisk, 4 when it hasa Personal vDisk and performs tests, 0 otherwise. A Device with type 0 - 3 canonly 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

string User: Name of user to authenticate before theboot process continues. This cannot be Set for a Device with Personal vDisk.Default="" ASCII Max Length=20

bool XsPvsProxyEnabled: Enable XenServer PVS proxywhen set to true Default=false

Guid XsPvsProxyUuid: UUID of XenServer PVS_proxyDefault=00000000-0000-0000-0000-000000000000

Read-Only Fields

bool Active: True if the Device is currently active,false otherwise. Default=false

Guid CollectionId: GUID of the Collection thisDevice is to be a member of. It is not used with CollectionName.

string CollectionName: Name of the Collection thisDevice is to be a member of. SiteName or SiteId must also be used.

Guid Guid or DeviceId: Read-only GUID that uniquelyidentifies this Device.

string PvdDriveLetter: Read-only Personal vDiskDrive letter. Range is E to U and W to Z. Default="" Max Length=1

uint Role: Read-only Role of the user for this item.100 is Farm Administrator, 200 is Site Administrator, 300 is CollectionAdministrator, and 400 is Collection Operator. Default=999

Guid SiteId: GUID of the Site the CollectionName isto be a member of. This or SiteName is used with CollectionName.

string SiteName: Name of the Site the CollectionNameis to be a member of. This or SiteId is used with CollectionName.

bool Template: True if the Device is the template inits Collection, false otherwise. Default=false

bool TemporaryVersionSet: Read-only true whentemporary version is set. Default=false

Guid VirtualHostingPoolId: GUID that uniquelyidentifies the Virtual Hosting Pool for a VM. This is needed when Adding a VMdevice. Default=00000000-0000-0000-0000-000000000000

PvsDeviceBootstrap

Read-Only Fields

Guid Guid or DeviceId: GUID of the Device.

PvsDeviceBootstrapList: Each one of these has these2 fields:

string Name or Bootstrap: Name of the bootstrapfile. Max Length=259

string MenuText: Text that is displayed in the BootMenu. If this field has no value, the bootstrap value is used.Default="" ASCII Max Length=64

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

Methods

Add(string bootstrap, string menuText): Used to adda PvsDeviceBootstrapList to the end of the array.

Insert(int position, string bootstrap, stringmenuText): Used to insert a PvsDeviceBootstrapList array item at position. Theposition is 0 based.

Remove(int position): Used to remove aPvsDeviceBootstrapList array item at position. The position is 0 based.

Set(int position, string menuText): Used to set aPvsDeviceBootstrapList array item MenuText at position. The position is 0based.

Reorder(int oldPosition, int newPosition): Used tomove a PvsDeviceBootstrapList array item from the oldPosition to thenewPosition. The oldPosition and newPosition are 0 based.

PvsDeviceBootstrapList

Read/Write Fields

string Name or Bootstrap: Name of the bootstrapfile. Max Length=259

string MenuText: Text that is displayed in the BootMenu. If this field has no value, the bootstrap value is used.Default="" ASCII Max Length=64

PvsDeviceDiskTempVersion

Read-Only Fields

Guid Guid or DeviceId: Read-only GUID that uniquelyidentifies the Device with temporary version.

string Name or DeviceName: Read-only Computer namethat uniquely identifies the Device with temporary version. ASCII computer namecharacters

Guid DiskLocatorId: Read-only GUID that uniquelyidentifies then Disk Locator with temporary version.

string DiskLocatorName: Read-only Name of the DiskLocator File with temporary version. It is unique within the Store. ASCII

Guid SiteId: Read-only GUID of the Site the Deviceand DiskLocator are a member of.

string SiteName: Read-only Name of the Site theDevice and DiskLocator are a member of.

Guid StoreId: Read-only GUID of the Store that theDisk Locator is a member of.

string StoreName: Read-only Name of the Store thatthe Disk Locator is a member of.

uint Version: Read-only Disk version the temporaryis for.

PvsDeviceInfo

Read-Only Fields

bool Active: True if the Device is currently active,false otherwise. Default=false

uint AdSignature: The signature of the ActiveDirectory machine account password. Do not set this field, it is only setinternally by PVS. Default=0

uint AdTimestamp: The time the Active Directory machineaccount password was generated. Do not set this field, it is only setinternally by PVS. Default=0

uint Authentication: Device log in authentication.Choices are 0 for none, 1 for User Name/Password, and 2 for Extern. This cannotbe Set for a Device with Personal vDisk. Min=0, Max=2, Default=0

bool BdmBoot: Use PXE boot when set to false, BDMboot when set to true. Default is PXE Default=false

DateTime BdmCreated: Timstamp when BDM device wascreated Default=Empty

uint BdmFormat: 1 use VHD for BDMboot, 2 use ISO, 3use USB. Default=0

uint BdmType: Use PXE boot when set to 0, BDM (Bios)boot when set to 1 and BDM (Uefi) boot when set to 2. Default=0

DateTime BdmUpdated: Timestamp of the last BDM bootdisk update. Default=Empty

uint BootFrom: Device to boot from. Choices are 1for vDisk, 2 for Hard Disk, and 3 for Floppy. This cannot be Set for a Devicewith Personal vDisk. Min=1, Max=3, Default=1

string ClassName: Used by Automatic Update featureto match new versions of Disks to a Device. This cannot be Set for a Devicewith Personal vDisk. Default="" Max Length=41

Guid CollectionId: GUID of the Collection thisDevice is to be a member of. It is not used with CollectionName.

string CollectionName: Name of the Collection thisDevice is to be a member of. SiteName or SiteId must also be used.

string Description: User description.Default="" Max Length=250

Guid Guid or DeviceId: Read-only GUID that uniquelyidentifies this Device.

PvsPhysicalAddress DeviceMac: Ethernet address canhave the form XX-XX-XX-XX-XX-XX. Uniquely identifies the Device.

string Name or DeviceName: Computer name with nospaces. ASCII computer name characters Max Length=15

string DiskFileName: Name of the Disk File includingthe extension. It is equal to "" if the Device is not active.

Guid DiskLocatorId: Read-only GUID of the DiskLocator that the Device is using. It is equal to00000000-0000-0000-0000-000000000000 if the Device is not active.

string DiskLocatorName: Read-only name of the DiskLocator File that the Device is using. It is equal to the list of Disk Locatornames for the Device if the Device is not active.

uint DiskVersion: Read-only version of the DiskLocator File that the Device is using. It is equal to 0 if the Device is notactive. Default=0

uint DiskVersionAccess: 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 isequal to 0 if the Device is not active. Default=0

string DomainControllerName: The name of the DC usedto create the host's computer account. Do not set this field, it is only setinternally by PVS. Default="" Max Length=4000

string DomainName: Fully qualified name of thedomain that the Device belongs to. Do not set this field, it is only setinternally by PVS. Default="" Max Length=255

string DomainObjectSID: The value of the objectSIDAD attribute of the same name for the Device's computer account. Do not setthis field, it is only set internally by PVS. Default="" Max Length=186

DateTime DomainTimeCreated: The time that thecomputer account was created. Has the date and time including milliseconds. Donot set this field, it is only set internally by PVS. Default=Empty

bool Enabled: True when it can be booted, falseotherwise. This cannot be Set for a Device with Personal vDisk. Default=true

System.Net.IPAddress Ip: Read-only IP of the Device.It is equal to 0.0.0.0 if the Device is not active.

uint License: Oem Only: Read-only type of thelicense. Values are 0 when None, 1 or 2 when Desktop. It is equal to 0 if theDevice is not active. Default=0

uint LicenseType: 0 when None, 1 for Desktop, 2 forServer, 5 for OEM SmartClient, 6 for XenApp, 7 for XenDesktop. It is equal to 0if the Device is not active. Default=0

bool LocalDiskEnabled: If there is a local disk menuchoice for the Device, this is true. This cannot be Set for a Device withPersonal vDisk. Default=false

uint LocalWriteCacheDiskSize: The size in GB toformat the Device cache file disk. If the value is 0, then the disk is notformatted. Min=0, Max=2048, Default=0

uint LogLevel: Level to perform logging at. Valuesare: 0 (None), 1 (Fatal), 2 (Error), 3 (Warning), 4 (Info), 5 (Debug), and 6(Trace). Min=0, Max=6, Default=0

uint MakLicenseActivated: Read-only indicator if MAKlicensing is being used and is activated. Values are: 0 (MAK not used), 1 (NotActivated), 2 (Activated). It is equal to 0 if the Device is not active.Default=0

string Model: Oem Only: Read-only model of thecomputer. Values are OptiPlex 745, 755, 320, 760, FX160, or Default. It isequal to "" if the Device is not active.

string Password: Password of user to authenticatebefore the boot process continues. This cannot be Set for a Device withPersonal vDisk. Default="" ASCII Max Length=100

uint Port: UDP port to use with Stream Service.Min=1025, Max=65534, Default=6901

string PvdDriveLetter: Read-only Personal vDiskDrive letter. Range is E to U and W to Z. Default="" Max Length=1

uint Role: Read-only Role of the user for this item.100 is Farm Administrator, 200 is Site Administrator, 300 is CollectionAdministrator, and 400 is Collection Operator. Default=999

Guid ServerId: Read-only GUID of the Server that theDevice is using. It is equal to 00000000-0000-0000-0000-000000000000 if theDevice is not active.

System.Net.IPAddress ServerIpConnection: Read-onlyIP of the Server that the Device is using. It is equal to 0.0.0.0 if the Deviceis not active.

string ServerName: Read-only Name of the Server thatthe Device is using. It is equal to "" if the Device is not active.

uint ServerPortConnection: Read-only Port of theServer that the Device is using. It is equal to 0 if the Device is not active.Default=0

Guid SiteId: GUID of the Site the CollectionName isto be a member of. This or SiteName is used with CollectionName.

string SiteName: Name of the Site the CollectionNameis to be a member of. This or SiteId is used with CollectionName.

string Status: 1 or 2 numbers in the format n,n.They are the number of retries and if ram cache is being used, ram cachepercent used. It is equal to "" if the Device is not active.

bool Template: True if the Device is the template inits Collection, false otherwise. Default=false

bool TemporaryVersionSet: Read-only true whentemporary version is set. Default=false

uint Type: 1 when it performs test of Disks, 2 whenit performs maintenance on Disks, 3 when it has a Personal vDisk, 4 when it hasa Personal vDisk and performs tests, 0 otherwise. Min=0, Max=4, Default=0

string User: Name of user to authenticate before theboot process continues. This cannot be Set for a Device with Personal vDisk.Default="" ASCII Max Length=20

Guid VirtualHostingPoolId: GUID that uniquelyidentifies the Virtual Hosting Pool for a VM. This is needed when Adding a VMdevice. Default=00000000-0000-0000-0000-000000000000

bool XsPvsProxyEnabled: Enable XenServer PVS proxywhen set to true Default=false

Guid XsPvsProxyUuid: UUID of XenServer PVS_proxyDefault=00000000-0000-0000-0000-000000000000

PvsDevicePersonality

Read-Only Fields

Guid Guid or DeviceId: GUID of the Device.

PvsDevicePersonalityList: Each one of these hasthese 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: Listof objects that can be changed with the methods below.

Methods

Add(string name, string value): Used to add aPvsDevicePersonalityList to the end of the array.

Insert(int position, string name, string value):Used to insert a PvsDevicePersonalityList array item at position. The positionis 0 based.

Remove(int position): Used to remove aPvsDevicePersonalityList array item at position. The position is 0 based.

Set(int position, string value): Used to set aPvsDevicePersonalityList array item Value at position. The position is 0 based.

Reorder(int oldPosition, int newPosition): Used tomove a PvsDevicePersonalityList array item from the oldPosition to thenewPosition. The oldPosition and newPosition are 0 based.

PvsDevicePersonalityList

Read/Write Fields

string Name: Name of the Device personality item.Max Length=250

string Value: Value for the Device personality item.Max Length=1000

PvsDeviceStatus

Read-Only Fields

Guid Guid or DeviceId: Read-only GUID of the Device.Can be used with Get Device.

string Name or DeviceName: Read-only Name of theDevice. Can be used with Get Device.

string DiskFileName: Name of the Disk File includingthe extension.

Guid DiskLocatorId: Read-only GUID of the DiskLocator that the Device is using.

string DiskLocatorName: Read-only name of the DiskLocator File that the Device is using.

uint DiskVersion: Read-only version of the DiskLocator File that the Device is using. Default=0

uint DiskVersionAccess: 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

System.Net.IPAddress Ip: Read-only IP of the Device.

uint LicenseType: 0 when None, 1 for Desktop, 2 forServer, 5 for OEM SmartClient, 6 for XenApp, 7 for XenDesktop. Default=0

uint MakLicenseActivated: Read-only indicator if MAKlicensing is being used and is activated. Values are: 0 (MAK not used), 1 (NotActivated), 2 (Activated). Default=0

Guid ServerId: Read-only GUID of the Server that theDevice is using.

System.Net.IPAddress ServerIpConnection: Read-onlyIP of the Server that the Device is using.

string ServerName: Read-only Name of the Server thatthe Device is using.

uint ServerPortConnection: Read-only Port of the Serverthat the Device is using. Default=0

string Status: 1 or 2 numbers in the format n,n.They are the number of retries and if ram cache is being used, ram cachepercent used.

PvsDisk

Read/Write Fields

bool ActivationDateEnabled: Use activation date to activateimage when set to true. Default false

DateTime ActiveDate: Date to activate the disk ifAutoUpdateEnabled and activationDateEnabled are true. Has the date. Empty whenthe AutoUpdateEnabled or activationDateEnabled are false.

bool AdPasswordEnabled: Enable AD passwordmanagement when set to true.

string Author: User defined author. Max Length=40

bool AutoUpdateEnabled: Automatically update thisimage for matching Devices when set to true. Default false

UInt64 Build: User defined build number. Min=0,Max=4294967295, Default=0

string Class: Class of the Disk. Max Length=40

string Company: User defined company. Max Length=40

string Date: User defined date. Max Length=40

bool VHDX: If VHDX is true, the format of the imageis VHDX. Otherwise it is VHD. Default=false

bool HaEnabled: Enable HA when set to true.

string HardwareTarget: User defined hardware target.Max Length=127

string ImageType: Type of this image (softwaretype). Max Length=40

string InternalName: User defined name. MaxLength=63

uint LicenseMode: 0 (None), 1 (Multiple ActivationKey), or 2 (Key Management Service). Min=0, Max=2, Default=0

string LongDescription: Description of the Disk. MaxLength=399

UInt64 MajorRelease: User defined major releasenumber. Min=0, Max=4294967295, Default=0

UInt64 MinorRelease: User defined minor releasenumber. Min=0, Max=4294967295, Default=0

string OriginalFile: User defined original file. MaxLength=127

bool PrinterManagementEnabled: Invalid printers willbe deleted from the Device when set to true.

string SerialNumber: User defined serial number. MaxLength=36

string Title: User defined title. Max Length=40

UInt64 WriteCacheSize: RAM cache size (MB). Not 0when used with Cache in Device RAM, and Cache in Device RAM with Overflow onHard Disk. A value of 0 will disable the RAM use for Cache in Device RAM withOverflow on Hard Disk. Min=0, Max=131072, Default=0

uint WriteCacheType: 0 (Private), (other values arestandard image) 1 (Cache on Server), 3 (Cache in Device RAM), 4 (Cache onDevice Hard Disk), 6 (Device RAM Disk), 7 (Cache on Server, Persistent), or 9(Cache in Device RAM with Overflow on Hard Disk). Min=0, Max=9, Default=0

Read-Only Fields

Guid Guid or DiskLocatorId: GUID of the DiskLocatorused for Get and Set.

UInt64 DiskSize: Read-only size of the image. Thevalue is 0 when it is not available. Default=0

string LogicalSectorSize: Logical Sector Size.Values are: 512, 4096, Default=512

uint VhdBlockSize: Block size in KB. For VHD it isonly used with Dynamic type. Tested sizes for VHD are 512, 2048, and 16384. VHDMin=512, Max=16384, Default=2048. For VHDX it is used for all types. Testedsize for VHDX is 32768. VHDX Min=1024, Max= 262144, Default=32768. Default=0

PvsDiskInfo

Read-Only Fields

bool ActivationDateEnabled: Use activation date toactivate image when set to true. Default false

bool Active: True if the DiskLocator is currentlyactive, false otherwise. Default=false

DateTime ActiveDate: Date to activate the disk ifAutoUpdateEnabled and activationDateEnabled are true. Has the date. Empty whenthe AutoUpdateEnabled or activationDateEnabled are false.

bool AdPasswordEnabled: Enable AD passwordmanagement when set to true.

string Author: User defined author. Max Length=40

bool AutoUpdateEnabled: Automatically update thisimage for matching Devices when set to true. Default false

UInt64 Build: User defined build number. Min=0,Max=4294967295, Default=0

string Class: Class of the Disk. Max Length=40

string Company: User defined company. Max Length=40

string Date: User defined date. Max Length=40

string Description: User description.Default="" Max Length=250

uint DeviceCount: Read-only count of Devices.Default=0

Guid Guid or DiskLocatorId: Read-only GUID thatuniquely identifies this Disk Locator.

string Name or DiskLocatorName: Name of the Disk LocatorFile. It is unique within the Store. ASCII Max Length=52

UInt64 DiskSize: Read-only size of the image. Thevalue is 0 when it is not available. Default=0

Guid DiskUpdateDeviceId: GUID of theDiskUpdateDevice that is used when updates are performed.Default=00000000-0000-0000-0000-000000000000

string DiskUpdateDeviceName: Name of theDiskUpdateDevice that is used when updates are performed. Default=""

bool Enabled: True when this disk can be booted,false otherwise. Default=true

bool EnabledForDevice: True when this disk isenabled for the Device specified, false otherwise. This is only returned when aDevice is specified. Default=true

bool VHDX: If VHDX is true, the format of the imageis VHDX. Otherwise it is VHD. Default=false

bool HaEnabled: Enable HA when set to true.

string HardwareTarget: User defined hardware target.Max Length=127

string ImageType: Type of this image (softwaretype). Max Length=40

string InternalName: User defined name. MaxLength=63

uint LicenseMode: 0 (None), 1 (Multiple ActivationKey), or 2 (Key Management Service). Min=0, Max=2, Default=0

bool Locked: True if the Disk is currently locked,false otherwise. Default=false

string LogicalSectorSize: Logical Sector Size.Values are: 512, 4096, Default=512

string LongDescription: Description of the Disk. MaxLength=399

UInt64 MajorRelease: User defined major releasenumber. Min=0, Max=4294967295, Default=0

bool Mapped: True if the Disk is currently mapped,false otherwise. Default=false

string MenuText: Text that is displayed in the BootMenu. If this field has no value, the name value is used. Default=""ASCII Max Length=64

UInt64 MinorRelease: User defined minor releasenumber. Min=0, Max=4294967295, Default=0

string OriginalFile: User defined original file. MaxLength=127

bool PrinterManagementEnabled: Invalid printers willbe deleted from the Device when set to true.

bool RebalanceEnabled: True when this Server canautomatically rebalance Devices, false otherwise. Default=false

uint RebalanceTriggerPercent: Percent over fair loadthat triggers a dynamic Device rebalance. Min=5, Max=5000, Default=25

uint Role: Read-only Role of the user for this item.100 is Farm Administrator, 200 is Site Administrator, 300 is CollectionAdministrator, and 999 is read-only. Default=999

string SerialNumber: User defined serial number. MaxLength=36

Guid ServerId: GUID of the single Server that thisDisk Locator is assigned to. It is not used with ServerName.Default=00000000-0000-0000-0000-000000000000

string ServerName: Name of the single Server thatthis Disk Locator is assigned to. It is not used with ServerId.Default=""

Guid SiteId: GUID of the Site this DiskLocator is tobe a member of. It is not used with SiteName.

string SiteName: Name of the Site this DiskLocatoris to be a member of. It is not used with SiteId.

Guid StoreId: GUID of the Store that this DiskLocator is a member of. SiteName or SiteId must also be used. It is not usedwith StoreName.

string StoreName: Name of the Store that this DiskLocator is a member of. SiteName or SiteId must also be used. It is not usedwith StoreId.

uint SubnetAffinity: Qualifier for subnet affinitywhen assigning a Server. 0=None, 1=Best Effort, 2=Fixed. Min=0, Max=2,Default=0

bool TemporaryVersionSet: Read-only true whentemporary version(s) are set. Default=false

string Title: User defined title. Max Length=40

uint VhdBlockSize: Block size in KB. For VHD it isonly used with Dynamic type. Tested sizes for VHD are 512, 2048, and 16384. VHDMin=512, Max=16384, Default=2048. For VHDX it is used for all types. Testedsize for VHDX is 32768. VHDX Min=1024, Max= 262144, Default=32768. Default=0

UInt64 WriteCacheSize: RAM cache size (MB). Not 0when used with Cache in Device RAM, and Cache in Device RAM with Overflow onHard Disk. A value of 0 will disable the RAM use for Cache in Device RAM withOverflow on Hard Disk. Min=0, Max=131072, Default=0

uint WriteCacheType: 0 (Private), (other values arestandard image) 1 (Cache on Server), 3 (Cache in Device RAM), 4 (Cache onDevice Hard Disk), 6 (Device RAM Disk), 7 (Cache on Server, Persistent), or 9(Cache in Device RAM with Overflow on Hard Disk). Min=0, Max=9, Default=0

PvsDiskInventory

Read-Only Fields

string Active: 1 if the Server is currently active,2 if unknown, and 0 otherwise.

Guid Guid or DiskLocatorId: GUID of the DiskLocatorused for Get and Set.

string FilePath: Path used to access the diskversion from the Server. Empty if the information is not available.

DateTime FileTime: Date/Time of the date versionfile. Has the date and time without milliseconds. Empty if the information isnot available.

DateTime PropertiesTime: Date/Time of the diskproperties. Has the date and time without milliseconds. Empty if theinformation is not available.

Guid ServerId: GUID of the Server that the DiskVersion Inventory is being reported about.

string ServerName: Name of the Server that the DiskVersion Inventory is being reported about.

string State: The number code of the inventorystate. Values are: 0 (Up to date), 1 (version file is missing), 2 (version fileis out of date), 3 (properties are missing), 4 (properties are out of date), 5(server is not reachable).

string Version: Version number. The base disk isversion 0, the other version numbers are in part of the file name.

PvsDiskLocator

Read/Write Fields

string Description: User description.Default="" Max Length=250

bool Enabled: True when this disk can be booted,false otherwise. Default=true

string MenuText: Text that is displayed in the BootMenu. If this field has no value, the name value is used. Default=""ASCII Max Length=64

bool RebalanceEnabled: True when this Server canautomatically rebalance Devices, false otherwise. Default=false

uint RebalanceTriggerPercent: Percent over fair loadthat triggers a dynamic Device rebalance. Min=5, Max=5000, Default=25

Guid ServerId: GUID of the single Server that thisDisk Locator is assigned to. It is not used with ServerName.Default=00000000-0000-0000-0000-000000000000

string ServerName: Name of the single Server thatthis Disk Locator is assigned to. It is not used with ServerId.Default=""

uint SubnetAffinity: Qualifier for subnet affinitywhen assigning a Server. 0=None, 1=Best Effort, 2=Fixed. Min=0, Max=2,Default=0

Read-Only Fields

bool Active: True if the DiskLocator is currentlyactive, false otherwise. Default=false

Guid Guid or DiskLocatorId: Read-only GUID thatuniquely identifies this Disk Locator.

string Name or DiskLocatorName: Name of the DiskLocator File. It is unique within the Store. ASCII Max Length=52

Guid DiskUpdateDeviceId: GUID of theDiskUpdateDevice that is used when updates are performed.Default=00000000-0000-0000-0000-000000000000

string DiskUpdateDeviceName: Name of theDiskUpdateDevice that is used when updates are performed. Default=""

bool EnabledForDevice: True when this disk isenabled for the Device specified, false otherwise. This is only returned when aDevice is specified. Default=true

bool Mapped: True if the Disk is currently mapped,false otherwise. Default=false

uint Role: Read-only Role of the user for this item.100 is Farm Administrator, 200 is Site Administrator, 300 is CollectionAdministrator, and 999 is read-only. Default=999

Guid SiteId: GUID of the Site this DiskLocator is tobe a member of. It is not used with SiteName.

string SiteName: Name of the Site this DiskLocatoris to be a member of. It is not used with SiteId.

Guid StoreId: GUID of the Store that this DiskLocator is a member of. SiteName or SiteId must also be used. It is not usedwith StoreName.

string StoreName: Name of the Store that this DiskLocator is a member of. SiteName or SiteId must also be used. It is not usedwith StoreId.

bool TemporaryVersionSet: Read-only true whentemporary version(s) are set. Default=false

PvsDiskLocatorLock

Read-Only Fields

Guid DeviceId: GUID of the Device that has the lock,will be 00000000-0000-0000-0000-000000000000 if a Server has the lock.

string DeviceName: Name of the Device that has thelock, will not be included if a Server has the lock.

bool Exclusive: True when the lock is exclusive,false when it is shared. Default=false

bool ReadOnly: True when lock is because file systemis read only, false when file system is read write Default=false

Guid ServerId: GUID of the Server that has the lock,will be 00000000-0000-0000-0000-000000000000 if a Device has the lock.

string ServerName: Name of the Server that has thelock, will not be included if a Device has the lock.

PvsDiskUpdateDevice

Read/Write Fields

uint AdSignature: The signature of the ActiveDirectory machine account password. Do not set this field, it is only setinternally by PVS. Default=0

uint AdTimestamp: The time the Active Directorymachine account password was generated. Do not set this field, it is only setinternally by PVS. Default=0

string Description: User description.Default="" Max Length=250

string DomainControllerName: The name of the DC usedto create the host's computer account. Do not set this field, it is only setinternally by PVS. Default="" Max Length=4000

string DomainName: Fully qualified name of thedomain that the Device belongs to. Do not set this field, it is only setinternally by PVS. Default="" Max Length=255

string DomainObjectSID: The value of the objectSIDAD attribute of the same name for the Device's computer account. Do not setthis field, it is only set internally by PVS. Default="" MaxLength=186

DateTime DomainTimeCreated: The time that thecomputer account was created. Has the date and time including milliseconds. Donot set this field, it is only set internally by PVS. Default=Empty

uint LogLevel: Level to perform logging at. Valuesare: 0 (None), 1 (Fatal), 2 (Error), 3 (Warning), 4 (Info), 5 (Debug), and 6(Trace). Min=0, Max=6, Default=0

uint Port: UDP port to use with Stream Service.Min=1025, Max=65534, Default=6901

Read-Only Fields

bool Active: True if the Device is currently active,false otherwise. Default=false

Guid Guid or DeviceId: Read-only GUID that uniquelyidentifies this Device.

PvsPhysicalAddress DeviceMac: Ethernet address canhave the form XX-XX-XX-XX-XX-XX. Uniquely identifies the Device.

string Name or DeviceName: Computer name with nospaces. ASCII computer name characters Max Length=15

Guid DiskLocatorId: GUID of the Disk Locator toupdate with this Device.

string DiskLocatorName: Name of the Disk LocatorFile to update with this Device.

uint DiskVersion: Read-only version of the DiskLocator File that the Device is using. It is equal to 0 if the Device is notactive. Default=0

System.Net.IPAddress Ip: Read-only IP of the Device.It is equal to 0.0.0.0 if the Device is not active.

uint License: Oem Only: Read-only type of thelicense. Values are 0 when None, 1 or 2 when Desktop. It is equal to 0 if theDevice is not active. Default=0

uint LicenseType: 0 when None, 1 for Desktop, 2 forServer, 5 for OEM SmartClient, 6 for XenApp, 7 for XenDesktop. It is equal to 0if the Device is not active. Default=0

uint MakLicenseActivated: Read-only indicator if MAKlicensing is being used and is activated. Values are: 0 (MAK not used), 1 (NotActivated), 2 (Activated). It is equal to 0 if the Device is not active.Default=0

string Model: Oem Only: Read-only model of thecomputer. Values are OptiPlex 745, 755, 320, 760, FX160, or Default. It isequal to "" if the Device is not active.

Guid ServerId: Read-only GUID of the Server that theDevice is using. It is equal to 00000000-0000-0000-0000-000000000000 if theDevice is not active.

System.Net.IPAddress ServerIpConnection: Read-onlyIP of the Server that the Device is using. It is equal to 0.0.0.0 if the Deviceis not active.

string ServerName: Read-only Name of the Server thatthe Device is using. It is equal to "" if the Device is not active.

uint ServerPortConnection: Read-only Port of theServer that the Device is using. It is equal to 0 if the Device is not active.Default=0

Guid SiteId: GUID of the Site this Disk UpdateDevice is to be a member of.

string SiteName: Name of the Site this Disk UpdateDevice is to be a member of.

string Status: 1 or 2 numbers in the format n,n.They are the number of retries and if ram cache is being used, ram cachepercent used. It is equal to "" if the Device is not active.

Guid StoreId: GUID of the Store that the DiskLocator is a member of.

string StoreName: Name of the Store that the DiskLocator is a member of.

Guid VirtualHostingPoolId: GUID of the VirtualHosting Pool. It is not used with VirtualHostingPoolName.Default=00000000-0000-0000-0000-000000000000

string VirtualHostingPoolName: Name of the VirtualHosting Pool.

PvsDiskUpdateStatus

Read-Only Fields

uint CurrentStatus: Current status of the update.Values are: 0 (Ready), 1 (Update Pending), 2 (Preparing Image), 3 (StartingVM), 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

string CurrentStatusMessage: Message string thatincludes the results of the run. Default="" Max Length=255

string Description: User description of the UpdateTask.

Guid DeviceId: GUID that Device being used to do theupdate.

string DeviceName: Name of the Device being used todo the update.

Guid DiskLocatorId: GUID of the Disk Locator toupdate.

string Name or DiskLocatorName: Name of the DiskLocator File to update.

Guid Guid or DiskUpdateTaskId: GUID that uniquelyidentifies this Update Task and Device relationship.

uint PreviousResult: Status of the last run. Valuesare: 0 (Ready), 1 (Update Pending), 2 (Preparing Image), 3 (Starting VM), 4(Update In Progress), 5 (Stopping VM), 6 (Submitting Image), 7 (RevertingImage), 8 (Invalid), 9 (Aborted), 10 (Completed Successfully), 11 (No Updates)Min=0, Max=11, Default=0

string PreviousResultMessage: Message string thatincludes the results of the last run. Default="" Max Length=255

Guid SiteId: GUID of the Site that this Update TaskName is a member of.

string SiteName: Name of the Site that this UpdateTask Name is a member of.

Guid StoreId: GUID of the Store that the DiskLocator is a member of.

string StoreName: Name of the Store that the DiskLocator is a member of.

Guid UpdateTaskId: GUID that uniquely identifies theUpdate Task.

string UpdateTaskName: Name of the Update Task.

Guid VirtualHostingPoolId: GUID of the VirtualHosting Pool being used for the update.

string VirtualHostingPoolName: Name of the VirtualHosting Pool being used for the update.

PvsDiskVersion

Read/Write Fields

string Description: User description.Default="" Max Length=250

DateTime ScheduledDate: Date/Time that the DiskVersion is scheduled to become available. Has the date, hour and minute. Emptywhen the disk version is made available immediately. Default=Empty

Read-Only Fields

uint Access: 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

bool CanDelete: Read-only true when the version canbe deleted. Default=false

bool CanMerge: Read-only true when the version canbe update merged. Will be set for the highest version number. Default=false

bool CanMergeBase: Read-only true when the versioncan be base merged. Will be set for the highest version number. Default=false

bool CanOverride: Read-only true when the versioncan be set as the Override. Default=false

bool CanPromote: Read-only true when the version canbe promoted. Default=false

bool CanRevertMaintenance: Read-only true when theversion can be reverted to Maintenance Access. Default=false

bool CanRevertTest: Read-only true when the versioncan be reverted to Test Access. Default=false

bool CanSetScheduledDate: Read-only true when theversion can have the scheduled date modified. Default=false

string CreateDate: Read-only Date/Time that the DiskVersion was created. Default=getdate

bool DeleteWhenFree: Read-only true if the DiskVersion is no longer needed because of a merge. If not current booted by aDevice, it can be deleted. Default=false

uint DeviceCount: Read-only count of Devices.Default=0

string Name or DiskFileName: Name of the Disk Fileincluding the extension. Default=""

Guid Guid or DiskLocatorId: GUID of the DiskLocatorused for Get and Set.

bool GoodInventoryStatus: True when the up to datefile is accessible by all Servers, false otherwise. Default=false

bool IsPending: Read-only true when the versionScheduledDate has not occurred. Default=false

uint TaskId: When a Merge is occurring, this will beset with the task number of the process that is occurring. Default=""

bool TemporaryVersionSet: Read-only true whentemporary version(s) are set. Some changes cannot be made to the version whenthis is set. Default=false

uint Type: 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

uint Version: Read-only version number. The basedisk is version 0, the other version numbers are in part of the file name.Default=0

PvsFarm

Read/Write Fields

bool AuditingEnabled: True when Auditing is enabled,false otherwise. Default=false

bool AutoAddEnabled: True when Auto Add is enabled,false otherwise. Default=false

bool AutomaticMergeEnabled: True when AutomaticMerge is enabled, false otherwise. If the number of versions becomes more thanthe MaxVersions value, a merge will occur at the end of PromoteDiskVersion.Default=true

Guid DefaultSiteId: GUID of the Site to place newDevices into automatically. Not used with defaultSiteName.Default=00000000-0000-0000-0000-000000000000

string DefaultSiteName: Name of the Site to placenew Devices into automatically. Not used with DefaultSiteId.Default=""

string Description: User description.Default="" Max Length=250

string Name or FarmName: Name of the Farm.Default="" Max Length=50

DateTime LastAuditArchiveDate: Last date of AuditTrail data that was Archived. Has the date. Default=Empty

string LicenseServer: License server name.Default="" Max Length=255

uint LicenseServerPort: License server port.Min=1025, Max=65534, Default=27000

uint MaxVersions: Maximum number a versions of aDisk that can exist before a merge will automatically occur. Min=3, Max=50,Default=5

uint MergeMode: Mode to place the version in after amerge has occurred. Values are: 0 (Production), 1 (Test) and 2 (Maintenance).Min=0, Max=2, Default=2

bool OfflineDatabaseSupportEnabled: True whenOffline Database Support is enabled, false otherwise. Default=false

Read-Only Fields

bool AdGroupsEnabled: Active Directory groups areused for authorization, when set to true. Windows groups are used when set tofalse. Default=false

string DatabaseInstanceName: Read-only name of thedatabase instance.

string DatabaseName: Read-only name of the database.

string DatabaseServerName: Read-only name of thedatabase server.

string FailoverPartnerInstanceName: Read-only nameof the database server instance.

string FailoverPartnerServerName: Read-only name ofthe database server.

Guid Guid or FarmId: Read-only GUID that uniquelyidentifies this Farm.

string MultiSubnetFailover: Read-only DatabaseMultiSubnetFailover value

uint Role: Read-only Role of the user for this item.100 is Farm Administrator, and 999 is read-only. Default=999

PvsFarmView

Read/Write Fields

string Description: User description.Default="" Max Length=250

string Name or FarmViewName: name of the Farm View.Max Length=50

Read-Only Fields

uint ActiveDeviceCount: Read-only count of activeDevices in this Farm View. Default=0

uint DeviceCount: Read-only count of Devices in thisFarm View. Default=0

Guid Guid or FarmViewId: Read-only GUID thatuniquely identifies this Farm View.

uint MakActivateNeededCount: Read-only count ofactive Devices that need MAK activation in this Farm View. Default=0

PvsGroup

Read-Only Fields

Guid Guid: GUID of the Active Directory group.00000000-0000-0000-0000-000000000000 for Windows groups.

string Name: Name of the Group.

PvsLocalServer

Read-Only Field

string Name or LocalServer: NetBios name of local server.

PvsNewDiskVersion

Read-Only Fields

string Name: Name of the disk file without theextension.

uint Status: Status of the disk file. Values are: 0(Valid), 1 (Missing Properties File), 2 (Access Denied), 3 (Access Denied andMissing Properties File), 4 (Invalid Disk File), 5 (Manifest Invalid)

PvsPhysicalAddress

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

PvsServer

Read/Write Fields

uint AdMaxPasswordAge: Number of days before apassword expires. Min=1, Max=30, Default=7

bool AdMaxPasswordAgeEnabled: Age the password, whenset to true. Default=false

uint BootPauseSeconds: Number of seconds that aDevice will pause during login if its server busy. Min=1, Max=60, Default=10

uint BuffersPerThread: Number of buffers per workerthread. Min=1, Max=128, Default=24

uint BusyDbConnectionRetryCount: Number of times afailed database connection will be retried. Min=0, Max=32767, Default=2

uint BusyDbConnectionRetryInterval: Interval, in numberof milliseconds, the server should wait before retrying to connect to adatabase. Min=0, Max=10000, Default=25

string Description: User description.Default="" Max Length=250

bool EventLoggingEnabled: Enable event logging, whenset to true. Default=false

uint FirstPort: Number of the first UDP port for useby the Stream Service, First and Last must allow at least 5 ports. Min=1025,Max=65534, Default=6910

uint InitialQueryConnectionPoolSize: Initial size ofdatabase connection pool for non-transactional queries. Min=1, Max=1000,Default=50

uint InitialTransactionConnectionPoolSize: Initialsize of database connection pool for transactional queries. Min=1, Max=1000,Default=50

uint IoBurstSize: Number of bytes read/writes cansend in a burst of packets. Required thatIoBurstSize/(MaxTransmissionUnits-76)<=32. Min=4096, Max=61440,Default=32768

System.Net.IPAddress[] Ip: One or more streaming ipaddresses.

DateTime LastBugReportAttempt: Time that this serverlast attempted to upload or generate a bug report bundle. Default=Empty

string LastBugReportResult: Status of the last bugreport on this server. Default="" Max Length=4000

string LastBugReportStatus: Status of the last bugreport on this server. Default="" Max Length=250

string LastBugReportSummary: Summary of the last bugreport on this server. Default="" Max Length=250

DateTime LastCeipUploadAttempt: Time that thisserver last attempted a CEIP upload. Default=Empty

uint LastPort: Number of the last UDP port for useby the Stream Service, First and Last must allow at least 5 ports. Min=1025,Max=65534, Default=6930

uint LicenseTimeout: Amount of seconds before alicense times out. Min=15, Max=300, Default=30

uint LocalConcurrentIoLimit: Maximum concurrent IOtransactions it performs for vDisks that are local. A value of 0 disables thefeature. Min=0, Max=128, Default=4

uint LogFileBackupCopiesMax: Maximum number of logfile backups. Min=1, Max=50, Default=4

uint LogFileSizeMax: Maximum size log files canreach in Megabytes. Min=1, Max=50, Default=5

uint LogLevel: Level to perform logging at. Valuesare: 0 (None), 1 (Fatal), 2 (Error), 3 (Warning), 4 (Info), 5 (Debug), and 6(Trace). Min=0, Max=6, Default=4

uint MaxBootDevicesAllowed: Maximum number ofDevices allowed to boot simultaneously. Min=1, Max=1000, Default=500

uint MaxBootSeconds: Maximum number of seconds for aDevice to boot. Min=10, Max=900, Default=60

uint MaxQueryConnectionPoolSize: Maximum size ofdatabase connection pool for non-transactional queries. Min=1, Max=32767,Default=1000

uint MaxTransactionConnectionPoolSize: Maximum sizeof database connection pool for transactional queries. Min=1, Max=32767,Default=1000

uint MaxTransmissionUnits: Ethernet maximumtransmission unit size for the protocol for use for Server and Device. Requiredthat IoBurstSize/(MaxTransmissionUnits-76)<=32. Min=502, Max=16426,Default=1506

bool NonBlockingIoEnabled: Use non-Blocking IO, whenset to true. Default=true

float PowerRating: A strictly relative rating ofthis Server's capabilities when compared to other Servers in the Store(s) itbelongs too; can be used to help tune load balancing. Min=0.1, Max=1000,Default=1

uint RamDiskInvitationPeriod: The amount of time inseconds that invitations are sent to Devices. Min=1, Max=300, Default=10

bool RamDiskInvitationType: Either false for Fixed,or true for Variable. Default=false

System.Net.IPAddress RamDiskIpAddress: IP address touse for transferring the RAM Disk. When equal to 0.0.0.0 the server IP is usedwith the first part replaced with 233. Default=0.0.0.0

uint RamDiskTimeToLive: Time to live for theinvitation packet sent to Devices. Min=1, Max=255, Default=1

uint RefreshInterval: Interval, in number ofseconds, the server should wait before refreshing settings. If set to 0, unuseddatabase connections are never released. Min=0, Max=32767, Default=300

uint RemoteConcurrentIoLimit: Maximum concurrent IOtransactions it performs for vDisks that are remote. A value of 0 disables thefeature. Min=0, Max=128, Default=4

uint ServerCacheTimeout: Number of seconds to waitbefore considering another Server is down. Min=5, Max=60, Default=8

string Name or ServerName: Computer name with nospaces. ASCII computer name characters Max Length=21

uint ThreadsPerPort: Number of worker threads per IOport. Required that (threadPerPort * numberPorts * numberIPs) <= 1000.Min=1, Max=60, Default=8

uint UnusedDbConnectionTimeout: Interval, in numberof seconds, a connection should go unused before it is to be released. Min=0,Max=32767, Default=300

uint VDiskCreatePacing: VDisk create time pacing inmiliseconds. Min=0, Max=5, Default=0

Read-Only Fields

uint Active: 1 if the Server is currently active, 2if unknown, and 0 otherwise. Min=0, Max=2, Default=0

System.Net.IPAddress ManagementIp: IP address usedfor management communications between Servers. Default=0.0.0.0

uint Role: Read-only Role of the user for this item.100 is Farm Administrator, and 200 is Site Administrator. Default=999

string ServerFqdn: Read-only fully qualified domainname. Default="" Max Length=1024

Guid Guid or ServerId: Read-only GUID that uniquelyidentifies this Server.

Guid SiteId: GUID of the Site this Server is to be amember of. It is not used with SiteName.

string SiteName: Name of the Site this Server is tobe a member of. It is not used with SiteId.

PvsServerBiosBootstrap

Read/Write Fields

bool BootFromHdOnFail: For network recovery rebootto hard drive when set to true, restore network connection when set to false.Default=false

System.Net.IPAddress Bootserver1_Ip: 1st boot serverIP. Only used when Lookup is false.

uint Bootserver1_Port: 1st boot server port. Onlyused when Lookup is false. Min=1025, Max=65536, Default=6910

System.Net.IPAddress Bootserver2_Ip: 2nd boot serverIP. Only used when Lookup is false. Default=0.0.0.0

uint Bootserver2_Port: 2nd boot server port. Onlyused when Lookup is false. Min=1025, Max=65536, Default=6910

System.Net.IPAddress Bootserver3_Ip: 3rd boot serverIP. Only used when Lookup is false. Default=0.0.0.0

uint Bootserver3_Port: 3rd boot server port. Onlyused when Lookup is false. Min=1025, Max=65536, Default=6910

System.Net.IPAddress Bootserver4_Ip: 4th boot serverIP. Only used when Lookup is false. Default=0.0.0.0

uint Bootserver4_Port: 4th boot server port. Onlyused when Lookup is false. Min=1025, Max=65536, Default=6910

bool DhcpEnabled: Use DHCP to retrieve target deviceIP when set to true, otherwise use the static domain, dnsIpAddresstrue anddnsIpAddress2 settings. Default=true

System.Net.IPAddress DnsIpAddress1: Primary DNSserver IP. Only used when DhcpEnabled is false.

System.Net.IPAddress DnsIpAddress2: Secondary DNSserver IP. Only used when DhcpEnabled is false.

string Domain: Domain of the primary and secondaryDNS servers. Only used when DhcpEnabled is false.

bool Enabled: Automatically update the BIOS on thetarget device with these setting when set to true, otherwise do not use thesesettings. Default=false

uint GeneralTimeout: Login general timeout inmilliseconds. Min=1000, Max=60000, Default=5000

bool InterruptSafeMode: Interrupt safe mode (use iftarget device hangs during boot) when set to true. Default=false

bool Lookup: Use DNS to find the Server when set totrue 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

bool PaeMode: PAE mode (use if PAE enabled inboot.ini of target device) when set to true. Default=false

uint PollingTimeout: Login polling timeout inmilliseconds. Min=1000, Max=60000, Default=5000

uint RecoveryTime: When bootFromHdOnFail is 1, thisis the number of seconds to wait before reboot to hard drive. Min=10,Max=60000, Default=50

string Name or ServerName: Host to use for DNSlookup. Only used when Lookup is true. Default=IMAGESERVER1

bool VerboseMode: Display verbose diagnosticinformation when set to true. Default=false

Read-Only Field

Guid Guid or ServerId: GUID of the Server used forGet and Set.

PvsServerBootstrap

Read/Write Fields

bool BootFromHdOnFail: For network recovery rebootto hard drive when set to true, restore network connection when set to false.Default=false

System.Net.IPAddress Bootserver1_Gateway: 1st bootserver gateway. Default=0.0.0.0

System.Net.IPAddress Bootserver1_Ip: 1st boot serverIP.

System.Net.IPAddress Bootserver1_Netmask: 1st bootserver netmask. Default=0.0.0.0

uint Bootserver1_Port: 1st boot server port.Min=1025, Max=65536, Default=6910

System.Net.IPAddress Bootserver2_Gateway: 2nd bootserver gateway. Default=0.0.0.0

System.Net.IPAddress Bootserver2_Ip: 2nd boot serverIP. Default=0.0.0.0

System.Net.IPAddress Bootserver2_Netmask: 2nd bootserver netmask. Default=0.0.0.0

uint Bootserver2_Port: 2nd boot server port.Min=1025, Max=65536, Default=6910

System.Net.IPAddress Bootserver3_Gateway: 3rd bootserver gateway. Default=0.0.0.0

System.Net.IPAddress Bootserver3_Ip: 3rd boot serverIP. Default=0.0.0.0

System.Net.IPAddress Bootserver3_Netmask: 3rd bootserver netmask. Default=0.0.0.0

uint Bootserver3_Port: 3rd boot server port. Min=1025,Max=65536, Default=6910

System.Net.IPAddress Bootserver4_Gateway: 4th bootserver gateway. Default=0.0.0.0

System.Net.IPAddress Bootserver4_Ip: 4th boot serverIP. Default=0.0.0.0

System.Net.IPAddress Bootserver4_Netmask: 4th bootserver netmask. Default=0.0.0.0

uint Bootserver4_Port: 4th boot server port.Min=1025, Max=65536, Default=6910

uint GeneralTimeout: Login general timeout inmilliseconds. Min=1000, Max=60000, Default=5000

bool InterruptSafeMode: Interrupt safe mode (use iftarget device hangs during boot) when set to true. Default=false

bool PaeMode: PAE mode (use if PAE enabled inboot.ini of target device) when set to true. Default=false

uint PollingTimeout: Login polling timeout inmilliseconds. Min=1000, Max=60000, Default=5000

uint RecoveryTime: When bootFromHdOnFail is 1, thisis the number of seconds to wait before reboot to hard drive. Min=10,Max=60000, Default=50

bool VerboseMode: Display verbose diagnosticinformation when set to true. Default=false

Read-Only Fields

string Name: Name of the bootstrap file used to Getand Set.

Guid Guid or ServerId: GUID of the Server used forGet and Set.

PvsServerBootstrapName

Read-Only Field

string Name: Bootstrap file name.

PvsServerInfo

Read-Only Fields

uint Active: 1 if the Server is currently active, 2if unknown, and 0 otherwise. Min=0, Max=2, Default=0

uint AdMaxPasswordAge: Number of days before apassword expires. Min=1, Max=30, Default=7

bool AdMaxPasswordAgeEnabled: Age the password, whenset to true. Default=false

uint BootPauseSeconds: Number of seconds that aDevice will pause during login if its server busy. Min=1, Max=60, Default=10

uint BuffersPerThread: Number of buffers per workerthread. Min=1, Max=128, Default=24

uint BusyDbConnectionRetryCount: Number of times afailed database connection will be retried. Min=0, Max=32767, Default=2

uint BusyDbConnectionRetryInterval: Interval, innumber of milliseconds, the server should wait before retrying to connect to adatabase. Min=0, Max=10000, Default=25

System.Net.IPAddress ContactIp: Read-only contact IPfor the Server.

string ContactPort: Read-only contact port for theServer.

string Description: User description.Default="" Max Length=250

uint DeviceCount: Read-only count of Devices.Default=0

bool EventLoggingEnabled: Enable event logging, whenset to true. Default=false

uint FirstPort: Number of the first UDP port for useby the Stream Service, First and Last must allow at least 5 ports. Min=1025,Max=65534, Default=6910

uint InitialQueryConnectionPoolSize: Initial size ofdatabase connection pool for non-transactional queries. Min=1, Max=1000,Default=50

uint InitialTransactionConnectionPoolSize: Initialsize of database connection pool for transactional queries. Min=1, Max=1000,Default=50

uint IoBurstSize: Number of bytes read/writes cansend in a burst of packets. Required thatIoBurstSize/(MaxTransmissionUnits-76)<=32. Min=4096, Max=61440,Default=32768

System.Net.IPAddress[] Ip: One or more streaming ipaddresses.

DateTime LastBugReportAttempt: Time that this serverlast attempted to upload or generate a bug report bundle. Default=Empty

string LastBugReportResult: Status of the last bugreport on this server. Default="" Max Length=4000

string LastBugReportStatus: Status of the last bugreport on this server. Default="" Max Length=250

string LastBugReportSummary: Summary of the last bugreport on this server. Default="" Max Length=250

DateTime LastCeipUploadAttempt: Time that thisserver last attempted a CEIP upload. Default=Empty

uint LastPort: Number of the last UDP port for useby the Stream Service, First and Last must allow at least 5 ports. Min=1025,Max=65534, Default=6930

uint LicenseTimeout: Amount of seconds before alicense times out. Min=15, Max=300, Default=30

uint LocalConcurrentIoLimit: Maximum concurrent IO transactionsit performs for vDisks that are local. A value of 0 disables the feature.Min=0, Max=128, Default=4

uint LogFileBackupCopiesMax: Maximum number of logfile backups. Min=1, Max=50, Default=4

uint LogFileSizeMax: Maximum size log files canreach in Megabytes. Min=1, Max=50, Default=5

uint LogLevel: Level to perform logging at. Valuesare: 0 (None), 1 (Fatal), 2 (Error), 3 (Warning), 4 (Info), 5 (Debug), and 6(Trace). Min=0, Max=6, Default=4

System.Net.IPAddress ManagementIp: IP address usedfor management communications between Servers. Default=0.0.0.0

uint MaxBootDevicesAllowed: Maximum number ofDevices allowed to boot simultaneously. Min=1, Max=1000, Default=500

uint MaxBootSeconds: Maximum number of seconds for aDevice to boot. Min=10, Max=900, Default=60

uint MaxQueryConnectionPoolSize: Maximum size ofdatabase connection pool for non-transactional queries. Min=1, Max=32767,Default=1000

uint MaxTransactionConnectionPoolSize: Maximum sizeof database connection pool for transactional queries. Min=1, Max=32767,Default=1000

uint MaxTransmissionUnits: Ethernet maximumtransmission unit size for the protocol for use for Server and Device. Requiredthat IoBurstSize/(MaxTransmissionUnits-76)<=32. Min=502, Max=16426,Default=1506

bool NonBlockingIoEnabled: Use non-Blocking IO, whenset to true. Default=true

float PowerRating: A strictly relative rating ofthis Server's capabilities when compared to other Servers in the Store(s) itbelongs too; can be used to help tune load balancing. Min=0.1, Max=1000,Default=1

uint RamDiskInvitationPeriod: The amount of time inseconds that invitations are sent to Devices. Min=1, Max=300, Default=10

bool RamDiskInvitationType: Either false for Fixed,or true for Variable. Default=false

System.Net.IPAddress RamDiskIpAddress: IP address touse for transferring the RAM Disk. When equal to 0.0.0.0 the server IP is usedwith the first part replaced with 233. Default=0.0.0.0

uint RamDiskTimeToLive: Time to live for theinvitation packet sent to Devices. Min=1, Max=255, Default=1

uint RefreshInterval: Interval, in number ofseconds, the server should wait before refreshing settings. If set to 0, unuseddatabase connections are never released. Min=0, Max=32767, Default=300

uint RemoteConcurrentIoLimit: Maximum concurrent IO transactionsit performs for vDisks that are remote. A value of 0 disables the feature.Min=0, Max=128, Default=4

uint Role: Read-only Role of the user for this item.100 is Farm Administrator, and 200 is Site Administrator. Default=999

uint ServerCacheTimeout: Number of seconds to waitbefore considering another Server is down. Min=5, Max=60, Default=8

string ServerFqdn: Read-only fully qualified domainname. Default="" Max Length=1024

Guid Guid or ServerId: Read-only GUID that uniquelyidentifies this Server.

string Name or ServerName: Computer name with nospaces. ASCII computer name characters Max Length=21

Guid SiteId: GUID of the Site this Server is to be amember of. It is not used with SiteName.

string SiteName: Name of the Site this Server is tobe a member of. It is not used with SiteId.

uint ThreadsPerPort: Number of worker threads per IOport. Required that (threadPerPort * numberPorts * numberIPs) <= 1000.Min=1, Max=60, Default=8

uint UnusedDbConnectionTimeout: Interval, in numberof seconds, a connection should go unused before it is to be released. Min=0,Max=32767, Default=300

uint VDiskCreatePacing: VDisk create time pacing inmiliseconds. Min=0, Max=5, Default=0

PvsServerStatus

Read-Only Fields

uint DeviceCount: Read-only count of Devices. Default=0

System.Net.IPAddress Ip: Read-only contact IP forthe Server.

uint Port: Read-only contact port for the Server.

Guid Guid or ServerId: Read-only GUID of the Server.Can be used with Get Server.

string Name or ServerName: Read-only Name of the Server.Can be used with Get Server.

uint Status: Status of the server, 0 if down, 1 ifup and 2 if unknown. Default=0

PvsServerStore

Read/Write Fields

string[] CachePath: Cache path(s) that the Serveruses with the Store. If none are specified the caches will be placed in theStore cachePath. Default=None

string Path: Directory path that the Server uses toaccess the Store. Default="" Max Length=255

Read-Only Fields

Guid ServerId: GUID of the server that uses theStore. ServerName can be used instead.

string ServerName: Name of the server that uses theStore. ServerId can be used instead.

Guid StoreId: GUID of the Store. StoreName can beused instead.

string StoreName: Name of the Store. StoreId can beused instead.

PvsSite

Read/Write Fields

Guid DefaultCollectionId: GUID of the Collection toplace new Devices into automatically. Not used with defaultCollectionName.Default=00000000-0000-0000-0000-000000000000

string DefaultCollectionName: Name of the Collectionto place new Devices into automatically. Not used with DefaultCollectionId.Default=""

string Description: User description.Default="" Max Length=250

Guid DiskUpdateServerId: GUID of the Disk UpdateServer for the Site. Not used with DiskUpdateServerName.Default=00000000-0000-0000-0000-000000000000

string DiskUpdateServerName: Name of the Disk UpdateServer for the Site. Not used with DiskUpdateServerId. Default=""

bool EnableDiskUpdate: True when Disk Updated isenabled for the Site, false otherwise. Default=false

uint InventoryFilePollingInterval: The number ofseconds between polls for Disk changes in the Stores. Min=1, Max=600,Default=60

string MakPassword: User password used for MAKactivation. Default="" Max Length=64

string MakUser: User name used for MAK activation.Default="" Max Length=64

string Name or SiteName: Name of the Site. MaxLength=50

Read-Only Fields

uint Role: 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 Guid or SiteId: Read-only GUID that uniquelyidentifies this Site.

PvsSiteView

Read/Write Fields

string Description: User description.Default="" Max Length=250

string Name or SiteViewName: Name of the Site View.Max Length=50

Read-Only Fields

uint ActiveDeviceCount: Read-only count of activeDevices in this Site View. Default=0

uint DeviceCount: Read-only count of Devices in thisSite View. Default=0

uint DeviceWithPVDCount: Read-only count of Deviceswith Personal vDisk in this Site View. Default=0

uint MakActivateNeededCount: Read-only count ofactive Devices that need MAK activation in this Site View. Default=0

uint Role: Read-only Role of the user for this item.100 is Farm Administrator, and 200 is Site Administrator. Default=999

Guid SiteId: GUID of the Site this View is to be amember of. It is not used with SiteName.

string SiteName: Name of the Site this View is to bea member of. It is not used with SiteId.

Guid Guid or SiteViewId: Read-only GUID thatuniquely identifies this Site View.

PvsStore

Read/Write Fields

string[] CachePath: Default Cache path(s) that theServers use with this Store. If none are specified the caches will be placed inthe WriteCache subdirectory of the Store path. Default=None

string Description: User description.Default="" Max Length=250

string Path: Default directory path that the Serversuse to access this Store. Max Length=255

Guid SiteId: GUID of the Site where Administratorsof that Site can change this Store. Not used for Farm Stores. SiteName can beused instead. Default=00000000-0000-0000-0000-000000000000

string SiteName: Name of the Site whereAdministrators of that Site can change this Store. Not used for Farm Stores.SiteId can be used instead. Default=""

string Name or StoreName: Name of the Store. MaxLength=50

Read-Only Fields

string PathType: Read-only field indicating if thevdisks are on a server's local hard disk or on a remote share.

uint Role: 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 Guid or StoreId: Read-only GUID that uniquelyidentifies this Store.

PvsStoreSharedOrServerPath

Read-Only Fields

string Path: Directory path that the Servers use toaccess this Store.

Guid StoreId: GUID of the Store.

string StoreName: Name of the Store.

PvsTask

Read-Only Fields

string Command: Command being processed.Default="" Max Length=50

string CommandType: Type of the command. Values are:Add, Delete, Get, Info, Run, RunWithReturn, Set and SetList.Default="" Max Length=13

DateTime ExpirationTime: Time the task record may beremoved from the database if the task does not complete. Has the date and timewithout milliseconds.

uint Handle: Handle to a running function.

System.Net.IPAddress Ip: IP Address of the remotehost.

string MapiException: Exception result in XMLformat. Default=""

uint Port: Port number of the remote service.

string Results: Result in XML format.Default=""

string ServerFqdn: Qualified name of the server.Default="" Max Length=1024

Guid SiteId: GUID of the Site that this Task isbeing processed in. Default=00000000-0000-0000-0000-000000000000

string SiteName: Name of the Site that that thisTask is being processed in.

DateTime StartTime: Time the task was started. Hasthe date and time without milliseconds.

uint State: State of the Task. Values are: 0(Processing), 1 (Cancelled), and 2 (Complete). Min=0, Max=2

uint TaskId: Unique ID of the task.

PvsUndefinedDisk

Read-Only Fields

bool VHDX: If VHDX is true, the format of the imageis VHDX. Otherwise it is VHD. Default=false

string Name: Name of the disk file without theextension.

uint Status: Status of the disk file. Values are: 0(Valid), 1 (Missing Properties File), 2 (Access Denied), 3 (Access Denied andMissing Properties File), 4 (Invalid Disk File), 5 (Manifest Missing orInvalid), 6 (Both VHD and VHDX)

PvsUpdateTask

Read/Write Fields

uint[] Date: Days of the month. Numbers from 1-31are the only valid values. This is used with Monthly Date recurrence.Default="" Max Length=83

uint DayMask: 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

string Description: User description.Default="" Max Length=250

string Domain: Domain to add the Disk UpdateDevice(s) to. If not included, the first Domain Controller found on the Serveris used. Default="" Max Length=255

bool Enabled: True when it will be processed, falseotherwise. Default=true

string EsdType: Esd to use. Valid values are SCCM orWSUS. If no value, a custom script is run on the client. Default=""Max Length=50

uint Hour: The hour of the day to perform the task.Min=0, Max=23, Default=0

uint Minute: The minute of the hour to perform thetask. Min=0, Max=59, Default=0

uint MonthlyOffset: When to happen monthly. 0 =None, 1 = First, 2 = Second, 3 = Third, 4 = Forth, 5 = Last. This is used withMonthly Type recurrence. Min=0, Max=5, Default=3

string OrganizationUnit: Organizational Unit to addthe Disk Update Device(s) to. This parameter is optional. If it is notspecified, the device is added to the built in Computers container. Child OU'sshould 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 acomma is still supported, but deprecated. Note that in this case, the child OUcomes first, e.g. "ChildOU,ParentOU". Default="" MaxLength=255

uint PostUpdateApprove: Access to place the versionin after the update has occurred. 0 = Production, 1 = Test, 2 = Maintenance.Min=0, Max=2, Default=0

string PostUpdateScript: Script file to run afterthe update finishes. Default="" Max Length=255

string PostVmScript: Script file to run after the VMis unloaded. Default="" Max Length=255

string PreUpdateScript: Script file to run beforethe update starts. Default="" Max Length=255

string PreVmScript: Script file to run before the VMis loaded. Default="" Max Length=255

uint Recurrence: The update will reoccur on thisschedule. 0 = None, 1 = Daily, 2 = Every Weekday, 3 = Weekly, 4 = Monthly Date,5 = Monthly Type. Min=0, Max=5, Default=0

string Name or UpdateTaskName: Name of the UpdateTask. It is unique within the Site. Max Length=50

Read-Only Fields

Guid SiteId: GUID of the Site that this Update Taskis a member of. It is not used with SiteName.

string SiteName: Name of the Site that this UpdateTask is a member of. It is not used with SiteId.

Guid Guid or UpdateTaskId: Read-only GUID thatuniquely identifies this Update Task.

PvsVersion

Read-Only Fields

string DbEdition: Edition of the database. If'Express Edition', monitor dbSize.

uint DbSize: Size of the database in MB. Monitorthis value if the edition is 'Express Edition' and this value is close toreaching the 4000 MB maximum. Default=0

uint DbVersion: Version of the database schema as anumber. Default=0

string MapiVersion: Version of the system inmajor.minor.point.build format.

uint MapiVersionNumber: Internal version number ofthe system. It is a number that is increaed by 100 for each major and minorrelease. Point releases are the numbers between each 100. Value is 0 when thesystem does not support MapiVersionNumber. Default=0

string SdkVersion: Version of the SDK inmajor.minor.build format.

uint Type: Type of system. Values are 0 (Normal), 1(OROM), and 2 (Secure). Default=0

PvsVirtualHostingPool

Read/Write Fields

string Datacenter: Datacenter of the Virtual HostingPool. Default="" Max Length=250

string Description: User description.Default="" Max Length=250

string Password: Password to use when logging intothe Server.

uint Port: Port of the Host Server. Min=80,Max=65534, Default=80

bool PrepopulateEnabled: Enable prepopulate when setto true Default=false

string Server: Name or IP of the Host Server. MaxLength=255

uint ShutdownTimeout: Timeout for shutdown. Min=2,Max=30, Default=10

uint Type: Type of the Virtual Hosting Pool. 0 =Citrix XenServer, 1 = Microsoft SCVMM/Hyper-V, 2 = VMWare vSphere/ESX. Min=0,Max=2, Default=0

uint UpdateLimit: Number of updates at the sametime. Min=2, Max=1000, Default=1000

uint UpdateTimeout: Timeout for updates. Min=2,Max=240, Default=60

string UserName: Name to use when logging into theServer.

string Name or VirtualHostingPoolName: Name of theVirtual Hosting Pool. It is unique within the Site. Max Length=50

Guid XdHostingUnitUuid: UUID of XenDesktop HostingUnit Default=00000000-0000-0000-0000-000000000000

bool XsPvsProxyEnabled: Enable XenServer PVS proxywhen set to true Default=false

Guid XsPvsSiteUuid: UUID of XenServerPVS_site Default=00000000-0000-0000-0000-000000000000

Read-Only Fields

Guid SiteId: GUID of the Site that this VirtualHosting Pool is a member of. It is not used with SiteName.

string SiteName: Name of the Site that this VirtualHosting Pool is a member of. It is not used with SiteId.

Guid Guid or VirtualHostingPoolId: Read-only GUIDthat uniquely identifies this Virtual Hosting Pool.

PvsXDSite

Read/Write Field

string[] ConfigServices: XenDesktop Serveraddresses. Max Length=2000

Read-Only Field

Guid Guid or XdSiteId: GUID of the XenDesktop Site.

Cmdlets

Add-PvsDeviceToDomain

Add a Device, all Devices in a Collection or View toa Domain.

One of these required

Guid[] Guid or DeviceId: GUID of the Device to Addto the Domain.

string[] Name or DeviceName: Name of the Device toAdd to the Domain.

PvsPhysicalAddress[] DeviceMac: MAC of the Device toAdd to the Domain.

Guid[] CollectionId: GUID of the Collection to Addall Devices to the Domain.

Guid[] SiteViewId: GUID of the Site View to Add allDevices to the Domain.

Guid[] FarmViewId: GUID of the Farm View to Add allDevices to the Domain.

string[] FarmViewName: Name of the Farm View to Addall Devices to the Domain.

or one of these required ; resolutions

string[] CollectionName: Name of the Collection toAdd all Devices to the Domain.

string[] SiteViewName: Name of the Site View to Addall Devices to the Domain.

Optional

string[] Domain: Domain to add the Device(s) to. Ifnot included, the first Domain Controller found on the Server is used.

string[] OrganizationUnit: Organizational Unit toadd the Device(s) to. This parameter is optional. If it is not specified, thedevice is added to the built in Computers container. Child OU's should bedelimited with forward slashes, e.g. "ParentOU/ChildOU". Specialcharacters 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 acomma is still supported, but deprecated. Note that in this case, the child OUcomes first, e.g. "ChildOU,ParentOU".

One of these resolutions when needed

Guid[] SiteId: GUID of the Site.

string[] SiteName: Name of the Site.

Instead of a parameter that matches one of themembers listed

PvsObject[] Object: PvsObjects with the membersbelow can be used as the Object parameter or from a pileline:

DeviceId, CollectionId, SiteViewId or FarmViewId

Optional

SwitchParameter Confirm: The impact of thisoperation is "low". If -Confirm is specified, the operation will beconfirmed. $ConfirmPreference can be set to "low" to haveconfirmation without the Confirm parameter.

EXAMPLE 1: Add-PvsDeviceToDomain for Name with Domain and OrganizationUnit

Add-PvsDeviceToDomain -Name theDevice -DomaintheDomain -OrganizationUnit theOrganizationUnit

EXAMPLE 2: Add-PvsDeviceToDomain for PvsDevice Using Pipe

The Get-PvsDevice output is piped to theAdd-PvsDeviceToDomain.

Get-PvsDevice -Name theDevice -Fields Guid |Add-PvsDeviceToDomain -Domain theDomain -OrganizationUnit theOrganizationUnit

The -Fields parameter with only the needed fieldsspecified makes the Get work faster because only those fields are retrieved.

EXAMPLE 3: Add-PvsDeviceToDomain for FarmViewName with Domain andOrganizationUnit

Add-PvsDeviceToDomain -FarmViewName theFarmView-Domain theDomain -OrganizationUnit theOrganizationUnit

EXAMPLE 4: Add-PvsDeviceToDomain for PvsFarmView Using Pipe

The Get-PvsFarmView output is piped to theAdd-PvsDeviceToDomain.

Get-PvsFarmView -Name theFarmView -Fields Guid |Add-PvsDeviceToDomain -Domain theDomain -OrganizationUnit theOrganizationUnit

The -Fields parameter with only the needed fieldsspecified makes the Get work faster because only those fields are retrieved.

EXAMPLE 5: Add-PvsDeviceToDomain for CollectionName with Domain andOrganizationUnit

Add-PvsDeviceToDomain -CollectionName theCollection-SiteName theSite -Domain theDomain -OrganizationUnit theOrganizationUnit

CollectionId can be used instead of CollectionNameso that the SiteName or SiteId is not also needed.

EXAMPLE 6: Add-PvsDeviceToDomain for PvsCollection Using Pipe

The Get-PvsCollection output is piped to theAdd-PvsDeviceToDomain.

Get-PvsCollection -Name theCollection -SiteNametheSite -Fields Guid | Add-PvsDeviceToDomain -Domain theDomain-OrganizationUnit theOrganizationUnit

The -Fields parameter with only the needed fieldsspecified makes the Get work faster because only those fields are retrieved.

Guid can be used instead of Name so that theSiteName or SiteId is not also needed.

EXAMPLE 7: Add-PvsDeviceToDomain for SiteViewName with Domain andOrganizationUnit

Add-PvsDeviceToDomain -SiteViewName theSiteView-SiteName theSite -Domain theDomain -OrganizationUnit theOrganizationUnit

SiteViewId can be used instead of SiteViewName sothat the SiteName or SiteId is not also needed.

EXAMPLE 8: Add-PvsDeviceToDomain for PvsSiteView Using Pipe

The Get-PvsSiteView output is piped to theAdd-PvsDeviceToDomain.

Get-PvsSiteView -Name theSiteView -SiteName theSite-Fields Guid | Add-PvsDeviceToDomain -Domain theDomain -OrganizationUnittheOrganizationUnit

The -Fields parameter with only the needed fieldsspecified makes the Get work faster because only those fields are retrieved.

Guid can be used instead of Name so that theSiteName or SiteId is not also needed.

Add-PvsDeviceToView

Move a Device to a Collection. Personal vDiskDevices cannot be moved to a Collection in another Site.

One of these required

Guid[] Guid or DeviceId: GUID of the Device to Add.

string[] Name or DeviceName: Name of the Device toAdd.

PvsPhysicalAddress[] DeviceMac: MAC of the Device toAdd.

One of these required

Guid[] SiteViewId: GUID of the Site View to Add theDevice to.

Guid[] FarmViewId: GUID of the Farm View to Add theDevice to.

string[] FarmViewName: Name of the Farm View to Addthe Device to.

or this required ; resolution

string[] SiteViewName: Name of the Site View to Addthe Device to.

One of these resolutions when needed

Guid[] SiteId: GUID of the Site.

string[] SiteName: Name of the Site.

Instead of a parameter that matches one of themembers listed

PvsObject[] Object: PvsObjects with the membersbelow can be used as the Object parameter or from a pileline:

DeviceId, SiteViewId or FarmViewId

Optional

SwitchParameter Confirm: The impact of thisoperation is "low". If -Confirm is specified, the operation will beconfirmed. $ConfirmPreference can be set to "low" to haveconfirmation without the Confirm parameter.

EXAMPLE 1: Add-PvsDeviceToView for PvsDevice to PvsFarmView

Add-PvsDeviceToView -Name theDevice -PvsFarmViewNamethePvsFarmView

EXAMPLE 2: Add-PvsDeviceToView for PvsDevice Using Pipe

The Get-PvsDevice output is piped to theAdd-PvsDeviceToView.

Get-PvsDevice -Name theDevice -Fields Guid |Add-PvsDeviceToView -PvsFarmViewName thePvsFarmView

The -Fields parameter with only the needed fieldsspecified makes the Get work faster because only those fields are retrieved.

EXAMPLE 3: Add-PvsDeviceToView for PvsFarmView Using Pipe

The Get-PvsFarmView output is piped to theAdd-PvsDeviceToView.

Get-PvsFarmView -Name theFarmView -Fields Guid |Add-PvsDeviceToView -Name theDevice

The -Fields parameter with only the needed fieldsspecified makes the Get work faster because only those fields are retrieved.

EXAMPLE 4: Add-PvsDeviceToView for PvsDevice to PvsSiteView

Add-PvsDeviceToView -Name theDevice -SiteViewNametheSiteView -SiteName theSite

SiteViewId can be used instead of SiteViewName sothat the SiteName or SiteId is not also needed.

EXAMPLE 5: Add-PvsDeviceToView for PvsDevice Using Pipe

The Get-PvsDevice output is piped to theAdd-PvsDeviceToView.

Get-PvsDevice -Name theDevice -Fields Guid |Add-PvsDeviceToView -SiteViewName theSiteView -SiteName theSite

The -Fields parameter with only the needed fieldsspecified makes the Get work faster because only those fields are retrieved.

SiteViewId can be used instead of SiteViewName sothat the SiteName or SiteId is not also needed.

EXAMPLE 6: Add-PvsDeviceToView for PvsSiteView Using Pipe

The Get-PvsSiteView output is piped to theAdd-PvsDeviceToView.

Get-PvsSiteView -Name theSiteView -SiteName theSite-Fields Guid | Add-PvsDeviceToView -Name theDevice

The -Fields parameter with only the needed fieldsspecified makes the Get work faster because only those fields are retrieved.

Guid can be used instead of Name so that theSiteName or SiteId is not also needed.

Add-PvsDiskLocatorToDevice

Assign a Disk Locator to a Device, a Collection orView.

This required

Guid[] Guid or DiskLocatorId: GUID of the DiskLocator to Assign.

or this required ; resolution

string[] Name or DiskLocatorName: Name of the DiskLocator File to Assign.

One of these required

Guid[] DeviceId: GUID of the Device to Assign a DiskLocator.

string[] DeviceName: Name of the Device to Assign aDisk Locator.

PvsPhysicalAddress[] DeviceMac: MAC of the Device toAssign a Disk Locator.

Guid[] CollectionId: GUID of the Collection toAssign a Disk Locator or Locators to all Devices.

Guid[] SiteViewId: GUID of the Site View to Assign aDisk Locator to all Devices.

Guid[] FarmViewId: GUID of the Farm View to Assign aDisk Locator to all Devices.

string[] FarmViewName: Name of the Farm View toAssign a Disk Locator to all Devices.

or one of these required ; resolutions

string[] CollectionName: Name of the Collection toAssign a Disk Locator or Locators to all Devices.

string[] SiteViewName: Name of the Site View toAssign a Disk Locator to all Devices.

Optional

SwitchParameter RemoveExisting: If -RemoveExistingis specified, remove the existing Disk Locators before assigning the new one.

One of these resolutions when needed

Guid[] SiteId: GUID of the Site.

string[] SiteName: Name of the Site.

One of these resolutions when needed

Guid[] StoreId: GUID of the Store that is neededwhen a DiskLocatorName is used.

string[] StoreName: Name of the Store that is neededwhen a DiskLocatorName is used.

Instead of a parameter that matches one of themembers listed

PvsObject[] Object: PvsObjects with the membersbelow can be used as the Object parameter or from a pileline:

DiskLocatorId, DeviceId, CollectionId, SiteViewId orFarmViewId

Optional

SwitchParameter Confirm: The impact of thisoperation is "low". If -Confirm is specified, the operation will beconfirmed. $ConfirmPreference can be set to "low" to haveconfirmation without the Confirm parameter.

EXAMPLE 1: Add-PvsDiskLocatorToDevice for PvsDiskLocator to PvsDevice

Add-PvsDiskLocatorToDevice -Name theDiskLocator-DeviceName theDevice -SiteName theSite -StoreName theStore

Guid can be used instead of Name so that theSiteName or SiteId and StoreName or StoreId are not also needed.

EXAMPLE 2: Add-PvsDiskLocatorToDevice for PvsDiskLocator Using Pipe

The Get-PvsDiskLocator output is piped to theAdd-PvsDiskLocatorToDevice.

Get-PvsDiskLocator -Name theDiskLocator -SiteNametheSite -StoreName theStore -Fields Guid | Add-PvsDiskLocatorToDevice-DeviceName theDevice

The -Fields parameter with only the needed fieldsspecified makes the Get work faster because only those fields are retrieved.

Guid can be used instead of Name so that theSiteName or SiteId and StoreName or StoreId are not also needed.

EXAMPLE 3: Add-PvsDiskLocatorToDevice for PvsDevice Using Pipe

The Get-PvsDevice output is piped to theAdd-PvsDiskLocatorToDevice.

Get-PvsDevice -Name theDevice -Fields Guid |Add-PvsDiskLocatorToDevice -Name theDiskLocator -SiteName theSite -StoreNametheStoreName

The -Fields parameter with only the needed fieldsspecified makes the Get work faster because only those fields are retrieved.

Guid can be used instead of Name so that theSiteName or SiteId and StoreName or StoreId are not also needed.

EXAMPLE 4: Add-PvsDiskLocatorToDevice for PvsDiskLocator to PvsCollection

Add-PvsDiskLocatorToDevice -Name theDiskLocator-CollectionName theCollection -SiteName theSite -StoreName theStore

EXAMPLE 5: Add-PvsDiskLocatorToDevice for PvsDiskLocator Using Pipe

The Get-PvsDiskLocator output is piped to theAdd-PvsDiskLocatorToDevice.

Get-PvsDiskLocator -Name theDiskLocator -SiteNametheSite -StoreName theStore -Fields Guid | Add-PvsDiskLocatorToDevice-CollectionName theCollection -SiteName theSite

The -Fields parameter with only the needed fieldsspecified makes the Get work faster because only those fields are retrieved.

EXAMPLE 6: Add-PvsDiskLocatorToDevice for PvsCollection Using Pipe

The Get-PvsCollection output is piped to theAdd-PvsDiskLocatorToDevice.

Get-PvsCollection -Name theCollection -SiteNametheSite -Fields Guid | Add-PvsDiskLocatorToDevice -Name theDiskLocator-SiteName theSite -StoreName theStoreName

The -Fields parameter with only the needed fieldsspecified makes the Get work faster because only those fields are retrieved.

EXAMPLE 7: Add-PvsDiskLocatorToDevice for PvsDiskLocator to PvsFarmView

Add-PvsDiskLocatorToDevice -Name theDiskLocator-FarmViewName theFarmView -SiteName theSite -StoreName theStore

Guid can be used instead of Name so that theSiteName or SiteId and StoreName or StoreId are not also needed.

EXAMPLE 8: Add-PvsDiskLocatorToDevice for PvsDiskLocator Using Pipe

The Get-PvsDiskLocator output is piped to theAdd-PvsDiskLocatorToDevice.

Get-PvsDiskLocator -Name theDiskLocator -SiteNametheSite -StoreName theStore -Fields Guid | Add-PvsDiskLocatorToDevice-FarmViewName theFarmView

The -Fields parameter with only the needed fieldsspecified makes the Get work faster because only those fields are retrieved.

Guid can be used instead of Name so that theSiteName or SiteId and StoreName or StoreId are not also needed.

EXAMPLE 9: Add-PvsDiskLocatorToDevice for PvsFarmView Using Pipe

The Get-PvsFarmView output is piped to theAdd-PvsDiskLocatorToDevice.

Get-PvsFarmView -Name theFarmView -Fields Guid |Add-PvsDiskLocatorToDevice -Name theDiskLocator -SiteName theSite -StoreName theStoreName

The -Fields parameter with only the needed fieldsspecified makes the Get work faster because only those fields are retrieved.

Guid can be used instead of Name so that theSiteName or SiteId and StoreName or StoreId are not also needed.

EXAMPLE 10: Add-PvsDiskLocatorToDevice for PvsDiskLocator to PvsSiteView

Add-PvsDiskLocatorToDevice -Name theDiskLocator-SiteViewName theSiteView -SiteName theSite -StoreName theStore

EXAMPLE 11: Add-PvsDiskLocatorToDevice for PvsDiskLocator Using Pipe

The Get-PvsDiskLocator output is piped to theAdd-PvsDiskLocatorToDevice.

Get-PvsDiskLocator -Name theDiskLocator -SiteNametheSite -StoreName theStore -Fields Guid | Add-PvsDiskLocatorToDevice-SiteViewName theSiteView -SiteName theSite

The -Fields parameter with only the needed fieldsspecified makes the Get work faster because only those fields are retrieved.

EXAMPLE 12: Add-PvsDiskLocatorToDevice for PvsSiteView Using Pipe

The Get-PvsSiteView output is piped to theAdd-PvsDiskLocatorToDevice.

Get-PvsSiteView -Name theSiteView -SiteName theSite-Fields Guid | Add-PvsDiskLocatorToDevice -Name theDiskLocator -SiteNametheSite -StoreName theStoreName

The -Fields parameter with only the needed fieldsspecified makes the Get work faster because only those fields are retrieved.

Add-PvsDiskToUpdateTask

Add a Disk to an Update Task.

This required

Guid[] Guid or DiskLocatorId: GUID of the DiskLocator to Assign.

or this required ; resolution

string[] Name or DiskLocatorName: Name of the DiskLocator File to Assign.

One of these required

Guid[] UpdateTaskId: GUID of the Update Task toAssign a Disk.

string[] UpdateTaskName: Name of the Update Task toAssign a Disk.

One of these resolutions when needed

Guid[] SiteId: GUID of the Site.

string[] SiteName: Name of the Site.

One of these resolutions when needed

Guid[] StoreId: GUID of the Store that is neededwhen a DiskLocatorName is used.

string[] StoreName: Name of the Store that is neededwhen a DiskLocatorName is used.

Instead of a parameter that matches one of themembers listed

PvsObject[] Object: PvsObjects with the membersbelow can be used as the Object parameter or from a pileline:

DiskLocatorId or UpdateTaskId

Optional

SwitchParameter Confirm: The impact of thisoperation is "low". If -Confirm is specified, the operation will beconfirmed. $ConfirmPreference can be set to "low" to haveconfirmation without the Confirm parameter.

EXAMPLE 1: Add-PvsDiskToUpdateTask for PvsDiskLocator to PvsUpdateTask

Add-PvsDiskToUpdateTask -Name theDiskLocator-UpdateTaskName theUpdateTask -SiteName theSite -StoreName theStore

UpdateTaskId can be used instead of UpdateTaskNameso that the SiteName or SiteId is not also needed.

EXAMPLE 2: Add-PvsDiskToUpdateTask for PvsDiskLocator Using Pipe

The Get-PvsDiskLocator output is piped to theAdd-PvsDiskToUpdateTask.

Get-PvsDiskLocator -Name theDiskLocator -SiteNametheSite -StoreName theStore -Fields Guid | Add-PvsDiskToUpdateTask-UpdateTaskName theUpdateTask -SiteName theSite

The -Fields parameter with only the needed fieldsspecified makes the Get work faster because only those fields are retrieved.

EXAMPLE 3: Add-PvsDiskToUpdateTask for PvsUpdateTask Using Pipe

The Get-PvsUpdateTask output is piped to theAdd-PvsDiskToUpdateTask.

Get-PvsUpdateTask -Name theUpdateTask -SiteNametheSite -Fields Guid | Add-PvsDiskToUpdateTask -Name theDiskLocator -SiteNametheSite -StoreName theStore

The -Fields parameter with only the needed fieldsspecified makes the Get work faster because only those fields are retrieved.

Add-PvsDiskVersion

Add one or more new Versions to a Disk. A manifestfile for the new Disk Version(s) must exist in the Store.

This required

Guid[] Guid or DiskLocatorId: GUID of the DiskLocator File to Add the new Disk Version(s) to.

or this required ; resolution

string[] Name or DiskLocatorName: Name of the DiskLocator File to Add the new Disk Version(s) to.

One of these resolutions when needed

Guid[] SiteId: GUID of the Site.

string[] SiteName: Name of the Site.

One of these resolutions when needed

Guid[] StoreId: GUID of the Store that is neededwhen a DiskLocatorName is used.

string[] StoreName: Name of the Store that is neededwhen a DiskLocatorName is used.

Instead of a parameter that matches one of themembers listed

PvsObject[] Object: PvsObjects with the membersbelow can be used as the Object parameter or from a pileline:

DiskLocatorId

Optional

SwitchParameter Confirm: The impact of thisoperation is "low". If -Confirm is specified, the operation will beconfirmed. $ConfirmPreference can be set to "low" to haveconfirmation without the Confirm parameter.

EXAMPLE 1: Add-PvsDiskVersion for Name

Add-PvsDiskVersion -Name theDiskLocator -SiteNametheSite -StoreName theStore

Guid can be used instead of Name so that theSiteName or SiteId and StoreName or StoreId are not also needed.

EXAMPLE 2: Add-PvsDiskVersion for PvsDiskLocator Using Pipe

The Get-PvsDiskLocator output is piped to theAdd-PvsDiskVersion.

Get-PvsDiskLocator -Name theDiskLocator -SiteNametheSite -StoreName theStore -Fields Guid | Add-PvsDiskVersion

The -Fields parameter with only the needed fieldsspecified makes the Get work faster because only those fields are retrieved.

Guid can be used instead of Name so that theSiteName or SiteId and StoreName or StoreId are not also needed.

Clear-PvsConnection

Closes the existing SoapServer connection, and if-Persist is specified the connection settings in the registry are removed.

Optional

SwitchParameter Persist: If -Persist is specified,clear the connection settings in the registry.

Optional

SwitchParameter Confirm: The impact of thisoperation is "low". If -Confirm is specified, the operation will beconfirmed. $ConfirmPreference can be set to "low" to haveconfirmation without the Confirm parameter.

EXAMPLE 1: Clear-PvsConnection

Clear-PvsConnection

EXAMPLE 2: Clear-PvsConnection with Persist

Clear-PvsConnection -Persist

Clear-PvsTask

Clear a single or all completed or cancelled Tasksin a Site or the whole Farm.

One of these optional

uint TaskId: Id of the Task to Clear.

Guid[] SiteId: Site Id of the Tasks to Clear.

string[] SiteName: Site Name of the Tasks to Clear.

Instead of a parameter that matches one of themembers listed

PvsObject[] Object: PvsObjects with the membersbelow can be used as the Object parameter or from a pileline:

TaskId or SiteId

Optional

SwitchParameter Confirm: The impact of thisoperation is "medium". If -Confirm is specified, the operation willbe confirmed. $ConfirmPreference can be set to "medium" or"low" to have confirmation without the Confirm parameter.

EXAMPLE 1: Clear-PvsTask for TaskId

Clear-PvsTask -TaskId 101

EXAMPLE 2: Clear-PvsTask for PvsTask Using Pipe

The Get-PvsTask output is piped to theClear-PvsTask.

Get-PvsTask -TaskId 101 -Fields -TaskId |Clear-PvsTask

The -Fields parameter with only the needed fieldsspecified makes the Get work faster because only those fields are retrieved.

EXAMPLE 3: Clear-PvsTask for SiteName

Clear-PvsTask -SiteName theSite

EXAMPLE 4: Clear-PvsTask for PvsTask Using Pipe

The Get-PvsTask output is piped to theClear-PvsTask.

Get-PvsTask -SiteName theSite -Fields -SiteId |Clear-PvsTask

The -Fields parameter with only the needed fieldsspecified makes the Get work faster because only those fields are retrieved.

Copy-PvsDeviceProperties

Copy properties of one Device to a Device, all theDevices in a Collection, Site View or Farm View.

One of these required

Guid DeviceIdFrom: GUID of the Device to Copy from.

string DeviceNameFrom: Name of the Device to Copyfrom.

PvsPhysicalAddress DeviceMacFrom: Mac of the Deviceto Copy from.

One of these required

Guid Guid or DeviceId: GUID of the Device to Copyto.

string Name or DeviceName: Name of the Device toCopy to.

PvsPhysicalAddress DeviceMac: MAC of the Device toCopy to.

Guid CollectionId: GUID of the Collection to Copyto.

Guid SiteViewId: GUID of the Site View to Copy to.

Guid FarmViewId: GUID of the Farm View to Copy to.

string FarmViewName: Name of the Farm View to Copyto.

or one of these required ; resolutions

string CollectionName: Name of the Collection toCopy to.

string SiteViewName: Name of the Site View to Copyto.

Optional

uint[] Properties: If not specified, all are copied.Properties to copy. Values are: 1 (Description), 2 (Class), 3 (Port), 4(Disabled), 5 (Boot Behavior), 6 (Disk Assignment), 7 (Personality), 8(Printer), 9 (Type), 10 (Authentication) and 11 (Logging).

One of these resolutions when needed

Guid SiteId: GUID of the Site.

string SiteName: Name of the Site.

Instead of a parameter that matches one of themembers listed

PvsObject[] Object: PvsObjects with the membersbelow can be used as the Object parameter or from a pileline:

DeviceId, CollectionId, SiteViewId or FarmViewId

Optional

SwitchParameter Confirm: The impact of thisoperation is "low". If -Confirm is specified, the operation will beconfirmed. $ConfirmPreference can be set to "low" to haveconfirmation without the Confirm parameter.

EXAMPLE 1: Copy-PvsDeviceProperties for Name

Copy-PvsDeviceProperties -DeviceNameFromtheDeviceFrom -Name theDeviceTo

EXAMPLE 2: Copy-PvsDeviceProperties for Name with Properties

Copy-PvsDeviceProperties -DeviceNameFromtheDeviceFrom -Name theDeviceTo -Properties 2, 3

EXAMPLE 3: Copy-PvsDeviceProperties for PvsDevice Using Pipe

The Get-PvsDevice output is piped to theCopy-PvsDeviceProperties.

Get-PvsDevice -Name theDeviceTo -Fields Guid |Copy-PvsDeviceProperties -DeviceNameFrom theDeviceFrom -Properties 2, 3

The -Fields parameter with only the needed fieldsspecified makes the Get work faster because only those fields are retrieved.

EXAMPLE 4: Copy-PvsDeviceProperties for Name

Copy-PvsDeviceProperties -DeviceMacFrom"00-11-22-33-44-55" -Name theDeviceTo

EXAMPLE 5: Copy-PvsDeviceProperties for Name with Properties

Copy-PvsDeviceProperties -DeviceMacFrom"00-11-22-33-44-55" -Name theDeviceTo -Properties 2, 3

EXAMPLE 6: Copy-PvsDeviceProperties for PvsDevice Using Pipe

The Get-PvsDevice output is piped to theCopy-PvsDeviceProperties.

Get-PvsDevice -Name theDeviceTo -Fields Guid |Copy-PvsDeviceProperties -DeviceMacFrom "00-11-22-33-44-55"-Properties 2, 3

The -Fields parameter with only the needed fieldsspecified makes the Get work faster because only those fields are retrieved.

EXAMPLE 7: Copy-PvsDeviceProperties for FarmViewName

Copy-PvsDeviceProperties -DeviceNameFromtheDeviceFrom -FarmViewName theFarmViewNameTo

EXAMPLE 8: Copy-PvsDeviceProperties for FarmViewName with Properties

Copy-PvsDeviceProperties -DeviceNameFromtheDeviceFrom -FarmViewName theFarmViewNameTo -Properties 2, 3

EXAMPLE 9: Copy-PvsDeviceProperties for PvsFarmView Using Pipe

The Get-PvsFarmView output is piped to theCopy-PvsDeviceProperties.

Get-PvsFarmView -Name theFarmViewTo -Fields Guid |Copy-PvsDeviceProperties -DeviceNameFrom theDeviceFrom -Properties 2, 3

The -Fields parameter with only the needed fieldsspecified makes the Get work faster because only those fields are retrieved.

EXAMPLE 10: Copy-PvsDeviceProperties for CollectionName

Copy-PvsDeviceProperties -DeviceNameFromtheDeviceFrom -CollectionName theCollectionNameTo -SiteName theSite

CollectionId can be used instead of CollectionNameso that the SiteName or SiteId is not also needed.

EXAMPLE 11: Copy-PvsDeviceProperties for CollectionName with Properties

Copy-PvsDeviceProperties -DeviceNameFromtheDeviceFrom -CollectionName theCollectionNameTo -SiteName theSite -Properties2, 3

CollectionId can be used instead of CollectionNameso that the SiteName or SiteId is not also needed.

EXAMPLE 12: Copy-PvsDeviceProperties for PvsCollection Using Pipe

The Get-PvsCollection output is piped to theCopy-PvsDeviceProperties.

Get-PvsCollection -Name theCollection -SiteNametheSite -Fields Guid | Copy-PvsDeviceProperties -DeviceNameFrom theDeviceFrom-Properties 2, 3

The -Fields parameter with only the needed fieldsspecified makes the Get work faster because only those fields are retrieved.

Guid can be used instead of Name so that theSiteName or SiteId is not also needed.

EXAMPLE 13: Copy-PvsDeviceProperties for SiteViewName

Copy-PvsDeviceProperties -DeviceNameFromtheDeviceFrom -SiteViewName theSiteViewNameTo -SiteName theSite

SiteViewId can be used instead of SiteViewName sothat the SiteName or SiteId is not also needed.

EXAMPLE 14: Copy-PvsDeviceProperties for SiteViewName with Properties

Copy-PvsDeviceProperties -DeviceNameFromtheDeviceFrom -SiteViewName theSiteViewNameTo -SiteName theSite -Properties 2,3

SiteViewId can be used instead of SiteViewName sothat the SiteName or SiteId is not also needed.

EXAMPLE 15: Copy-PvsDeviceProperties for PvsSiteView Using Pipe

The Get-PvsSiteView output is piped to theCopy-PvsDeviceProperties.

Get-PvsSiteView -Name theSiteView -SiteName theSite-Fields Guid | Copy-PvsDeviceProperties -DeviceNameFrom theDeviceFrom-Properties 2, 3

The -Fields parameter with only the needed fieldsspecified makes the Get work faster because only those fields are retrieved.

Guid can be used instead of Name so that theSiteName or SiteId is not also needed.

Copy-PvsDiskProperties

Copy properties of one Disk to a Disk.

This required

Guid DiskLocatorIdFrom: GUID of the Disk Locator toCopy from.

This required

Guid Guid or DiskLocatorId: GUID of the Disk Locatorto Copy to.

Optional

uint[] Properties: If not specified, all are copied.Properties to copy. Values are: 1 (Description), 2 (Class), 3 (Type), 4 (DiskMode), 5 (Auto Update), 6 (HA), 7 (Active Directory), 8 (Printer), 10(Version), 11 (Date), 12 (Author), 13 (Title), 14 (Company), 15 (InternalFilename), 16 (Original Filename), 17 (Hardware Target), 18 (Menu Text), 19(Enabled), 20 (Server), and 21 (Store).

Instead of a parameter that matches one of themembers listed

PvsObject[] Object: PvsObjects with the membersbelow can be used as the Object parameter or from a pileline:

DiskLocatorId

Optional

SwitchParameter Confirm: The impact of thisoperation is "low". If -Confirm is specified, the operation will beconfirmed. $ConfirmPreference can be set to "low" to haveconfirmation without the Confirm parameter.

EXAMPLE 1: Copy-PvsDiskProperties for Guid

Copy-PvsDiskProperties -DiskLocatorIdFrom"66302103-2991-4e42-ba58-a1614cec070c" -Guid"f5eb3de9-bcf4-416f-a289-6a9472c13f8b"

EXAMPLE 2: Copy-PvsDiskProperties for Guid with Properties

Copy-PvsDiskProperties -DiskLocatorIdFrom"66302103-2991-4e42-ba58-a1614cec070c" -Guid"f5eb3de9-bcf4-416f-a289-6a9472c13f8b" -Properties 2, 3

EXAMPLE 3: Copy-PvsDiskProperties for PvsDiskLocator Using Pipe

The Get-PvsDiskLocator output is piped to theCopy-PvsDiskProperties.

Get-PvsDiskLocator -Guid"f5eb3de9-bcf4-416f-a289-6a9472c13f8b" -Fields Guid |Copy-PvsDiskProperties -DiskLocatorIdFrom"66302103-2991-4e42-ba58-a1614cec070c" -Properties 2, 3

The -Fields parameter with only the needed fieldsspecified makes the Get work faster because only those fields are retrieved.

Copy-PvsServerProperties

Copy properties of one Server to a Server.

One of these required

Guid ServerIdFrom: GUID of the Server to Copy from.

string ServerNameFrom: Name of the Server to Copyfrom.

One of these required

Guid Guid or ServerId: GUID of the Server to Copyto.

string Name or ServerName: Name of the Server toCopy to.

Optional

uint[] Properties: If not specified, all are copied.Properties to copy. Values are: 1 (Configuration), 2 (Port), 4 (ActiveDirectory), 5 (Advanced Server), 6 (Advanced Network), 7 (Advanced Pacing), 8(Advanced Device) and 9 (Logging).

Instead of a parameter that matches one of themembers listed

PvsObject[] Object: PvsObjects with the membersbelow can be used as the Object parameter or from a pileline:

ServerId

Optional

SwitchParameter Confirm: The impact of thisoperation is "low". If -Confirm is specified, the operation will beconfirmed. $ConfirmPreference can be set to "low" to haveconfirmation without the Confirm parameter.

EXAMPLE 1: Copy-PvsDiskProperties for Name

Copy-PvsDiskProperties -ServerNameFrom theServerFrom-Name theServerTo

EXAMPLE 2: Copy-PvsDiskProperties for Name with Properties

Copy-PvsDiskProperties -ServerNameFrom theServerFrom-Name theServerTo -Properties 2, 3

EXAMPLE 3: Copy-PvsDiskProperties for PvsServer Using Pipe

The Get-PvsServer output is piped to theCopy-PvsDiskProperties.

Get-PvsServer -Name theServerTo -Fields Guid |Copy-PvsDiskProperties -ServerNameFrom theServerFrom -Properties 2, 3

The -Fields parameter with only the needed fieldsspecified makes the Get work faster because only those fields are retrieved.

Disable-PvsDeviceDiskLocator

Disable a Device's DiskLocator.

One of these required

Guid[] Guid or DeviceId: GUID of the Device toDisable the DiskLocator for.

string[] Name or DeviceName: Name of the Device toDisable the DiskLocator for.

PvsPhysicalAddress[] DeviceMac: MAC of the Device toDisable the DiskLocator for.

This required

Guid[] DiskLocatorId: GUID of the DiskLocator toDisable for the Device.

or this required ; resolution

string[] DiskLocatorName: Name of the DiskLocatorFile to Disable for the Device.

One of these resolutions when needed

Guid[] StoreId: GUID of the Store that is neededwhen a DiskLocatorName is used.

string[] StoreName: Name of the Store that is neededwhen a DiskLocatorName is used.

Instead of a parameter that matches one of themembers listed

PvsObject[] Object: PvsObjects with the members belowcan be used as the Object parameter or from a pileline:

DeviceId or DiskLocatorId

Optional

SwitchParameter Confirm: The impact of thisoperation is "medium". If -Confirm is specified, the operation willbe confirmed. $ConfirmPreference can be set to "medium" or"low" to have confirmation without the Confirm parameter.

EXAMPLE 1: Disable a PvsDevice PvsDiskLocator

This example disables the PvsDiskLocator namedtheDiskLocator for the PvsDevice named theDevice.

Disable-PvsDeviceDiskLocator -Name theDevice-DiskLocatorName theDiskLocator -StoreName theStore

DiskLocatorId can be used instead of DiskLocatorNameso that the StoreName or StoreId are not also needed.

Dismount-PvsDisk

No longer Map the Disk.

EXAMPLE 1: Dismount-PvsDisk

Dismount-PvsDisk

Enable-PvsDeviceDiskLocator

Enable a Device's DiskLocator. If the DiskLocator isDisabled, that overrides the Device DiskLocator setting.

One of these required

Guid[] Guid or DeviceId: GUID of the Device toEnable the DiskLocator for.

string[] Name or DeviceName: Name of the Device toEnable the DiskLocator for.

PvsPhysicalAddress[] DeviceMac: MAC of the Device toEnable the DiskLocator for.

This required

Guid[] DiskLocatorId: GUID of the DiskLocator toEnable for the Device.

or this required ; resolution

string[] DiskLocatorName: Name of the DiskLocator toEnable for the Device.

One of these resolutions when needed

Guid[] StoreId: GUID of the Store that is neededwhen a DiskLocatorName is used.

string[] StoreName: Name of the Store that is neededwhen a DiskLocatorName is used.

Instead of a parameter that matches one of themembers listed

PvsObject[] Object: PvsObjects with the membersbelow can be used as the Object parameter or from a pileline:

DeviceId or DiskLocatorId

Optional

SwitchParameter Confirm: The impact of thisoperation is "low". If -Confirm is specified, the operation will beconfirmed. $ConfirmPreference can be set to "low" to haveconfirmation without the Confirm parameter.

EXAMPLE 1: Enable a PvsDevice PvsDiskLocator

This example enables the PvsDiskLocator namedtheDiskLocator for the PvsDevice named theDevice.

Enable-PvsDeviceDiskLocator -Name theDevice-DiskLocatorName theDiskLocator -StoreName theStore

DiskLocatorId can be used instead of DiskLocatorNameso that the StoreName or StoreId are not also needed.

Export-PvsAuditTrail

Archive the information in the Audit Trail up to acertain date to a file. When finished, the information archived will be removedfrom the Audit Trail.

This required

string[] FileName: Name of the file to archive theAudit Trail to. This must be a full file path name.

Optional

DateTime EndDate: Last date of information toArchive. If not entered, all information is Archived. Uses only the date.

SwitchParameter NoPurgeData: If -NoPurgeData isspecified, the information archived will not be removed from the Audit Trail.

Optional

SwitchParameter Confirm: The impact of thisoperation is "low". If -Confirm is specified, the operation will beconfirmed. $ConfirmPreference can be set to "low" to haveconfirmation without the Confirm parameter.

EXAMPLE 1: Export-AuditTrail for PvsFarm

Export-AuditTrail -Name"C:\export\theFileName"

EXAMPLE 2: Export-AuditTrail for PvsFarm with EndDate

Export-AuditTrail-EndDate "01/01/2015" -Name"C:\export\theFileName"

EXAMPLE 3: Export-AuditTrail for PvsFarm with EndDate and NoPurgeData

Export-AuditTrail-EndDate "01/01/2015" -NoPurgeData -Name"C:\export\theFileName"

Export-PvsDisk

Export the disk stack to a manifest file.

This required

Guid[] Guid or DiskLocatorId: GUID of the DiskLocator that identifies the disk to export.

or this required ; resolution

string[] Name or DiskLocatorName: Name of the DiskLocator that identifies the disk to export.

Optional

uint Version: Version to use as the start of theexport. The export will include all versions starting with this to the highestone.

One of these resolutions when needed

Guid[] SiteId: GUID of the Site.

string[] SiteName: Name of the Site.

One of these resolutions when needed

Guid[] StoreId: GUID of the Store that is needed whena DiskLocatorName is used.

string[] StoreName: Name of the Store that is neededwhen a DiskLocatorName is used.

Instead of a parameter that matches one of themembers listed

PvsObject[] Object: PvsObjects with the membersbelow can be used as the Object parameter or from a pileline:

DiskLocatorId

EXAMPLE 1: Export-PvsDisk for Name

Export-PvsDisk -Name theDiskLocator -SiteNametheSite -StoreName theStore

Guid can be used instead of Name so that theSiteName or SiteId and StoreName or StoreId are not also needed.

EXAMPLE 2: Export-PvsDisk for PvsDiskLocator Using Pipe

The Get-PvsDiskLocator output is piped to theExport-PvsDisk.

Get-PvsDiskLocator -Name theDiskLocator -SiteNametheSite -StoreName theStore -Fields Guid | Export-PvsDisk

The -Fields parameter with only the needed fieldsspecified makes the Get work faster because only those fields are retrieved.

Guid can be used instead of Name so that theSiteName or SiteId and StoreName or StoreId are not also needed.

EXAMPLE 3: Export-PvsDisk for Name with Version

Export-PvsDisk -Name theDiskLocator -SiteNametheSite -StoreName theStore -Version 4

Guid can be used instead of Name so that theSiteName or SiteId and StoreName or StoreId are not also needed.

EXAMPLE 4: Export-PvsDisk for PvsDiskLocator Using Pipe

The Get-PvsDiskLocator output is piped to theExport-PvsDisk.

Get-PvsDiskLocator -Name theDiskLocator -SiteNametheSite -StoreName theStore -Fields Guid | Export-PvsDisk -Version 4

The -Fields parameter with only the needed fieldsspecified makes the Get work faster because only those fields are retrieved.

Guid can be used instead of Name so that theSiteName or SiteId and StoreName or StoreId are not also needed.

Export-PvsOemLicenses

Oem Only: Export the Oem Licenses for the Devices tothe fileName specified.

This required

string FileName: Name of the file to export the OemLicenses to. This must be a full file path name.

One of these required

Guid Guid or DeviceId: GUID of the Device to ExportOem Licenses to the fileName specified.

string Name or DeviceName: Name of the Device toExport Oem Licenses to the fileName specified.

PvsPhysicalAddress DeviceMac: MAC of the Device toExport Oem Licenses to the fileName specified.

Guid CollectionId: GUID of the Collection to Exportall Device Oem Licenses to the fileName specified.

Guid SiteViewId: GUID of the Site View to Export allDevice Oem Licenses to the fileName specified.

Guid FarmViewId: GUID of the Farm View to Export allDevice Oem Licenses to the fileName specified.

string FarmViewName: Name of the Farm View to Exportall Device Oem Licenses to the fileName specified.

or one of these required ; resolutions

string CollectionName: Name of the Collection toExport all Device Oem Licenses to the fileName specified.

string SiteViewName: Name of the Site View to Exportall Device Oem Licenses to the fileName specified.

One of these resolutions when needed

Guid SiteId: GUID of the Site.

string SiteName: Name of the Site.

Instead of a parameter that matches one of themembers listed

PvsObject[] Object: PvsObjects with the membersbelow can be used as the Object parameter or from a pileline:

DeviceId, CollectionId, SiteViewId or FarmViewId

EXAMPLE 1: Export-PvsOemLicenses for Name

Export-PvsOemLicenses -Name theDevice -FileName"C:\export\theFileName"

EXAMPLE 2: Export-PvsOemLicenses for PvsDevice Using Pipe

The Get-PvsDevice output is piped to theExport-PvsOemLicenses.

Get-PvsDevice -Name theDevice -Fields Guid |Export-PvsOemLicenses -FileName "C:\export\theFileName"

The -Fields parameter with only the needed fieldsspecified makes the Get work faster because only those fields are retrieved.

EXAMPLE 3: Export-PvsOemLicenses for DeviceMac

Export-PvsOemLicenses -DeviceMac"00-11-22-33-44-55" -FileName "C:\export\theFileName"

EXAMPLE 4: Export-PvsOemLicenses for PvsDevice Using Pipe

The Get-PvsDevice output is piped to theExport-PvsOemLicenses.

Get-PvsDevice -DeviceMac"00-11-22-33-44-55" -Fields Guid | Export-PvsOemLicenses -FileName"C:\export\theFileName"

The -Fields parameter with only the needed fields specifiedmakes the Get work faster because only those fields are retrieved.

EXAMPLE 5: Export-PvsOemLicenses for FarmViewName

Export-PvsOemLicenses -FarmViewName theFarmView-FileName "C:\export\theFileName"

EXAMPLE 6: Export-PvsOemLicenses for PvsFarmView Using Pipe

The Get-PvsFarmView output is piped to theExport-PvsOemLicenses.

Get-PvsFarmView -Name theFarmView -Fields Guid |Export-PvsOemLicenses -FileName "C:\export\theFileName"

The -Fields parameter with only the needed fieldsspecified makes the Get work faster because only those fields are retrieved.

EXAMPLE 7: Export-PvsOemLicenses for CollectionName

Export-PvsOemLicenses -CollectionName theCollection-SiteName theSite -FileName "C:\export\theFileName"

CollectionId can be used instead of CollectionNameso that the SiteName or SiteId is not also needed.

EXAMPLE 8: Export-PvsOemLicenses for PvsCollection Using Pipe

The Get-PvsCollection output is piped to theExport-PvsOemLicenses.

Get-PvsCollection -Name theCollection -SiteNametheSite -Fields Guid | Export-PvsOemLicenses -FileName"C:\export\theFileName"

The -Fields parameter with only the needed fieldsspecified makes the Get work faster because only those fields are retrieved.

Guid can be used instead of Name so that theSiteName or SiteId is not also needed.

EXAMPLE 9: Export-PvsOemLicenses for SiteViewName

Export-PvsOemLicenses -SiteViewName theSiteView-SiteName theSite -FileName "C:\export\theFileName"

SiteViewId can be used instead of SiteViewName sothat the SiteName or SiteId is not also needed.

EXAMPLE 10: Export-PvsOemLicenses for PvsSiteView Using Pipe

The Get-PvsSiteView output is piped to theExport-PvsOemLicenses.

Get-PvsSiteView -Name theSiteView -SiteName theSite-Fields Guid | Export-PvsOemLicenses -FileName"C:\export\theFileName"

The -Fields parameter with only the needed fieldsspecified makes the Get work faster because only those fields are retrieved.

Guid can be used instead of Name so that theSiteName or SiteId is not also needed.

Get-PvsADAccount

Return a PvsAdAccount object if the named DeviceAccount in the domain is found.

This required

string Domain: Domain the account is a member of.

This required

string Name: Name of the Device for the account.

PvsADAccount: If successful, the PvsADAccount objectis returned.

EXAMPLE 1: Get PvsADAccount

Get the PvsADAccount in the Domain named theDomainfor the Device named theDevice.

Get-PvsADAccount -Domain theDomain -Name theDevice

Get-PvsAuditActionParameter

Get the Parameters of an Audit Action.

This required

Guid[] AuditActionId: GUID of the Audit Action toGet Parameters for.

Instead of a parameter that matches one of themembers listed

PvsObject[] Object: PvsObjects with the membersbelow can be used as the Object parameter or from a pileline:

AuditActionId

If only selected fields are needed, pass them in theFields parameter as a string array.

Name or AuditParameterName: Name of the parameter.Max Length=50

Value: Value of the parameter. Max Length=1000

PvsAuditActionParameter[]: If successful, thePvsAuditActionParameter object(s) are returned.

EXAMPLE 1: Get PvsAuditActionParameter

Get all PvsAuditActionParameter for theAuditActionId e8baa554-7c2d-49e5-9f6b-e0bc46179fc7.

Get-PvsAuditActionParameter -AuditActionId"e8baa554-7c2d-49e5-9f6b-e0bc46179fc7"

EXAMPLE 2: Get PvsAuditActionParameter for Multiple AuditActionId

Get all PvsAuditActionParameter for theAuditActionId e8baa554-7c2d-49e5-9f6b-e0bc46179fc7 and54ee6180-7fbc-42a2-9499-2e4936f039dc.

Get-PvsAuditActionParameter -AuditActionId"e8baa554-7c2d-49e5-9f6b-e0bc46179fc7","54ee6180-7fbc-42a2-9499-2e4936f039dc"

EXAMPLE 3: Get PvsAuditActionParameter for Get-PvsAuditTrail Results withParameters

Get-PvsAuditTrail is called and only thePvsAuditTrail.Attachment with bit 4 (Parameters) set are used to callGet-PvsAuditActionParameter.

Get-PvsAuditTrail | Where-Object {($_.Attachments-band 4) -eq 4} | Get-PvsAuditActionParameter

Get-PvsAuditActionProperty

Get the Properties of an Audit Action.

This required

Guid[] AuditActionId: GUID of the Audit Action toGet Properties for.

Instead of a parameter that matches one of themembers listed

PvsObject[] Object: PvsObjects with the membersbelow can be used as the Object parameter or from a pileline:

AuditActionId

If only selected fields are needed, pass them in theFields parameter as a string array.

Name or AuditPropertyName: Name of the property. MaxLength=50

OldValue: Previous value of the Property.Default="" Max Length=1000

NewValue: New value of the Property.Default="" Max Length=1000

PvsAuditActionProperty[]: If successful, thePvsAuditActionProperty object(s) are returned.

EXAMPLE 1: Get PvsAuditActionProperty

Get all PvsAuditActionProperty for the AuditActionIde8baa554-7c2d-49e5-9f6b-e0bc46179fc7.

Get-PvsAuditActionProperty -AuditActionId"e8baa554-7c2d-49e5-9f6b-e0bc46179fc7"

EXAMPLE 2: Get PvsAuditActionProperty for Multiple AuditActionId

Get all PvsAuditActionProperty for the AuditActionIde8baa554-7c2d-49e5-9f6b-e0bc46179fc7 and 54ee6180-7fbc-42a2-9499-2e4936f039dc.

Get-PvsAuditActionProperty -AuditActionId "e8baa554-7c2d-49e5-9f6b-e0bc46179fc7","54ee6180-7fbc-42a2-9499-2e4936f039dc"

EXAMPLE 3: Get PvsAuditActionProperty for Get-PvsAuditTrail Results withProperties

Get-PvsAuditTrail is called and only thePvsAuditTrail.Attachment with bit 8 (Properties) set are used to callGet-PvsAuditActionProperty.

Get-PvsAuditTrail | Where-Object {($_.Attachments-band 8) -eq 8} | Get-PvsAuditActionProperty

Get-PvsAuditActionSibling

Get the Sibling of an Audit Action. It is the 2ndobject involved with the action.

This required

Guid[] Guid or AuditActionId: GUID of the AuditAction to Get Sibling for.

Instead of a parameter that matches one of themembers listed

PvsObject[] Object: PvsObjects with the membersbelow can be used as the Object parameter or from a pileline:

AuditActionId

If only selected fields are needed, pass them in theFields parameter as a string array.

Guid or AuditActionId: GUID of the action.

Type: 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)

ObjectId: GUID of the object of the action.

ObjectName: Name of the object of the action. MaxLength=1000

Path: Path of the object of the action. An exampleis Site\Collection for a Device. Default="" Max Length=101

SiteId: GUID of the Site for the object of theaction. 00000000-0000-0000-0000-000000000000 when not valid.Default=00000000-0000-0000-0000-000000000000

SubId: GUID of the Collection or Store of theaction. 00000000-0000-0000-0000-000000000000 when not valid.Default=00000000-0000-0000-0000-000000000000

PvsAuditAction[]: If successful, the PvsAuditActionobject(s) are returned.

EXAMPLE 1: Get PvsAuditActionSibling

Get all PvsAuditActionSibling for the AuditActionIde8baa554-7c2d-49e5-9f6b-e0bc46179fc7.

Get-PvsAuditActionSibling -Guid"e8baa554-7c2d-49e5-9f6b-e0bc46179fc7"

EXAMPLE 2: Get PvsAuditActionSibling for Multiple AuditActionId

Get all PvsAuditActionSibling for the AuditActionIde8baa554-7c2d-49e5-9f6b-e0bc46179fc7 and 54ee6180-7fbc-42a2-9499-2e4936f039dc.

Get-PvsAuditActionSibling -Guid"e8baa554-7c2d-49e5-9f6b-e0bc46179fc7","54ee6180-7fbc-42a2-9499-2e4936f039dc"

EXAMPLE 3: Get PvsAuditActionSibling for Get-PvsAuditTrail Results withSiblings

Get-PvsAuditTrail is called and only thePvsAuditTrail.Attachment with bit 2 (Siblings) set are used to callGet-PvsAuditActionSibling.

Get-PvsAuditTrail | Where-Object {($_.Attachments-band 2) -eq 2} | Get-PvsAuditActionSibling

Get-PvsAuditTrail

Get the Audit Trail actions for a Farm, Site,Server, DiskLocator, Collection, Device, User Group, Site View, Farm View orStore. All Audit Trail actions are returned if no parameters are passed. Theresult can be filtered by parent, user\domain and date range.

One of these optional

Guid[] Guid or AuditActionId: GUID of the AuditAction to Get.

Guid[] ParentId: Parent AuditActionId of the recordsto retrieve. If no parameters are included, only records with no parent arereturned.

Guid[] RootId: Root AuditActionId of the records toretrieve. All of the actions caused by the root action are returned. If noparameters are included, only records with no root are returned.

Guid[] SiteId: GUID of the Site to get the AuditTrail for.

string[] SiteName: Name of the Site to get the AuditTrail for.

Guid[] CollectionId: GUID of the Collection to getthe Audit Trail for.

Guid[] SiteViewId: GUID of the Site View to get theAudit Trail for.

Guid[] FarmViewId: GUID of the Farm View to get theAudit Trail for.

string[] FarmViewName: Name of the Farm View to getthe Audit Trail for.

Guid[] ServerId: GUID of the Server to get the AuditTrail for.

string[] ServerName: Name of the Server to get theAudit Trail for.

Guid[] DeviceId: GUID of the Device to get the AuditTrail for.

string[] DeviceName: Name of the Device to get theAudit Trail for.

PvsPhysicalAddress[] DeviceMac: MAC of the Device toget the Audit Trail for.

Guid[] StoreId: GUID of the Store to get the AuditTrail for.

string[] StoreName: Name of the Store to get theAudit Trail for.

Guid[] DiskLocatorId: GUID of the DiskLocator to getthe Audit Trail for.

or one of these optional ; resolutions

string[] CollectionName: Name of the Collection toget the Audit Trail for.

string[] SiteViewName: Name of the Site View to getthe Audit Trail for.

string[] DiskLocatorName: Name of the DiskLocator toget the Audit Trail for.

Optional

string[] UserName: User that performed the action.

string[] Domain: Domain of the user that performedthe action.

DateTime BeginDate: Date/Time of the first actionsto get. If not included, all actions until the endDate are returned. If neitherthis or the endDate are included, then only actions that occurred in the lastweek are returned. Uses only the date, hour and minute. If connected to aServer version previous to 7.7, only the date is used.

DateTime EndDate: Date/Time of the last actions toget. If not included, all actions from the beginDate until now are returned. Ifneither this or the beginDate are included, then only actions that occurred inthe last week are returned. Uses only the date, hour and minute. If connectedto a Server version previous to 7.7, only the date is used.

uint[] Type: Types to get. 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), and13 (UserGroup)

uint[] Action: Actions to get. 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), 2064RunUpdateBDM, 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, 6018SetDiskUpdateDevice, 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)

One of these resolutions when needed

Guid[] SiteId: GUID of the Site to get the AuditTrail for.

string[] SiteName: Name of the Site to get the AuditTrail for.

One of these resolutions when needed

Guid[] StoreId: GUID of the Store to get the AuditTrail for.

string[] StoreName: Name of the Store to get theAudit Trail for.

Instead of a parameter that matches one of themembers listed

PvsObject[] Object: PvsObjects with the membersbelow can be used as the Object parameter or from a pileline:

AuditActionId, ParentId, RootId, SiteId,CollectionId, SiteViewId, FarmViewId, ServerId, DeviceId, StoreId orDiskLocatorId

If only selected fields are needed, pass them in theFields parameter as a string array.

Guid or AuditActionId: GUID of the action.

Time: Date/Time the action occurred down to themillisecond. Has the date and time including milliseconds. Default=Empty

UserName: User that performed the action. MaxLength=255

Domain: Domain of the user that performed theaction. Max Length=255

Type: 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)

Action: Name of the action taken. This is a numberthat 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), 2064RunUpdateBDM, 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), 6016SetVirtualHostingPool, 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)

ObjectId: GUID of the object of the action.Default=00000000-0000-0000-0000-000000000000

ObjectName: Name of the object of the action.Default="" Max Length=1000

Path: Path of the object of the action. An exampleis Site\Collection for a Device. Default="" Max Length=101

SiteId: GUID of the Site for the object of theaction. 00000000-0000-0000-0000-000000000000 when not valid.Default=00000000-0000-0000-0000-000000000000

SubId: GUID of the Collection or Store of theaction. 00000000-0000-0000-0000-000000000000 when not valid.Default=00000000-0000-0000-0000-000000000000

ParentId: GUID of the parent action (one thattriggered this action) if one exists. 00000000-0000-0000-0000-000000000000 whennot valid. Default=00000000-0000-0000-0000-000000000000

RootId: GUID of the root action (one that triggeredthis group of actions) if one exists. 00000000-0000-0000-0000-000000000000 whennot valid. Default=00000000-0000-0000-0000-000000000000

Attachments: An or'ed value that indicates if thereare any details for this action. A value of 15 indicates that there areChildren, Sibling, Parameters and Properties for the action. Values are: 0(None), 1 (Children), 2 (Sibling), 4 (Parameters), and 8 (Properties) Default=0

PvsAuditTrail[]: If successful, the PvsAuditTrailobject(s) are returned.

EXAMPLE 1: Get PvsAuditTrail for Farm

Get all PvsAuditTrail for the Farm.

Get-PvsAuditTrail

EXAMPLE 2: Get PvsAuditTrail for FarmView

Get all PvsAuditTrail for the FarmView namedtheFarmView.

Get-PvsAuditTrail -FarmViewName theFarmView

EXAMPLE 3: Get PvsAuditTrail for Site

Get all PvsAuditTrail for the Site named theSite.

Get-PvsAuditTrail -SiteName theSite

EXAMPLE 4: Get PvsAuditTrail for SiteView

Get all PvsAuditTrail for the SiteView named theSiteViewin the Site named theSite.

Get-PvsAuditTrail -SiteViewName theSiteView-SiteName theSite

SiteViewId can be used instead of SiteViewName sothat the SiteName or SiteId is not also needed.

EXAMPLE 5: Get PvsAuditTrail for Collection

Get all PvsAuditTrail for the Collection namedtheCollection in the Site named theSite.

Get-PvsAuditTrail -CollectionName theCollection-SiteName theSite

CollectionId can be used instead of CollectionNameso that the SiteName or SiteId is not also needed.

EXAMPLE 6: Get PvsAuditTrail for Device

Get all PvsAuditTrail for the Device namedtheDevice.

Get-PvsAuditTrail -DeviceName theDevice

EXAMPLE 7: Get PvsAuditTrail for Device MAC

Get all PvsAuditTrail for the Device with MAC02-50-F2-00-00-01.

Get-PvsAuditTrail -DeviceMac"02-50-F2-00-00-01"

EXAMPLE 8: Get PvsAuditTrail for Server

Get all PvsAuditTrail for the Server namedtheServer.

Get-PvsAuditTrail -ServerName theServer

EXAMPLE 9: Get PvsAuditTrail for Store

Get all PvsAuditTrail for the Store named theStore.

Get-PvsAuditTrail -StoreName theStore

EXAMPLE 10: Get PvsAuditTrail for DiskLocator

Get all PvsAuditTrail for the DiskLocator namedtheDiskLocator in the Site named theSite and Store named theStore.

Get-PvsAuditTrail -DiskLocatorName theDiskLocator-SiteName theSite -StoreName theStore

DiskLocatorId can be used instead of DiskLocatorNameso that the SiteName or SiteId and StoreName or StoreId are not also needed.

EXAMPLE 11: Get PvsAuditTrail for User

Get all PvsAuditTrail for the User named theUser inDomain theDomain.

Get-PvsAuditTrail -UserName theUser -DomainNametheDomain

EXAMPLE 12: Get PvsAuditTrail for January

Get all PvsAuditTrail for January.

Get-PvsAuditTrail -BeginDate "01/01/201500:00" -EndDate "01/31/2015 23:59"

EXAMPLE 13: Get PvsAuditTrail for DiskLocator and Server Type Actions

Get all PvsAuditTrail for 5 (DiskLocator) and 8(Server) type actions.

Get-PvsAuditTrail -Type 5 8

EXAMPLE 14: Get PvsAuditTrail for DiskLocator and Server Type Actions

Get all PvsAuditTrail for the 1003 (DeleteDevice) and1007 (DeleteServer) actions.

Get-PvsAuditTrail -Action 1003 1007

EXAMPLE 15: Get PvsAuditTrail with Children

Get the 4fd16fc1-8dcc-4097-be5a-d0485bd7433bPvsAuditTrail and if it has children, the child PvsAuditTrail are retrieved.

$x = Get-PvsAuditTrail -AuditActionId"4fd16fc1-8dcc-4097-be5a-d0485bd7433b"

if (($x.Attachments -band 1) -eq 1) {Get-PvsAuditTrail -ParentId $x.AuditActionId }

Get-PvsAuthGroup

Get the fields for an AuthGroup, all AuthGroups inthe system, AuthGroups with Farm, Site or Collection Authorization. AllAuthGroups in the system are returned if no parameters are passed.

One of these optional

Guid[] Guid or AuthGroupId: GUID of the AuthGroup toGet.

string[] Name or AuthGroupName: Name of theAuthGroup to Get.

Guid[] SiteId: GUID of the Site to Get allAuthGroups with Authorization for.

string[] SiteName: Name of the Site to Get allAuthGroups with Authorization for.

Guid[] CollectionId: GUID of the Collection to Getall AuthGroups with Authorization for.

or this optional ; resolution

string[] CollectionName: Name of the Collection toGet all AuthGroups with Authorization for.

Optional

SwitchParameter Farm: If -Farm is specified,AuthGroups with Farm Authorization should be returned.

One of these resolutions when needed

Guid[] SiteId: GUID of the Site to Get allAuthGroups with Authorization for.

string[] SiteName: Name of the Site to Get allAuthGroups with Authorization for.

Instead of a parameter that matches one of themembers listed

PvsObject[] Object: PvsObjects with the members belowcan be used as the Object parameter or from a pileline:

AuthGroupId, SiteId or CollectionId

If only selected fields are needed, pass them in theFields parameter as a string array.

Guid or AuthGroupId: Read-only GUID that uniquelyidentifies this AuthGroup.

Name or AuthGroupName: Name of the Active Directoryor Windows Group. Max Length=450

Description: User description. Default=""Max Length=250

Role: Role of the AuthGroup for a Collection. rolecan only be used with CollectionId or CollectionName. 300 is CollectionAdministrator, and 400 is Collection Operator. Default=999

PvsAuthGroup[]: If successful, the PvsAuthGroupobject(s) are returned.

EXAMPLE 1: Get PvsAuthGroup for System

Get all PvsAuthGroup for the System.

Get-PvsAuthGroup

EXAMPLE 2: Get PvsAuthGroup for Farm

Get all PvsAuthGroup for the Farm.

Get-PvsAuthGroup

EXAMPLE 3: Get PvsAuthGroup for Site

Get all PvsAuthGroup for the Site named theSite.

Get-PvsAuthGroup -SiteName theSite

EXAMPLE 4: Get PvsAuthGroup for Collection

Get all PvsAuthGroup for the Collection namedtheCollection in the Site named theSite.

Get-PvsAuthGroup -CollectionName theCollection-SiteName theSite

CollectionId can be used instead of CollectionNameso that the SiteName or SiteId is not also needed.

Get-PvsAuthGroupUsage

Get the items that are authorized for an AuthGroup.

One of these required

Guid[] AuthGroupId: GUID of the AuthGroup to Get allitems that are authorized for it.

string[] Name or AuthGroupName: Name of theAuthGroup to Get all items that are authorized for it.

Instead of a parameter that matches one of themembers listed

PvsObject[] Object: PvsObjects with the membersbelow can be used as the Object parameter or from a pileline:

AuthGroupId

If only selected fields are needed, pass them in theFields parameter as a string array.

Guid or Id: GUID of the item. The item can be aFarm, Site or Collection. It will be 00000000-0000-0000-0000-000000000000 forFarm.

Name: Name of the item. The item can be a Farm, Siteor Collection.

Role: Role of the AuthGroup for the item. 100 isFarm Administrator, 200 is Site Administrator, 300 is Collection Administrator,and 400 is Collection Operator. Default=999

PvsAuthGroupUsage[]: If successful, thePvsAuthGroupUsage object(s) are returned.

EXAMPLE 1: Get PvsAuthGroupUsage

Get all PvsAuthGroupUsage for the AuthGroup namedtheAuthGroup.

Get-PvsAuthGroupUsage -Name theAuthGroup

Get-PvsCeipData

Get the CEIP configuration

Optional

string[] Uuid: CEIP UUID of this Farm. This isoptional since there is only one.

Instead of a parameter that matches one of themembers listed

PvsObject[] Object: PvsObjects with the membersbelow can be used as the Object parameter or from a pileline:

Uuid

If only selected fields are needed, pass them in theFields parameter as a string array.

Enabled: 1 if CEIP is enabled, otherwise 0. Min=0,Max=1

Uuid: CEIP UUID.

NextUpload: Date and time next CEIP upload is due ifenabled is 1. Default=Empty

InProgress: 1 if an upload is currently in progress,otherwise 0. Default=0

ServerId: ID of server that is currently uploading,null if InProgress is 0. Default=00000000-0000-0000-0000-000000000000

OneTimeUpload: 1 to perform a one time upload.

PvsCeipData[]: If successful, the PvsCeipDataobject(s) are returned.

EXAMPLE 1: Get PvsCeipData for CeipData

Get all PvsCeipData for CeipData.

Get-PvsCeipData

Get-PvsCisData

Get the CIS configuration

If only selected fields are needed, pass them in theFields parameter as a string array.

Guid or CisDataId: CIS UUID

UserName: Username used to obtain the tokenDefault="" Max Length=255

UploadToken: Token for uploading bundles to CISDefault="" Max Length=10

Path: Path where the last problem report bundle wassaved Default="" Max Length=255

Password: Password of the user required to obtainthe token. This is required only by Set and Add

PvsCisData[]: If successful, the PvsCisDataobject(s) are returned.

EXAMPLE 1: Get PvsCisData for CisData

Get all PvsCisData for CispData.

Get-PvsCisData

Get-PvsCollection

Get the fields for a Collection or all Collectionsin a Site or Farm. All Collections are returned if no parameters are passed.

One of these optional

Guid[] Guid or CollectionId: GUID of the Collectionto Get.

Guid[] SiteId: GUID of the Site to Get allCollections for.

string[] SiteName: Name of the Site to Get allCollections for.

or this optional ; resolution

string[] Name or CollectionName: Name of theCollection to Get.

One of these resolutions when needed

Guid[] SiteId: GUID of the Site to Get allCollections for.

string[] SiteName: Name of the Site to Get allCollections for.

Instead of a parameter that matches one of themembers listed

PvsObject[] Object: PvsObjects with the membersbelow can be used as the Object parameter or from a pileline:

CollectionId or SiteId

If only selected fields are needed, pass them in theFields parameter as a string array.

Guid or CollectionId: Read-only GUID that uniquelyidentifies this Collection.

Name or CollectionName: Name of the Collection. Itis unique within the Site. Max Length=50

SiteId: GUID of the Site that this Collection is amember of. It is not used with SiteName.

SiteName: Name of the Site that this Collection is amember of. It is not used with SiteId.

Description: User description. Default=""Max Length=250

TemplateDeviceId: GUID of a Device in the Collectionwhose settings are used for initial values of new Devices. Not used withtemplateDeviceName. Default=00000000-0000-0000-0000-000000000000

TemplateDeviceName: Name of a Device in theCollection whose settings are used for initial values of new Devices. Not usedwith TemplateDeviceId. Default=""

LastAutoAddDeviceNumber: The Device Number of thelast Auto Added Device. Default=0

Enabled: True when Devices in the Collection can bebooted, false otherwise. Default=true

DeviceCount: Read-only count of Devices in this Collection.Default=0

DeviceWithPVDCount: Read-only count of Devices withPersonal vDisk in this Collection. Default=0

ActiveDeviceCount: Read-only count of active Devicesin this Collection. Default=0

MakActivateNeededCount: Read-only count of activeDevices that need MAK activation in this Collection. Default=0

AutoAddPrefix: The string put before the DeviceNumber for Auto Add. Default="" ASCII computer name characters no enddigit Max Length=12

AutoAddSuffix: The string put after the DeviceNumber for Auto Add. Default="" ASCII computer name characters nobegin digit Max Length=12

AutoAddZeroFill: True when zeros be placed beforethe Device Number up to the AutoAddNumberLength for Auto Add, false otherwise.Default=true

AutoAddNumberLength: The maximum length of theDevice Number for Auto Add. This length plus the AutoAddPrefix length plus theAutoAddSuffix length must be less than 16. Required that((lenautoAddPrefix+lenautoAddSuffix)+AutoAddNumberLength)<=15. Min=3, Max=9,Default=4

Role: Read-only Role of the user for this item. 100is Farm Administrator, 200 is Site Administrator, 300 is CollectionAdministrator, and 400 is Collection Operator. Default=999

PvsCollection[]: If successful, the PvsCollectionobject(s) are returned.

EXAMPLE 1: Get PvsCollection for Farm

Get all PvsCollection for the Farm.

Get-PvsCollection

EXAMPLE 2: Get PvsCollection for Site

Get all PvsCollection for the Site named theSite.

Get-PvsCollection -SiteName theSite

EXAMPLE 3: Get PvsCollection

Get the PvsCollection for the Collection namedtheCollection in the Site named theSite.

Get-PvsCollection -Name theCollection -SiteNametheSite

Guid can be used instead of Name so that theSiteName or SiteId is not also needed.

EXAMPLE 4: Get PvsCollection and Enable

Get all PvsCollection that are not Enabled and thenEnables them.

Get-PvsCollection -Fields Enabled | Where-Object{$_.Enabled -eq $false} | foreach { $o = $_; $o.Enabled = $true; $o } |Set-PvsCollection

The -Fields parameter with only the needed fieldsspecified makes the Get work faster because only those fields are retrieved.

The "foreach { $o = $_; $o.X = Y; $o }"sets the field X to value Y and returns the object again so it can be piped tothe Set command for update.

Get-PvsConnection

Return the PvsConnection object with the informationabout the SoapServer connection.

PvsConnection: If successful, the PvsConnectionobject is returned.

EXAMPLE 1: Get PvsConnection

Get the PvsConnection for the SoapServer.

Get-PvsConnection

Get-PvsCreateDiskStatus

Get the Percent Finished for an active CreateDisk.When finished, the PvsDiskLocator created is returned.

This required

string Name: Name of the Disk file that is beingcreated.

One of these required

Guid StoreId: GUID of the Store that the Disk willbe a member of.

string StoreName: Name of the Store that the Diskwill be a member of.

Instead of a parameter that matches one of themembers listed

PvsObject[] Object: PvsObjects with the membersbelow can be used as the Object parameter or from a pileline:

StoreId

UInt32 or PvsDiskLocator: If not finished, thepercent complete is returned in an UInt32. If finished and successful, thePvsDiskLocator is returned.

EXAMPLE 1: Start-PvsCreateDiskStatus

This example shows how to useGet-PvsCreateDiskStatus during Start-PvsCreateDisk processing.

$thePvsDiskLocator = Start-PvsCreateDiskStatus -NametheDiskName -Size 20480 -StoreName theStore -SiteName theSite -VHDX -Dynamic

while ($thePvsDiskLocator -eq$null) #while the create is processing

{

%percentFinished = Get-PvsCreateDiskStatus -NametheDiskName -StoreName theStore # get percent finished orDiskLocator when done

if (%percentFinished.GetType().Name =="PvsDiskLocator")

{

$thePvsDiskLocator = %percentFinished

}

else

{

%percentFinished.ToString() + "% finished" #display percent finished

Start-Sleep -seconds10 #wait 10 seconds more

}

}

"Successful"

Get-PvsDevice

Get the fields for a Device, all Devices in aCollection, Site, Farm View, or Farm. All Devices are returned if no parametersare passed.

One of these optional

Guid[] Guid or DeviceId: GUID of the Device to Get.

string[] Name or DeviceName: Name of Device to Get.

PvsPhysicalAddress[] DeviceMac: MAC of the Device toGet.

Guid[] CollectionId: GUID of the Collection to Getall Devices for.

Guid[] ServerId: GUID of the Server to Get allDevices for.

string[] ServerName: Name of the Server to Get allDevices for.

Guid[] DiskLocatorId: GUID of the DiskLocator to Getall Devices for.

Guid[] SiteViewId: GUID of the Site View to Get allDevices for.

Guid[] SiteId: GUID of the Site.

string[] SiteName: Name of the Site.

Guid[] FarmViewId: GUID of the Farm View to Get allDevices for.

string[] FarmViewName: Name of the Farm View to Getall Devices for.

string[] BdmBoot: Include only the BDM Devices whenset to 1. PXE devices if set to 0. If not included, all Devices are returned.

or one of these optional ; resolutions

string[] CollectionName: Name of the Collection toGet all Devices for.

string[] DiskLocatorName: Name of the DiskLocator toGet all Devices for.

string[] SiteViewName: Name of the Site View to Getall Devices for.

One of these resolutions when needed

Guid[] SiteId: GUID of the Site.

string[] SiteName: Name of the Site.

One of these resolutions when needed

Guid[] StoreId: GUID of the Store that is neededwhen a DiskLocatorName is used.

string[] StoreName: Name of the Store that is neededwhen a DiskLocatorName is used.

Instead of a parameter that matches one of themembers listed

PvsObject[] Object: PvsObjects with the membersbelow can be used as the Object parameter or from a pileline:

DeviceName, CollectionId, ServerId, DiskLocatorId,SiteViewId, SiteId or FarmViewId

If only selected fields are needed, pass them in theFields parameter as a string array.

Guid or DeviceId: Read-only GUID that uniquelyidentifies this Device.

Name or DeviceName: Computer name with no spaces.ASCII computer name characters Max Length=15

CollectionId: GUID of the Collection this Device isto be a member of. It is not used with CollectionName.

CollectionName: Name of the Collection this Deviceis to be a member of. SiteName or SiteId must also be used.

SiteId: GUID of the Site the CollectionName is to bea member of. This or SiteName is used with CollectionName.

SiteName: Name of the Site the CollectionName is tobe a member of. This or SiteId is used with CollectionName.

Description: User description. Default=""Max Length=250

DeviceMac: Ethernet address can have the formXX-XX-XX-XX-XX-XX. Uniquely identifies the Device.

BootFrom: Device to boot from. Choices are 1 forvDisk, 2 for Hard Disk, and 3 for Floppy. This cannot be Set for a Device withPersonal vDisk. Min=1, Max=3, Default=1

ClassName: Used by Automatic Update feature to matchnew versions of Disks to a Device. This cannot be Set for a Device withPersonal vDisk. Default="" Max Length=41

Port: UDP port to use with Stream Service. Min=1025,Max=65534, Default=6901

Enabled: True when it can be booted, falseotherwise. This cannot be Set for a Device with Personal vDisk. Default=true

LocalDiskEnabled: If there is a local disk menuchoice for the Device, this is true. This cannot be Set for a Device withPersonal vDisk. Default=false

Role: Read-only Role of the user for this item. 100is Farm Administrator, 200 is Site Administrator, 300 is CollectionAdministrator, and 400 is Collection Operator. Default=999

Authentication: Device log in authentication.Choices are 0 for none, 1 for User Name/Password, and 2 for Extern. This cannotbe Set for a Device with Personal vDisk. Min=0, Max=2, Default=0

User: Name of user to authenticate before the bootprocess continues. This cannot be Set for a Device with Personal vDisk.Default="" ASCII Max Length=20

Password: Password of user to authenticate beforethe boot process continues. This cannot be Set for a Device with PersonalvDisk. Default="" ASCII Max Length=100

Active: True if the Device is currently active,false otherwise. Default=false

Template: True if the Device is the template in itsCollection, false otherwise. Default=false

AdTimestamp: The time the Active Directory machineaccount password was generated. Do not set this field, it is only setinternally by PVS. Default=0

AdSignature: The signature of the Active Directorymachine account password. Do not set this field, it is only set internally byPVS. Default=0

LogLevel: 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=0

DomainName: Fully qualified name of the domain thatthe Device belongs to. Do not set this field, it is only set internally by PVS.Default="" Max Length=255

DomainObjectSID: The value of the objectSID ADattribute of the same name for the Device's computer account. Do not set thisfield, it is only set internally by PVS. Default="" Max Length=186

DomainControllerName: The name of the DC used tocreate the host's computer account. Do not set this field, it is only setinternally by PVS. Default="" Max Length=4000

DomainTimeCreated: The time that the computeraccount was created. Has the date and time including milliseconds. Do not setthis field, it is only set internally by PVS. Default=Empty

Type: 1 when it performs test of Disks, 2 when itperforms maintenance on Disks, 3 when it has a Personal vDisk, 4 when it has aPersonal vDisk and performs tests, 0 otherwise. Min=0, Max=4, Default=0

PvdDriveLetter: Read-only Personal vDisk Driveletter. Range is E to U and W to Z. Default="" Max Length=1

LocalWriteCacheDiskSize: The size in GB to formatthe Device cache file disk. If the value is 0, then the disk is not formatted.Min=0, Max=2048, Default=0

VirtualHostingPoolId: GUID that uniquely identifiesthe Virtual Hosting Pool for a VM. This is needed when Adding a VM device.Default=00000000-0000-0000-0000-000000000000

TemporaryVersionSet: Read-only true when temporaryversion is set. Default=false

BdmBoot: Use PXE boot when set to false, BDM bootwhen set to true. Default is PXE Default=false

BdmType: Use PXE boot when set to 0, BDM (Bios) bootwhen set to 1 and BDM (Uefi) boot when set to 2. Default=0

BdmFormat: 1 use VHD for BDMboot, 2 use ISO, 3 useUSB. Default=0

BdmUpdated: Timestamp of the last BDM boot diskupdate. Default=Empty

BdmCreated: Timstamp when BDM device wascreated Default=Empty

XsPvsProxyUuid: UUID of XenServer PVS_proxyDefault=00000000-0000-0000-0000-000000000000

XsPvsProxyEnabled: Enable XenServer PVS proxy whenset to true Default=false

PvsDevice[]: If successful, the PvsDevice object(s)are returned.

EXAMPLE 1: Get PvsDevice for Farm

Get all PvsDevice for the Farm.

Get-PvsDevice

EXAMPLE 2: Get PvsDevice for FarmView

Get all PvsDevice for the FarmView namedtheFarmView.

Get-PvsDevice -FarmViewName theFarmView

EXAMPLE 3: Get PvsDevice for Site

Get all PvsDevice for the Site named theSite.

Get-PvsDevice -SiteName theSite

EXAMPLE 4: Get PvsDevice for SiteView

Get all PvsDevice for the SiteView named theSiteViewin the Site named theSite.

Get-PvsDevice -SiteViewName theSiteView -SiteNametheSite

SiteViewId can be used instead of SiteViewName sothat the SiteName or SiteId is not also needed.

EXAMPLE 5: Get PvsDevice for Collection

Get all PvsDevice for the Collection namedtheCollection in the Site named theSite.

Get-PvsDevice -CollectionName theCollection-SiteName theSite

CollectionId can be used instead of CollectionNameso that the SiteName or SiteId is not also needed.

EXAMPLE 6: Get PvsDevice for DiskLocator

Get all PvsDevice for the DiskLocator namedtheDiskLocator in the Site named theSite and Store named theStore.

Get-PvsDevice -DiskLocatorName theDiskLocator-SiteName theSite -StoreName theStore

DiskLocatorId can be used instead of DiskLocatorNameso that the SiteName or SiteId and StoreName or StoreId are not also needed.

EXAMPLE 7: Get PvsDevice for Device

Get the PvsDevice for the Device named theDevice.

Get-PvsDevice -Name theDevice

EXAMPLE 8: Get PvsDevice and Enable

Get all PvsDevice that are not Enabled and thenEnables them.

Get-PvsDevice -Fields Enabled | Where-Object{$_.Enabled -eq $false} | foreach { $o = $_; $o.Enabled = $true; $o } |Set-PvsDevice

The -Fields parameter with only the needed fieldsspecified makes the Get work faster because only those fields are retrieved.

The "foreach { $o = $_; $o.X = Y; $o }"sets the field X to value Y and returns the object again so it can be piped tothe Set command for update.

Get-PvsDeviceBootstrap

Get all Bootstrap files for a Device, and theMenuText for each.

One of these required

Guid[] Guid or DeviceId: GUID of the Device.

string[] Name or DeviceName: Name of the Device.

PvsPhysicalAddress[] DeviceMac: MAC of the Device.

Instead of a parameter that matches one of themembers listed

PvsObject[] Object: PvsObjects with the membersbelow can be used as the Object parameter or from a pileline:

DeviceId

If only selected fields are needed, pass them in theFields parameter as a string array.

These fields exist in the DeviceBootstrap arraywithin each PvsDeviceBootstrap returned.

Each array item is a PvsDeviceBootstrapList object.

Name or Bootstrap: Name of the bootstrap file. Max Length=259

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

PvsDeviceBootstrap[]: If successful, thePvsDeviceBootstrap object(s) are returned.

EXAMPLE 1: Get PvsDeviceBootstrap for Device

Get all PvsDeviceBootstrap for the Device namedtheDevice.

Get-PvsDeviceBootstrap -Name theDevice

EXAMPLE 2: Get PvsDeviceBootstrap for Device MAC

Get all PvsDeviceBootstrap for the Device with MAC02-50-F2-00-00-01.

Get-PvsDeviceBootstrap -DeviceMac"02-50-F2-00-00-01"

Get-PvsDeviceCount

Get count of Devices in a Collection or View.

One of these required

Guid CollectionId: GUID of the Collection to get theDevice Count of.

Guid SiteViewId: GUID of the Site View to get theDevice Count of.

Guid FarmViewId: GUID of the Farm View to get theDevice Count of.

string FarmViewName: Name of the Farm View to getthe Device Count of.

or one of these required ; resolutions

string CollectionName: Name of the Collection to getthe Device Count of.

string SiteViewName: Name of the Site View to getthe Device Count of.

One of these resolutions when needed

Guid SiteId: GUID of the Site.

string SiteName: Name of the Site.

Instead of a parameter that matches one of themembers listed

PvsObject[] Object: PvsObjects with the membersbelow can be used as the Object parameter or from a pileline:

CollectionId, SiteViewId or FarmViewId

UInt32: If successful, the numeric value is returned

EXAMPLE 1: Get-PvsDeviceCount Returns the Number (or Count) of PvsDevice inPvsCollection

Get-PvsDeviceCount -CollectionName theCollection-SiteName theSite

CollectionId can be used instead of CollectionNameso that the SiteName or SiteId is not also needed.

EXAMPLE 2: Get-PvsDeviceCount Returns the Number (or Count) of PvsDevice inPvsFarmView

Get-PvsDeviceCount -FarmViewName theFarmView

EXAMPLE 3: Get-PvsDeviceCount Returns the Number (or Count) of PvsDevice inPvsSiteView

Get-PvsDeviceCount -SiteViewName theSiteView-SiteName theSite

SiteViewId can be used instead of SiteViewName sothat the SiteName or SiteId is not also needed.

Get-PvsDeviceDiskLocatorEnabled

Return true if a Device/DiskLocator is enabled.

One of these required

Guid Guid or DeviceId: Device GUID, to see if theDiskLocator for it is enabled.

string Name or DeviceName: Device name, to see ifthe DiskLocator for it is enabled.

PvsPhysicalAddress[] DeviceMac: MAC of the Device,to see if the DiskLocator for it is enabled.

This required

Guid DiskLocatorId: DiskLocator GUID, to see if itis enabled for the Device.

or this required ; resolution

string DiskLocatorName: DiskLocator name, to see ifit is enabled for the Device.

One of these resolutions when needed

Guid StoreId: GUID of the Store that is needed whena DiskLocatorName is used.

string StoreName: Name of the Store that is neededwhen a DiskLocatorName is used.

Instead of a parameter that matches one of themembers listed

PvsObject[] Object: PvsObjects with the membersbelow can be used as the Object parameter or from a pileline:

DeviceId or DiskLocatorId

String: If successful, the String value is returned.

EXAMPLE 1: Get-PvsDeviceDiskLocatorEnabled Determine ifPvsDevice/PvsDiskLocator is Enabled

Get-PvsDeviceDiskLocatorEnabled -Name theDevice-DiskLocatorName theDiskLocator -StoreName theStore

DiskLocatorId can be used instead of DiskLocatorNameso that the StoreName or StoreId are not also needed.

Get-PvsDeviceDiskTempVersion

Get Temporary Disk Version information for a Device,DiskLocator, Disk Version, Site or Farm.

One of these optional

Guid[] Guid or DeviceId: GUID of the Device to getthe temporary disk version information for.

string[] Name or DeviceName: Name of the Device toget the temporary disk version information for.

PvsPhysicalAddress[] DeviceMac: MAC of the Device toget the temporary disk version information for.

Guid[] SiteId: GUID of the Site to get temporarydisk version information for, and also resolution for DiskLocatorName.

string[] SiteName: Name of the Site to get temporarydisk version information for, and also resolution for DiskLocatorName.

Guid[] DiskLocatorId: GUID of the Disk Locator toget temporary disk version information for.

or this optional ; resolution

string[] DiskLocatorName: Name of the Disk Locatorto get temporary disk version information for.

This optional ; resolution

string[] Version: Version of the DiskLocatorspecified to get temporary disk version information for. Needs theDiskLocatorId or DiskLocatorName too.

One of these resolutions when needed

Guid[] SiteId: GUID of the Site to get temporarydisk version information for, and also resolution for DiskLocatorName.

string[] SiteName: Name of the Site to get temporarydisk version information for, and also resolution for DiskLocatorName.

One of these resolutions when needed

Guid[] StoreId: GUID of the Store that is neededwhen a DiskLocatorName is used.

string[] StoreName: Name of the Store that is neededwhen a DiskLocatorName is used.

Instead of a parameter that matches one of themembers listed

PvsObject[] Object: PvsObjects with the membersbelow can be used as the Object parameter or from a pileline:

DeviceId, SiteId or DiskLocatorId

If only selected fields are needed, pass them in theFields parameter as a string array.

Guid or DeviceId: Read-only GUID that uniquelyidentifies the Device with temporary version.

Name or DeviceName: Read-only Computer name thatuniquely identifies the Device with temporary version. ASCII computer namecharacters

DiskLocatorId: Read-only GUID that uniquelyidentifies then Disk Locator with temporary version.

DiskLocatorName: Read-only Name of the Disk LocatorFile with temporary version. It is unique within the Store. ASCII

SiteId: Read-only GUID of the Site the Device andDiskLocator are a member of.

SiteName: Read-only Name of the Site the Device andDiskLocator are a member of.

StoreId: Read-only GUID of the Store that the DiskLocator is a member of.

StoreName: Read-only Name of the Store that the DiskLocator is a member of.

Version: Read-only Disk version the temporary isfor.

PvsDeviceDiskTempVersion[]: If successful, the PvsDeviceDiskTempVersionobject(s) are returned.

EXAMPLE 1: Get PvsDeviceDiskTempVersion for Device

Get the PvsDeviceDiskTempVersion for the Devicenamed theDevice.

Get-PvsDeviceDiskTempVersion -Name theDevice

EXAMPLE 2: Get PvsDeviceDiskTempVersion for DiskLocator

Get all PvsDeviceDiskTempVersion for the DiskLocatornamed theDiskLocator in the Site named theSite and Store named theStore.

Get-PvsDeviceDiskTempVersion -DiskLocatorNametheDiskLocator -SiteName theSite -StoreName theStore

DiskLocatorId can be used instead of DiskLocatorNameso that the SiteName or SiteId and StoreName or StoreId are not also needed.

EXAMPLE 3: Get PvsDeviceDiskTempVersion for DiskLocator with Version

Get-PvsDeviceDiskTempVersion -DiskLocatorNametheDiskLocator -Version 4 -SiteName theSite -StoreName theStore

DiskLocatorId can be used instead of DiskLocatorNameso that the StoreName or StoreId are not also needed.

EXAMPLE 4: Get PvsDeviceDiskTempVersion for Site

Get all PvsDeviceDiskTempVersion for the Site namedtheSite.

Get-PvsDeviceDiskTempVersion -SiteName theSite

EXAMPLE 5: Get PvsDeviceDiskTempVersion for Farm

Get all PvsDeviceDiskTempVersion for the Farm.

Get-PvsDeviceDiskTempVersion

Get-PvsDeviceInfo

Get the fields and status for a Device, all Devicesin a Collection, Site, Farm View, or Farm. All Devices are returned if noparameters are passed.

One of these optional

Guid[] Guid or DeviceId: GUID of the Device to Get.

string[] Name or DeviceName: Name of Device to Get.

PvsPhysicalAddress[] DeviceMac: MAC of the Device toGet.

Guid[] CollectionId: GUID of the Collection to Getall Devices for.

Guid[] ServerId: GUID of the Server to Get allDevices for.

string[] ServerName: Name of the Server to Get allDevices for.

Guid[] DiskLocatorId: GUID of the DiskLocator to Getall Devices for.

Guid[] SiteViewId: GUID of the Site View to Get allDevices for.

Guid[] SiteId: GUID of the Site.

string[] SiteName: Name of the Site.

Guid[] FarmViewId: GUID of the Farm View to Get allDevices for.

string[] FarmViewName: Name of the Farm View to Getall Devices for.

string[] BdmBoot: Include only the BDM Devices whenset to 1. PXE devices if set to 0. If not included, all Devices are returned.

or one of these optional ; resolutions

string[] CollectionName: Name of the Collection toGet all Devices for.

string[] DiskLocatorName: Name of the DiskLocator toGet all Devices for.

string[] SiteViewName: Name of the Site View to Getall Devices for.

Optional

SwitchParameter OnlyActive: If -OnlyActive isspecified, include only the active Devices, otherwise all Devices are returned.Only active Devices are always returned for ServerId, ServerName, or version.

uint MakLicenseActivated: Optional MAK licensingindicator value to only return active Devices for. Values are: 0 (MAK notused), 1 (Not Activated), 2 (Activated).

uint Version: Version of the Disk to Get all activeDevices for. This is used with DiskLocatorId or DiskLocatorName.

One of these resolutions when needed

Guid[] SiteId: GUID of the Site.

string[] SiteName: Name of the Site.

One of these resolutions when needed

Guid[] StoreId: GUID of the Store that is neededwhen a DiskLocatorName is used.

string[] StoreName: Name of the Store that is neededwhen a DiskLocatorName is used.

Instead of a parameter that matches one of themembers listed

PvsObject[] Object: PvsObjects with the membersbelow can be used as the Object parameter or from a pileline:

DeviceName, CollectionId, ServerId, DiskLocatorId,SiteViewId, SiteId or FarmViewId

If only selected fields are needed, pass them in theFields parameter as a string array.

Guid or DeviceId: Read-only GUID that uniquelyidentifies this Device.

Name or DeviceName: Computer name with no spaces.ASCII computer name characters Max Length=15

CollectionId: GUID of the Collection this Device isto be a member of. It is not used with CollectionName.

CollectionName: Name of the Collection this Deviceis to be a member of. SiteName or SiteId must also be used.

SiteId: GUID of the Site the CollectionName is to bea member of. This or SiteName is used with CollectionName.

SiteName: Name of the Site the CollectionName is tobe a member of. This or SiteId is used with CollectionName.

Description: User description. Default=""Max Length=250

DeviceMac: Ethernet address can have the formXX-XX-XX-XX-XX-XX. Uniquely identifies the Device.

BootFrom: Device to boot from. Choices are 1 forvDisk, 2 for Hard Disk, and 3 for Floppy. This cannot be Set for a Device withPersonal vDisk. Min=1, Max=3, Default=1

ClassName: Used by Automatic Update feature to matchnew versions of Disks to a Device. This cannot be Set for a Device withPersonal vDisk. Default="" Max Length=41

Port: UDP port to use with Stream Service. Min=1025,Max=65534, Default=6901

Enabled: True when it can be booted, falseotherwise. This cannot be Set for a Device with Personal vDisk. Default=true

LocalDiskEnabled: If there is a local disk menuchoice for the Device, this is true. This cannot be Set for a Device withPersonal vDisk. Default=false

Role: Read-only Role of the user for this item. 100is Farm Administrator, 200 is Site Administrator, 300 is CollectionAdministrator, and 400 is Collection Operator. Default=999

Authentication: Device log in authentication.Choices are 0 for none, 1 for User Name/Password, and 2 for Extern. This cannotbe Set for a Device with Personal vDisk. Min=0, Max=2, Default=0

User: Name of user to authenticate before the bootprocess continues. This cannot be Set for a Device with Personal vDisk.Default="" ASCII Max Length=20

Password: Password of user to authenticate beforethe boot process continues. This cannot be Set for a Device with PersonalvDisk. Default="" ASCII Max Length=100

Active: True if the Device is currently active,false otherwise. Default=false

Template: True if the Device is the template in itsCollection, false otherwise. Default=false

AdTimestamp: The time the Active Directory machineaccount password was generated. Do not set this field, it is only setinternally by PVS. Default=0

AdSignature: The signature of the Active Directorymachine account password. Do not set this field, it is only set internally byPVS. Default=0

LogLevel: 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=0

DomainName: Fully qualified name of the domain thatthe Device belongs to. Do not set this field, it is only set internally by PVS.Default="" Max Length=255

DomainObjectSID: The value of the objectSID ADattribute of the same name for the Device's computer account. Do not set thisfield, it is only set internally by PVS. Default="" Max Length=186

DomainControllerName: The name of the DC used tocreate the host's computer account. Do not set this field, it is only setinternally by PVS. Default="" Max Length=4000

DomainTimeCreated: The time that the computeraccount was created. Has the date and time including milliseconds. Do not setthis field, it is only set internally by PVS. Default=Empty

Type: 1 when it performs test of Disks, 2 when itperforms maintenance on Disks, 3 when it has a Personal vDisk, 4 when it has aPersonal vDisk and performs tests, 0 otherwise. Min=0, Max=4, Default=0

PvdDriveLetter: Read-only Personal vDisk Driveletter. Range is E to U and W to Z. Default="" Max Length=1

LocalWriteCacheDiskSize: The size in GB to formatthe Device cache file disk. If the value is 0, then the disk is not formatted.Min=0, Max=2048, Default=0

VirtualHostingPoolId: GUID that uniquely identifiesthe Virtual Hosting Pool for a VM. This is needed when Adding a VM device.Default=00000000-0000-0000-0000-000000000000

TemporaryVersionSet: Read-only true when temporaryversion is set. Default=false

BdmBoot: Use PXE boot when set to false, BDM bootwhen set to true. Default is PXE Default=false

BdmType: Use PXE boot when set to 0, BDM (Bios) bootwhen set to 1 and BDM (Uefi) boot when set to 2. Default=0

BdmFormat: 1 use VHD for BDMboot, 2 use ISO, 3 useUSB. Default=0

BdmUpdated: Timestamp of the last BDM boot diskupdate. Default=Empty

BdmCreated: Timstamp when BDM device was created Default=Empty

XsPvsProxyUuid: UUID of XenServer PVS_proxyDefault=00000000-0000-0000-0000-000000000000

XsPvsProxyEnabled: Enable XenServer PVS proxy whenset to true Default=false

Ip: Read-only IP of the Device. It is equal to0.0.0.0 if the Device is not active.

ServerPortConnection: Read-only Port of the Serverthat the Device is using. It is equal to 0 if the Device is not active.Default=0

ServerIpConnection: Read-only IP of the Server thatthe Device is using. It is equal to 0.0.0.0 if the Device is not active.

ServerId: Read-only GUID of the Server that theDevice is using. It is equal to 00000000-0000-0000-0000-000000000000 if theDevice is not active.

ServerName: Read-only Name of the Server that theDevice is using. It is equal to "" if the Device is not active.

DiskLocatorId: Read-only GUID of the Disk Locatorthat the Device is using. It is equal to 00000000-0000-0000-0000-000000000000if the Device is not active.

DiskLocatorName: Read-only name of the Disk LocatorFile that the Device is using. It is equal to the list of Disk Locator namesfor the Device if the Device is not active.

DiskVersion: Read-only version of the Disk LocatorFile that the Device is using. It is equal to 0 if the Device is not active.Default=0

DiskVersionAccess: State of the Disk Version. Valuesare: 0 (Production), 1 (Maintenance), 2 (MaintenanceHighestVersion), 3(Override), 4 (Merge), 5 (MergeMaintenance), 6 (MergeTest), and 7 (Test). It isequal to 0 if the Device is not active. Default=0

DiskFileName: Name of the Disk File including theextension. It is equal to "" if the Device is not active.

Status: 1 or 2 numbers in the format n,n. They arethe number of retries and if ram cache is being used, ram cache percent used.It is equal to "" if the Device is not active.

LicenseType: 0 when None, 1 for Desktop, 2 forServer, 5 for OEM SmartClient, 6 for XenApp, 7 for XenDesktop. It is equal to 0if the Device is not active. Default=0

MakLicenseActivated: Read-only indicator if MAKlicensing is being used and is activated. Values are: 0 (MAK not used), 1 (NotActivated), 2 (Activated). It is equal to 0 if the Device is not active.Default=0

Model: 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.

License: 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 isnot active. Default=0

PvsDeviceInfo[]: If successful, the PvsDeviceInfoobject(s) are returned.

EXAMPLE 1: Get PvsDeviceInfo for Farm

Get all PvsDeviceInfo for the Farm.

Get-PvsDeviceInfo

EXAMPLE 2: Get PvsDeviceInfo for FarmView

Get all PvsDeviceInfo for the FarmView namedtheFarmView.

Get-PvsDeviceInfo -FarmViewName theFarmView

EXAMPLE 3: Get PvsDeviceInfo for Site

Get all PvsDeviceInfo for the Site named theSite.

Get-PvsDeviceInfo -SiteName theSite

EXAMPLE 4: Get PvsDeviceInfo for SiteView

Get all PvsDeviceInfo for the SiteView namedtheSiteView in the Site named theSite.

Get-PvsDeviceInfo -SiteViewName theSiteView-SiteName theSite

SiteViewId can be used instead of SiteViewName sothat the SiteName or SiteId is not also needed.

EXAMPLE 5: Get PvsDeviceInfo for Collection

Get all PvsDeviceInfo for the Collection namedtheCollection in the Site named theSite.

Get-PvsDeviceInfo -CollectionName theCollection-SiteName theSite

CollectionId can be used instead of CollectionNameso that the SiteName or SiteId is not also needed.

EXAMPLE 6: Get PvsDeviceInfo for DiskLocator

Get all PvsDeviceInfo for the DiskLocator namedtheDiskLocator in the Site named theSite and Store named theStore.

Get-PvsDeviceInfo -DiskLocatorName theDiskLocator-SiteName theSite -StoreName theStore

DiskLocatorId can be used instead of DiskLocatorNameso that the SiteName or SiteId and StoreName or StoreId are not also needed.

EXAMPLE 7: Get PvsDeviceInfo for Device

Get the PvsDeviceInfo for the Device namedtheDevice.

Get-PvsDeviceInfo -Name theDevice

EXAMPLE 8: Get PvsDeviceInfo and Enable

Get all PvsDeviceInfo that are not Enabled and thenEnables them.

Get-PvsDeviceInfo -Fields Enabled | Where-Object{$_.Enabled -eq $false} | foreach { $o = $_; $o.Enabled = $true; $o } |Set-PvsDevice

The -Fields parameter with only the needed fieldsspecified makes the Get work faster because only those fields are retrieved.

The "foreach { $o = $_; $o.X = Y; $o }"sets the field X to value Y and returns the object again so it can be piped tothe Set command for update.

Get-PvsDevicePersonality

Get the Device Personality names and values.

One of these required

Guid[] Guid or DeviceId: GUID of the Device.

string[] Name or DeviceName: Name of the Device.

PvsPhysicalAddress[] DeviceMac: MAC of the Device.

Instead of a parameter that matches one of themembers listed

PvsObject[] Object: PvsObjects with the membersbelow can be used as the Object parameter or from a pileline:

DeviceId

If only selected fields are needed, pass them in theFields parameter as a string array.

These fields exist in the DevicePersonality arraywithin each PvsDevicePersonality returned.

Each array item is a PvsDevicePersonalityListobject.

Name: Name of the Device personality item. MaxLength=250

Value: Value for the Device personality item. MaxLength=1000

PvsDevicePersonality[]: If successful, thePvsDevicePersonality object(s) are returned.

EXAMPLE 1: Get PvsDevicePersonality for Device

Get all PvsDevicePersonality for the Device namedtheDevice.

Get-PvsDevicePersonality -Name theDevice

EXAMPLE 2: Get PvsDevicePersonality for Device MAC

Get all PvsDevicePersonality for the Device with MAC02-50-F2-00-00-01.

Get-PvsDevicePersonality -DeviceMac"02-50-F2-00-00-01"

Get-PvsDeviceStatus

Get the DeviceStatus fields for a Device or allDevices for a Server, Disk Locator, or Farm. All Devices are returned if noparameters are passed.

One of these optional

Guid[] Guid or DeviceId: GUID of the Device to Getstatus for.

string[] Name or DeviceName: Name of Device to Getstatus for.

PvsPhysicalAddress[] DeviceMac: MAC of the Device toGet status for.

Guid[] ServerId: GUID of the Server to Get allDevice Status for.

string[] ServerName: Name of the Server to Get allDevice Status for.

Guid[] DiskLocatorId: GUID of the Disk Locator toGet all DeviceStatus for.

Guid[] CollectionId: GUID of the Collection to Getall DeviceStatus for.

or one of these optional ; resolutions

string[] DiskLocatorName: Name of the Disk LocatorFile to Get all DeviceStatus for.

string[] CollectionName: Name of the Collection toGet all DeviceStatus for.

One of these resolutions when needed

Guid[] SiteId: GUID of the Site.

string[] SiteName: Name of the Site.

One of these resolutions when needed

Guid[] StoreId: GUID of the Store that is neededwhen a DiskLocatorName is used.

string[] StoreName: Name of the Store that is neededwhen a DiskLocatorName is used.

Instead of a parameter that matches one of themembers listed

PvsObject[] Object: PvsObjects with the membersbelow can be used as the Object parameter or from a pileline:

DeviceId, ServerId, DiskLocatorId or CollectionId

If only selected fields are needed, pass them in theFields parameter as a string array.

Guid or DeviceId: Read-only GUID of the Device. Canbe used with Get Device.

Name or DeviceName: Read-only Name of the Device.Can be used with Get Device.

Ip: Read-only IP of the Device.

ServerPortConnection: Read-only Port of the Serverthat the Device is using. Default=0

ServerIpConnection: Read-only IP of the Server thatthe Device is using.

ServerId: Read-only GUID of the Server that theDevice is using.

ServerName: Read-only Name of the Server that the Deviceis using.

DiskLocatorId: Read-only GUID of the Disk Locatorthat the Device is using.

DiskLocatorName: Read-only name of the Disk LocatorFile that the Device is using.

DiskVersion: Read-only version of the Disk LocatorFile that the Device is using. Default=0

DiskVersionAccess: State of the Disk Version. Valuesare: 0 (Production), 1 (Maintenance), 2 (MaintenanceHighestVersion), 3(Override), 4 (Merge), 5 (MergeMaintenance), 6 (MergeTest), and 7 (Test)Default=0

DiskFileName: Name of the Disk File including theextension.

Status: 1 or 2 numbers in the format n,n. They arethe number of retries and if ram cache is being used, ram cache percent used.

LicenseType: 0 when None, 1 for Desktop, 2 forServer, 5 for OEM SmartClient, 6 for XenApp, 7 for XenDesktop. Default=0

MakLicenseActivated: Read-only indicator if MAKlicensing is being used and is activated. Values are: 0 (MAK not used), 1 (NotActivated), 2 (Activated). Default=0

PvsDeviceStatus[]: If successful, thePvsDeviceStatus object(s) are returned.

EXAMPLE 1: Get PvsDeviceStatus for Farm

Get all PvsDeviceStatus for the Farm.

Get-PvsDeviceStatus

EXAMPLE 2: Get PvsDeviceStatus for FarmView

Get all PvsDeviceStatus for the FarmView namedtheFarmView.

Get-PvsDeviceStatus -FarmViewName theFarmView

EXAMPLE 3: Get PvsDeviceStatus for Site

Get all PvsDeviceStatus for the Site named theSite.

Get-PvsDeviceStatus -SiteName theSite

EXAMPLE 4: Get PvsDeviceStatus for SiteView

Get all PvsDeviceStatus for the SiteView namedtheSiteView in the Site named theSite.

Get-PvsDeviceStatus -SiteViewName theSiteView-SiteName theSite

SiteViewId can be used instead of SiteViewName sothat the SiteName or SiteId is not also needed.

EXAMPLE 5: Get PvsDeviceStatus for Collection

Get all PvsDeviceStatus for the Collection namedtheCollection in the Site named theSite.

Get-PvsDeviceStatus -CollectionName theCollection-SiteName theSite

CollectionId can be used instead of CollectionNameso that the SiteName or SiteId is not also needed.

EXAMPLE 6: Get PvsDeviceStatus for DiskLocator

Get all PvsDeviceStatus for the DiskLocator namedtheDiskLocator in the Site named theSite and Store named theStore.

Get-PvsDeviceStatus -DiskLocatorName theDiskLocator-SiteName theSite -StoreName theStore

DiskLocatorId can be used instead of DiskLocatorNameso that the SiteName or SiteId and StoreName or StoreId are not also needed.

EXAMPLE 7: Get PvsDeviceStatus for Device

Get the PvsDeviceStatus for the Device namedtheDevice.

Get-PvsDeviceStatus -Name theDevice

Get-PvsDirectory

Look for Directories or Drives on the Serverspecified. Return a String array of the Directories or Drives found.

One of these required

Guid Guid or ServerId: GUID of the Server to get alist of Directories or Drives.

string Name or ServerName: Name of the Server to geta list of Directories or Drives.

Optional

string Path: Path to get list of Directories for. Ifnot specified, the Drives are returned.

Instead of a parameter that matches one of themembers listed

PvsObject[] Object: PvsObjects with the membersbelow can be used as the Object parameter or from a pileline:

ServerId

string[]: If successful, the array of directorynames is returned.

EXAMPLE 1: Get-PvsDirectory for Name

Get-PvsDirectory -Name theServer -Path"C:\directory"

EXAMPLE 2: Get-PvsDirectory for PvsServer Using Pipe

The Get-PvsServer output is piped to theGet-PvsDirectory.

Get-PvsServer -Name theServer -Fields Guid |Get-PvsDirectory -Path "C:\directory"

The -Fields parameter with only the needed fieldsspecified makes the Get work faster because only those fields are retrieved.

Get-PvsDisk

Get the fields for a single disk.

This required

Guid[] Guid or DiskLocatorId: GUID of the DiskLocator.

or this required ; resolution

string[] Name or DiskLocatorName: Name of the DiskLocator.

One of these resolutions when needed

Guid[] SiteId: GUID of the Site.

string[] SiteName: Name of the Site.

One of these resolutions when needed

Guid[] StoreId: GUID of the Store that is neededwhen a DiskLocatorName is used.

string[] StoreName: Name of the Store that is neededwhen a DiskLocatorName is used.

Instead of a parameter that matches one of themembers listed

PvsObject[] Object: PvsObjects with the membersbelow can be used as the Object parameter or from a pileline:

DiskLocatorId

If only selected fields are needed, pass them in theFields parameter as a string array.

Class: Class of the Disk. Max Length=40

ImageType: Type of this image (software type). MaxLength=40

DiskSize: Read-only size of the image. The value is0 when it is not available. Default=0

VhdBlockSize: Block size in KB. For VHD it is onlyused with Dynamic type. Tested sizes for VHD are 512, 2048, and 16384. VHDMin=512, Max=16384, Default=2048. For VHDX it is used for all types. Testedsize for VHDX is 32768. VHDX Min=1024, Max= 262144, Default=32768. Default=0

LogicalSectorSize: Logical Sector Size. Values are:512, 4096, Default=512

WriteCacheSize: RAM cache size (MB). Not 0 when usedwith Cache in Device RAM, and Cache in Device RAM with Overflow on Hard Disk. Avalue of 0 will disable the RAM use for Cache in Device RAM with Overflow onHard Disk. Min=0, Max=131072, Default=0

AutoUpdateEnabled: Automatically update this imagefor matching Devices when set to true. Default false

ActivationDateEnabled: Use activation date toactivate image when set to true. Default false

AdPasswordEnabled: Enable AD password managementwhen set to true.

HaEnabled: Enable HA when set to true.

PrinterManagementEnabled: Invalid printers will bedeleted from the Device when set to true.

WriteCacheType: 0 (Private), (other values arestandard image) 1 (Cache on Server), 3 (Cache in Device RAM), 4 (Cache onDevice Hard Disk), 6 (Device RAM Disk), 7 (Cache on Server, Persistent), or 9(Cache in Device RAM with Overflow on Hard Disk). Min=0, Max=9, Default=0

LicenseMode: 0 (None), 1 (Multiple Activation Key),or 2 (Key Management Service). Min=0, Max=2, Default=0

ActiveDate: Date to activate the disk ifAutoUpdateEnabled and activationDateEnabled are true. Has the date. Empty whenthe AutoUpdateEnabled or activationDateEnabled are false.

LongDescription: Description of the Disk. MaxLength=399

SerialNumber: User defined serial number. MaxLength=36

Date: User defined date. Max Length=40

Author: User defined author. Max Length=40

Title: User defined title. Max Length=40

Company: User defined company. Max Length=40

InternalName: User defined name. Max Length=63

OriginalFile: User defined original file. MaxLength=127

HardwareTarget: User defined hardware target. MaxLength=127

MajorRelease: User defined major release number.Min=0, Max=4294967295, Default=0

MinorRelease: User defined minor release number.Min=0, Max=4294967295, Default=0

Build: User defined build number. Min=0,Max=4294967295, Default=0

VHDX: If VHDX is true, the format of the image isVHDX. Otherwise it is VHD. Default=false

PvsDisk[]: If successful, the PvsDisk object(s) arereturned.

EXAMPLE 1: Get PvsDisk for DiskLocator

Get the PvsDisk for the DiskLocator namedtheDiskLocator in the Site named theSite and Store named theStore.

Get-PvsDisk -Name theDiskLocator -SiteName theSite-StoreName theStore

Guid can be used instead of Name so that theSiteName or SiteId and StoreName or StoreId are not also needed.

Get-PvsDiskInfo

Get the fields for a Disk and Disk Locator or allDisks and Disk Locators for a Device, Server, Store, Site, or Farm. All Disksand DiskLocators are returned if no parameters are passed.

One of these optional

Guid[] Guid or DiskLocatorId: GUID of the DiskLocator to Get.

Guid[] DeviceId: GUID of the Device to Get allDiskLocators for.

string[] DeviceName: Name of the Device to Get allDiskLocators for.

PvsPhysicalAddress[] DeviceMac: MAC of the Device toGet all DiskLocators for.

Guid[] ServerId: GUID of the Server to Get allDiskLocators for.

string[] ServerName: Name of the Server to Get allDiskLocators for.

Guid[] UpdateTaskId: GUID of the Update Task to Getall DiskLocators for.

Guid[] SiteId: GUID of the Site to Get allDiskLocators for.

string[] SiteName: Name of the Site to Get allDiskLocators for.

or one of these optional ; resolutions

string[] Name or DiskLocatorName: Name of the DiskLocator File to Get.

Guid[] StoreId: GUID of the Store to Get allDiskLocators for.

string[] StoreName: Name of the Store to Get allDiskLocators for.

string[] UpdateTaskName: Name of the Update Task toGet all DiskLocators for.

One of these optional

SwitchParameter Single: If -Single is specified,include single server connection. If this and All are not included, bothconnection types are included.

SwitchParameter All: If -All is specified, includeall server connections for the store. If this and Single are not included, bothconnection types are included.

Optional

SwitchParameter OnlyActive: If -OnlyActive isspecified, include only the active DiskLocators. If not included, allDiskLocators are returned.

SwitchParameter UpdateDevice: If -UpdateDevice isspecified, include only DiskLocators that have an Update Device.

One of these resolutions when needed

Guid[] SiteId: GUID of the Site to Get allDiskLocators for.

string[] SiteName: Name of the Site to Get allDiskLocators for.

One of these resolutions when needed

Guid[] StoreId: GUID of the Store to Get allDiskLocators for.

string[] StoreName: Name of the Store to Get allDiskLocators for.

Instead of a parameter that matches one of themembers listed

PvsObject[] Object: PvsObjects with the membersbelow can be used as the Object parameter or from a pileline:

DiskLocatorId, DeviceId, ServerId, UpdateTaskId orSiteId

If only selected fields are needed, pass them in theFields parameter as a string array.

Guid or DiskLocatorId: Read-only GUID that uniquelyidentifies this Disk Locator.

Name or DiskLocatorName: Name of the Disk LocatorFile. It is unique within the Store. ASCII Max Length=52

SiteId: GUID of the Site this DiskLocator is to be amember of. It is not used with SiteName.

SiteName: Name of the Site this DiskLocator is to bea member of. It is not used with SiteId.

StoreId: GUID of the Store that this Disk Locator isa member of. SiteName or SiteId must also be used. It is not used withStoreName.

StoreName: Name of the Store that this Disk Locatoris a member of. SiteName or SiteId must also be used. It is not used withStoreId.

Description: User description. Default=""Max Length=250

MenuText: Text that is displayed in the Boot Menu.If this field has no value, the name value is used. Default="" ASCIIMax Length=64

ServerId: GUID of the single Server that this DiskLocator is assigned to. It is not used with ServerName.Default=00000000-0000-0000-0000-000000000000

ServerName: Name of the single Server that this DiskLocator is assigned to. It is not used with ServerId. Default=""

Enabled: True when this disk can be booted, falseotherwise. Default=true

Role: Read-only Role of the user for this item. 100is Farm Administrator, 200 is Site Administrator, 300 is CollectionAdministrator, and 999 is read-only. Default=999

Mapped: True if the Disk is currently mapped, falseotherwise. Default=false

EnabledForDevice: True when this disk is enabled forthe Device specified, false otherwise. This is only returned when a Device isspecified. Default=true

Active: True if the DiskLocator is currently active,false otherwise. Default=false

RebalanceEnabled: True when this Server canautomatically rebalance Devices, false otherwise. Default=false

RebalanceTriggerPercent: Percent over fair load thattriggers a dynamic Device rebalance. Min=5, Max=5000, Default=25

SubnetAffinity: Qualifier for subnet affinity whenassigning a Server. 0=None, 1=Best Effort, 2=Fixed. Min=0, Max=2, Default=0

DiskUpdateDeviceId: GUID of the DiskUpdateDevicethat is used when updates are performed.Default=00000000-0000-0000-0000-000000000000

DiskUpdateDeviceName: Name of the DiskUpdateDevicethat is used when updates are performed. Default=""

TemporaryVersionSet: Read-only true when temporaryversion(s) are set. Default=false

Class: Class of the Disk. Max Length=40

ImageType: Type of this image (software type). MaxLength=40

DiskSize: Read-only size of the image. The value is0 when it is not available. Default=0

VhdBlockSize: Block size in KB. For VHD it is onlyused with Dynamic type. Tested sizes for VHD are 512, 2048, and 16384. VHDMin=512, Max=16384, Default=2048. For VHDX it is used for all types. Testedsize for VHDX is 32768. VHDX Min=1024, Max= 262144, Default=32768. Default=0

LogicalSectorSize: Logical Sector Size. Values are:512, 4096, Default=512

WriteCacheSize: RAM cache size (MB). Not 0 when usedwith Cache in Device RAM, and Cache in Device RAM with Overflow on Hard Disk. Avalue of 0 will disable the RAM use for Cache in Device RAM with Overflow onHard Disk. Min=0, Max=131072, Default=0

AutoUpdateEnabled: Automatically update this imagefor matching Devices when set to true. Default false

ActivationDateEnabled: Use activation date toactivate image when set to true. Default false

AdPasswordEnabled: Enable AD password managementwhen set to true.

HaEnabled: Enable HA when set to true.

PrinterManagementEnabled: Invalid printers will bedeleted from the Device when set to true.

WriteCacheType: 0 (Private), (other values arestandard image) 1 (Cache on Server), 3 (Cache in Device RAM), 4 (Cache onDevice Hard Disk), 6 (Device RAM Disk), 7 (Cache on Server, Persistent), or 9(Cache in Device RAM with Overflow on Hard Disk). Min=0, Max=9, Default=0

LicenseMode: 0 (None), 1 (Multiple Activation Key),or 2 (Key Management Service). Min=0, Max=2, Default=0

ActiveDate: Date to activate the disk ifAutoUpdateEnabled and activationDateEnabled are true. Has the date. Empty whenthe AutoUpdateEnabled or activationDateEnabled are false.

LongDescription: Description of the Disk. MaxLength=399

SerialNumber: User defined serial number. MaxLength=36

Date: User defined date. Max Length=40

Author: User defined author. Max Length=40

Title: User defined title. Max Length=40

Company: User defined company. Max Length=40

InternalName: User defined name. Max Length=63

OriginalFile: User defined original file. MaxLength=127

HardwareTarget: User defined hardware target. MaxLength=127

MajorRelease: User defined major release number.Min=0, Max=4294967295, Default=0

MinorRelease: User defined minor release number.Min=0, Max=4294967295, Default=0

Build: User defined build number. Min=0,Max=4294967295, Default=0

VHDX: If VHDX is true, the format of the image isVHDX. Otherwise it is VHD. Default=false

DeviceCount: Read-only count of Devices. Default=0

Locked: True if the Disk is currently locked, falseotherwise. Default=false

PvsDiskInfo[]: If successful, the PvsDiskInfoobject(s) are returned.

EXAMPLE 1: Get PvsDiskInfo for Farm

Get all PvsDiskInfo for the Farm.

Get-PvsDiskInfo

EXAMPLE 2: Get PvsDiskInfo for Site

Get all PvsDiskInfo for the Site named theSite.

Get-PvsDiskInfo -SiteName theSite

EXAMPLE 3: Get PvsDiskInfo for Site and Store

Get all PvsDiskInfo for the Site named theSite andStore named theStore.

Get-PvsDiskInfo -SiteName theSite -StoreNametheStore

EXAMPLE 4: Get PvsDiskInfo for DiskLocator

Get the PvsDiskInfo for the DiskLocator namedtheDiskLocator in the Site named theSite and Store named theStore.

Get-PvsDiskInfo -Name theDiskLocator -SiteNametheSite -StoreName theStore

Guid can be used instead of Name so that theSiteName or SiteId and StoreName or StoreId are not also needed.

EXAMPLE 5: Get PvsDiskInfo and Enable

Get all PvsDiskInfo that are not Enabled and thenEnables them.

Get-PvsDiskInfo -Fields Enabled | Where-Object{$_.Enabled -eq $false} | foreach { $o = $_; $o.Enabled = $true; $o } |Set-PvsDiskLocator

The -Fields parameter with only the needed fieldsspecified makes the Get work faster because only those fields are retrieved.

The "foreach { $o = $_; $o.X = Y; $o }"sets the field X to value Y and returns the object again so it can be piped tothe Set command for update.

Get-PvsDiskInventory

Get the fields for Inventory Status of a DiskVersion or all Disk Versions for a Disk Locator.

This required

Guid[] Guid or DiskLocatorId: GUID of the DiskLocator to Get Disk Version Inventory of.

or this required ; resolution

string[] Name or DiskLocatorName: Name of the DiskLocator to Get Disk Version Inventory of.

Optional

uint Version: Specific Version to Get.

One of these resolutions when needed

Guid[] SiteId: GUID of the Site.

string[] SiteName: Name of the Site.

One of these resolutions when needed

Guid[] StoreId: GUID of the Store that is neededwhen a DiskLocatorName is used.

string[] StoreName: Name of the Store that is neededwhen a DiskLocatorName is used.

Instead of a parameter that matches one of themembers listed

PvsObject[] Object: PvsObjects with the membersbelow can be used as the Object parameter or from a pileline:

(DiskLocatorId and Version) or DiskLocatorId

If only selected fields are needed, pass them in theFields parameter as a string array.

Version: Version number. The base disk is version 0,the other version numbers are in part of the file name.

ServerId: GUID of the Server that the Disk VersionInventory is being reported about.

ServerName: Name of the Server that the Disk VersionInventory is being reported about.

FilePath: Path used to access the disk version fromthe Server. Empty if the information is not available.

FileTime: Date/Time of the date version file. Hasthe date and time without milliseconds. Empty if the information is notavailable.

PropertiesTime: Date/Time of the disk properties.Has the date and time without milliseconds. Empty if the information is notavailable.

State: The number code of the inventory state.Values are: 0 (Up to date), 1 (version file is missing), 2 (version file is outof date), 3 (properties are missing), 4 (properties are out of date), 5 (serveris not reachable).

Active: 1 if the Server is currently active, 2 ifunknown, and 0 otherwise.

PvsDiskInventory[]: If successful, thePvsDiskInventory object(s) are returned.

EXAMPLE 1: Get PvsDiskInventory for DiskLocator

Get all PvsDiskInventory for the DiskLocator namedtheDiskLocator in the Site named theSite and Store named theStore.

Get-PvsDiskInventory -Name theDiskLocator -SiteNametheSite -StoreName theStore

Guid can be used instead of Name so that theSiteName or SiteId and StoreName or StoreId are not also needed.

Get-PvsDiskLocator

Get the fields for a Disk Locator or all DiskLocators for a Device, Server, Store, Site, or Farm. All DiskLocators arereturned if no parameters are passed.

One of these optional

Guid[] Guid or DiskLocatorId: GUID of the DiskLocator to Get.

Guid[] DeviceId: GUID of the Device to Get allDiskLocators for.

string[] DeviceName: Name of the Device to Get allDiskLocators for.

PvsPhysicalAddress[] DeviceMac: MAC of the Device toGet all DiskLocators for.

Guid[] ServerId: GUID of the Server to Get allDiskLocators for.

string[] ServerName: Name of the Server to Get allDiskLocators for.

Guid[] UpdateTaskId: GUID of the Update Task to Getall DiskLocators for.

Guid[] SiteId: GUID of the Site to Get allDiskLocators for.

string[] SiteName: Name of the Site to Get allDiskLocators for.

or one of these optional ; resolutions

string[] Name or DiskLocatorName: Name of the DiskLocator File to Get.

Guid[] StoreId: GUID of the Store to Get allDiskLocators for.

string[] StoreName: Name of the Store to Get allDiskLocators for.

string[] UpdateTaskName: Name of the Update Task toGet all DiskLocators for.

One of these optional

SwitchParameter Single: If -Single is specified,include single server connection. If this and All are not included, bothconnection types are included.

SwitchParameter All: If -All is specified, includeall server connections for the store. If this and Single are not included, bothconnection types are included.

Optional

SwitchParameter OnlyActive: If -OnlyActive isspecified, include only the active DiskLocators. If not included, allDiskLocators are returned.

SwitchParameter UpdateDevice: If -UpdateDevice isspecified, include only DiskLocators that have an Update Device.

One of these resolutions when needed

Guid[] SiteId: GUID of the Site to Get allDiskLocators for.

string[] SiteName: Name of the Site to Get allDiskLocators for.

One of these resolutions when needed

Guid[] StoreId: GUID of the Store to Get allDiskLocators for.

string[] StoreName: Name of the Store to Get allDiskLocators for.

Instead of a parameter that matches one of themembers listed

PvsObject[] Object: PvsObjects with the membersbelow can be used as the Object parameter or from a pileline:

DiskLocatorId, DeviceId, ServerId, UpdateTaskId,SiteId or StoreId

If only selected fields are needed, pass them in theFields parameter as a string array.

Guid or DiskLocatorId: Read-only GUID that uniquelyidentifies this Disk Locator.

Name or DiskLocatorName: Name of the Disk LocatorFile. It is unique within the Store. ASCII Max Length=52

SiteId: GUID of the Site this DiskLocator is to be amember of. It is not used with SiteName.

SiteName: Name of the Site this DiskLocator is to bea member of. It is not used with SiteId.

StoreId: GUID of the Store that this Disk Locator isa member of. SiteName or SiteId must also be used. It is not used withStoreName.

StoreName: Name of the Store that this Disk Locatoris a member of. SiteName or SiteId must also be used. It is not used withStoreId.

Description: User description. Default=""Max Length=250

MenuText: Text that is displayed in the Boot Menu.If this field has no value, the name value is used. Default="" ASCIIMax Length=64

ServerId: GUID of the single Server that this DiskLocator is assigned to. It is not used with ServerName.Default=00000000-0000-0000-0000-000000000000

ServerName: Name of the single Server that this DiskLocator is assigned to. It is not used with ServerId. Default=""

Enabled: True when this disk can be booted, falseotherwise. Default=true

Role: Read-only Role of the user for this item. 100is Farm Administrator, 200 is Site Administrator, 300 is CollectionAdministrator, and 999 is read-only. Default=999

Mapped: True if the Disk is currently mapped, falseotherwise. Default=false

EnabledForDevice: True when this disk is enabled forthe Device specified, false otherwise. This is only returned when a Device isspecified. Default=true

Active: True if the DiskLocator is currently active,false otherwise. Default=false

RebalanceEnabled: True when this Server canautomatically rebalance Devices, false otherwise. Default=false

RebalanceTriggerPercent: Percent over fair load thattriggers a dynamic Device rebalance. Min=5, Max=5000, Default=25

SubnetAffinity: Qualifier for subnet affinity whenassigning a Server. 0=None, 1=Best Effort, 2=Fixed. Min=0, Max=2, Default=0

DiskUpdateDeviceId: GUID of the DiskUpdateDevicethat is used when updates are performed.Default=00000000-0000-0000-0000-000000000000

DiskUpdateDeviceName: Name of the DiskUpdateDevicethat is used when updates are performed. Default=""

TemporaryVersionSet: Read-only true when temporaryversion(s) are set. Default=false

PvsDiskLocator[]: If successful, the PvsDiskLocatorobject(s) are returned.

EXAMPLE 1: Get PvsDiskLocator for Farm

Get all PvsDiskLocator for the Farm.

Get-PvsDiskLocator

EXAMPLE 2: Get PvsDiskLocator for Site

Get all PvsDiskLocator for the Site named theSite.

Get-PvsDiskLocator -SiteName theSite

EXAMPLE 3: Get PvsDiskLocator for Site and Store

Get all PvsDiskLocator for the Site named theSiteand Store named theStore.

Get-PvsDiskLocator -SiteName theSite -StoreNametheStore

EXAMPLE 4: Get PvsDiskLocator for DiskLocator

Get the PvsDiskLocator for the DiskLocator namedtheDiskLocator in the Site named theSite and Store named theStore.

Get-PvsDiskLocator -Name theDiskLocator -SiteNametheSite -StoreName theStore

Guid can be used instead of Name so that theSiteName or SiteId and StoreName or StoreId are not also needed.

EXAMPLE 5: Get PvsDiskLocator and Enable

Get all PvsDiskLocator that are not Enabled and thenEnables them.

Get-PvsDiskLocator -Fields Enabled | Where-Object{$_.Enabled -eq $false} | foreach { $o = $_; $o.Enabled = $true; $o } |Set-PvsDiskLocator

The -Fields parameter with only the needed fieldsspecified makes the Get work faster because only those fields are retrieved.

The "foreach { $o = $_; $o.X = Y; $o }"sets the field X to value Y and returns the object again so it can be piped tothe Set command for update.

Get-PvsDiskLocatorCount

Get count of Disk Locators for a Site and Type.

One of these required

Guid SiteId: GUID of the Site to get the DiskLocator Count of.

string SiteName: Name of the Site to get the DiskLocator Count of.

One of these optional

SwitchParameter Single: If -Single is specified,include single server connection. If this and All are not included, bothconnection types are included.

SwitchParameter All: If -All is specified, includeall server connections for the store. If this and Single are not included, bothconnection types are included.

Instead of a parameter that matches one of themembers listed

PvsObject[] Object: PvsObjects with the membersbelow can be used as the Object parameter or from a pileline:

SiteId

UInt32: If successful, the numeric value is returned

EXAMPLE 1: Get-PvsDiskLocatorCount Returns the Number (or Count) ofPvsDiskLocator in PvsSite

Get-PvsDiskLocatorCount -SiteName theSite

Get-PvsDiskLocatorLock

Get the fields for all the locks of a Disk Locator.

This required

Guid[] Guid or DiskLocatorId: GUID of the DiskLocator to Get the Locks.

or this required ; resolution

string[] Name or DiskLocatorName: Name of DiskLocator to Get the Locks.

One of these resolutions when needed

Guid[] SiteId: GUID of the Site.

string[] SiteName: Name of the Site.

One of these resolutions when needed

Guid[] StoreId: GUID of the Store that is neededwhen a DiskLocatorName is used.

string[] StoreName: Name of the Store that is neededwhen a DiskLocatorName is used.

Instead of a parameter that matches one of themembers listed

PvsObject[] Object: PvsObjects with the membersbelow can be used as the Object parameter or from a pileline:

DiskLocatorId

If only selected fields are needed, pass them in theFields parameter as a string array.

Exclusive: True when the lock is exclusive, falsewhen it is shared. Default=false

DeviceId: GUID of the Device that has the lock, willbe 00000000-0000-0000-0000-000000000000 if a Server has the lock.

DeviceName: Name of the Device that has the lock,will not be included if a Server has the lock.

ServerId: GUID of the Server that has the lock, willbe 00000000-0000-0000-0000-000000000000 if a Device has the lock.

ServerName: Name of the Server that has the lock,will not be included if a Device has the lock.

ReadOnly: True when lock is because file system isread only, false when file system is read write Default=false

PvsDiskLocatorLock[]: If successful, thePvsDiskLocatorLock object(s) are returned.

EXAMPLE 1: Get PvsDiskLocatorLock for DiskLocator

Get all PvsDiskLocatorLock for the DiskLocator namedtheDiskLocator in the Site named theSite and Store named theStore.

Get-PvsDiskLocatorLock -Name theDiskLocator-SiteName theSite -StoreName theStore

Guid can be used instead of Name so that theSiteName or SiteId and StoreName or StoreId are not also needed.

Get-PvsDiskUpdateDevice

Get the fields and status for a Disk Update Device,or all Disk Update Devices for a Site, Server, DiskLocator or Farm. All DiskUpdate Devices are returned if no parameters are passed.

One of these optional

Guid[] Guid or DeviceId: GUID of the Disk UpdateDevice to Get.

string[] Name or DeviceName: Name of Disk UpdateDevice to Get.

PvsPhysicalAddress[] DeviceMac: MAC of the DiskUpdate Device to Get.

Guid[] ServerId: GUID of the Server to Get all DiskUpdate Devices for.

string[] ServerName: Name of the Server to Get allDisk Update Devices for.

Guid[] DiskLocatorId: GUID of the DiskLocator to Getthe Disk Update Device for.

Guid[] UpdateTaskId: GUID of the Update Task to Getall Disk Update Devices for.

Guid[] SiteId: GUID of the Site.

string[] SiteName: Name of the Site.

or one of these optional ; resolutions

string[] DiskLocatorName: Name of the DiskLocator toGet the Disk Update Device for.

string[] UpdateTaskName: Name of the Update Task toGet all Disk Update Devices for.

Optional

SwitchParameter OnlyActive: If -OnlyActive isspecified, include only the active Disk Update Devices. Only active Disk UpdateDevices are always returned for ServerId or ServerName.

uint MakLicenseActivated: Optional MAK licensingindicator value to only return active Disk Update Devices for. Values are: 0(MAK not used), 1 (Not Activated), 2 (Activated).

One of these resolutions when needed

Guid[] SiteId: GUID of the Site.

string[] SiteName: Name of the Site.

One of these resolutions when needed

Guid[] StoreId: GUID of the Store that is neededwhen a DiskLocatorName is used.

string[] StoreName: Name of the Store that is neededwhen a DiskLocatorName is used.

Instead of a parameter that matches one of themembers listed

PvsObject[] Object: PvsObjects with the membersbelow can be used as the Object parameter or from a pileline:

DeviceId, ServerId, DiskLocatorId, UpdateTaskId orSiteId

If only selected fields are needed, pass them in theFields parameter as a string array.

Guid or DeviceId: Read-only GUID that uniquelyidentifies this Device.

Name or DeviceName: Computer name with no spaces.ASCII computer name characters Max Length=15

VirtualHostingPoolId: GUID of the Virtual HostingPool. It is not used with VirtualHostingPoolName. Default=00000000-0000-0000-0000-000000000000

VirtualHostingPoolName: Name of the Virtual HostingPool.

DiskLocatorId: GUID of the Disk Locator to updatewith this Device.

DiskLocatorName: Name of the Disk Locator File toupdate with this Device.

SiteId: GUID of the Site this Disk Update Device isto be a member of.

SiteName: Name of the Site this Disk Update Deviceis to be a member of.

StoreId: GUID of the Store that the Disk Locator isa member of.

StoreName: Name of the Store that the Disk Locatoris a member of.

Description: User description. Default=""Max Length=250

DeviceMac: Ethernet address can have the formXX-XX-XX-XX-XX-XX. Uniquely identifies the Device.

Port: UDP port to use with Stream Service. Min=1025,Max=65534, Default=6901

Active: True if the Device is currently active,false otherwise. Default=false

AdTimestamp: The time the Active Directory machineaccount password was generated. Do not set this field, it is only setinternally by PVS. Default=0

AdSignature: The signature of the Active Directorymachine account password. Do not set this field, it is only set internally byPVS. Default=0

LogLevel: 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=0

DomainName: Fully qualified name of the domain thatthe Device belongs to. Do not set this field, it is only set internally by PVS.Default="" Max Length=255

DomainObjectSID: The value of the objectSID ADattribute of the same name for the Device's computer account. Do not set thisfield, it is only set internally by PVS. Default="" Max Length=186

DomainControllerName: The name of the DC used tocreate the host's computer account. Do not set this field, it is only setinternally by PVS. Default="" Max Length=4000

DomainTimeCreated: The time that the computeraccount was created. Has the date and time including milliseconds. Do not setthis field, it is only set internally by PVS. Default=Empty

Ip: Read-only IP of the Device. It is equal to0.0.0.0 if the Device is not active.

ServerPortConnection: Read-only Port of the Serverthat the Device is using. It is equal to 0 if the Device is not active.Default=0

ServerIpConnection: Read-only IP of the Server thatthe Device is using. It is equal to 0.0.0.0 if the Device is not active.

ServerId: Read-only GUID of the Server that theDevice is using. It is equal to 00000000-0000-0000-0000-000000000000 if theDevice is not active.

ServerName: Read-only Name of the Server that theDevice is using. It is equal to "" if the Device is not active.

DiskVersion: Read-only version of the Disk LocatorFile that the Device is using. It is equal to 0 if the Device is not active.Default=0

Status: 1 or 2 numbers in the format n,n. They arethe number of retries and if ram cache is being used, ram cache percent used.It is equal to "" if the Device is not active.

LicenseType: 0 when None, 1 for Desktop, 2 forServer, 5 for OEM SmartClient, 6 for XenApp, 7 for XenDesktop. It is equal to 0if the Device is not active. Default=0

MakLicenseActivated: Read-only indicator if MAKlicensing is being used and is activated. Values are: 0 (MAK not used), 1 (NotActivated), 2 (Activated). It is equal to 0 if the Device is not active.Default=0

Model: 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.

License: 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 isnot active. Default=0

PvsDiskUpdateDevice[]: If successful, thePvsDiskUpdateDevice object(s) are returned.

EXAMPLE 1: Get PvsDiskUpdateDevice for Farm

Get all PvsDiskUpdateDevice for the Farm.

Get-PvsDiskUpdateDevice

EXAMPLE 2: Get PvsDiskUpdateDevice for Site

Get all PvsDiskUpdateDevice for the Site namedtheSite.

Get-PvsDiskUpdateDevice -SiteName theSite

EXAMPLE 3: Get PvsDiskUpdateDevice for Server

Get all PvsDiskUpdateDevice for the Server namedtheServer.

Get-PvsDiskUpdateDevice -ServerName theServer

EXAMPLE 4: Get PvsDiskUpdateDevice for DiskLocator

Get all PvsDiskUpdateDevice for the DiskLocatornamed theDiskLocator in the Site named theSite and Store named theStore.

Get-PvsDiskUpdateDevice -DiskLocatorNametheDiskLocator -SiteName theSite -StoreName theStore

DiskLocatorId can be used instead of DiskLocatorNameso that the SiteName or SiteId and StoreName or StoreId are not also needed.

EXAMPLE 5: Get PvsDiskUpdateDevice for Device

Get the PvsDiskUpdateDevice for the Device namedtheDevice.

Get-PvsDiskUpdateDevice -Name theDevice

EXAMPLE 6: Get PvsDiskUpdateDevice for Device MAC

Get the PvsDiskUpdateDevice for the Device with MAC02-50-F2-00-00-01.

Get-PvsDiskUpdateDevice -DeviceMac"02-50-F2-00-00-01"

EXAMPLE 7: Get PvsDiskUpdateDevice for UpdateTask

Get the PvsDiskUpdateDevice for the UpdateTask namedtheUpdateTask in the Site named theSite.

Get-PvsDiskUpdateDevice -UpdateTaskNametheUpdateTask -SiteName theSite

UpdateTaskId can be used instead of UpdateTaskNameso that the SiteName or SiteId is not also needed.

Get-PvsDiskUpdateStatus

Get the status of an Update Task, or all UpdateTasks for a Site or Farm. All Disk Update Tasks are returned if no parametersare passed.

One of these optional

Guid[] UpdateTaskId: GUID of the Update Task to Get.

Guid[] DeviceId: GUID of the Disk Update Device toGet Disk Update Status for.

string[] DeviceName: Name of the Disk Update Deviceto Get Disk Update Status for.

PvsPhysicalAddress[] DeviceMac: MAC of the DiskUpdate Device to Get Disk Update Status for.

Guid[] Guid or DiskUpdateTaskId: GUID of the DiskUpdate Task and Device relationship to Get Disk Update Status for.

Guid[] SiteId: GUID of the Site to Get all UpdateTasks for. Also used with UpdateTaskName.

string[] SiteName: Name of the Site to Get allUpdate Tasks for. Also used with UpdateTaskName.

or this optional ; resolution

string[] UpdateTaskName: Name of the Update Task toGet.

One of these resolutions when needed

Guid[] SiteId: GUID of the Site to Get all UpdateTasks for. Also used with UpdateTaskName.

string[] SiteName: Name of the Site to Get allUpdate Tasks for. Also used with UpdateTaskName.

Instead of a parameter that matches one of themembers listed

PvsObject[] Object: PvsObjects with the membersbelow can be used as the Object parameter or from a pileline:

UpdateTaskId, DeviceId or SiteId

If only selected fields are needed, pass them in theFields parameter as a string array.

Guid or DiskUpdateTaskId: GUID that uniquelyidentifies this Update Task and Device relationship.

UpdateTaskId: GUID that uniquely identifies theUpdate Task.

UpdateTaskName: Name of the Update Task.

Description: User description of the Update Task.

DiskLocatorId: GUID of the Disk Locator to update.

Name or DiskLocatorName: Name of the Disk LocatorFile to update.

VirtualHostingPoolId: GUID of the Virtual HostingPool being used for the update.

VirtualHostingPoolName: Name of the Virtual HostingPool being used for the update.

DeviceId: GUID that Device being used to do theupdate.

DeviceName: Name of the Device being used to do theupdate.

SiteId: GUID of the Site that this Update Task Nameis a member of.

SiteName: Name of the Site that this Update TaskName is a member of.

StoreId: GUID of the Store that the Disk Locator isa member of.

StoreName: Name of the Store that the Disk Locatoris a member of.

PreviousResult: Status of the last run. Values are:0 (Ready), 1 (Update Pending), 2 (Preparing Image), 3 (Starting VM), 4 (UpdateIn 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: Message string that includesthe results of the last run. Default="" Max Length=255

CurrentStatus: Current status of the update. Valuesare: 0 (Ready), 1 (Update Pending), 2 (Preparing Image), 3 (Starting VM), 4(Update In Progress), 5 (Stopping VM), 6 (Submitting Image), 7 (RevertingImage), 8 (Invalid), 9 (Aborted), 10 (Completed Successfully), 11 (No Updates)Min=0, Max=11, Default=0

CurrentStatusMessage: Message string that includesthe results of the run. Default="" Max Length=255

PvsDiskUpdateStatus[]: If successful, thePvsDiskUpdateStatus object(s) are returned.

EXAMPLE 1: Get PvsDiskUpdateStatus for Farm

Get all PvsDiskUpdateStatus for the Farm.

Get-PvsDiskUpdateStatus

EXAMPLE 2: Get PvsDiskUpdateStatus for Site

Get all PvsDiskUpdateStatus for the Site namedtheSite.

Get-PvsDiskUpdateStatus -SiteName theSite

EXAMPLE 3: Get PvsDiskUpdateStatus for Server

Get all PvsDiskUpdateStatus for the Server namedtheServer.

Get-PvsDiskUpdateStatus -ServerName theServer

EXAMPLE 4: Get PvsDiskUpdateStatus for DiskLocator

Get all PvsDiskUpdateStatus for the DiskLocatornamed theDiskLocator in the Site named theSite and Store named theStore.

Get-PvsDiskUpdateStatus -DiskLocatorNametheDiskLocator -SiteName theSite -StoreName theStore

DiskLocatorId can be used instead of DiskLocatorNameso that the SiteName or SiteId and StoreName or StoreId are not also needed.

EXAMPLE 5: Get PvsDiskUpdateStatus for Device

Get the PvsDiskUpdateStatus for the Device namedtheDevice.

Get-PvsDiskUpdateStatus -Name theDevice

EXAMPLE 6: Get PvsDiskUpdateStatus for Device MAC

Get the PvsDiskUpdateStatus for the Device with MAC02-50-F2-00-00-01.

Get-PvsDiskUpdateStatus -DeviceMac "02-50-F2-00-00-01"

EXAMPLE 7: Get PvsDiskUpdateStatus for UpdateTask

Get the PvsDiskUpdateStatus for the UpdateTask namedtheUpdateTask in the Site named theSite.

Get-PvsDiskUpdateStatus -UpdateTaskNametheUpdateTask -SiteName theSite

UpdateTaskId can be used instead of UpdateTaskNameso that the SiteName or SiteId is not also needed.

EXAMPLE 8: Get PvsDiskUpdateStatus for DiskUpdateTaskId

Get the PvsDiskUpdateStatus for the Device namedtheDevice then uses the DiskUpdateTaskId of the PvsDiskUpdateStatus to get thefuture Get-PvsDiskUpdateStatus.

$u = Get-PvsDiskUpdateStatus -DeviceName theDevice-Fields DiskUpdateTaskId

Get-PvsDiskUpdateStatus -Guid $u.DiskUpdateTaskId

The -Fields parameter with only the needed fieldsspecified makes the Get work faster because only those fields are retrieved.

Get-PvsDiskVersion

Get the fields for a Disk Version or all DiskVersions for a Disk Locator.

This required

Guid[] Guid or DiskLocatorId: GUID of the DiskLocator to Get Disk Versions of.

or this required ; resolution

string[] Name or DiskLocatorName: Name of the DiskLocator to Get Disk Versions of.

One of these optional

uint Version: Specific Version to Get.

uint Type: When set to 1, get the Maintenance orMaintenanceHighestVersion access version if it exists. When set to 2, get theTest access versions if any exist. When set to 3, get the Override accessversion if it exists.

One of these resolutions when needed

Guid[] SiteId: GUID of the Site.

string[] SiteName: Name of the Site.

One of these resolutions when needed

Guid[] StoreId: GUID of the Store that is neededwhen a DiskLocatorName is used.

string[] StoreName: Name of the Store that is neededwhen a DiskLocatorName is used.

Instead of a parameter that matches one of themembers listed

PvsObject[] Object: PvsObjects with the membersbelow can be used as the Object parameter or from a pileline:

(DiskLocatorId and Version) or DiskLocatorId

If only selected fields are needed, pass them in theFields parameter as a string array.

Version: Read-only version number. The base disk isversion 0, the other version numbers are in part of the file name. Default=0

Description: User description. Default=""Max Length=250

Type: Read-only type of the Disk Version. Valuesare: 0 (Base), 1 (Manual), 2 (Automatic), 3 (Merge), and 4 (MergeBase) Min=0,Max=4, Default=0

CreateDate: Read-only Date/Time that the DiskVersion was created. Default=getdate

ScheduledDate: Date/Time that the Disk Version isscheduled to become available. Has the date, hour and minute. Empty when thedisk version is made available immediately. Default=Empty

DeleteWhenFree: Read-only true if the Disk Versionis no longer needed because of a merge. If not current booted by a Device, itcan be deleted. Default=false

Access: Read-only access of the Disk Version. Valuesare: 0 (Production), 1 (Maintenance), 2 (MaintenanceHighestVersion), 3(Override), 4 (Merge), 5 (MergeMaintenance), 6 (MergeTest), and 7 (Test) Min=0,Max=7, Default=0

Name or DiskFileName: Name of the Disk Fileincluding the extension. Default=""

DeviceCount: Read-only count of Devices. Default=0

GoodInventoryStatus: True when the up to date fileis accessible by all Servers, false otherwise. Default=false

TaskId: When a Merge is occurring, this will be setwith the task number of the process that is occurring. Default=""

CanDelete: Read-only true when the version can bedeleted. Default=false

CanMerge: Read-only true when the version can beupdate merged. Will be set for the highest version number. Default=false

CanMergeBase: Read-only true when the version can bebase merged. Will be set for the highest version number. Default=false

CanPromote: Read-only true when the version can bepromoted. Default=false

CanRevertTest: Read-only true when the version canbe reverted to Test Access. Default=false

CanRevertMaintenance: Read-only true when theversion can be reverted to Maintenance Access. Default=false

CanSetScheduledDate: Read-only true when the versioncan have the scheduled date modified. Default=false

CanOverride: Read-only true when the version can beset as the Override. Default=false

IsPending: Read-only true when the versionScheduledDate has not occurred. Default=false

TemporaryVersionSet: Read-only true when temporaryversion(s) are set. Some changes cannot be made to the version when this isset. Default=false

PvsDiskVersion[]: If successful, the PvsDiskVersionobject(s) are returned.

EXAMPLE 1: Get PvsDiskVersion for DiskLocator

Get all PvsDiskVersion for the DiskLocator namedtheDiskLocator in the Site named theSite and Store named theStore.

Get-PvsDiskVersion -Name theDiskLocator -SiteNametheSite -StoreName theStore

Guid can be used instead of Name so that theSiteName or SiteId and StoreName or StoreId are not also needed.

EXAMPLE 2: Get PvsDiskVersion for DiskLocator

Get the first base PvsDiskVersion for theDiskLocator named theDiskLocator in Site named theSite and Store namedtheStore.

Get-PvsDiskVersion -Name theDiskLocator -Version 0-SiteName theSite -StoreName theStore

Guid can be used instead of Name so that theSiteName or SiteId and StoreName or StoreId are not also needed.

EXAMPLE 3: Get Maintenance PvsDiskVersion for DiskLocator

Get the Maintenance PvsDiskVersion for theDiskLocator named theDiskLocator in Site named theSite and Store namedtheStore.

Get-PvsDiskVersion -Name theDiskLocator -Type 1-SiteName theSite -StoreName theStore

Guid can be used instead of Name so that theSiteName or SiteId and StoreName or StoreId are not also needed.

EXAMPLE 4: Get Test PvsDiskVersion for DiskLocator

Get all Test PvsDiskVersion for the DiskLocatornamed theDiskLocator in Site named theSite and Store named theStore.

Get-PvsDiskVersion -Name theDiskLocator -Type 2-SiteName theSite -StoreName theStore

Guid can be used instead of Name so that theSiteName or SiteId and StoreName or StoreId are not also needed.

EXAMPLE 5: Get Override PvsDiskVersion for DiskLocator

Get the Override PvsDiskVersion for the DiskLocatornamed theDiskLocator in Site named theSite and Store named theStore.

Get-PvsDiskVersion -Name theDiskLocator -Type 3-SiteName theSite -StoreName theStore

Guid can be used instead of Name so that theSiteName or SiteId and StoreName or StoreId are not also needed.

Get-PvsExists

Return true if a Site, Server, Collection, View,Device, Store, Update Task or Virtual Hosting Pool Name is already used. If aCollectionName, SiteViewName, UpdateTaskName or VirtualHostingPoolName isspecified, SiteName or SiteId must be included.

One of these required

string SiteName: Name of the Site.

string ServerName: Server name, to see if it isalready used in the Farm.

string FarmViewName: Farm View name, to see if it isalready used in the Farm.

string DeviceName: Device name, to see if it isalready used in the Farm.

PvsPhysicalAddress[] DeviceMac: Device MAC, to seeif it is already used in the Farm.

string StoreName: Store name, to see if it isalready used.

or one of these required ; resolutions

string CollectionName: Collection name, to see if itis already used in a Site.

string SiteViewName: Site View name, to see if it isalready used in the Site.

string VirtualHostingPoolName: Virtual Hosting Poolname, to see if it is already used in a Site.

string UpdateTaskName: Update Task name, to see ifit is already used in a Site.

string DiskLocatorName: DiskLocator name, to see ifit is already used in a Site.

One of these resolutions when needed

string SiteName: Name of the Site.

Guid SiteId: GUID of the Site.

One of these resolutions when needed

Guid StoreId: GUID of the Store that is needed whena DiskLocatorName is used.

string StoreName: Store name, to see if it isalready used.

Boolean: If successful, $true or $false is returned.

EXAMPLE 1: Get-PvsExists Determine if SiteName Already Exists

Get-PvsExists -SiteName theName

EXAMPLE 2: Get-PvsExists Determine if ServerName Already Exists

Get-PvsExists -ServerName theName

EXAMPLE 3: Get-PvsExists Determine if FarmViewName Already Exists

Get-PvsExists -FarmViewName theName

EXAMPLE 4: Get-PvsExists Determine if DeviceName Already Exists

Get-PvsExists -DeviceName theName

EXAMPLE 5: Get-PvsExists Determine if DeviceMac Already Exists

Get-PvsExists -DeviceMac"00-11-22-33-44-55"

EXAMPLE 6: Get-PvsExists Determine if StoreName Already Exists

Get-PvsExists -StoreName theName

EXAMPLE 7: Get-PvsExists Determine if CollectionName Already Exists

Get-PvsExists -CollectionName theName -SiteNametheSite

SiteId can be used instead of SiteName.

EXAMPLE 8: Get-PvsExists Determine if SiteViewName Already Exists

Get-PvsExists -SiteViewName theName -SiteNametheSite

SiteId can be used instead of SiteName.

EXAMPLE 9: Get-PvsExists Determine if VirtualHostingPoolName Already Exists

Get-PvsExists -VirtualHostingPoolName theName-SiteName theSite

SiteId can be used instead of SiteName.

EXAMPLE 10: Get-PvsExists Determine if UpdateTaskName Already Exists

Get-PvsExists -UpdateTaskName theName -SiteNametheSite

SiteId can be used instead of SiteName.

EXAMPLE 11: Get-PvsExists Determine if DiskLocatorName Already Exists

Get-PvsExists -DiskLocatorName theName -SiteNametheSite -StoreName theStore

SiteId can be used instead of SiteName, and StoreIdcan be used instead of StoreName.

Get-PvsFarm

Get the fields for the Farm.

Optional

Guid[] Guid or FarmId: GUID of the Farm to Get. Thisis optional since there is only one Farm.

Instead of a parameter that matches one of themembers listed

PvsObject[] Object: PvsObjects with the membersbelow can be used as the Object parameter or from a pileline:

FarmId

If only selected fields are needed, pass them in theFields parameter as a string array.

Guid or FarmId: Read-only GUID that uniquelyidentifies this Farm.

Name or FarmName: Name of the Farm.Default="" Max Length=50

Description: User description. Default=""Max Length=250

AutoAddEnabled: True when Auto Add is enabled, falseotherwise. Default=false

AuditingEnabled: True when Auditing is enabled,false otherwise. Default=false

LastAuditArchiveDate: Last date of Audit Trail datathat was Archived. Has the date. Default=Empty

DefaultSiteId: GUID of the Site to place new Devicesinto automatically. Not used with defaultSiteName.Default=00000000-0000-0000-0000-000000000000

DefaultSiteName: Name of the Site to place newDevices into automatically. Not used with DefaultSiteId. Default=""

OfflineDatabaseSupportEnabled: True when OfflineDatabase Support is enabled, false otherwise. Default=false

AdGroupsEnabled: Active Directory groups are usedfor authorization, when set to true. Windows groups are used when set to false.Default=false

LicenseServer: License server name.Default="" Max Length=255

LicenseServerPort: License server port. Min=1025,Max=65534, Default=27000

AutomaticMergeEnabled: True when Automatic Merge isenabled, false otherwise. If the number of versions becomes more than theMaxVersions value, a merge will occur at the end of PromoteDiskVersion.Default=true

MaxVersions: Maximum number a versions of a Diskthat can exist before a merge will automatically occur. Min=3, Max=50,Default=5

MergeMode: Mode to place the version in after amerge has occurred. Values are: 0 (Production), 1 (Test) and 2 (Maintenance).Min=0, Max=2, Default=2

DatabaseServerName: Read-only name of the databaseserver.

DatabaseInstanceName: Read-only name of the databaseinstance.

DatabaseName: Read-only name of the database.

FailoverPartnerServerName: Read-only name of thedatabase server.

FailoverPartnerInstanceName: Read-only name of thedatabase server instance.

MultiSubnetFailover: Read-only DatabaseMultiSubnetFailover value

Role: Read-only Role of the user for this item. 100is Farm Administrator, and 999 is read-only. Default=999

PvsFarm[]: If successful, the PvsFarm object(s) arereturned.

EXAMPLE 1: Get PvsFarm

Get the PvsFarm.

Get-PvsFarm

Get-PvsFarmView

Get the fields for a Farm View or all Farm Views inthe Farm. All Farm Views are returned if no parameters are passed.

One of these optional

Guid[] Guid or FarmViewId: GUID of the Farm View toGet.

string[] Name or FarmViewName: Name of the Farm Viewto Get.

Instead of a parameter that matches one of themembers listed

PvsObject[] Object: PvsObjects with the membersbelow can be used as the Object parameter or from a pileline:

FarmViewId

If only selected fields are needed, pass them in theFields parameter as a string array.

Guid or FarmViewId: Read-only GUID that uniquelyidentifies this Farm View.

Name or FarmViewName: name of the Farm View. MaxLength=50

Description: User description. Default=""Max Length=250

DeviceCount: Read-only count of Devices in this FarmView. Default=0

ActiveDeviceCount: Read-only count of active Devicesin this Farm View. Default=0

MakActivateNeededCount: Read-only count of activeDevices that need MAK activation in this Farm View. Default=0

PvsFarmView[]: If successful, the PvsFarmViewobject(s) are returned.

EXAMPLE 1: Get PvsFarmView for Farm

Get all PvsFarmView for the Farm.

Get-PvsFarmView

EXAMPLE 2: Get PvsFarmView

Get the PvsFarmView for the FarmView namedtheFarmView.

Get-PvsFarmView -Name theFarmView

Get-PvsGroup

Get the fields for the Groups for the user or theSystem.

Optional

string[] Domain: Domain of user (may be the name ofthe local computer).

string[] User: Name of user.

SwitchParameter AdGroupsEnabled: Get ActiveDirectory groups, when set to true. Get Windows groups, when set to false. Ifnot included, the Farm AdGroupsEnabled setting is used.

If only selected fields are needed, pass them in theFields parameter as a string array.

Name: Name of the Group.

Guid: GUID of the Active Directory group.00000000-0000-0000-0000-000000000000 for Windows groups.

PvsGroup[]: If successful, the PvsGroup object(s)are returned.

EXAMPLE 1: Get PvsGroup for System

Get all PvsGroup for the System.

Get-PvsGroup

EXAMPLE 2: Get PvsGroup for User

Get all the PvsGroup in the Domain named theDomainfor the User named theUser.

Get-PvsGroup -Domain theDomain -User theUser

EXAMPLE 3: Get Active Directory PvsGroup

Get all the Active Directory PvsGroup in the System.

Get-PvsGroup -AdGroupsEnabled

EXAMPLE 4: Get Windows Groups PvsGroup

Get all the Windows Groups PvsGroup in the System.

Get-PvsGroup -AdGroupsEnabled:$false

Get-PvsLocalServer

Return one record with the local server's NetBiosname

PvsLocalServer[]: If successful, the PvsLocalServerobject(s) are returned.

EXAMPLE 1: Get PvsLocalServer

Get the PvsLocalServer for the PVS SoapServerconnected to.

Get-PvsLocalServer

Get-PvsMaintenanceVersionExists

Return true if the if the DiskLocator has amaintenance version, false otherwise.

This required

Guid Guid or DiskLocatorId: DiskLocator GUID, to seeif it has a maintenance version.

or this required ; resolution

string Name or DiskLocatorName: DiskLocator name, tosee if it has a maintenance version.

One of these resolutions when needed

Guid SiteId: GUID of the Site.

string SiteName: Name of the Site.

One of these resolutions when needed

Guid StoreId: GUID of the Store that is needed whena DiskLocatorName is used.

string StoreName: Name of the Store that is neededwhen a DiskLocatorName is used.

Instead of a parameter that matches one of themembers listed

PvsObject[] Object: PvsObjects with the membersbelow can be used as the Object parameter or from a pileline:

DiskLocatorId

Boolean: If successful, $true or $false is returned.

EXAMPLE 1: Get-PvsMaintenanceVersionExists for Name

Get-PvsMaintenanceVersionExists -Name theDiskLocator-SiteName theSite -StoreName theStore

Guid can be used instead of Name so that the SiteNameor SiteId and StoreName or StoreId are not also needed.

Get-PvsMinimumLastAutoAddDeviceNumber

Get the minimum that the Device Number of the lastAuto Added Device can be.

This required

Guid CollectionId: GUID of the Collection to get theMinimum LastAutoAddDeviceNumber for.

or this required ; resolution

string CollectionName: Name of the Collection to getthe Minimum LastAutoAddDeviceNumber for.

Optional

string AutoAddPrefix: The string put before theDevice Number for Auto Add.

string AutoAddSuffix: The string put after theDevice Number for Auto Add.

uint AutoAddNumberLength: The maximum length of theDevice Number for Auto Add. This length plus the AutoAddPrefix length plus theAutoAddSuffix length must be less than 16.

One of these resolutions when needed

Guid SiteId: GUID of the Site.

string SiteName: Name of the Site.

Instead of a parameter that matches one of themembers listed

PvsObject[] Object: PvsObjects with the membersbelow can be used as the Object parameter or from a pileline:

CollectionId

UInt32: If successful, the numeric value is returned

EXAMPLE 1: Get-PvsMinimumLastAutoAddDeviceNumber

This example gets the highest auto-add number usedso far for a PvsDevice that starts with the AutoAddPrefix and AutoAddSuffix ofthe PVsCollection.

Get-PvsMinimumLastAutoAddDeviceNumber-CollectionName theCollection -SiteName theSite

CollectionId can be used instead of CollectionNameso that the SiteName or SiteId is not also needed.

EXAMPLE 2: Get-PvsMinimumLastAutoAddDeviceNumber for AutoAddPrefix withAutoAddSuffix and AutoAddNumberLength

This example gets the highest auto-add number usedso far for a PvsDevice with name length up to 10 characters and starts with theAutoAddPrefix and AutoAddSuffix specified.

Get-PvsMinimumLastAutoAddDeviceNumber -CollectionNametheCollection -SiteName theSite -AutoAddPrefix "P" -AutoAddSuffix"S" -AutoAddNumberLength 10

CollectionId can be used instead of CollectionNameso that the SiteName or SiteId is not also needed.

Get-PvsMountedDisk

Get the mounted disk, if there is one.

One of these optional

Guid ServerId: GUID of the Server.

string ServerName: Name of the Server.

One of these optional

Guid StoreId: GUID of the Store.

string StoreName: Name of the Store.

Instead of a parameter that matches one of themembers listed

PvsObject[] Object: PvsObjects with the membersbelow can be used as the Object parameter or from a pileline:

ServerId or StoreId

PvsDiskLocator: If successful, the mappedPvsDiskLocator is returned.

EXAMPLE 1: Get-PvsMountedDisk

This example gets the PvsMappedDisk. If no disk ismapped, null is returned.

$thePvsDiskLocator = Get-PvsMappedDisk

if ($thePvsDiskLocator -ne $null)

{

$thePvsDiskLocator.Name #display the name of the mapped PvsDiskLocator

}

EXAMPLE 2: Get-PvsMountedDisk for ServerName

This example gets any mapped disk for theServerName. If no disk is mapped, null is returned.

$thePvsDiskLocator = Get-PvsMappedDisk -ServerNametheServer

if ($thePvsDiskLocator -ne $null)

{

$thePvsDiskLocator.Name #display the name of the mapped PvsDiskLocator

}

EXAMPLE 3: Get-PvsMountedDisk for StoreName

This example gets any mapped disk for the StoreName.If no disk is mapped, null is returned.

$thePvsDiskLocator = Get-PvsMappedDisk -StoreNametheStore

if ($thePvsDiskLocator -ne $null)

{

$thePvsDiskLocator.Name #display the name of the mapped PvsDiskLocator

}

Get-PvsMountedDriveLetter

If there is currently a Mounted Drive, return theLetter of the Drive.

String: If successful, the String value is returned.

EXAMPLE 1: Get-PvsMountedDriveLetter

This example gets any mapped disk drive letter. Ifno disk is mapped, a string with length greater than 0 is returned.

$theDriveLetter = Get-PvsMappedDisk

if ($theDriveLetter -ne $null -and$theDriveLetter.length -gt 0)

{

$theDriveLetter # display thedrive letter

}

Get-PvsNewDiskVersion

Get new Disk versions for the Store on the Serverspecified.

One of these required

Guid[] ServerId: GUID of the Server to look for newDisk versions.

string[] ServerName: Name of the Server to look fornew Disk versions.

One of these required

Guid[] StoreId: GUID of the Store that the Serverservices to look for new Disk versions.

string[] StoreName: Name of the Store that theServer services to look for new Disk versions.

Optional

SwitchParameter AutoAddEnabled: If -AutoAddEnabledis specified, undefined Disk versions found will be automatically added.

Instead of a parameter that matches one of themembers listed

PvsObject[] Object: PvsObjects with the membersbelow can be used as the Object parameter or from a pileline:

ServerId or StoreId

If only selected fields are needed, pass them in theFields parameter as a string array.

Name: Name of the disk file without the extension.

Status: Status of the disk file. Values are: 0(Valid), 1 (Missing Properties File), 2 (Access Denied), 3 (Access Denied andMissing Properties File), 4 (Invalid Disk File), 5 (Manifest Invalid)

PvsNewDiskVersion[]: If successful, thePvsNewDiskVersion object(s) are returned.

EXAMPLE 1: Get PvsNewDiskVersion

Get all PvsNewDiskVersion in the Store namedtheStore using the Server named theServer.

Get-PvsNewDiskVersion -ServerName theServer-StoreName theStore

EXAMPLE 2: Get PvsNewDiskVersion with AutoAdd

Get all PvsNewDiskVersion and Auto Adds them in theStore named theStore using the Server named theServer.

Get-PvsNewDiskVersion -ServerName theServer-StoreName theStore -AutoAddEnabled

Get-PvsServer

Get the fields for a Server, all Servers in a Sitethat use a Store, service a DiskLocator, or for the whole Farm. All Servers arereturned if no parameters are passed.

One of these optional

Guid[] Guid or ServerId: GUID of the Server to Get.

string[] Name or ServerName: Name of the Server toGet.

Guid[] SiteId: GUID of the Site to Get all Servers.

string[] SiteName: Name of the Site to Get allServers.

Guid[] DiskLocatorId: GUID of the Disk Locator toGet all Servers.

or this optional ; resolution

string[] DiskLocatorName: Name of the Disk LocatorFile to Get all Servers.

One of these optional ; resolutions

Guid[] StoreId: GUID of the Store to Get all Servers.

string[] StoreName: Name of the Store to Get allServers.

Optional

SwitchParameter All: If -All is specified, withStoreId or StoreName all Servers for the Store including ones with invalidpaths will be returned.

One of these resolutions when needed

Guid[] SiteId: GUID of the Site to Get all Servers.

string[] SiteName: Name of the Site to Get allServers.

One of these resolutions when needed

Guid[] StoreId: GUID of the Store to Get allServers.

string[] StoreName: Name of the Store to Get allServers.

Instead of a parameter that matches one of themembers listed

PvsObject[] Object: PvsObjects with the membersbelow can be used as the Object parameter or from a pileline:

ServerId, SiteId, DiskLocatorId or StoreId

If only selected fields are needed, pass them in theFields parameter as a string array.

Guid or ServerId: Read-only GUID that uniquelyidentifies this Server.

Name or ServerName: Computer name with no spaces.ASCII computer name characters Max Length=21

SiteId: GUID of the Site this Server is to be amember of. It is not used with SiteName.

SiteName: Name of the Site this Server is to be amember of. It is not used with SiteId.

Description: User description. Default=""Max Length=250

AdMaxPasswordAge: Number of days before a passwordexpires. Min=1, Max=30, Default=7

LicenseTimeout: Amount of seconds before a licensetimes out. Min=15, Max=300, Default=30

VDiskCreatePacing: VDisk create time pacing inmiliseconds. Min=0, Max=5, Default=0

FirstPort: Number of the first UDP port for use bythe Stream Service, First and Last must allow at least 5 ports. Min=1025,Max=65534, Default=6910

LastPort: Number of the last UDP port for use by theStream Service, First and Last must allow at least 5 ports. Min=1025,Max=65534, Default=6930

ThreadsPerPort: Number of worker threads per IOport. Required that (threadPerPort * numberPorts * numberIPs) <= 1000.Min=1, Max=60, Default=8

BuffersPerThread: Number of buffers per workerthread. Min=1, Max=128, Default=24

ServerCacheTimeout: Number of seconds to wait beforeconsidering another Server is down. Min=5, Max=60, Default=8

IoBurstSize: Number of bytes read/writes can send ina burst of packets. Required that IoBurstSize/(MaxTransmissionUnits-76)<=32.Min=4096, Max=61440, Default=32768

MaxTransmissionUnits: Ethernet maximum transmissionunit size for the protocol for use for Server and Device. Required thatIoBurstSize/(MaxTransmissionUnits-76)<=32. Min=502, Max=16426, Default=1506

MaxBootDevicesAllowed: Maximum number of Devicesallowed to boot simultaneously. Min=1, Max=1000, Default=500

MaxBootSeconds: Maximum number of seconds for aDevice to boot. Min=10, Max=900, Default=60

BootPauseSeconds: Number of seconds that a Devicewill pause during login if its server busy. Min=1, Max=60, Default=10

AdMaxPasswordAgeEnabled: Age the password, when setto true. Default=false

EventLoggingEnabled: Enable event logging, when setto true. Default=false

NonBlockingIoEnabled: Use non-Blocking IO, when setto true. Default=true

Role: Read-only Role of the user for this item. 100is Farm Administrator, and 200 is Site Administrator. Default=999

Ip: One or more streaming ip addresses.

InitialQueryConnectionPoolSize: Initial size ofdatabase connection pool for non-transactional queries. Min=1, Max=1000,Default=50

InitialTransactionConnectionPoolSize: Initial sizeof database connection pool for transactional queries. Min=1, Max=1000,Default=50

MaxQueryConnectionPoolSize: Maximum size of databaseconnection pool for non-transactional queries. Min=1, Max=32767, Default=1000

MaxTransactionConnectionPoolSize: Maximum size ofdatabase connection pool for transactional queries. Min=1, Max=32767,Default=1000

RefreshInterval: Interval, in number of seconds, theserver should wait before refreshing settings. If set to 0, unused databaseconnections are never released. Min=0, Max=32767, Default=300

UnusedDbConnectionTimeout: Interval, in number ofseconds, a connection should go unused before it is to be released. Min=0,Max=32767, Default=300

BusyDbConnectionRetryCount: Number of times a faileddatabase connection will be retried. Min=0, Max=32767, Default=2

BusyDbConnectionRetryInterval: Interval, in numberof milliseconds, the server should wait before retrying to connect to adatabase. Min=0, Max=10000, Default=25

LocalConcurrentIoLimit: Maximum concurrent IOtransactions it performs for vDisks that are local. A value of 0 disables thefeature. Min=0, Max=128, Default=4

RemoteConcurrentIoLimit: Maximum concurrent IOtransactions it performs for vDisks that are remote. A value of 0 disables thefeature. Min=0, Max=128, Default=4

RamDiskIpAddress: IP address to use for transferringthe RAM Disk. When equal to 0.0.0.0 the server IP is used with the first partreplaced with 233. Default=0.0.0.0

RamDiskTimeToLive: Time to live for the invitationpacket sent to Devices. Min=1, Max=255, Default=1

RamDiskInvitationType: Either false for Fixed, ortrue for Variable. Default=false

RamDiskInvitationPeriod: The amount of time inseconds that invitations are sent to Devices. Min=1, Max=300, Default=10

Active: 1 if the Server is currently active, 2 ifunknown, and 0 otherwise. Min=0, Max=2, Default=0

LogLevel: 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

LogFileSizeMax: Maximum size log files can reach inMegabytes. Min=1, Max=50, Default=5

LogFileBackupCopiesMax: Maximum number of log filebackups. Min=1, Max=50, Default=4

PowerRating: A strictly relative rating of thisServer's capabilities when compared to other Servers in the Store(s) it belongstoo; can be used to help tune load balancing. Min=0.1, Max=1000, Default=1

ServerFqdn: Read-only fully qualified domain name.Default="" Max Length=1024

ManagementIp: IP address used for management communicationsbetween Servers. Default=0.0.0.0

LastCeipUploadAttempt: Time that this server lastattempted a CEIP upload. Default=Empty

LastBugReportAttempt: Time that this server lastattempted to upload or generate a bug report bundle. Default=Empty

LastBugReportStatus: Status of the last bug reporton this server. Default="" Max Length=250

LastBugReportResult: Status of the last bug reporton this server. Default="" Max Length=4000

LastBugReportSummary: Summary of the last bug reporton this server. Default="" Max Length=250

PvsServer[]: If successful, the PvsServer object(s)are returned.

EXAMPLE 1: Get PvsServer for Farm

Get all PvsServer for the Farm.

Get-PvsServer

EXAMPLE 2: Get PvsServer for Site

Get all PvsServer for the Site named theSite.

Get-PvsServer -SiteName theSite

EXAMPLE 3: Get PvsServer for Site and Store

Get all PvsServer for the Site named theSite andStore named theStore.

Get-PvsServer -SiteName theSite -StoreName theStore

EXAMPLE 4: Get PvsServer for DiskLocator

Get the PvsServer for the DiskLocator namedtheDiskLocator in the Site named theSite and Store named theStore.

Get-PvsServer -DiskLocatorName theDiskLocator-SiteName theSite -StoreName theStore

DiskLocatorId can be used instead of DiskLocatorNameso that the SiteName or SiteId and StoreName or StoreId are not also needed.

EXAMPLE 5: Get PvsServer for Server

Get the PvsServer for the Server named theServer.

Get-PvsServer -Name theServer

EXAMPLE 6: Get PvsServer Not Active and Start

Get all PvsServer that are not Active and then Startthem.

Get-PvsServer -Fields Active | Where-Object{$_.Active -eq 0} | Start-PvsStreamService

The -Fields parameter with only the needed fieldsspecified makes the Get work faster because only those fields are retrieved.

Get-PvsServerBiosBootstrap

Oem Only: Get the bootstrap fields for the Serverdell_bios.bin BIOS bootstrap file.

One of these required

Guid[] Guid or ServerId: GUID of the Server to Getthe dell_bios.bin BIOS bootstrap file from.

string[] Name or ServerName: Name of the Server toGet the dell_bios.bin BIOS bootstrap file from.

Instead of a parameter that matches one of themembers listed

PvsObject[] Object: PvsObjects with the membersbelow can be used as the Object parameter or from a pileline:

ServerId

If only selected fields are needed, pass them in theFields parameter as a string array.

Enabled: Automatically update the BIOS on the targetdevice with these setting when set to true, otherwise do not use thesesettings. Default=false

DhcpEnabled: Use DHCP to retrieve target device IPwhen set to true, otherwise use the static domain, dnsIpAddresstrue anddnsIpAddress2 settings. Default=true

Lookup: Use DNS to find the Server when set to truewith 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

VerboseMode: Display verbose diagnostic informationwhen set to true. Default=false

InterruptSafeMode: Interrupt safe mode (use iftarget device hangs during boot) when set to true. Default=false

PaeMode: PAE mode (use if PAE enabled in boot.ini oftarget device) when set to true. Default=false

BootFromHdOnFail: For network recovery reboot tohard drive when set to true, restore network connection when set to false.Default=false

RecoveryTime: When bootFromHdOnFail is 1, this isthe number of seconds to wait before reboot to hard drive. Min=10, Max=60000,Default=50

PollingTimeout: Login polling timeout in milliseconds.Min=1000, Max=60000, Default=5000

GeneralTimeout: Login general timeout inmilliseconds. Min=1000, Max=60000, Default=5000

Name or ServerName: Host to use for DNS lookup. Onlyused when Lookup is true. Default=IMAGESERVER1

Bootserver1_Ip: 1st boot server IP. Only used whenLookup is false.

Bootserver1_Port: 1st boot server port. Only usedwhen Lookup is false. Min=1025, Max=65536, Default=6910

Bootserver2_Ip: 2nd boot server IP. Only used whenLookup is false. Default=0.0.0.0

Bootserver2_Port: 2nd boot server port. Only usedwhen Lookup is false. Min=1025, Max=65536, Default=6910

Bootserver3_Ip: 3rd boot server IP. Only used whenLookup is false. Default=0.0.0.0

Bootserver3_Port: 3rd boot server port. Only usedwhen Lookup is false. Min=1025, Max=65536, Default=6910

Bootserver4_Ip: 4th boot server IP. Only used whenLookup is false. Default=0.0.0.0

Bootserver4_Port: 4th boot server port. Only usedwhen Lookup is false. Min=1025, Max=65536, Default=6910

Domain: Domain of the primary and secondary DNSservers. Only used when DhcpEnabled is false.

DnsIpAddress1: Primary DNS server IP. Only used whenDhcpEnabled is false.

DnsIpAddress2: Secondary DNS server IP. Only usedwhen DhcpEnabled is false.

PvsServerBiosBootstrap[]: If successful, the PvsServerBiosBootstrapobject(s) are returned.

EXAMPLE 1: Get PvsServerBiosBootstrap for Server

Get all PvsServerBiosBootstrap for the Server namedtheServer.

Get-PvsServerBiosBootstrap -Name theServer

Get-PvsServerBootstrap

Get the bootstrap fields for the Server and namedbootstrap file specified.

One of these required

Guid[] Guid or ServerId: GUID of the Server to Getthe named bootstrap file from.

string[] ServerName: Name of the Server to Get thenamed bootstrap file from.

This required

string[] Name: Name of the bootstrap file.

Instead of a parameter that matches one of themembers listed

PvsObject[] Object: PvsObjects with the membersbelow can be used as the Object parameter or from a pileline:

(ServerId and Name) or ServerId

If only selected fields are needed, pass them in theFields parameter as a string array.

Bootserver1_Ip: 1st boot server IP.

Bootserver1_Netmask: 1st boot server netmask.Default=0.0.0.0

Bootserver1_Gateway: 1st boot server gateway.Default=0.0.0.0

Bootserver1_Port: 1st boot server port. Min=1025,Max=65536, Default=6910

Bootserver2_Ip: 2nd boot server IP. Default=0.0.0.0

Bootserver2_Netmask: 2nd boot server netmask.Default=0.0.0.0

Bootserver2_Gateway: 2nd boot server gateway.Default=0.0.0.0

Bootserver2_Port: 2nd boot server port. Min=1025,Max=65536, Default=6910

Bootserver3_Ip: 3rd boot server IP. Default=0.0.0.0

Bootserver3_Netmask: 3rd boot server netmask.Default=0.0.0.0

Bootserver3_Gateway: 3rd boot server gateway.Default=0.0.0.0

Bootserver3_Port: 3rd boot server port. Min=1025,Max=65536, Default=6910

Bootserver4_Ip: 4th boot server IP. Default=0.0.0.0

Bootserver4_Netmask: 4th boot server netmask.Default=0.0.0.0

Bootserver4_Gateway: 4th boot server gateway.Default=0.0.0.0

Bootserver4_Port: 4th boot server port. Min=1025,Max=65536, Default=6910

VerboseMode: Display verbose diagnostic informationwhen set to true. Default=false

InterruptSafeMode: Interrupt safe mode (use iftarget device hangs during boot) when set to true. Default=false

PaeMode: PAE mode (use if PAE enabled in boot.ini oftarget device) when set to true. Default=false

BootFromHdOnFail: For network recovery reboot tohard drive when set to true, restore network connection when set to false.Default=false

RecoveryTime: When bootFromHdOnFail is 1, this isthe number of seconds to wait before reboot to hard drive. Min=10, Max=60000,Default=50

PollingTimeout: Login polling timeout inmilliseconds. Min=1000, Max=60000, Default=5000

GeneralTimeout: Login general timeout inmilliseconds. Min=1000, Max=60000, Default=5000

PvsServerBootstrap[]: If successful, thePvsServerBootstrap object(s) are returned.

EXAMPLE 1: Get PvsServerBootstrap

Get the PvsServerBootstrap for the Bootstrap namedtheBootstrap on the Server named theServer.

Get-PvsServerBootstrap -ServerName theServer -NametheBootstrap

Get-PvsServerBootstrapName

Get the bootstrap names for a Server.

One of these required

Guid[] Guid or ServerId: GUID of the Server to Getbootstrap names for.

string[] Name or ServerName: Name of the Server toGet bootstrap names for.

Instead of a parameter that matches one of themembers listed

PvsObject[] Object: PvsObjects with the membersbelow can be used as the Object parameter or from a pileline:

ServerId

PvsServerBootstrapName[]: If successful, thePvsServerBootstrapName object(s) are returned.

EXAMPLE 1: Get PvsServerBootstrapName for Server

Get all PvsServerBootstrapName for the Server namedtheServer.

Get-PvsServerBootstrapName -Name theServer

Get-PvsServerCount

Get count of Servers in a Site.

One of these required

Guid Guid or SiteId: GUID of the Site to get theServer Count of.

string Name or SiteName: Name of the Site to get theServer Count of.

Instead of a parameter that matches one of themembers listed

PvsObject[] Object: PvsObjects with the membersbelow can be used as the Object parameter or from a pileline:

SiteId

UInt32: If successful, the numeric value is returned

EXAMPLE 1: Get-PvsServerCount Returns the Number (or Count) of PvsServer inPvsSite

Get-PvsServerCount -Name theSite

Get-PvsServerInfo

Get the fields and status for a Server, all Serversin a Site that use a Store, service a DiskLocator, or for the whole Farm. AllServers are returned if no parameters are passed.

One of these optional

Guid[] Guid or ServerId: GUID of the Server to Get.

string[] Name or ServerName: Name of the Server toGet.

Guid[] SiteId: GUID of the Site to Get all Servers.

string[] SiteName: Name of the Site to Get allServers.

Guid[] DiskLocatorId: GUID of the Disk Locator toGet all Servers.

or this optional ; resolution

string[] DiskLocatorName: Name of the Disk LocatorFile to Get all Servers.

One of these optional ; resolutions

Guid[] StoreId: GUID of the Store to Get allServers.

string[] StoreName: Name of the Store to Get allServers.

Optional

SwitchParameter All: If -All is specified, withStoreId or StoreName all Servers for the Store including ones with invalidpaths will be returned.

One of these resolutions when needed

Guid[] SiteId: GUID of the Site to Get all Servers.

string[] SiteName: Name of the Site to Get all Servers.

One of these resolutions when needed

Guid[] StoreId: GUID of the Store to Get allServers.

string[] StoreName: Name of the Store to Get allServers.

Instead of a parameter that matches one of themembers listed

PvsObject[] Object: PvsObjects with the membersbelow can be used as the Object parameter or from a pileline:

ServerId, SiteId, DiskLocatorId or StoreId

If only selected fields are needed, pass them in theFields parameter as a string array.

Guid or ServerId: Read-only GUID that uniquely identifiesthis Server.

Name or ServerName: Computer name with no spaces.ASCII computer name characters Max Length=21

SiteId: GUID of the Site this Server is to be amember of. It is not used with SiteName.

SiteName: Name of the Site this Server is to be a memberof. It is not used with SiteId.

Description: User description. Default=""Max Length=250

AdMaxPasswordAge: Number of days before a passwordexpires. Min=1, Max=30, Default=7

LicenseTimeout: Amount of seconds before a licensetimes out. Min=15, Max=300, Default=30

VDiskCreatePacing: VDisk create time pacing inmiliseconds. Min=0, Max=5, Default=0

FirstPort: Number of the first UDP port for use bythe Stream Service, First and Last must allow at least 5 ports. Min=1025,Max=65534, Default=6910

LastPort: Number of the last UDP port for use by theStream Service, First and Last must allow at least 5 ports. Min=1025,Max=65534, Default=6930

ThreadsPerPort: Number of worker threads per IOport. Required that (threadPerPort * numberPorts * numberIPs) <= 1000.Min=1, Max=60, Default=8

BuffersPerThread: Number of buffers per workerthread. Min=1, Max=128, Default=24

ServerCacheTimeout: Number of seconds to wait beforeconsidering another Server is down. Min=5, Max=60, Default=8

IoBurstSize: Number of bytes read/writes can send ina burst of packets. Required that IoBurstSize/(MaxTransmissionUnits-76)<=32.Min=4096, Max=61440, Default=32768

MaxTransmissionUnits: Ethernet maximum transmissionunit size for the protocol for use for Server and Device. Required thatIoBurstSize/(MaxTransmissionUnits-76)<=32. Min=502, Max=16426, Default=1506

MaxBootDevicesAllowed: Maximum number of Devicesallowed to boot simultaneously. Min=1, Max=1000, Default=500

MaxBootSeconds: Maximum number of seconds for aDevice to boot. Min=10, Max=900, Default=60

BootPauseSeconds: Number of seconds that a Devicewill pause during login if its server busy. Min=1, Max=60, Default=10

AdMaxPasswordAgeEnabled: Age the password, when setto true. Default=false

EventLoggingEnabled: Enable event logging, when setto true. Default=false

NonBlockingIoEnabled: Use non-Blocking IO, when setto true. Default=true

Role: Read-only Role of the user for this item. 100is Farm Administrator, and 200 is Site Administrator. Default=999

Ip: One or more streaming ip addresses.

InitialQueryConnectionPoolSize: Initial size ofdatabase connection pool for non-transactional queries. Min=1, Max=1000,Default=50

InitialTransactionConnectionPoolSize: Initial sizeof database connection pool for transactional queries. Min=1, Max=1000,Default=50

MaxQueryConnectionPoolSize: Maximum size of databaseconnection pool for non-transactional queries. Min=1, Max=32767, Default=1000

MaxTransactionConnectionPoolSize: Maximum size ofdatabase connection pool for transactional queries. Min=1, Max=32767,Default=1000

RefreshInterval: Interval, in number of seconds, theserver should wait before refreshing settings. If set to 0, unused databaseconnections are never released. Min=0, Max=32767, Default=300

UnusedDbConnectionTimeout: Interval, in number ofseconds, a connection should go unused before it is to be released. Min=0,Max=32767, Default=300

BusyDbConnectionRetryCount: Number of times a faileddatabase connection will be retried. Min=0, Max=32767, Default=2

BusyDbConnectionRetryInterval: Interval, in numberof milliseconds, the server should wait before retrying to connect to adatabase. Min=0, Max=10000, Default=25

LocalConcurrentIoLimit: Maximum concurrent IOtransactions it performs for vDisks that are local. A value of 0 disables thefeature. Min=0, Max=128, Default=4

RemoteConcurrentIoLimit: Maximum concurrent IOtransactions it performs for vDisks that are remote. A value of 0 disables thefeature. Min=0, Max=128, Default=4

RamDiskIpAddress: IP address to use for transferringthe RAM Disk. When equal to 0.0.0.0 the server IP is used with the first partreplaced with 233. Default=0.0.0.0

RamDiskTimeToLive: Time to live for the invitationpacket sent to Devices. Min=1, Max=255, Default=1

RamDiskInvitationType: Either false for Fixed, ortrue for Variable. Default=false

RamDiskInvitationPeriod: The amount of time inseconds that invitations are sent to Devices. Min=1, Max=300, Default=10

Active: 1 if the Server is currently active, 2 ifunknown, and 0 otherwise. Min=0, Max=2, Default=0

LogLevel: 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

LogFileSizeMax: Maximum size log files can reach inMegabytes. Min=1, Max=50, Default=5

LogFileBackupCopiesMax: Maximum number of log filebackups. Min=1, Max=50, Default=4

PowerRating: A strictly relative rating of thisServer's capabilities when compared to other Servers in the Store(s) it belongstoo; can be used to help tune load balancing. Min=0.1, Max=1000, Default=1

ServerFqdn: Read-only fully qualified domain name.Default="" Max Length=1024

ManagementIp: IP address used for managementcommunications between Servers. Default=0.0.0.0

LastCeipUploadAttempt: Time that this server lastattempted a CEIP upload. Default=Empty

LastBugReportAttempt: Time that this server lastattempted to upload or generate a bug report bundle. Default=Empty

LastBugReportStatus: Status of the last bug reporton this server. Default="" Max Length=250

LastBugReportResult: Status of the last bug reporton this server. Default="" Max Length=4000

LastBugReportSummary: Summary of the last bug reporton this server. Default="" Max Length=250

ContactIp: Read-only contact IP for the Server.

ContactPort: Read-only contact port for the Server.

DeviceCount: Read-only count of Devices. Default=0

PvsServerInfo[]: If successful, the PvsServerInfoobject(s) are returned.

EXAMPLE 1: Get PvsServerInfo for Farm

Get all PvsServerInfo for the Farm.

Get-PvsServerInfo

EXAMPLE 2: Get PvsServerInfo for Site

Get all PvsServerInfo for the Site named theSite.

Get-PvsServerInfo -SiteName theSite

EXAMPLE 3: Get PvsServerInfo for Site and Store

Get all PvsServerInfo for the Site named theSite andStore named theStore.

Get-PvsServerInfo -SiteName theSite -StoreNametheStore

EXAMPLE 4: Get PvsServerInfo for DiskLocator

Get the PvsServerInfo for the DiskLocator namedtheDiskLocator in the Site named theSite and Store named theStore.

Get-PvsServerInfo -DiskLocatorName theDiskLocator-SiteName theSite -StoreName theStore

DiskLocatorId can be used instead of DiskLocatorNameso that the SiteName or SiteId and StoreName or StoreId are not also needed.

EXAMPLE 5: Get PvsServerInfo for Server

Get the PvsServerInfo for the Server named theServer.

Get-PvsServerInfo -Name theServer

EXAMPLE 6: Get PvsServerInfo Not Active and Start

Get all PvsServerInfo that are not Active and thenStart them.

Get-PvsServerInfo -Fields Active | Where-Object{$_.Active -eq 0} | Start-PvsStreamService

The -Fields parameter with only the needed fieldsspecified makes the Get work faster because only those fields are retrieved.

Get-PvsServerName

Return the name of the Server the SoapServer isrunning on.

String: If successful, the String value is returned.

EXAMPLE 1: Get-PvsServerName

Get-PvsServerName

Get-PvsServerStatus

Get the Server Status fields for a Server.

One of these required

Guid[] Guid or ServerId: GUID of the Server to Getstatus for.

string[] Name or ServerName: Name of Server to Getstatus for.

Instead of a parameter that matches one of themembers listed

PvsObject[] Object: PvsObjects with the membersbelow can be used as the Object parameter or from a pileline:

ServerId

If only selected fields are needed, pass them in theFields parameter as a string array.

Guid or ServerId: Read-only GUID of the Server. Canbe used with Get Server.

Name or ServerName: Read-only Name of the Server.Can be used with Get Server.

Ip: Read-only contact IP for the Server.

Port: Read-only contact port for the Server.

DeviceCount: Read-only count of Devices. Default=0

Status: Status of the server, 0 if down, 1 if up and2 if unknown. Default=0

PvsServerStatus[]: If successful, thePvsServerStatus object(s) are returned.

EXAMPLE 1: Get PvsServerStatus for Server

Get the PvsServerStatus for the Server namedtheServer.

Get-PvsServerStatus -Name theServer

Get-PvsServerStore

Get the directory and cache paths of a Server forone or all Stores.

One of these required

Guid[] ServerId: GUID of a Server.

string[] ServerName: Name of a Server.

One of these optional

Guid[] StoreId: GUID of the Store.

string[] StoreName: Name of the Store.

Instead of a parameter that matches one of themembers listed

PvsObject[] Object: PvsObjects with the membersbelow can be used as the Object parameter or from a pileline:

(ServerId and StoreId), ServerId or StoreId

If only selected fields are needed, pass them in theFields parameter as a string array.

StoreId: GUID of the Store. StoreName can be usedinstead.

StoreName: Name of the Store. StoreId can be usedinstead.

ServerId: GUID of the server that uses the Store.ServerName can be used instead.

ServerName: Name of the server that uses the Store.ServerId can be used instead.

Path: Directory path that the Server uses to accessthe Store. Default="" Max Length=255

CachePath: Cache path(s) that the Server uses withthe Store. If none are specified the caches will be placed in the StorecachePath. Default=None

PvsServerStore[]: If successful, the PvsServerStoreobject(s) are returned.

EXAMPLE 1: Get PvsServerStore for Server

Get all PvsServerStore for the Server namedtheServer.

Get-PvsServerStore -ServerName theServer

EXAMPLE 2: Get PvsServerStore for Server and Store

Get the PvsServerStore for the Server namedtheServer and Store named theStore.

Get-PvsServerStore -ServerName theServer -StoreNametheStore

Get-PvsServerStoreActiveDeviceCount

Get the count of Devices currently connected to anyvdisk served from the Store by the Server.

One of these required

Guid ServerId: GUID of the Server.

string ServerName: Name of the Server.

One of these required

Guid StoreId: GUID of the Store.

string StoreName: Name of the Store.

Instead of a parameter that matches one of themembers listed

PvsObject[] Object: PvsObjects with the membersbelow can be used as the Object parameter or from a pileline:

ServerId or StoreId

UInt32: If successful, the numeric value is returned

EXAMPLE 1: Get-PvsServerStoreActiveDeviceCount Returns the Number (orCount) of PvsDevice Served from PvsStore by PvsServer

Get-PvsServerStoreActiveDeviceCount -ServerNametheServer -StoreName theStore

Get-PvsSite

Get the fields for a Site or all Sites. All Sitesare returned if no parameters are passed.

One of these optional

Guid[] Guid or SiteId: GUID of the Site to Get.

string[] Name or SiteName: Name of the Site to Get.

Instead of a parameter that matches one of themembers listed

PvsObject[] Object: PvsObjects with the membersbelow can be used as the Object parameter or from a pileline:

SiteId

If only selected fields are needed, pass them in theFields parameter as a string array.

Guid or SiteId: Read-only GUID that uniquelyidentifies this Site.

Name or SiteName: Name of the Site. Max Length=50

Description: User description. Default=""Max Length=250

DefaultCollectionId: GUID of the Collection to placenew Devices into automatically. Not used with defaultCollectionName.Default=00000000-0000-0000-0000-000000000000

DefaultCollectionName: Name of the Collection toplace new Devices into automatically. Not used with DefaultCollectionId. Default=""

InventoryFilePollingInterval: The number of secondsbetween polls for Disk changes in the Stores. Min=1, Max=600, Default=60

EnableDiskUpdate: True when Disk Updated is enabledfor the Site, false otherwise. Default=false

DiskUpdateServerId: GUID of the Disk Update Serverfor the Site. Not used with DiskUpdateServerName.Default=00000000-0000-0000-0000-000000000000

DiskUpdateServerName: Name of the Disk Update Serverfor the Site. Not used with DiskUpdateServerId. Default=""

MakUser: User name used for MAK activation.Default="" Max Length=64

MakPassword: User password used for MAK activation.Default="" Max Length=64

Role: Read-only Role of the user for this item. 100is Farm Administrator, 200 is Site Administrator, and 999 is read-only.Default=999

PvsSite[]: If successful, the PvsSite object(s) arereturned.

EXAMPLE 1: Get PvsSite for Farm

Get all PvsSite for the Farm.

Get-PvsSite

EXAMPLE 2: Get PvsSite

Get the PvsSite for the Site named theSite.

Get-PvsSite -Name theSite

Get-PvsSiteView

Get the fields for a Site View or all Site Views ina Site or the whole Farm. All Site Views are returned if no parameters arepassed.

One of these optional

Guid[] Guid or SiteViewId: GUID of the Site View toGet.

Guid[] SiteId: GUID of the Site to Get all Views for.

string[] SiteName: Name of the Site to Get all Viewsfor.

or this optional ; resolution

string[] Name or SiteViewName: Name of the Site Viewto Get.

One of these resolutions when needed

Guid[] SiteId: GUID of the Site to Get all Viewsfor.

string[] SiteName: Name of the Site to Get all Viewsfor.

Instead of a parameter that matches one of themembers listed

PvsObject[] Object: PvsObjects with the membersbelow can be used as the Object parameter or from a pileline:

SiteViewId or SiteId

If only selected fields are needed, pass them in theFields parameter as a string array.

Guid or SiteViewId: Read-only GUID that uniquelyidentifies this Site View.

Name or SiteViewName: Name of the Site View. MaxLength=50

SiteId: GUID of the Site this View is to be a memberof. It is not used with SiteName.

SiteName: Name of the Site this View is to be amember of. It is not used with SiteId.

Description: User description. Default=""Max Length=250

DeviceCount: Read-only count of Devices in this SiteView. Default=0

DeviceWithPVDCount: Read-only count of Devices withPersonal vDisk in this Site View. Default=0

ActiveDeviceCount: Read-only count of active Devicesin this Site View. Default=0

MakActivateNeededCount: Read-only count of activeDevices that need MAK activation in this Site View. Default=0

Role: Read-only Role of the user for this item. 100is Farm Administrator, and 200 is Site Administrator. Default=999

PvsSiteView[]: If successful, the PvsSiteViewobject(s) are returned.

EXAMPLE 1: Get PvsSiteView for Farm

Get all PvsSiteView for the Farm.

Get-PvsSiteView

EXAMPLE 2: Get PvsSiteView for Site

Get all PvsSiteView for the Site named theSite.

Get-PvsSiteView -SiteName theSite

EXAMPLE 3: Get PvsSiteView

Get the PvsSiteView for the SiteView namedtheSiteView in the Site named theSite.

Get-PvsSiteView -Name theSiteView -SiteName theSite

Guid can be used instead of Name so that theSiteName or SiteId is not also needed.

Get-PvsStore

Get the fields for a Store or all Stores for aServer, Site or the Farm. All Stores are returned if no parameters are passed.

One of these optional

Guid[] Guid or StoreId: GUID of the Store to Get.

string[] Name or StoreName: Name of the Store toGet.

Guid[] ServerId: GUID of the Server to Get allStores for.

string[] ServerName: Name of the Server to Get allStores for.

Guid[] SiteId: GUID of the Site to Get all Storesfor.

string[] SiteName: Name of the Site to Get allStores for.

Instead of a parameter that matches one of themembers listed

PvsObject[] Object: PvsObjects with the membersbelow can be used as the Object parameter or from a pileline:

StoreId, ServerId or SiteId

If only selected fields are needed, pass them in theFields parameter as a string array.

Guid or StoreId: Read-only GUID that uniquelyidentifies this Store.

Name or StoreName: Name of the Store. Max Length=50

SiteId: GUID of the Site where Administrators ofthat Site can change this Store. Not used for Farm Stores. SiteName can be usedinstead. Default=00000000-0000-0000-0000-000000000000

SiteName: Name of the Site where Administrators ofthat Site can change this Store. Not used for Farm Stores. SiteId can be usedinstead. Default=""

Description: User description. Default=""Max Length=250

Path: Default directory path that the Servers use toaccess this Store. Max Length=255

CachePath: Default Cache path(s) that the Serversuse with this Store. If none are specified the caches will be placed in theWriteCache subdirectory of the Store path. Default=None

Role: Read-only Role of the user for this item. 100is Farm Administrator, 200 is Site Administrator, and 999 is read-only.Default=999

PathType: Read-only field indicating if the vdisksare on a server's local hard disk or on a remote share.

PvsStore[]: If successful, the PvsStore object(s)are returned.

EXAMPLE 1: Get PvsStore for Farm

Get all PvsStore for the Farm.

Get-PvsStore

EXAMPLE 2: Get PvsStore for Site

Get all PvsStore for the Site named theSite.

Get-PvsStore -SiteName theSite

EXAMPLE 3: Get PvsStore for Server

Get all PvsStore for the Server named theServer.

Get-PvsStore -ServerName theServer

EXAMPLE 4: Get PvsStore

Get the PvsStore for the Store named theStore.

Get-PvsStore -Name theStore -SiteName theSite

Get-PvsStoreFreeSpace

Get the free megabytes available in the Store.

One of these required ; resolutions

Guid Guid or StoreId: GUID of the Store.

string Name or StoreName: Name of the Store.

One of these resolutions when needed

Guid ServerId: GUID of the Server to use todetermine the free space in the Store.

string ServerName: Name of the Server to use to determinethe free space in the Store.

Guid SiteId: GUID of the Site.

string SiteName: Name of the Site.

UInt32: If successful, the numeric value is returned

EXAMPLE 1: Get-PvsStoreFreeSpace for Name with ServerName

Get-PvsStoreFreeSpace -Name theStore -ServerNametheServer

EXAMPLE 2: Get-PvsStoreFreeSpace for Name with SiteName

Get-PvsStoreFreeSpace -Name theStore -SiteNametheSite

Get-PvsStoreSharedOrServerPath

Get the Stores and paths for the ServerNamespecified or Stores with only shared UNC paths.

One of these required

Guid[] SiteId: GUID of a Site used for authorizationcheck.

string[] SiteName: Name of a Site used forauthorization check.

Optional

string[] ServerName: Name of a Server to also getlocal Store paths for.

Instead of a parameter that matches one of themembers listed

PvsObject[] Object: PvsObjects with the membersbelow can be used as the Object parameter or from a pileline:

SiteId

If only selected fields are needed, pass them in theFields parameter as a string array.

StoreId: GUID of the Store.

StoreName: Name of the Store.

Path: Directory path that the Servers use to accessthis Store.

PvsStoreSharedOrServerPath[]: If successful, thePvsStoreSharedOrServerPath object(s) are returned.

EXAMPLE 1: Get PvsStoreSharedOrServerPath with Sharded UNC Paths

Get PvsStoreSharedOrServerPath with shared UNC pathsfor the Farm.

Get-PvsStoreSharedOrServerPath -SiteName theSite

EXAMPLE 2: Get PvsStoreSharedOrServerPath with Sharded UNC Paths and ServerLocal Paths

Get PvsStoreSharedOrServerPath with shared UNC pathsfor the Farm with local paths for the Server named theServer.

Get-PvsStoreSharedOrServerPath -SiteName theSite-StoreName theServer

Get-PvsTask

Get the current Task fields for select, or allactive and completed un-cleared tasks.

One of these optional

uint TaskId: ID of the Task to get.

Guid[] SiteId: GUID of the Site to get Tasks for.

string[] SiteName: Name of the Site to get Tasksfor.

Optional

uint State: The TaskState to get Tasks for. Valuesare: 0 (Processing), 1 (Cancelled), and 2 (Complete).

Instead of a parameter that matches one of themembers listed

PvsObject[] Object: PvsObjects with the membersbelow can be used as the Object parameter or from a pileline:

TaskId or SiteId

If only selected fields are needed, pass them in theFields parameter as a string array.

TaskId: Unique ID of the task.

SiteId: GUID of the Site that this Task is beingprocessed in. Default=00000000-0000-0000-0000-000000000000

SiteName: Name of the Site that that this Task isbeing processed in.

Handle: Handle to a running function.

ServerFqdn: Qualified name of the server.Default="" Max Length=1024

Ip: IP Address of the remote host.

Port: Port number of the remote service.

StartTime: Time the task was started. Has the dateand time without milliseconds.

ExpirationTime: Time the task record may be removedfrom the database if the task does not complete. Has the date and time withoutmilliseconds.

State: State of the Task. Values are: 0(Processing), 1 (Cancelled), and 2 (Complete). Min=0, Max=2

CommandType: Type of the command. Values are: Add,Delete, Get, Info, Run, RunWithReturn, Set and SetList. Default=""Max Length=13

Command: Command being processed.Default="" Max Length=50

MapiException: Exception result in XML format.Default=""

Results: Result in XML format. Default=""

PvsTask[]: If successful, the PvsTask object(s) arereturned.

EXAMPLE 1: Get PvsTask for Farm

Get all PvsTask for the Farm.

Get-PvsTask

EXAMPLE 2: Get PvsTask for Site

Get all PvsTask for the Site named theSite.

Get-PvsTask -SiteName theSite

EXAMPLE 3: Get PvsTask Currently Processing

Get PvsTask that are currently in Processing statefor the Farm.

Get-PvsTask -State 0

EXAMPLE 4: Get PvsTask

Get PvsTask for TaskId 101.

Get-PvsTask -TaskId 101

Get-PvsTaskStatus

Get the status of a Task in percent complete.

This required

uint TaskId: Id of the Task to get the Status of.

Instead of a parameter that matches one of themembers listed

PvsObject[] Object: PvsObjects with the membersbelow can be used as the Object parameter or from a pileline:

TaskId

UInt32: If successful, the numeric value is returned

EXAMPLE 1: Get-PvsTaskStatus for Start-PvsBoot to PvsTask

$thePvsTask = Start-PvsBoot -NametheDevice #start the task

while ($thePvsTask.State -eq0) #while the task is processing

{

%percentFinished = Get-PvsTaskStatus -Object$thePvsTask # get percent finished

%percentFinished.ToString() + "%finished" #display percent finished

Start-Sleep -seconds 10 #wait 10 seconds more

$thePvsTask = Get-PvsTask -Object$thePvsTask #get the current PvsTask object

}

if ($thePvsTask.State -eq2) #check to see if completed

{

"Successful"

}

else

{

"Cancelled"

}

EXAMPLE 2: Get-PvsTaskStatus for taskId

Get-PvsTaskStatus -taskId 101

Get-PvsUndefinedDisk

Get undefined Disks for the Store on the Serverspecified.

One of these required

Guid[] ServerId: GUID of the Server to look forundefined Disks.

string[] ServerName: Name of the Server to look forundefined Disks.

One of these required

Guid[] StoreId: GUID of the Store that the Serverservices to look for undefined Disks.

string[] StoreName: Name of the Store that theServer services to look for undefined Disks.

Optional

SwitchParameter AutoAddEnabled: If -AutoAddEnabledis specified, then undefined Disks found will be automatically added.

Instead of a parameter that matches one of themembers listed

PvsObject[] Object: PvsObjects with the membersbelow can be used as the Object parameter or from a pileline:

ServerId or StoreId

If only selected fields are needed, pass them in theFields parameter as a string array.

Name: Name of the disk file without the extension.

Status: Status of the disk file. Values are: 0(Valid), 1 (Missing Properties File), 2 (Access Denied), 3 (Access Denied andMissing Properties File), 4 (Invalid Disk File), 5 (Manifest Missing orInvalid), 6 (Both VHD and VHDX)

VHDX: If VHDX is true, the format of the image isVHDX. Otherwise it is VHD. Default=false

PvsUndefinedDisk[]: If successful, thePvsUndefinedDisk object(s) are returned.

EXAMPLE 1: Get PvsUndefinedDisk

Get all PvsUndefinedDisk in the Store named theStoreusing the Server named theServer.

Get-PvsUndefinedDisk -ServerName theServer-StoreName theStore

EXAMPLE 2: Get PvsUndefinedDisk with AutoAdd

Get all PvsUndefinedDisk and Auto Adds them in theStore named theStore using the Server named theServer.

Get-PvsUndefinedDisk -ServerName theServer-StoreName theStore -AutoAddEnabled

Get-PvsUpdateTask

Get the fields for an Update Task or all UpdateTasks in a Site or the whole Farm. All Update Tasks are returned if noparameters are passed.

One of these optional

Guid[] Guid or UpdateTaskId: GUID of the Update Taskto Get.

Guid[] SiteId: GUID of the Site to Get all UpdateTasks for.

string[] SiteName: Name of the Site to Get allUpdate Tasks for.

or this optional ; resolution

string[] Name or UpdateTaskName: Name of the UpdateTask to Get.

One of these resolutions when needed

Guid[] SiteId: GUID of the Site to Get all UpdateTasks for.

string[] SiteName: Name of the Site to Get allUpdate Tasks for.

Instead of a parameter that matches one of themembers listed

PvsObject[] Object: PvsObjects with the membersbelow can be used as the Object parameter or from a pileline:

UpdateTaskId or SiteId

If only selected fields are needed, pass them in theFields parameter as a string array.

Guid or UpdateTaskId: Read-only GUID that uniquelyidentifies this Update Task.

Name or UpdateTaskName: Name of the Update Task. Itis unique within the Site. Max Length=50

SiteId: GUID of the Site that this Update Task is amember of. It is not used with SiteName.

SiteName: Name of the Site that this Update Task isa member of. It is not used with SiteId.

Description: User description. Default=""Max Length=250

Enabled: True when it will be processed, falseotherwise. Default=true

Hour: The hour of the day to perform the task.Min=0, Max=23, Default=0

Minute: The minute of the hour to perform the task.Min=0, Max=59, Default=0

Recurrence: The update will reoccur on thisschedule. 0 = None, 1 = Daily, 2 = Every Weekday, 3 = Weekly, 4 = Monthly Date,5 = Monthly Type. Min=0, Max=5, Default=0

DayMask: 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

Date: Days of the month. Numbers from 1-31 are theonly valid values. This is used with Monthly Date recurrence.Default="" Max Length=83

MonthlyOffset: When to happen monthly. 0 = None, 1 =First, 2 = Second, 3 = Third, 4 = Forth, 5 = Last. This is used with MonthlyType recurrence. Min=0, Max=5, Default=3

EsdType: Esd to use. Valid values are SCCM or WSUS.If no value, a custom script is run on the client. Default="" MaxLength=50

PreUpdateScript: Script file to run before theupdate starts. Default="" Max Length=255

PreVmScript: Script file to run before the VM isloaded. Default="" Max Length=255

PostUpdateScript: Script file to run after theupdate finishes. Default="" Max Length=255

PostVmScript: Script file to run after the VM isunloaded. Default="" Max Length=255

Domain: 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

OrganizationUnit: Organizational Unit to add theDisk 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 bedelimited with forward slashes, e.g. "ParentOU/ChildOU". Specialcharacters 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 ofdelimiting child OU's with a comma is still supported, but deprecated. Notethat in this case, the child OU comes first, e.g. "ChildOU,ParentOU".Default="" Max Length=255

PostUpdateApprove: Access to place the version inafter the update has occurred. 0 = Production, 1 = Test, 2 = Maintenance.Min=0, Max=2, Default=0

PvsUpdateTask[]: If successful, the PvsUpdateTaskobject(s) are returned.

EXAMPLE 1: Get PvsUpdateTask for Farm

Get all PvsUpdateTask for the Farm.

Get-PvsUpdateTask

EXAMPLE 2: Get PvsUpdateTask for Site

Get all PvsUpdateTask for the Site named theSite.

Get-PvsUpdateTask -SiteName theSite

EXAMPLE 3: Get PvsUpdateTask

Get PvsUpdateTask for UpdateTask named theUpdateTaskin Site named theSite.

Get-PvsUpdateTask -Name theUpdateTask -SiteNametheSite

Guid can be used instead of Name so that theSiteName or SiteId is not also needed.

Get-PvsUploadCeip

Perform a one time upload of CEIP data. Returnupload Id if successful.

This optional

string OneTimeUpload: If -OneTimeUpload isspecified, perform a one time upload.

Optional

SwitchParameter Confirm: The impact of thisoperation is "low". If -Confirm is specified, the operation will beconfirmed. $ConfirmPreference can be set to "low" to have confirmationwithout the Confirm parameter.

String: If successful, the String value is returned.

Get-PvsVersion

Get the version information.

If only selected fields are needed, pass them in theFields parameter as a string array.

MapiVersion: Version of the system inmajor.minor.point.build format.

DbVersion: Version of the database schema as anumber. Default=0

Type: Type of system. Values are 0 (Normal), 1(OROM), and 2 (Secure). Default=0

DbEdition: Edition of the database. If 'ExpressEdition', monitor dbSize.

DbSize: Size of the database in MB. Monitor thisvalue if the edition is 'Express Edition' and this value is close to reachingthe 4000 MB maximum. Default=0

MapiVersionNumber: Internal version number of thesystem. It is a number that is increaed by 100 for each major and minorrelease. Point releases are the numbers between each 100. Value is 0 when thesystem does not support MapiVersionNumber. Default=0

PvsVersion[]: If successful, the PvsVersionobject(s) are returned.

EXAMPLE 1: Get PvsVersion

Get the PvsVersion for the PVS SoapServer connectedto.

Get-PvsVersion

EXAMPLE 2: Get the PvsVersion MapiVersion

Get the PvsVersion for the PVS SoapServer connectedto.

Get-PvsVersion -Fields MapiVersion

The -Fields parameter with only the needed fieldsspecified makes the Get work faster because only those fields are retrieved.

Get-PvsVirtualHostingPool

Get the fields for a Virtual Hosting Pool or allVirtual Hosting Pools in a Site or the whole Farm. All Virtual Hosting Poolsare returned if no parameters are passed.

One of these optional

Guid[] Guid or VirtualHostingPoolId: GUID of theVirtual Hosting Pool to Get.

Guid[] SiteId: GUID of the Site to Get all VirtualHosting Pools for.

string[] SiteName: Name of the Site to Get allVirtual Hosting Pools for.

or this optional ; resolution

string[] Name or VirtualHostingPoolName: Name of theVirtual Hosting Pool to Get.

One of these resolutions when needed

Guid[] SiteId: GUID of the Site to Get all VirtualHosting Pools for.

string[] SiteName: Name of the Site to Get allVirtual Hosting Pools for.

Instead of a parameter that matches one of themembers listed

PvsObject[] Object: PvsObjects with the membersbelow can be used as the Object parameter or from a pileline:

VirtualHostingPoolId or SiteId

If only selected fields are needed, pass them in theFields parameter as a string array.

Guid or VirtualHostingPoolId: Read-only GUID thatuniquely identifies this Virtual Hosting Pool.

Name or VirtualHostingPoolName: Name of the VirtualHosting Pool. It is unique within the Site. Max Length=50

SiteId: GUID of the Site that this Virtual HostingPool is a member of. It is not used with SiteName.

SiteName: Name of the Site that this Virtual HostingPool is a member of. It is not used with SiteId.

Type: Type of the Virtual Hosting Pool. 0 = CitrixXenServer, 1 = Microsoft SCVMM/Hyper-V, 2 = VMWare vSphere/ESX. Min=0, Max=2,Default=0

Description: User description. Default=""Max Length=250

Server: Name or IP of the Host Server. MaxLength=255

Port: Port of the Host Server. Min=80, Max=65534,Default=80

Datacenter: Datacenter of the Virtual Hosting Pool.Default="" Max Length=250

UpdateLimit: Number of updates at the same time.Min=2, Max=1000, Default=1000

UpdateTimeout: Timeout for updates. Min=2, Max=240,Default=60

ShutdownTimeout: Timeout for shutdown. Min=2,Max=30, Default=10

UserName: Name to use when logging into the Server.

Password: Password to use when logging into theServer.

XdHostingUnitUuid: UUID of XenDesktop Hosting UnitDefault=00000000-0000-0000-0000-000000000000

XsPvsProxyEnabled: Enable XenServer PVS proxy whenset to true Default=false

PrepopulateEnabled: Enable prepopulate when set totrue Default=false

XsPvsSiteUuid: UUID of XenServerPVS_site Default=00000000-0000-0000-0000-000000000000

PvsVirtualHostingPool[]: If successful, thePvsVirtualHostingPool object(s) are returned.

EXAMPLE 1: Get PvsVirtualHostingPool for Farm

Get all PvsVirtualHostingPool for the Farm.

Get-PvsVirtualHostingPool

EXAMPLE 2: Get PvsVirtualHostingPool for Site

Get all PvsVirtualHostingPool for the Site namedtheSite.

Get-PvsVirtualHostingPool -SiteName theSite

EXAMPLE 3: Get PvsVirtualHostingPool

Get PvsVirtualHostingPool for VirtualHostingPoolnamed theVirtualHostingPool in Site named theSite.

Get-PvsVirtualHostingPool -NametheVirtualHostingPool -SiteName theSite

Guid can be used instead of Name so that theSiteName or SiteId is not also needed.

Get-PvsXDSite

Get the fields for a XenDesktop Site or allXenDesktop Sites. All XenDisktop Sites are returned if no parameters arepassed.

This optional

Guid[] Guid or XdSiteId: GUID of the XenDesktop Siteto Get.

Instead of a parameter that matches one of themembers listed

PvsObject[] Object: PvsObjects with the membersbelow can be used as the Object parameter or from a pileline:

XdSiteId

If only selected fields are needed, pass them in theFields parameter as a string array.

Guid or XdSiteId: GUID of the XenDesktop Site.

ConfigServices: XenDesktop Server addresses. MaxLength=2000

PvsXDSite[]: If successful, the PvsXDSite object(s)are returned.

EXAMPLE 1: Get PvsXDSite for Farm

Get all PvsXDSite for the Farm.

Get-PvsXDSite

EXAMPLE 2: Get PvsXDSite

Get the PvsXDSite for the XDSite with Guid45687f34-c9ec-4852-9d55-337a1af41405.

Get-PvsXDSite -Guid "45687f34-c9ec-4852-9d55-337a1af41405"

Grant-PvsAuthGroup

Assign an AuthGroup to have Farm, Site or CollectionAuthorization. If no Site or Collection is specified, the AuthGroup is givenFarm Authorization.

One of these required

Guid[] Guid or AuthGroupId: GUID of the AuthGroup toassign Authorization for.

string[] Name or AuthGroupName: Name of theAuthGroup to assign Authorization for.

One of these optional

Guid[] SiteId: GUID of the Site to assignAuthorization to for the AuthGroup.

string[] SiteName: Name of the Site to assignAuthorization to for the AuthGroup.

Guid[] CollectionId: GUID of the Collection toassign Authorization to for the AuthGroup.

or this optional ; resolution

string[] CollectionName: Name of the Collection toassign Authorization to for the AuthGroup.

Optional

uint Role: Authorization Role for the Collection.300 or 400 can be used. Role can only be used with CollectionId orCollectionName. 300 is Collection Administrator, and 400 is CollectionOperator. Default=400

One of these resolutions when needed

Guid[] SiteId: GUID of the Site to assignAuthorization to for the AuthGroup.

string[] SiteName: Name of the Site to assignAuthorization to for the AuthGroup.

Instead of a parameter that matches one of themembers listed

PvsObject[] Object: PvsObjects with the membersbelow can be used as the Object parameter or from a pileline:

AuthGroupId, SiteId or CollectionId

Optional

SwitchParameter Confirm: The impact of thisoperation is "low". If -Confirm is specified, the operation will beconfirmed. $ConfirmPreference can be set to "low" to haveconfirmation without the Confirm parameter.

EXAMPLE 1: Grant-PvsAuthGroup for PvsAuthGroup to PvsFarm

Grant-PvsAuthGroup -Name theAuthGroup

EXAMPLE 2: Grant-PvsAuthGroup for PvsAuthGroup Using Pipe

The Get-PvsAuthGroup output is piped to theGrant-PvsAuthGroup.

Get-PvsAuthGroup -Name theAuthGroup -Fields Guid |Grant-PvsAuthGroup

The -Fields parameter with only the needed fieldsspecified makes the Get work faster because only those fields are retrieved.

EXAMPLE 3: Grant-PvsAuthGroup for PvsAuthGroup to PvsSite

Grant-PvsAuthGroup -Name theAuthGroup -SiteNametheSite

EXAMPLE 4: Grant-PvsAuthGroup for PvsAuthGroup Using Pipe

The Get-PvsAuthGroup output is piped to theGrant-PvsAuthGroup.

Get-PvsAuthGroup -Name theAuthGroup -Fields Guid |Grant-PvsAuthGroup -SiteName theSite

The -Fields parameter with only the needed fieldsspecified makes the Get work faster because only those fields are retrieved.

EXAMPLE 5: Grant-PvsAuthGroup for PvsSite Using Pipe

The Get-PvsSite output is piped to theGrant-PvsAuthGroup.

Get-PvsSite -Name theSite -Fields Guid |Grant-PvsAuthGroup -Name theAuthGroup

The -Fields parameter with only the needed fieldsspecified makes the Get work faster because only those fields are retrieved.

EXAMPLE 6: Grant-PvsAuthGroup for PvsAuthGroup to PvsCollection

Grant-PvsAuthGroup -Name theAuthGroup-CollectionName theCollection -SiteName theSite

CollectionId can be used instead of CollectionNameso that the SiteName or SiteId is not also needed.

EXAMPLE 7: Grant-PvsAuthGroup for PvsAuthGroup Using Pipe

The Get-PvsAuthGroup output is piped to theGrant-PvsAuthGroup.

Get-PvsAuthGroup -Name theAuthGroup -Fields Guid |Grant-PvsAuthGroup -CollectionName theCollection -SiteName theSite

The -Fields parameter with only the needed fieldsspecified makes the Get work faster because only those fields are retrieved.

CollectionId can be used instead of CollectionNameso that the SiteName or SiteId is not also needed.

EXAMPLE 8: Grant-PvsAuthGroup for PvsCollection Using Pipe

The Get-PvsCollection output is piped to theGrant-PvsAuthGroup.

Get-PvsCollection -Name theCollection -SiteNametheSite -Fields Guid | Grant-PvsAuthGroup -Name theAuthGroup

The -Fields parameter with only the needed fieldsspecified makes the Get work faster because only those fields are retrieved.

Guid can be used instead of Name so that theSiteName or SiteId is not also needed.

EXAMPLE 9: Grant-PvsAuthGroup for PvsAuthGroup to PvsCollection

Grant-PvsAuthGroup -Name theAuthGroup-CollectionName theCollection -SiteName theSite -Role 300

CollectionId can be used instead of CollectionNameso that the SiteName or SiteId is not also needed.

EXAMPLE 10: Grant-PvsAuthGroup for PvsAuthGroup Using Pipe

The Get-PvsAuthGroup output is piped to theGrant-PvsAuthGroup.

Get-PvsAuthGroup -Name theAuthGroup -Fields Guid |Grant-PvsAuthGroup -CollectionName theCollection -SiteName theSite -Role 300

The -Fields parameter with only the needed fieldsspecified makes the Get work faster because only those fields are retrieved.

CollectionId can be used instead of CollectionNameso that the SiteName or SiteId is not also needed.

EXAMPLE 11: Grant-PvsAuthGroup for PvsCollection Using Pipe

The Get-PvsCollection output is piped to theGrant-PvsAuthGroup.

Get-PvsCollection -Name theCollection -SiteNametheSite -Fields Guid | Grant-PvsAuthGroup -Name theAuthGroup -Role 300

The -Fields parameter with only the needed fieldsspecified makes the Get work faster because only those fields are retrieved.

Guid can be used instead of Name so that theSiteName or SiteId is not also needed.

Import-PvsDevices

Import Devices from the contents of the comma or tabdelimited fileName specified. Each record needs to have Device Name, MacAddress, Site Name, Collection Name, optional Description and optional Type.Description must exist for Type to be included, but it can have 0 length. Typecan be 1 when it performs test of Disks, 2 when it performs maintenance onDisks, and 0 otherwise.

This required

string[] Name or FileName: Name of the file toimport the Devices from. This must be a full file path name.

One of these optional

Guid[] CollectionId: GUID of the Collection toimport the Devices into.

Guid[] SiteId: GUID of the Site to import theDevices into.

string[] SiteName: Name of the Site to import theDevices into.

or this optional ; resolution

string[] CollectionName: Name of the Collection toimport the Devices into.

Optional

SwitchParameter CopyTemplate: If -CopyTemplate isspecified, the Template Device for the collection, if it exists, will be usedfor the property settings of the imported Devices.

SwitchParameter DoNotCreateNewSites: If-DoNotCreateNewSites is specified, new Sites found in the file will not becreated.

SwitchParameter DoNotCreateNewCollections: If-DoNotCreateNewCollections is specified, new Collections found in the file willnot be created.

One of these resolutions when needed

Guid[] SiteId: GUID of the Site to import theDevices into.

string[] SiteName: Name of the Site to import theDevices into.

Instead of a parameter that matches one of themembers listed

PvsObject[] Object: PvsObjects with the membersbelow can be used as the Object parameter or from a pileline:

CollectionId or SiteId

Optional

SwitchParameter Confirm: The impact of this operationis "medium". If -Confirm is specified, the operation will beconfirmed. $ConfirmPreference can be set to "medium" or"low" to have confirmation without the Confirm parameter.

EXAMPLE 1: Import-PvsDevices

Import-PvsDevices -Name "C:\import\theFileName"

EXAMPLE 2: Import-PvsDevices

Import-PvsDevices -CopyTemplate -DoNotCreateNewSites-DoNotCreateNewCollections -Name "C:\import\theFileName"

EXAMPLE 3: Import-PvsDevices for SiteName

Import-PvsDevices -SiteName theSite -Name"C:\import\theFileName"

EXAMPLE 4: Import-PvsDevices for SiteName with CopyTemplate andDoNotCreateNewCollections

Import-PvsDevices -SiteName theSite -CopyTemplate-DoNotCreateNewCollections -Name "C:\import\theFileName"

EXAMPLE 5: Import-PvsDevices for PvsSite Using Pipe

The Get-PvsSite output is piped to theImport-PvsDevices.

Get-PvsSite -Name theSite -Fields Guid |Import-PvsDevices -Name "C:\import\theFileName"

The -Fields parameter with only the needed fieldsspecified makes the Get work faster because only those fields are retrieved.

EXAMPLE 6: Import-PvsDevices for CollectionName

Import-PvsDevices -CollectionName theCollection-SiteName theSite -Name "C:\import\theFileName"

CollectionId can be used instead of CollectionNameso that the SiteName or SiteId is not also needed.

EXAMPLE 7: Import-PvsDevices for CollectionName with CopyTemplate

Import-PvsDevices -CollectionName theCollection-SiteName theSite -CopyTemplate -Name "C:\import\theFileName"

CollectionId can be used instead of CollectionNameso that the SiteName or SiteId is not also needed.

EXAMPLE 8: Import-PvsDevices for PvsCollection Using Pipe

The Get-PvsCollection output is piped to theImport-PvsDevices.

Get-PvsCollection -Name theCollection -SiteNametheSite -Fields Guid | Import-PvsDevices -Name "C:\import\theFileName"

The -Fields parameter with only the needed fieldsspecified makes the Get work faster because only those fields are retrieved.

Guid can be used instead of Name so that theSiteName or SiteId is not also needed.

Import-PvsDisk

Import a Disk. It will add a Disk Locator for theDisk to the Site. A manifest file must exist in the Store. If successful, thenew PvsDiskLocator is returned.

This required ; resolution

string Name or DiskLocatorName: Name of the DiskLocator File. It is unique within the Store. ASCII Max Length=52

One of these optional

Guid ServerId: GUID of the single Server that thisDisk Locator is assigned to. It is not used with ServerName.Default=00000000-0000-0000-0000-000000000000

string ServerName: Name of the single Server thatthis Disk Locator is assigned to. It is not used with ServerId.Default=""

Optional

string Description: User description.Default="" Max Length=250

string MenuText: Text that is displayed in the BootMenu. If this field has no value, the name value is used. Default=""ASCII Max Length=64

SwitchParameter Enabled: True when this disk can bebooted, false otherwise. Default=true

SwitchParameter RebalanceEnabled: True when thisServer can automatically rebalance Devices, false otherwise. Default=false

uint RebalanceTriggerPercent: Percent over fair loadthat triggers a dynamic Device rebalance. Min=5, Max=5000, Default=25

uint SubnetAffinity: Qualifier for subnet affinitywhen assigning a Server. 0=None, 1=Best Effort, 2=Fixed. Min=0, Max=2, Default=0

SwitchParameter VHDX: If -VHDX is specified, VHDXwill be used for the format of the image. VHDX has a Block size of 32 MB. VHDis the default.

One of these resolutions when needed

Guid SiteId: GUID of the Site.

string SiteName: Name of the Site.

One of these resolutions when needed

Guid StoreId: GUID of the Store that is needed whena DiskLocatorName is used.

string StoreName: Name of the Store that is neededwhen a DiskLocatorName is used.

Instead of a parameter that matches one of themembers listed

PvsObject[] Object: PvsObjects with the membersbelow can be used as the Object parameter or from a pileline:

ServerId

Optional

SwitchParameter Confirm: The impact of thisoperation is "low". If -Confirm is specified, the operation will beconfirmed. $ConfirmPreference can be set to "low" to haveconfirmation without the Confirm parameter.

PvsDiskLocator: If successful, the newPvsDiskLocator object is returned.

EXAMPLE 1: Import-PvsDisk for VHDX to PvsDiskLocator

This example imports a VHDX Disk and uses thedefault settings for all other optional parameters.

$thePvsDiskLocator = Import-PvsDisk -NametheDiskLocator -SiteName theSite -StoreName theStore -VHDX

if ($thePvsDiskLocator -eq$null) # check that the PvsDiskLocator wasreturned

{

$thePvsDiskLocator.Name #display the name

}

EXAMPLE 2: Import-PvsDisk for VHD to PvsDiskLocator

This example imports a VHD Disk and sets all of theother optional parameters to non-default values.

$thePvsDiskLocator = Import-PvsDisk -Name theDiskLocator-SiteName theSite -StoreName theStore -ServerName theServer -Description"The VHD disk." -MenuText "The VHD disk." -Enabled-RebalanceEnabled -rebalanceTriggerPercent 50 -SubnetAffinity 2

if ($thePvsDiskLocator -eq$null) # check that the PvsDiskLocator wasreturned

{

$thePvsDiskLocator.Name #display the name

}

Import-PvsOemLicenses

Oem Only: Import the Oem Licenses from the contentsof the fileName specified.

This required

string[] Name or FileName: Name of the file toimport the Oem Licenses from. This must be a full file path name.

Optional

SwitchParameter Confirm: The impact of thisoperation is "medium". If -Confirm is specified, the operation willbe confirmed. $ConfirmPreference can be set to "medium" or"low" to have confirmation without the Confirm parameter.

EXAMPLE 1: Import-PvsOemLicenses

Import-PvsOemLicenses -Name"C:\import\theFileName"

Invoke-PvsActivateDeviceMAK

Proxy Activate with a Multiple Activation Key and/orapply the Confirmation ID to remote activate a Device DiskLocator pair.

One of these required

Guid[] Guid or DeviceId: GUID of the Device toActivate.

string[] Name or DeviceName: Name of the Device toActivate.

PvsPhysicalAddress[] DeviceMac: MAC of the Device toActivate.

This required

string[] MakUsedToActivate: Multiple Activation Keyto Activate the Device with.

Instead of a parameter that matches one of themembers listed

PvsObject[] Object: PvsObjects with the membersbelow can be used as the Object parameter or from a pileline:

DeviceId

Optional

SwitchParameter Confirm: The impact of thisoperation is "low". If -Confirm is specified, the operation will beconfirmed. $ConfirmPreference can be set to "low" to haveconfirmation without the Confirm parameter.

EXAMPLE 1: Invoke-ActivateDeviceMAK for Name

Invoke-ActivateDeviceMAK -Name theDevice-MakUsedToActivate "2FKWD-NYFC7-VH8G3-BK3GD-7T667"

EXAMPLE 2: Invoke-ActivateDeviceMAK for DeviceMac

Invoke-ActivateDeviceMAK -DeviceMac"00-11-22-33-44-55" -MakUsedToActivate"2FKWD-NYFC7-VH8G3-BK3GD-7T667"

EXAMPLE 3: Invoke-ActivateDeviceMAK for PvsDevice Using Pipe

The Get-PvsDevice output is piped to theInvoke-ActivateDeviceMAK.

Get-PvsDevice -Name theDevice -Fields Guid |Invoke-ActivateDeviceMAK -MakUsedToActivate"2FKWD-NYFC7-VH8G3-BK3GD-7T667"

The -Fields parameter with only the needed fieldsspecified makes the Get work faster because only those fields are retrieved.

Invoke-PvsMarkDown

Mark Down a Device, Collection, View, Server orSite.

One of these required

Guid[] DeviceId: GUID of the Device to Mark Down.

string[] DeviceName: Name of the Device to MarkDown.

PvsPhysicalAddress[] DeviceMac: MAC of the Device toMark Down.

Guid[] CollectionId: GUID of the Collection to MarkDown all Devices.

Guid[] SiteViewId: GUID of the Site View to MarkDown all Devices.

Guid[] SiteId: GUID of the Site. Can be used aloneto Mark Down all Servers and Devices in the Site.

string[] SiteName: Name of the Site. Can be usedalone to Mark Down all Servers and Devices in the Site.

Guid[] FarmViewId: GUID of the Farm View to MarkDown all Devices.

string[] FarmViewName: Name of the Farm View to MarkDown all Devices.

Guid[] DiskLocatorId: GUID of the DiskLocator toMark Down all Devices.

Guid[] ServerId: GUID of the Server to Mark Down.

string[] ServerName: Name of the Server to MarkDown.

or one of these required ; resolutions

string[] CollectionName: Name of the Collection toMark Down all Devices.

string[] SiteViewName: Name of the Site View to MarkDown all Devices.

string[] DiskLocatorName: Name of the DiskLocator toMark Down all Devices.

One of these resolutions when needed

Guid[] SiteId: GUID of the Site. Can be used aloneto Mark Down all Servers and Devices in the Site.

string[] SiteName: Name of the Site. Can be usedalone to Mark Down all Servers and Devices in the Site.

One of these resolutions when needed

Guid[] StoreId: GUID of the Store that is neededwhen a DiskLocatorName is used.

string[] StoreName: Name of the Store that is neededwhen a DiskLocatorName is used.

Instead of a parameter that matches one of themembers listed

PvsObject[] Object: PvsObjects with the membersbelow can be used as the Object parameter or from a pileline:

DeviceId, CollectionId, SiteViewId, SiteId,FarmViewId, DiskLocatorId or ServerId

Optional

SwitchParameter Confirm: The impact of thisoperation is "medium". If -Confirm is specified, the operation willbe confirmed. $ConfirmPreference can be set to "medium" or"low" to have confirmation without the Confirm parameter.

EXAMPLE 1: Invoke-PvsMarkDown for SiteName

Invoke-PvsMarkDown -SiteName theSite

EXAMPLE 2: Invoke-PvsMarkDown for PvsSite Using Pipe

The Get-PvsSite output is piped to theInvoke-PvsMarkDown.

Get-PvsSite -Name theSite -Fields Guid |Invoke-PvsMarkDown

The -Fields parameter with only the needed fieldsspecified makes the Get work faster because only those fields are retrieved.

EXAMPLE 3: Invoke-PvsMarkDown for ServerName

Invoke-PvsMarkDown -ServerName theServer

EXAMPLE 4: Invoke-PvsMarkDown for PvsServer Using Pipe

The Get-PvsServer output is piped to theInvoke-PvsMarkDown.

Get-PvsServer -Name theServer -Fields Guid |Invoke-PvsMarkDown

The -Fields parameter with only the needed fieldsspecified makes the Get work faster because only those fields are retrieved.

EXAMPLE 5: Invoke-PvsMarkDown for DeviceName

Invoke-PvsMarkDown -DeviceName theDevice

EXAMPLE 6: Invoke-PvsMarkDown for PvsDevice Using Pipe

The Get-PvsDevice output is piped to theInvoke-PvsMarkDown.

Get-PvsDevice -Name theDevice -Fields Guid |Invoke-PvsMarkDown

The -Fields parameter with only the needed fieldsspecified makes the Get work faster because only those fields are retrieved.

EXAMPLE 7: Invoke-PvsMarkDown for DeviceMac

Invoke-PvsMarkDown -DeviceMac"00-11-22-33-44-55"

EXAMPLE 8: Invoke-PvsMarkDown for PvsDevice Using Pipe

The Get-PvsDevice output is piped to theInvoke-PvsMarkDown.

Get-PvsDevice -DeviceMac"00-11-22-33-44-55" -Fields Guid | Invoke-PvsMarkDown

The -Fields parameter with only the needed fieldsspecified makes the Get work faster because only those fields are retrieved.

EXAMPLE 9: Invoke-PvsMarkDown for FarmViewName

Invoke-PvsMarkDown -FarmViewName theFarmView

EXAMPLE 10: Invoke-PvsMarkDown for PvsFarmView Using Pipe

The Get-PvsFarmView output is piped to theInvoke-PvsMarkDown.

Get-PvsFarmView -Name theFarmView -Fields Guid | Invoke-PvsMarkDown

The -Fields parameter with only the needed fieldsspecified makes the Get work faster because only those fields are retrieved.

EXAMPLE 11: Invoke-PvsMarkDown for CollectionName

Invoke-PvsMarkDown -CollectionName theCollection-SiteName theSite

CollectionId can be used instead of CollectionNameso that the SiteName or SiteId is not also needed.

EXAMPLE 12: Invoke-PvsMarkDown for PvsCollection Using Pipe

The Get-PvsCollection output is piped to theInvoke-PvsMarkDown.

Get-PvsCollection -Name theCollection -SiteNametheSite -Fields Guid | Invoke-PvsMarkDown

The -Fields parameter with only the needed fieldsspecified makes the Get work faster because only those fields are retrieved.

Guid can be used instead of Name so that theSiteName or SiteId is not also needed.

EXAMPLE 13: Invoke-PvsMarkDown for SiteViewName

Invoke-PvsMarkDown -SiteViewName theSiteView-SiteName theSite

SiteViewId can be used instead of SiteViewName sothat the SiteName or SiteId is not also needed.

EXAMPLE 14: Invoke-PvsMarkDown for PvsSiteView Using Pipe

The Get-PvsSiteView output is piped to theInvoke-PvsMarkDown.

Get-PvsSiteView -Name theSiteView -SiteName theSite-Fields Guid | Invoke-PvsMarkDown

The -Fields parameter with only the needed fieldsspecified makes the Get work faster because only those fields are retrieved.

Guid can be used instead of Name so that theSiteName or SiteId is not also needed.

EXAMPLE 15: Invoke-PvsMarkDown for DiskLocatorName

Invoke-PvsMarkDown -DiskLocatorName theDiskLocator-SiteName theSite -StoreName theStore

DiskLocatorId can be used instead of DiskLocatorNameso that the SiteName or SiteId and StoreName or StoreId are not also needed.

EXAMPLE 16: Invoke-PvsMarkDown for PvsDiskLocator Using Pipe

The Get-PvsDiskLocator output is piped to theInvoke-PvsMarkDown.

Get-PvsDiskLocator -Name theDiskLocator -SiteNametheSite -StoreName theStore -Fields Guid | Invoke-PvsMarkDown

The -Fields parameter with only the needed fieldsspecified makes the Get work faster because only those fields are retrieved.

Guid can be used instead of Name so that theSiteName or SiteId and StoreName or StoreId are not also needed.

Invoke-PvsPromoteDiskVersion

Commit the changes made in the current Maintenanceor a Test version. Promotes the Maintenance version or a Test version to a Testor new Production version.

This required

Guid[] Guid or DiskLocatorId: GUID of the DiskLocator File to Promote the Disk Version of.

or this required ; resolution

string[] Name or DiskLocatorName: Name of the DiskLocator File to Promote the Disk Version of.

Optional

DateTime ScheduledDate: Date/Time the new diskversion will become available. Uses only the date, hour and minute.

uint TestVersion: Specifies the Test version numberthat should be Promoted to Production.

SwitchParameter Test: If -Test is specified, set themode of the Maintenance version to Test.

One of these resolutions when needed

Guid[] SiteId: GUID of the Site.

string[] SiteName: Name of the Site.

One of these resolutions when needed

Guid[] StoreId: GUID of the Store that is neededwhen a DiskLocatorName is used.

string[] StoreName: Name of the Store that is neededwhen a DiskLocatorName is used.

Instead of a parameter that matches one of themembers listed

PvsObject[] Object: PvsObjects with the membersbelow can be used as the Object parameter or from a pileline:

DiskLocatorId

Optional

SwitchParameter Confirm: The impact of thisoperation is "low". If -Confirm is specified, the operation will beconfirmed. $ConfirmPreference can be set to "low" to have confirmationwithout the Confirm parameter.

EXAMPLE 1: Invoke-PvsPromoteDiskVersion to Production

Invoke-PvsPromoteDiskVersion -Name theDiskLocator-SiteName theSite -StoreName theStore

Guid can be used instead of Name so that theSiteName or SiteId and StoreName or StoreId are not also needed.

EXAMPLE 2: Invoke-PvsPromoteDiskVersion to Production Using Pipe

Get-PvsDiskLocator -Name theDiskLocator -SiteNametheSite -StoreName theStore -Fields Guid | Invoke-PvsPromoteDiskVersion

The -Fields parameter with only the needed fieldsspecified makes the Get work faster because only those fields are retrieved.

Guid can be used instead of Name so that theSiteName or SiteId and StoreName or StoreId are not also needed.

EXAMPLE 3: Invoke-PvsPromoteDiskVersion to Test

Invoke-PvsPromoteDiskVersion -Name theDiskLocator-SiteName theSite -StoreName theStore -Test

Guid can be used instead of Name so that theSiteName or SiteId and StoreName or StoreId are not also needed.

EXAMPLE 4: Invoke-PvsPromoteDiskVersion to Test Using Pipe

Get-PvsDiskLocator -Name theDiskLocator -SiteNametheSite -StoreName theStore -Fields Guid | Invoke-PvsPromoteDiskVersion -Test

The -Fields parameter with only the needed fieldsspecified makes the Get work faster because only those fields are retrieved.

Guid can be used instead of Name so that theSiteName or SiteId and StoreName or StoreId are not also needed.

EXAMPLE 5: Invoke-PvsPromoteDiskVersion Test to Production

Invoke-PvsPromoteDiskVersion -Name theDiskLocator-SiteName theSite -StoreName theStore -TestVersion 4

Guid can be used instead of Name so that theSiteName or SiteId and StoreName or StoreId are not also needed.

EXAMPLE 6: Invoke-PvsPromoteDiskVersion Test to Production Using Pipe

Get-PvsDiskLocator -Name theDiskLocator -SiteNametheSite -StoreName theStore -Fields Guid | Invoke-PvsPromoteDiskVersion-TestVersion 4

The -Fields parameter with only the needed fieldsspecified makes the Get work faster because only those fields are retrieved.

Guid can be used instead of Name so that theSiteName or SiteId and StoreName or StoreId are not also needed.

EXAMPLE 7: Invoke-PvsPromoteDiskVersion to Production, for Future

Invoke-PvsPromoteDiskVersion -Name theDiskLocator-SiteName theSite -StoreName theStore -ScheduledDate "2016/01/01"

Guid can be used instead of Name so that theSiteName or SiteId and StoreName or StoreId are not also needed.

EXAMPLE 8: Invoke-PvsPromoteDiskVersion to Production, for Future UsingPipe

Get-PvsDiskLocator -Name theDiskLocator -SiteNametheSite -StoreName theStore -Fields Guid | Invoke-PvsPromoteDiskVersion-ScheduledDate "2016/01/01"

The -Fields parameter with only the needed fieldsspecified makes the Get work faster because only those fields are retrieved.

Guid can be used instead of Name so that theSiteName or SiteId and StoreName or StoreId are not also needed.

Invoke-PvsRebalanceDevices

Rebalance Devices for a Server. When successful,returns the number of Devices affected.

One of these required

Guid Guid or ServerId: GUID of the Server toRebalance Devices on, ServerName.

string Name or ServerName: Name of the Server toRebalance Devices on, ServerId.

Instead of a parameter that matches one of themembers listed

PvsObject[] Object: PvsObjects with the membersbelow can be used as the Object parameter or from a pileline:

ServerId

Optional

SwitchParameter Confirm: The impact of thisoperation is "low". If -Confirm is specified, the operation will beconfirmed. $ConfirmPreference can be set to "low" to haveconfirmation without the Confirm parameter.

UInt32: If successful, the numeric value is returned

EXAMPLE 1: Invoke-PvsRebalanceDevices for Name

Invoke-PvsRebalanceDevices -Name theServer

Invoke-PvsRevertDiskVersion

Set the existing highest version disk to Maintenanceor Test mode. A specified version can be reverted to Test mode if there are noProduction versions higher than it. If the mode is Test, it can be set toMaintenance.

This required

Guid[] Guid or DiskLocatorId: GUID of the DiskLocator File to Revert.

or this required ; resolution

string[] Name or DiskLocatorName: Name of the DiskLocator File to Revert.

Optional

uint Version: Specifies the version number thatshould be Reverted to Test mode.

SwitchParameter Test: If -Test is specified, whenreverting the highest version, the access will be set to Test, otherwise set itto Maintenance.

One of these resolutions when needed

Guid[] SiteId: GUID of the Site.

string[] SiteName: Name of the Site.

One of these resolutions when needed

Guid[] StoreId: GUID of the Store that is neededwhen a DiskLocatorName is used.

string[] StoreName: Name of the Store that is neededwhen a DiskLocatorName is used.

Instead of a parameter that matches one of themembers listed

PvsObject[] Object: PvsObjects with the membersbelow can be used as the Object parameter or from a pileline:

DiskLocatorId

Optional

SwitchParameter Confirm: The impact of thisoperation is "medium". If -Confirm is specified, the operation willbe confirmed. $ConfirmPreference can be set to "medium" or"low" to have confirmation without the Confirm parameter.

EXAMPLE 1: Invoke-PvsRevertDiskVersion to Maintenance

Invoke-PvsRevertDiskVersion -Name theDiskLocator-SiteName theSite -StoreName theStore

Guid can be used instead of Name so that theSiteName or SiteId and StoreName or StoreId are not also needed.

EXAMPLE 2: Invoke-PvsRevertDiskVersion to Maintenance Using Pipe

Get-PvsDiskLocator -Name theDiskLocator -SiteNametheSite -StoreName theStore -Fields Guid | Invoke-PvsRevertDiskVersion

The -Fields parameter with only the needed fieldsspecified makes the Get work faster because only those fields are retrieved.

Guid can be used instead of Name so that theSiteName or SiteId and StoreName or StoreId are not also needed.

EXAMPLE 3: Invoke-PvsRevertDiskVersion to Test

Invoke-PvsRevertDiskVersion -Name theDiskLocator-SiteName theSite -StoreName theStore -Test

Guid can be used instead of Name so that theSiteName or SiteId and StoreName or StoreId are not also needed.

EXAMPLE 4: Invoke-PvsRevertDiskVersion to Test Using Pipe

Get-PvsDiskLocator -Name theDiskLocator -SiteNametheSite -StoreName theStore -Fields Guid | Invoke-PvsRevertDiskVersion -Test

The -Fields parameter with only the needed fieldsspecified makes the Get work faster because only those fields are retrieved.

Guid can be used instead of Name so that the SiteNameor SiteId and StoreName or StoreId are not also needed.

EXAMPLE 5: Invoke-PvsRevertDiskVersion Production to Test

Invoke-PvsRevertDiskVersion -Name theDiskLocator-SiteName theSite -StoreName theStore -Version 4

Guid can be used instead of Name so that theSiteName or SiteId and StoreName or StoreId are not also needed.

EXAMPLE 6: Invoke-PvsRevertDiskVersion Production to Test Using Pipe

Get-PvsDiskLocator -Name theDiskLocator -SiteNametheSite -StoreName theStore -Fields Guid | Invoke-PvsRevertDiskVersion -Version4

The -Fields parameter with only the needed fieldsspecified makes the Get work faster because only those fields are retrieved.

Guid can be used instead of Name so that theSiteName or SiteId and StoreName or StoreId are not also needed.

Merge-PvsDisk

Merge the Disk.

This required

Guid[] Guid or DiskLocatorId: GUID of the DiskLocator File to Merge.

or this required ; resolution

string[] Name or DiskLocatorName: Name of the DiskLocator File to Merge.

Optional

uint Access: Access to set the version to when mergeis finished. Default value is found in the Farm MergeMode setting. Values are:0 (Production), 1 (Test) and 2 (Maintenance), Min=0, Max=2

SwitchParameter NewBase: If -NewBase is specified,create a new base from last base plus all updates from that base. The defaultis to merge all updates from the last base by default.

One of these resolutions when needed

Guid[] SiteId: GUID of the Site.

string[] SiteName: Name of the Site.

One of these resolutions when needed

Guid[] StoreId: GUID of the Store that is neededwhen a DiskLocatorName is used.

string[] StoreName: Name of the Store that is neededwhen a DiskLocatorName is used.

Instead of a parameter that matches one of themembers listed

PvsObject[] Object: PvsObjects with the members belowcan be used as the Object parameter or from a pileline:

DiskLocatorId

Optional

SwitchParameter Confirm: The impact of thisoperation is "medium". If -Confirm is specified, the operation willbe confirmed. $ConfirmPreference can be set to "medium" or "low"to have confirmation without the Confirm parameter.

EXAMPLE 1: Merge-PvsDisk for Name

Merge-PvsDisk -Name theDiskLocator -SiteName theSite-StoreName theStore

Guid can be used instead of Name so that theSiteName or SiteId and StoreName or StoreId are not also needed.

EXAMPLE 2: Merge-PvsDisk for PvsDiskLocator Using Pipe

The Get-PvsDiskLocator output is piped to theMerge-PvsDisk.

Get-PvsDiskLocator -Name theDiskLocator -SiteNametheSite -StoreName theStore -Fields Guid | Merge-PvsDisk

The -Fields parameter with only the needed fieldsspecified makes the Get work faster because only those fields are retrieved.

Guid can be used instead of Name so that theSiteName or SiteId and StoreName or StoreId are not also needed.

EXAMPLE 3: Merge-PvsDisk for Name with Access and NewBase

Merge-PvsDisk -Name theDiskLocator -SiteName theSite-StoreName theStore -Access 2 -NewBase

Guid can be used instead of Name so that theSiteName or SiteId and StoreName or StoreId are not also needed.

EXAMPLE 4: Merge-PvsDisk for PvsDiskLocator Using Pipe

The Get-PvsDiskLocator output is piped to theMerge-PvsDisk.

Get-PvsDiskLocator -Name theDiskLocator -SiteNametheSite -StoreName theStore -Fields Guid | Merge-PvsDisk -Access 2 -NewBase

The -Fields parameter with only the needed fieldsspecified makes the Get work faster because only those fields are retrieved.

Guid can be used instead of Name so that theSiteName or SiteId and StoreName or StoreId are not also needed.

Mount-PvsDisk

Mount a disk. If successful, the drive letter or anempty string is returned. An empty string can be returned if a drive letter wasnot assigned by the operating system before the maxDiskLetterWaitSeconds isused up.

This required

Guid Guid or DiskLocatorId: GUID of the Disk Locatorto Mount the Disk.

or this required ; resolution

string Name or DiskLocatorName: Name of the DiskLocator to Mount the Disk.

One of these optional

Guid ServerId: Specific Server GUID to use to Mountthe Disk.

string ServerName: Specific Server Name to use toMount the Disk.

Optional

uint MaxDiskLetterWaitSeconds: Once mapping a diskis successful, this is the maximum amount of seconds spent waiting for theoperating system to return a drive letter. If the operating system does notreturn a drive letter before the maximum wait time, then an empty string isreturned. Default=30

One of these resolutions when needed

Guid SiteId: GUID of the Site.

string SiteName: Name of the Site.

One of these resolutions when needed

Guid StoreId: GUID of the Store that is needed whena DiskLocatorName is used.

string StoreName: Name of the Store that is neededwhen a DiskLocatorName is used.

Instead of a parameter that matches one of themembers listed

PvsObject[] Object: PvsObjects with the membersbelow can be used as the Object parameter or from a pileline:

DiskLocatorId or ServerId

Optional

SwitchParameter Confirm: The impact of thisoperation is "low". If -Confirm is specified, the operation will beconfirmed. $ConfirmPreference can be set to "low" to haveconfirmation without the Confirm parameter.

String: If successful, the String value is returned.

EXAMPLE 1: Mount-PvsDisk

$theDriveLetter = Start-PvsMapDisk -NametheDiskLocator -SiteName theSite -StoreName theStore

if ($theDriveLetter -ne $null -and$theDriveLetter.length -gt 0)

{

$theDriveLetter # display thedrive letter

}

Guid can be used instead of Name so that theSiteName or SiteId and StoreName or StoreId are not also needed.

EXAMPLE 2: Mount-PvsDisk for PvsServer with MaxDiskLetterWaitSeconds

$theDriveLetter = Start-PvsMapDisk -NametheDiskLocator -SiteName theSite -StoreName theStore -ServerName theServer-MaxDiskLetterWaitSeconds 60

if ($theDriveLetter -ne $null -and$theDriveLetter.length -gt 0)

{

$theDriveLetter # display thedrive letter

}

Guid can be used instead of Name so that theSiteName or SiteId and StoreName or StoreId are not also needed.

Move-PvsDeviceToCollection

Move a Device to a Collection. Personal vDiskDevices cannot be moved to a Collection in another Site.

One of these required

Guid[] Guid or DeviceId: GUID of the Device to Move.

string[] Name or DeviceName: Name of the Device toMove.

PvsPhysicalAddress[] DeviceMac: MAC of the Device toMove.

This required

Guid[] CollectionId: GUID of the Collection to Movea Device to. The Device is moved from whatever Collection it is currently in,to the Collection specified.

or this required ; resolution

string[] CollectionName: Name of the Collection toMove a Device to. The Device is moved from whatever Collection it is currentlyin, to the Collection specified.

Optional

SwitchParameter CopyTemplate: If -CopyTemplate isspecified, the Template Device for the Collection, if it exists, will be usedfor the property settings of the moved Device.

One of these resolutions when needed

Guid[] SiteId: GUID of the Site.

string[] SiteName: Name of the Site.

Instead of a parameter that matches one of themembers listed

PvsObject[] Object: PvsObjects with the membersbelow can be used as the Object parameter or from a pileline:

DeviceId or CollectionId

Optional

SwitchParameter Confirm: The impact of thisoperation is "low". If -Confirm is specified, the operation will beconfirmed. $ConfirmPreference can be set to "low" to haveconfirmation without the Confirm parameter.

EXAMPLE 1: Move-PvsDeviceToCollection for PvsDevice to PvsCollection

Move-PvsDeviceToCollection -Name theDevice-CollectionName theCollection -SiteName theSite

CollectionId can be used instead of CollectionNameso that the SiteName or SiteId is not also needed.

EXAMPLE 2: Move-PvsDeviceToCollection for PvsDevice Using Pipe

The Get-PvsDevice output is piped to theMove-PvsDeviceToCollection.

Get-PvsDevice -Name theDevice -Fields Guid |Move-PvsDeviceToCollection -CollectionName thetheCollection -SiteName theSite

The -Fields parameter with only the needed fieldsspecified makes the Get work faster because only those fields are retrieved.

CollectionId can be used instead of CollectionNameso that the SiteName or SiteId is not also needed.

EXAMPLE 3: Move-PvsDeviceToCollection for PvsCollection Using Pipe

The Get-PvsCollection output is piped to theMove-PvsDeviceToCollection.

Get-PvsCollection -Name theCollection -SiteNametheSite -Fields Guid | Move-PvsDeviceToCollection -Name theDevice

The -Fields parameter with only the needed fieldsspecified makes the Get work faster because only those fields are retrieved.

Guid can be used instead of Name so that theSiteName or SiteId is not also needed.

Move-PvsServerToSite

Move a Server to a Site.

One of these required

Guid[] Guid or ServerId: GUID of the Server toAssign.

string[] Name or ServerName: Name of the Server toAssign.

One of these required

Guid[] SiteId: GUID of the Site to Assign a Server.

string[] SiteName: Name of the Site to Assign aServer.

Instead of a parameter that matches one of themembers listed

PvsObject[] Object: PvsObjects with the membersbelow can be used as the Object parameter or from a pileline:

ServerId or SiteId

Optional

SwitchParameter Confirm: The impact of thisoperation is "low". If -Confirm is specified, the operation will beconfirmed. $ConfirmPreference can be set to "low" to haveconfirmation without the Confirm parameter.

EXAMPLE 1: Move-PvsServerToSite for PvsServer to PvsSite

Move-PvsServerToSite -Name theServer -SiteNametheSite

EXAMPLE 2: Move-PvsServerToSite for PvsServer Using Pipe

The Get-PvsServer output is piped to theMove-PvsServerToSite.

Get-PvsServer -Name theServer -Fields Guid |Move-PvsServerToSite -SiteName theSite

The -Fields parameter with only the needed fieldsspecified makes the Get work faster because only those fields are retrieved.

EXAMPLE 3: Move-PvsServerToSite for PvsSite Using Pipe

The Get-PvsSite output is piped to theMove-PvsServerToSite.

Get-PvsSite -Name theSite -Fields Guid |Move-PvsServerToSite -Name theServer

The -Fields parameter with only the needed fieldsspecified makes the Get work faster because only those fields are retrieved.

New-PvsAuthGroup

Create a new authorization AuthGroup for an ActiveDirectory or Windows Group.

All parameters that do not have a Default arerequired, unless only a few of a group are required.

string Name or AuthGroupName: Name of the ActiveDirectory or Windows Group. Max Length=450

string Description: User description.Default="" Max Length=250

SwitchParameter Confirm: The impact of thisoperation is "low". If -Confirm is specified, the operation will beconfirmed. $ConfirmPreference can be set to "low" to haveconfirmation without the Confirm parameter.

PvsAuthGroup: If successful, the new PvsAuthGroupobject is returned.

EXAMPLE 1: Create PvsAuthGroup with Minimum Fields

Creates a PvsAuthGroup for the"AD\PVSFarmAdminGroup" Active Directory security group.

New-PvsAuthGroup -Name"AD\PVSFarmAdminGroup"

EXAMPLE 2: Create PvsAuthGroup with All Fields

Creates a PvsAuthGroup for the"AD\PVSFarmAdminGroup" Active Directory security group with"Farm AuthGroup" as the description.

New-PvsAuthGroup -Name"AD\PVSFarmAdminGroup" -Description "Farm AuthGroup"

EXAMPLE 3: Create PvsAuthGroup and Assign to Site

Creates a PvsAuthGroup for the"AD\PVSSiteAdminGroup" Active Directory security group and Assigns itto theSite.

New-PvsAuthGroup -Name"AD\PVSSiteAdminGroup" | Grant-PvsAuthGroup -SiteName theSite

New-PvsCeipData

Create a new entry for CeipData table.

All parameters that do not have a Default arerequired, unless only a few of a group are required.

uint Enabled: 1 if CEIP is enabled, otherwise 0.Min=0, Max=1

DateTime NextUpload: Date and time next CEIP uploadis due if enabled is 1. Default=Empty

uint InProgress: 1 if an upload is currently inprogress, otherwise 0. Default=0

Guid ServerId: ID of server that is currentlyuploading, null if InProgress is 0.Default=00000000-0000-0000-0000-000000000000

uint OneTimeUpload: 1 to perform a one time upload.

SwitchParameter Confirm: The impact of thisoperation is "low". If -Confirm is specified, the operation will beconfirmed. $ConfirmPreference can be set to "low" to haveconfirmation without the Confirm parameter.

PvsCeipData: If successful, the new PvsCeipDataobject is returned.

EXAMPLE 1: Create PvsCeipData with Minimum Fields

Creates a PvsCeipData with enabled as false.

New-PvsCeipData -Enabled 0

EXAMPLE 2: Create PvsCeipData with All Fields

Creates a PvsCeipData with enabled as true and withall fields set different than defaults.

New-PvsCeipData -Enabled 1 -NextUpload"2016-01-14 15:52:00"

New-PvsCisData

Create a new entry for CisData table.

All parameters that do not have a Default arerequired, unless only a few of a group are required.

string UserName: Username used to obtain the tokenMax Length=255

string Path: Path where the last problem reportbundle was saved Default="" Max Length=255

string Password: Password of the user required toobtain the token. This is required only by Set and Add

SwitchParameter Confirm: The impact of thisoperation is "low". If -Confirm is specified, the operation will beconfirmed. $ConfirmPreference can be set to "low" to haveconfirmation without the Confirm parameter.

PvsCisData: If successful, the new PvsCisData objectis returned.

EXAMPLE 1: Create PvsCisData with Minimum Fields

Creates a PvsCisData with userName as userName andwith all fields set different than defaults.

New-PvsCisData -UserName userName

New-PvsCollection

Create a new Collection for a Site.

All parameters that do not have a Default arerequired, unless only a few of a group are required.

string Name or CollectionName: Name of theCollection. It is unique within the Site. Max Length=50

Guid SiteId: GUID of the Site that this Collectionis a member of. It is not used with SiteName.

string SiteName: Name of the Site that thisCollection is a member of. It is not used with SiteId.

string Description: User description.Default="" Max Length=250

uint LastAutoAddDeviceNumber: The Device Number ofthe last Auto Added Device. Default=0

SwitchParameter Disabled: If -Disabled is specified,the Devices in the Collection can not be booted. By default the Devices can bebooted.

string AutoAddPrefix: The string put before theDevice Number for Auto Add. Default="" ASCII computer name charactersno end digit Max Length=12

string AutoAddSuffix: The string put after theDevice Number for Auto Add. Default="" ASCII computer name charactersno begin digit Max Length=12

SwitchParameter NoAutoAddZeroFill: If-NoAutoAddZeroFill is specified, zeros will not be placed before the DeviceNumber up to the AutoAddNumberLength for Auto Add.

uint AutoAddNumberLength: The maximum length of theDevice Number for Auto Add. This length plus the AutoAddPrefix length plus theAutoAddSuffix length must be less than 16. Required that ((lenautoAddPrefix+lenautoAddSuffix)+AutoAddNumberLength)<=15.Min=3, Max=9, Default=4

SwitchParameter Confirm: The impact of thisoperation is "low". If -Confirm is specified, the operation will beconfirmed. $ConfirmPreference can be set to "low" to have confirmationwithout the Confirm parameter.

PvsCollection: If successful, the new PvsCollectionobject is returned.

EXAMPLE 1: Create PvsCollection with Minimum Fields

Creates a PvsCollection named theCollection intheSite.

New-PvsCollection -Name theCollection -SiteNametheSite

EXAMPLE 2: Create PvsCollection with All Fields

Creates a PvsCollection named theCollection intheSite with "XenServer Collection" as the description that isDisabled and has all AutoAdd settings different than defaults.

New-PvsCollection -Name theCollection -SiteNametheSite -Description "XenServer Collection" -Disabled-LastAutoAddDeviceNumber 100 -AutoAddPrefix A -AutoAddSuffix A-NoAutoAddZeroFill -AutoAddNumberLength 3

EXAMPLE 3: Create PvsCollection and Assign AuthGroup to it

Creates a PvsCollection named theCollection intheSite and Assigns AuthGroup "AD\PVSCollectionAdminGroup" to it.

New-PvsCollection -Name theCollection -SiteNametheSite | Grant-PvsAuthGroup -AuthGroupName"AD\PVSCollectionAdminGroup"

New-PvsDevice

Add a new Device to a Collection.

All parameters that do not have a Default arerequired, unless only a few of a group are required.

string Name or DeviceName: Computer name with nospaces. ASCII computer name characters Max Length=15

Guid CollectionId: GUID of the Collection thisDevice is to be a member of. It is not used with CollectionName.

string CollectionName: Name of the Collection thisDevice is to be a member of. SiteName or SiteId must also be used.

Guid SiteId: GUID of the Site the CollectionName isto be a member of. This or SiteName is used with CollectionName.

string SiteName: Name of the Site the CollectionNameis to be a member of. This or SiteId is used with CollectionName.

string Description: User description.Default="" Max Length=250

PvsPhysicalAddress DeviceMac: Ethernet address canhave the form XX-XX-XX-XX-XX-XX. Uniquely identifies the Device.

uint BootFrom: Device to boot from. Choices are 1for vDisk, 2 for Hard Disk, and 3 for Floppy. Min=1, Max=3, Default=1

string ClassName: Used by Automatic Update featureto match new versions of Disks to a Device. Default="" Max Length=41

uint Port: UDP port to use with Stream Service.Min=1025, Max=65534, Default=6901

SwitchParameter Disabled: If -Disabled is specified,the Device can not be booted. By default the Device can be booted.

SwitchParameter LocalDiskEnabled: If-LocalDiskEnabled is specified, there will be a local disk menu choice for theDevice.

uint Authentication: Device log in authentication.Choices are 0 for none, 1 for User Name/Password, and 2 for Extern. Min=0,Max=2, Default=0

string User: Name of user to authenticate before theboot process continues. Default="" ASCII Max Length=20

string Password: Password of user to authenticatebefore the boot process continues. Default="" ASCII Max Length=100

SwitchParameter CopyTemplate: If -CopyTemplate isspecified, the Template Device for the collection, if it exists, will be usedfor the property settings of the new Device.

uint AdTimestamp: The time the Active Directorymachine account password was generated. Do not set this field, it is only setinternally by PVS. Default=0

uint AdSignature: The signature of the ActiveDirectory machine account password. Do not set this field, it is only setinternally by PVS. Default=0

uint LogLevel: Level to perform logging at. Valuesare: 0 (None), 1 (Fatal), 2 (Error), 3 (Warning), 4 (Info), 5 (Debug), and 6(Trace). Min=0, Max=6, Default=0

string DomainName: Fully qualified name of thedomain that the Device belongs to. Do not set this field, it is only setinternally by PVS. Default="" Max Length=255

string DomainObjectSID: The value of the objectSIDAD attribute of the same name for the Device's computer account. Do not setthis field, it is only set internally by PVS. Default="" MaxLength=186

string DomainControllerName: The name of the DC usedto create the host's computer account. Do not set this field, it is only setinternally by PVS. Default="" Max Length=4000

DateTime DomainTimeCreated: The time that thecomputer account was created. Has the date and time including milliseconds. Donot set this field, it is only set internally by PVS. Default=Empty

uint Type: 1 when it performs test of Disks, 2 whenit performs maintenance on Disks, 0 otherwise. Min=0, Max=2, Default=0

uint LocalWriteCacheDiskSize: The size in GB toformat the Device cache file disk. If the value is 0, then the disk is notformatted. Min=0, Max=2048, Default=0

Guid VirtualHostingPoolId: GUID that uniquelyidentifies the Virtual Hosting Pool for a VM. This is needed when Adding a VM device.Default=00000000-0000-0000-0000-000000000000

SwitchParameter BdmBoot: If -BdmBoot is 0, use PXE,1 use BDM. PXE boot is used by default.

uint BdmType: Use PXE boot when set to 0, BDM (Bios)boot when set to 1 and BDM (Uefi) boot when set to 2. Default=0

uint BdmFormat: 1 use VHD for BDMboot, 2 use ISO, 3use USB. Default=0

DateTime BdmUpdated: Timestamp of the last BDM bootdisk update. Default=Empty

DateTime BdmCreated: Timstamp when BDM device wascreated Default=Empty

Guid XsPvsProxyUuid: UUID of XenServer PVS_proxyDefault=00000000-0000-0000-0000-000000000000

SwitchParameter XsPvsProxyEnabled: Enable XenServerPVS proxy when set to true Default=false

SwitchParameter Confirm: The impact of thisoperation is "low". If -Confirm is specified, the operation will beconfirmed. $ConfirmPreference can be set to "low" to haveconfirmation without the Confirm parameter.

PvsDevice: If successful, the new PvsDevice objectis returned.

EXAMPLE 1: Create PvsDevice with Minimum Fields

Creates a PvsDevice named theDevice in theCollectionof theSite.

New-PvsDevice -Name theDevice -DeviceMac"00-11-22-33-44-55" -SiteName theSite -CollectionName theCollection

CollectionId can be used instead of CollectionNameso that the SiteName or SiteId is not also needed.

EXAMPLE 2: Create PvsDevice with All Fields

Creates a PvsDevice named theDevice in theCollectionof theSite with all fields set different than defaults.

New-PvsDevice -Name theDevice -DeviceMac"00-11-22-33-44-55" -SiteName theSite -CollectionName theCollection-Description "XenServer Device" -BootFrom 2 -ClassName C -Port 6000-Disabled -LocalDiskEnabled -Authentication 1 -User U -Password P -CopyTemplate-LogLevel 3 -Type 2 -LocalWriteCacheDiskSize 100 -BdmBoot -VirtualHostingPoolId"15e0544e-4cf9-449e-b47f-8d836b16026f"

Do not set AdTimestamp, AdSignature, DomainName,DomainObjectSID, DomainControllerName and DomainTimeCreated. They are only setinternally by PVS.

CollectionId can be used instead of CollectionNameso that the SiteName or SiteId is not also needed.

EXAMPLE 3: Create PvsDevice and Boot it

Creates a PvsDevice named theDevice in theCollectionof theSite and Boots it.

New-PvsDevice -Name theDevice -DeviceMac"00-11-22-33-44-55" -SiteName theSite -CollectionName theCollection |Start-PvsBoot

CollectionId can be used instead of CollectionNameso that the SiteName or SiteId is not also needed.

New-PvsDeviceWithPersonalvDisk

Add a new Device with Personal vDisk to acollection.

All parameters that do not have a Default arerequired, unless only a few of a group are required.

string Name or DeviceName: Computer name with nospaces. ASCII computer name characters Max Length=15

Guid CollectionId: GUID of the Collection thisDevice with Personal vDisk is to be a member of. It is not used withCollectionName.

string CollectionName: Name of the Collection thisDevice with Personal vDisk is to be a member of. SiteName or SiteId must alsobe used.

Guid DiskLocatorId: GUID of the Disk Locator toupdate with this Device.

Guid SiteId: GUID of the Site the CollectionName isto be a member of. This or SiteName is used with CollectionName.

string SiteName: Name of the Site the CollectionNameis to be a member of. This or SiteId is used with CollectionName.

string Description: User description.Default="" Max Length=250

PvsPhysicalAddress DeviceMac: Ethernet address canhave the form XX-XX-XX-XX-XX-XX. Uniquely identifies the Device with PersonalvDisk.

uint Port: UDP port to use with Stream Service.Min=1025, Max=65534, Default=6901

uint AdTimestamp: The time the Active Directorymachine account password was generated. Do not set this field, it is only setinternally by PVS. Default=0

uint AdSignature: The signature of the ActiveDirectory machine account password. Do not set this field, it is only setinternally by PVS. Default=0

uint LogLevel: Level to perform logging at. Valuesare: 0 (None), 1 (Fatal), 2 (Error), 3 (Warning), 4 (Info), 5 (Debug), and 6(Trace). Min=0, Max=6, Default=0

string DomainName: Fully qualified name of thedomain that the Device with Personal vDisk belongs to. Do not set this field,it is only set internally by PVS. Default="" Max Length=255

string DomainObjectSID: The value of the objectSIDAD attribute of the same name for the Device with Personal vDisk's computeraccount. Do not set this field, it is only set internally by PVS.Default="" Max Length=186

string DomainControllerName: The name of the DC usedto create the host's computer account. Do not set this field, it is only setinternally by PVS. Default="" Max Length=4000

DateTime DomainTimeCreated: The time that thecomputer account was created. Has the date and time including milliseconds. Donot set this field, it is only set internally by PVS. Default=Empty

uint Type: 3 when it has a Personal vDisk, 4 when ithas a Personal vDisk and performs tests. Min=3, Max=4, Default=3

string PvdDriveLetter: Personal vDisk Drive letter.Range is F to Z. Default="" Max Length=1

uint LocalWriteCacheDiskSize: The size in GB toformat the Device cache file disk. If the value is 0, then the disk is notformatted. Min=0, Max=2048, Default=0

SwitchParameter BdmBoot: If -BdmBoot is specified,user BDM instead of PXE boot. PXE boot is used by default.

Guid XdSiteId: GUID of the XenDesktop Site.Default=00000000-0000-0000-0000-000000000000