Cmdlets

Add-PvsDeviceToDomain

Add a Device, all Devices in a Collection or View to a Domain.

One of these is required

or one of these is required & resolutions

Optional

One of these resolutions when needed

Instead of a parameter that matches one of the members listed
PvsObject[] Object: PvsObjects with the members below can be used as the Object parameter or from a pipeline:
      DeviceId, CollectionId, SiteViewId or FarmViewId

Optional SwitchParameter Confirm: The impact of this operation is “low”. If -Confirm is specified, the operation will be confirmed. $ConfirmPreference can be set to “low” to have confirmation without the Confirm parameter.

Examples

EXAMPLE 1: Add-PvsDeviceToDomain for Name with Domain and OrganizationUnit

Add-PvsDeviceToDomain -Name theDevice -Domain theDomain -OrganizationUnit theOrganizationUnit

EXAMPLE 2: Add-PvsDeviceToDomain for PvsDevice Using Pipe

The Get-PvsDevice output is piped to the Add-PvsDeviceToDomain.

Get-PvsDevice -Name theDevice -Fields Guid | Add-PvsDeviceToDomain -Domain theDomain -OrganizationUnit theOrganizationUnit

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

EXAMPLE 3: Add-PvsDeviceToDomain for FarmViewName with Domain and OrganizationUnit

Add-PvsDeviceToDomain -FarmViewName theFarmView -Domain theDomain -OrganizationUnit theOrganizationUnit

EXAMPLE 4: Add-PvsDeviceToDomain for PvsFarmView Using Pipe

The Get-PvsFarmView output is piped to the Add-PvsDeviceToDomain.

Get-PvsFarmView -Name theFarmView -Fields Guid | Add-PvsDeviceToDomain -Domain theDomain -OrganizationUnit theOrganizationUnit

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

EXAMPLE 5: Add-PvsDeviceToDomain for CollectionName with Domain and OrganizationUnit

Add-PvsDeviceToDomain -CollectionName theCollection -SiteName theSite -Domain theDomain -OrganizationUnit theOrganizationUnit

CollectionId can be used instead of CollectionName so that the SiteName or SiteId is not also needed.

EXAMPLE 6: Add-PvsDeviceToDomain for PvsCollection Using Pipe

The Get-PvsCollection output is piped to the Add-PvsDeviceToDomain.

Get-PvsCollection -Name theCollection -SiteName theSite -Fields Guid | Add-PvsDeviceToDomain -Domain theDomain -OrganizationUnit theOrganizationUnit

The -Fields parameter with only the needed fields specified makes the Get work faster because only those fields are retrieved. Guid can be used instead of Name so that the SiteName or SiteId is not also needed.

EXAMPLE 7: Add-PvsDeviceToDomain for SiteViewName with Domain and OrganizationUnit

Add-PvsDeviceToDomain -SiteViewName theSiteView -SiteName theSite -Domain theDomain -OrganizationUnit theOrganizationUnit

SiteViewId can be used instead of SiteViewName so that the SiteName or SiteId is not also needed.

EXAMPLE 8: Add-PvsDeviceToDomain for PvsSiteView Using Pipe

The Get-PvsSiteView output is piped to the Add-PvsDeviceToDomain.

Get-PvsSiteView -Name theSiteView -SiteName theSite -Fields Guid | Add-PvsDeviceToDomain -Domain theDomain -OrganizationUnit theOrganizationUnit

The -Fields parameter with only the needed fields specified makes the Get work faster because only those fields are retrieved. Guid can be used instead of Name so that the SiteName or SiteId is not also needed.

Add-PvsDeviceToView

Move a Device to a Collection. Personal vDisk Devices cannot be moved to a Collection in another Site.

One of these is required

One of these is required

or this is required & resolution

One of these resolutions when needed

Instead of a parameter that matches one of the members listed
PvsObject[] Object: PvsObjects with the members below can be used as the Object parameter or from a pipeline:
      DeviceId, SiteViewId or FarmViewId

Optional SwitchParameter Confirm: The impact of this operation is “low”. If -Confirm is specified, the operation will be confirmed. $ConfirmPreference can be set to “low” to have confirmation without the Confirm parameter.

Examples

EXAMPLE 1: Add-PvsDeviceToView for PvsDevice to PvsFarmView

Add-PvsDeviceToView -Name theDevice -PvsFarmViewName thePvsFarmView

EXAMPLE 2: Add-PvsDeviceToView for PvsDevice Using Pipe

The Get-PvsDevice output is piped to the Add-PvsDeviceToView.

Get-PvsDevice -Name theDevice -Fields Guid | Add-PvsDeviceToView -PvsFarmViewName thePvsFarmView

The -Fields parameter with only the needed fields specified 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 the Add-PvsDeviceToView.

Get-PvsFarmView -Name theFarmView -Fields Guid | Add-PvsDeviceToView -Name theDevice

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

EXAMPLE 4: Add-PvsDeviceToView for PvsDevice to PvsSiteView

Add-PvsDeviceToView -Name theDevice -SiteViewName theSiteView -SiteName theSite

SiteViewId can be used instead of SiteViewName so that the SiteName or SiteId is not also needed.

EXAMPLE 5: Add-PvsDeviceToView for PvsDevice Using Pipe

The Get-PvsDevice output is piped to the Add-PvsDeviceToView.

Get-PvsDevice -Name theDevice -Fields Guid | Add-PvsDeviceToView -SiteViewName theSiteView -SiteName theSite

The -Fields parameter with only the needed fields specified makes the Get work faster because only those fields are retrieved. SiteViewId can be used instead of SiteViewName so that the SiteName or SiteId is not also needed.

EXAMPLE 6: Add-PvsDeviceToView for PvsSiteView Using Pipe

The Get-PvsSiteView output is piped to the Add-PvsDeviceToView.

Get-PvsSiteView -Name theSiteView -SiteName theSite -Fields Guid | Add-PvsDeviceToView -Name theDevice

The -Fields parameter with only the needed fields specified makes the Get work faster because only those fields are retrieved. Guid can be used instead of Name so that the SiteName or SiteId is not also needed.

Add-PvsDiskLocatorToDevice

Assign a Disk Locator to a Device, a Collection or View.

This is required

or this is required & resolution

One of these is required

or one of these is required & resolutions

Optional

One of these resolutions when needed

One of these resolutions when needed

Instead of a parameter that matches one of the members listed
PvsObject[] Object: PvsObjects with the members below can be used as the Object parameter or from a pipeline:
      DiskLocatorId, DeviceId, CollectionId, SiteViewId or FarmViewId

Optional SwitchParameter Confirm: The impact of this operation is “low”. If -Confirm is specified, the operation will be confirmed. $ConfirmPreference can be set to “low” to have confirmation without the Confirm parameter.

Examples

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 the SiteName 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 the Add-PvsDiskLocatorToDevice.

Get-PvsDiskLocator -Name theDiskLocator -SiteName theSite -StoreName theStore -Fields Guid | Add-PvsDiskLocatorToDevice -DeviceName theDevice

The -Fields parameter with only the needed fields specified makes the Get work faster because only those fields are retrieved. Guid can be used instead of Name so that the SiteName 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 the Add-PvsDiskLocatorToDevice.

Get-PvsDevice -Name theDevice -Fields Guid | Add-PvsDiskLocatorToDevice -Name theDiskLocator -SiteName theSite -StoreName theStoreName

The -Fields parameter with only the needed fields specified makes the Get work faster because only those fields are retrieved. Guid can be used instead of Name so that the SiteName 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 the Add-PvsDiskLocatorToDevice.

Get-PvsDiskLocator -Name theDiskLocator -SiteName theSite -StoreName theStore -Fields Guid | Add-PvsDiskLocatorToDevice -CollectionName theCollection -SiteName theSite

The -Fields parameter with only the needed fields specified 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 the Add-PvsDiskLocatorToDevice.

Get-PvsCollection -Name theCollection -SiteName theSite -Fields Guid | Add-PvsDiskLocatorToDevice -Name theDiskLocator -SiteName theSite -StoreName theStoreName

The -Fields parameter with only the needed fields specified 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 the SiteName 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 the Add-PvsDiskLocatorToDevice.

Get-PvsDiskLocator -Name theDiskLocator -SiteName theSite -StoreName theStore -Fields Guid | Add-PvsDiskLocatorToDevice -FarmViewName theFarmView

The -Fields parameter with only the needed fields specified makes the Get work faster because only those fields are retrieved. Guid can be used instead of Name so that the SiteName 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 the Add-PvsDiskLocatorToDevice.

