Parameter Reference

Parameter	Cmdlet(s)	Values	Description
`ComputerAddress`	`Dismount-PsbSnapshotSet Get-PsbAvailableDrive Invoke-PsbSnapshotJob Mount-PsbSnapshotSet New-PsbVolumeSet`		The name (DNS or Fully Qualified Domain Name) or IP address of a physical server or VM running Windows Server.
`ComputerSession`	`Get-PSBAvailableDrive`		A session that is declared if Backup Module is installed on macOS or Linux, allowing a remote PowerShell session to the target Windows Server ( `ComputerAddress`). See PowerShell Core for more information.
`ComputerCredential`	`Dismount-PsbSnapshotSet Invoke-PsbSnapshotJob Mount-PsbSnapshotSet` `New-PsbVolumeSet`		The credentials for the Windows Server passed in through a variable.
`CreatePgroup`	`Invoke-PsbSnapshotJob`		Use this the first time `Invoke-PsbSnapshotJob` is run to create a Protection Group with psb- as the prefix. It also adds all Volumes declared in the `Path` parameter.
DatastoreName	`Mount-PsbSnapshotSet`		Use this to declare which datastore to use for the mounted volumes. This is most useful in replicated environments where the target FlashArray is not the same FlashArray as the source volumes used to create the snapshots.
`FlashArrayAddress`	`Dismount-PsbSnapshotSet Get-PsbSnapshotJobHistory Get-PsbVolumeSet Get-PsbVolumeSetProtectionGroup Invoke-PsbSnapshotJob Mount-PsbSnapshotSet New-PsbVolumeSet Remove-PsbSnapshotSet Remove-PsbVolumeSet`		The name (DNS or Fully Qualified Domain Name) or IP address of a Everpure FlashArray.
`FlashArrayCredential`	`Dismount-PsbSnapshotSet Get-PsbSnapshotJobHistory Get-PsbVolumeSet Get-PsbVolumeSetProtectionGroup Invoke-PsbSnapshotJob Mount-PsbSnapshotSet New-PsbVolumeSet Remove-PsbSnapshotSet Remove-PsbVolumeSet`		The credentials for a Everpure FlashArray passed in through a variable.
`HistoryID`	`Mount-PsbSnapshotSet Remove-PsbSnapshotSet`		A unique ID assigned to a snapshot set when the snapshot is created.
`MountID`	`Dismount-PsbSnapshotSet`		A unique ID assigned when a snapshot set is mounted. This allows the same source snapshot set to be mounted multiple times.
`NewPgroupSuffix`	`Invoke-PsbSnapshotJob`		These parameters can be used to create a Protection Group the first time `Invoke-PsbSnapshotJob` is run. This will create a Protection Group with the suffix provided.
`NoPgroup`	`Invoke-PsbSnapshotJob`		This should only be used when a single Pure Volume is declared. A Volume snapshot will be taken instead of a Protection Group snapshot. Consistency cannot be guaranteed with multiple volumes without using a protection group.
`Path`	`Invoke-PsbSnapshotJob Mount-PsbSnapshotSet New-PsbVolumeSet`		The path can be a drive letter or mount point separated by a comma without spaces. Valid path examples: Single Drive Letter `'E:\'` Multiple Drive Letters `'E:\,P:\'` Mount Point and Multiple Drive Letters `'C:\mp1,S:\,T:\'`
`PgroupName`	`Invoke-PsbSnapshotJob`		This should be the steady state parameter used when invoking a snapshot.
`ReplicateNow`	`Invoke-PsbSnapshotJob`		In the case of a Protection Group with a replication target, this parameter forces replication to occur immediately after snapshot creation. If not used, replication will occur at the interval set as part of the Protection Group replication policy.
`UseBestPgroupMatch`	`Invoke-PsbSnapshotJob`		Use this parameter to select the Protection Group that contains all of the Volumes declared using `Path` with the fewest number of additional Volumes. Only use when multiple Protection Groups include all of the declared volumes in the path and you prefer to have the cmdlet find the protection group with the fewest number of additional Volumes. Using this parameter when the declared Volumes in the path only belong to one Protection Group, and that Protection Group has many, or all of the Volumes on the FlashArray included, can waste space since it is not the number of snapshots but the change rate times the retention, that impacts snapshot consumption.
`VCenterAddress`	`Dismount-PsbSnapshotSet Get-PsbVmPersistentId Invoke-PsbSnapshotJob Mount-PsbSnapshotSet New-PsbVolumeSet`		(VMware only) The name (DNS or Fully Qualified Domain Name) or IP address of a VMware vCenter Server.
`VCenterCredential`	`Dismount-PsbSnapshotSet Get-PsbVmPersistentId Invoke-PsbSnapshotJob Mount-PsbSnapshotSet New-PsbVolumeSet`		(VMware only) The credentials for the VMware vCenter server passed in through a variable.
`VmName`	`Get-PSBVMPersistentId Invoke-PsbSnapshotJob New-PsbVolumeSet`		(VMware only) This name is the friendly name of the VM as seen by vCenter/ESXi, not the hostname or FQDN of the VM. This is only used for virtual machines in a VMware environment using either pRDM or vVol disk types. VMs that utilize in-guest iSCSI or virtual FC HBAs are treated as physical servers with physical disk types.
`VmPersistentID`	`Get-PsbVmPersistentId Invoke-PsbSnapshotJob Mount-PsbSnapshotSet New-PsbVolumeSet`		(VMware only) This is an optional parameter that will protect automation in the case that the friendly name of a VMware VM in vCenter is changed.
`VolumeSetName`	`Get-PsbSnapshotJobHistory Get-PsbVolumeSetProtectionGroup Invoke-PsbSnapshotJob New-PsbVolumeSet Remove-PsbVolumeSet`		This is the friendly name used to assign a set of Volumes to a Volume Set. If the number of Volumes declared in `Path` change, the snapshot will fail if all Volumes are not included in the declared Protection Group. Add the new volumes to the existing Protection Group or create a new one using `CreatePgroup` and NewPgroupSuffix parameters of `Invoke-PsbSnapshotJob`.
`VolumeType`	`Invoke-PsbSnapshotJob New-PsbVolumeSet`	`Physical` `RDM` `vVol`	`Physical` - Use this for bare metal servers and VMs that use virtual Fibre Channel (Hyper-V only) or in-guest iSCSI (Hyper-V and VMware) and direct Volumes on FlashArray. `RDM` - VMware VMs that use pRDMs. `vVol` - VMware VMs that use vVols.