Add-PfaHostGroupHosts
Adds host members of the host group.
Add
PfaHostGroupHosts
Adds host members of the host group.
Add-PfaHostGroupHosts
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Name
Name of host group to create.
String
HostList
Adds a list of hosts to the existing list.
String[]
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Name
Name of host group to create.
String
String
HostList
Adds a list of hosts to the existing list.
String[]
String[]
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Add-PfaHostGroupHosts -FlashArray 1.1.1.1 -Name HOSTGROUP1 -HostList HOSTA,HOSTB,HOSTC,HOSTD -Session $MySession
Add-PfaProtectionGroupMembers
Creates a new snapshot of a Pure Storage Protection Group(s).
Add
PfaProtectionGroupMembers
The New-PfaProtectionGroupSnapshot creates a new snapshot of the host, host group or volumes
that are part of a Protection Group. Assumes that the apply_retention will be used for all snapshots.
Add-PfaProtectionGroupMembers
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Name
Protection group name.
String
HostGroups
Add one or more host groups to be included in the new protection group.
String[]
Hosts
Add one or more hosts to be included in the new protection group.
String[]
Volumes
Add one or more volumes to be included in the new protection group.
String[]
ReplicationTargets
Add one or more targets to be included in the new protection group.
String[]
Session
Pure Storage FlashArray session created with Connect-PfaController.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Name
Protection group name.
String
String
HostGroups
Add one or more host groups to be included in the new protection group.
String[]
String[]
Hosts
Add one or more hosts to be included in the new protection group.
String[]
String[]
Volumes
Add one or more volumes to be included in the new protection group.
String[]
String[]
ReplicationTargets
Add one or more targets to be included in the new protection group.
String[]
String[]
Session
Pure Storage FlashArray session created with Connect-PfaController.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Add-PfaProtectionGroupMembers -FlashArray 1.1.1.1 -Name TESTGROUP -HostGroups HG1,HG2 -Session $S
Clear-PfaPermissionCache
Clears all user permission cache entries.
Clear
PfaPermissionCache
Clears all user permission cache entries.
User permission cache entries are also automatically updated when the user starts a new session.
Clear-PfaPermissionCache
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Clear-PfaPermissionCache -FlashArray 1.1.1.1 -Session $MySession
Connect-PfaController
Connects to the Pure Storage FlashArray.
Connect
PfaController
Using the API Token established from the Get-PfaApiToken cmdlet a session is established to the FlashArray.
Connect-PfaController
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
API_Token
Retrieved API Token for a given user on the Pure Storage FlashArray.
String
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
API_Token
Retrieved API Token for a given user on the Pure Storage FlashArray.
String
String
System.String
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
$MySession = Connect-PfaController -FlashArray 1.1.1.1 -API_Token $MyToken.api_token
This example shows how to set the $MySession variable by passing the $MyToken.api_token.
-------------------------- EXAMPLE 2 --------------------------
PS C:\Users\barkz>
$MySession = Get-PfaAPIToken -FlashArray 10.21.8.82 -Username pureuser -Password pureuser -RESTAPI 1.2 | Connect-PfaController -FlashArray 10.21.8.82
This example shows how to pass a retrieved API Token using ValueFromPipelineByPropertyName to Connect-PfaController
cmdlet and assigning a new session variable to $MySession.
Connect-PfaHost
Assigns the same LUN to each connection. The connection fails for any host for which the specified LUN is already in use.
Connect
PfaHost
Assigns the same LUN to each connection. The connection fails for any host for which the specified LUN is already in
use.
Connect-PfaHost
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Name
Name of host to connect.
String
Volume
Volume to attach to host.
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Name
Name of host to connect.
String
String
Volume
Volume to attach to host.
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Connect-PfaVolume -FlashArray 1.1.1.1 -Name HOST1 -Volume VOLUME1 -Session $MySession
Connect-PfaHostGroup
Connects a volume to all hosts in the specified host group.
Connect
PfaHostGroup
Connects a volume to all hosts in the specified host group.
If the LUN is not specified, when the volume is connected to the host group, Purity
assigns the same LUN to each connection. All hosts in the group use this LUN to
communicate with the volume.
Connect-PfaHostGroup
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Name
Name of host group to connect.
String
Volume
Volume to connect to host group.
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Name
Name of host group to connect.
String
String
Volume
Volume to connect to host group.
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
New-PfaHost -FlashArray 1.1.1.1 -Name HOSTGROUP1 -Session $MySession
-------------------------- EXAMPLE 2 --------------------------
PS C:\>
New-PfaHost -FlashArray 1.1.1.1 -Name HOSTGROUP1 -HostList HOSTA,HOSTB,HOSTC,HOSTD -Session $MySession
Connect-PfaRemoteAssist
Enables a remote assist session.
Connect
PfaRemoteAssist
Enables (true) the automatic hourly transmission of array logs to the Pure Storage Support team.
Connect-PfaRemoteAssist
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Connect-PfaRemoteAssist -FlashArray 1.1.1.1 -Session $MySession
Connect-PfaVolume
Assigns the same LUN to each connection. The connection fails for any host for which the specified LUN is already in use.
Connect
PfaVolume
Assigns the same LUN to each connection. The connection fails for any host for which the specified LUN is already in
use.
Connect-PfaVolume
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Name
Name of host to connect.
String
Volume
Volume to attach to host.
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Name
Name of host to connect.
String
String
Volume
Volume to attach to host.
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Connect-PfaVolume -FlashArray 1.1.1.1 -Name HOST1 -Volume VOLUME1 -Session $MySession
Disable-PfaAlertRecipient
Disables (false) the transmission of alert messages to the specified email address.
Disable
PfaAlertRecipient
Disables (false) the transmission of alert messages to the specified email address.
Disable-PfaAlertRecipient
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Email
Email recipient to test.
String
Session
Pure Storage FlashArray session created with Connect-PfaController.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Email
Email recipient to test.
String
String
Session
Pure Storage FlashArray session created with Connect-PfaController.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Disable-PfaAlertRecipient -FlashArray 1.1.1.1 -Email test@test.com -Session $S
Disable-PfaConsoleLock
Disables root login through the console.
Disable
PfaConsoleLock
Disables (false) the console lock which prevents the root user from logging in through the system console.
Disable-PfaConsoleLock
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Enable-PfaConsoleLock -FlashArray 1.1.1.1 -Session $MySession
Disable-PfaDirectoryService
Disables directory service support.
Disable
PfaDirectoryService
Disables directory service support.
Disable-PfaDirectoryService
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Disable-PfaDirectoryService -FlashArray 1.1.1.1 -Session $MySession
Disable-PfaPhonehome
Disables phonehome actions.
Disable
PfaPhonehome
Disables (false) the automatic hourly transmission of array logs to the Pure Storage Support team.
Disable-PfaPhonehome
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Disable-PfaPhonehome -FlashArray 1.1.1.1 -Session $MySession
Disable-PfaPorts
Disables (false) the array ports, opening or blocking communication with hosts.
Disable
PfaPorts
Disables (false) the array ports, opening or blocking communication with hosts.
Disable-PfaPorts
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Session
Pure Storage FlashArray session created with Connect-PfaController.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Session
Pure Storage FlashArray session created with Connect-PfaController.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Enable-PfaPorts -FlashArray 1.1.1.1 -Session $S
Disable-PfaProtectionGroupReplication
Disable the protection group replication schedule.
Disable
PfaProtectionGroupReplication
Disable the protection group replication schedule.
Disable-PfaProtectionGroupReplication
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Name
Protection group name.
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Name
Protection group name.
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Disable-PfaProtectionGroupReplication -FlashArray 1.1.1.1 -Name Volume1 -Session $MySession
Disable-PfaProtectionGroupSnapshots
Disable the protection group snapshot schedule.
Disable
PfaProtectionGroupSnapshots
Disable the protection group snapshot schedule.
Disable-PfaProtectionGroupSnapshots
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Name
Protection group name.
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Name
Protection group name.
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Disable-PfaProtectionGroupSnapshots -FlashArray 1.1.1.1 -Name Volume1 -Session $MySession
Disconnect-PfaController
Disconnect from a Pure Storage FlashArray session.
Disconnect
PfaController
Disconnect from an established session with the Pure Storage FlashArray. Each individual session needs to be
disconnected to ensure all sessions have been deleted.
Disconnect-PfaController
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Disconnect-PfaController -FlashArray 1.1.1.1 -Session $MySession
Disconnect-PfaHostGroupVolume
Disconnects host group from specified volume.
Disconnect
PfaHostGroupVolume
Disconnects host group from specified volume.
Disconnect-PfaHostGroupVolume
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Name
Name of host group to disconnect volume.
String
Volume
Name of volume to disconnect.
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Name
Name of host group to disconnect volume.
String
String
Volume
Name of volume to disconnect.
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Disconnect-PfaHostGroupVolume -FlashArray 1.1.1.1 -Name HOSTGROUP1 -Session $MySession
Disconnect-PfaRemoteAssist
Disables a remote assist session.
Disconnect
PfaRemoteAssist
Disables (false) the automatic hourly transmission of array logs to the Pure Storage Support team.
Disconnect-PfaRemoteAssist
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Disconnect-PfaRemoteAssist -FlashArray 1.1.1.1 -Session $MySession
Disconnect-PfaVolume
Breaks the connection between a host and volume.
Disconnect
PfaVolume
Breaks the connection between a host and volume.
Disconnect-PfaVolume
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Volume
Volume to disconnect from host.
String
Host
Name of host to disconnect.
String
HostGroup
Name of host group to disconnect.
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Volume
Volume to disconnect from host.
String
String
Host
Name of host to disconnect.
String
String
HostGroup
Name of host group to disconnect.
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Disconnect-PfaVolume -FlashArray 1.1.1.1 -Volume VOLUME1 -Host HOST1 -Session $MySession
-------------------------- EXAMPLE 2 --------------------------
PS C:\>
Disconnect-PfaVolume -FlashArray 1.1.1.1 -Volume VOLUME1 -HostGroup HOSTGROUP1 -Session $MySession
Enable-PfaAlertRecipient
Enables (true) the transmission of alert messages to the specified email address.
Enable
PfaAlertRecipient
Enables (true) the transmission of alert messages to the specified email address.
Enable-PfaAlertRecipient
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Email
Email recipient to test.
String
Session
Pure Storage FlashArray session created with Connect-PfaController.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Email
Email recipient to test.
String
String
Session
Pure Storage FlashArray session created with Connect-PfaController.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Enable-PfaAlertRecipient -FlashArray 1.1.1.1 -Email test@test.com -Session $S
Enable-PfaConsoleLock
Enables root login through the console.
Enable
PfaConsoleLock
Enables (true) the console lock which prevents the root user from logging in through the system console.
Enable-PfaConsoleLock
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Enable-PfaConsoleLock -FlashArray 1.1.1.1 -Session $MySession
Enable-PfaDirectoryService
Enables directory service support.
Enable
PfaDirectoryService
Enables directory service support.
Enable-PfaDirectoryService
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Enable-PfaDirectoryService -FlashArray 1.1.1.1 -Session $MySession
Enable-PfaPhonehome
Disables phonehome actions.
Enable
PfaPhonehome
Enables (true) the automatic hourly transmission of array logs to the Pure Storage Support team.
Enable-PfaPhonehome
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Enable-PfaPhonehome -FlashArray 1.1.1.1 -Session $MySession
Enable-PfaPorts
Enables (true) the array ports, opening or blocking communication with hosts.
Enable
PfaPorts
Enables (true) the array ports, opening or blocking communication with hosts.
Enable-PfaPorts
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Session
Pure Storage FlashArray session created with Connect-PfaController.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Session
Pure Storage FlashArray session created with Connect-PfaController.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Enable-PfaPorts -FlashArray 1.1.1.1 -Session $S
Enable-PfaProtectionGroupReplication
Enable the protection group replication schedule.
Enable
PfaProtectionGroupReplication
Enable the protection group replication schedule.
Enable-PfaProtectionGroupReplication
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Name
Protection group name.
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Name
Protection group name.
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Enable-PfaProtectionGroupReplication -FlashArray 1.1.1.1 -Name Volume1 -Session $MySession
Enable-PfaProtectionGroupSnapshots
Enable the protection group snapshot schedule.
Enable
PfaProtectionGroupSnapshots
Enable the protection group snapshot schedule.
Enable-PfaProtectionGroupSnapshots
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Name
Protection group name.
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Name
Protection group name.
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Enable-PfaProtectionGroupSnapshots -FlashArray 1.1.1.1 -Name Volume1 -Session $MySession
Eradicate-PfaProtectionGroup
Eradicates a destroyed protection group and all of its snapshots.
Eradicate
PfaProtectionGroup
Eradicates a destroyed protection group and all of its snapshots.
Eradicate-PfaProtectionGroup
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Name
Protection group name.
String
Session
Pure Storage FlashArray session created with Connect-PfaController.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Name
Protection group name.
String
String
Session
Pure Storage FlashArray session created with Connect-PfaController.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Eradicate-PfaProtectionGroup -FlashArray 1.1.1.1 -Name TESTGROUP -Session $S
Eradicate-PfaProtectionGroupSnapshots
Eradicates a destroyed protection group and all of its snapshots.
Eradicate
PfaProtectionGroupSnapshots
Eradicates a destroyed protection group and all of its snapshots.
Eradicate-PfaProtectionGroupSnapshots
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Name
Protection group name.
String
Session
Pure Storage FlashArray session created with Connect-PfaController.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Name
Protection group name.
String
String
Session
Pure Storage FlashArray session created with Connect-PfaController.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Eradicate-PfaProtectionGroup -FlashArray 1.1.1.1 -Name TESTGROUP -Session $S
Eradicate-PfaVolume
Eradicates the specified volume or snapshot.
Eradicate
PfaVolume
Eradicates the specified volume or snapshot.
Eradicate-PfaVolume
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Volume
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Volume
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Eradicate-PfaVolume -FlashArray 1.1.1.1 -Name Volume1 -Session $MySession
Export-PfaSslCert
Export-PfaSslCert [-FlashArray] <string> [-Session] <WebRequestSession> [-Certificate] [-IntermediateCertificate] [<CommonParameters>]
Export
PfaSslCert
Export-PfaSslCert
FlashArray
String
Session
WebRequestSession
Certificate
SwitchParameter
IntermediateCertificate
SwitchParameter
FlashArray
String
String
Certificate
SwitchParameter
SwitchParameter
IntermediateCertificate
SwitchParameter
SwitchParameter
Session
WebRequestSession
WebRequestSession
Get-HostBusAdapter
Retrieves the HBAs installed on the specific computer.
Get
HostBusAdapter
Retrieves the HBAs installed on the specific computer.
Get-HostBusAdapter
ComputerName
String
ComputerName
String
String
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Get-HBAObject -ComputerName MyServer
Get-PfaAlertRecipient
Lists information about the specified email recipient.
Get
PfaAlertRecipient
Lists information about the specified email recipient.
Get-PfaAlertRecipient
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Email
Email recipient, defaults to flasharray-alerts@purestorage.com
String
Session
Pure Storage FlashArray session created with Connect-PfaController.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Email
Email recipient, defaults to flasharray-alerts@purestorage.com
String
String
Session
Pure Storage FlashArray session created with Connect-PfaController.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Get-PfaAlertRecipient -FlashArray 1.1.1.1 -Session $S
Get-PfaAlerts
Get-PfaAlerts [-FlashArray] <string> [-Session] <WebRequestSession> [<CommonParameters>]
Get
PfaAlerts
Get-PfaAlerts
FlashArray
String
Session
WebRequestSession
FlashArray
String
String
Session
WebRequestSession
WebRequestSession
Get-PfaApiToken
Generates a REST API token that can be used to create a REST session.
Get
PfaApiToken
A detailed description of the Get-PfaAPIToken function.
Get-PfaApiToken
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Username
Purity user login name used to generate the REST API token. Sometimes referred to as sAMAccountName.
String
Password
Purity user login password used to generate the REST API token.
String
RESTAPI
What REST API version to target. Purity Operating Environment has the following released versions: 1.0, 1.1, 1.2, 1.3.
The
default is 1.3 the latest version of the REST API.
NOTE: This parameter can be set when retrieving an API Token but once a connection is made to a Pure Storage FlashArray
using the Connect-PfaController cmdlet the latest REST API will automatically be used in subsequent cmdlets.
String
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Username
Purity user login name used to generate the REST API token. Sometimes referred to as sAMAccountName.
String
String
Password
Purity user login password used to generate the REST API token.
String
String
RESTAPI
What REST API version to target. Purity Operating Environment has the following released versions: 1.0, 1.1, 1.2, 1.3.
The
default is 1.3 the latest version of the REST API.
NOTE: This parameter can be set when retrieving an API Token but once a connection is made to a Pure Storage FlashArray
using the Connect-PfaController cmdlet the latest REST API will automatically be used in subsequent cmdlets.
String
String
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
$MyToken = Get-PfaAPIToken -FlashArray 1.1.1.1 -Username pureuser -Password pureuser -RESTAPI 1.2
This example shows how to get an API Token and assign it to the $MyToken variable for use with the
Connect-PfaController cmdlet.
-------------------------- EXAMPLE 2 --------------------------
PS C:\Users\barkz>
$MySession = Get-PfaAPIToken -FlashArray 10.21.8.82 -Username pureuser -Password pureuser -RESTAPI 1.2 | Connect-PfaController -FlashArray 10.21.8.82
This example shows how to pass a retrieved API Token using ValueFromPipelineByPropertyName to Connect-PfaController
cmdlet and assigning a new session variable to $MySession.
Get-PfaApiVersion
Get-PfaApiVersion [-FlashArray] <string> -Session <WebRequestSession> [<CommonParameters>]
Get
PfaApiVersion
Get-PfaApiVersion
FlashArray
String
Session
WebRequestSession
FlashArray
String
String
Session
WebRequestSession
WebRequestSession
Get-PfaArray
List FlashArray attributes.
Get
PfaArray
List FlashArray attributes.
Get-PfaArray
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Get-PfaArray -FlashArray 1.1.1.1 -Session $MySession
Get-PfaConfiguration
Retrieves all FlashArray configuration information. The same details can be retrieved via
the Pure Storage FlashArray Web Management Interface (GUI) from the System tab.
Get
PfaConfiguration
Provides detailed information about the configuration of the FlashArray.
Get-PfaConfiguration
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Get-PfaConfiguration -FlashArray 1.1.1.1 -Session $MySession
Get-PfaConnection
Lists connected arrays.
Get
PfaConnection
Lists connected arrays.
Get-PfaConnection
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Get-PfaConnection -FlashArray 1.1.1.1 -Session $MySession
Get-PfaConsoleLock
Displays the status of the console lock.
Get
PfaConsoleLock
Displays the status of the console lock.
Get-PfaConsoleLock
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Get-PfaConsoleLock -FlashArray 1.1.1.1 -Session $MySession
Get-PfaDirectoryService
Lists current base configuration information for the directory service.
Get
PfaDirectoryService
Lists current base configuration information for the directory service.
Get-PfaDirectoryService
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Get-PfaDirectoryService -FlashArray 1.1.1.1 -Session $MySession
Get-PfaDirectoryServiceCertificate
Returns information about the currently configured CA certificate data.
Get
PfaDirectoryServiceCertificate
Returns information about the currently configured CA certificate data.
Get-PfaDirectoryServiceCertificate
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Get-PfaDirectoryServiceCertificate -FlashArray 1.1.1.1 -Session $MySession
Get-PfaDirectoryServiceGroups
Returns information about the group configuration.
Get
PfaDirectoryServiceGroups
Returns information about the group configuration.
Get-PfaDirectoryServiceGroups
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Get-PfaDirectoryServiceGroups -FlashArray 1.1.1.1 -Session $MySession
Get-PfaDns
Get-PfaDns [-FlashArray] <string> [-Session] <WebRequestSession> [<CommonParameters>]
Get
PfaDns
Get-PfaDns
FlashArray
String
Session
WebRequestSession
FlashArray
String
String
Session
WebRequestSession
WebRequestSession
Get-PfaDrive
Lists the attributes for the specified drive.
Get
PfaDrive
Lists the attributes for the specified drive.
Get-PfaDrive
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Location
Location of drive. Eg. SH0.BAY0
String
Session
Pure Storage FlashArray session created with Connect-PfaController.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Location
Location of drive. Eg. SH0.BAY0
String
String
Session
Pure Storage FlashArray session created with Connect-PfaController.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Get-PfaDrive -FlashArray 1.1.1.1 -Location SH0.BAY0 -Session $S
Get-PfaDrives
Lists SSD and NVRAM modules and their attributes.
Get
PfaDrives
Lists SSD and NVRAM modules and their attributes.
Get-PfaDrives
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Session
Pure Storage FlashArray session created with Connect-PfaController.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Session
Pure Storage FlashArray session created with Connect-PfaController.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Get-PfaDrive -FlashArray 1.1.1.1 -Session $S
Get-PfaHardware
Get-PfaHardware [-FlashArray] <string> [-Session] <WebRequestSession> [<CommonParameters>]
Get
PfaHardware
Get-PfaHardware
FlashArray
String
Session
WebRequestSession
FlashArray
String
String
Session
WebRequestSession
WebRequestSession
Get-PfaHardwareComponent
Lists the attributes for the specified hardware component.
Get
PfaHardwareComponent
Lists the attributes for the specified hardware component.
Get-PfaHardwareComponent
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Component
Specific component to query.
String
Session
Pure Storage FlashArray session created with Connect-PfaController.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Component
Specific component to query.
String
String
Session
Pure Storage FlashArray session created with Connect-PfaController.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Get-PfaHardware -FlashArray 1.1.1.1 -Session $S
Get-PfaHistoricalPerformance
Displays the historical performance data.
Get
PfaHistoricalPerformance
Display historical performance data at a specified resolution.
Valid historical values are: 1h, 3h, 24h, 7d, 30d, 90d, 1y
Get-PfaHistoricalPerformance
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
TimePeriod
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
TimePeriod
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Get-PfaArrayConfiguration -FlashArray 1.1.1.1 -Session $MySession
Get-PfaHistoricalVolumePerformance
Displays the historical performance data for a volume.
Get
PfaHistoricalVolumePerformance
Display historical performance data at a specified resolution.
Valid historical values are: 1h, 3h, 24h, 7d, 30d, 90d, 1y
Get-PfaHistoricalVolumePerformance
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Name
Volume name.
String
TimePeriod
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Name
Volume name.
String
String
TimePeriod
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Get-PfaHistoricalVolumePerformance -FlashArray 1.1.1.1 -Name Volume1 -Session $MySession
Get-PfaHost
Get-PfaHost [-FlashArray] <string> [-Name] <string> [[-Display] <string>] [[-Volume] <string>] [-Session] <WebRequestSession> [<CommonParameters>]
Get
PfaHost
Get-PfaHost
FlashArray
String
Name
String
Display
String
Volume
String
Session
WebRequestSession
FlashArray
String
String
Name
String
String
Display
String
String
Volume
String
String
Session
WebRequestSession
WebRequestSession
Get-PfaHostGroups
Get-PfaHostGroups [-FlashArray] <string> [[-Name] <string>] [-Session] <WebRequestSession> [-Space] [<CommonParameters>]
Get
PfaHostGroups
Get-PfaHostGroups
FlashArray
String
Name
String
Session
WebRequestSession
Space
SwitchParameter
FlashArray
String
String
Name
String
String
Space
SwitchParameter
SwitchParameter
Session
WebRequestSession
WebRequestSession
Get-PfaHostGroupVolumes
Lists volumes associated with the specified host groups and the LUNs used to address them.
Get
PfaHostGroupVolumes
Lists volumes associated with the specified host groups and the LUNs used to address them.
Get-PfaHostGroupVolumes
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Name
Host group name.
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Name
Host group name.
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Get-HostGroupVolumes -FlashArray 1.1.1.1 -Session $MySession
Get-PfaHosts
Get-PfaHosts [-FlashArray] <string> [[-Display] <string>] [-Session] <WebRequestSession> [<CommonParameters>]
Get
PfaHosts
Get-PfaHosts
FlashArray
String
Display
String
Session
WebRequestSession
FlashArray
String
String
Display
String
String
Session
WebRequestSession
WebRequestSession
Get-PfaInitiators
Displays host worldwide names (both those discovered by Purity and those assigned by administrators) and the
array ports (targets) on which they are eligible to communicate.
Get
PfaInitiators
Displays host worldwide names (both those discovered by Purity and those assigned by administrators) and the
array ports (targets) on which they are eligible to communicate.
Get-PfaInitiators
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Session
Pure Storage FlashArray session created with Connect-PfaController.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Session
Pure Storage FlashArray session created with Connect-PfaController.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Get-PfaInitiators -FlashArray 1.1.1.1 -Session $S
Get-PfaMessages
Disables (false) the transmission of alert messages to the specified email address.
Get
PfaMessages
Disables (false) the transmission of alert messages to the specified email address.
Get-PfaMessages
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Type
All: Lists all alert events and audit records.
Audit: Lists audit records instead of alerts.
Flagged: Lists flagged messages only. The array automatically flags warnings and critical alerts.
Open: Lists open messages.
Recent: Lists recent messages. An audit record is considered recent if it relates to a command
issued within the past 24 hours. An alert is considered recent if the situation that triggered
it is unresolved, or has only been resolved within the past 24 hours.
User: When audit is set to true, user can be used to list audit records for a specific user.
String
Username
String
Session
Pure Storage FlashArray session created with Connect-PfaController.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Type
All: Lists all alert events and audit records.
Audit: Lists audit records instead of alerts.
Flagged: Lists flagged messages only. The array automatically flags warnings and critical alerts.
Open: Lists open messages.
Recent: Lists recent messages. An audit record is considered recent if it relates to a command
issued within the past 24 hours. An alert is considered recent if the situation that triggered
it is unresolved, or has only been resolved within the past 24 hours.
User: When audit is set to true, user can be used to list audit records for a specific user.
String
String
Username
String
String
Session
Pure Storage FlashArray session created with Connect-PfaController.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Get-PfaMessages -FlashArray 1.1.1.1 -Type Audit -Session $S
-------------------------- EXAMPLE 2 --------------------------
PS C:\>
Get-PfaMessages -FlashArray 1.1.1.1 -Type User -Username User1 -Session $S
Get-PfaNetwork
Lists array administrative network interfaces and their statuses (enabled or disabled) and attributes.
Get
PfaNetwork
Lists array administrative network interfaces and their statuses (enabled or disabled) and attributes.
Get-PfaNetwork
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Get-PfaNetwork -FlashArray 1.1.1.1 -Session $MySession
Get-PfaNetworkInterface
Lists the attributes for the specified network component.
Get
PfaNetworkInterface
Lists the attributes for the specified network component.
Get-PfaNetworkInterface
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Interface
Interface to retrieve. Eg. CT0.ETH0, CT0.ETH1, CT1.ETH0, REPLBOND, VIR0, VIR1
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Interface
Interface to retrieve. Eg. CT0.ETH0, CT0.ETH1, CT1.ETH0, REPLBOND, VIR0, VIR1
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Get-PfaNetworkInterface -FlashArray 1.1.1.1 -Interface CT0.ETH0 -Session $MySession
Get-PfaPendingOnlyVolumes
Lists only volumes pending eradication.
Get
PfaPendingOnlyVolumes
Lists only volumes pending eradication.
Get-PfaPendingOnlyVolumes
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Get-PfaPendingOnlyVolumes -FlashArray 1.1.1.1 -Session $MySession
Get-PfaPendingVolumes
Lists all volumes with pending eradication time remaining.
Get
PfaPendingVolumes
Lists all volumes with pending eradication time remaining.
Get-PfaPendingVolumes
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Get-PfaPendingVolumes -FlashArray 1.1.1.1 -Session $MySession
Get-PfaPhoneHome
Lists information about the status of the transmission logs for the phonehome facility.
Get
PfaPhoneHome
Lists information about the status of the transmission logs for the phonehome facility.
Get-PfaPhoneHome
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Get-PfaPhoneHome -FlashArray 1.1.1.1 -Session $MySession
Get-PfaPorts
Get-PfaPorts [-FlashArray] <string> [-Session] <WebRequestSession> [<CommonParameters>]
Get
PfaPorts
Get-PfaPorts
FlashArray
String
Session
WebRequestSession
FlashArray
String
String
Session
WebRequestSession
WebRequestSession
Get-PfaProtectionGroup
Lists a specific protection group.
Get
PfaProtectionGroup
Lists a specific protection group.
Get-PfaProtectionGroup
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Name
Specific protection group name.
String
Session
Pure Storage FlashArray session created with Connect-PfaController.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Name
Specific protection group name.
String
String
Session
Pure Storage FlashArray session created with Connect-PfaController.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Get-PfaProtectionGroups -FlashArray 1.1.1.1 -Name TESTGROUP -Session $S
Get-PfaProtectionGroupPending
Includes destroyed protection groups that are in the eradication pending state. Time remaining is displayed in seconds.
Get
PfaProtectionGroupPending
Includes destroyed protection groups that are in the eradication pending state. Time remaining is displayed in seconds.
Get-PfaProtectionGroupPending
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Name
Protection group name.
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Name
Protection group name.
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Get-PfaProtectionGroupPending -FlashArray 1.1.1.1 -Name PGROUP1 -Session $MySession
Get-PfaProtectionGroupPendingOnly
Lists destroyed protection groups that are in the eradication pending state. Time remaining is displayed in seconds.
Get
PfaProtectionGroupPendingOnly
Lists destroyed protection groups that are in the eradication pending state. Time remaining is displayed in seconds.
Get-PfaProtectionGroupPendingOnly
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Name
Protection group name.
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Name
Protection group name.
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Get-PfaProtectionGroupPendingOnly -FlashArray 1.1.1.1 -Name PGROUP1 -Session $MySession
Get-PfaProtectionGroupRetentionPolicy
Lists protection groups and snapshots created on this array.
Get
PfaProtectionGroupRetentionPolicy
Lists protection groups and snapshots created on this array.
Get-PfaProtectionGroupRetentionPolicy
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Name
Protection group name.
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Name
Protection group name.
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Get-PfaProtectionGroupRetentionPolicy -FlashArray 1.1.1.1 -Name PGROUP1 -Session $MySession
Get-PfaProtectionGroups
Get-PfaProtectionGroups [-FlashArray] <string> [-Session] <WebRequestSession> [<CommonParameters>]
Get
PfaProtectionGroups
Get-PfaProtectionGroups
FlashArray
String
Session
WebRequestSession
FlashArray
String
String
Session
WebRequestSession
WebRequestSession
Get-PfaProtectionGroupSchedule
Displays the snapshot/replication schedule.
Get
PfaProtectionGroupSchedule
Displays the snapshot/replication schedule.
Get-PfaProtectionGroupSchedule
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Name
Protection group name.
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Name
Protection group name.
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Get-PfaProtectionGroupSchedule -FlashArray 1.1.1.1 -Name PGROUP1 -Session $MySession
Get-PfaProtectionGroupSnapshotSpace
Lists size and space consumption attributes for a protection group.
Get
PfaProtectionGroupSnapshotSpace
Lists size and space consumption attributes for a protection group.
Get-PfaProtectionGroupSnapshotSpace
FlashArray
A description of the FlashArray parameter.
String
Session
A description of the Session parameter.
WebRequestSession
Name
Protection group name.
SwitchParameter
FlashArray
A description of the FlashArray parameter.
String
String
Name
Protection group name.
SwitchParameter
SwitchParameter
Session
A description of the Session parameter.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Get-PfaProtectionGroupSnapshotSpace -FlashArray 1.1.1.1 -Name PGROUP1 -Session $MySession
Get-PfaProtectionGroupSpace
Displays the total space consumption for a protection group.
Get
PfaProtectionGroupSpace
Displays the total space consumption for a protection group.
Get-PfaProtectionGroupSpace
FlashArray
A description of the FlashArray parameter.
String
Session
A description of the Session parameter.
WebRequestSession
Name
Protection group name.
SwitchParameter
FlashArray
A description of the FlashArray parameter.
String
String
Name
Protection group name.
SwitchParameter
SwitchParameter
Session
A description of the Session parameter.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Get-PfaProtectionGroupSpace -FlashArray 1.1.1.1 -Name PGROUP1 -Session $MySession
Get-PfaProtectionGroupsPending
Includes destroyed protection groups that are in the eradication pending state. Time remaining is displayed in seconds.
Get
PfaProtectionGroupsPending
Includes destroyed protection groups that are in the eradication pending state. Time remaining is displayed in seconds.
Get-PfaProtectionGroupsPending
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Get-PfaProtectionGroupsPending -FlashArray 1.1.1.1 -Session $MySession
Get-PfaProtectionGroupsPendingOnly
Lists destroyed protection groups that are in the eradication pending state. Time remaining is displayed in seconds.
Get
PfaProtectionGroupsPendingOnly
Lists destroyed protection groups that are in the eradication pending state. Time remaining is displayed in seconds.
Get-PfaProtectionGroupsPendingOnly
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Get-PfaProtectionGroupsPendingOnly -FlashArray 1.1.1.1 -Session $MySession
Get-PfaProtectionGroupsRetentionPolicy
Lists protection groups and snapshots created on this array.
Get
PfaProtectionGroupsRetentionPolicy
Lists protection groups and snapshots created on this array.
Get-PfaProtectionGroupsRetentionPolicy
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
Source
Switch to show source. Source and Target are mutually exclusive.
SwitchParameter
Target
Switch to show target. Source and Target are mutually exclusive.
SwitchParameter
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Source
Switch to show source. Source and Target are mutually exclusive.
SwitchParameter
SwitchParameter
Target
Switch to show target. Source and Target are mutually exclusive.
SwitchParameter
SwitchParameter
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Get-PfaProtectionGroupsRetentionPolicy -FlashArray 1.1.1.1 -Session $MySession
-------------------------- EXAMPLE 2 --------------------------
PS C:\>
Get-PfaProtectionGroupsRetentionPolicy -FlashArray 1.1.1.1 -Source -Session $MySession
-------------------------- EXAMPLE 3 --------------------------
PS C:\>
Get-PfaProtectionGroupsRetentionPolicy -FlashArray 1.1.1.1 -Target -Session $MySession
Get-PfaProtectionGroupsSchedule
Displays the snapshot/replication schedule.
Get
PfaProtectionGroupsSchedule
Displays the snapshot/replication schedule.
Get-PfaProtectionGroupsSchedule
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
Source
Switch to show source. Source and Target are mutually exclusive.
SwitchParameter
Target
Switch to show target. Source and Target are mutually exclusive.
SwitchParameter
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Source
Switch to show source. Source and Target are mutually exclusive.
SwitchParameter
SwitchParameter
Target
Switch to show target. Source and Target are mutually exclusive.
SwitchParameter
SwitchParameter
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Get-PfaProtectionGroupsSchedule -FlashArray 1.1.1.1 -Session $MySession
-------------------------- EXAMPLE 2 --------------------------
PS C:\>
Get-PfaProtectionGroupsSchedule -FlashArray 1.1.1.1 -Source -Session $MySession
-------------------------- EXAMPLE 3 --------------------------
PS C:\>
Get-PfaProtectionGroupsSchedule -FlashArray 1.1.1.1 -Target -Session $MySession
Get-PfaProtectionGroupsSnapshots
Lists all snapshots (true).
Get
PfaProtectionGroupsSnapshots
Lists all snapshots (true).
Get-PfaProtectionGroupsSnapshots
FlashArray
A description of the FlashArray parameter.
String
Session
A description of the Session parameter.
WebRequestSession
FlashArray
A description of the FlashArray parameter.
String
String
Session
A description of the Session parameter.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Get-PfaProtectionGroupsSnapshots -FlashArray 1.1.1.1 -Session $MySession
Get-PfaProtectionGroupsSnapshotSpace
Lists size and space consumption attributes for each protection group.
Get
PfaProtectionGroupsSnapshotSpace
Lists size and space consumption attributes for each protection group.
Get-PfaProtectionGroupsSnapshotSpace
FlashArray
A description of the FlashArray parameter.
String
Session
A description of the Session parameter.
WebRequestSession
Source
Switch to show source. Source and Target are mutually exclusive.
SwitchParameter
Target
Switch to show target. Source and Target are mutually exclusive.
SwitchParameter
FlashArray
A description of the FlashArray parameter.
String
String
Source
Switch to show source. Source and Target are mutually exclusive.
SwitchParameter
SwitchParameter
Target
Switch to show target. Source and Target are mutually exclusive.
SwitchParameter
SwitchParameter
Session
A description of the Session parameter.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Get-PfaProtectionGroupsSnapshotSpace -FlashArray 1.1.1.1 -Session $MySession
-------------------------- EXAMPLE 2 --------------------------
PS C:\>
Get-PfaProtectionGroupsSnapshotSpace -FlashArray 1.1.1.1 -Source -Session $MySession
-------------------------- EXAMPLE 3 --------------------------
PS C:\>
Get-PfaProtectionGroupsSnapshotSpace -FlashArray 1.1.1.1 -Target -Session $MySession
Get-PfaProtectionGroupsSpace
Displays the total space consumption for all protection groups.
Get
PfaProtectionGroupsSpace
Displays the total space consumption for all protection groups.
Get-PfaProtectionGroupsSpace
FlashArray
A description of the FlashArray parameter.
String
Session
A description of the Session parameter.
WebRequestSession
Source
Switch to show source. Source and Target are mutually exclusive.
SwitchParameter
Target
Switch to show target. Source and Target are mutually exclusive.
SwitchParameter
FlashArray
A description of the FlashArray parameter.
String
String
Source
Switch to show source. Source and Target are mutually exclusive.
SwitchParameter
SwitchParameter
Target
Switch to show target. Source and Target are mutually exclusive.
SwitchParameter
SwitchParameter
Session
A description of the Session parameter.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Get-PfaProtectionGroupsSpace -FlashArray 1.1.1.1 -Session $MySession
-------------------------- EXAMPLE 2 --------------------------
PS C:\>
Get-PfaProtectionGroupsSpace -FlashArray 1.1.1.1 -Source -Session $MySession
-------------------------- EXAMPLE 3 --------------------------
PS C:\>
Get-PfaProtectionGroupsSpace -FlashArray 1.1.1.1 -Target -Session $MySession
Get-PfaProtectionGroupsTransferStatisics
Used with the snap parameter to display (true) replication data transfer statistics, including data
transfer start time, data transfer end time, data transfer progress, and amount of logical/physical
data transferred.
Get
PfaProtectionGroupsTransferStatisics
Used with the snap parameter to display (true) replication data transfer statistics, including data
transfer start time, data transfer end time, data transfer progress, and amount of logical/physical
data transferred.
Get-PfaProtectionGroupsTransferStatisics
FlashArray
A description of the FlashArray parameter.
String
Session
A description of the Session parameter.
WebRequestSession
FlashArray
A description of the FlashArray parameter.
String
String
Session
A description of the Session parameter.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Get-PfaProtectionGroupsTransferStatisics -FlashArray 1.1.1.1 -Session $MySession
Get-PfaProtectionGroupTransferStatisics
Used with the snap parameter to display (true) replication data transfer statistics, including data
transfer start time, data transfer end time, data transfer progress, and amount of logical/physical
data transferred.
Get
PfaProtectionGroupTransferStatisics
Used with the snap parameter to display (true) replication data transfer statistics, including data
transfer start time, data transfer end time, data transfer progress, and amount of logical/physical
data transferred.
Get-PfaProtectionGroupTransferStatisics
FlashArray
A description of the FlashArray parameter.
String
Name
Protection group name.
String
Session
A description of the Session parameter.
WebRequestSession
FlashArray
A description of the FlashArray parameter.
String
String
Name
Protection group name.
String
String
Session
A description of the Session parameter.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Get-PfaProtectionGroupTransferStatisics -FlashArray 1.1.1.1 -Name PGROUP1 -Session $MySession
Get-PfaRemoteAssist
Lists information about the status (enabled or disabled) of a remote assist session.
Get
PfaRemoteAssist
Lists information about the status (enabled or disabled) of a remote assist session.
Get-PfaRemoteAssist
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Get-PfaRemoteAssist -FlashArray 1.1.1.1 -Session $MySession
Get-PfaShadowCopy
Get-PfaShadowCopy [-ScriptName] <string> [-MetadataFile] <string> [-ShadowCopyAlias] <string> [-ExposeAs] <string> [<CommonParameters>]
Get
PfaShadowCopy
Get-PfaShadowCopy
ScriptName
String
MetadataFile
String
ShadowCopyAlias
String
ExposeAs
String
ScriptName
String
String
MetadataFile
String
String
ShadowCopyAlias
String
String
ExposeAs
String
String
Get-PfaSnapshots
Lists all snapshots (true).
Get
PfaSnapshots
Lists all snapshots (true).
Get-PfaSnapshots
FlashArray
A description of the FlashArray parameter.
String
Session
A description of the Session parameter.
WebRequestSession
FlashArray
A description of the FlashArray parameter.
String
String
Session
A description of the Session parameter.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Get-PfaSnapshots -FlashArray 1.1.1.1 -Session $MySession
Get-PfaSnmp
Get-PfaSnmp [-FlashArray] <string> [-Session] <WebRequestSession> [-EngineId] [<CommonParameters>]
Get
PfaSnmp
Get-PfaSnmp
FlashArray
String
Session
WebRequestSession
EngineId
SwitchParameter
FlashArray
String
String
EngineId
SwitchParameter
SwitchParameter
Session
WebRequestSession
WebRequestSession
Get-PfaSnmpManager
Lists communication and security attributes for the specified SNMP manager.
Get
PfaSnmpManager
Lists communication and security attributes for the specified SNMP manager.
Get-PfaSnmpManager
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Manager
Name of the SNMP manager.
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Manager
Name of the SNMP manager.
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Get-PfaSnmpManager -FlashArray 1.1.1.1 -Manager SNMPMANAGER -Session $MySession
Get-PfaSpace
Retrieves usable physical storage information.
Get
PfaSpace
Displays the amount of usable physical storage on the array and the amount of storage occupied
by data and metadata.
Get-PfaSpace
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Get-PfaSpace -FlashArray 1.1.1.1 -Session $MySession
Get-PfaSslCert
Get-PfaSslCert [-FlashArray] <string> [-Session] <WebRequestSession> [<CommonParameters>]
Get
PfaSslCert
Get-PfaSslCert
FlashArray
String
Session
WebRequestSession
FlashArray
String
String
Session
WebRequestSession
WebRequestSession
Get-PfaUser
Lists public key and API token information for all users.
Get
PfaUser
Lists public key and API token information for all users.
Get-PfaUser
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Show
API_Token: Displays a list of users that have REST API access and the dates in which the API tokens were created.
Public_Key: Displays a list of users that have public key access.
String
User
Lists public key or API token information for the specified user.
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Show
API_Token: Displays a list of users that have REST API access and the dates in which the API tokens were created.
Public_Key: Displays a list of users that have public key access.
String
String
User
Lists public key or API token information for the specified user.
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Get-PfaAdmin -FlashArray 1.1.1.1 -Show API_Token -Session $MySession
-------------------------- EXAMPLE 2 --------------------------
PS C:\>
Get-PfaAdmin -FlashArray 1.1.1.1 -Show API_Token -User pureuser -Session $MySession
Get-PfaUsers
Get-PfaUsers [-FlashArray] <string> [-Show] <string> [-Session] <WebRequestSession> [<CommonParameters>]
Get
PfaUsers
Get-PfaUsers
FlashArray
String
Show
String
Session
WebRequestSession
FlashArray
String
String
Show
String
String
Session
WebRequestSession
WebRequestSession
Get-PfaVolume
Lists specific volume.
Get
PfaVolume
Lists specific volume.
Get-PfaVolume
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Name
Volume name.
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Name
Volume name.
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Get-PfaVolume -FlashArray 1.1.1.1 -Name Volume1 -Session $MySession
Get-PfaVolumeDiff
Lists block differences for the specified volume.
Get
PfaVolumeDiff
Lists block differences for the specified volume.
Get-PfaVolumeDiff
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Name
Volume or snapshot name to be used as the base for the diff. If a base volume or snapshot is not
specified, all mapped blocks for the volume are returned.
String
BlockSize
Granularity, in bytes, at which to compare.
String
Length
Length of the region, in bytes, to compare.
String
Offset
Absolute offset, in bytes, of the region to compare. Must be a multiple of block_size.
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Name
Volume or snapshot name to be used as the base for the diff. If a base volume or snapshot is not
specified, all mapped blocks for the volume are returned.
String
String
BlockSize
Granularity, in bytes, at which to compare.
String
String
Length
Length of the region, in bytes, to compare.
String
String
Offset
Absolute offset, in bytes, of the region to compare. Must be a multiple of block_size.
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Get-PfaVolumePrivateConnections -FlashArray 1.1.1.1 -Name Volume1 -Session $MySession
Get-PfaVolumePrivateConnections
Lists private connections for a specific volume.
Get
PfaVolumePrivateConnections
Lists private connections for a specific volume.
Get-PfaVolumePrivateConnections
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Name
Volume name.
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Name
Volume name.
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Get-PfaVolumePrivateConnections -FlashArray 1.1.1.1 -Name Volume1 -Session $MySession
Get-PfaVolumes
Get-PfaVolumes [-FlashArray] <string> [-Session] <WebRequestSession> [<CommonParameters>]
Get
PfaVolumes
Get-PfaVolumes
FlashArray
String
Session
WebRequestSession
FlashArray
String
String
Session
WebRequestSession
WebRequestSession
Get-PfaVolumeSharedConnections
Lists shared connections for a specific volume.
Get
PfaVolumeSharedConnections
Lists shared connections for a specific volume.
Get-PfaVolumeSharedConnections
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Name
Volume name.
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Name
Volume name.
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Get-PfaVolumeSharedConnections -FlashArray 1.1.1.1 -Name Volume1 -Session $MySession
Get-PfaVolumeSnapshots
Lists specific volume snapshots.
Get
PfaVolumeSnapshots
Lists specific volume snapshots.
Get-PfaVolumeSnapshots
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Name
Volume name.
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Name
Volume name.
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Get-PfaVolumeSnapshots -FlashArray 1.1.1.1 -Name Volume1 -Session $MySession
Get-PfaVolumeSpace
Lists specific volume space information.
Get
PfaVolumeSpace
Lists specific volume space information.
Get-PfaVolumeSpace
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Name
Volume name.
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Name
Volume name.
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Get-PfaVolumeSpace -FlashArray 1.1.1.1 -Name Volume1 -Session $MySession
Get-PfaVolumesSpace
Lists size and space consumption attributes for each volume.
Get
PfaVolumesSpace
Lists size and space consumption attributes for each volume.
Get-PfaVolumesSpace
FlashArray
A description of the FlashArray parameter.
String
Session
A description of the Session parameter.
WebRequestSession
FlashArray
A description of the FlashArray parameter.
String
String
Session
A description of the Session parameter.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Get-PfaVolumeSpace -FlashArray 1.1.1.1 -Session $MySession
Get-WindowsPowerScheme
Retrieve the currently active Windows Server power scheme.
Get
WindowsPowerScheme
Determine what the current Windows Server power scheme that is being used to ensure the host
is optimally configured for performance.
Get-WindowsPowerScheme
ComputerName
String
ComputerName
String
String
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Get-WindowsPowerScheme
Hide-PfaMessage
Unflags a message.
Hide
PfaMessage
Unflags (false) a message.
Hide-PfaMessage
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Id
Unflags a message.
String
Session
Pure Storage FlashArray session created with Connect-PfaController.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Id
Unflags a message.
String
String
Session
Pure Storage FlashArray session created with Connect-PfaController.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Hide-PfaMessage -FlashArray 1.1.1.1 -Id 25680 -Session $S
New-PfaAlertRecipient
Lists information about the specified email recipient.
New
PfaAlertRecipient
Lists information about the specified email recipient.
New-PfaAlertRecipient
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Email
Email recipient to add.
String
Session
Pure Storage FlashArray session created with Connect-PfaController.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Email
Email recipient to add.
String
String
Session
Pure Storage FlashArray session created with Connect-PfaController.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Get-PfaAlertRecipient -FlashArray 1.1.1.1 -Email test@test.com -Session $S
New-PfaApiToken
Creates an API token for the specified user.
New
PfaApiToken
Creates an API token for the specified user.
New-PfaApiToken
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
User
Lists public key or API token information for the specified user.
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
User
Lists public key or API token information for the specified user.
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
New-PfaApiToken -FlashArray 1.1.1.1 -User NEWUSER -Session $MySession
New-PfaConnection
Creates a new connection to a target array.
New
PfaConnection
Creates a new connection to a target array.
New-PfaConnection
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
ManagementAddress
String
ConnectionKey
The connection_key of the array to be connected.
String
ReplicationAddress
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
ManagementAddress
String
String
ConnectionKey
The connection_key of the array to be connected.
String
String
ReplicationAddress
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
New-PfaConnection -FlashArray 1.1.1.1 -TargetFlashArray 2.2.2.2 -ConnectionKey <Key> -ReplicationAddress 3.3.3.3 -Session $MySession
New-PfaHost
New-PfaHost [-FlashArray] <string> [-Name] <string> [[-IQNList] <string>] [[-WWNList] <string[]>] [-Session] <WebRequestSession> [<CommonParameters>]
New
PfaHost
New-PfaHost
FlashArray
String
Name
String
IQNList
String
WWNList
String[]
Session
WebRequestSession
FlashArray
String
String
Name
String
String
IQNList
String
String
WWNList
String[]
String[]
Session
WebRequestSession
WebRequestSession
New-PfaHostGroup
Creates a host group with the specified name.
New
PfaHostGroup
Creates a host group with the specified name.
New-PfaHostGroup
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Name
Name of host group to create.
String
HostList
String[]
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Name
Name of host group to create.
String
String
HostList
String[]
String[]
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
New-PfaHost -FlashArray 1.1.1.1 -Name HOSTGROUP1 -Session $MySession
-------------------------- EXAMPLE 2 --------------------------
PS C:\>
New-PfaHost -FlashArray 1.1.1.1 -Name HOSTGROUP1 -HostList HOSTA,HOSTB,HOSTC,HOSTD -Session $MySession
New-PfaProtectionGroup
Creates a new snapshot of a Pure Storage Protection Group(s).
New
PfaProtectionGroup
The New-PfaProtectionGroupSnapshot creates a new snapshot of the host, host group or volumes
that are part of a Protection Group. Assumes that the apply_retention will be used for all snapshots.
New-PfaProtectionGroup
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Name
Protection group name.
String
HostGroups
List of one or more host groups to be included in the new protection group.
String[]
Hosts
List of one or more hosts to be included in the new protection group.
String[]
Volumes
List of one or more volumes to be included in the new protection group.
String[]
ReplicationTargets
List of one or more targets to be included in the new protection group.
String[]
Session
Pure Storage FlashArray session created with Connect-PfaController.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Name
Protection group name.
String
String
HostGroups
List of one or more host groups to be included in the new protection group.
String[]
String[]
Hosts
List of one or more hosts to be included in the new protection group.
String[]
String[]
Volumes
List of one or more volumes to be included in the new protection group.
String[]
String[]
ReplicationTargets
List of one or more targets to be included in the new protection group.
String[]
String[]
Session
Pure Storage FlashArray session created with Connect-PfaController.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
New-PfaProtectionGroup -FlashArray 1.1.1.1 -Name TESTGROUP -HostGroups HG1,HG2 -Session $S
-------------------------- EXAMPLE 2 --------------------------
PS C:\>
New-PfaProtectionGroup -FlashArray 1.1.1.1 -Name TESTGROUP -Hosts HOST1,HOST2,HOST3 -Session $S
-------------------------- EXAMPLE 3 --------------------------
PS C:\>
New-PfaProtectionGroup -FlashArray 1.1.1.1 -Name TESTGROUP -Volumes VOL1,VOl2,VOL3,VOL4,VOL5 -Session $S
-------------------------- EXAMPLE 4 --------------------------
PS C:\>
New-PfaProtectionGroup -FlashArray 1.1.1.1 -Name TESTGROUP -Volumes VOL1,VOl2,VOL3,VOL4,VOL5 -ReplicationTargets ARRAY2 -Session $S
New-PfaProtectionGroupSnapshot
Creates a new snapshot of a Pure Storage Protection Group(s).
New
PfaProtectionGroupSnapshot
The New-PfaProtectionGroupSnapshot creates a new snapshot of the host, host group or volumes
that are part of a Protection Group. Assumes that the apply_retention will be used for all snapshots.
New-PfaProtectionGroupSnapshot
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
ProtectionGroupName
String
SnapshotSuffix
String
Session
Pure Storage FlashArray session created with Connect-PfaController.
WebRequestSession
ReplicateNow
Replicates this snapshot to all target arrays.
SwitchParameter
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
ProtectionGroupName
String
String
SnapshotSuffix
String
String
ReplicateNow
Replicates this snapshot to all target arrays.
SwitchParameter
SwitchParameter
Session
Pure Storage FlashArray session created with Connect-PfaController.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
New-PfaProtectionGroupSnapshot -FlashArray 1.1.1.1 -Name TESTGROUP -SnapshotSuffix TEST -ReplicateNow -Session $S
-------------------------- EXAMPLE 2 --------------------------
PS C:\>
New-PfaProtectionGroupSnapshot -FlashArray 1.1.1.1 -Name TESTGROUP -ReplicateNow -Session $S
New-PfaShadowCopy
Initiate a new Microsoft Volume Shadow Copy Service (VSS) snapshot.
New
PfaShadowCopy
The New-PfaShadowCopy cmdlet uses Microsoft Diskshadow utility to initiate a volume shadow
copy service snapshot using the Pure Storage VSS Hardware Provider. The GUID for the Pure
Storage VSS Provider is {781c006a-5829-4a25-81e3-d5e43bd005ab} and should be used to ensure
that the proper provider is used. These cmdlets are meant to be examples of automating
Diskshadow through Windows PowerShell, these examples can be enhanced to support greater
flexibility and more complicated use cases.
New-PfaShadowCopy
Volume
Identification of the Pure Storage volume that needs to be quiesced. Eg. F:
String[]
ScriptName
Assigned name of the script that will be autogenerated. Default is PUREVSS-SNAP.
String
MetadataFile
The metadata file (.cab) created during a backup operation which contains the details about the volume shadow copy.
String
ShadowCopyAlias
A simple name to alias the Shadow Copy ID.
String
VerboseMode
Display all executed details for the volume shadow copy service operations.
String
Volume
Identification of the Pure Storage volume that needs to be quiesced. Eg. F:
String[]
String[]
ScriptName
Assigned name of the script that will be autogenerated. Default is PUREVSS-SNAP.
String
String
MetadataFile
The metadata file (.cab) created during a backup operation which contains the details about the volume shadow copy.
String
String
ShadowCopyAlias
A simple name to alias the Shadow Copy ID.
String
String
VerboseMode
Display all executed details for the volume shadow copy service operations.
String
String
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
New-PfaShadowCopy -Volume VOLUME1 -Scriptname MyScript -MetadataFile SampleMetadata -ShadowCopyAlias SampleAlias -VerboseMode On
New-PfaSnapshot
Creates a volume or copies a volume or snapshot. Either the size or source parameter must be specified.
New
PfaSnapshot
Creates a volume or copies a volume or snapshot. Either the size or source parameter must be specified.
New-PfaSnapshot
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Volumes
One or more volume name(s) separated by commas.
String[]
Suffix
Specify a custom suffix that is added to the snapshot name.
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Volumes
One or more volume name(s) separated by commas.
String[]
String[]
Suffix
Specify a custom suffix that is added to the snapshot name.
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
New-PfaVolume -FlashArray 1.1.1.1 -Name Volume1 -Suffix TEST -Session $MySession
-------------------------- EXAMPLE 2 --------------------------
PS C:\>
New-PfaVolume -FlashArray 1.1.1.1 -Name Volume1, Volume2, Volume3, Volume4 -Suffix TEST -Session $MySession
New-PfaSnmpv2cManager
Creates a Purity SNMP manager object that identifies a host (SNMP manager) and specifies the protocol
attributes for communicating with it.
New
PfaSnmpv2cManager
Creates a Purity SNMP manager object that identifies a host (SNMP manager) and specifies the protocol
attributes for communicating with it.
Once a manager object is created, the transmission of SNMP traps is immediately enabled.
New-PfaSnmpv2cManager
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Manager
Name of the SNMP manager.
String
Hostname
DNS hostname or IP address of a computer that hosts an SNMP manager to which Purity is to send trap
messages when it generates alerts.
String
Community
SNMP v2c only. Manager community ID under which Purity is to communicate with the specified managers.
The value must be between 1 and 32 characters in length and from the set {[A-Z], [a-z], [0-9],
_ (underscore), and - (hyphen)}.
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Manager
Name of the SNMP manager.
String
String
Hostname
DNS hostname or IP address of a computer that hosts an SNMP manager to which Purity is to send trap
messages when it generates alerts.
String
String
Community
SNMP v2c only. Manager community ID under which Purity is to communicate with the specified managers.
The value must be between 1 and 32 characters in length and from the set {[A-Z], [a-z], [0-9],
_ (underscore), and - (hyphen)}.
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
New-PfaSnmpv2cManager -FlashArray 1.1.1.1 -Session $S
New-PfaSnmpv3Manager
Creates a Purity SNMP manager object that identifies a host (SNMP manager) and specifies the protocol
attributes for communicating with it.
New
PfaSnmpv3Manager
Creates a Purity SNMP manager object that identifies a host (SNMP manager) and specifies the protocol
attributes for communicating with it.
Once a manager object is created, the transmission of SNMP traps is immediately enabled.
New-PfaSnmpv3Manager
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Manager
Name of the SNMP manager.
String
Hostname
DNS hostname or IP address of a computer that hosts an SNMP manager to which Purity is to send trap
messages when it generates alerts.
String
User
SNMP v3 only. User ID recognized by the specified SNMP managers which Purity is to use in communications
with them. The value must be between 1 and 32 characters in length and from the set {[A-Z], [a-z], [0-9],
_ (underscore), and -(hyphen)}.
String
AuthProtocol
SNMP v3 only. Hash algorithm used to validate the authentication passphrase. Valid values are MD5 or SHA.
String
AuthPassphrase
SNMP v3 only. Passphrase used by Purity to authenticate the array with the specified managers. The value
must be between 1 and 32 characters in length and from the set {[A-Z], [a-z], [0-9], _ (underscore),
and - (hyphen)}.
String
PrivacyProtocol
SNMP v3 only. Passphrase used to encrypt SNMP messages. The value must be between 8 and 63 non-space
ASCII characters in length.
String
PrivacyPassphrase
SNMP v3 only. Encryption protocol for SNMP messages. Valid values are AES or DES.
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Manager
Name of the SNMP manager.
String
String
Hostname
DNS hostname or IP address of a computer that hosts an SNMP manager to which Purity is to send trap
messages when it generates alerts.
String
String
User
SNMP v3 only. User ID recognized by the specified SNMP managers which Purity is to use in communications
with them. The value must be between 1 and 32 characters in length and from the set {[A-Z], [a-z], [0-9],
_ (underscore), and -(hyphen)}.
String
String
AuthProtocol
SNMP v3 only. Hash algorithm used to validate the authentication passphrase. Valid values are MD5 or SHA.
String
String
AuthPassphrase
SNMP v3 only. Passphrase used by Purity to authenticate the array with the specified managers. The value
must be between 1 and 32 characters in length and from the set {[A-Z], [a-z], [0-9], _ (underscore),
and - (hyphen)}.
String
String
PrivacyProtocol
SNMP v3 only. Passphrase used to encrypt SNMP messages. The value must be between 8 and 63 non-space
ASCII characters in length.
String
String
PrivacyPassphrase
SNMP v3 only. Encryption protocol for SNMP messages. Valid values are AES or DES.
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
New-PfaSnmpv3Manager -FlashArray 1.1.1.1 -Manager TEST -Hostname TEST1 -User Administrator -AuthProtocol MD5 -AuthPassphrase TESTPHRASE -PrivacyProtocol AES -PrivacyPassphrase TESTPHRASE -Session $S
New-PfaVolume
Creates a volume or copies a volume or snapshot. Either the size or source parameter must be specified.
New
PfaVolume
Creates a volume or copies a volume or snapshot. Either the size or source parameter must be specified.
New-PfaVolume
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Name
Volume name.
String
Size
Creates a volume with the specified provisioned size.
Enter the size as a number (bytes) or as a string with a single character unit symbol. Valid
unit symbols are S, K, M, G, T, P, denoting 512-byte sectors, KiB, MiB, GiB, TiB, and PiB respectively.
"Ki" denotes 2^10, "Mi" denotes 2^20, and so on. If the unit symbol is not specified, the unit defaults
to sectors.
String
Source
Creates a new volume from a snapshot as the source.
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Name
Volume name.
String
String
Size
Creates a volume with the specified provisioned size.
Enter the size as a number (bytes) or as a string with a single character unit symbol. Valid
unit symbols are S, K, M, G, T, P, denoting 512-byte sectors, KiB, MiB, GiB, TiB, and PiB respectively.
"Ki" denotes 2^10, "Mi" denotes 2^20, and so on. If the unit symbol is not specified, the unit defaults
to sectors.
String
String
Source
Creates a new volume from a snapshot as the source.
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
New-PfaVolume -FlashArray 1.1.1.1 -Name Volume1 -Size 100G -Session $MySession
-------------------------- EXAMPLE 2 --------------------------
PS C:\>
New-PfaVolume -FlashArray 1.1.1.1 -Name Volume1 -Source Volume2.Snapshot -Session $MySession
Open-PureStorageGitHub
Open-PureStorageGitHub
Open
PureStorageGitHub
Open-PureStorageGitHub
Refresh-PfaVolume
Overwrites an existing volume.
Refresh
PfaVolume
Overwrites an existing volume.
Refresh-PfaVolume
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Name
Volume name.
String
Source
Creates a new volume from a snapshot as the source.
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Name
Volume name.
String
String
Source
Creates a new volume from a snapshot as the source.
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Refresh-PfaVolume -FlashArray 1.1.1.1 -Name Volume1 -Source Volume2.Snapshot -Session $MySession
Register-PfaHostVolumes
Rescans host for newly attached Pure Storage volumes.
Register
PfaHostVolumes
Rescans host for newly attached Pure Storage volumes.
Register-PfaHostVolumes
Computername
String
Computername
String
String
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Register-PureStorageVolumes -ComputerName MyServer
Remove-PfaAlertRecipient
Deletes an email address from the list of addresses designated to receive Purity alert messages.
You cannot delete the built-in flasharray-alerts@purestorage.com address.
Remove
PfaAlertRecipient
Deletes an email address from the list of addresses designated to receive Purity alert messages.
You cannot delete the built-in flasharray-alerts@purestorage.com address.
Remove-PfaAlertRecipient
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Email
Email recipient to add.
String
Session
Pure Storage FlashArray session created with Connect-PfaController.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Email
Email recipient to add.
String
String
Session
Pure Storage FlashArray session created with Connect-PfaController.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Remove-PfaAlertRecipient -FlashArray 1.1.1.1 -Email test@test.com -Session $S
Remove-PfaApiToken
Deletes API token for the specified user.
Remove
PfaApiToken
Deletes API token for the specified user.
Remove-PfaApiToken
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
User
User to remove the API token.
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
User
User to remove the API token.
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Remove-PfaApiToken -FlashArray 1.1.1.1 -User NEWUSER -Session $MySession
Remove-PfaConnection
Removes a connection to a target array.
Remove
PfaConnection
Removes a new connection to a target array.
Remove-PfaConnection
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Name
The address of the array to be disconnected.
String
Session
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Name
The address of the array to be disconnected.
String
String
Session
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Remove-PfaConnection -FlashArray 1.1.1.1 -Name DEMOARRAY -Session $MySession
Remove-PfaHost
Destroys the specified host.
Remove
PfaHost
Destroys the specified host.
Remove-PfaHost
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Name
Host name.
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Name
Host name.
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Remove-PfaHost -FlashArray 1.1.1.1 -Name HOST1 -Session $MySession
Remove-PfaHostGroup
Remove host group.
Remove
PfaHostGroup
Remove host group.
Remove-PfaHostGroup
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Name
Name of host group to remove.
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Name
Name of host group to remove.
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Remove-PfaHostGroup -FlashArray 1.1.1.1 -Name HOSTGROUP1 -Session $MySession
Remove-PfaHostGroupHosts
Removes host members of the host group.
Remove
PfaHostGroupHosts
Removes host members of the host group.
Remove-PfaHostGroupHosts
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Name
Name of host group to create.
String
HostList
Removes list of hosts from the existing list.
String[]
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Name
Name of host group to create.
String
String
HostList
Removes list of hosts from the existing list.
String[]
String[]
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Remove-PfaHostGroupHosts -FlashArray 1.1.1.1 -Name HOSTGROUP1 -HostList HOSTA,HOSTB,HOSTC,HOSTD -Session $MySession
Remove-PfaProtectionGroup
Destroys the specified protection group and all of its snapshots.
Remove
PfaProtectionGroup
Destroys the specified protection group and all of its snapshots.
Remove-PfaProtectionGroup
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Name
Protection group name.
String
Session
Pure Storage FlashArray session created with Connect-PfaController.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Name
Protection group name.
String
String
Session
Pure Storage FlashArray session created with Connect-PfaController.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Remove-PfaProtectionGroup -FlashArray 1.1.1.1 -Name TESTGROUP -Session $S
Remove-PfaProtectionGroupMembers
Removes a members (HostGroups, Hosts, Volumes or Replication Targets from the existing list.
Remove
PfaProtectionGroupMembers
Removes a members (HostGroups, Hosts, Volumes or Replication Targets from the existing list.
Remove-PfaProtectionGroupMembers
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Name
Protection group name.
String
HostGroups
Remove one or more host groups to be included in the new protection group.
String[]
Hosts
Remove one or more hosts to be included in the new protection group.
String[]
Volumes
Remove one or more volumes to be included in the new protection group.
String[]
ReplicationTargets
Remove one or more targets to be included in the new protection group.
String[]
Session
Pure Storage FlashArray session created with Connect-PfaController.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Name
Protection group name.
String
String
HostGroups
Remove one or more host groups to be included in the new protection group.
String[]
String[]
Hosts
Remove one or more hosts to be included in the new protection group.
String[]
String[]
Volumes
Remove one or more volumes to be included in the new protection group.
String[]
String[]
ReplicationTargets
Remove one or more targets to be included in the new protection group.
String[]
String[]
Session
Pure Storage FlashArray session created with Connect-PfaController.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Add-PfaProtectionGroupMembers -FlashArray 1.1.1.1 -Name TESTGROUP -HostGroups HG1,HG2 -Session $S
Remove-PfaProtectionGroupSnapshots
Destroys the specified protection group snapshot(s).
Remove
PfaProtectionGroupSnapshots
Destroys the specified protection group snapshot(s).
Remove-PfaProtectionGroupSnapshots
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Name
Protection group name.
String[]
Session
Pure Storage FlashArray session created with Connect-PfaController.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Name
Protection group name.
String[]
String[]
Session
Pure Storage FlashArray session created with Connect-PfaController.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Remove-PfaProtectionGroupSnapshots -FlashArray 1.1.1.1 -Name TESTGROUP.SNAPSHOT -Session $S
Remove-PfaSnapshot
Destroys the specified snapshot.
Remove
PfaSnapshot
Destroys the specified snapshot.
Remove-PfaSnapshot
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Name
Snapshot name.
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Name
Snapshot name.
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Remove-PfaSnapshot -FlashArray 1.1.1.1 -Name Volume1.Snapshot -Session $MySession
Remove-PfaSnmpManager
Stops communication with the specified managers and deletes the SNMP manager object.
Remove
PfaSnmpManager
Stops communication with the specified managers and deletes the SNMP manager object.
Remove-PfaSnmpManager
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
Manager
SNMP v3 only. If set to true, displays the SNMP v3 engine ID generated by Purity for the array.
SwitchParameter
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Manager
SNMP v3 only. If set to true, displays the SNMP v3 engine ID generated by Purity for the array.
SwitchParameter
SwitchParameter
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Remove-PfaSnmpManager -FlashArray 1.1.1.1 -Session $MySession
Remove-PfaVolume
Destroys the specified volume or snapshot.
Remove
PfaVolume
Destroys the specified volume or snapshot.
Remove-PfaVolume
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Name
Volume name.
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Name
Volume name.
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Remove-PfaVolume -FlashArray 1.1.1.1 -Name Volume1 -Session $MySession
Rename-PfaHostGroup
Rename host group.
Rename
PfaHostGroup
Rename host group.
Rename-PfaHostGroup
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Name
Name of host group to rename.
String
NewName
New name of host group.
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Name
Name of host group to rename.
String
String
NewName
New name of host group.
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Rename-PfaHostGroup -FlashArray 1.1.1.1 -Name HOSTGROUP1 -HostList HOSTA,HOSTB,HOSTC,HOSTD -Session $MySession
Rename-PfaProtectionGroup
Renames a protection group.
Rename
PfaProtectionGroup
Renames a protection group.
Rename-PfaProtectionGroup
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Name
Current protection group name.
String
NewName
New protection group name.
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Name
Current protection group name.
String
String
NewName
New protection group name.
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Rename-PfaProtectionGroup -FlashArray 1.1.1.1 -Name Volume1 -Session $MySession
-------------------------- EXAMPLE 2 --------------------------
PS C:\>
Rename-PfaProtectionGroup -FlashArray 1.1.1.1 -Name Volume1 -Session $MySession
Rename-PfaVolume
Renames the specified volume.
Rename
PfaVolume
Renames the specified volume.
Rename-PfaVolume
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
CurrentName
Current name of volume to rename.
String
NewName
Current name of volume to rename.
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
CurrentName
Current name of volume to rename.
String
String
NewName
Current name of volume to rename.
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Rename-PfaVolume -FlashArray 1.1.1.1 -CurrentName Volume1 -NewName Volume9 -Session $MySession
Resize-PfaVolume
Resizes a volume.
Resize
PfaVolume
Resizes a volume.
Resize-PfaVolume
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Name
Volume name.
String
Size
Creates a volume with the specified provisioned size.
Enter the size as a number (bytes) or as a string with a single character unit symbol. Valid
unit symbols are S, K, M, G, T, P, denoting 512-byte sectors, KiB, MiB, GiB, TiB, and PiB respectively.
"Ki" denotes 2^10, "Mi" denotes 2^20, and so on. If the unit symbol is not specified, the unit defaults
to sectors.
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
Truncate
This is a switch setting to use when resizing a volume that requires truncation.
SwitchParameter
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Name
Volume name.
String
String
Size
Creates a volume with the specified provisioned size.
Enter the size as a number (bytes) or as a string with a single character unit symbol. Valid
unit symbols are S, K, M, G, T, P, denoting 512-byte sectors, KiB, MiB, GiB, TiB, and PiB respectively.
"Ki" denotes 2^10, "Mi" denotes 2^20, and so on. If the unit symbol is not specified, the unit defaults
to sectors.
String
String
Truncate
This is a switch setting to use when resizing a volume that requires truncation.
SwitchParameter
SwitchParameter
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Resize-PfaVolume -FlashArray 1.1.1.1 -Name Volume1 -Size 100G -Session $MySession
-------------------------- EXAMPLE 2 --------------------------
PS C:\>
Resize-PfaVolume -FlashArray 1.1.1.1 -Name Volume1 -Size 50G -Truncate -Session $MySession
Restore-PfaProtectionGroup
Recovers the contents of the specified volume. Set the parameter to recover.
Restore
PfaProtectionGroup
Recovers the contents of the specified volume. Set the parameter to recover.
Restore-PfaProtectionGroup
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Name
Volume name.
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Name
Volume name.
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Restore-PfaProtectionGroup -FlashArray 1.1.1.1 -Name Volume1 -Size 100G -Session $MySession
-------------------------- EXAMPLE 2 --------------------------
PS C:\>
Restore-PfaProtectionGroup -FlashArray 1.1.1.1 -Name Volume1 -Source Volume2.Snapshot -Session $MySession
Restore-PfaProtectionGroupSnapshots
Recovers the contents of the specified volume. Set the parameter to recover.
Restore
PfaProtectionGroupSnapshots
Recovers the contents of the specified volume. Set the parameter to recover.
Restore-PfaProtectionGroupSnapshots
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Name
Volume name.
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Name
Volume name.
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Restore-PfaProtectionGroupSnapshots -FlashArray 1.1.1.1 -Name Volume1 -Size 100G -Session $MySession
-------------------------- EXAMPLE 2 --------------------------
PS C:\>
Restore-PfaProtectionGroupSnapshots -FlashArray 1.1.1.1 -Name Volume1 -Source Volume2.Snapshot -Session $MySession
Restore-PfaProtectionGroupVolumeSnapshots
Creates a volume or copies a volume or snapshot. Either the size or source parameter must be specified.
Restore
PfaProtectionGroupVolumeSnapshots
Creates a volume or copies a volume or snapshot. Either the size or source parameter must be specified.
Restore-PfaProtectionGroupVolumeSnapshots
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
ProtectionGroup
String
SnapshotName
String
Prefix
String
Hostname
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
ProtectionGroup
String
String
SnapshotName
String
String
Prefix
String
String
Hostname
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
New-PfaVolume -FlashArray 1.1.1.1 -Name Volume1 -Size 100G -Session $MySession
-------------------------- EXAMPLE 2 --------------------------
PS C:\>
New-PfaVolume -FlashArray 1.1.1.1 -Name Volume1 -Source Volume2.Snapshot -Session $MySession
Restore-PfaProtectionGroupVolumeSnapshots –FlashArray $FA `
–ProtectionGroup "CS-PERF-PURE-02:LT" `
–VolumeSnaphots "CS-PERF-PURE-02:LT.2" `
–Prefix TEST `
–Session $FASession
Restore-PfaSnapshot
Recovers the contents of the specified volume. Set the parameter to recover.
Restore
PfaSnapshot
Recovers the contents of the specified volume. Set the parameter to recover.
Restore-PfaSnapshot
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Name
Volume name.
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Name
Volume name.
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Restore-PfaSnapshot -FlashArray 1.1.1.1 -Name Volume1 -Session $MySession
Restore-PfaVolume
Recovers the contents of the specified volume. Set the parameter to recover.
Restore
PfaVolume
Recovers the contents of the specified volume. Set the parameter to recover.
Restore-PfaVolume
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Name
Volume name.
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Name
Volume name.
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Restore-PfaVolume -FlashArray 1.1.1.1 -Name Volume1 -Session $MySession
Send-PfaPhonehomeLogs
Transmits event logs stored in the array to the Pure Storage Support team via the phonehome channel.
Send
PfaPhonehomeLogs
Transmits event logs stored in the array to the Pure Storage Support team via the phonehome channel. Specify the
phonehome log time period as any of the following: send_all, send_today, send_yesterday, cancel.
Send-PfaPhonehomeLogs
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
TimePeriod
Specify the phonehome log time period as any of the following: send_all, send_today, send_yesterday, cancel.
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
TimePeriod
Specify the phonehome log time period as any of the following: send_all, send_today, send_yesterday, cancel.
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Send-PfaPhonehome -FlashArray 1.1.1.1 -TimePeriod All -Session $MySession
Set-PfaBanner
Sets a common "message of the day" (MOTD) that is sent to all Purity users. The banner message
is displayed in the login pane of the Purity GUI and via SSH after users log in.
Set
PfaBanner
Sets a common "message of the day" (MOTD) that is sent to all Purity users. The banner message
is displayed in the login pane of the Purity GUI and via SSH after users log in.
Set-PfaBanner
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Banner
Message of the day (MOTD)
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Banner
Message of the day (MOTD)
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Set-PfaBanner -FlashArray 1.1.1.1 -Banner "This is my test banner" -Session $MySession
Set-PfaDns
Lists DNS attributes for the array administrative network.
Set
PfaDns
Lists DNS attributes for the array administrative network.
Set-PfaDns
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Domain
Domain suffix to be appended by the array when performing DNS lookups.
String
Nameservers
A list of up to three DNS server IP addresses that replace the current list of name servers. The order of the list
is significant. Purity queries DNS servers in the order in which their IP addresses are listed in this option.
String[]
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Domain
Domain suffix to be appended by the array when performing DNS lookups.
String
String
Nameservers
A list of up to three DNS server IP addresses that replace the current list of name servers. The order of the list
is significant. Purity queries DNS servers in the order in which their IP addresses are listed in this option.
String[]
String[]
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Set-PfaDns -FlashArray 1.1.1.1 -Domain EXAMPLE.COM -Nameservers 9.9.9.9,4.4.4.4,6.6.6.6 -Session $MySession
Set-PfaIdleTimeout
Sets the idle time limit, in minutes, of the Purity GUI and CLI sessions.
Set
PfaIdleTimeout
Sets the idle time limit, in minutes, of the Purity GUI and CLI sessions. Valid values are between
5 and 180 minutes. The default timeout value is 30 minutes. Specifying a value of zero disables the
automatic log-off feature. Changes made to the idle_timeout value do not apply to existing Purity
sessions.
Set-PfaIdleTimeout
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
IdleTimeout
Valid values are between 5 and 180 minutes. The default timeout value is 30 minutes. Specifying a
value of zero disables the automatic log-off feature.
Int32
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
IdleTimeout
Valid values are between 5 and 180 minutes. The default timeout value is 30 minutes. Specifying a
value of zero disables the automatic log-off feature.
Int32
Int32
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Set-PfaIdleTimeout -FlashArray 1.1.1.1 -IdleTimeout 60 -Session $MySession
Set-PfaName
Renames the array.
Set
PfaName
Renames the array.
Set-PfaName
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Name
New FlashArray name.
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Name
New FlashArray name.
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Set-PfaName -FlashArray 1.1.1.1 -Name MyFlashArray -Session $MySession
Set-PfaNtpServer
Specifies alternate NTP servers, by IP address or hostname, assigned as the array source for
reference time.
Set
PfaNtpServer
Specifies alternate NTP servers, by IP address or hostname, assigned as the array source for
reference time. Supersedes any previous NTP server assignments.
Set-PfaNtpServer
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Servers
One more more new NTP Server hostname or IP address. Separated by commas.
String[]
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Servers
One more more new NTP Server hostname or IP address. Separated by commas.
String[]
String[]
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Set-PfaNtpServer -FlashArray 1.1.1.1 -Name MyNtpServer -Session $MySession
Set-PfaProtectionGroupReplicationBlackout
Modifies the replication schedule of the protection group. Specifies the range of time at which to
suspend replication. See below example for the dictionary format.
Set
PfaProtectionGroupReplicationBlackout
Modifies the replication schedule of the protection group. Specifies the range of time at which to
suspend replication. See below example for the dictionary format.
Set-PfaProtectionGroupReplicationBlackout
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Name
Protection group name.
String
StartTime
Start time of blackout period. Format 24hr clock, Eg. 2pm = 14, 8pm = 20
Int32
EndTime
Start time of blackout period. Format 24hr clock, Eg. 2pm = 14, 8pm = 20
Int32
Session
Pure Storage FlashArray session created with Connect-PfaController.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Name
Protection group name.
String
String
StartTime
Start time of blackout period. Format 24hr clock, Eg. 2pm = 14, 8pm = 20
Int32
Int32
EndTime
Start time of blackout period. Format 24hr clock, Eg. 2pm = 14, 8pm = 20
Int32
Int32
Session
Pure Storage FlashArray session created with Connect-PfaController.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Creates a blackout period between 2am and 6am.
PS C:\> Update-PfaProtectionGroupReplication -FlashArray 1.1.1.1 -Name TESTGROUP -StartTime 2 -EndTime 6 -Session $S
Set-PfaProxy
Sets the proxy host for the phonehome facility when HTTPS is the phonehome protocol.
Set
PfaProxy
Sets the proxy host for the phonehome facility when HTTPS is the phonehome protocol (the phonehome
facility itself determines which protocol to use). The format for the value is https://HOSTNAME:PORT,
where HOSTNAME is the name of the proxy host and PORT is the TCP/IP port number used by the proxy host.
Set-PfaProxy
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Name
New proxy (HOSTNAME:PORT).
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Name
New proxy (HOSTNAME:PORT).
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Set-PfaProxy -FlashArray 1.1.1.1 -Name MyProxy -Session $MySession
Set-PfaRelayHost
Sets the hostname or IP address of the electronic mail relay server.
Set
PfaRelayHost
Sets the hostname or IP address of the electronic mail relay server currently being used
as a forwarding point for email alerts generated by the array. To set Purity to send alert
email messages directly to recipient addresses rather than routing them via a relay (mail
forwarding) server, set relayhost to an empty string.
Set-PfaRelayHost
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Name
New relay hostname or IP address.
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Name
New relay hostname or IP address.
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Set-PfaRelayHost -FlashArray 1.1.1.1 -Name MyProxy -Session $MySession
Set-PfaScsiTimeout
Changes the amount of time, in seconds, that can lapse during an I/O interruption before the
target ports log out of the fabric. The default timeout value is 60 seconds.
Set
PfaScsiTimeout
Changes the amount of time, in seconds, that can lapse during an I/O interruption before the
target ports log out of the fabric. The default timeout value is 60 seconds.
Changing the default timeout value may cause an initiator to mistakenly interpret the status
of the FlashArray as failed or generate a host timeout. Contact the Pure Storage Support team
before you change the scsi_timeout value
Set-PfaScsiTimeout
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Timeout
New relay hostname or IP address.
Int32
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Timeout
New relay hostname or IP address.
Int32
Int32
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Set-PfaScsiTimeout -FlashArray 1.1.1.1 -Timeout MyProxy -Session $MySession
Set-PfaSenderDomain
Sets the domain name from which Purity sends email alert messages.
Set
PfaSenderDomain
Sets the domain name from which Purity sends email alert messages.
Set-PfaSenderDomain
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Name
New domain name.
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Name
New domain name.
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Set-PfaSenderDomain -FlashArray 1.1.1.1 -Name MyDomain -Session $MySession
Set-PfaSyslogServer
Specifies the remote syslog servers for delivering notifications.
Set
PfaSyslogServer
Specifies the remote syslog servers for delivering notifications. The format for the value is
tcp://HOST:PORT or udp://HOST:PORT.
Set-PfaSyslogServer
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Servers
One or more syslogserver names. Separated with commas.
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Servers
One or more syslogserver names. Separated with commas.
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Set-PfaSyslogServer -FlashArray 1.1.1.1 -Name MySyslogServer, MySyslogServer1, MySyslogServer2 -Session $MySession
Set-PfaUserPassword
Sets the password or public key or refreshes the user permission cache entries for the specified user.
Set
PfaUserPassword
Sets the password or public key or refreshes the user permission cache entries for the specified user.
Set-PfaUserPassword
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
User
User to update.
String
Old
Used with the password parameter to change the password for the single, local administrative account pureuser.
String
New
Used with the Old parameter to change the password for the single, local administrative account pureuser. The value
must be between 1 and 32 characters in length and be entered from a standard English (U.S.) keyboard.
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
User
User to update.
String
String
Old
Used with the password parameter to change the password for the single, local administrative account pureuser.
String
String
New
Used with the Old parameter to change the password for the single, local administrative account pureuser. The value
must be between 1 and 32 characters in length and be entered from a standard English (U.S.) keyboard.
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Set-PfaUserPassword -FlashArray 1.1.1.1 -User TESTUSER -Old TESTPWD -New NEWPWD -Session $MySession
Set-PfaUserPublicKey
Sets the password or public key or refreshes the user permission cache entries for the specified user.
Set
PfaUserPublicKey
Sets the password or public key or refreshes the user permission cache entries for the specified user.
Set-PfaUserPublicKey
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
User
User to update.
String
PublicKey
Changes the public key for SSH access for the specified user. Only system administrators can change public
keys on behalf of other users. If no users are provided as arguments, a request to change the public key will
be for the administrator issuing the request and a request to display set public keys will show all users with
a public key configured.
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
User
User to update.
String
String
PublicKey
Changes the public key for SSH access for the specified user. Only system administrators can change public
keys on behalf of other users. If no users are provided as arguments, a request to change the public key will
be for the administrator issuing the request and a request to display set public keys will show all users with
a public key configured.
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Set-PfaUserPublicKey -FlashArray 1.1.1.1 -User TESTUSER -PublicKey <string> -Session $MySession
Show-PfaHardwareLed
Controls the visual identification of the specified controllers, storage shelves, and storage shelf drive bays.
Show
PfaHardwareLed
Controls the visual identification of the specified controllers, storage shelves, and storage shelf drive bays.
Show-PfaHardwareLed
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Component
Specific component to query.
String
State
On or Off for LED.
String
Session
Pure Storage FlashArray session created with Connect-PfaController.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Component
Specific component to query.
String
String
State
On or Off for LED.
String
String
Session
Pure Storage FlashArray session created with Connect-PfaController.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Show-PfaHardwareLed -FlashArray 1.1.1.1 -Component SH0.BAY0 -State On -Session $S
Show-PfaMessage
Flags a message.
Show
PfaMessage
Flags (true) a message. If set to true, flags the message with the specified ID. If set to false, unflags the message.
Show-PfaMessage
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Id
Flags a message.
String
Session
Pure Storage FlashArray session created with Connect-PfaController.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Id
Flags a message.
String
String
Session
Pure Storage FlashArray session created with Connect-PfaController.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Show-PfaMessage -FlashArray 1.1.1.1 -Id 25680 -Session $S
Test-PfaAlertRecipient
Tests the ability of the array to send alert messages to all of the designated email addresses.
Test
PfaAlertRecipient
Tests the ability of the array to send alert messages to all of the designated email addresses.
Test-PfaAlertRecipient
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Email
Email recipient to test.
String
Session
Pure Storage FlashArray session created with Connect-PfaController.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Email
Email recipient to test.
String
String
Session
Pure Storage FlashArray session created with Connect-PfaController.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Test-PfaAlertRecipient -FlashArray 1.1.1.1 -Email test@test.com -Session $S
Test-PfaDirectoryService
Tests the current directory service configuration.
Test
PfaDirectoryService
Tests the current directory service configuration; verifies that the URIs can be resolved and that Purity can
bind and query the tree using the bind user credentials. The call also verifies that it can find all the configured
groups to ensure the Common Names and group base are correctly configured.
Test-PfaDirectoryService
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Test-PfaDirectoryService -FlashArray 1.1.1.1 -Session $MySession
Test-PfaSnmpManager
Send test trap to the specified Purity SNMP manager object.
Test
PfaSnmpManager
Send test trap to the specified Purity SNMP manager object.
Test-PfaSnmpManager
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Manager
Name of the SNMP manager.
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Manager
Name of the SNMP manager.
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Test-PfaSnmpManager -FlashArray 1.1.1.1 -Manager TEST -Session $S
Update-PfaDirectoryService
Modifies the directory service configuration.
Update
PfaDirectoryService
Modifies the directory service configuration.
Update-PfaDirectoryService
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
LdapUri
A list of up to 30 URIs of the directory servers. These must be full URIs including the scheme:
ldap:// or ldaps://. The domain names should be resolvable by configured DNS servers. If the scheme
of the URIs is ldaps://, SSL is enabled. SSL is either enabled or disabled globally, so the scheme
of all supplied URIs must be the same. They must also all have the same domain. If base DN is not
configured and a URI is provided, the base DN will automatically default to the Domain Components
of the URIs. Standard ports are assumed (389 for ldap, 636 for ldaps). Non-standard ports can be
specified in the URI if they are in use.
String[]
BaseDN
Sets the base of the Distinguished Name (DN) of the directory service groups. The base should consist
of only Domain Components (DCs). The base_dn will populate with a default value when a URI is entered
by parsing domain components from the URI. The base DN should specify DC= for each domain component
and multiple DCs should be separated by commas.
String
GroupBase
Specifies where the configured groups are located in the directory tree. This field consists of
Organizational Units (OUs) that combine with the base DN attribute and the configured group CNs to
complete the full Distinguished Name of the groups. The group base should specify OU= for each OU
and multiple OUs should be separated by commas. The order of OUs is important and should get larger
in scope from left to right. Each OU should not exceed 64 characters in length.
String
ArrayAdminGroup
Sets the common Name (CN) of the directory service group containing administrators with full privileges
when managing the FlashArray. The name should be just the Common Name of the group without the CN=
specifier. Common Names should not exceed 64 characters in length.
String
StorageAdminGroup
Sets the common Name (CN) of the configured directory service group containing administrators with
storage-related privileges on the FlashArray. This name should be just the Common Name of the group
without the CN= specifier. Common Names should not exceed 64 characters in length.
String
ReadOnlyGroup
Sets the common Name (CN) of the configured directory service group containing users with read-only
privileges on the FlashArray. This name should be just the Common Name of the group without the CN=
specifier. Common Names should not exceed 64 characters in length.
String
BindUser
Sets the user name that can be used to bind to and query the directory. Often referred to as
sAMAccountName or User Logon Name.
String
BindPassword
Sets the password of the bind_user user name account.
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
LdapUri
A list of up to 30 URIs of the directory servers. These must be full URIs including the scheme:
ldap:// or ldaps://. The domain names should be resolvable by configured DNS servers. If the scheme
of the URIs is ldaps://, SSL is enabled. SSL is either enabled or disabled globally, so the scheme
of all supplied URIs must be the same. They must also all have the same domain. If base DN is not
configured and a URI is provided, the base DN will automatically default to the Domain Components
of the URIs. Standard ports are assumed (389 for ldap, 636 for ldaps). Non-standard ports can be
specified in the URI if they are in use.
String[]
String[]
BaseDN
Sets the base of the Distinguished Name (DN) of the directory service groups. The base should consist
of only Domain Components (DCs). The base_dn will populate with a default value when a URI is entered
by parsing domain components from the URI. The base DN should specify DC= for each domain component
and multiple DCs should be separated by commas.
String
String
GroupBase
Specifies where the configured groups are located in the directory tree. This field consists of
Organizational Units (OUs) that combine with the base DN attribute and the configured group CNs to
complete the full Distinguished Name of the groups. The group base should specify OU= for each OU
and multiple OUs should be separated by commas. The order of OUs is important and should get larger
in scope from left to right. Each OU should not exceed 64 characters in length.
String
String
ArrayAdminGroup
Sets the common Name (CN) of the directory service group containing administrators with full privileges
when managing the FlashArray. The name should be just the Common Name of the group without the CN=
specifier. Common Names should not exceed 64 characters in length.
String
String
StorageAdminGroup
Sets the common Name (CN) of the configured directory service group containing administrators with
storage-related privileges on the FlashArray. This name should be just the Common Name of the group
without the CN= specifier. Common Names should not exceed 64 characters in length.
String
String
ReadOnlyGroup
Sets the common Name (CN) of the configured directory service group containing users with read-only
privileges on the FlashArray. This name should be just the Common Name of the group without the CN=
specifier. Common Names should not exceed 64 characters in length.
String
String
BindUser
Sets the user name that can be used to bind to and query the directory. Often referred to as
sAMAccountName or User Logon Name.
String
String
BindPassword
Sets the password of the bind_user user name account.
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Update-PfaDirectoryService -FlashArray 1.1.1.1 -LdapUri 'ldap://10.21.8.5' -BaseDN 'DC=csglab,DC=purestorage,DC=com' -GroupBase OU=SAN_Managers -ArrayAdminGroup Pure_Storage_Admins -StorageAdminGroup Pure_Storage_Users -ReadOnlyGroup Pure_Storage_Readers -BindUser USER1 -BindPassword 'pa$$word' -Session $S
Update-PfaHostGroupHosts
Replaces host members of the host group.
Update
PfaHostGroupHosts
Replaces host members of the host group.
Update-PfaHostGroupHosts
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Name
Name of host group to create.
String
HostList
Removes list of hosts from the existing list.
String[]
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Name
Name of host group to create.
String
String
HostList
Removes list of hosts from the existing list.
String[]
String[]
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Update-PfaHostGroupHosts -FlashArray 1.1.1.1 -Name HOSTGROUP1 -HostList HOSTA,HOSTB,HOSTC,HOSTD -Session $MySession
Update-PfaProtectionGroupReplication
Allows (true) or disallows (false) a protection group from being replicated.
Update
PfaProtectionGroupReplication
Allows (true) or disallows (false) a protection group from being replicated.
Update-PfaProtectionGroupReplication
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Name
Protection group name.
String
Replication
Allow or Disallow replication.
String
Session
Pure Storage FlashArray session created with Connect-PfaController.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Name
Protection group name.
String
String
Replication
Allow or Disallow replication.
String
String
Session
Pure Storage FlashArray session created with Connect-PfaController.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Update-PfaProtectionGroupReplication -FlashArray 1.1.1.1 -Name TESTGROUP -Replication Allow -Session $S
Update-PfaSnmpManager
Updates a Purity SNMP manager object that identifies a host (SNMP manager) and specifies the protocol
attributes for communicating with it.
Update
PfaSnmpManager
Creates a Purity SNMP manager object that identifies a host (SNMP manager) and specifies the protocol
attributes for communicating with it.
Once a manager object is created, the transmission of SNMP traps is immediately enabled.
Update-PfaSnmpManager
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Manager
Name of the SNMP manager.
String
Name
New name of the SNMP manager.
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Manager
Name of the SNMP manager.
String
String
Name
New name of the SNMP manager.
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Update-PfaSnmpManager -FlashArray 1.1.1.1 -Manager TEST -Name NEWTEST -Session $S
Watch-PfaPerformance
Watch-PfaPerformance [-FlashArray] <string> [-Session] <WebRequestSession> [<CommonParameters>]
Watch
PfaPerformance
Watch-PfaPerformance
FlashArray
String
Session
WebRequestSession
FlashArray
String
String
Session
WebRequestSession
WebRequestSession
Watch-PfaVolumePerformance
Displays the following real-time performance data.
Watch
PfaVolumePerformance
Latency
usec_per_read_op - average arrival-to-completion time, measured in microseconds, for a host read operation.
usec_per_write_op - average arrival-to-completion time, measured in microseconds, for a host write operation.
queue_depth - average number of queued I/O requests.
IOPS
reads_per_sec - number of read requests processed per second.
writes_per_sec - number of write requests processed per second.
Bandwidth
input_per_sec - number of bytes read per second.
output_per_sec - number of bytes written per second.
Watch-PfaVolumePerformance
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
Name
Volume name.
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
FlashArray
Pure Storage FlashArray virtual IP address (eg. vir0) or DNS name.
String
String
Name
Volume name.
String
String
Session
The session that has been established using the Connect-PfaController and Get-PfaAPIToken cmdlets.
WebRequestSession
WebRequestSession
-------------------------- EXAMPLE 1 --------------------------
PS C:\>
Watch-PfaVolumePerformance -FlashArray 1.1.1.1 -Name Volume1 -Session $MySession