Get-PvsFarmView -Name theFarmView -Fields Guid | Add-PvsDiskLocatorToDevice -Name theDiskLocator -SiteName theSite -StoreName theStoreName

The -Fields parameter with only the needed fields specified makes the Get work faster because only those fields are retrieved. Guid can be used instead of Name so that the SiteName 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 the Add-PvsDiskLocatorToDevice.

Get-PvsDiskLocator -Name theDiskLocator -SiteName theSite -StoreName theStore -Fields Guid | Add-PvsDiskLocatorToDevice -SiteViewName theSiteView -SiteName theSite

The -Fields parameter with only the needed fields specified 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 the Add-PvsDiskLocatorToDevice.

Get-PvsSiteView -Name theSiteView -SiteName theSite -Fields Guid | Add-PvsDiskLocatorToDevice -Name theDiskLocator -SiteName theSite -StoreName theStoreName

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

Add-PvsDiskToUpdateTask

Add a Disk to an Update Task.

This is required

or this is required & resolution

One of these is required

One of these resolutions when needed

One of these resolutions when needed

Instead of a parameter that matches one of the members listed
PvsObject[] Object: PvsObjects with the members below can be used as the Object parameter or from a pipeline:
      DiskLocatorId or UpdateTaskId

Optional SwitchParameter Confirm: The impact of this operation is “low”. If -Confirm is specified, the operation will be confirmed. $ConfirmPreference can be set to “low” to have confirmation without the Confirm parameter.

Examples

EXAMPLE 1: Add-PvsDiskToUpdateTask for PvsDiskLocator to PvsUpdateTask

Add-PvsDiskToUpdateTask -Name theDiskLocator -UpdateTaskName theUpdateTask -SiteName theSite -StoreName theStore

UpdateTaskId can be used instead of UpdateTaskName so that the SiteName or SiteId is not also needed.

EXAMPLE 2: Add-PvsDiskToUpdateTask for PvsDiskLocator Using Pipe

The Get-PvsDiskLocator output is piped to the Add-PvsDiskToUpdateTask.

Get-PvsDiskLocator -Name theDiskLocator -SiteName theSite -StoreName theStore -Fields Guid | Add-PvsDiskToUpdateTask -UpdateTaskName theUpdateTask -SiteName theSite

The -Fields parameter with only the needed fields specified 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 the Add-PvsDiskToUpdateTask.

Get-PvsUpdateTask -Name theUpdateTask -SiteName theSite -Fields Guid | Add-PvsDiskToUpdateTask -Name theDiskLocator -SiteName theSite -StoreName theStore

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

Add-PvsDiskVersion

Add one or more new Versions to a Disk. A manifest file for the new Disk Version(s) must exist in the Store.

This is required

or this is required & resolution

One of these resolutions when needed

One of these resolutions when needed

Instead of a parameter that matches one of the members listed
PvsObject[] Object: PvsObjects with the members below can be used as the Object parameter or from a pipeline:
      DiskLocatorId

Optional SwitchParameter Confirm: The impact of this operation is “low”. If -Confirm is specified, the operation will be confirmed. $ConfirmPreference can be set to “low” to have confirmation without the Confirm parameter.

Examples

EXAMPLE 1: Add-PvsDiskVersion for Name

Add-PvsDiskVersion -Name theDiskLocator -SiteName theSite -StoreName theStore

Guid can be used instead of Name so that the SiteName 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 the Add-PvsDiskVersion.

Get-PvsDiskLocator -Name theDiskLocator -SiteName theSite -StoreName theStore -Fields Guid | Add-PvsDiskVersion

The -Fields parameter with only the needed fields specified makes the Get work faster because only those fields are retrieved. Guid can be used instead of Name so that the SiteName 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

Optional SwitchParameter Confirm: The impact of this operation is “low”. If -Confirm is specified, the operation will be confirmed. $ConfirmPreference can be set to “low” to have confirmation without the Confirm parameter.

Examples

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 Tasks in a Site or the whole Farm.

These are optional

Instead of a parameter that matches one of the members listed
PvsObject[] Object: PvsObjects with the members below can be used as the Object parameter or from a pipeline:
      TaskId or SiteId

Optional SwitchParameter Confirm: The impact of this operation is “medium”. If -Confirm is specified, the operation will be confirmed. $ConfirmPreference can be set to “medium” or “low” to have confirmation without the Confirm parameter.

Examples

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 the Clear-PvsTask.

Get-PvsTask -TaskId 101 -Fields -TaskId | Clear-PvsTask

The -Fields parameter with only the needed fields specified 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 the Clear-PvsTask.

Get-PvsTask -SiteName theSite -Fields -SiteId | Clear-PvsTask

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

Copy-PvsDeviceProperties

Copy properties of one Device to a Device, all the Devices in a Collection, Site View or Farm View.

One of these is required

One of these is required

or one of these is required & resolutions

Optional

One of these resolutions when needed

Instead of a parameter that matches one of the members listed
PvsObject[] Object: PvsObjects with the members below can be used as the Object parameter or from a pipeline:
      DeviceId, CollectionId, SiteViewId or FarmViewId

Optional SwitchParameter Confirm: The impact of this operation is “low”. If -Confirm is specified, the operation will be confirmed. $ConfirmPreference can be set to “low” to have confirmation without the Confirm parameter.

Examples

EXAMPLE 1: Copy-PvsDeviceProperties for Name

Copy-PvsDeviceProperties -DeviceNameFrom theDeviceFrom -Name theDeviceTo

EXAMPLE 2: Copy-PvsDeviceProperties for Name with Properties

Copy-PvsDeviceProperties -DeviceNameFrom theDeviceFrom -Name theDeviceTo -Properties 2, 3

EXAMPLE 3: Copy-PvsDeviceProperties for PvsDevice Using Pipe

The Get-PvsDevice output is piped to the Copy-PvsDeviceProperties.

Get-PvsDevice -Name theDeviceTo -Fields Guid | Copy-PvsDeviceProperties -DeviceNameFrom theDeviceFrom -Properties 2, 3

The -Fields parameter with only the needed fields specified 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 the Copy-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 fields specified makes the Get work faster because only those fields are retrieved.

EXAMPLE 7: Copy-PvsDeviceProperties for FarmViewName

Copy-PvsDeviceProperties -DeviceNameFrom theDeviceFrom -FarmViewName theFarmViewNameTo

EXAMPLE 8: Copy-PvsDeviceProperties for FarmViewName with Properties

Copy-PvsDeviceProperties -DeviceNameFrom theDeviceFrom -FarmViewName theFarmViewNameTo -Properties 2, 3

EXAMPLE 9: Copy-PvsDeviceProperties for PvsFarmView Using Pipe

The Get-PvsFarmView output is piped to the Copy-PvsDeviceProperties.

Get-PvsFarmView -Name theFarmViewTo -Fields Guid | Copy-PvsDeviceProperties -DeviceNameFrom theDeviceFrom -Properties 2, 3

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

EXAMPLE 10: Copy-PvsDeviceProperties for CollectionName

Copy-PvsDeviceProperties -DeviceNameFrom theDeviceFrom -CollectionName theCollectionNameTo -SiteName theSite

CollectionId can be used instead of CollectionName so that the SiteName or SiteId is not also needed.

EXAMPLE 11: Copy-PvsDeviceProperties for CollectionName with Properties

Copy-PvsDeviceProperties -DeviceNameFrom theDeviceFrom -CollectionName theCollectionNameTo -SiteName theSite -Properties 2, 3

CollectionId can be used instead of CollectionName so that the SiteName or SiteId is not also needed.

EXAMPLE 12: Copy-PvsDeviceProperties for PvsCollection Using Pipe

The Get-PvsCollection output is piped to the Copy-PvsDeviceProperties.

Get-PvsCollection -Name theCollection -SiteName theSite -Fields Guid | Copy-PvsDeviceProperties -DeviceNameFrom theDeviceFrom -Properties 2, 3

The -Fields parameter with only the needed fields specified makes the Get work faster because only those fields are retrieved. Guid can be used instead of Name so that the SiteName or SiteId is not also needed.

EXAMPLE 13: Copy-PvsDeviceProperties for SiteViewName

Copy-PvsDeviceProperties -DeviceNameFrom theDeviceFrom -SiteViewName theSiteViewNameTo -SiteName theSite

SiteViewId can be used instead of SiteViewName so that the SiteName or SiteId is not also needed.

EXAMPLE 14: Copy-PvsDeviceProperties for SiteViewName with Properties

Copy-PvsDeviceProperties -DeviceNameFrom theDeviceFrom -SiteViewName theSiteViewNameTo -SiteName theSite -Properties 2, 3

SiteViewId can be used instead of SiteViewName so that the SiteName or SiteId is not also needed.

EXAMPLE 15: Copy-PvsDeviceProperties for PvsSiteView Using Pipe

The Get-PvsSiteView output is piped to the Copy-PvsDeviceProperties.

Get-PvsSiteView -Name theSiteView -SiteName theSite -Fields Guid | Copy-PvsDeviceProperties -DeviceNameFrom theDeviceFrom -Properties 2, 3

The -Fields parameter with only the needed fields specified makes the Get work faster because only those fields are retrieved. Guid can be used instead of Name so that the SiteName or SiteId is not also needed.

Copy-PvsDiskProperties

Copy properties of one Disk to a Disk.

This is required

This is required

Optional

Instead of a parameter that matches one of the members listed
PvsObject[] Object: PvsObjects with the members below can be used as the Object parameter or from a pipeline:
      DiskLocatorId

Optional SwitchParameter Confirm: The impact of this operation is “low”. If -Confirm is specified, the operation will be confirmed. $ConfirmPreference can be set to “low” to have confirmation without the Confirm parameter.

Examples

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 the Copy-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 fields specified makes the Get work faster because only those fields are retrieved.

Copy-PvsServerProperties

Copy properties of one Server to a Server.

One of these is required

One of these is required

Optional

Instead of a parameter that matches one of the members listed
PvsObject[] Object: PvsObjects with the members below can be used as the Object parameter or from a pipeline:
      ServerId

Optional SwitchParameter Confirm: The impact of this operation is “low”. If -Confirm is specified, the operation will be confirmed. $ConfirmPreference can be set to “low” to have confirmation without the Confirm parameter.

Examples

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 the Copy-PvsDiskProperties.

Get-PvsServer -Name theServerTo -Fields Guid | Copy-PvsDiskProperties -ServerNameFrom theServerFrom -Properties 2, 3

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

Disable-PvsDeviceDiskLocator

Disable a Device’s DiskLocator.

One of these is required

This is required

or this is required & resolution

One of these resolutions when needed

Instead of a parameter that matches one of the members listed
PvsObject[] Object: PvsObjects with the members below can be used as the Object parameter or from a pipeline:
      DeviceId or DiskLocatorId

Optional SwitchParameter Confirm: The impact of this operation is “medium”. If -Confirm is specified, the operation will be confirmed. $ConfirmPreference can be set to “medium” or “low” to have confirmation without the Confirm parameter.

Examples

EXAMPLE 1: Disable a PvsDevice PvsDiskLocator

This example disables the PvsDiskLocator named theDiskLocator for the PvsDevice named theDevice.

Disable-PvsDeviceDiskLocator -Name theDevice -DiskLocatorName theDiskLocator -StoreName theStore

DiskLocatorId can be used instead of DiskLocatorName so that the StoreName or StoreId are not also needed.

Dismount-PvsDisk

No longer Map the Disk.

Examples

EXAMPLE 1: Dismount-PvsDisk

Dismount-PvsDisk

Enable-PvsDeviceDiskLocator

Enable a Device’s DiskLocator. If the DiskLocator is Disabled, that overrides the Device DiskLocator setting.

One of these is required

This is required

or this is required & resolution

One of these resolutions when needed

Instead of a parameter that matches one of the members listed
PvsObject[] Object: PvsObjects with the members below can be used as the Object parameter or from a pipeline:
      DeviceId or DiskLocatorId

Optional SwitchParameter Confirm: The impact of this operation is “low”. If -Confirm is specified, the operation will be confirmed. $ConfirmPreference can be set to “low” to have confirmation without the Confirm parameter.

Examples

EXAMPLE 1: Enable a PvsDevice PvsDiskLocator

This example enables the PvsDiskLocator named theDiskLocator for the PvsDevice named theDevice.

Enable-PvsDeviceDiskLocator -Name theDevice -DiskLocatorName theDiskLocator -StoreName theStore

DiskLocatorId can be used instead of DiskLocatorName so that the StoreName or StoreId are not also needed.

Export-PvsAuditTrail

Archive the information in the Audit Trail up to a certain date to a file. When finished, the information archived will be removed from the Audit Trail.

This is required

Optional

Optional SwitchParameter Confirm: The impact of this operation is “low”. If -Confirm is specified, the operation will be confirmed. $ConfirmPreference can be set to “low” to have confirmation without the Confirm parameter.

Examples

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 is required

or this is required & resolution

Optional

One of these resolutions when needed

One of these resolutions when needed

Instead of a parameter that matches one of the members listed
PvsObject[] Object: PvsObjects with the members below can be used as the Object parameter or from a pipeline:
      DiskLocatorId

Examples

EXAMPLE 1: Export-PvsDisk for Name

Export-PvsDisk -Name theDiskLocator -SiteName theSite -StoreName theStore

Guid can be used instead of Name so that the SiteName 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 the Export-PvsDisk.

Get-PvsDiskLocator -Name theDiskLocator -SiteName theSite -StoreName theStore -Fields Guid | Export-PvsDisk

The -Fields parameter with only the needed fields specified makes the Get work faster because only those fields are retrieved. Guid can be used instead of Name so that the SiteName or SiteId and StoreName or StoreId are not also needed.

EXAMPLE 3: Export-PvsDisk for Name with Version

Export-PvsDisk -Name theDiskLocator -SiteName theSite -StoreName theStore -Version 4

Guid can be used instead of Name so that the SiteName 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 the Export-PvsDisk.

Get-PvsDiskLocator -Name theDiskLocator -SiteName theSite -StoreName theStore -Fields Guid | Export-PvsDisk -Version 4

The -Fields parameter with only the needed fields specified makes the Get work faster because only those fields are retrieved. Guid can be used instead of Name so that the SiteName or SiteId and StoreName or StoreId are not also needed.

Export-PvsOemLicenses

Oem Only: Export the Oem Licenses for the Devices to the fileName specified.

This is required

One of these is required

or one of these is required & resolutions

One of these resolutions when needed

Instead of a parameter that matches one of the members listed
PvsObject[] Object: PvsObjects with the members below can be used as the Object parameter or from a pipeline:
      DeviceId, CollectionId, SiteViewId or FarmViewId

Examples

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 the Export-PvsOemLicenses.

Get-PvsDevice -Name theDevice -Fields Guid | Export-PvsOemLicenses -FileName \"C:\export\theFileName\"

The -Fields parameter with only the needed fields specified 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 the Export-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 specified makes 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 the Export-PvsOemLicenses.

Get-PvsFarmView -Name theFarmView -Fields Guid | Export-PvsOemLicenses -FileName \"C:\export\theFileName\"

The -Fields parameter with only the needed fields specified 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 CollectionName so that the SiteName or SiteId is not also needed.

EXAMPLE 8: Export-PvsOemLicenses for PvsCollection Using Pipe

The Get-PvsCollection output is piped to the Export-PvsOemLicenses.

Get-PvsCollection -Name theCollection -SiteName theSite -Fields Guid | Export-PvsOemLicenses -FileName \"C:\export\theFileName\"

The -Fields parameter with only the needed fields specified makes the Get work faster because only those fields are retrieved. Guid can be used instead of Name so that the SiteName 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 so that the SiteName or SiteId is not also needed.

EXAMPLE 10: Export-PvsOemLicenses for PvsSiteView Using Pipe

The Get-PvsSiteView output is piped to the Export-PvsOemLicenses.

Get-PvsSiteView -Name theSiteView -SiteName theSite -Fields Guid | Export-PvsOemLicenses -FileName \"C:\export\theFileName\"

The -Fields parameter with only the needed fields specified makes the Get work faster because only those fields are retrieved. Guid can be used instead of Name so that the SiteName or SiteId is not also needed.

Get-PvsADAccount

Return a PvsAdAccount object if the named Device Account in the domain is found.

This is required

This is required

PvsADAccount: If successful, the PvsADAccount object is returned.

Examples

EXAMPLE 1: Get PvsADAccount

Get the PvsADAccount in the Domain named theDomain for the Device named theDevice.

Get-PvsADAccount -Domain theDomain -Name theDevice

Get-PvsAuditActionParameter

Get the Parameters of an Audit Action.

This is required

Instead of a parameter that matches one of the members listed
PvsObject[] Object: PvsObjects with the members below can be used as the Object parameter or from a pipeline:
      AuditActionId

If only selected fields are needed, pass them in the Fields parameter as a string array.

PvsAuditActionParameter[]: If successful, the PvsAuditActionParameter object(s) are returned.

Examples

EXAMPLE 1: Get PvsAuditActionParameter

Get all PvsAuditActionParameter for the AuditActionId e8baa554-7c2d-49e5-9f6b-e0bc46179fc7.

Get-PvsAuditActionParameter -AuditActionId "e8baa554-7c2d-49e5-9f6b-e0bc46179fc7"

EXAMPLE 2: Get PvsAuditActionParameter for Multiple AuditActionId

Get all PvsAuditActionParameter for the AuditActionId e8baa554-7c2d-49e5-9f6b-e0bc46179fc7 and 54ee6180-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 with Parameters

Get-PvsAuditTrail is called and only the PvsAuditTrail.Attachment with bit 4 (Parameters) set are used to call Get-PvsAuditActionParameter.

Get-PvsAuditTrail | Where-Object {\(\$\_.Attachments -band 4) -eq 4} | Get-PvsAuditActionParameter

Get-PvsAuditActionProperty

Get the Properties of an Audit Action.

This is required

Instead of a parameter that matches one of the members listed
PvsObject[] Object: PvsObjects with the members below can be used as the Object parameter or from a pipeline:
      AuditActionId

If only selected fields are needed, pass them in the Fields parameter as a string array.

PvsAuditActionProperty[]: If successful, the PvsAuditActionProperty object(s) are returned.

Examples

EXAMPLE 1: Get PvsAuditActionProperty

Get all PvsAuditActionProperty for the AuditActionId e8baa554-7c2d-49e5-9f6b-e0bc46179fc7.

Get-PvsAuditActionProperty -AuditActionId "e8baa554-7c2d-49e5-9f6b-e0bc46179fc7"

EXAMPLE 2: Get PvsAuditActionProperty for Multiple AuditActionId

Get all PvsAuditActionProperty for the AuditActionId e8baa554-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 with Properties

Get-PvsAuditTrail is called and only the PvsAuditTrail.Attachment with bit 8 (Properties) set are used to call Get-PvsAuditActionProperty.

Get-PvsAuditTrail | Where-Object {\(\$\_.Attachments -band 8) -eq 8} | Get-PvsAuditActionProperty

Get-PvsAuditActionSibling

Get the Sibling of an Audit Action. It is the 2nd object involved with the action.

This is required

Instead of a parameter that matches one of the members listed
PvsObject[] Object: PvsObjects with the members below can be used as the Object parameter or from a pipeline:
      AuditActionId

If only selected fields are needed, pass them in the Fields parameter as a string array.

PvsAuditAction[]: If successful, the PvsAuditAction object(s) are returned.

Examples

EXAMPLE 1: Get PvsAuditActionSibling

Get all PvsAuditActionSibling for the AuditActionId e8baa554-7c2d-49e5-9f6b-e0bc46179fc7.

Get-PvsAuditActionSibling -Guid "e8baa554-7c2d-49e5-9f6b-e0bc46179fc7"

EXAMPLE 2: Get PvsAuditActionSibling for Multiple AuditActionId

Get all PvsAuditActionSibling for the AuditActionId e8baa554-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 with Siblings

Get-PvsAuditTrail is called and only the PvsAuditTrail.Attachment with bit 2 (Siblings) set are used to call Get-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 or Store. All Audit Trail actions are returned if no parameters are passed. The result can be filtered by parent, user\domain and date range.

These are optional

These are optional & resolutions

Optional

One of these resolutions when needed

One of these resolutions when needed

Instead of a parameter that matches one of the members listed
PvsObject[] Object: PvsObjects with the members below can be used as the Object parameter or from a pipeline:
      AuditActionId, ParentId, RootId, SiteId, CollectionId, SiteViewId, FarmViewId, ServerId, DeviceId, StoreId or DiskLocatorId

If only selected fields are needed, pass them in the Fields parameter as a string array.

PvsAuditTrail[]: If successful, the PvsAuditTrail object(s) are returned.

Examples

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 named theFarmView.

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 theSiteView in the Site named theSite.

Get-PvsAuditTrail -SiteViewName theSiteView -SiteName theSite

SiteViewId can be used instead of SiteViewName so that the SiteName or SiteId is not also needed.

EXAMPLE 5: Get PvsAuditTrail for Collection

Get all PvsAuditTrail for the Collection named theCollection in the Site named theSite.

Get-PvsAuditTrail -CollectionName theCollection -SiteName theSite

CollectionId can be used instead of CollectionName so that the SiteName or SiteId is not also needed.

EXAMPLE 6: Get PvsAuditTrail for Device

Get all PvsAuditTrail for the Device named theDevice.

Get-PvsAuditTrail -DeviceName theDevice

EXAMPLE 7: Get PvsAuditTrail for Device MAC

Get all PvsAuditTrail for the Device with MAC 02-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 named theServer.

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 named theDiskLocator in the Site named theSite and Store named theStore.

Get-PvsAuditTrail -DiskLocatorName theDiskLocator -SiteName theSite -StoreName theStore

DiskLocatorId can be used instead of DiskLocatorName so 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 in Domain theDomain.

Get-PvsAuditTrail -UserName theUser -DomainName theDomain

EXAMPLE 12: Get PvsAuditTrail for January

Get all PvsAuditTrail for January.

Get-PvsAuditTrail -BeginDate "01/01/2015 00: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) and 1007 (DeleteServer) actions.

Get-PvsAuditTrail -Action 1003 1007

EXAMPLE 15: Get PvsAuditTrail with Children

Get the 4fd16fc1-8dcc-4097-be5a-d0485bd7433b PvsAuditTrail 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 in the system, AuthGroups with Farm, Site or Collection Authorization. All AuthGroups in the system are returned if no parameters are passed.

These are optional

or this is optional & resolution

Optional

One of these resolutions when needed

Instead of a parameter that matches one of the members listed
PvsObject[] Object: PvsObjects with the members below can be used as the Object parameter or from a pipeline:
      AuthGroupId, SiteId or CollectionId

If only selected fields are needed, pass them in the Fields parameter as a string array.

PvsAuthGroup[]: If successful, the PvsAuthGroup object(s) are returned.

Examples

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 named theCollection in the Site named theSite.

Get-PvsAuthGroup -CollectionName theCollection -SiteName theSite

CollectionId can be used instead of CollectionName so that the SiteName or SiteId is not also needed.

Get-PvsAuthGroupUsage

Get the items that are authorized for an AuthGroup.

One of these is required

Instead of a parameter that matches one of the members listed
PvsObject[] Object: PvsObjects with the members below can be used as the Object parameter or from a pipeline:
      AuthGroupId

If only selected fields are needed, pass them in the Fields parameter as a string array.

PvsAuthGroupUsage[]: If successful, the PvsAuthGroupUsage object(s) are returned.

Examples

EXAMPLE 1: Get PvsAuthGroupUsage

Get all PvsAuthGroupUsage for the AuthGroup named theAuthGroup.

Get-PvsAuthGroupUsage -Name theAuthGroup

Get-PvsCeipData

Get the CEIP configuration

Optional

Instead of a parameter that matches one of the members listed
PvsObject[] Object: PvsObjects with the members below can be used as the Object parameter or from a pipeline:
      Uuid

If only selected fields are needed, pass them in the Fields parameter as a string array.

PvsCeipData[]: If successful, the PvsCeipData object(s) are returned.

Examples

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 the Fields parameter as a string array.

PvsCisData[]: If successful, the PvsCisData object(s) are returned.

Examples

EXAMPLE 1: Get PvsCisData for CisData

Get all PvsCisData for CispData.

Get-PvsCisData

Get-PvsCollection

Get the fields for a Collection or all Collections in a Site or Farm. All Collections are returned if no parameters are passed.

These are optional

or this is optional & resolution

This is optional

One of these resolutions when needed

Instead of a parameter that matches one of the members listed
PvsObject[] Object: PvsObjects with the members below can be used as the Object parameter or from a pipeline:
      CollectionId or SiteId

If only selected fields are needed, pass them in the Fields parameter as a string array.

PvsCollection[]: If successful, the PvsCollection object(s) are returned.

Examples

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 named theCollection in the Site named theSite.

Get-PvsCollection -Name theCollection -SiteName theSite

Guid can be used instead of Name so that the SiteName or SiteId is not also needed.

EXAMPLE 4: Get PvsCollection and Enable

Get all PvsCollection that are not Enabled and then Enables 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 fields specified 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 to the Set command for update.

Get-PvsConnection

Return the PvsConnection object with the information about the SoapServer connection.

PvsConnection: If successful, the PvsConnection object is returned.

Examples

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 is required

One of these is required

Instead of a parameter that matches one of the members listed
PvsObject[] Object: PvsObjects with the members below can be used as the Object parameter or from a pipeline:
      StoreId

UInt32 or PvsDiskLocator: If not finished, the percent complete is returned in an UInt32. If finished and successful, the PvsDiskLocator is returned.

Examples

EXAMPLE 1: Start-PvsCreateDiskStatus

This example shows how to use Get-PvsCreateDiskStatus during Start-PvsCreateDisk processing.

$thePvsDiskLocator = Start-PvsCreateDiskStatus -Name theDiskName -Size 20480 -StoreName theStore -SiteName theSite -VHDX -Dynamic
while ($thePvsDiskLocator -eq $null)                           # while the create is processing
{
    %percentFinished = Get-PvsCreateDiskStatus -Name theDiskName -StoreName theStore  # get percent finished or DiskLocator when done
    if (%percentFinished.GetType().Name == "PvsDiskLocator")
    {
        $thePvsDiskLocator = %percentFinished
    }
    else
    {
        %percentFinished.ToString() + "% finished"                 # display percent finished
        Start-Sleep -seconds 10                                    # wait 10 seconds more
    }
}
"Successful"

Get-PvsDevice

Get the fields for a Device, all Devices in a Collection, Site, Farm View, or Farm. All Devices are returned if no parameters are passed.

These are optional

These are optional & resolutions

One of these resolutions when needed

One of these resolutions when needed

Instead of a parameter that matches one of the members listed
PvsObject[] Object: PvsObjects with the members below can be used as the Object parameter or from a pipeline:
      DeviceName, CollectionId, ServerId, DiskLocatorId, SiteViewId, SiteId or FarmViewId

If only selected fields are needed, pass them in the Fields parameter as a string array.

PvsDevice[]: If successful, the PvsDevice object(s) are returned.

Examples

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 named theFarmView.

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 theSiteView in the Site named theSite.

Get-PvsDevice -SiteViewName theSiteView -SiteName theSite

SiteViewId can be used instead of SiteViewName so that the SiteName or SiteId is not also needed.

EXAMPLE 5: Get PvsDevice for Collection

Get all PvsDevice for the Collection named theCollection in the Site named theSite.

Get-PvsDevice -CollectionName theCollection -SiteName theSite

CollectionId can be used instead of CollectionName so that the SiteName or SiteId is not also needed.

EXAMPLE 6: Get PvsDevice for DiskLocator

Get all PvsDevice for the DiskLocator named theDiskLocator in the Site named theSite and Store named theStore.

Get-PvsDevice -DiskLocatorName theDiskLocator -SiteName theSite -StoreName theStore

DiskLocatorId can be used instead of DiskLocatorName so 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 then Enables 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 fields specified 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 to the Set command for update.

Get-PvsDeviceBootstrap

Get all Bootstrap files for a Device, and the MenuText for each.

One of these is required

Instead of a parameter that matches one of the members listed
PvsObject[] Object: PvsObjects with the members below can be used as the Object parameter or from a pipeline:
      DeviceId

If only selected fields are needed, pass them in the Fields parameter as a string array. These fields exist in the DeviceBootstrap array within each PvsDeviceBootstrap returned. Each array item is a PvsDeviceBootstrapList object.

PvsDeviceBootstrap[]: If successful, the PvsDeviceBootstrap object(s) are returned.

Examples

EXAMPLE 1: Get PvsDeviceBootstrap for Device

Get all PvsDeviceBootstrap for the Device named theDevice.

Get-PvsDeviceBootstrap -Name theDevice

EXAMPLE 2: Get PvsDeviceBootstrap for Device MAC

Get all PvsDeviceBootstrap for the Device with MAC 02-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 is required

or one of these is required & resolutions

One of these resolutions when needed

Instead of a parameter that matches one of the members listed
PvsObject[] Object: PvsObjects with the members below can be used as the Object parameter or from a pipeline:
      CollectionId, SiteViewId or FarmViewId

UInt32: If successful, the numeric value is returned

Examples

EXAMPLE 1: Get-PvsDeviceCount Returns the Number (or Count) of PvsDevice in PvsCollection

Get-PvsDeviceCount -CollectionName theCollection -SiteName theSite

CollectionId can be used instead of CollectionName so that the SiteName or SiteId is not also needed.

EXAMPLE 2: Get-PvsDeviceCount Returns the Number (or Count) of PvsDevice in PvsFarmView

Get-PvsDeviceCount -FarmViewName theFarmView

EXAMPLE 3: Get-PvsDeviceCount Returns the Number (or Count) of PvsDevice in PvsSiteView

Get-PvsDeviceCount -SiteViewName theSiteView -SiteName theSite

SiteViewId can be used instead of SiteViewName so that the SiteName or SiteId is not also needed.

Get-PvsDeviceDiskLocatorEnabled

Return true if a Device/DiskLocator is enabled.

One of these is required

This is required

or this is required & resolution

One of these resolutions when needed

Instead of a parameter that matches one of the members listed
PvsObject[] Object: PvsObjects with the members below can be used as the Object parameter or from a pipeline:
      DeviceId or DiskLocatorId

String: If successful, the String value is returned.

Examples

EXAMPLE 1: Get-PvsDeviceDiskLocatorEnabled Determine if PvsDevice/PvsDiskLocator is Enabled

Get-PvsDeviceDiskLocatorEnabled -Name theDevice -DiskLocatorName theDiskLocator -StoreName theStore

DiskLocatorId can be used instead of DiskLocatorName so 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.

These are optional

or this is optional & resolution

This is optional & resolution

One of these resolutions when needed

One of these resolutions when needed

Instead of a parameter that matches one of the members listed
PvsObject[] Object: PvsObjects with the members below can be used as the Object parameter or from a pipeline:
      DeviceId, SiteId or DiskLocatorId

If only selected fields are needed, pass them in the Fields parameter as a string array.

PvsDeviceDiskTempVersion[]: If successful, the PvsDeviceDiskTempVersion object(s) are returned.

Examples

EXAMPLE 1: Get PvsDeviceDiskTempVersion for Device

Get the PvsDeviceDiskTempVersion for the Device named theDevice.

Get-PvsDeviceDiskTempVersion -Name theDevice

EXAMPLE 2: Get PvsDeviceDiskTempVersion for DiskLocator

Get all PvsDeviceDiskTempVersion for the DiskLocator named theDiskLocator in the Site named theSite and Store named theStore.

Get-PvsDeviceDiskTempVersion -DiskLocatorName theDiskLocator -SiteName theSite -StoreName theStore

DiskLocatorId can be used instead of DiskLocatorName so that the SiteName or SiteId and StoreName or StoreId are not also needed.

EXAMPLE 3: Get PvsDeviceDiskTempVersion for DiskLocator with Version

Get-PvsDeviceDiskTempVersion -DiskLocatorName theDiskLocator -Version 4 -SiteName theSite -StoreName theStore

DiskLocatorId can be used instead of DiskLocatorName so that the StoreName or StoreId are not also needed.

EXAMPLE 4: Get PvsDeviceDiskTempVersion for Site

Get all PvsDeviceDiskTempVersion for the Site named theSite.

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 Devices in a Collection, Site, Farm View, or Farm. All Devices are returned if no parameters are passed.

These are optional

These are optional & resolutions

Optional

One of these resolutions when needed

One of these resolutions when needed

Instead of a parameter that matches one of the members listed
PvsObject[] Object: PvsObjects with the members below can be used as the Object parameter or from a pipeline:
      DeviceName, CollectionId, ServerId, DiskLocatorId, SiteViewId, SiteId or FarmViewId

If only selected fields are needed, pass them in the Fields parameter as a string array.

PvsDeviceInfo[]: If successful, the PvsDeviceInfo object(s) are returned.

Examples

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 named theFarmView.

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 named theSiteView in the Site named theSite.

Get-PvsDeviceInfo -SiteViewName theSiteView -SiteName theSite

SiteViewId can be used instead of SiteViewName so that the SiteName or SiteId is not also needed.

EXAMPLE 5: Get PvsDeviceInfo for Collection

Get all PvsDeviceInfo for the Collection named theCollection in the Site named theSite.

Get-PvsDeviceInfo -CollectionName theCollection -SiteName theSite

CollectionId can be used instead of CollectionName so that the SiteName or SiteId is not also needed.

EXAMPLE 6: Get PvsDeviceInfo for DiskLocator

Get all PvsDeviceInfo for the DiskLocator named theDiskLocator in the Site named theSite and Store named theStore.

Get-PvsDeviceInfo -DiskLocatorName theDiskLocator -SiteName theSite -StoreName theStore

DiskLocatorId can be used instead of DiskLocatorName so 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 named theDevice.

Get-PvsDeviceInfo -Name theDevice

EXAMPLE 8: Get PvsDeviceInfo and Enable

Get all PvsDeviceInfo that are not Enabled and then Enables 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 fields specified 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 to the Set command for update.

Get-PvsDevicePersonality

Get the Device Personality names and values.

One of these is required

Instead of a parameter that matches one of the members listed
PvsObject[] Object: PvsObjects with the members below can be used as the Object parameter or from a pipeline:
      DeviceId

If only selected fields are needed, pass them in the Fields parameter as a string array. These fields exist in the DevicePersonality array within each PvsDevicePersonality returned. Each array item is a PvsDevicePersonalityList object.

PvsDevicePersonality[]: If successful, the PvsDevicePersonality object(s) are returned.

Examples

EXAMPLE 1: Get PvsDevicePersonality for Device

Get all PvsDevicePersonality for the Device named theDevice.

Get-PvsDevicePersonality -Name theDevice

EXAMPLE 2: Get PvsDevicePersonality for Device MAC

Get all PvsDevicePersonality for the Device with MAC 02-50-F2-00-00-01.

Get-PvsDevicePersonality -DeviceMac "02-50-F2-00-00-01"

Get-PvsDeviceStatus

Get the DeviceStatus fields for a Device or all Devices for a Server, Disk Locator, or Farm. All Devices are returned if no parameters are passed.

These are optional

These are optional & resolutions

One of these resolutions when needed

One of these resolutions when needed

Instead of a parameter that matches one of the members listed
PvsObject[] Object: PvsObjects with the members below can be used as the Object parameter or from a pipeline:
      DeviceId, ServerId, DiskLocatorId or CollectionId

If only selected fields are needed, pass them in the Fields parameter as a string array.

PvsDeviceStatus[]: If successful, the PvsDeviceStatus object(s) are returned.

Examples

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 named theFarmView.

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 named theSiteView in the Site named theSite.

Get-PvsDeviceStatus -SiteViewName theSiteView -SiteName theSite

SiteViewId can be used instead of SiteViewName so that the SiteName or SiteId is not also needed.

EXAMPLE 5: Get PvsDeviceStatus for Collection

Get all PvsDeviceStatus for the Collection named theCollection in the Site named theSite.

Get-PvsDeviceStatus -CollectionName theCollection -SiteName theSite

CollectionId can be used instead of CollectionName so that the SiteName or SiteId is not also needed.

EXAMPLE 6: Get PvsDeviceStatus for DiskLocator

Get all PvsDeviceStatus for the DiskLocator named theDiskLocator in the Site named theSite and Store named theStore.

Get-PvsDeviceStatus -DiskLocatorName theDiskLocator -SiteName theSite -StoreName theStore

DiskLocatorId can be used instead of DiskLocatorName so 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 named theDevice.

Get-PvsDeviceStatus -Name theDevice

Get-PvsDirectory

Look for Directories or Drives on the Server specified. Return a String array of the Directories or Drives found.

One of these is required

Optional

Instead of a parameter that matches one of the members listed
PvsObject[] Object: PvsObjects with the members below can be used as the Object parameter or from a pipeline:
      ServerId

string[]: If successful, the array of directory names is returned.

Examples

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 the Get-PvsDirectory.

Get-PvsServer -Name theServer -Fields Guid | Get-PvsDirectory -Path \"C:\directory\"

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

Get-PvsDisk

Get the fields for a single disk.

This is required

or this is required & resolution

One of these resolutions when needed

One of these resolutions when needed

Instead of a parameter that matches one of the members listed
PvsObject[] Object: PvsObjects with the members below can be used as the Object parameter or from a pipeline:
      DiskLocatorId

If only selected fields are needed, pass them in the Fields parameter as a string array.

PvsDisk[]: If successful, the PvsDisk object(s) are returned.

Examples

EXAMPLE 1: Get PvsDisk for DiskLocator

Get the PvsDisk for the DiskLocator named theDiskLocator 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 the SiteName or SiteId and StoreName or StoreId are not also needed.

Get-PvsDiskInfo

Get the fields for a Disk and Disk Locator or all Disks and Disk Locators for a Device, Server, Store, Site, or Farm. All Disks and DiskLocators are returned if no parameters are passed.

These are optional

These are optional & resolutions

These are optional

Optional

One of these resolutions when needed

One of these resolutions when needed

Instead of a parameter that matches one of the members listed
PvsObject[] Object: PvsObjects with the members below can be used as the Object parameter or from a pipeline:
      DiskLocatorId, DeviceId, ServerId, UpdateTaskId or SiteId

If only selected fields are needed, pass them in the Fields parameter as a string array.

PvsDiskInfo[]: If successful, the PvsDiskInfo object(s) are returned.

Examples

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 and Store named theStore.

Get-PvsDiskInfo -SiteName theSite -StoreName theStore

EXAMPLE 4: Get PvsDiskInfo for DiskLocator

Get the PvsDiskInfo for the DiskLocator named theDiskLocator in the Site named theSite and Store named theStore.

Get-PvsDiskInfo -Name theDiskLocator -SiteName theSite -StoreName theStore

Guid can be used instead of Name so that the SiteName or SiteId and StoreName or StoreId are not also needed.

EXAMPLE 5: Get PvsDiskInfo and Enable

Get all PvsDiskInfo that are not Enabled and then Enables 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 fields specified 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 to the Set command for update.

Get-PvsDiskInventory

Get the fields for Inventory Status of a Disk Version or all Disk Versions for a Disk Locator.

This is required

or this is required & resolution

Optional

One of these resolutions when needed

One of these resolutions when needed

Instead of a parameter that matches one of the members listed
PvsObject[] Object: PvsObjects with the members below can be used as the Object parameter or from a pipeline:
      (DiskLocatorId and Version) or DiskLocatorId

If only selected fields are needed, pass them in the Fields parameter as a string array.

PvsDiskInventory[]: If successful, the PvsDiskInventory object(s) are returned.

Examples

EXAMPLE 1: Get PvsDiskInventory for DiskLocator

Get all PvsDiskInventory for the DiskLocator named theDiskLocator in the Site named theSite and Store named theStore.

Get-PvsDiskInventory -Name theDiskLocator -SiteName theSite -StoreName theStore

Guid can be used instead of Name so that the SiteName or SiteId and StoreName or StoreId are not also needed.

Get-PvsDiskLocator

Get the fields for a Disk Locator or all Disk Locators for a Device, Server, Store, Site, or Farm. All DiskLocators are returned if no parameters are passed.

These are optional

These are optional & resolutions

These are optional

Optional

One of these resolutions when needed

One of these resolutions when needed

Instead of a parameter that matches one of the members listed
PvsObject[] Object: PvsObjects with the members below can be used as the Object parameter or from a pipeline:
      DiskLocatorId, DeviceId, ServerId, UpdateTaskId, SiteId or StoreId

If only selected fields are needed, pass them in the Fields parameter as a string array.

PvsDiskLocator[]: If successful, the PvsDiskLocator object(s) are returned.

Examples

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 theSite and Store named theStore.

Get-PvsDiskLocator -SiteName theSite -StoreName theStore

EXAMPLE 4: Get PvsDiskLocator for DiskLocator

Get the PvsDiskLocator for the DiskLocator named theDiskLocator in the Site named theSite and Store named theStore.

Get-PvsDiskLocator -Name theDiskLocator -SiteName theSite -StoreName theStore

Guid can be used instead of Name so that the SiteName or SiteId and StoreName or StoreId are not also needed.

EXAMPLE 5: Get PvsDiskLocator and Enable

Get all PvsDiskLocator that are not Enabled and then Enables 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 fields specified 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 to the Set command for update.

Get-PvsDiskLocatorCount

Get count of Disk Locators for a Site and Type.

One of these is required

These are optional

Instead of a parameter that matches one of the members listed
PvsObject[] Object: PvsObjects with the members below can be used as the Object parameter or from a pipeline:
      SiteId

UInt32: If successful, the numeric value is returned

Examples

EXAMPLE 1: Get-PvsDiskLocatorCount Returns the Number (or Count) of PvsDiskLocator in PvsSite

Get-PvsDiskLocatorCount -SiteName theSite

Get-PvsDiskLocatorLock

Get the fields for all the locks of a Disk Locator.

This is required

or this is required & resolution

One of these resolutions when needed

One of these resolutions when needed

Instead of a parameter that matches one of the members listed
PvsObject[] Object: PvsObjects with the members below can be used as the Object parameter or from a pipeline:
      DiskLocatorId

If only selected fields are needed, pass them in the Fields parameter as a string array.

PvsDiskLocatorLock[]: If successful, the PvsDiskLocatorLock object(s) are returned.

Examples

EXAMPLE 1: Get PvsDiskLocatorLock for DiskLocator

Get all PvsDiskLocatorLock for the DiskLocator named theDiskLocator 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 the SiteName 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 Disk Update Devices are returned if no parameters are passed.

These are optional

These are optional & resolutions

Optional

One of these resolutions when needed

One of these resolutions when needed

Instead of a parameter that matches one of the members listed
PvsObject[] Object: PvsObjects with the members below can be used as the Object parameter or from a pipeline:
      DeviceId, ServerId, DiskLocatorId, UpdateTaskId or SiteId

If only selected fields are needed, pass them in the Fields parameter as a string array.

PvsDiskUpdateDevice[]: If successful, the PvsDiskUpdateDevice object(s) are returned.

Examples

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 named theSite.

Get-PvsDiskUpdateDevice -SiteName theSite

EXAMPLE 3: Get PvsDiskUpdateDevice for Server

Get all PvsDiskUpdateDevice for the Server named theServer.

Get-PvsDiskUpdateDevice -ServerName theServer

EXAMPLE 4: Get PvsDiskUpdateDevice for DiskLocator

Get all PvsDiskUpdateDevice for the DiskLocator named theDiskLocator in the Site named theSite and Store named theStore.

Get-PvsDiskUpdateDevice -DiskLocatorName theDiskLocator -SiteName theSite -StoreName theStore

DiskLocatorId can be used instead of DiskLocatorName so 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 named theDevice.

Get-PvsDiskUpdateDevice -Name theDevice

EXAMPLE 6: Get PvsDiskUpdateDevice for Device MAC

Get the PvsDiskUpdateDevice for the Device with MAC 02-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 named theUpdateTask in the Site named theSite.

Get-PvsDiskUpdateDevice -UpdateTaskName theUpdateTask -SiteName theSite

UpdateTaskId can be used instead of UpdateTaskName so that the SiteName or SiteId is not also needed.

Get-PvsDiskUpdateStatus

Get the status of an Update Task, or all Update Tasks for a Site or Farm. All Disk Update Tasks are returned if no parameters are passed.

These are optional

or this is optional & resolution

One of these resolutions when needed

Instead of a parameter that matches one of the members listed
PvsObject[] Object: PvsObjects with the members below can be used as the Object parameter or from a pipeline:
      UpdateTaskId, DeviceId or SiteId

If only selected fields are needed, pass them in the Fields parameter as a string array.

PvsDiskUpdateStatus[]: If successful, the PvsDiskUpdateStatus object(s) are returned.

Examples

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 named theSite.

Get-PvsDiskUpdateStatus -SiteName theSite

EXAMPLE 3: Get PvsDiskUpdateStatus for Server

Get all PvsDiskUpdateStatus for the Server named theServer.

Get-PvsDiskUpdateStatus -ServerName theServer

EXAMPLE 4: Get PvsDiskUpdateStatus for DiskLocator

Get all PvsDiskUpdateStatus for the DiskLocator named theDiskLocator in the Site named theSite and Store named theStore.

Get-PvsDiskUpdateStatus -DiskLocatorName theDiskLocator -SiteName theSite -StoreName theStore

DiskLocatorId can be used instead of DiskLocatorName so 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 named theDevice.

Get-PvsDiskUpdateStatus -Name theDevice

EXAMPLE 6: Get PvsDiskUpdateStatus for Device MAC

Get the PvsDiskUpdateStatus for the Device with MAC 02-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 named theUpdateTask in the Site named theSite.

Get-PvsDiskUpdateStatus -UpdateTaskName theUpdateTask -SiteName theSite

UpdateTaskId can be used instead of UpdateTaskName so that the SiteName or SiteId is not also needed.

EXAMPLE 8: Get PvsDiskUpdateStatus for DiskUpdateTaskId

Get the PvsDiskUpdateStatus for the Device named theDevice then uses the DiskUpdateTaskId of the PvsDiskUpdateStatus to get the future Get-PvsDiskUpdateStatus.

$u = Get-PvsDiskUpdateStatus -DeviceName theDevice -Fields DiskUpdateTaskId
Get-PvsDiskUpdateStatus -Guid $u.DiskUpdateTaskId

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

Get-PvsDiskVersion

Get the fields for a Disk Version or all Disk Versions for a Disk Locator.

This is required

or this is required & resolution

These are optional

One of these resolutions when needed

One of these resolutions when needed

Instead of a parameter that matches one of the members listed
PvsObject[] Object: PvsObjects with the members below can be used as the Object parameter or from a pipeline:
      (DiskLocatorId and Version) or DiskLocatorId

If only selected fields are needed, pass them in the Fields parameter as a string array.

PvsDiskVersion[]: If successful, the PvsDiskVersion object(s) are returned.

Examples

EXAMPLE 1: Get PvsDiskVersion for DiskLocator

Get all PvsDiskVersion for the DiskLocator named theDiskLocator in the Site named theSite and Store named theStore.

Get-PvsDiskVersion -Name theDiskLocator -SiteName theSite -StoreName theStore

Guid can be used instead of Name so that the SiteName or SiteId and StoreName or StoreId are not also needed.

EXAMPLE 2: Get PvsDiskVersion for DiskLocator

Get the first base PvsDiskVersion for the DiskLocator named theDiskLocator in Site named theSite and Store named theStore.

Get-PvsDiskVersion -Name theDiskLocator -Version 0 -SiteName theSite -StoreName theStore

Guid can be used instead of Name so that the SiteName or SiteId and StoreName or StoreId are not also needed.

EXAMPLE 3: Get Maintenance PvsDiskVersion for DiskLocator

Get the Maintenance PvsDiskVersion for the DiskLocator named theDiskLocator in Site named theSite and Store named theStore.

Get-PvsDiskVersion -Name theDiskLocator -Type 1 -SiteName theSite -StoreName theStore

Guid can be used instead of Name so that the SiteName or SiteId and StoreName or StoreId are not also needed.

EXAMPLE 4: Get Test PvsDiskVersion for DiskLocator

Get all Test PvsDiskVersion for the DiskLocator named 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 the SiteName or SiteId and StoreName or StoreId are not also needed.

EXAMPLE 5: Get Override PvsDiskVersion for DiskLocator

Get the Override PvsDiskVersion for the DiskLocator named 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 the SiteName 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 a CollectionName, SiteViewName, UpdateTaskName or VirtualHostingPoolName is specified, SiteName or SiteId must be included.

One of these is required

or one of these is required & resolutions

One of these resolutions when needed

One of these resolutions when needed

Boolean: If successful, $true or $false is returned.

Examples

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 -SiteName theSite

SiteId can be used instead of SiteName.

EXAMPLE 8: Get-PvsExists Determine if SiteViewName Already Exists

Get-PvsExists -SiteViewName theName -SiteName theSite

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 -SiteName theSite

SiteId can be used instead of SiteName.

EXAMPLE 11: Get-PvsExists Determine if DiskLocatorName Already Exists

Get-PvsExists -DiskLocatorName theName -SiteName theSite -StoreName theStore

SiteId can be used instead of SiteName, and StoreId can be used instead of StoreName.

Get-PvsFarm

Get the fields for the Farm.

Optional

Instead of a parameter that matches one of the members listed
PvsObject[] Object: PvsObjects with the members below can be used as the Object parameter or from a pipeline:
      FarmId

If only selected fields are needed, pass them in the Fields parameter as a string array.

PvsFarm[]: If successful, the PvsFarm object(s) are returned.

Examples

EXAMPLE 1: Get PvsFarm

Get the PvsFarm.

Get-PvsFarm

Get-PvsFarmView

Get the fields for a Farm View or all Farm Views in the Farm. All Farm Views are returned if no parameters are passed.

These are optional

Instead of a parameter that matches one of the members listed
PvsObject[] Object: PvsObjects with the members below can be used as the Object parameter or from a pipeline:
      FarmViewId

If only selected fields are needed, pass them in the Fields parameter as a string array.

PvsFarmView[]: If successful, the PvsFarmView object(s) are returned.

Examples

EXAMPLE 1: Get PvsFarmView for Farm

Get all PvsFarmView for the Farm.

Get-PvsFarmView

EXAMPLE 2: Get PvsFarmView

Get the PvsFarmView for the FarmView named theFarmView.

Get-PvsFarmView -Name theFarmView

Get-PvsGroup

Get the fields for the Groups for the user or the System.

Optional

If only selected fields are needed, pass them in the Fields parameter as a string array.

PvsGroup[]: If successful, the PvsGroup object(s) are returned.

Examples

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 theDomain for 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-PvsKeyRotationPendingServers

Gets all the offline servers in Farm that have ServerEpoch different than FarmEpoch when EncryptionStatus is Distributing keys. When EncryptionStatus is Idle, it gets list of all offline servers.

If only selected fields are needed, pass them in the Fields parameter as a string array.

PvsKeyRotationPendingServers[]: If successful, the PvsKeyRotationPendingServers object(s) are returned.

Examples

EXAMPLE 1: Get Get-PvsKeyRotationPendingServers

Gets all the offline servers in Farm that have serverEpoch different than farmEpoch when encryptionStatus is Distributing keys. When encryptionStatus is Idle, it gets list of all offline servers.

Get-PvsKeyRotationPendingServers

Get-PvsLocalServer

Return one record with the local server’s NetBios name

| Name | Type | Description | | :— | :— | :———- |

PvsLocalServer[]: If successful, the PvsLocalServer object(s) are returned.

Examples

EXAMPLE 1: Get PvsLocalServer

Get the PvsLocalServer for the PVS SoapServer connected to.

Get-PvsLocalServer

Get-PvsMaintenanceVersionExists

Return true if the if the DiskLocator has a maintenance version, false otherwise.

This is required

or this is required & resolution

One of these resolutions when needed

One of these resolutions when needed

Instead of a parameter that matches one of the members listed
PvsObject[] Object: PvsObjects with the members below can be used as the Object parameter or from a pipeline:
      DiskLocatorId

Boolean: If successful, $true or $false is returned.

Examples

EXAMPLE 1: Get-PvsMaintenanceVersionExists for Name

Get-PvsMaintenanceVersionExists -Name theDiskLocator -SiteName theSite -StoreName theStore

Guid can be used instead of Name so that the SiteName or SiteId and StoreName or StoreId are not also needed.

Get-PvsMinimumLastAutoAddDeviceNumber

Get the minimum that the Device Number of the last Auto Added Device can be.

This is required

or this is required & resolution

Optional

One of these resolutions when needed

Instead of a parameter that matches one of the members listed
PvsObject[] Object: PvsObjects with the members below can be used as the Object parameter or from a pipeline:
      CollectionId

UInt32: If successful, the numeric value is returned

Examples

EXAMPLE 1: Get-PvsMinimumLastAutoAddDeviceNumber

This example gets the highest auto-add number used so far for a PvsDevice that starts with the AutoAddPrefix and AutoAddSuffix of the PVsCollection.

Get-PvsMinimumLastAutoAddDeviceNumber -CollectionName theCollection -SiteName theSite

CollectionId can be used instead of CollectionName so that the SiteName or SiteId is not also needed.

EXAMPLE 2: Get-PvsMinimumLastAutoAddDeviceNumber for AutoAddPrefix with AutoAddSuffix and AutoAddNumberLength

This example gets the highest auto-add number used so far for a PvsDevice with name length up to 10 characters and starts with the AutoAddPrefix and AutoAddSuffix specified.

Get-PvsMinimumLastAutoAddDeviceNumber -CollectionName theCollection -SiteName theSite -AutoAddPrefix "P" -AutoAddSuffix "S" -AutoAddNumberLength 10

CollectionId can be used instead of CollectionName so that the SiteName or SiteId is not also needed.

Get-PvsMountedDisk

Get the mounted disk, if there is one.

These are optional

These are optional

Instead of a parameter that matches one of the members listed
PvsObject[] Object: PvsObjects with the members below can be used as the Object parameter or from a pipeline:
      ServerId or StoreId

PvsDiskLocator: If successful, the mapped PvsDiskLocator is returned.

Examples

EXAMPLE 1: Get-PvsMountedDisk

This example gets the PvsMappedDisk. If no disk is mapped, 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 the ServerName. If no disk is mapped, null is returned.

$thePvsDiskLocator = Get-PvsMappedDisk -ServerName theServer
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 -StoreName theStore
if ($thePvsDiskLocator -ne $null)
{
    $thePvsDiskLocator.Name    # display the name of the mapped PvsDiskLocator
}

Get-PvsMountedDriveLetter

If there is currently a Mounted Drive, return the Letter of the Drive.

String: If successful, the String value is returned.

Examples

EXAMPLE 1: Get-PvsMountedDriveLetter

This example gets any mapped disk drive letter. If no 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 the drive letter
}

Get-PvsNewDiskVersion

Get new Disk versions for the Store on the Server specified.

One of these is required

One of these is required

Optional

Instead of a parameter that matches one of the members listed
PvsObject[] Object: PvsObjects with the members below can be used as the Object parameter or from a pipeline:
      ServerId or StoreId

If only selected fields are needed, pass them in the Fields parameter as a string array.

PvsNewDiskVersion[]: If successful, the PvsNewDiskVersion object(s) are returned.

Examples

EXAMPLE 1: Get PvsNewDiskVersion

Get all PvsNewDiskVersion in the Store named theStore 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 the Store named theStore using the Server named theServer.

Get-PvsNewDiskVersion -ServerName theServer -StoreName theStore -AutoAddEnabled

Get-PvsScrambledDataReport

Returns a (scrambled value, real value) key pair for all device usage events (e.g. create, edit, delete)

If only selected fields are needed, pass them in the Fields parameter as a string array.

PvsScrambledDataReport[]: If successful, the PvsScrambledDataReport object(s) are returned.

Get-PvsServer

Get the fields for a Server, all Servers in a Site that use a Store, service a DiskLocator, or for the whole Farm. All Servers are returned if no parameters are passed.

These are optional

or this is optional & resolution

These are optional & resolutions

Optional

One of these resolutions when needed

One of these resolutions when needed

Instead of a parameter that matches one of the members listed
PvsObject[] Object: PvsObjects with the members below can be used as the Object parameter or from a pipeline:
      ServerId, SiteId, DiskLocatorId or StoreId

If only selected fields are needed, pass them in the Fields parameter as a string array.

PvsServer[]: If successful, the PvsServer object(s) are returned.

Examples

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 and Store named theStore.

Get-PvsServer -SiteName theSite -StoreName theStore

EXAMPLE 4: Get PvsServer for DiskLocator

Get the PvsServer for the DiskLocator named theDiskLocator in the Site named theSite and Store named theStore.

Get-PvsServer -DiskLocatorName theDiskLocator -SiteName theSite -StoreName theStore

DiskLocatorId can be used instead of DiskLocatorName so 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 Start them.

Get-PvsServer -Fields Active | Where-Object {\$\_.Active -eq 0} | Start-PvsStreamService

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

Get-PvsServerBiosBootstrap

Oem Only: Get the bootstrap fields for the Server dell_bios.bin BIOS bootstrap file.

One of these is required

Instead of a parameter that matches one of the members listed
PvsObject[] Object: PvsObjects with the members below can be used as the Object parameter or from a pipeline:
      ServerId

If only selected fields are needed, pass them in the Fields parameter as a string array.

PvsServerBiosBootstrap[]: If successful, the PvsServerBiosBootstrap object(s) are returned.

Examples

EXAMPLE 1: Get PvsServerBiosBootstrap for Server

Get all PvsServerBiosBootstrap for the Server named theServer.

Get-PvsServerBiosBootstrap -Name theServer

Get-PvsServerBootstrap

Get the bootstrap fields for the Server and named bootstrap file specified.

One of these is required

This is required

Instead of a parameter that matches one of the members listed
PvsObject[] Object: PvsObjects with the members below can be used as the Object parameter or from a pipeline:
      (ServerId and Name) or ServerId

If only selected fields are needed, pass them in the Fields parameter as a string array.