diff --git a/EUA.rtf b/EUA.rtf
index 4869d03..ffce0e3 100644
--- a/EUA.rtf
+++ b/EUA.rtf
@@ -1345,18 +1345,22 @@ alid or unenforceable provision will be deemed modified so that it is valid and
\par {\listtext\pard\plain\ltrpar \s38 \rtlch\fcs1 \af0\afs18 \ltrch\fcs0 \b\fs18\dbch\af0\cgrid0\insrsid7611348 \hich\af0\dbch\af0\loch\f0 8.3\tab}}{\rtlch\fcs1 \af0\afs18 \ltrch\fcs0 \b\f0\fs18\cgrid0\insrsid7611348 Export.}{\rtlch\fcs1 \af0\afs18
\ltrch\fcs0 \f0\fs18\cgrid0\insrsid7611348 The }{\rtlch\fcs1 \af0\afs18 \ltrch\fcs0 \f0\fs18\cgrid0\insrsid15359378 Software}{\rtlch\fcs1 \af0\afs18 \ltrch\fcs0 \f0\fs18\cgrid0\insrsid7611348
and related technology are subject to U.S. export control laws and may be subject to export or import regulations in other countries. End User agrees not to export, reexport, or transfer, directly or indirectly, any techn}{\rtlch\fcs1 \af0\afs18
-\ltrch\fcs0 \f0\fs18\insrsid7611348 ical data acquired from Pure, or any products incorporating such data, in violation of applicable export laws or regulations.}{\rtlch\fcs1 \af0\afs18 \ltrch\fcs0 \f0\fs18\insrsid15227847
-\par }\pard \ltrpar\s38\qj \li0\ri-396\sa120\widctlpar\tx540\wrapdefault\aspalpha\aspnum\faauto\outlinelevel1\adjustright\rin-396\lin0\itap0 {\rtlch\fcs1 \af0\afs18 \ltrch\fcs0 \f0\fs18\cf1\insrsid15227847 \sect }\sectd \ltrsect
+\ltrch\fcs0 \f0\fs18\insrsid7611348 ical data acquired from Pure, or any products incorporating such data, in violation of applicable export laws or regulations.}{\rtlch\fcs1 \af0\afs18 \ltrch\fcs0
+\f0\fs18\insrsid15227847
+\par }\pard \ltrpar\s56\qj \li0\ri-396\sa120\widctlpar\tx540\wrapdefault\aspalpha\aspnum\faauto\outlinelevel1\adjustright\rin-396\lin0\itap0 {\rtlch\fcs1 \af0\afs18 \ltrch\fcs0 \f0\fs18\cf1\insrsid15227847 \sect }\sectd \ltrsect
\marglsxn1080\margrsxn1080\margtsxn810\margbsxn900\psz1\sbknone\linex0\headery1008\footery576\endnhere\pgbrdropt32\pgbrdrt\brdrs\brdrw90\brsp320\brdrcf21 \pgbrdrl\brdrs\brdrw90\brsp320\brdrcf21 \pgbrdrb\brdrs\brdrw90\brsp320\brdrcf21 \pgbrdrr
-\brdrs\brdrw90\brsp320\brdrcf21 \sectdefaultcl\sftnbj\sftnnrlc\saftnnar {\footerr \ltrpar \pard\plain \ltrpar\s18\ql \li0\ri0\sl-200\slmult0\widctlpar
+\brdrs\brdrw90\brsp320\brdrcf21 \sectdefaultcl\sftnbj\sftnnrlc\saftnnar {\footerr \ltrpar \pard\plain \ltrpar\s28\ql \li0\ri0\sl-200\slmult0\widctlpar
\tqc\tx4819\tqc\tx5040\tqr\tx9071\tqr\tx10170\wrapdefault\aspalpha\aspnum\faauto\adjustright\rin0\lin0\itap0 \rtlch\fcs1 \af0\afs20\alang1025 \ltrch\fcs0 \fs20\lang1033\langfe2052\loch\af0\hich\af0\dbch\af13\cgrid\langnp1033\langfenp2052 {\rtlch\fcs1
\af0 \ltrch\fcs0 \insrsid15227847
\par }{\rtlch\fcs1 \af0 \ltrch\fcs0 \insrsid7611348 \hich\af0\dbch\af13\loch\f0 }{\rtlch\fcs1 \af0 \ltrch\fcs0 \insrsid15227847
\par }{\rtlch\fcs1 \af0 \ltrch\fcs0 \insrsid7611348 \hich\af0\dbch\af13\loch\f0 }{\rtlch\fcs1 \af0 \ltrch\fcs0 \insrsid15227847
\par }{\rtlch\fcs1 \af0 \ltrch\fcs0 \insrsid7611348 \hich\af0\dbch\af13\loch\f0 }{\rtlch\fcs1 \af0 \ltrch\fcs0 \insrsid15227847
\par }{\rtlch\fcs1 \af0 \ltrch\fcs0 \i\insrsid15227847
-\par }}\pard\plain \ltrpar\ql \li0\ri-396\widctlpar\tx900\tx3960\tx4320\tx5040\tx8640\wrapdefault\aspalpha\aspnum\faauto\adjustright\rin-396\lin0\itap0 \rtlch\fcs1 \af0\afs20\alang1025 \ltrch\fcs0
-\fs20\lang1033\langfe2052\loch\af0\hich\af0\dbch\af13\cgrid\langnp1033\langfenp2052 {\rtlch\fcs1 \af0\afs18 \ltrch\fcs0 \fs18\insrsid15227847
+\par }}\pard\plain \ltrpar\ql \li-450\ri-396\widctlpar\tx900\tx3960\tx4320\tx5040\tx8640\wrapdefault\aspalpha\aspnum\faauto\adjustright\rin-396\lin-450\itap0\pararsid15553847 \rtlch\fcs1 \af0\afs20\alang1025 \ltrch\fcs0
+\fs20\lang1033\langfe2052\loch\af0\hich\af0\dbch\af13\cgrid\langnp1033\langfenp2052 {\rtlch\fcs1 \af0\afs18 \ltrch\fcs0 \fs18\insrsid8788043
+\par }{\rtlch\fcs1 \af0\afs18 \ltrch\fcs0 \fs18\insrsid15553847\charrsid15553847 \hich\af0\dbch\af13\loch\f0 Please follow this link to review our latest End User License Agreement: }{\rtlch\fcs1 \af0\afs18 \ltrch\fcs0
+\fs18\ul\cf22\insrsid15553847\charrsid15553847 \hich\af0\dbch\af13\loch\f0 https://www.purestorage.com/docs.html?item=/type/pdf/subtype/doc/path/content/dam/pdf/en/legal/pure-storage-plugin-end-user-license-agreement.pdf}{
+\rtlch\fcs1 \af0\afs18 \ltrch\fcs0 \fs18\insrsid15227847
\par }{\*\themedata 504b030414000600080000002100e9de0fbfff0000001c020000130000005b436f6e74656e745f54797065735d2e786d6cac91cb4ec3301045f748fc83e52d4a
9cb2400825e982c78ec7a27cc0c8992416c9d8b2a755fbf74cd25442a820166c2cd933f79e3be372bd1f07b5c3989ca74aaff2422b24eb1b475da5df374fd9ad
5689811a183c61a50f98f4babebc2837878049899a52a57be670674cb23d8e90721f90a4d2fa3802cb35762680fd800ecd7551dc18eb899138e3c943d7e503b6
diff --git a/PureStoragePowerShellSDK-Help.html b/PureStoragePowerShellSDK-Help.html
index ab661dc..90a2492 100644
--- a/PureStoragePowerShellSDK-Help.html
+++ b/PureStoragePowerShellSDK-Help.html
@@ -2,24 +2,29 @@
- PureStoragePowerShellSDK Cmdlet Documentation
+ PureStoragePowerShellSDK v1.19 Help File
-
+
-
+
-
Copyright 2020
Add-PfaArrayToPod
-
(REST API 1.13+) Stretches pod to the specified array
-
(REST API 1.13+) Stretches pod to the specified array
+
Stretches a pod to the specified array. (Requires REST 1.13+)
+
ActiveCluster replication is managed through pods. A pod representing a collection of protection groups and volumes is created on one array and stretched to another array, resulting in fully synchronized writes between the two arrays. A pod can contain a mix of volumes, and protection groups with member volumes. (Requires REST 1.13+)
(REST API 1.2+) Adds a list of host groups to the existing list.
-
+
Adds a list of host groups to the existing list of hosts in a protection group. (Requires REST 1.2+)
+
Adds a list of host groups to the existing list of hosts in a protection group. A Protection Group provides a logical grouping mechanism for volumes that are asynchronously replicated. (Requires REST 1.2+)
Adds the specified host groups ("hostgroup1", "hostgroup2, and "hostgroup3") to the existing list of host groups in the protection group "protectionGroup1".
Adds the specified host groups ("hostgroup1", "hostgroup2, and "hostgroup3") to the existing list of host groups in the protection group "protectionGroup1" on Array $array
Adds Fibre Channel WWNs for the specified host. Fibre Channel World Wide Names (WWNs) follow the naming standards set by the IEEE Standards Association. WWNs are comprised of eight pairs of case-insensitive hexadecimal numbers, optionally separated by colons.
Adds slaves to the existing list. May only be used on network bond interfaces.
-
NO EXAMPLE YET
+
Add-PfaPodReplicaLink
+
Creates a replica link between the specified local and remote pods to initiate continuous replication. (Requires REST 1.19+)
+
Creates a connection from a source-array pod to a target-array pod. The source and target pods must already exist. (Requires REST 1.19+)
Pure refers to the replication relationship between the source and target pod as a Replica Link. Establishing a relationship between the source pod and the target pod is referred to as “linking the pods” because you are effectively creating a directional replication link between the source and target pod which defines the direction of replication for the pod members. Creating a replica link between the source and target pod causes the replication source pod content and configuration information to be replicated to the target FlashArray. The process begins with a 'baselining' process which leverages Purity's highly efficient asynchronous replication engine to quickly synchronize with the target pod and then automatically transitions into normal 'replicating' mode. The volumes in the replication source pod will not appear at the remote array until the 'baselining' process has completed, and therefore there may be some delay before hosts at the replication target site (DR site) can be pre-connected to the volumes in the replication target pod.
The output type is the type of the objects that the cmdlet emits.
+
System.Object
+
+
+
+
Note
+
+
Existing pods can be used as ActiveDR source pods or used with ActiveCluster, but not both simultaneously. Creating a replica link between a local pod and a pod in a remote FlashArray prevents either of the two pods from being stretched. Use caution when selecting an existing pod to ensure it is not intended for use with ActiveCluster.
+
+ Prior to creating a Replica Link between the source and target pod, if an existing target pod (Remote Pod) is used, it must be set to a demoted state. This is because the replication target pod (Remote Pod) will be overwritten with the content (volumes, protection groups, and snapshot history) contained in the replication source pod when the replica link is created.
(REST API 1.2+) Adds a list of volumes to the existing list.
-
+
Add-PfaTargetArrays
+
Adds a list of target arrays to the existing list of target arrays. (Requires REST 1.2+)
+
Adds a list of target arrays to the existing list of target arrays. If multiple target arrays are specified, they must be in comma-seperated format. (Requires REST 1.2+)
(REST API 1.13+) Adds a volume to a container (either a volume group or a pod)
-
(REST API 1.13+) Adds a volume to a container (either a volume group or a pod)
+
Add-PfaVolumesTag
+
Adds a tag to the specified array volume(s) or snapshot(s). (Requires REST 1.19+)
+
Adds a tag to the specified array volume(s) or snapshot(s). The tag is applied to the specified single or multiple volumes or snapshots by the Name parameter. (Requires REST 1.19+)
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
-
None
+
+
+
+
-Name
+
VolumeName
+
Specifies the name(s) of the volume(s) or snapshot(s) to apply the tag to. If multiple names are to be specified, they must be comma-separated and enclosed in quotes. Example: -Name "vol1,vol2".
+
true
+
True (ByPropertyName)
+
+
+
+
-Key
+
+
A descriptive identifier of the tag. Part of the Key/Value pair of a tag. An example would be "Location". The tag key can only have unicode letters, numbers, white spaces, and the following characters: Hyphen (-), underscore (_), dot (.), slash (/), plus (+), and the at sign (@).
+
true
+
True (ByPropertyName)
+
+
+
+
-Value
+
+
A descriptive value of the tag identifier. Part of the Key/Value pair of a tag. An example would be for the key value of 'Location", -Value could be "California". There are no restrictions on the unicode characters that can be used for the tag value.
+
true
+
True (ByPropertyName)
+
+
+
+
-Namespace
+
+
Specifies a namespace in which to create the tag. The namespace option provides users with the option to create different sets of tags, without any overlap between the different sets. If not specified, the tag(s) are created in the default namespace. Namespaces can only start and end with a letter or a number. The tag namespace can consist of ASCII letters, numbers, and the following characters: Hyphen (-), underscore (_), dot (.), and slash (/). (Requires REST 1.19+)
+
false
+
True (ByPropertyName)
+
+
+
+
-Copyable
+
+
Specifies that tags are inherited between copied objects. Defaults to $true. By default in the SDK, tags are NOT copyable. Copyable means that if an object such as a volume has tags, and the volume is copied, the tags will be inherited by the volume copy. Please note that a snapshot of a volume will always inherit the tags from the volume, regardless of whether this option is enabled or not. However, if a volume is created from that snapshot, the non-copyable tag is not inherited by the newly created volume copy. (Requires REST 1.19+)
+
false
+
True (ByPropertyName)
+
$true
+
+
+
-WhatIf
+
wi
+
Shows what would happen if the cmdlet runs. The cmdlet is not run.
+
false
+
False
+
-Confirm
@@ -1527,35 +1638,203 @@
Parameters
Prompts you for confirmation before running the cmdlet.
false
False
-
False
+
+
+
+
+
+
Inputs
+
The input type is the type of the objects that you can pipe to the cmdlet.
Adds a list of volumes to the existing list for a protection group. (Requires REST 1.2+)
+
Adds a list of volumes to the existing list for a protection group. If multiple volumes are to added, specify as a comma-seperated list. (Requires REST 1.2+)
Used to manually clear a flag previously set for an audit, alert, or user session message. Purity//FA automatically flags all warning and critical alerts. An alert remains flagged until you have manually cleared the flag to indicate that the alert has been addressed. If there are further changes to the condition that caused the alert (for example, a temperature of a controller or shelf has changed), Purity//FA will set the flag again.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
@@ -1606,36 +1896,36 @@
Parameters
-Id
-
none
-
Target message ID.
+
+
Target message ID.
Each alert or message has an associated ID. These are visible in the 'ID" column in the FlashArray UI under Health --> Alerts. You could also use the Get-PfaFlaggedMessages or Get-PfaAuditFlaggedRecords cmdlets. This document lists the currently available message IDs as of this release - https://support.purestorage.com/FlashArray/PurityFA/PurityFA_Alerts/FlashArray_Alert_Information/List_of_Available_Alerts
true
True (ByPropertyName)
None
-
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
-
false
-
False
-
False
-
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
-
false
-
False
-
False
+
-Name
+
+
Alias name to this Azure Blob offload target. Required.
+
true
+
True (ByPropertyName)
+
None
-
-ContainerName
-
none
-
Name of the Azure Blob container. If you do not specify a container name, the default is offload. Optional.
+
-AccountName
+
+
Name of the Azure Blob storage account. Required.
true
True (ByPropertyName)
None
-
-Initialize
-
none
-
Initializes(true) the Azure Blob container to prepare it for offloading. Only required if this is the first time a FlashArray array is connecting to the Azure Blob container. The array will only initialize an Azure Blob container if it is empty. Optional.
-
false
+
-SecretAccessKey
+
+
Secret access key of the Azure Blob account used to authenticate requests between the array and the Azure Blob container. Required.
+
true
True (ByPropertyName)
None
-
-Name
-
none
-
Alias name to this Azure Blob offload target. Required.
+
-ContainerName
+
+
Name of the Azure Blob container. If you do not specify a container name, the default is offload. Optional.
true
True (ByPropertyName)
None
-
-SecretAccessKey
-
none
-
Secret access key of the Azure Blob account used to authenticate requests between the array and the Azure Blob container. Required.
-
true
+
-Initialize
+
+
Initializes ($true) the Azure Blob container to prepare it for offloading. Only required if this is the first time a FlashArray array is connecting to the Azure Blob container. The array will only initialize an Azure Blob container if it is empty.
+
false
True (ByPropertyName)
None
@@ -1740,20 +2022,28 @@
Parameters
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
-
false
-
False
-
False
+
-Name
+
+
Name given to this connection to the NFS offload target.
+
true
+
True (ByPropertyName)
+
None
-
-MountOptions
-
none
-
List mount options in comma-separated value (CSV) format. Supported mount options include port, rsize, wsize, nfsvers, and tcp or udp and are common options available to all NFS file systems.
-
false
+
-Address
+
+
Address or Host name of the NFS server
+
true
True (ByPropertyName)
None
-MountPoint
-
none
+
Mount point on the NFS server. Users with UID 1000 or group users with GID 1000 must have read and write permissions to the mount point.
true
True (ByPropertyName)
None
-
-Name
-
none
-
Name given to this connection to the NFS offload target.
-
true
+
-MountOptions
+
+
List mount options in comma-separated value (CSV) format. Supported mount options include port, rsize, wsize, nfsvers, and tcp or udp and are common options available to all NFS file systems.
+
false
True (ByPropertyName)
None
@@ -1855,17 +2137,25 @@
Parameters
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Connects to NFS Server for snapshot offload. The NFS Server address is 10.15.87.42 and mount path is "/mnt/exports/share" using optional mount options.
@@ -1889,15 +2179,15 @@
Examples
Connect-PfaOffloadS3Target
-
Creates a connection between the current array and the specified Amazon S3 offload target.
-
Creates a connection between the current array and the specified Amazon S3 offload target.
+
Creates a connection between the current array and the specified AWS S3 offload target.
+
Creates a connection between the current array and the specified AWS S3 offload target.
Access key ID of the AWS account. The access key is 20 characters in length. Required.
+
-Array
+
+
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
+
true
+
True (ByPropertyName, ByValue)
+
None
+
+
+
-Name
+
+
Name given to this connection to the S3 offload target.
true
True (ByPropertyName)
None
-
-Array
-
none
-
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
+
-AccessKeyId
+
+
Access key ID of the AWS account. The access key is 20 characters in length. Required.
true
-
True (ByPropertyName, ByValue)
+
True (ByPropertyName)
None
-Bucket
-
none
+
Name of the S3 bucket. Required.
true
True (ByPropertyName)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
-
false
-
False
-
False
+
-SecretAccessKey
+
+
Secret access key of the AWS account used to authenticate requests between the array and S3 bucket. The secret access key is 40 characters in length. Required.
+
true
+
True (ByPropertyName)
+
None
-Initialize
-
none
+
Initializes (true) the S3 bucket to prepare it for offloading. Only required if this is the first time a FlashArray array is connecting to the S3 bucket. The array will only initialize an S3 bucket if it is empty. Optional.
false
True (ByPropertyName)
@@ -1956,44 +2254,36 @@
Parameters
-PlacementStrategy
-
none
-
Possible values are 'retention-based', 'aws-standard-class', 'aws-intelligent-tiering'. placement strategy for offloaded data. The retention-based placement selects the AWS storage class based on the retention of the protection group. The other options always select a specific storage class. When no placement strategy is set, retention-based is used as default when this array connects for the first time or the existing placement strategy is used when the array reconnects.
+
+
Possible values are 'retention-based', 'aws-standard-class', 'aws-intelligent-tiering'. placement strategy for offloaded data. The retention-based placement selects the AWS storage class based on the retention of the protection group. The other options always select a specific storage class. When no placement strategy is set, retention-based is used as default when this array connects for the first time or the existing placement strategy is used when the array reconnects. (Requires REST 1.17+)
false
True (ByPropertyName)
None
-
-
-Name
-
none
-
Name given to this connection to the S3 offload target.
-
true
-
True (ByPropertyName)
-
None
-
-
-
-SecretAccessKey
-
none
-
Secret access key of the AWS account used to authenticate requests between the array and S3 bucket. The secret access key is 40 characters in length. Required.
-
true
-
True (ByPropertyName)
-
None
-
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Disables the transmission of alert messages to the email address "admin@example.com".
@@ -2194,15 +2484,15 @@
Examples
Disable-PfaIdLight
-
Turns off visual identification of the specified hardware component. Valid for controllers, storage shelves, and storage shelf drive bays. On FlashArray//m, also valid for NVRAM module bays and the chassis.
-
+
Turns off visual identification of the specified hardware component.
+
Turns off visual identification of the specified hardware component. Valid for controllers, storage shelves, and storage shelf drive bays. On FlashArray//M, also valid for NVRAM module bays and the chassis.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
@@ -2229,36 +2519,36 @@
Parameters
-Name
-
none
-
Name of the hardware component
+
+
Name of the hardware component.
true
True (ByPropertyName)
None
-
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
-
false
-
False
-
False
-
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
PurePowerShell.PureArray
-
+
System.String
@@ -2267,8 +2557,8 @@
Examples
- EXAMPLE 1
-
Disable-PfaIdLight -Array $Array -Name SH0.BAY3
+ EXAMPLE
+
Disable-PfaIdLight -Array $array -Name SH0.BAY3
Turns off the chassis identification light for bay 3 in storage shelf 0.
@@ -2277,15 +2567,15 @@
Examples
Disable-PfaNetworkInterface
-
Disables communication between the specified Ethernet interface and the administrative network. Do not disable the interface through which the administrative session is being conducted.
-
+
Disables communication between the specified Ethernet interface and the administrative network.
+
Disables communication between the specified Ethernet interface and the administrative network.
**CAUTION: Do not disable the interface through which the administrative session is being conducted.
Enables the transmission of alert messages to the email address "admin@example.com".
@@ -3105,15 +3395,15 @@
Examples
Enable-PfaIdLight
+
Turns on visual identification of the specified hardware component.
Turns on visual identification of the specified hardware component. Valid for controllers, storage shelves, and storage shelf drive bays. On FlashArray//m, also valid for the chassis and NVRAM module bays.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
-
false
-
False
-
False
-
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
-
False
+
false
False
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
false
+
false
False
-
None
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
PurePowerShell.PureArray
+
+
+
Note
+
+
When using the Get-PfaAllDriveAttributes cmdlet with API versions 1.0 to 1.19:
+
+ As of this release, 'last_evac_completed' and 'last_failure' results are only available with Purity versions 5.2.7, 5.3.0, and 5.3.2.
+
Examples
- EXAMPLE 1
-
Get-PfaAllDriveAttributes -Array $Array
+ EXAMPLE
+
Get-PfaAllDriveAttributes -Array $array
Lists flash modules and NVRAM modules, including their attributes, for the specifed array.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
False
+
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
-
None
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
+
False
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
False
+
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
-
None
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
+
False
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
False
+
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
-
None
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
+
False
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
-
False
+
None
-
-WhatIf
-
wi
-
Shows what would happen if the cmdlet runs. The cmdlet is not run.
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
-
False
+
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
-
None
+
-
-
-
-
-
Inputs
-
The input type is the type of the objects that you can pipe to the cmdlet.
-
PurePowerShell.PureArray
-
-
-
-
-
Get-PfaAllHostGroupIOMetricsAverage
-
(REST API 1.7+) Lists IO metrics attributes for all host groups and also lists average IO sizes
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
-
true
-
True (ByPropertyName, ByValue)
-
None
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
false
False
-
False
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
-
False
+
false
False
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
false
+
false
False
-
None
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
PurePowerShell.PureArray
+
+
Examples
+
+
+
+ EXAMPLE
+
Get-PfaAllHostGroupIOMetrics -Array $array
+
Retrieves Host Group metrics from the Array $array.
+As an example, a Purity 6.1.x array includes this output:
+reads_per_sec
+usec_per_write_op
+time
+input_per_sec
+usec_per_read_op
+output_per_sec
+name
+writes_per_sec
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
False
+
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
-
None
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
+
False
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
PurePowerShell.PureArray
-
-
Outputs
-
The output type is the type of the objects that the cmdlet emits.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
+
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
+
False
+
+
+
+
-WhatIf
+
wi
+
Shows what would happen if the cmdlet runs. The cmdlet is not run.
+
false
+
false
+
False
+
-Confirm
cf
Prompts you for confirmation before running the cmdlet.
false
+
false
+
False
+
+
+
+
+
+
Inputs
+
The input type is the type of the objects that you can pipe to the cmdlet.
+
PurePowerShell.PureArray
+
+
+
Outputs
+
The output type is the type of the objects that the cmdlet emits.
Lists all host group performance statistics for IO that has been mirrored as part of an ActiveCluster connection on the array "$array".
+Sample output (Purity 6.1):
+reads_per_sec : 0
+usec_per_write_op : 0
+array : array1
+time : 01/01/2021 1:00:00 AM
+input_per_sec : 0
+mirrored_writes_per_sec : 0
+usec_per_read_op : 0
+usec_per_mirrored_write_op : 0
+mirrored_input_per_sec : 0
+output_per_sec : 0
+name : host1
+writes_per_sec : 0
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
+
true
+
True (ByPropertyName, ByValue)
+
None
+
+
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
False
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
-
False
+
false
False
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
false
+
false
False
-
None
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
PurePowerShell.PureArray
+
+
Examples
+
+
+
+ EXAMPLE
+
Get-PfaAllHostGroupIOMetricsTotal -Array $array
+
Retrieves all Host Group metrics and adds totals from Array $array.
+Sample output (Purity 6.1):
+reads_per_sec : 0
+usec_per_write_op : 169
+time : 01/01/2021 1:00:00 AM
+input_per_sec : 208872
+usec_per_read_op : 0
+output_per_sec : 0
+name : (total)
+writes_per_sec : 31
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
+
False
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
-
False
+
false
False
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
false
+
false
False
-
None
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
@@ -4710,8 +5308,8 @@
Examples
- EXAMPLE 1
-
Get-PfaAllHostGroupSpaceMetrics -Array $Array
+ EXAMPLE
+
Get-PfaAllHostGroupSpaceMetrics -Array $array
Lists size and space consumption information for each volume associated with all host groups on the specified array.
@@ -4720,15 +5318,15 @@
Examples
Get-PfaAllHostIOLatencyMetrics
-
Lists IO latency metric attributes, including SAN, Qos and queue times for all hosts.
-
Lists IO latency metric attributes, including SAN, Qos and queue times for all hosts.
+
Lists IO latency metric attributes, including SAN, QoS and queue times for all hosts.
+
Lists IO latency metric attributes, including SAN, QoS and queue times for all hosts.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
False
+
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
false
False
-
None
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
@@ -4795,8 +5425,8 @@
Examples
- Example 1
-
Get-PfaAllHostIOLatencyMetrics -Array "ArrayName"
+ EXAMPLE
+
Get-PfaAllHostIOLatencyMetrics -Array $array
@@ -4805,15 +5435,15 @@
Examples
Get-PfaAllHostIOLatencyMetricsMirrored
-
Shows performance statistics for IO latency, including SAN, Qos and queue times that have been mirrored as part of an ActiveCluster connection
-
Shows performance statistics for IO latency, including SAN, Qos and queue times that have been mirrored as part of an ActiveCluster connection
+
Shows performance statistics for IO latency, including SAN, QoS and queue times that have been mirrored as part of an ActiveCluster connection.
+
Shows performance statistics for IO latency, including SAN, QoS and queue times that have been mirrored as part of an ActiveCluster connection.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
False
+
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
false
False
-
None
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
False
+
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
-
None
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
+
False
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
+
False
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
-
False
+
false
False
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
false
+
false
False
-
None
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
False
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
-
False
+
false
False
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
false
+
false
False
-
None
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
False
+
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
-
None
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
+
False
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
@@ -5188,9 +6021,22 @@
Examples
- EXAMPLE 1
-
Get-PfaAllHostIOMetricsMirrored -Array $Array
-
Lists all host performance statistics for IO that has been mirrored as part of an ActiveCluster connection on the array "$Array".
+ EXAMPLE
+
Get-PfaAllHostIOMetricsMirrored -Array $array
+
Lists all host performance statistics for IO that has been mirrored as part of an ActiveCluster connection on the array "$array".
+Sample output (Purity 6.1):
+reads_per_sec : 0
+usec_per_write_op : 416
+array : array1
+time : 1/02/2021 1:00:00 AM
+input_per_sec : 24851975
+mirrored_writes_per_sec : 0
+usec_per_read_op : 0
+usec_per_mirrored_write_op : 0
+mirrored_input_per_sec : 0
+output_per_sec : 0
+name : host1
+writes_per_sec : 85
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
False
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
-
False
+
false
False
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
false
+
false
False
-
None
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
PurePowerShell.PureArray
+
+
Examples
+
+
+
+ EXAMPLE
+
Get-PfaAllHostIOMetricsTotal -Array $array
+
Returns all host metrics with total from Array $array
+Sample output (Purity 6.1):
+reads_per_sec : 0
+usec_per_write_op : 373
+time : 1/01/2021 1:00:00 AM
+input_per_sec : 19532916
+usec_per_read_op : 0
+output_per_sec : 0
+name : (total)
+writes_per_sec : 110
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
False
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
-
False
+
false
False
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
false
+
false
False
-
None
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
@@ -5337,9 +6267,18 @@
Examples
- EXAMPLE 1
-
Get-PfaAllHostSpaceMetrics -Array $Array
-
Lists information about provisioned size and physical storage consumption for each volume connected to any host on the specified array.
+ EXAMPLE
+
Get-PfaAllHostSpaceMetrics -Array $array
+
Lists information about provisioned size and physical storage consumption for each volume connected to any host on the specified array.
+Sample output (Purity 6.1):
+total : 337360
+total_reduction : 31549.672588767946
+snapshots : 0
+size : 590558003200
+volumes : 337360
+thin_provisioning : 0.9997713288393888
+data_reduction : 7.214500247778171
+name : host1
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
-
false
-
False
-
False
-
-
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
-
false
-
False
-
None
-
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
@@ -5672,14 +6595,20 @@
Outputs
The output type is the type of the objects that the cmdlet emits.
System.Object
+
+
+
Note
+
+
As of this release, "Total" result is only returned for Purity versions 5.3.0, 5.3.2, and 6.0.0. "Total" is not returned on Purity versions 6.1.6 or 6.2.0.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
False
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
-
False
+
false
False
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
false
+
false
False
-
None
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
False
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
-
False
+
false
False
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
false
+
false
False
-
None
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
False
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
-
False
+
false
False
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
false
+
false
False
-
None
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-OffloadTargetName
+
+
Name of the offload target.
+
true
+
True (ByPropertyName)
+
None
+
+
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
False
+
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
-
None
+
-
-OffloadTargetName
-
none
-
Name of the offload target.
-
true
-
True (ByPropertyName)
-
None
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
+
False
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-IncludeArray
+
+
When set, returns the details of the connected replicated array.
false
-
False
+
True (ByPropertyName)
False
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
-
False
+
false
None
-
-IncludeArray
-
none
-
When set, returns the details of the connected replicated array.
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
false
-
True (ByPropertyName)
False
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-IncludeArray
+
+
Includes the array information.
false
-
False
+
True (ByPropertyName)
False
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-Historical
+
+
Time range for historical data with units. Valid historical values are: 1h, 3h, 24h, 7d, 30d, 90d, 1y.
false
-
False
+
True (ByPropertyName)
None
-
-Historical
-
none
-
Time range for historical data with units. Valid historical values are: 1h, 3h, 24h, 7d, 30d, 90d, 1y.
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
-
True (ByPropertyName)
+
false
None
-
-IncludeArray
-
none
-
Include the array information.
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
false
-
True (ByPropertyName)
False
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
-
false
-
False
-
False
-
-
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
-
false
-
False
-
None
-
-On
-
none
-
Displays a list of pods that are on the specified remote arrays but not stretched to this array. Pods that are stretched to this array will not appear in the list. Enter multiple remote array names in comma-separated format. The remote array name can be set to asterisk (*) to represent all remote arrays.
+
+
Displays a list of pods that are on the specified remote arrays but not stretched to this array. Pods that are stretched to this array will not appear in the list. Enter multiple remote array names in comma-separated format. The remote array name can be set to asterisk (*) to represent all remote arrays.
true
True (ByPropertyName)
None
@@ -7156,17 +8423,25 @@
Parameters
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
+
False
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
-
False
+
false
False
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
false
+
false
False
-
None
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
@@ -7260,8 +8567,8 @@
Examples
- EXAMPLE 1
-
Get-PfaAllSnapshotSpaceMetrics -Array $Array
+ EXAMPLE
+
Get-PfaAllSnapshotSpaceMetrics -Array $array
Lists size and space consumption attributes for each volume's snapshots on the specified array.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
False
+
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
-
None
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
+
False
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
-
false
+
-TimeRange
+
+
Time range for historical data with units. Valid historical values are: 1h, 3h, 24h, 7d, 30d, 90d, 1y.
+
true
+
True (ByPropertyName)
+
None
+
+
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
False
+
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
-
None
+
-
-TimeRange
-
none
-
Time range for historical data with units. Valid historical values are: 1h, 3h, 24h, 7d, 30d, 90d, 1y.
-
true
-
True (ByPropertyName)
-
None
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
+
False
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
False
+
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
-
None
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
+
False
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
@@ -7680,9 +9078,9 @@
Examples
- EXAMPLE 1
-
Get-PfaAllVolumeGroupIOMetrics -Array $Array
-
Lists IO metrics for all volume groups on the array "$Array".
+ EXAMPLE
+
Get-PfaAllVolumeGroupIOMetrics -Array $array
+
Lists IO metrics for all volume groups on the array "$array".
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-TimeRange
+
+
Time range for historical data with units. Valid historical values are: 1h, 3h, 24h, 7d, 30d, 90d, 1y.
+
true
+
True (ByPropertyName)
+
None
+
+
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
False
+
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
-
None
+
-
-TimeRange
-
none
-
Time range for historical data with units. Valid historical values are: 1h, 3h, 24h, 7d, 30d, 90d, 1y.
-
true
-
True (ByPropertyName)
-
None
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
+
False
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
False
+
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
false
False
-
None
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
False
+
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
false
False
-
None
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
False
+
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
false
False
-
None
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-IncludePendingDeletes
+
+
Includes (true) Pods that are in the eradication pending state. Time remaining in the eradication pending state is displayed in seconds.
false
-
False
+
True (ByPropertyName)
False
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
-
False
+
false
None
-
-IncludePendingDeletes
-
none
-
Includes (true) Pods that are in the eradication pending state. Time remaining in the eradication pending state is displayed in seconds.
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
false
-
True (ByPropertyName)
False
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
@@ -8118,19 +9676,30 @@
Outputs
The output type is the type of the objects that the cmdlet emits.
System.Object
+
+
Examples
+
+
+
+ EXAMPLE
+
Get-PfaAllVolumeGroupSpaceMetrics -Array $array
+
Returns space metrics for all volume groups on Array $array
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
False
+
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
false
False
-
None
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
False
+
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
false
False
-
None
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-TimeRange
+
+
Time range for historical data with units. Valid historical values are: 1h, 3h, 24h, 7d, 30d, 90d, 1y.
+
true
+
True (ByPropertyName)
+
None
+
+
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
False
+
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
-
None
+
-
-TimeRange
-
none
-
Time range for historical data with units. Valid historical values are: 1h, 3h, 24h, 7d, 30d, 90d, 1y.
-
true
-
True (ByPropertyName)
-
None
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
+
False
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
False
+
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
false
False
-
None
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
False
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
-
False
+
false
False
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
false
+
false
False
-
None
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
@@ -8543,8 +10272,8 @@
Examples
- EXAMPLE 1
-
Get-PfaAllVolumeIOMetrics -Array $Array
+ EXAMPLE
+
Get-PfaAllVolumeIOMetrics -Array $array
List real-time performance data for all volumes on the array.
@@ -8553,15 +10282,15 @@
Examples
Get-PfaAllVolumeIOMetricsAverage
-
(REST API 1.7+) Lists IO metrics attributes for all volumes and also display average IO sizes
-
+
Lists IO metrics attributes for all volumes and also display average IO sizes. (Requires REST 1.7+)
+
Lists IO metrics attributes for all volumes and also display average IO sizes. (Requires REST 1.7+)
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
False
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
-
False
+
false
False
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
false
+
false
False
-
None
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
@@ -8622,15 +10383,15 @@
Inputs
Get-PfaAllVolumeIOMetricsByTimeRange
-
(REST API 1.5+) Lists historical IO metrics for all volumes for specified time range.
-
+
Lists historical IO metrics for all volumes for specified time range. (Requires REST 1.5+)
+
Lists historical IO metrics for all volumes for specified time range. (Requires REST 1.5+)
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
-
false
-
False
-
False
-
-TimeRange
-
none
+
Time range for historical data with units. Valid historical values are: 1h, 3h, 24h, 7d, 30d, 90d, 1y.
true
True (ByPropertyName)
None
+
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
+
False
+
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
-
False
+
false
False
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
false
+
false
False
-
None
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
@@ -8701,19 +10494,30 @@
Outputs
The output type is the type of the objects that the cmdlet emits.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
False
+
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
false
False
-
None
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
@@ -8780,9 +10616,9 @@
Examples
- EXAMPLE 1
-
Get-PfaAllVolumeIOMetricsMirrored -Array $Array
-
Lists all volume performance statistics for IO that has been mirrored as part of an ActiveCluster connection on the array "$Array".
+ EXAMPLE
+
Get-PfaAllVolumeIOMetricsMirrored -Array $array
+
Lists all volume performance statistics for IO that has been mirrored as part of an ActiveCluster connection on the array "$array".
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
-
False
-
False
+
false
+
None
-
-WhatIf
-
wi
-
Shows what would happen if the cmdlet runs. The cmdlet is not run.
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
-
False
+
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
-
None
+
-
-
-
-
-
Inputs
-
The input type is the type of the objects that you can pipe to the cmdlet.
-
PurePowerShell.PureArray
-
-
-
-
-
Get-PfaAllVolumeOffloadSnapshot
-
Lists all Volume offloaded snapshots for the specified offload target.
-
Lists all Volumes offloaded snapshots for the specified offload target.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
-
true
-
True (ByPropertyName, ByValue)
-
None
-
-
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
-
False
+
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
false
False
-
None
-
-
-
-OffloadTargetName
-
none
-
Offload target name.
-
true
-
True (ByPropertyName)
-
None
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
-
PurePowerShell.PureArray
-
-
-System.String
+
PurePowerShell.PureArray
-
-
Outputs
-
The output type is the type of the objects that the cmdlet emits.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-IncludePendingDeletes
-
none
-
Includes (true) destroyed volumes that are in the eradication pending state.
-
false
+
-OffloadTargetName
+
+
Offload target name.
+
true
True (ByPropertyName)
+
None
+
+
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
False
+
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
False
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
+
+
+
+
+
Inputs
+
The input type is the type of the objects that you can pipe to the cmdlet.
+
PurePowerShell.PureArray
+
+
+System.String
+
+
+
Outputs
+
The output type is the type of the objects that the cmdlet emits.
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
+
+
false
+
false
+
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
+
False
+
+
+
+
-WhatIf
+
wi
+
+
false
+
false
+
+
+
+
-Confirm
+
cf
+
+
false
+
false
+
+
+
+
+
+
+
Inputs
+
The input type is the type of the objects that you can pipe to the cmdlet.
+
PurePowerShell.PureArray
+
+
+
Outputs
+
The output type is the type of the objects that the cmdlet emits.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
+
true
+
True (ByPropertyName, ByValue)
+
None
+
+
+
-IncludePendingDeletes
+
+
Includes (true) destroyed volumes that are in the eradication pending state.
false
+
True (ByPropertyName)
False
+
+
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
None
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
+
False
+
+
+
+
-WhatIf
+
wi
+
Shows what would happen if the cmdlet runs. The cmdlet is not run.
+
false
+
false
+
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
+
False
+
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
False
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
-
False
+
false
False
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
false
+
false
False
-
None
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
@@ -9116,8 +11186,8 @@
Examples
- EXAMPLE 1
-
Get-PfaAllVolumeSpaceMetrics -Array $Array
+ EXAMPLE
+
Get-PfaAllVolumeSpaceMetrics -Array $array
Lists size and space attributes for all volumes on the array.
@@ -9126,15 +11196,15 @@
Examples
Get-PfaAllVolumeSpaceMetricsByTimeRange
-
(REST API 1.6+) Lists historical data size and space consumption attributes for all volumes for specified time range.
-
+
Lists historical data size and space consumption attributes for all volumes for specified time range. (Requires REST 1.6+)
+
Lists historical data size and space consumption attributes for all volumes for specified time range. (Requires REST 1.6+)
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
@@ -9161,44 +11231,76 @@
Parameters
-TimeRange
-
none
+
Time range for historical data with units. Valid historical values are: 1h, 3h, 24h, 7d, 30d, 90d, 1y.
true
True (ByPropertyName)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
False
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
-
False
+
false
False
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
false
+
false
False
-
None
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
PurePowerShell.PureArray
-
+
System.String
@@ -9207,14 +11309,14 @@
Inputs
Get-PfaAllVolumeSpaceMetricsTotal
List all volumes space metrics, including total metrics.
-
+
List all volumes space metrics, including total metrics.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
False
+
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
-
None
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
+
False
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
@@ -9281,8 +11415,8 @@
Examples
- Example 1
-
Get-PfaAllVolumeSpaceMetricsTotal -Array $Array
+ EXAMPLE
+
Get-PfaAllVolumeSpaceMetricsTotal -Array $array
@@ -9291,15 +11425,15 @@
Examples
Get-PfaAllVolumeTotal
-
(REST API 1.17+) List all volumes total space.
-
+
List all volumes total space. (Requires REST 1.17+)
+
List all volumes total space. (Requires REST 1.17+)
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
False
+
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
-
None
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
+
False
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
False
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
-
False
+
false
False
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
false
+
false
False
-
None
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
@@ -10232,9 +12408,9 @@
Examples
- EXAMPLE 1
-
Get-PfaArrayPorts -Array $Array
-
For array $Array, lists array ports and the worldwide names assigned to each port.
+ EXAMPLE
+
Get-PfaArrayPorts -Array $array
+
For array $array, lists array ports and the worldwide names assigned to each port.
(REST API 1.6+) Get the historical data for the amount of usable physical storage on the array and the amount of storage occupied by data and metadata.
-
+
Get the historical data for the amount of usable physical storage on the array and the amount of storage occupied by data and metadata. (Requires REST 1.6+)
+
Get the historical data for the amount of usable physical storage on the array and the amount of storage occupied by data and metadata. (Requires REST 1.6+)
(REST API 1.13+) Lists all the TCP connections to the array. Each item shows the connection status per IP address. Starting from Purity 5.0.0, an array connection may have multiple TCP connections with different IP addresses.
-
(REST API 1.13+) Shows all the TCP connections and their status
+
Lists all the TCP connections to the array and their status.
+
Lists all the TCP connections to the array and their status. Each item shows the connection status per IP address. Starting from Purity 5.0.0, an array connection may have multiple TCP connections with different IP addresses. (Requires REST 1.13+)
Lists audit records for the user "admin@example.com".
- EXAMPLE 2
-
Get-PfaAuditRecords -Array $Array -User pureuser
+ EXAMPLE
+
Get-PfaAuditRecords -Array $array -User pureuser
Lists audit records for the administrator "pureuser".
@@ -10573,15 +12736,15 @@
Examples
Get-PfaBanner
-
Displays the "message of the day" (MOTD) text 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.
-
+
Displays the "message of the day" (MOTD) text that is sent to all Array users.
+
Displays the "message of the day" (MOTD) text that is sent to all Array users. The banner message is displayed in the login pane of the Array GUI or via SSH after users log in.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
-
false
-
False
-
False
-
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
@@ -10635,8 +12798,8 @@
Examples
- EXAMPLE 1
-
Get-PfaBanner -Array $Array
+ EXAMPLE
+
Get-PfaBanner -Array $array
Displays the "message of the day" (MOTD) text for the specified array.
@@ -10645,15 +12808,15 @@
Examples
Get-PfaBlockDifferences
-
(REST API 1.3+) Lists block differences for the specified volume.
-
+
Lists block differences for the specified snapshot. (Requires REST 1.3+)
+
Lists block differences for the specified snapshot. *NOTE: This cmdlet only works with snapshots, not volumes. An alternative alias -SnapshotName exists for the -VolumeName parameter for clarity. (Requires REST 1.3+)
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
@@ -10680,82 +12843,114 @@
Parameters
-VolumeName
-
none
-
Target volume name.
+
SnapshotName
+
Target snapshot name. *NOTE: This cmdlet only works with snapshots, not volumes. An alternative alias -SnapshotName exists for this parameter for clarity.
true
True (ByPropertyName)
None
-
-Length
-
none
-
Length of the region, in bytes, to compare. (Commas are not supported.)
+
-Granularity
+
+
Granularity, in bytes, at which to compare.
true
True (ByPropertyName)
None
-
-Offset
-
none
-
Absolute offset, in bytes, of the region to compare. Must be a multiple of block_size.
-
false
+
-Length
+
+
Length of the region, in bytes, to compare. (Commas are not supported.)
+
true
True (ByPropertyName)
None
-BaseName
-
none
+
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.
false
True (ByPropertyName)
None
-
-Granularity
-
none
-
Granularity, in bytes, at which to compare.
-
true
+
-Offset
+
+
Absolute offset, in bytes, of the region to compare. Must be a multiple of block_size.
+
false
True (ByPropertyName)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Start
+
+
+
false
+
false
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
False
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
-
False
+
false
False
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
false
+
false
False
-
None
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Lists block differences for the first 1 gigabyte (1,073,741,824 bytes) in the volume "vol1", beginning after an offset of 5,120,000 bytes, using a block size of 512 bytes.
Displays the current SSL certificates used by the specified array. The first command saves the certificates to the variable $Cert1. The second and third commands display the certificates.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
False
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
-
False
+
false
False
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
false
+
false
False
-
None
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
@@ -11026,8 +13253,8 @@
Examples
- EXAMPLE 1
-
Get-PfaChapStatuses -Array $Array
+ EXAMPLE
+
Get-PfaChapStatuses -Array $array
Lists CHAP status of all hosts on the specified array.
@@ -11037,14 +13264,14 @@
Examples
Get-PfaConnectionKey
Displays a connection key that can be used to connect to this array.
-
+
Displays a connection key that can be used to connect to this array.
Shows host group performance statistics for IO that has been mirrored as part of an ActiveCluster connection for the host group named "HostGroupName" on the array "$Array".
Shows host group performance statistics for IO that has been mirrored as part of an ActiveCluster connection for the host group named "HostGroupName" on the array "$array".
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
@@ -12885,60 +15102,103 @@
Parameters
-HostGroupName
-
none
+
Target HostGroup name.
true
True (ByPropertyName)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details see about_Purity_Filtering. (Requires REST 1.7+)
+
false
+
False
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
False
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
-
False
+
false
False
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
false
+
false
False
-
None
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
False
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
-
False
+
false
False
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
false
+
false
False
-
None
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
@@ -13000,9 +15292,9 @@
Examples
- EXAMPLE 1
-
Get-PfaHostGroups -Array $Array
-
For array $Array, lists all host groups and their member hosts.
+ EXAMPLE
+
Get-PfaHostGroups -Array $array
+
For array $array, lists all host groups and their member hosts.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
@@ -13128,44 +15420,76 @@
Parameters
-HostGroupName
-
none
+
Target host group name.
true
True (ByPropertyName)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
False
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
-
False
+
false
False
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
false
+
false
False
-
None
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Shows host performance statistics for IO that has been mirrored as part of an ActiveCluster connection for the host named "HostName" on the array "$Array".
Shows host performance statistics for IO that has been mirrored as part of an ActiveCluster connection for the host named "HostName" on the array "$array".
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
@@ -13625,44 +15949,76 @@
Parameters
-Name
-
none
+
Target host name.
true
True (ByPropertyName)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
+
False
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
-
False
+
false
False
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
false
+
false
False
-
None
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
@@ -13716,60 +16072,103 @@
Parameters
-HostName
-
none
+
Target host name.
true
True (ByPropertyName)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
False
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
-
False
+
false
False
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
false
+
false
False
-
None
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-PreferredArray
+
+
Displays the preferred array or arrays for the new host. (Requires REST 1.5+)
false
+
True (ByPropertyName)
False
+
+
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
False
+
-
-WhatIf
-
wi
-
Shows what would happen if the cmdlet runs. The cmdlet is not run.
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
False
+
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
false
False
-
None
+
-
-PreferredArray
-
none
-
Displays the preferred array or arrays for the new host.
+
-WhatIf
+
wi
+
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
-
True (ByPropertyName)
+
false
+
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
@@ -13839,8 +16270,8 @@
Examples
- EXAMPLE 1
-
Get-PfaHosts -Array $Array
+ EXAMPLE
+
Get-PfaHosts -Array $array
Lists all hosts on the specified array.
@@ -13849,15 +16280,15 @@
Examples
Get-PfaHostSharedVolumeConnections
+
Lists volumes associated with the specified host and the LUNs used to address them.
Lists volumes associated with the specified host and the LUNs used to address them. Limited to shared connections.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
@@ -13884,44 +16315,76 @@
Parameters
-Name
-
none
+
Target host name.
true
True (ByPropertyName)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
False
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
-
False
+
false
False
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
false
+
false
False
-
None
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
@@ -14058,44 +16521,76 @@
Parameters
-Name
-
none
+
Target host name.
true
True (ByPropertyName)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
+
False
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
-
False
+
false
False
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
false
+
false
False
-
None
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Lists volumes associated with the host named "host1", with the LUNs used to address the volumes.
@@ -14114,15 +16609,15 @@
Examples
Get-PfaIdleTimeout
+
Displays the idle time limit, in minutes, of the Array GUI and CLI sessions.
Displays the idle time limit, in minutes, of the Purity GUI and CLI sessions. Users are automatically logged out a session that exceeds the idle timeout limit.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
-
false
-
False
-
False
-
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
@@ -14176,8 +16671,8 @@
Examples
- EXAMPLE 1
-
Get-PfaIdleTimeout -Array $Array
+ EXAMPLE
+
Get-PfaIdleTimeout -Array $array
Displays the idle time limit, in minutes, for the specified array.
@@ -14186,15 +16681,15 @@
Examples
Get-PfaInitiatorPorts
+
Lists host worldwide names (WWNs) and the array ports (targets) on which they are eligible to communicate.
Lists 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.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
+
False
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
-
False
+
false
False
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
false
+
false
False
-
None
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
@@ -14256,9 +16783,9 @@
Examples
- EXAMPLE 1
-
Get-PfaInitiatorPorts -Array $Array
-
For array $Array, lists host worldwide names and the array ports (targets) on which they are eligible to communicate.
+ EXAMPLE
+
Get-PfaInitiatorPorts -Array $array
+
For array $array, lists host worldwide names and the array ports (targets) on which they are eligible to communicate.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
+
true
+
True (ByPropertyName, ByValue)
+
None
+
+
+
-Names
+
+
Includes only named host groups (as a comma-separated list) in the result. The names parameter also accepts an asterisk ( * ) as a wildcard character.
+
true
+
True (ByPropertyName)
+
None
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
-
False
+
false
None
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
+
False
+
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
-
PurePowerShell.PureArray
+
PurePowerShell.PureArray
+ System.String
Outputs
@@ -14975,25 +17588,25 @@
Examples
- EXAMPLE 1
-
Get-PfaNamedCertificateAttributes -Array $Array
-
Lists the certificate attributes of all the certificates on the array "$Array".
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Names
+
+
Includes only named hosts (as a comma-separated list) in the result. The names parameter also accepts an asterisk ( * ) as a wildcard character.
+
true
+
True (ByPropertyName)
+
None
+
+
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
False
+
-
-Names
-
none
-
Includes only named host groups (as a comma-separated list) in the result. The names parameter also accepts an asterisk ( * ) as a wildcard character.
-
true
-
True (ByPropertyName)
-
None
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
+
False
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
-
False
+
false
False
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
false
+
false
False
-
None
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
@@ -15064,19 +17709,30 @@
Outputs
The output type is the type of the objects that the cmdlet emits.
Lists maximum physical space information of the pods named "pod1" and "pod2" on the array "$array". Those pods must not be in eradication pending state.
Lists maximum physical space information of the pods named "pod1" and "pod2" on the array "$Array". Those pods must not be in eradication pending state.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Names
+
+
Includes only named protection groups (as a comma-separated list) in the result. The names parameter also accepts an asterisk ( * ) as a wildcard character.
+
true
+
True (ByPropertyName)
+
None
+
+
+
-IncludePendingDeletes
+
+
Includes (true) destroyed protection groups that are in the eradication pending state
false
-
False
+
True (ByPropertyName)
False
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. See the "Sorting, Filtering, and Pagination" section of the REST API guide.
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
-
False
+
false
None
-
-IncludePendingDeletes
-
none
-
Includes (true) Pods that are in the eradication pending state. Time remaining in the eradication pending state is displayed in seconds.
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
-
True (ByPropertyName)
False
+
-
-Names
-
none
-
Target pod names
-
true
-
True (ByPropertyName)
-
None
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
-
-TimeRange
-
none
-
Time range for historical data with units. Valid historical values are: 1h, 3h, 24h, 7d, 30d, 90d, 1y.
-
true
-
True (ByPropertyName)
-
None
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
+
False
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
-
false
-
False
-
False
-
-
-
-IncludePendingDeletes
-
none
-
Includes (true) destroyed protection groups that are in the eradication pending state
-
false
-
True (ByPropertyName)
-
False
-
-Names
-
none
-
Includes only named protection groups (as a comma-separated list) in the result. The names parameter also accepts an asterisk ( * ) as a wildcard character.
+
+
Includes only named volume groups (as a comma-separated list) in the result. The names parameter also accepts an asterisk ( * ) as a wildcard character.
true
True (ByPropertyName)
None
-
-WhatIf
-
wi
-
Shows what would happen if the cmdlet runs. The cmdlet is not run.
+
-IncludePendingDeletes
+
+
Includes (true) destroyed volume groups that are in the eradication pending state. Time remaining is displayed in seconds.
false
-
False
+
True (ByPropertyName)
False
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
-
False
-
None
-
-
-
-
-
-
Inputs
-
The input type is the type of the objects that you can pipe to the cmdlet.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
-
true
-
True (ByPropertyName, ByValue)
+
false
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
-
False
+
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
-
None
+
-
-IncludePendingDeletes
-
none
-
Includes (true) destroyed volume groups that are in the eradication pending state. Time remaining is displayed in seconds.
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
-
True (ByPropertyName)
False
+
-
-Names
-
none
-
Includes only named volume groups (as a comma-separated list) in the result. The names parameter also accepts an asterisk ( * ) as a wildcard character.
-
true
-
True (ByPropertyName)
-
None
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
+
False
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
-
false
-
False
-
False
-
-
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
-
false
-
False
-
None
-
-Names
-
none
+
Comma seperated list of volume groups.
true
True (ByPropertyName)
@@ -15921,28 +18513,76 @@
Parameters
-TimeRange
-
none
+
Time range for historical data with units. Valid historical values are: 1h, 3h, 24h, 7d, 30d, 90d, 1y.
true
True (ByPropertyName)
None
+
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
+
False
+
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
-
false
-
False
-
False
-
-
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
-
false
-
False
-
None
-
-Names
-
none
+
Includes only named volume groups (as a comma-separated list) in the result. The names parameter also accepts an asterisk ( * ) as a wildcard character.
true
True (ByPropertyName)
@@ -16025,23 +18649,71 @@
Parameters
-TimeRange
-
none
+
Time range for historical data with units. Valid historical values are: 1h, 3h, 24h, 7d, 30d, 90d, 1y.
true
True (ByPropertyName)
None
+
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
+
False
+
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
-
false
-
False
-
False
+
-Names
+
+
Includes only named volumes (as a comma-separated list) in the result. The names parameter also accepts an asterisk ( * ) as a wildcard character.
+
true
+
True (ByPropertyName)
+
None
-IncludePendingDeletes
-
none
+
Includes (true) destroyed volumes that are in the eradication pending state. Time remaining is displayed in seconds.
false
True (ByPropertyName)
False
-
-Names
-
none
-
Includes only named volumes (as a comma-separated list) in the result. The names parameter also accepts an asterisk ( * ) as a wildcard character.
-
true
-
True (ByPropertyName)
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
None
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
+
False
+
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
-
False
+
false
False
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
false
+
false
False
-
None
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
@@ -16155,19 +18859,30 @@
Outputs
The output type is the type of the objects that the cmdlet emits.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
-
false
-
False
-
False
-
-
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
-
false
-
False
-
None
-
-Names
-
none
-
Comma seperated list of volume names.
+
+
Comma separated list of volume names.
true
True (ByPropertyName)
None
-TimeRange
-
none
+
Time range for historical data with units. Valid historical values are: 1h, 3h, 24h, 7d, 30d, 90d, 1y.
true
True (ByPropertyName)
None
+
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
+
False
+
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
-
false
-
False
-
False
-
-Names
-
none
+
Available in REST 1.7+. Limits the results to specific volumes (multiple volume names are separated by commas). Accepts asterisk(*) as a wildcard character.
true
True (ByPropertyName)
@@ -16314,31 +19053,71 @@
Parameters
-TimeRange
-
none
+
Time range for historical data with units. Valid historical values are: 1h, 3h, 24h, 7d, 30d, 90d, 1y.
true
True (ByPropertyName)
None
+
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
+
False
+
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
-
False
+
false
False
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
false
+
false
False
-
None
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
@@ -16350,19 +19129,30 @@
Outputs
The output type is the type of the objects that the cmdlet emits.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
-
false
-
False
-
False
-
-
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
-
false
-
False
+
-VolumeName
+
+
Volume name.
+
true
+
True (ByPropertyName)
None
-OffloadTargetName
-
none
+
Offload target name.
true
True (ByPropertyName)
None
-
-VolumeName
-
none
-
Volume name.
-
true
-
True (ByPropertyName)
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
None
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
+
False
+
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
-
None
+
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-SnapshotName
+
+
The name of the snapshot
+
true
+
True (ByPropertyName)
+
+
+
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
False
+
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
-
None
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
+
False
+
-WhatIf
@@ -17182,15 +20012,24 @@
Parameters
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
False
+
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
False
+
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
-
False
-
False
+
false
+
None
-
-WhatIf
-
wi
-
Shows what would happen if the cmdlet runs. The cmdlet is not run.
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
-
False
+
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
-
None
-
-
-
-
-
-
Inputs
-
The input type is the type of the objects that you can pipe to the cmdlet.
-
PurePowerShell.PureArray
-
-
-
Examples
-
-
-
- EXAMPLE 1
-
Get-PfaPendingDeleteVolumes -Array $Array
-
List only those volumes that are pending eradication on the specified array.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
-
true
-
True (ByPropertyName, ByValue)
-
None
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
false
False
-
False
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
-
False
+
false
False
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
false
+
false
False
-
None
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
@@ -17692,25 +20456,25 @@
Examples
- EXAMPLE 1
-
Get-PfaPendingDeleteVolumeSnapshots -Array $Array
-
List only those volume snapshots that are pending eradication on the specified array.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
-
None
+
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Namespace
+
+
Specify a namespace. Do not use to return all tags. In Purity, the namespace provides users with the option to create different sets of tags, without any overlap between the different sets. When tags are used without the namespace option, they are created in the default namespace.
+
false
+
True (ByPropertyName)
+
+
+
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
False
+
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. See the "Sorting, Filtering, and Pagination" section of the REST API guide.
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
-
None
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
+
False
+
-WhatIf
@@ -17757,15 +20553,24 @@
Parameters
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
False
+
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
False
+
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
-
PurePowerShell.PureArray
+
PurePowerShell.PureArray
+System.String
Outputs
@@ -17777,25 +20582,34 @@
Examples
- EXAMPLE 1
-
Get-PfaPendingPodFootprint -Array $Array
-
Lists maximum physical space information of pods eradication pending on the array "$Array".
+ EXAMPLE
+
Get-PfaPendingDeleteSnapshotsTags -Array $array
+
Returns all tags for snapshots that are in the pending eradication state on Array $array
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
False
+
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. See the "Sorting, Filtering, and Pagination" section of the REST API guide.
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
-
None
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
+
False
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
@@ -17862,25 +20708,25 @@
Examples
- EXAMPLE 1
-
Get-PfaPendingPodMediator -Array $Array
-
Lists mediator status of pods pending eradication on the array "$Array".
+ EXAMPLE
+
Get-PfaPendingDeleteVolumeGroups -Array $array
+
Lists volume groups that are in eradication pending state on the array "$array".
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
False
+
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. See the "Sorting, Filtering, and Pagination" section of the REST API guide.
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
-
None
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
+
False
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
PurePowerShell.PureArray
-
-
Outputs
-
The output type is the type of the objects that the cmdlet emits.
-
System.Object
-
Examples
- EXAMPLE 1
-
Get-PfaPendingPodSpace -Array $Array
-
Lists space consumption information of eradication pending pods on the array "$Array".
+ EXAMPLE
+
Get-PfaPendingDeleteVolumes -Array $array
+
List only those volumes that are pending eradication on the specified array.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
+
False
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
-
False
+
false
False
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
false
+
false
False
-
None
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
@@ -18027,25 +20932,25 @@
Examples
- EXAMPLE 1
-
Get-PfaPersonalities -Array $Array
-
Lists the personality settings associated with all hosts on the specified array.
+ EXAMPLE
+
Get-PfaPendingDeleteVolumeSnapshots -Array $array
+
List only those volume snapshots that are pending eradication on the specified array.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
-
None
+
-
-Name
-
none
-
Target host name.
-
true
+
-Namespace
+
+
Specifies a namespace in which to create the tag(s). The namespace option provides users with the option to create different sets of tags, without any overlap between the different sets. If not specified, the tag(s) are created in the default namespace. Namespaces can only start and end with a letter or a number. The tag namespace can consist of ASCII letters, numbers, and the following characters: Hyphen (-), underscore (_), dot (.), and slash (/). (Requires REST 1.19+)
+
false
True (ByPropertyName)
-
None
+
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Filter
+
+
+
false
+
false
+
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
False
+
-
-WhatIf
-
wi
-
Shows what would happen if the cmdlet runs. The cmdlet is not run.
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
False
+
+
+
+
-WhatIf
+
wi
+
+
false
+
false
+
+
+
+
-Confirm
+
cf
+
+
false
+
false
+
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
False
+
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
-
None
+
-
-Name
-
none
-
Target pod name.
-
true
-
True (ByPropertyName)
-
None
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
+
False
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
-
PurePowerShell.PureArray
-
-
-System.String
+
PurePowerShell.PureArray
-
-
Outputs
-
The output type is the type of the objects that the cmdlet emits.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
-
false
-
False
-
False
-
-
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. See the "Sorting, Filtering, and Pagination" section of the REST API guide.
-
false
-
False
-
None
-
-
-
-IncludePendingDeletes
-
none
-
Includes (true) Pods that are in the eradication pending state. Time remaining in the eradication pending state is displayed in seconds.
-
false
-
True (ByPropertyName)
-
False
-
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
-
False
+
false
False
-
-FailoverPreference
-
none
-
Comma seperated list of array names. Specifies which array within a stretched pod should be given priority to stay online, should the arrays ever lose contact with each other.
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
false
-
True (ByPropertyName)
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
-
false
-
False
-
False
-
-
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
-
false
-
False
-
None
-
-Name
-
none
-
Target protection group name.
+
+
Target pod name
true
True (ByPropertyName)
None
-
-OffloadTargetName
-
none
-
Name of the offload target.
-
true
+
-FailoverPreference
+
+
Displays which array within a stretched pod should be given priority to stay online, should the arrays ever lose contact with each other. (Requires REST 1.15+)
+
false
True (ByPropertyName)
-
None
+
False
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
(REST API 1.2+) Lists protection groups and their attributes.
-
+
Get-PfaPodReplicaLink
+
Returns replica-link information, including status, direction, lag, local pod name, remote array, remote pod name, and recovery point, of all linked pods on the array.
+
Returns replica-link information, including status, direction, lag, local pod name, remote array, remote pod name, and recovery point, of all linked pods on the array. A historical time range may also be specified.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
-
None
+
-
-IncludePending
-
none
-
Include protection groups that have been destroyed and are pending eradication.
+
-Lag
+
+
When specified, the replica-link information shows the following details: lag.avg - average lag measured in microseconds. lag.max - maximum lag measured in microseconds. local_pod_name - name of the local pod. recovery_point - timestamp in milliseconds of the most recent changes that can be recovered. remote_names - name of the remote array. remote_pod_name - name of the remote pod. status - status for replica link. Valid values are baselining, paused, quiescing, quiesced, replicating, and unhealthy.
false
True (ByPropertyName)
-
False
+
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-TimeRange
+
+
Time range for historical data with units. Valid historical values are: 1h, 3h, 24h, 7d, 30d, 90d, 1y.
false
-
False
-
False
+
True (ByPropertyName)
+
-WhatIf
@@ -19274,54 +22143,78 @@
Parameters
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
False
-
False
+
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
false
False
-
None
+
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Lists all protection groups and their attributes for the specified array, including protection groups that have been destroyed and are pending eradication.
(REST API 1.2+) Lists the snapshot/replication schedule for the specified protection group.
-
+
Get-PfaPodReplicaLinkHistory
+
Returns historical replica-link information, including status, direction, lag, local pod name, remote array, remote pod name, and recovery point, of all linked pods on the array.
+
Returns historical replica-link information, including status, direction, lag, local pod name, remote array, remote pod name, and recovery point, of all linked pods on the array.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-IncludePendingDeletes
+
+
Includes (true) Pods that are in the eradication pending state. Time remaining in the eradication pending state is displayed in seconds.
false
+
True (ByPropertyName)
False
+
+
+
-FailoverPreference
+
+
Comma seperated list of array names. Specifies which array within a stretched pod should be given priority to stay online, should the arrays ever lose contact with each other. (Requires REST 1.15+)
+
false
+
True (ByPropertyName)
False
@@ -19442,38 +22367,58 @@
Parameters
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
-
False
+
false
False
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
false
+
false
False
-
None
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
@@ -19591,71 +22528,116 @@
Parameters
-Name
-
none
+
Target protection group name.
true
True (ByPropertyName)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-OffloadTargetName
+
+
Name of the offload target.
+
true
+
True (ByPropertyName)
+
None
+
+
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
False
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
-
False
+
false
False
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
false
+
false
False
-
None
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
PurePowerShell.PureArray
-
+
System.String
+
+
Outputs
+
The output type is the type of the objects that the cmdlet emits.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
@@ -19682,71 +22664,119 @@
Parameters
-Name
-
none
-
Target protection group name.
+
+
protection group name.
true
True (ByPropertyName)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-IncludeArray
+
+
Include the array details.
+
false
+
True (ByPropertyName)
+
False
+
+
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
False
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
-
False
+
false
False
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
false
+
false
False
-
None
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
@@ -19773,71 +22803,127 @@
Parameters
-Name
-
none
-
Target protection group snapshot name.
+
+
protection group name.
true
True (ByPropertyName)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-IncludeArray
+
+
include array details.
+
false
+
True (ByPropertyName)
+
False
+
+
+
-Historical
+
+
Time range for historical data with units. Valid historical values are: 1h, 3h, 24h, 7d, 30d, 90d, 1y.
+
false
+
True (ByPropertyName)
+
None
+
+
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
False
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
-
False
+
false
False
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
false
+
false
False
-
None
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
False
+
-
-Name
-
none
-
Target volume name.
-
true
-
True (ByPropertyName)
-
None
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
+
False
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-IncludePending
+
+
Include protection groups that have been destroyed and are pending eradication.
false
+
True (ByPropertyName)
False
-
False
+
+
+
-OffloadTargetName
+
+
Displays protection groups with a specified Azure Blob, NFS, or S3 offload target. (Requires REST 1.14+)
+
false
+
True (ByPropertyName)
+
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
-
False
+
false
None
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
+
False
+
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Lists all protection groups and their attributes for the specified array, including protection groups that have been destroyed and are pending eradication.
Displays the proxy host for the phonehome facility when HTTPS is the phonehome protocol (the phonehome facility itself determines which protocol to use).
-
+
Get-PfaProtectionGroupSchedule
+
Lists the snapshot/replication schedule for the specified protection group. (Requires REST 1.2+)
+
Lists the snapshot/replication schedule for the specified protection group. (Requires REST 1.2+)
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-User
-
none
-
The user whose public key is requested.
-
true
-
True (ByPropertyName)
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
False
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
-
True (ByPropertyName)
+
True (ByPropertyName, ByValue)
None
-
-Array
-
none
-
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
+
-Name
+
+
Target protection group name.
true
-
True (ByPropertyName, ByValue)
+
True (ByPropertyName)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
False
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
PurePowerShell.PureArray
- System.String
+
+
+System.String
-
-
Outputs
-
The output type is the type of the objects that the cmdlet emits.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Name
+
+
Target protection group name.
+
true
+
True (ByPropertyName)
+
None
+
+
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
False
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
-
False
+
false
False
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
false
+
false
False
-
None
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
-
PurePowerShell.PureArray
+
PurePowerShell.PureArray
+
+
+System.String
-
-
Outputs
-
The output type is the type of the objects that the cmdlet emits.
Lists recent audit records. 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.
-
+
Get-PfaProtectionGroupSnapshotSpaceMetrics
+
Lists the space consumption for all snapshots in the specified protection group. (Requires REST API 1.2+)
+
Lists the space consumption for all snapshots in the specified protection group. (Requires REST API 1.2+)
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-User
-
none
-
Name of target user.
-
false
+
-Name
+
+
Target protection group name.
+
true
True (ByPropertyName)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
False
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
-
False
+
false
False
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
false
+
false
False
-
None
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
PurePowerShell.PureArray
-
+
System.String
@@ -20468,28 +23803,25 @@
Examples
- EXAMPLE 1
-
Get-PfaRecentAuditRecords -Array $Array
-
Lists recent audit records for all users on the specified array.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Name
+
+
Target protection group snapshot name.
+
true
+
True (ByPropertyName)
+
None
+
+
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
False
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
-
False
+
false
False
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
false
+
false
False
-
None
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
-
PurePowerShell.PureArray
+
PurePowerShell.PureArray
+
+
+System.String
Examples
- EXAMPLE 1
-
Get-PfaRecentMessages -Array $Array
-
Lists recent alerts, audit records, and user session logs for the specified array.
(REST API 1.4+) Lists recent user login sessions. A user session log event is considered recent if the login, logout, or authentication event occurred within the past 24 hours.
-
+
Get-PfaProtectionGroupVolumeSpaceMetrics
+
Gets size and space consumption information items listed below for each volume associated with each specified protection group. (Requires REST 1.2+)
+
Gets size and space consumption information items listed below for each volume associated with each specified protection group. (Requires REST 1.2+)
Displays 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.
-
+
Get-PfaProtocolEndpointVolume
+
Lists the attributes for the specified protocol endpoint volume.
+
Lists the attributes for the specified protocol endpoint volume.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
False
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
PurePowerShell.PureArray
+
+
Outputs
+
The output type is the type of the objects that the cmdlet emits.
+
System.Object
+
Examples
- EXAMPLE 1
-
Get-PfaRemoteAssistSession -Array $Array
-
Lists the status (enabled or disabled) of the remote assist session on the specified array.
+ EXAMPLE
+
Get-PfaProtocolEndpointVolumes -Array $array
+
Lists attributes for all protocol endpoint volumes on the array "$array".
(REST API 1.13+) Lists the attributes for the specified host on the current array or connected array (the connected array has to be connected to current array with "sync-replication"). The remote host name needs to have the format: "<connected array name>:<host name>".
-
(REST API 1.13+) Lists the attributes for the specified remote host.
+
Get-PfaProxy
+
Displays the proxy host for the phonehome facility when HTTPS is the phonehome protocol.
+
Displays the proxy host for the phonehome facility when HTTPS is the phonehome protocol. The phonehome facility itself determines which protocol to use.
(REST API 1.13+) Lists the attributes for the specified host group on the current array or connected array (the connected array has to be connected to current array with "sync-replication"). The remote host group name needs to have the format: "<connected array name>:<host group name>".
-
(REST API 1.13+) Lists the attributes for the specified remote host group.
+
Get-PfaPublicKey
+
Gets public key information for the specified user.
+
Gets public key information for the specified user.
(REST API 1.13+) Lists the attributes for all the host groups on both connected array and current array (the connected array has to be connected to current array with "sync-replication").
-
(REST API 1.13+) Lists the attributes all remote host groups.
+
Get-PfaPureAppAttributes
+
Lists the attributes of the installed Pure Application. (Requires REST 1.9+)
+
Lists the attributes of the installed Pure Application. Refer to the FlashArray user guide for details about Pure applications. (Requires REST 1.9+)
(REST API 1.13+) Lists the connections between a host group and volumes on the connected array. Volumes have to be created within pods which are stretched to the current array. The remote host group name has the format: "<array name>:<host group name>"
-
(REST API 1.13+) Lists the remote host group volume connections for the specified host group.
+
Get-PfaPureAppsAttributes
+
Lists attributes of the installed Pure Applications. (Requires REST API 1.9+)
+
Lists attributes of the installed Pure Applications. (Refer to the FlashArray user guide for details about Pure applications). (Requires REST API 1.9+)
(REST API 1.13+) Lists the attributes for all the hosts on both connected array and current array (the connected array has to be connected to current array with "sync-replication").
-
(REST API 1.13+) Lists all the remote hosts.
+
Get-PfaRecentAuditRecords
+
Lists recent audit records.
+
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.
Display the specified pods on the specified remote arrays but not stretched to this array.
-
Displays the pod that are on the specified remote arrays but not stretched to this array. Pods that are stretched to this array will not appear in the list. Enter multiple remote array names in comma-separated format. The remote array name can be set to asterisk (*) to represent all remote arrays.
+
Get-PfaRecentMessages
+
Lists recent alerts, audit records, and user session logs.
+
Lists recent alerts, audit records, and user session logs.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
-
false
-
False
-
False
-
-
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
-
false
-
False
-
None
-
-
-
-Names
-
none
-
Target pod names. Specify the pod names in comma seperated list.
-
true
-
True (ByPropertyName)
-
None
-
-
-
-On
-
none
-
Displays the pod that are on the specified remote arrays but not stretched to this array. Pods that are stretched to this array will not appear in the list. Enter multiple remote array names in comma-separated format. The remote array name can be set to asterisk (*) to represent all remote arrays.
-
true
-
True (ByPropertyName)
-
None
-
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
-
PurePowerShell.PureArray
-
-
-System.String
+
PurePowerShell.PureArray
-
-
Outputs
-
The output type is the type of the objects that the cmdlet emits.
(REST API 1.13+) Lists the connections between a volume and hosts on the connected array. The volume has to be created within a pod which is stretched to the current array. The volume name has the format: "<pod name>::<volume name>".
-
(REST API 1.13+) Lists all the remote volume host connection for the specified volume.
+
Get-PfaRecentUserSessionRecords
+
Lists recent user login sessions. (Requires REST 1.4+)
+
Lists recent user login sessions. A user session log event is considered recent if the login, logout, or authentication event occurred within the past 24 hours. (Requires REST 1.4+)
(REST API 1.13+) Lists the connections between a volume and host groups on the connected array. The volume has to be created within a pod which is stretched to the current array. The volume name has the format: "<pod name>::<volume name>".
-
(REST API 1.13+) Lists all the remote volume host group connection for the specified volume.
+
Get-PfaRelayHost
+
Displays 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.
+
Displays 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.
Displays 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.
-
+
Get-PfaRemoteAssistSession
+
Lists information about the status (enabled or disabled) of a remote assist session.
+
Lists information about the status (enabled or disabled) of a remote assist session.
Displays the domain name from which Purity sends email alert messages.
-
+
Get-PfaRemoteHost
+
Lists the attributes for the specified host on the current array or connected array. (Requires REST 1.13+)
+
Lists the attributes for the specified host on the current array or connected array. The connected array has to be connected to the current array with "sync-replication". The remote host name must have the format: "<connected array name>:<host name>". (Requires REST 1.13+)
Displays SMTP manager attributes and sender domain name.
-
Displays SMTP manager attributes and sender domain name.
+
Get-PfaRemoteHostGroup
+
Lists the attributes for the specified host group on the current array or connected array. (Requires REST 1.13+)
+
Lists the attributes for the specified host group on the current array or connected array. The connected array has to be connected to current array with "sync-replication". The remote host group name must have the format: "<connected array name>:<host group name>". (Requires REST 1.13+)
Lists size and space consumption attributes for the snapshots of the specified volume.
-
+
Get-PfaRemoteHostGroups
+
Lists the attributes for all the host groups on both connected array and current array. (Requires REST 1.13+)
+
Lists the attributes for all the host groups on both connected array and current array. The connected array has to be connected to current array with "sync-replication". (Requires REST 1.13+)
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-IncludePendingDeletes
-
none
-
Includes (true) destroyed snapshots that are in the eradication pending state.
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
-
True (ByPropertyName)
False
+
-
-Name
-
none
-
Volume name.
-
true
-
True (ByPropertyName)
-
None
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
False
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
-
False
+
false
False
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
false
+
false
False
-
None
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Lists size and space consumption attributes for all snapshots taken of volume "vol1" (not including destroyed snapshots in the eradication pending state).
Lists size and space consumption attributes for all snapshots taken of volume "vol1", including snapshots that have been destroyed within the past 24 hours and are still in the eradication pending state.
+ EXAMPLE
+
Get-PfaRemoteHostGroups -Array $CurrentArray
+
Gets attributes for all host groups which are created on both array $CurrentArray and connected array.
Lists communication and security attributes for the specified SNMP manager.
-
+
Get-PfaRemoteHostGroupVolumeConnections
+
Lists the connections between a host group and volumes on the connected array. (Requires REST 1.13+)
+
Lists the connections between a host group and volumes on the connected array. Volumes have to be created within pods which are stretched to the current array. The remote host group name has the format: "<array name>:<host group name>". (Requires REST 1.13+)
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Name
-
none
-
Targe SNMP manager name.
+
-HostGroupName
+
+
Name of the target host group.
true
True (ByPropertyName)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
False
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Lists an array's SNMP managers and their communication and security attributes.
-
+
Get-PfaRemoteHosts
+
Lists the attributes for all the hosts on both connected array and current array. (Requires REST 1.13+)
+
Lists the attributes for all the hosts on both connected array and current array. The connected array has to be connected to current array with "sync-replication". (Requires REST 1.13+)
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-PreferredArray
+
+
Displays the preferred array or arrays for the remote hosts. (Requires REST 1.5+)
+
false
+
True (ByPropertyName)
+
None
+
+
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
False
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
-
False
+
false
False
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
false
+
false
False
-
None
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Lists installed applications and their installation statuses.
-
Lists installed applications and their installation statuses.
+
Get-PfaRemotePod
+
Display the specified pods on the specified remote arrays but not stretched to this array.
+
Displays the pod that are on the specified remote arrays but not stretched to this array. Pods that are stretched to this array will not appear in the list. Enter multiple remote array names in comma-separated format. The remote array name can be a wildcard (*) to represent all remote arrays.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Catalog
-
none
-
When specified, lists all available and installed software applications
-
false
+
-Names
+
+
Target pod names. Specify the pod names in comma seperated list.
+
true
True (ByPropertyName)
-
False
-
-
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
-
false
-
False
-
False
+
None
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
-
false
-
False
+
-On
+
+
Displays the pod that are on the specified remote arrays but not stretched to this array. Pods that are stretched to this array will not appear in the list. Enter multiple remote array names in comma-separated format. The remote array name can be set to asterisk (*) to represent all remote arrays.
+
true
+
True (ByPropertyName)
None
@@ -22080,19 +25524,27 @@
Parameters
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Lists installed applications and their attributes.
-
Lists installed applications and their attributes.
+
Get-PfaRemoteVolumeHostConnections
+
Lists the connections between a volume and hosts on the connected array. (Requires REST 1.13+)
+
Lists the connections between a volume and hosts on the connected array. The volume has to be created within a pod which is stretched to the current array. The volume name has the format: "<pod name>::<volume name>". (Requires REST 1.13+)
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
-
false
-
False
-
False
+
-VolumeName
+
+
Name of the target volume.
+
true
+
True (ByPropertyName)
+
None
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
-
False
+
false
None
-
-WhatIf
-
wi
-
Shows what would happen if the cmdlet runs. The cmdlet is not run.
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
False
+
-
-
-
-
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
+
False
+
+
+
+
-WhatIf
+
wi
+
Shows what would happen if the cmdlet runs. The cmdlet is not run.
+
false
+
false
+
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
+
False
+
+
+
+
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Lists the connections between a volume and host groups on the connected array. (Requires REST 1.13+)
+
Lists the connections between a volume and host groups on the connected array. The volume has to be created within a pod which is stretched to the current array. The volume name has the format: "<pod name>::<volume name>". (Requires REST 1.13+)
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-VolumeName
+
+
Name of target volume.
+
true
+
True (ByPropertyName)
+
None
+
+
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
False
+
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
-
None
+
-
-Name
-
none
-
Name of the software app.
-
true
-
True (ByPropertyName)
-
None
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
+
False
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
(REST API 1.2+) Get the snapshot/replication retention list from the source only.
-
+
Get-PfaScsiTimeout
+
Displays the amount of time (in seconds) that can lapse during an I/O interruption before the target ports log out of the Array fabric.
+
Displays the amount of time (in seconds) that can lapse during an I/O interruption before the target ports log out of the Array fabric. The default timeout value is 60 seconds.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Subnet
-
none
-
Name of subnet.
+
-Name
+
+
Volume name.
true
True (ByPropertyName)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-IncludePendingDeletes
+
+
Includes (true) destroyed snapshots that are in the eradication pending state.
+
false
+
True (ByPropertyName)
+
False
+
+
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
False
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Lists size and space consumption attributes for all snapshots taken of volume "vol1" (not including destroyed snapshots in the eradication pending state).
Lists size and space consumption attributes for all snapshots taken of volume "vol1", including snapshots that have been destroyed within the past 24 hours and are still in the eradication pending state.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
-
None
+
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-IncludePendingDeletes
+
+
If specified, returns only objects from destroyed resources. Returns an error if the name of a live resource is specified with the -IsPendingDeletes parameter. If not specified, returns only objects from live resources. Returns an error if the name of a destroyed resource is specified with the -IsPendingDeletes parameter.
+
false
+
True (ByPropertyName)
+
+
+
+
-Namespace
+
+
A comma-separated list of namespaces. The namespace option provides users with the option to create different sets of tags, without any overlap between the different sets. (Requires REST 1.19+)
+
false
+
True (ByPropertyName)
+
+
+
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
False
+
-WhatIf
@@ -22640,40 +26271,64 @@
Parameters
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
False
+
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
False
+
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
-
None
+
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Name
+
VolumeName
+
The name of the snapshot to retrieve the tags for.
+
true
+
True (ByPropertyName)
+
+
+
+
-IncludePendingDeletes
+
+
If specified, returns only objects from destroyed resources. Returns an error if the name of a live resource is specified with the -IsPendingDeletes parameter. If not specified, returns only objects from live resources. Returns an error if the name of a destroyed resource is specified with the -IsPendingDeletes parameter.
+
false
+
True (ByPropertyName)
+
+
+
+
-Namespace
+
+
A comma-separated list of namespaces. The namespace option provides users with the option to create different sets of tags, without any overlap between the different sets. (Requires REST 1.19+)
+
false
+
True (ByPropertyName)
+
+
+
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
False
+
-WhatIf
@@ -22712,48 +26423,64 @@
Parameters
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
False
-
False
+
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
false
False
-
None
+
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
(REST API 1.13+) Lists all the volume connections with host and host groups. If the "Remote" flag is set, the returned list will also include connections on the connected array (the connected array has to be connected to current array with "sync-replication")., and volumes have to be created within pods.
-
(REST API 1.13+) Lists all the volume connections, including host and host group connections. Can also include remote volumes.
+
Get-PfaSoftwareAttribute
+
Lists installed applications and their attributes.
+
Lists installed applications and their attributes.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
False
+
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
-
None
+
-
-Name
-
none
-
Target volume group name.
-
true
-
True (ByPropertyName)
-
None
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
+
False
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Get historical performance(latency) data at a specified resolution for the specified volume group. Valid historical values are: 1h, 3h, 24h, 7d, 30d, 90d, 1y.
-
Get historical performance(latency) data at a specified resolution for the specified volume group. Valid historical values are: 1h, 3h, 24h, 7d, 30d, 90d, 1y.
+
Get-PfaSourceProtectionGroups
+
Lists protection groups and their attributes. (Requires REST 1.2+)
+
Lists protection groups and their attributes. Limited to groups created on this array. (Requires REST 1.2+)
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
-
False
+
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
-
None
+
-
-Name
-
none
-
Target volume group name.
-
true
-
True (ByPropertyName)
-
None
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
-
-TimeRange
-
none
-
Time range for historical data with units. Valid historical values are: 1h, 3h, 24h, 7d, 30d, 90d, 1y.
-
true
-
True (ByPropertyName)
-
None
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
+
False
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
-
PurePowerShell.PureArray
-
-
-System.String
+
PurePowerShell.PureArray
-
-
Outputs
-
The output type is the type of the objects that the cmdlet emits.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
False
+
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
-
None
+
-
-Name
-
none
-
Name of the target volume group
-
true
-
True (ByPropertyName)
-
None
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
+
False
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
-
PurePowerShell.PureArray
- System.String
+
PurePowerShell.PureArray
-
-
Outputs
-
The output type is the type of the objects that the cmdlet emits.
(REST API 1.13+) Lists IO metrics for specific volume group including average IO size
-
(REST API 1.13+) Lists IO metrics for specific volume group including average IO size
+
Get-PfaSubnet
+
Returns the attributes for the specified network subnet. (Requires REST 1.5+)
+
Returns the attributes for the specified network subnet on the array. (Requires REST 1.5+)
In Purity//FA, interfaces with common attributes can be organized into subnetworks, (or subnets) to enhance the efficiency of data (iSCSI, NVMe-RoCE, or file), management, and replication traffic if applicable.
If the subnet is assigned a valid IP address, once it is created, all of its enabled interfaces are immediately available for connection. The subnet inherits the services from all of its interfaces. Likewise, the interfaces contained in the subnet inherit the netmask, gateway, MTU, and VLAN ID (if applicable) attributes from the subnet.
Physical, virtual, and bond interfaces can belong to the same subnet. VLAN interfaces can only belong to subnets with other VLAN interfaces.
Physical, virtual, and bond interfaces in a subnet share common address, netmask, and MTU attributes. The subnet can contain a mix of physical, virtual, and bond interfaces, and the interface services can be of any type, such as iSCSI, management, NVMe-RoCE, or replication services. To add physical, virtual, or bond interfaces to a subnet, create the subnet and then run purenetwork eth setattr --subnet to add the interfaces to the subnet.
A VLAN interface is a dedicated virtual network interface that is designed to be used with an organization’s virtual local area network (VLAN). Through VLAN interfaces, Purity//FA employs VLAN tags to ensure the data passing between the array and VLANs is securely isolated and routed properly.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
-
False
+
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
-
None
+
-
-IncludePendingDeletes
-
none
-
Includes (true) destroyed volume groups that are in the eradication pending state. Time remaining is displayed in seconds.
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
-
True (ByPropertyName)
False
+
-
-Qos
-
none
-
Displays (true) the QoS information for each volume group. A bandwidth limit of null represents unlimited throughput. Optional.
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
false
-
True (ByPropertyName)
False
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Name
+
+
Target protection group name.
+
true
+
True (ByPropertyName)
+
None
+
+
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
False
+
-
-IncludePendingDeletes
-
none
-
Includes (true) objects that are in the eradication pending state. Time remaining in the eradication pending state is displayed in seconds.
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
-
True (ByPropertyName)
False
+
-
-Name
-
none
-
Name of target volume group
-
true
-
True (ByPropertyName)
-
None
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
+
False
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Lists shared connections for the specified volume.
-
+
Get-PfaVolumeConnection
+
Lists all the volume connections with host and host groups. (Requires REST 1.13+)
+
Lists all the volume connections with host and host groups. If the "Remote" flag is set, the returned list will also include connections on the connected array (the connected array has to be connected to current array with "sync-replication")., and volumes have to be created within pods. (Requires REST 1.13+)
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-VolumeName
-
none
-
Target volume name.
-
true
+
-Remote
+
+
Include remote volumes in the results.
+
false
True (ByPropertyName)
+
False
+
+
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
False
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
-
False
+
false
False
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
false
+
false
False
-
None
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
PurePowerShell.PureArray
-
-
-System.String
+ System.Management.Automation.SwitchParameter
+
+
Outputs
+
The output type is the type of the objects that the cmdlet emits.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Name
+
+
Target volume group name.
+
true
+
True (ByPropertyName)
+
None
+
+
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
-
False
+
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
-
None
+
-
-TimeRange
-
none
-
Time range for historical data with units. Valid historical values are: 1h, 3h, 24h, 7d, 30d, 90d, 1y.
-
true
-
True (ByPropertyName)
-
None
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
-
-VolumeName
-
none
-
Target volume name.
-
true
-
True (ByPropertyName)
-
None
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
+
False
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Get historical performance (latency) data at a specified resolution for the specified volume group.
+
Get historical performance (latency) data at a specified resolution for the specified volume group. Valid historical values are: 1h, 3h, 24h, 7d, 30d, 90d, 1y.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-VolumeName
-
none
-
Target volume name.
+
-Name
+
+
Target volume group name.
true
True (ByPropertyName)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-TimeRange
+
+
Time range for historical data with units. Valid historical values are: 1h, 3h, 24h, 7d, 30d, 90d, 1y.
+
true
+
True (ByPropertyName)
+
None
+
+
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
False
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
-
False
+
false
False
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
false
+
false
False
-
None
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
PurePowerShell.PureArray
-
+
System.String
+
+
Outputs
+
The output type is the type of the objects that the cmdlet emits.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-VolumeName
-
none
-
Target volume name.
+
-Name
+
+
Name of the target volume group
true
True (ByPropertyName)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
False
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
-
False
+
false
False
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
false
+
false
False
-
None
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
PurePowerShell.PureArray
-
-
-System.String
+ System.String
+
+
Outputs
+
The output type is the type of the objects that the cmdlet emits.
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
False
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
-
False
+
false
False
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
false
+
false
False
-
None
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
PurePowerShell.PureArray
-
-
-System.String
+ System.String
+
+
Outputs
+
The output type is the type of the objects that the cmdlet emits.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Name
+
+
Name of target volume group
+
true
+
True (ByPropertyName)
+
None
+
+
+
-TimeRange
+
+
Time range for historical data with units. Valid historical values are: 1h, 3h, 24h, 7d, 30d, 90d, 1y.
+
true
+
True (ByPropertyName)
+
None
+
+
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
False
+
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
-
None
+
-
-Name
-
none
-
Target volume name
-
true
-
True (ByPropertyName)
-
None
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
+
False
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Shows volume performance statistics for IO that has been mirrored as part of an ActiveCluster connection for the volume named "VolumeName" on the array "$Array".
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-VolumeName
-
none
-
Target volume name.
-
true
+
-IncludePendingDeletes
+
+
Includes (true) destroyed volume groups that are in the eradication pending state. Time remaining is displayed in seconds.
+
false
+
True (ByPropertyName)
+
False
+
+
+
-QoS
+
+
Indicates whether to retrieve QoS metrics for volume. (Requires REST 1.14+)
+
false
True (ByPropertyName)
+
+
+
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
+
False
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
-
False
+
false
False
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
false
+
false
False
-
None
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
PurePowerShell.PureArray
-
-
-System.String
+ System.Management.Automation.SwitchParameter
-
-
-
-
Get-PfaVolumes
-
Lists volumes and their attributes.
-
-
-
-
Syntax
-
+
+
Outputs
+
The output type is the type of the objects that the cmdlet emits.
+
System.Object
+
+
+
Examples
+
+
+
+ EXAMPLE
+
Get-PfaVolumeGroups -Array $array
+
Lists all alive volume groups on the array "$array".
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
+
true
+
True (ByPropertyName, ByValue)
+
None
+
+
+
-VolumeName
+
+
Target volume name.
+
true
+
True (ByPropertyName)
+
None
+
+
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
+
False
+
+
+
+
-WhatIf
+
wi
+
Shows what would happen if the cmdlet runs. The cmdlet is not run.
+
false
+
false
+
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
+
False
+
+
+
+
+
+
Inputs
+
The input type is the type of the objects that you can pipe to the cmdlet.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
+
true
+
True (ByPropertyName, ByValue)
+
None
+
+
+
-VolumeName
+
+
Target volume name.
+
true
+
True (ByPropertyName)
+
None
+
+
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
+
False
+
+
+
+
-WhatIf
+
wi
+
Shows what would happen if the cmdlet runs. The cmdlet is not run.
+
false
+
false
+
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
+
False
+
+
+
+
+
+
Inputs
+
The input type is the type of the objects that you can pipe to the cmdlet.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
+
true
+
True (ByPropertyName, ByValue)
+
None
+
+
+
-VolumeName
+
+
Target volume name.
+
true
+
True (ByPropertyName)
+
None
+
+
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
+
False
+
+
+
+
-WhatIf
+
wi
+
Shows what would happen if the cmdlet runs. The cmdlet is not run.
+
false
+
false
+
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
+
False
+
+
+
+
+
+
Inputs
+
The input type is the type of the objects that you can pipe to the cmdlet.
+
PurePowerShell.PureArray
+
+
+System.String
+
+
+
Outputs
+
The output type is the type of the objects that the cmdlet emits.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
+
true
+
True (ByPropertyName, ByValue)
+
None
+
+
+
-VolumeName
+
+
Target volume name.
+
true
+
True (ByPropertyName)
+
None
+
+
+
-TimeRange
+
+
Time range for historical data with units. Valid historical values are: 1h, 3h, 24h, 7d, 30d, 90d, 1y.
+
true
+
True (ByPropertyName)
+
None
+
+
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
+
False
+
+
+
+
-WhatIf
+
wi
+
Shows what would happen if the cmdlet runs. The cmdlet is not run.
+
false
+
false
+
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
+
False
+
+
+
+
+
+
Inputs
+
The input type is the type of the objects that you can pipe to the cmdlet.
+
PurePowerShell.PureArray
+
+
+System.String
+
+
+
Outputs
+
The output type is the type of the objects that the cmdlet emits.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
+
true
+
True (ByPropertyName, ByValue)
+
+
+
+
-VolumeName
+
+
Target volume name.
+
true
+
True (ByPropertyName)
+
+
+
+
-TimeRange
+
+
Time range for historical data with units. Valid historical values are: 1h, 3h, 24h, 7d, 30d, 90d, 1y.
+
true
+
True (ByPropertyName)
+
+
+
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
+
False
+
+
+
+
-WhatIf
+
wi
+
+
false
+
false
+
+
+
+
-Confirm
+
cf
+
+
false
+
false
+
+
+
+
+
+
+
Inputs
+
The input type is the type of the objects that you can pipe to the cmdlet.
+
PurePowerShell.PureArray
+System.String
+
+
+
Outputs
+
The output type is the type of the objects that the cmdlet emits.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
+
true
+
True (ByPropertyName, ByValue)
+
None
+
+
+
-VolumeName
+
+
Target volume name.
+
true
+
True (ByPropertyName)
+
None
+
+
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
+
False
+
+
+
+
-WhatIf
+
wi
+
Shows what would happen if the cmdlet runs. The cmdlet is not run.
+
false
+
false
+
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
+
False
+
+
+
+
+
+
Inputs
+
The input type is the type of the objects that you can pipe to the cmdlet.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
+
true
+
True (ByPropertyName, ByValue)
+
None
+
+
+
-VolumeName
+
+
Target volume name.
+
true
+
True (ByPropertyName)
+
None
+
+
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
+
False
+
+
+
+
-WhatIf
+
wi
+
Shows what would happen if the cmdlet runs. The cmdlet is not run.
+
false
+
false
+
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
+
False
+
+
+
+
+
+
Inputs
+
The input type is the type of the objects that you can pipe to the cmdlet.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
+
true
+
True (ByPropertyName, ByValue)
+
None
+
+
+
-VolumeName
+
+
Target volume name.
+
true
+
True (ByPropertyName)
+
None
+
+
+
-TimeRange
+
+
Time range for historical data with units. Valid historical values are: 1h, 3h, 24h, 7d, 30d, 90d, 1y.
+
true
+
True (ByPropertyName)
+
None
+
+
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
+
False
+
+
+
+
-WhatIf
+
wi
+
Shows what would happen if the cmdlet runs. The cmdlet is not run.
+
false
+
false
+
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
+
False
+
+
+
+
+
+
Inputs
+
The input type is the type of the objects that you can pipe to the cmdlet.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
+
true
+
True (ByPropertyName, ByValue)
+
None
+
+
+
-Name
+
+
Target volume name
+
true
+
True (ByPropertyName)
+
None
+
+
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
+
False
+
+
+
+
-WhatIf
+
wi
+
Shows what would happen if the cmdlet runs. The cmdlet is not run.
+
false
+
false
+
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
+
False
+
+
+
+
+
+
Inputs
+
The input type is the type of the objects that you can pipe to the cmdlet.
+
PurePowerShell.PureArray
+ System.String
+
+
+
Outputs
+
The output type is the type of the objects that the cmdlet emits.
Shows volume performance statistics for IO that has been mirrored as part of an ActiveCluster connection for the volume named "VolumeName" on the array "$array".
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
False
+
+
+
+
-WhatIf
+
wi
+
Shows what would happen if the cmdlet runs. The cmdlet is not run.
+
false
+
false
+
-Confirm
cf
Prompts you for confirmation before running the cmdlet.
false
+
false
+
+
+
+
+
+
+
Inputs
+
The input type is the type of the objects that you can pipe to the cmdlet.
+
PurePowerShell.PureArray
+System.String
+
+
+
Outputs
+
The output type is the type of the objects that the cmdlet emits.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
+
true
+
True (ByPropertyName, ByValue)
+
None
+
+
+
-VolumeName
+
+
Target volume name.
+
true
+
True (ByPropertyName)
+
None
+
+
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
False
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
-
False
+
false
False
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
false
+
false
False
+
+
+
+
+
+
Inputs
+
The input type is the type of the objects that you can pipe to the cmdlet.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
+
true
+
True (ByPropertyName, ByValue)
None
+
+
-IncludePendingDeletes
+
+
Includes (true) destroyed volumes that are in the eradication pending state. Time remaining in the eradication pending state is displayed in seconds.
+
false
+
True (ByPropertyName)
+
False
+
-QoS
-
none
-
Indicates whether to retrieve QoS metrics for volume.
+
+
Indicates whether to retrieve QoS metrics for volume. (Requires REST 1.14+)
false
True (ByPropertyName)
False
+
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
+
False
+
+
+
+
-WhatIf
+
wi
+
Shows what would happen if the cmdlet runs. The cmdlet is not run.
+
false
+
false
+
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
+
False
+
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
+
true
+
True (ByPropertyName, ByValue)
+
None
+
+
+
-SnapshotName
+
+
Target snapshot name.
+
true
+
True (ByPropertyName)
+
None
+
+
+
-IncludePendingDeletes
+
+
Includes (true) destroyed snapshots that are in the eradication pending state. Time remaining is displayed in seconds.
+
false
+
True (ByPropertyName)
+
False
+
+
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
+
False
+
+
+
+
-WhatIf
+
wi
+
Shows what would happen if the cmdlet runs. The cmdlet is not run.
+
false
+
false
+
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
+
False
+
+
+
+
+
+
Inputs
+
The input type is the type of the objects that you can pipe to the cmdlet.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
+
true
+
True (ByPropertyName, ByValue)
+
None
+
+
+
-VolumeName
+
+
Target volume name.
+
true
+
True (ByPropertyName)
+
None
+
+
+
-IncludePendingDeletes
+
+
Includes (true) destroyed snapshots that are in the eradication pending state. Time remaining is displayed in seconds.
+
false
+
True (ByPropertyName)
+
False
+
+
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
+
False
+
+
+
+
-WhatIf
+
wi
+
Shows what would happen if the cmdlet runs. The cmdlet is not run.
+
false
+
false
+
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
+
False
+
+
+
+
+
+
Inputs
+
The input type is the type of the objects that you can pipe to the cmdlet.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
@@ -25040,55 +30921,95 @@
Parameters
-VolumeName
-
none
+
Target volume name.
true
True (ByPropertyName)
None
+
+
-TimeRange
+
+
Time range for historical data with units. Valid historical values are: 1h, 3h, 24h, 7d, 30d, 90d, 1y.
+
true
+
True (ByPropertyName)
+
None
+
-IncludePendingDeletes
-
none
-
Includes (true) destroyed snapshots that are in the eradication pending state. Time remaining is displayed in seconds.
+
+
Includes (true) destroyed volumes that are in the eradication pending state.
false
True (ByPropertyName)
False
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
None
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
False
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
-
False
+
false
False
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
false
+
false
False
-
None
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Lists size and space consumption attributes for the specified volume.
-
+
Get-PfaVolumesTags
+
Displays all volume or snapshot tags for an array. (Requires REST 1.19+)
+
Displays volume or snapshot tags for an array. The -Snap parameter specifies that the result should contain snapshots only. If the -IncludePendingDeletes parameter in specified, the tags will be returned only if the volumes or snapshots are pending deletion. (Requires REST 1.19+)
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
-
None
+
-
-VolumeName
-
none
-
Target volume name.
-
true
+
-IncludePendingDeletes
+
+
If specified, returns only objects from destroyed resources. Returns an error if the name of a live resource is specified with the -IsPendingDeletes parameter. If not specified, returns only objects from live resources. Returns an error if the name of a destroyed resource is specified with the -IsPendingDeletes parameter.
+
false
True (ByPropertyName)
-
None
+
-
-IncludePendingDeletes
-
none
-
Includes (true) destroyed volumes that are in the eradication pending state.
+
-Namespace
+
+
A comma-separated list of namespaces.
false
True (ByPropertyName)
+
+
+
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
False
+
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
False
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
-
False
-
False
+
false
+
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
+
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
(REST API 1.6+) Lists size and space consumption attributes for the specified volume.
-
+
Get-PfaVolumeTags
+
Displays tags associated with the specified volume or snapshot. (Requires REST 1.19+)
+
Displays tags associated with the specified volume or snapshot. If the -IncludePendingDeletes parameter in specified, the tags will be returned only if the volume is pending a deletion. (Requires REST 1.19+)
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
-
None
+
-VolumeName
-
none
-
Target volume name.
+
Name
+
Specifies the volume or snapshot name.
true
True (ByPropertyName)
-
None
+
-IncludePendingDeletes
-
none
-
Includes (true) destroyed volumes that are in the eradication pending state.
+
+
If specified, returns only objects from destroyed resources. Returns an error if the name of a live resource is specified with the -IsPendingDeletes parameter. If not specified, returns only objects from live resources. Returns an error if the name of a destroyed resource is specified with the -IsPendingDeletes parameter.
false
True (ByPropertyName)
-
False
+
-
-TimeRange
-
none
-
Time range for historical data with units. Valid historical values are: 1h, 3h, 24h, 7d, 30d, 90d, 1y.
-
true
+
-Namespace
+
+
A comma-separated list of namespaces.
+
false
True (ByPropertyName)
-
None
+
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Filter
+
+
Server side filtering to apply to the results. Narrows down the results to only the response objects that satisfy the filter criteria. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
false
+
+
+
+
-Sort
+
+
Returns the response objects in the order specified. Set `Sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Offset
+
Start
+
The starting position based on the results of the query in relation to the full set of response objects returned. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
+
false
+
False
+
+
+
+
-Limit
+
+
Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `TotalItemCount` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. For details, see about_Purity_Filtering or refer to the "Sorting, Filtering, and Pagination" section of the REST API guide. (Requires REST 1.7+)
false
False
+
+
+
+
-TotalItemCountVariable
+
+
Total number of resources to be returned.
+
false
False
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
-
False
-
False
+
false
+
-
-Filter
-
none
-
(REST 1.7+) Server side filtering to apply to the results. For details see about_Purity_Filtering.
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
false
-
False
-
None
+
false
+
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
+
+
-Name
+
+
Target certificate name.
+
true
+
True (ByPropertyName)
+
None
+
-Certificate
-
none
+
The certificate to import.
true
True (ByPropertyName)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-IntermediateCertificate
+
+
Intermediate certificate
false
-
False
-
False
+
True (ByPropertyName)
+
None
-
-Name
-
none
-
Target certificate name.
-
true
+
-CaCertificate
+
+
CA certificate
+
false
True (ByPropertyName)
None
@@ -25564,28 +31593,20 @@
Parameters
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
-
False
+
false
False
-
-CaCertificate
-
none
-
CA certificate
-
false
-
True (ByPropertyName)
-
None
-
-
-
-IntermediateCertificate
-
none
-
Intermediate certificate
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
false
-
True (ByPropertyName)
-
None
+
false
+
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
@@ -25602,11 +31623,11 @@
Examples
- EXAMPLE 1
-
Import-PfaNamedCertificate -Name "CertificateName" -Certificate "a block of encoded text containing the certificate information and public key. The certificate should begin with -----BEGIN CERTIFICATE----- and end with -----END CERTIFICATE-----" -CaCertificate "a block of encoded text containing the certificate information and public key. The certificate should begin with -----BEGIN CERTIFICATE----- and end with -----END CERTIFICATE-----" -Array $Array
+ EXAMPLE
+
Import-PfaNamedCertificate -Name "CertificateName" -Certificate "a block of encoded text containing the certificate information and public key. The certificate should begin with -----BEGIN CERTIFICATE----- and end with -----END CERTIFICATE-----" -CaCertificate "a block of encoded text containing the certificate information and public key. The certificate should begin with -----BEGIN CERTIFICATE----- and end with -----END CERTIFICATE-----" -Array $array
Imports a ca-certificate that replaces the existing certificate named "CertificateName".
- EXAMPLE 2
-
Import-PfaNamedCertificate -Name "CertificateName" -Certificate "a block of encoded text containing the certificate information and public key. The certificate should begin with -----BEGIN CERTIFICATE----- and end with -----END CERTIFICATE-----" -IntermediateCertificate "a block of encoded text containing the certificate information and public key. The certificate should begin with -----BEGIN CERTIFICATE----- and end with -----END CERTIFICATE-----" -Array $Array
+ EXAMPLE
+
Import-PfaNamedCertificate -Name "CertificateName" -Certificate "a block of encoded text containing the certificate information and public key. The certificate should begin with -----BEGIN CERTIFICATE----- and end with -----END CERTIFICATE-----" -IntermediateCertificate "a block of encoded text containing the certificate information and public key. The certificate should begin with -----BEGIN CERTIFICATE----- and end with -----END CERTIFICATE-----" -Array $array
Imports a intermediate-certificate that replaces the existing certificate named "CertificateName".
@@ -25616,14 +31637,14 @@
Examples
Invoke-PfaPhoneHomeAction
Transmits event logs stored in the array to the Pure Storage Support team via the phonehome channel.
-
+
Transmits event logs stored in the array to the Pure Storage Support team via the phonehome channel.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
@@ -25650,36 +31671,36 @@
Parameters
-Action
-
none
+
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: SendAll, SendToday, SendYesterday, Cancel.
true
True (ByPropertyName)
None
-
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
-
false
-
False
-
False
-
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
-
None
+
-
-BandwidthLimit
-
none
-
Specify bandwidth limit for volume IO in bytes per second.
+
-Method
+
+
The REST API method to use. Valid verbs are DELETE, GET, POST, PUT, and UPDATE
+
true
+
True (ByPropertyName)
+
+
+
+
-Command
+
+
The request to run against the array REST API. This is the URI of the request. It must not have a leading "/". GET volume command parameter example: "volume" GET hostgroup command parameter example: "host/hgroup"
Command arguments can be either appended to this parameter or specified in the -Args parameter.
+
true
+
True (ByPropertyName)
+
+
+
+
-Args
+
+
String of "&" separated arguments. Optional. If desired, it is possible to append the arguments to the -command parameter as well instead of specifying -Args.
false
True (ByPropertyName)
-
None
+
-
-IOPSLimit
-
none
-
Specify bandwidth limit for volume IO in bytes per second.
+
-Body
+
+
Must be valid JSON in a string. Example: '{ "size": "10G" }'
false
True (ByPropertyName)
-
None
+
+
+
+
-WhatIf
+
wi
+
Shows what would happen if the cmdlet runs. The cmdlet is not run.
+
false
+
False
+
-Confirm
@@ -25760,28 +31801,99 @@
Parameters
Prompts you for confirmation before running the cmdlet.
false
False
-
False
+
+
+
+
+
+
Inputs
+
The input type is the type of the objects that you can pipe to the cmdlet.
Retrieve volume information from Array $array.
+Retrieve vol1 information on Array $array that has tags assigned and is pending eradication
+Retrieve volumes on Array $array that are pending eradication
Specify the container for this volume (either a volume group or a pod)
+
Name
+
Alias
+
Description
+
Required?
+
Pipeline Input
+
Default Value
+
+
+
+
+
-Array
+
+
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
-
True (ByPropertyName)
+
True (ByPropertyName, ByValue)
None
-Name
-
none
+
Target volume name.
true
True (ByPropertyName)
None
-
-NewSize
-
none
-
New size of the volume in bytes. If the new volume size is smaller than the original, then the <code>truncate</code> parameter needs to be set to <code>true</code>.
+
-Container
+
+
Specify the container for this volume (either a volume group or a pod)
true
True (ByPropertyName)
None
@@ -25791,23 +31903,55 @@
Parameters
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
+
+
-NewSize
+
+
New size of the volume in bytes. If the new volume size is smaller than the original, then the <code>truncate</code> parameter needs to be set to <code>true</code>.
+
true
+
True (ByPropertyName)
+
None
+
+
+
-BandwidthLimit
+
+
Specify bandwidth limit for volume IO in bytes per second. (Requires REST 1.14+)
+
false
+
True (ByPropertyName)
+
None
+
+
+
-IOPSLimit
+
+
Specify bandwidth limit for volume IO in bytes per second. (Requires REST 1.17+)
+
false
+
True (ByPropertyName)
+
None
+
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
If this parameter is not specified, then the SDK uses the highest version of the REST API that is supported by both the FlashArray and the SDK.
false
True (ByPropertyName)
@@ -26069,7 +32213,7 @@
Parameters
-IgnoreCertificateError
-
none
+
Prevents certificate errors such as an unknown certificate issuer or non-matching names from causing the request to fail.
false
True (ByPropertyName)
@@ -26077,7 +32221,7 @@
Parameters
-DisableLoggingToArray
-
none
+
Disable phone home logging for this connection.
false
True (ByPropertyName)
@@ -26085,7 +32229,7 @@
Parameters
-HttpTimeOutInMilliSeconds
-
none
+
The request times out if not completed within this number of milliseconds.
false
True (ByPropertyName)
@@ -26093,15 +32237,23 @@
Parameters
-RoleRequired
-
none
+
RoleRequired enforces the specified role as a minimum role. The New-PfaArray fails if the user name provided does not have at least the specified level of permission.
Using Version 1.3 of the REST API, connects to the FlashArray named "pure01.example.com" with pureuser's login credentials. The cmdlet prompts for the login password and masks the password string on the screen.
The request times out if it takes longer than 300,000 milliseconds.
-"$Array" can be used with the "-Array" parameter in subsequent cmdlets (for example, "Disconnect-PfaArray -Array $Array").
- EXAMPLE 2
+"$array" can be used with the "-Array" parameter in subsequent cmdlets (for example, "Disconnect-PfaArray -Array $array").
Connects to the FlashArray named "pure01.example.com", ignoring any certificate errors.
First, the PowerShell command Get-Credential opens a pop-up to enter the login credentials, which are saved to $myCredential.
Connects to the FlashArray named "pure01.example.com", ignoring any certificate errors.
First, the PowerShell command ConvertTo-SecureString is used to convert a plain password to a secure string, which is saved to $SecurePassword.
Connects to the FlashArray named "pure01.example.com" with pureuser's login credentials. The cmdlet prompts for the login password and masks the password string on the screen.
The request times out if it takes longer than 300,000 milliseconds. The request fails if the specified user does not have at least ArrayAdmin permission.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Locality
-
none
-
Name of the city where your organization is located.
+
-CommonName
+
+
Common name of the CSR. The common name must be the fully qualified domain name of the current array. For example, for https://purearray.example.com, the common name must be purearray.example.com or *.example.com for a wildcard certificate. It can also be the management IP address of the array or the short name of the current array. It cannot have more than 64 characters.
true
True (ByPropertyName)
None
-Country
-
none
+
Country name of the CSR. The country name represents the two-letter ISO code for the country where your organization is located.
true
True (ByPropertyName)
None
-
-CommonName
-
none
-
Common name of the CSR. The common name must be the fully qualified domain name of the current array. For example, for https://purearray.example.com, the common name must be purearray.example.com or *.example.com for a wildcard certificate. It can also be the management IP address of the array or the short name of the current array. It cannot have more than 64 characters.
+
-Email
+
+
Email address used to contact your organization.
true
True (ByPropertyName)
None
-
-State
-
none
-
Name of the state or province where your organization is located.
+
-Locality
+
+
Name of the city where your organization is located.
true
True (ByPropertyName)
None
-Organization
-
none
+
Name of your organization. Enter the full and exact legal name of your organization. The organization name should not be abbreviated and should include suffixes such as Inc, Corp, or LLC. For example, "Pure Storage, Inc."
true
True (ByPropertyName)
None
-
-Email
-
none
-
Email address used to contact your organization.
+
-OrganizationalUnit
+
+
Name of the department within your organization that you want to appear in the certificate.
true
True (ByPropertyName)
None
-
-OrganizationalUnit
-
none
-
Name of the department within your organization that you want to appear in the certificate.
+
-State
+
+
Name of the state or province where your organization is located.
true
True (ByPropertyName)
None
-
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
-
false
-
False
-
False
-
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Disable phone home logging for this connection. This reduces the amount of logging on the array for any commands that are executed.
false
True (ByPropertyName)
False
-TimeOutInMilliSeconds
-
none
-
Timeout in milliseconds
+
+
Timeout in milliseconds for the command to complete.
false
True (ByPropertyName)
None
-CommandText
-
none
+
The CLI command to run on the FlashArray
true
True (ByPropertyName)
@@ -26406,29 +32550,45 @@
Parameters
-Credentials
-
none
-
The credentials for SSH access to the FlashArray
+
+
The credentials for SSH access to the FlashArray. Used in place of -Username and -Password. Obtained as a PSCredential object. Example $creds=Get-Credential.
true
True (ByPropertyName, ByValue)
None
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Creates a PSCredential object with the username and password supplied when prompted.
+Executes the CLI command 'purearray list --controller' on Array 'array1' and disables the logging of this connection for phone home logging.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
-
false
-
False
-
False
+
-Names
+
+
Configures the LDAP group mappings for the specified role name. Valid roles are readonly, ops_admin, storage_admin, and array_admin. Enter multiple role names in comma-separated format.
+
true
+
True (ByPropertyName)
+
None
-Group
-
none
+
Sets the Common Name (CN) of a directory service group mapping to a role. The name should be just the Common Name of the group without the CN= specifier. Common Names should not exceed 64 characters in length.
true
True (ByPropertyName)
@@ -26484,39 +32644,39 @@
Parameters
-GroupBase
-
none
+
Specifies where the configured group is 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 group. 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.
true
True (ByPropertyName)
None
-
-
-Names
-
none
-
Configures the LDAP group mappings for the specified role name. Valid roles are readonly, ops_admin, storage_admin, and array_admin. Enter multiple role names in comma-separated format.
-
true
-
True (ByPropertyName)
-
None
-
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Creates a host named "host1". This host cannot be connected to volumes or associated with a host group until at least one worldwide name is associated with it.
Creates a Key Management Interoperability Protocol (KMIP) configuration. KMIP provides a way to lock an array remotely. KMIP is a client/server communication protocol for the storage and maintenance of key, certificate, and secret objects. (Requires REST 1.12+)
Creates a new maintenance window on the Array for environment for 100 seconds.
@@ -27466,15 +33648,15 @@
Examples
New-PfaNamedCertificateImport
-
(REST API 1.12+) Import a named certificate.
-
(REST API 1.12+) Import a named certificate.
+
Imports a named certificate. (Requires REST 1.12+)
+
Imports a named certificate. Importing a certificate does not affect existing certificates, and there may not already be a certificate with the same name. (Requires REST 1.12+)
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-CaCertificate
-
none
-
The CA certificate used to sign the certificate. You must provide either CaCertificate or IntermediateCertificate
-
false
+
-Name
+
+
Target certificate name.
+
true
True (ByPropertyName)
None
-
-Certificate
-
none
-
The certificate to import.
+
-Key
+
+
The private key associated with the certificate.
true
True (ByPropertyName)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
-
false
-
False
-
False
+
-Certificate
+
+
The certificate to import.
+
true
+
True (ByPropertyName)
+
None
-IntermediateCertificate
-
none
+
The intermediate certificate used in signing the certificate. You must provide either CaCertificate or IntermediateCertificate.
false
True (ByPropertyName)
None
-
-Key
-
none
-
The private key associated with the certificate.
-
true
-
True (ByPropertyName)
-
None
-
-
-
-Name
-
none
-
Target certificate name.
-
true
+
-CaCertificate
+
+
The CA certificate used to sign the certificate. You must provide either CaCertificate or IntermediateCertificate
+
false
True (ByPropertyName)
None
@@ -27552,12 +33726,20 @@
Parameters
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
@@ -27574,11 +33756,11 @@
Examples
- EXAMPLE 1
-
New-PfaNamedCertificateImport -Name "CertificateName" -Certificate "a block of encoded text containing the certificate information and public key. The certificate should begin with -----BEGIN CERTIFICATE----- and end with -----END CERTIFICATE-----" -CaCertificate "a block of encoded text containing the certificate information and public key. The certificate should begin with -----BEGIN CERTIFICATE----- and end with -----END CERTIFICATE-----" -Key "a block of encoded text containing RSA private key. The key should begin with -----BEGIN RSA PRIVATE KEY----- and end with -----END RSA PRIVATE KEY-----" -Array $Array
+ EXAMPLE
+
New-PfaNamedCertificateImport -Name "CertificateName" -Certificate "a block of encoded text containing the certificate information and public key. The certificate should begin with -----BEGIN CERTIFICATE----- and end with -----END CERTIFICATE-----" -CaCertificate "a block of encoded text containing the certificate information and public key. The certificate should begin with -----BEGIN CERTIFICATE----- and end with -----END CERTIFICATE-----" -Key "a block of encoded text containing RSA private key. The key should begin with -----BEGIN RSA PRIVATE KEY----- and end with -----END RSA PRIVATE KEY-----" -Array $array
Imports a new ca-certificate named "CertificateName". Needs to specify certificate, ca-certificate and private key.
- EXAMPLE 2
-
New-PfaNamedCertificateImport -Name "CertificateName" -Certificate "a block of encoded text containing the certificate information and public key. The certificate should begin with -----BEGIN CERTIFICATE----- and end with -----END CERTIFICATE-----" -IntermediateCertificate "a block of encoded text containing the certificate information and public key. The certificate should begin with -----BEGIN CERTIFICATE----- and end with -----END CERTIFICATE-----" -Key "a block of encoded text containing RSA private key. The key should begin with -----BEGIN RSA PRIVATE KEY----- and end with -----END RSA PRIVATE KEY-----" -Array $Array
+ EXAMPLE
+
New-PfaNamedCertificateImport -Name "CertificateName" -Certificate "a block of encoded text containing the certificate information and public key. The certificate should begin with -----BEGIN CERTIFICATE----- and end with -----END CERTIFICATE-----" -IntermediateCertificate "a block of encoded text containing the certificate information and public key. The certificate should begin with -----BEGIN CERTIFICATE----- and end with -----END CERTIFICATE-----" -Key "a block of encoded text containing RSA private key. The key should begin with -----BEGIN RSA PRIVATE KEY----- and end with -----END RSA PRIVATE KEY-----" -Array $array
Imports a new intermediate-certificate named "CertificateName". Needs to specify certificate, intermediate-certificate and private key.
@@ -27587,15 +33769,15 @@
Examples
New-PfaNamedCertificateSigningRequest
-
(REST API 1.12+) Constructs a certificate signing request (CSR) for signing by a certificate authority (CA). The certificate will be identified by the specified name.
-
+
Constructs a certificate signing request (CSR) for signing by a certificate authority (CA). (Requires REST 1.12+)
+
Constructs a certificate signing request (CSR) for signing by a certificate authority (CA). The certificate will be identified by the specified name. (Requires REST 1.12+)
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
@@ -27622,7 +33804,7 @@
Parameters
-CertificateName
-
none
+
The name used by Purity to identify the certificate.
true
True (ByPropertyName)
@@ -27630,23 +33812,15 @@
Parameters
-CommonName
-
none
+
Common name of the CSR. The common name must be the fully qualified domain name of the current array. For example, for https://purearray.example.com, the common name must be purearray.example.com or *.example.com for a wildcard certificate. It can also be the management IP address of the array or the short name of the current array. It cannot have more than 64 characters.
true
True (ByPropertyName)
None
-
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
-
false
-
False
-
False
-
-Country
-
none
+
Country name of the CSR. The country name represents the two-letter ISO code for the country where your organization is located.
true
True (ByPropertyName)
@@ -27654,7 +33828,7 @@
Parameters
-Email
-
none
+
Email address used to contact your organization.
true
True (ByPropertyName)
@@ -27662,7 +33836,7 @@
Parameters
-Locality
-
none
+
Name of the city where your organization is located.
true
True (ByPropertyName)
@@ -27670,7 +33844,7 @@
Parameters
-Organization
-
none
+
Name of your organization. Enter the full and exact legal name of your organization. The organization name should not be abbreviated and should include suffixes such as Inc, Corp, or LLC. For example, "Pure Storage, Inc."
true
True (ByPropertyName)
@@ -27678,7 +33852,7 @@
Parameters
-OrganizationalUnit
-
none
+
Name of the department within your organization that you want to appear in the certificate.
true
True (ByPropertyName)
@@ -27686,7 +33860,7 @@
Parameters
-State
-
none
+
Name of the state or province where your organization is located.
true
True (ByPropertyName)
@@ -27697,12 +33871,20 @@
Parameters
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
(REST API 1.12+) Creates a named self-signed certificate.
-
(REST API 1.12+) Creates a named self-signed certificate.
+
Creates a named self-signed certificate. (Requires REST 1.12+)
+
Creates a named self-signed certificate. Creating a new self-signed certificate does not affect existing certificates, and there may not already be a certificate with the same name. (Requires REST 1.12+)
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-CommonName
-
none
-
Used to specify the common name. The common name represents the qualified domain name of the current array. For example, for https://purearray.example.com, the common name must be purearray.example.com or *.example.com for a wildcard certificate. It can also be the management IP address of the array or the short name of the current array. It can't have more than 64 characters.
+
-Name
+
+
Target certificate name.
true
True (ByPropertyName)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
-
false
-
False
-
False
+
-CommonName
+
+
Used to specify the common name. The common name represents the qualified domain name of the current array. For example, for https://purearray.example.com, the common name must be purearray.example.com or *.example.com for a wildcard certificate. It can also be the management IP address of the array or the short name of the current array. It can't have more than 64 characters.
+
true
+
True (ByPropertyName)
+
None
-Country
-
none
+
Used to specify the country name. The country name represents the two-letter ISO code for the country where your organization is located.
true
True (ByPropertyName)
@@ -27788,7 +33970,7 @@
Parameters
-Days
-
none
+
The number of valid days for the self-signed certificate being generated.
true
True (ByPropertyName)
@@ -27796,7 +33978,7 @@
Parameters
-Email
-
none
+
The email address used to contact your organization.
true
True (ByPropertyName)
@@ -27804,7 +33986,7 @@
Parameters
-KeySize
-
none
+
The key size in bits. Valid values are 512, 1024, 2048 (default) or 4096. A key size smaller than 2048 is considered insecure.
true
True (ByPropertyName)
@@ -27812,23 +33994,15 @@
Parameters
-Locality
-
none
+
The city where your organization is located.
true
True (ByPropertyName)
None
-
-
-Name
-
none
-
Target certificate name.
-
true
-
True (ByPropertyName)
-
None
-
-Organization
-
none
+
The full and exact legal name of your organization. The organization name should not be abbreviated and should include suffixes such as Inc, Corp, or LLC. For example,'Pure Storage, Inc.'
true
True (ByPropertyName)
@@ -27836,7 +34010,7 @@
Parameters
-OrganizationalUnit
-
none
+
The department within your organization that you want to appear in the certificate.
true
True (ByPropertyName)
@@ -27844,7 +34018,7 @@
Parameters
-State
-
none
+
The state or province where your organization is located.
true
True (ByPropertyName)
@@ -27855,12 +34029,20 @@
Parameters
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
-
false
-
False
-
False
-
-Name
-
none
+
Pod Name.
true
True (ByPropertyName)
None
+
+
-FailoverPreference
+
+
Specifies which array within a stretched pod should be given priority to stay online, should the arrays ever lose contact with each other. (Requires REST 1.15+)
+
false
+
True (ByPropertyName)
+
None
+
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
-
False
+
false
False
-
-FailoverPreference
-
none
-
Specifies which array within a stretched pod should be given priority to stay online, should the arrays ever lose contact with each other.
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
false
-
True (ByPropertyName)
-
None
+
false
+
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
@@ -27971,9 +34153,9 @@
Examples
- EXAMPLE 1
-
New-PfaPod -Array $Array -Name "PodName"
-
Creates a pod named "PodName" on the array $Array.
+ EXAMPLE
+
New-PfaPod -Array $array -Name "PodName"
+
Creates a pod named "PodName" on the array $array.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
@@ -28022,90 +34206,90 @@
Parameters
-Name
-
none
+
Target protection group name.
true
True (ByPropertyName)
None
-
-Hosts
-
none
-
List of one or more hosts to be included in the new protection group.
+
-WhatIf
+
wi
+
Shows what would happen if the cmdlet runs. The cmdlet is not run.
+
false
+
false
+
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
+
False
+
+
+
-HostGroups
+
+
List of one or more host groups to be included in the new protection group.
true
True (ByPropertyName)
None
-Targets
-
none
+
List of one or more targets to be included in the new protection group.
false
True (ByPropertyName)
None
-
-HostGroups
-
none
-
List of one or more host groups to be included in the new protection group.
+
-Hosts
+
+
List of one or more hosts to be included in the new protection group.
true
True (ByPropertyName)
None
-Source
-
none
-
(REST API 1.5+) The source pgroup snapshot to copy from.
+
+
(Requires REST API 1.5+) The source pgroup snapshot to copy from.
true
True (ByPropertyName)
None
-Overwrite
-
none
-
(REST API 1.5+) When copying a protection group, overwrite (true) volumes in the destination protection group that have the same name as the volumes in the source protection group. Without overwrite=true parameter, the copy command fails if any volume name collisions are found. With the overwrite=true parameter, both the source and destination protection groups must contain exactly the same volumes (volume names), otherwise the entire copy command fails.
+
+
(Requires REST API 1.5+) When copying a protection group, overwrite (true) volumes in the destination protection group that have the same name as the volumes in the source protection group. Without overwrite=true parameter, the copy command fails if any volume name collisions are found. With the overwrite=true parameter, both the source and destination protection groups must contain exactly the same volumes (volume names), otherwise the entire copy command fails.
false
True (ByPropertyName)
False
-Volumes
-
none
+
List of one or more volumes to be included in the new protection group.
true
True (ByPropertyName)
None
-
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
-
false
-
False
-
False
-
-
-
-WhatIf
-
wi
-
Shows what would happen if the cmdlet runs. The cmdlet is not run.
-
false
-
False
-
False
-
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Creates a protection group named "protectionGroup3" with 3 hosts ("host1", "host2", "host3") as members. The array "RemoteArray1" is added as a target array (to receive the replicated snapshots).
Creates a protection group named "protectionGroup5" with 3 hostgroups ("hostGroup1", "hostGroup2", "hostGroup3") as members. The array "RemoteArray2" is added as a target array (to receive the replicated snapshots).
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
@@ -28176,82 +34360,82 @@
Parameters
-Protectiongroupname
-
none
+
The name of the protection group that is the source of the snapshots.
true
True (ByPropertyName)
None
-
-Suffix
-
none
-
A custom suffix string to be appended to each snapshot name.
+
-ApplyRetention
+
+
If the -ApplyRetention option is used, Purity retains the snapshot based on the protection group retention schedule. If the -ApplyRetention option is not used, Purity retains the snapshot indefinitely.
false
True (ByPropertyName)
-
None
+
False
-
-ApplyRetention
-
none
-
If the -ApplyRetention option is used, Purity retains the snapshot based on the protection group retention schedule. If the -ApplyRetention option is not used, Purity retains the snapshot indefinitely.
+
-ReplicateNow
+
+
If the -ReplicateNow option is used, the on-demand snapshot is replicated immediately to the target arrays that allow protection group replication.
false
True (ByPropertyName)
False
-Replicate
-
none
+
if the -Replicate option is used, the on-demand snapshot is queued for replication. Purity begins replicating data to each allowed target only when all earlier replication sessions for the same protection group have been completed to that target (excluding those started with the -ReplicateNow option).
false
True (ByPropertyName)
False
-
-ReplicateNow
-
none
-
If the -ReplicateNow option is used, the on-demand snapshot is replicated immediately to the target arrays that allow protection group replication.
+
-Suffix
+
+
A custom suffix string to be appended to each snapshot name.
false
True (ByPropertyName)
-
False
+
None
-
-ProtectionGroups
-
none
-
The names of the protection groups that are the source of the snapshots.
-
true
-
True (ByPropertyName)
-
None
+
-WhatIf
+
wi
+
Shows what would happen if the cmdlet runs. The cmdlet is not run.
+
false
+
false
+
False
-Confirm
cf
Prompts you for confirmation before running the cmdlet.
false
-
False
+
false
False
-
-WhatIf
-
wi
-
Shows what would happen if the cmdlet runs. The cmdlet is not run.
-
false
-
False
-
False
+
-ProtectionGroups
+
+
The names of the protection groups that are the source of the snapshots.
+
true
+
True (ByPropertyName)
+
None
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
New-PfaProtectionGroupSnapshot -Array $Array -Protectiongroupname protectionGroup1 -Suffix example
-
Creates local snapshots of the content of all volumes on the source array ($Array) for the protection group named "protectionGroup1". Each snapshot name is appended with the suffix "example". Purity retains the snapshots indefinitely.
Creates local snapshots of the content of all volumes on the source array ($Array) for the protection group named "protectionGroup1". The snapshots are queued for replication to all of the protection group's target arrays for which replication has been allowed. Purity retains the snapshots based on the protection group retention schedule.
Creates local snapshots of the content of all volumes on the source array ($Array) for the protection groups "protectionGroup1" and "protectionGroup2". The snapshots are replicated to all of the protection group's target arrays for which replication has been allowed. Purity retains the snapshots based on the protection group retention schedule.
+ EXAMPLE
+
New-PfaProtectionGroupSnapshot -Array $array -Protectiongroupname protectionGroup1 -Suffix example
+
Creates local snapshots of the content of all volumes on the source array ($array) for the protection group named "protectionGroup1". Each snapshot name is appended with the suffix "example". Purity retains the snapshots indefinitely.
Creates local snapshots of the content of all volumes on the source array ($array) for the protection group named "protectionGroup1". The snapshots are queued for replication to all of the protection group's target arrays for which replication has been allowed. Purity retains the snapshots based on the protection group retention schedule.
Creates local snapshots of the content of all volumes on the source array ($array) for the protection groups "protectionGroup1" and "protectionGroup2". The snapshots are replicated to all of the protection group's target arrays for which replication has been allowed. Purity retains the snapshots based on the protection group retention schedule.
(REST API 1.13+) Creates a protocol endpoint volume.
-
(REST API 1.13+) Creates a protocol endpoint volume.
+
Creates a protocol endpoint volume. (Requires REST 1.13+)
+
Creates a protocol endpoint volume. To provide scale and flexibility for vVols, VMware adopted the T10 administrative logical unit (ALU) standard, which it calls protocol endpoint (PE). vVols are connected to VMs through PEs acting as subsidiary logical units (SLUs, also called sub-luns). The FlashArray vVol implementation makes PEs nearly transparent. Array administrators seldom deal with PEs, and not at all during day-to-day operations. PEs were formerly referred to as I/O de-multiplexers. (Requires REST 1.13+)
Creates a new replication connection from the source array $array, using the Replication IP address on the source array of 102.100.100.1 and the Connection Key "a61c8e55-7c8a-c2b2-2d67-8dd1e706e997" of the target array, to the target array "103.100.100.1".
(REST API 1.3-1.11) Creates a self-signed certificate.
-
+
New-PfaRestApiToken
+
Creates a REST API token for the specified user on the FlashArray. (Requires REST 1.5+)
+
This cmdlet will create a new API token for a specified user on the FlashArray. If a token currently exists for the user, it will be overwritten with the new token, and the previous token will no longer be valid. (Requires REST 1.5+)
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
-
True (ByPropertyName)
+
True (ByPropertyName, ByValue)
None
-CommonName
-
none
+
The common name, which represents the qualified domain name of the current array. For example, for https://purearray.example.com, the common name must be purearray.example.com or *.example.com for a wildcard certificate. It can also be the management IP address of the array or the short name of the currentarray. It cannot have more than 64 characters.
true
True (ByPropertyName)
None
+
+
-Country
+
+
The two-letter ISO code for the country where your organization is located.
+
true
+
True (ByPropertyName)
+
None
+
-Days
-
none
+
The number of valid days for the self-signed certificate being generated.
true
True (ByPropertyName)
None
-
-State
-
none
-
The state or province where your organization is located.
+
-Email
+
+
The email address used to contact your organization.
true
True (ByPropertyName)
None
-KeySize
-
none
+
The key size in bits. Valid values are 512, 1024, 2048 (default) or 4096. A key size smaller than 2048 is considered insecure.
true
True (ByPropertyName)
None
-
-Organization
-
none
-
The full and exact legal name of your organization. The organization name should not be abbreviated and should include suffixes such as Inc, Corp, or LLC. For example,"Pure Storage, Inc."
+
-Locality
+
+
The city where your organization is located.
true
True (ByPropertyName)
None
-
-Email
-
none
-
The email address used to contact your organization.
+
-NewKey
+
+
Creates a new key when creating the self-signed certificate. If a new private key is not generated, the certificate uses the existing private key.
+
true
+
True (ByPropertyName)
+
None
+
+
+
-Organization
+
+
The full and exact legal name of your organization. The organization name should not be abbreviated and should include suffixes such as Inc, Corp, or LLC. For example,"Pure Storage, Inc."
true
True (ByPropertyName)
None
-OrganizationalUnit
-
none
+
The department within your organization that you want to appear in the certificate.
true
True (ByPropertyName)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
-
false
-
False
-
False
+
-State
+
+
The state or province where your organization is located.
+
true
+
True (ByPropertyName)
+
None
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
-
false
-
False
-
False
-
-Name
-
none
+
Name of the software application.
true
True (ByPropertyName)
@@ -28679,17 +34971,25 @@
Parameters
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
PurePowerShell.PureArray
-
+
System.String
@@ -28703,8 +35003,8 @@
Examples
- Example 1
-
New-PfaSoftware -Array $Array -Name "linux"
+ EXAMPLE
+
New-PfaSoftware -Array $array -Name "linux"
Installs the linux application on the Array
@@ -28713,15 +35013,15 @@
Examples
New-PfaSubnet
-
(REST API 1.5+) Creates a subnet.
-
+
Creates a new subnet on an array. (Requires REST 1.5+)
+
Creates a new subnet on an array. The subnet name must not already exist on the array. (Requires REST 1.5+)
In Purity//FA, interfaces with common attributes can be organized into subnetworks, (or subnets) to enhance the efficiency of data (iSCSI, NVMe-RoCE, or file), management, and replication traffic if applicable.
If the subnet is assigned a valid IP address, once it is created, all of its enabled interfaces are immediately available for connection. The subnet inherits the services from all of its interfaces. Likewise, the interfaces contained in the subnet inherit the netmask, gateway, MTU, and VLAN ID (if applicable) attributes from the subnet.
Physical, virtual, and bond interfaces can belong to the same subnet. VLAN interfaces can only belong to subnets with other VLAN interfaces.
Physical, virtual, and bond interfaces in a subnet share common address, netmask, and MTU attributes. The subnet can contain a mix of physical, virtual, and bond interfaces, and the interface services can be of any type, such as iSCSI, management, NVMe-RoCE, or replication services. To add physical, virtual, or bond interfaces to a subnet, create the subnet and then run purenetwork eth setattr --subnet to add the interfaces to the subnet.
A VLAN interface is a dedicated virtual network interface that is designed to be used with an organization’s virtual local area network (VLAN). Through VLAN interfaces, Purity//FA employs VLAN tags to ensure the data passing between the array and VLANs is securely isolated and routed properly.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
@@ -28748,87 +35048,98 @@
Parameters
-Subnet
-
none
-
Name of the subnet
+
+
The name of the subnet.
true
True (ByPropertyName)
None
-Prefix
-
none
+
Sets the IPv4 address to be associated with the specified subnet. Prefixes must be specified in CIDR format (ddd.ddd.ddd.ddd/dd).
true
True (ByPropertyName)
None
-
-
-Vlan
-
none
-
VLAN ID. To remove the VLAN ID, set it to zero.
-
false
-
True (ByPropertyName)
-
None
-
-Gateway
-
none
-
Sets the IPv4 address (in ddd.ddd.ddd.ddd format) of the gateway through which the specified subnet is to communicate with the network. To remove the value, set it to empty string.
+
+
Sets the IPv4 address (in CIDR format ddd.ddd.ddd.ddd) of the gateway through which the specified subnet is to communicate with the network. To remove the value, set it to empty string.
false
True (ByPropertyName)
None
-Mtu
-
none
+
Maximum message transfer unit (packet) size for the subnet in bytes. Valid values are integers between 1280 and 9216 (inclusive). The default value is 1500.
false
True (ByPropertyName)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Vlan
+
+
The VLAN ID. To remove the VLAN ID, set it to zero (0).
false
-
False
-
False
+
True (ByPropertyName)
+
None
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Creates a new subnet on Array $array named 'subnet1' with a IP Prefix of 192.168.1.1, a gateway of 192.168.1.254, a MTU packet size of 9128 (for jumbo frames), and a VLAN ID of 200.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Host
-
none
-
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.
+
-Name
+
+
Target SNMP manager name.
true
True (ByPropertyName)
None
-
-Name
-
none
-
Targe SNMP manager name.
+
-Community
+
+
SNMP v2c only. Manager community ID under which Purity is to communicate with the specified manager. The value must be between 1 and 32 characters in length and from the set {[A-Z], [a-z], [0-9], _ (underscore), and - (hyphen)}.
true
True (ByPropertyName)
None
-
-Community
-
none
-
SNMP v2c only. Manager community ID under which Purity is to communicate with the specified manager. The value must be between 1 and 32 characters in length and from the set {[A-Z], [a-z], [0-9], _ (underscore), and - (hyphen)}.
+
-Host
+
+
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.
true
True (ByPropertyName)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Notification
+
+
(Requires REST API 1.12+) What type of SNMP message to send on an event. Either 'trap' or 'inform'.
false
-
False
-
False
+
True (ByPropertyName)
+
None
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
-
False
+
false
False
-
-Notification
-
none
-
(REST API 1.12+) What type of SNMP message to send on an event. Either 'trap' or 'inform'.
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
false
-
True (ByPropertyName)
-
None
+
false
+
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-PrivacyProtocol
-
none
-
SNMP v3 only. Encryption protocol for SNMP messages. Valid values are "AES" or "DES".
+
-Name
+
+
Targe SNMP manager name.
true
True (ByPropertyName)
None
-
-Name
-
none
-
Targe SNMP manager name.
+
-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)}.
true
True (ByPropertyName)
None
-
-AuthPassphrase
-
none
-
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)}.
+
-Host
+
+
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.
Required.
true
True (ByPropertyName)
None
-
-PrivacyPassphrase
-
none
-
SNMP v3 only. Passphrase used to encrypt SNMP messages. The value must be between 8 and 63 non-space ASCII characters in length.
+
-AuthProtocol
+
+
SNMP v3 only. Hash algorithm used to validate the authentication passphrase. Valid values are "MD5" or "SHA".
true
True (ByPropertyName)
None
-
-AuthProtocol
-
none
-
SNMP v3 only. Hash algorithm used to validate the authentication passphrase. Valid values are "MD5" or "SHA".
+
-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)}.
true
True (ByPropertyName)
None
-
-Host
-
none
-
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.
Required.
+
-PrivacyProtocol
+
+
SNMP v3 only. Encryption protocol for SNMP messages. Valid values are "AES" or "DES".
true
True (ByPropertyName)
None
-
-User
-
none
-
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)}.
+
-PrivacyPassphrase
+
+
SNMP v3 only. Passphrase used to encrypt SNMP messages. The value must be between 8 and 63 non-space ASCII characters in length.
true
True (ByPropertyName)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Notification
+
+
(Requires REST API 1.12+) What type of SNMP message to send on an event. Either 'trap' or 'inform'.
false
-
False
-
False
+
True (ByPropertyName)
+
None
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
-
False
+
false
False
-
-Notification
-
none
-
(REST API 1.12+) What type of SNMP message to send on an event. Either 'trap' or 'inform'.
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
false
-
True (ByPropertyName)
-
None
+
false
+
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Creates a v3 SNMP manager object named "MyV3Mgr". AES is the encryption protocol for SNMP messages. MD5 is the hash algorithm used to validate the authentication passphrase. The SNMP server is hosted on SNMPServer2.example.com.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
@@ -29193,7 +35515,7 @@
Parameters
-VolumeName
-
none
+
Target volume name.
true
True (ByPropertyName)
@@ -29201,82 +35523,82 @@
Parameters
-Size
-
none
+
Size in bytes of the volume.
true
True (ByPropertyName)
None
-
-Source
-
none
-
Specify the name of a volume or snapshot whose data is copied to the volume specified.
If the volume replaces an existing volume, an undo snapshot is automatically taken (providing a 24-hour window during which the previous contents can be retrieved).
-
true
+
-BandwidthLimit
+
+
Specify bandwidth limit for volume IO in bytes per second. (Requires REST 1.14+)
+
false
True (ByPropertyName)
None
-
-Overwrite
-
none
-
(REST API 1.1+) When used with "source", overwrites ("true") an existing volume.
+
-IOPSLimit
+
+
Specify IOPS limit for volume IO in bytes per second. (Requires REST 1.17+)
false
True (ByPropertyName)
-
False
+
None
-
-Unit
-
none
-
Valid unit symbols are K, M, G, T, P, representing KiB, MiB, GiB, TiB, and PiB, respectively, where "Ki" denotes 2^10, "Mi" denotes 2^20, and so on.
-
true
-
True (ByPropertyName)
-
None
+
-WhatIf
+
wi
+
Shows what would happen if the cmdlet runs. The cmdlet is not run.
+
false
+
false
+
False
-Confirm
cf
Prompts you for confirmation before running the cmdlet.
false
-
False
+
false
False
-
-WhatIf
-
wi
-
Shows what would happen if the cmdlet runs. The cmdlet is not run.
-
false
-
False
-
False
+
-Source
+
+
Specify the name of a volume or snapshot whose data is copied to the volume specified.
If the volume replaces an existing volume, an undo snapshot is automatically taken (providing a 24-hour window during which the previous contents can be retrieved).
+
true
+
True (ByPropertyName)
+
None
-
-BandwidthLimit
-
none
-
Specify bandwidth limit for volume IO in bytes per second.
+
-Overwrite
+
+
When used with "source", overwrites ("true") an existing volume. (Requires REST 1.1+)
false
True (ByPropertyName)
-
None
+
False
-
-IOPSLimit
-
none
-
Specify IOPS limit for volume IO in bytes per second.
-
false
+
-Unit
+
+
Valid unit symbols are K, M, G, T, P, representing KiB, MiB, GiB, TiB, and PiB, respectively, where "Ki" denotes 2^10, "Mi" denotes 2^20, and so on.
+
true
True (ByPropertyName)
None
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Create snapshots for volumes vol1 and vol2. The snapshot names are prefixed with the volume name and are assigned a random suffix (example: "vol1.38628" and "vol2.38628").
Create snapshots for volumes "vol1" and "vol2". The snapshot names are always prefixed with the volume name and when "-suffix" is used, the snapshot names are also assigned the specified suffix (example: "vol1.failover-backup" and "vol2.failover-backup").
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.
Create snapshots for volumes vol1 and vol2. The snapshot names are prefixed with the volume name and are assigned a random suffix (example: "vol1.38628" and "vol2.38628").
Create snapshots for volumes "vol1" and "vol2". The snapshot names are always prefixed with the volume name and when "-suffix" is used, the snapshot names are also assigned the specified suffix (example: "vol1.failover-backup" and "vol2.failover-backup").
Deletes an email address from the list of addresses designated to receive Purity alert messages.
+
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.
Unstretches the pod named "PodName" from the array name "ArrayName". This will create a pod pending eradication named "PodName.restretch" on the array "ArrayName".
Removes the specified host groups ("hostgroup1", "hostgroup2, and "hostgroup3") from the existing list of host groups in the protection group "protectionGroup1".
@@ -30027,14 +36349,14 @@
Examples
Remove-PfaHostGroupVolumeConnection
Breaks the connections between all hosts associated with the host group and the specified volume.
-
+
Breaks the connections between all hosts associated with the host group and the specified volume.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
-
false
-
False
-
False
+
-Name
+
+
Target pod name.
+
true
+
True (ByPropertyName)
+
None
-Eradicate
-
none
+
If set to true, eradicates the specified pod. If destroying or eradicating a volume, its snapshots are also destroyed or eradicated. After destroying a pod, you can eradicate it to immediately terminate the 24-hour eradication period and begin storage reclamation. Once eradication has begun, the pod can no longer be recovered. If set to false, destroys the specified pod. The destroyed pod undergoes a 24-hour eradication pending period during which time the pod and its data can be fully recovered. After the 24-hour pending period, Purity eradicates the destroyed pod.
false
True (ByPropertyName)
False
-
-
-Name
-
none
-
Target pod name.
-
true
-
True (ByPropertyName)
-
None
-
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
@@ -31115,12 +37437,12 @@
Examples
- EXAMPLE 1
-
Remove-PfaPod -Array $Array -Name "PodName"
-
Deletes the pod named "PodName" on the array "$Array". The pod "PodName" will become pod pending eradication.
Eradicates the eradication pending pod named "PodName" on the array "$Array". The pod "PodName" needs to be in eradication pending state before being eradicated.
+ EXAMPLE
+
Remove-PfaPod -Array $array -Name "PodName"
+
Deletes the pod named "PodName" on the array "$array". The pod "PodName" will become pod pending eradication.
Eradicates the eradication pending pod named "PodName" on the array "$array". The pod "PodName" needs to be in eradication pending state before being eradicated.
(REST API 1.2+) Destroys or eradicates the specified protection group or protection group snapshot. When a protection group is destroyed or eradicated, its protection group snapshots are also destroyed or eradicated.
-
+
Destroys or eradicates the specified protection group or protection group snapshot. (Requires REST 1.2+)
+
Destroys or eradicates the specified protection group or protection group snapshot. When a protection group is destroyed or eradicated, its protection group snapshots are also destroyed or eradicated. (Requires REST 1.2+)
Destroys the protection group "protectionGroup1" and all associated snapshots. The destroyed objects enter a 24-hour eradication period during which they can be restored.
Removes the arrays "array1", "array2", "array3" from the protect group "protectionGroup1". These arrays no longer receive replication snapshots from array $Array.
Removes the arrays "array1", "array2", "array3" from the protect group "protectionGroup1". These arrays no longer receive replication snapshots from array $array.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
-
false
-
False
-
False
+
-Name
+
+
Target volume group name.
+
true
+
True (ByPropertyName)
+
None
-Eradicate
-
none
+
If set to true, eradicates the specified volume group. If destroying or eradicating a volume group, its snapshots are also destroyed or eradicated. After destroying a volume group, you can eradicate it to immediately terminate the 24-hour eradication period and begin storage reclamation. Once eradication has begun, the volume group can no longer be recovered. If set to false, destroys the specified volume group. The destroyed volume group undergoes a 24-hour eradication pending period during which time the volume group and its data can be fully recovered. After the 24-hour pending period, Purity eradicates the destroyed volume group.
false
True (ByPropertyName)
False
-
-
-Name
-
none
-
Target volume group name.
-
true
-
True (ByPropertyName)
-
None
-
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Unless the -Eradicate parameter is used, the destroyed object enters a 24-hour eradication pending period during which the object can be recovered.
+
Destroys the specified volume or snapshot. Unless the -Eradicate parameter is used, the destroyed object enters a 24-hour eradication pending period during which the object can be recovered.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
@@ -32026,7 +38466,7 @@
Parameters
-Name
-
none
+
The name of the volume or snapshot to destroy or eradicate.
true
True (ByPropertyName)
@@ -32034,69 +38474,163 @@
Parameters
-Eradicate
-
none
+
If set to true, eradicates the specified volume or snapshot. If destroying or eradicating a volume, its snapshots are also destroyed or eradicated.
After destroying a volume or snapshot, you can eradicate it to immediately terminate the 24-hour eradication period and begin storage reclamation. Once eradication has begun, the volume or snapshot can no longer be recovered.
If set to false, destroys the specified volume or snapshot. The destroyed volume or snapshot undergoes a 24-hour eradication pending period during which time the volume or snapshot and its data can be fully recovered. After the 24-hour pending period, Purity eradicates the destroyed volume or snapshot.
false
True (ByPropertyName)
False
+
+
-WhatIf
+
wi
+
Shows what would happen if the cmdlet runs. The cmdlet is not run.
+
false
+
false
+
False
+
-Confirm
cf
Prompts you for confirmation before running the cmdlet.
false
+
false
False
-
False
+
+
+
+
+
+
Inputs
+
The input type is the type of the objects that you can pipe to the cmdlet.
Destroys the volume named "vol1" as well as all snapshots based on "vol1". The destroyed voluem and objects enter a 24-hour eradication pending period.
Destroys and eradicates the snapshot named "vol1.example.snap". There is no 24-hour eradication pending period and the destroyed snapshot cannot be recovered.
Destroys the volume named "vol1" as well as all snapshots based on "vol1". The destroyed voluem and objects enter a 24-hour eradication pending period.
Destroys and eradicates the snapshot named "vol1.example.snap". There is no 24-hour eradication pending period and the destroyed snapshot cannot be recovered.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
-
None
+
-
-VolumesToRemove
-
none
-
List of volumes to be removed from the existing list.
+
-Name
+
+
The name of the volume or snapshot that contains the tag to be removed.
true
True (ByPropertyName)
-
None
+
-
-Name
-
none
-
Target protection group name.
+
-Key
+
+
A descriptive identifier of the tag. Part of the Key/Value pair of a tag. An example would be "Location". The tag key can only have unicode letters, numbers, white spaces, and the following characters: Hyphen (-), underscore (_), dot (.), slash (/), plus (+), and the at sign (@).
true
True (ByPropertyName)
-
None
+
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Namespace
+
+
Specifies a namespace in which to delete the tag(s).
false
-
False
-
False
+
True (ByPropertyName)
+
-WhatIf
wi
-
Shows what would happen if the cmdlet runs. The cmdlet is not run.
+
false
-
False
-
False
+
false
+
+
+
+
-Confirm
+
cf
+
+
false
+
false
+
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-NewName
-
none
-
New name of the SNMP manager. SNMP manager names are used in Purity administrative commands, and have no external significance. Changing the name of the SNMP manager does not change the protocol and security attributes of the manager object.
+
-Name
+
+
Targe SNMP manager name.
true
True (ByPropertyName)
None
-
-Name
-
none
-
Targe SNMP manager name.
+
-NewName
+
+
New name of the SNMP manager. SNMP manager names are used in Purity administrative commands, and have no external significance. Changing the name of the SNMP manager does not change the protocol and security attributes of the manager object.
true
True (ByPropertyName)
None
-
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
-
false
-
False
-
False
-
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
@@ -32948,7 +39510,7 @@
Parameters
-VolumeName
-
none
+
Target volume name.
true
True (ByPropertyName)
@@ -32956,7 +39518,7 @@
Parameters
-NewSize
-
none
+
New size of the volume in bytes. If the new volume size is smaller than the original, then the "truncate" parameter must be set to "true". The size must be a multiple of 512.
true
True (ByPropertyName)
@@ -32964,42 +39526,42 @@
Parameters
-Truncate
-
none
+
Truncates ("true") the volume. When a volume is truncated, Purity automatically takes an undo snapshot, providing a 24-hour window during which the previous contents can be retrieved. After truncating a volume, its provisioned size can be subsequently increased, but the data in truncated sectors cannot be retrieved.
Required if the volume "size" is set to a size that is smaller than the original.
false
True (ByPropertyName)
False
-
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
-
false
-
False
-
False
-
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
@@ -33786,23 +40350,15 @@
Parameters
-Company
-
none
+
Specifies the full legal name of the entity. The value must be between 1 and 64 characters in length.
true
True (ByPropertyName)
None
-
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
-
false
-
False
-
False
-
-Name
-
none
+
Specifies the full legal name of the individual at the company who has the authority to accept the terms of the agreement. The value must be between 1 and 64 characters in length.
true
True (ByPropertyName)
@@ -33810,7 +40366,7 @@
Parameters
-Title
-
none
+
Specifies the individual's job title at the company. The value must be between 1 and 64 characters in length.
true
True (ByPropertyName)
@@ -33821,17 +40377,25 @@
Parameters
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Sets "PureArrayAdminUsers" as the name of the directory service group ("CN=PureArrayAdminUsers") that contains users with array administrator privileges.
@@ -34191,14 +40755,14 @@
Examples
Set-PfaDirectoryServiceAuthenticationStatus
Enables or disables the directory service configuration.
-
+
Enables or disables the directory service configuration.
Sets the array's CA certificate to the certificate entered after the -Certificate parameter. Trusts the certificate and skips certificate chain trust verification. Does not download and confirm the server certificate.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
@@ -34405,7 +40980,7 @@
Parameters
-BaseDN
-
none
+
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.
true
True (ByPropertyName)
@@ -34413,85 +40988,251 @@
Parameters
-BindUser
-
none
+
The user name that can be used to bind to and query the directory. Often referred to as sAMAccountName or User Logon Name.
true
True (ByPropertyName)
None
+
+
-BindPassword
+
+
The password of the bind_user user name account.
+
true
+
True (ByPropertyName)
+
None
+
-URI
-
none
+
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.
true
True (ByPropertyName)
None
-
-BindPassword
-
none
-
The password of the bind_user user name account.
+
-WhatIf
+
wi
+
Shows what would happen if the cmdlet runs. The cmdlet is not run.
+
false
+
false
+
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
+
False
+
+
+
+
+
+
Inputs
+
The input type is the type of the objects that you can pipe to the cmdlet.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
+
true
+
True (ByPropertyName, ByValue)
+
None
+
+
+
-GroupBase
+
+
Specifies where the configured groups are located in the directory tree. This field consists of OUs that, when combined with the base DN attribute and the configured group CNs, complete the full DN of each groups. The group base should specify "OU=" for each OU and multiple OUs should be separated by commas. The order of OUs should get larger in scope from left to right.
true
True (ByPropertyName)
None
+
+
-WhatIf
+
wi
+
Shows what would happen if the cmdlet runs. The cmdlet is not run.
+
false
+
false
+
False
+
-Confirm
cf
Prompts you for confirmation before running the cmdlet.
false
+
false
False
-
False
+
+
+
+
+
+
Inputs
+
The input type is the type of the objects that you can pipe to the cmdlet.
Sets the Group Base for Directory Services authentication to Storage-Pure-Arrays. The Base DN attribute created by Set-PfaDirectoryServiceConfiguration is added automatically when the Directory Service is queried.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-GroupBase
-
none
-
Specifies where the configured groups are located in the directory tree. This field consists of OUs that, when combined with the base DN attribute and the configured group CNs, complete the full DN of each groups. The group base should specify "OU=" for each OU and multiple OUs should be separated by commas. The order of OUs should get larger in scope from left to right.
-
true
-
True (ByPropertyName)
-
None
-
-
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Enabled
+
+
Enables (true) or disables (false) directory service support.
false
-
False
+
True (ByPropertyName)
False
@@ -34537,33 +41270,52 @@
Parameters
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-StorageAdminGroup
-
none
-
The name should be just the Common Name of the group without the CN= specifier. Common Names should not exceed 64 characters in length.
+
-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.
true
True (ByPropertyName)
None
-
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
-
false
-
False
-
False
-
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Renames the current storage shelf named "SH1" to "SH7".
+
+
+The shelf's display light changes to "7" and subsequent commands must refer to the shelf as "SH7" (for example, "SH7.BAY0").
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-NameServers
-
none
-
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.
+
-Name
+
+
Target host name
true
True (ByPropertyName)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
-
false
-
False
-
False
+
-PreferredArray
+
+
Adds a list of preferred arrays, completely replacing any existing preferred arrays that are already set for the host.
+
true
+
True (ByPropertyName)
+
None
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
PurePowerShell.PureArray
-
-System.String[]
+
+System.String[]
+
+
+System.String
+
+
Outputs
+
The output type is the type of the objects that the cmdlet emits.
Renames the current storage shelf named "SH1" to "SH7".
-
-
-The shelf's display light changes to "7" and subsequent commands must refer to the shelf as "SH7" (for example, "SH7.BAY0").
Adds the specified hostgroups ("hostGroup1", "hostGroup2", "hostGroup3", "hostGroup4") to the protection group named "protectionGroup1".
+
+
+This command removes any hostgroups that previously were members of "protectionGroup1".
Assigns the IQNs "iqn.2015-06.com.example:str1", "iqn.2015-06.com.example:str2", and "iqn.2015-06.com.example:str3" to host "host1".
+
+
+This command removes any IQNs that previously assigned to "host1".
Adds the specified hostgroups ("hostGroup1", "hostGroup2", "hostGroup3", "hostGroup4") to the protection group named "protectionGroup1".
-
-
-This command removes any hostgroups that previously were members of "protectionGroup1".
Assigns the IQNs "iqn.2015-06.com.example:str1", "iqn.2015-06.com.example:str2", and "iqn.2015-06.com.example:str3" to host "host1".
-
-
-This command removes any IQNs that previously assigned to "host1".
Adds the specified hosts ("host1", "host2", "host3", "host4") to the host group named "hostGroup1". This command removes any hosts that previously were members of "hostGroup1".
Adds the specified hosts ("host1", "host2", "host3", "host4") to the protection group named "protectionGroup1".
+
+
+This command removes any hosts that previously were members of protectionGroup1.
Adds the specified hosts ("host1", "host2", "host3", "host4") to the host group named "hostGroup1". This command removes any hosts that previously were members of "hostGroup1".
Assigns the WWNs "111112222233333a", "111112222233333b", "111112222233333c" to host "host1".
+
+
+This command removes any WWNs that previously were assigned to host1.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Hosts
-
none
-
List of hosts to replace the list of member hosts.
+
-IdleTimeout
+
+
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.
true
True (ByPropertyName)
None
-
-Name
-
none
-
Target protection group name.
-
true
-
True (ByPropertyName)
-
None
+
-WhatIf
+
wi
+
Shows what would happen if the cmdlet runs. The cmdlet is not run.
+
false
+
false
+
False
-Confirm
cf
Prompts you for confirmation before running the cmdlet.
false
-
False
-
False
-
-
-
-WhatIf
-
wi
-
Shows what would happen if the cmdlet runs. The cmdlet is not run.
-
false
-
False
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Adds the specified hosts ("host1", "host2", "host3", "host4") to the protection group named "protectionGroup1".
-
-
-This command removes any hosts that previously were members of protectionGroup1.
+ EXAMPLE
+
Set-PfaIdleTimeout -Array $array -IdleTimeout 15
+
Sets the idle time limit to 15 minutes, for the specified array.
+ EXAMPLE
+
Set-PfaIdleTimeout -Array $array -IdleTimeout 0
+
Disables the idle timeout for the specified array.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
@@ -35773,77 +42553,71 @@
Parameters
-Name
-
none
-
Target host name.
+
+
Target network component.
true
True (ByPropertyName)
None
-
-WwnList
-
none
-
Assigns the list of Fibre Channel worldwide names (WWNs) to the specified host.
+
-Address
+
+
IPv4 address to be associated with the specified interface. IP addresses may be specified in CIDR format (ddd.ddd.ddd.ddd/dd). Alternatively, set the "address" parameter with the "netmask" parameter to specify the netmask in ddd.ddd.ddd.ddd format.
true
True (ByPropertyName)
None
-
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
-
false
-
False
-
False
-
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Assigns the WWNs "111112222233333a", "111112222233333b", "111112222233333c" to host "host1".
-
-
-This command removes any WWNs that previously were assigned to host1.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-IdleTimeout
-
none
-
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.
+
-Name
+
+
Target network component.
true
True (ByPropertyName)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
-
false
-
False
-
False
+
-Address
+
+
IPv4 address to be associated with the specified interface. IP addresses may be specified in CIDR format (ddd.ddd.ddd.ddd/dd). Alternatively, set the "address" parameter with the "netmask" parameter to specify the netmask in ddd.ddd.ddd.ddd format.
+
true
+
True (ByPropertyName)
+
None
+
+
+
-Netmask
+
+
The netmask in ddd.ddd.ddd.ddd format.
+
true
+
True (ByPropertyName)
+
None
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
PurePowerShell.PureArray
-
-System.Int32
+
+System.String
Examples
- EXAMPLE 1
-
Set-PfaIdleTimeout -Array $Array -IdleTimeout 15
-
Sets the idle time limit to 15 minutes, for the specified array.
- EXAMPLE 2
-
Set-PfaIdleTimeout -Array $Array -IdleTimeout 0
-
Disables the idle timeout for the specified array.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
@@ -35956,44 +42743,44 @@
Parameters
-Name
-
none
+
Target network component.
true
True (ByPropertyName)
None
-
-Address
-
none
-
IPv4 address to be associated with the specified interface. IP addresses may be specified in CIDR format (ddd.ddd.ddd.ddd/dd). Alternatively, set the "address" parameter with the "netmask" parameter to specify the netmask in ddd.ddd.ddd.ddd format.
+
-Gateway
+
+
IPv4 address (in ddd.ddd.ddd.ddd format) of the gateway through which the specified interface is to communicate with the network.
true
True (ByPropertyName)
None
-
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
-
false
-
False
-
False
-
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-
-Netmask
-
none
-
The netmask in ddd.ddd.ddd.ddd format.
-
true
-
True (ByPropertyName)
-
None
-
-Name
-
none
+
Target network component.
true
True (ByPropertyName)
None
-
-Address
-
none
-
IPv4 address to be associated with the specified interface. IP addresses may be specified in CIDR format (ddd.ddd.ddd.ddd/dd). Alternatively, set the "address" parameter with the "netmask" parameter to specify the netmask in ddd.ddd.ddd.ddd format.
+
-Mtu
+
+
Maximum message transfer unit (packet) size for the interface in bytes. Valid values are integers between 1280 and 9216 (inclusive). The default value is 1500.
true
True (ByPropertyName)
None
-
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
-
false
-
False
-
False
-
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Name
-
none
-
Target network component.
+
-NTPServers
+
+
Alternate NTP servers, by IP address or hostname, assigned as the array source for reference time. Supersedes any previous NTP server assignments.
true
True (ByPropertyName)
None
-
-Mtu
-
none
-
Maximum message transfer unit (packet) size for the interface in bytes. Valid values are integers between 1280 and 9216 (inclusive). The default value is 1500.
-
true
-
True (ByPropertyName)
-
None
+
-WhatIf
+
wi
+
Shows what would happen if the cmdlet runs. The cmdlet is not run.
+
false
+
false
+
False
-Confirm
cf
Prompts you for confirmation before running the cmdlet.
false
-
False
-
False
-
-
-
-WhatIf
-
wi
-
Shows what would happen if the cmdlet runs. The cmdlet is not run.
-
false
-
False
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Id
-
none
-
Flags (true) or unflags (false) a message. If set to true, flags the message with the specified ID. If set to false, unflags the message.
+
-Name
+
+
Target host name.
true
True (ByPropertyName)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
-
false
-
False
-
False
+
-Personality
+
+
Determines the way in which the host personality tunes the protocol used between the array and the initiator. If the host is running the HP-UX operating system, set the host personality to "hpux".
+
true
+
True (ByPropertyName)
+
None
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
@@ -36497,71 +43271,79 @@
Parameters
-Name
-
none
-
Target host name.
+
+
Target pod name.
true
True (ByPropertyName)
None
-
-Personality
-
none
-
Determines the way in which the host personality tunes the protocol used between the array and the initiator. If the host is running the HP-UX operating system, set the host personality to "hpux".
+
-FailoverPreference
+
+
Specifies which array within a stretched pod should be given priority to stay online, should the arrays ever lose contact with each other.
true
True (ByPropertyName)
None
-
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
-
false
-
False
-
False
-
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
PurePowerShell.PureArray
-
-System.String
+
+System.String
+
+
+System.String[]
+
+
Outputs
+
The output type is the type of the objects that the cmdlet emits.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
-
None
+
-
-Status
-
none
-
Enables ("Enabled") or disables ("Disabled") the transmission of phonehome logs.
+
-Name
+
+
The Pod name.
true
True (ByPropertyName)
-
None
+
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Quiesce
+
+
Specifying this parameter as true allows the demoted pod to become a target pod after the replica-link status changes to quiesced. Specifying this setting ensures that all local data has been replicated to the remote pod before the demotion process.
false
-
False
-
False
+
True (ByPropertyName)
+
+
+
+
-SkipQuiesce
+
+
If this parameter is present as true, the pod will become a target pod without waiting for the quiesced replica-link status. Specifying this setting loses all pending data to be replicated to the remote pod.
+
false
+
True (ByPropertyName)
+
-WhatIf
@@ -36608,46 +43398,55 @@
Parameters
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
False
+
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
False
+
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-DefaultRetentionForAllTargetSnapshots
-
none
-
Specifies the length of time to keep the replicated snapshots on the target arrays. Maps to the "target_all_for" parameter in the REST API.
+
-GroupName
+
+
Target protection group name.
+
true
+
True (ByPropertyName)
+
None
+
+
+
-DefaultRetentionForAllSourceSnapshots
+
+
Specifies the length of time to keep the snapshots on the source array before they are eradicated. Maps to the "all_for" parameter in the REST API.
false
True (ByPropertyName)
None
-
-PostDefaultTargetSnapshotsPerDay
-
none
-
Specifies the number of per_day replicated snapshots to keep beyond the DefaultRetentionForAllTargetSnapshots period. Maps to the "target_per_day" parameter in the REST API.
+
-PostDefaultSourceSnapshotsPerDay
+
+
Specifies the number of per_day source (local) snapshots to keep beyond the DefaultRetentionForAllSourceSnapshots period. Maps to the "per_day" parameter in the REST API.
false
True (ByPropertyName)
None
-PostDefaultSourceSnapshotRetentionInDays
-
none
+
Specifies the number of days to keep the per_day source (local) snapshots beyond the DefaultRetentionForAllSourceSnapshots period before they are eradicated. Maps to the "days" parameter in the REST API.
false
True (ByPropertyName)
None
-
-PostDefaultSourceSnapshotsPerDay
-
none
-
Specifies the number of per_day source (local) snapshots to keep beyond the DefaultRetentionForAllSourceSnapshots period. Maps to the "per_day" parameter in the REST API.
+
-DefaultRetentionForAllTargetSnapshots
+
+
Specifies the length of time to keep the replicated snapshots on the target arrays. Maps to the "target_all_for" parameter in the REST API.
false
True (ByPropertyName)
None
-
-GroupName
-
none
-
Target protection group name.
-
true
+
-PostDefaultTargetSnapshotsPerDay
+
+
Specifies the number of per_day replicated snapshots to keep beyond the DefaultRetentionForAllTargetSnapshots period. Maps to the "target_per_day" parameter in the REST API.
+
false
True (ByPropertyName)
None
-PostDefaultTargetSnapshotRetentionInDays
-
none
+
Specifies the number of days to keep the target_per_day replicated snapshots beyond the DefaultRetentionForAllTargetSnapshots period before they are eradicated. Maps to the "target_days" parameter in the REST API.
false
True (ByPropertyName)
None
-
-DefaultRetentionForAllSourceSnapshots
-
none
-
Specifies the length of time to keep the snapshots on the source array before they are eradicated. Maps to the "all_for" parameter in the REST API.
+
-WhatIf
+
wi
+
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
-
True (ByPropertyName)
-
None
+
false
+
False
-Confirm
cf
Prompts you for confirmation before running the cmdlet.
false
-
False
-
False
-
-
-
-WhatIf
-
wi
-
Shows what would happen if the cmdlet runs. The cmdlet is not run.
-
false
-
False
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Sets the retention rules for the protection group protectionGroup1.
@@ -36883,9 +43686,9 @@
Examples
-DefaultRetentionForAllSourceSnapshots 7 By default, keeps snapshots on the source array for 7 days before they are eradicated. (PostDefaultSourceSnapshotRetentionInDays extends this number of days for per_day snapshots.)
Modifies an existing retention rule for the protection group protectionGroup1. This example changes 3 of the retention rules and passes in $CurrentRetention values for the other rules.
@@ -36908,7 +43711,7 @@
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-SnapshotFrequencyInSeconds
-
none
-
How often snapshots will be generated. Maps to the "snap_frequency" parameter in the REST API.
-
false
+
-GroupName
+
+
The target protection group name.
+
true
True (ByPropertyName)
None
-
-PreferredTimeOfDayToGenerateSnapshot
-
none
-
Specifies the preferred time at which to generate snapshots. The time is specified in seconds from midnight and must be on the hour (a multiple of 3600). Maps to the "snap_at" parameter in the REST API.
+
-Blackouts
+
+
Specifies a range of time (in seconds from midnight) during which to suspend replication. (Blackout periods only apply to scheduled replications, not to on-demand replications.) Maps to the "replicate_blackout" parameter in the REST API.
false
True (ByPropertyName)
None
-ReplicateAtSecondsOfDay
-
none
+
Time of day (in seconds from midnight) to initiate the transfer of replicated snapshots. Maps to the "replicate_at" parameter in the REST API.
false
True (ByPropertyName)
None
-
-
-GroupName
-
none
-
The target protection group name.
-
true
-
True (ByPropertyName)
-
None
-
-ReplicationFrequencyInSeconds
-
none
+
How often the transfer of replicated snapshots will occur. Maps to the "replication_frequency" parameter in the REST API.
false
True (ByPropertyName)
None
-
-Blackouts
-
none
-
Specifies a range of time (in seconds from midnight) during which to suspend replication. (Blackout periods only apply to scheduled replications, not to on-demand replications.) Maps to the "replicate_blackout" parameter in the REST API.
+
-SnapshotFrequencyInSeconds
+
+
How often snapshots will be generated. Maps to the "snap_frequency" parameter in the REST API.
false
True (ByPropertyName)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-PreferredTimeOfDayToGenerateSnapshot
+
+
Specifies the preferred time at which to generate snapshots. The time is specified in seconds from midnight and must be on the hour (a multiple of 3600). Maps to the "snap_at" parameter in the REST API. (Requires REST 1.4+)
false
-
False
-
False
+
True (ByPropertyName)
+
None
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Sets the following snapshot and replication schedule for the protection group "protectionGroup1": generate snapshots every hour (3600 seconds), and initiate the transfer of replicated snapshots every 4 hours (14400 seconds).
Adds a replication blackout from 10 AM (36000 seconds from midnight) to 12 noon (43200 seconds from midnight) every day to an existing replication schedule.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
@@ -37073,36 +43876,36 @@
Parameters
-Proxy
-
none
+
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.
true
True (ByPropertyName)
None
-
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
-
false
-
False
-
False
-
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
@@ -37156,36 +43959,36 @@
Parameters
-RelayHost
-
none
+
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.
true
True (ByPropertyName)
None
-
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
-
false
-
False
-
False
-
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
@@ -37325,36 +44128,36 @@
Parameters
-ScsiTimeout
-
none
+
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.
true
True (ByPropertyName)
None
-
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
-
false
-
False
-
False
-
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
PurePowerShell.PureArray
-
+
System.Int32
@@ -37363,8 +44166,8 @@
Examples
- EXAMPLE 1
-
Set-PfaScsiTimeout -Array $Array -ScsiTimeout 30
+ EXAMPLE
+
Set-PfaScsiTimeout -Array $array -ScsiTimeout 30
Sets the iSCSI timeout for the specified array to 30 seconds.
@@ -37374,14 +44177,14 @@
Examples
Set-PfaSenderDomain
Sets the sender domain from which Purity sends email alert messages for the array.
-
+
Sets the sender domain from which Purity sends email alert messages for the array.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-AuthPassphrase
-
none
-
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)}.
Required if the "auth-protocol" value is set.
+
-Name
+
+
Target SNMP manager name.
true
True (ByPropertyName)
None
-
-Name
-
none
-
Target SNMP manager name.
+
-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)}.
Required if the "auth-protocol" value is set.
true
True (ByPropertyName)
None
-
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
-
false
-
False
-
False
-
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
@@ -37889,7 +44692,7 @@
Parameters
-Name
-
none
+
Target SNMP manager name.
true
True (ByPropertyName)
@@ -37897,36 +44700,36 @@
Parameters
-Community
-
none
+
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)}.
true
True (ByPropertyName)
None
-
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
-
false
-
False
-
False
-
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Sets the IP address associated with the SNMP manager "MyMgr" to "102.00.00.01".
@@ -38036,15 +44839,15 @@
Examples
Set-PfaSnmpManagerNotification
+
Update the SNMP message to send on an event.
Update the SNMP message to send on an event. Either trap or inform. Both are types of message sent from one application to another. But "trap" is unacknowledged message, while "inform" is acknowledged message.
-
Update the SNMP message to send on an event. Either trap or inform.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
@@ -38165,7 +44968,7 @@
Parameters
-Name
-
none
+
Target SNMP manager name.
true
True (ByPropertyName)
@@ -38173,127 +44976,36 @@
Parameters
-PrivacyPassphrase
-
none
+
SNMP v3 only. Passphrase used to encrypt SNMP messages. The value must be between 8 and 63 non-space ASCII characters in length. Required if the "privacy_protocol" value is set.
true
True (ByPropertyName)
None
-
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
-
false
-
False
-
False
-
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
-
False
+
false
False
-
-
-
-
-
Inputs
-
The input type is the type of the objects that you can pipe to the cmdlet.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
@@ -38347,44 +45059,135 @@
Parameters
-Name
-
none
-
Targe SNMP manager name.
+
+
Target SNMP manager name.
true
True (ByPropertyName)
None
-
-User
-
none
-
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)}.
+
-PrivacyProtocol
+
+
SNMP v3 only. Encryption protocol for SNMP messages. Valid values are "AES" or "DES".
true
True (ByPropertyName)
None
+
+
-WhatIf
+
wi
+
Shows what would happen if the cmdlet runs. The cmdlet is not run.
+
false
+
false
+
False
+
-Confirm
cf
Prompts you for confirmation before running the cmdlet.
false
+
false
False
-
False
+
+
+
+
+
+
Inputs
+
The input type is the type of the objects that you can pipe to the cmdlet.
+
PurePowerShell.PureArray
+
+
+System.String
+
+
+
Examples
+
+
+
+ EXAMPLE
+
Set-PfaSnmpManagerPrivacyProtocol -Array $array -PrivacyProtocol DES -Name MyMgr
+
Sets "DES" as the privacy protocol to use with the SNMP manager "MyMgr". Requires that the privacy passphrase must be set.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
+
true
+
True (ByPropertyName, ByValue)
+
None
+
+
+
-Name
+
+
Targe SNMP manager name.
+
true
+
True (ByPropertyName)
+
None
+
+
+
-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)}.
+
true
+
True (ByPropertyName)
+
None
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-Version
-
none
-
Version of the SNMP protocol to be used by Purity in communications with the specified manager(s). The "version" value is case sensitive. Valid values are "v2c" (default) and "v3".
+
-Name
+
+
Target SNMP manager name.
true
True (ByPropertyName)
None
-
-Name
-
none
-
Target SNMP manager name.
+
-Version
+
+
Version of the SNMP protocol to be used by Purity in communications with the specified manager(s). The "version" value is case sensitive. Valid values are "v2c" (default) and "v3".
true
True (ByPropertyName)
None
-
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
-
false
-
False
-
False
-
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-BandwidthLimit
-
none
-
Specify bandwidth limit for volume group IO in bytes per second.
+
-Name
+
+
Target volume group name.
true
True (ByPropertyName)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
-
false
-
False
-
False
-
-
-
-Name
-
none
-
Target volume group name.
+
-BandwidthLimit
+
+
Specify bandwidth limit for volume group IO in bytes per second. Whenever throughput exceeds the bandwidth limit, throttling occurs. If the bandwidth limit is set, it must be between 1 MB/s and 512 GB/s. Enter the size as a number (bytes).
true
True (ByPropertyName)
None
@@ -38931,20 +45726,28 @@
Parameters
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
None
-
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
-
false
-
False
-
False
-
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
@@ -39405,8 +46208,8 @@
Examples
- EXAMPLE 1
-
Test-PfaAlerts -Array $Array
+ EXAMPLE
+
Test-PfaAlerts -Array $array
Tests the ability of the array to send alert messages to all of the designated email addresses.
@@ -39415,15 +46218,15 @@
Examples
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. Also verifies that it can find all the configured groups to ensure the Common Names and group base are correctly configured.
-
+
Tests the current directory service configuration.
+
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. Also verifies that it can find all the configured groups to ensure the Common Names and group base are correctly configured.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
@@ -39779,7 +46582,7 @@
Parameters
-DefaultLimit
-
none
+
Default maximum network bandwidth threshold for outbound traffic. Once the threshold is exceeded, bandwidth throttling occurs.
Enter the size as a number (bytes) or as a string with a single character unit symbol. Valid unit symbols are K, M, G, representing KiB, MiB, GiB, respectively, where "Ki" denotes 2^10, "Mi" denotes 2^20, and so on. If the unit symbol is not specified, the unit defaults to bytes.
The maximum threshold must be between one megabyte per second and four gigabytes per second. The maximum threshold value represents an average data rate, so actual data transfer rates can fluctuate slightly above the configured limit.
To completely stop the data transfer process, set the option to "0". During this time, all in-progress and scheduled data transfer processes are aborted.
A $null is used to clear the limit.
true
True (ByPropertyName)
@@ -39787,7 +46590,7 @@
Parameters
-Connection
-
none
+
The name of the connection to apply the throttling settins. The connection name is the array name of the peer array.
true
True (ByPropertyName)
@@ -39795,63 +46598,77 @@
Parameters
-Window
-
none
-
Range of time the 'WindowLimit' threshold is in effect.
Start and end times must be set on the hour. The start and end times must be specified as seconds from midnight.
Pass $null to unset the limit.
+
+
Range of time the 'WindowLimit' threshold is in effect. Example:
Start and end times, both measured in seconds, must be set on the hour. The start and end times must be specified as seconds from midnight. The start attribute represents the window start time and end attribute represents the window end time. Example: ("start: 3600", "end: 7200") would start 60 minutes after midnight (1:00AM) and end 120 minutes after midnight (3:00AM). Pass $null to unset the limit.
Creating a new object is optimal for this type of parameter and then using the variable for that object as the property of the -Window parameter. As an example: $window = New-Object PureStorage.Rest.ThrottlingWindow $window.StartSecondsOfDay = 3600 $window.EndSecondsOfDay = 7200
true
True (ByPropertyName)
None
-WindowLimit
-
none
+
Maximum network bandwidth threshold for outbound traffic during the specified 'Window' time range. Can use symbols like "MB","GB"
Enter the size as a number (bytes) or as a string with a single character unit symbol. Valid unit symbols are K, M, G, representing KiB, MiB, GiB, respectively, where "Ki" denotes 2^10, "Mi" denotes 2^20, and so on. If the unit symbol is not specified, the unit defaults to bytes.
To completely stop the data transfer process, set the option to "0". During this time, all in-progress and scheduled data transfer processes are aborted.
The maximum threshold must be between one megabyte per second and four gigabytes per second. The maximum threshold value represents an average data rate, so actual data transfer rates can fluctuate slightly above the configured limit.
The 'window' limit overrides the 'default' limit.
A $null is used to clear the limit.
true
True (ByPropertyName)
None
-
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
-
false
-
False
-
False
-
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Updates the connection throttling window on Array $array to the peer array 'peer-array' to a set limit of 1G, starting at 1AM and ending at 3AM, with a bandwidth limit of 200M during that window.
Updates the KMIP configuration named "KMIPName" with new Uri and new certificate.
@@ -40050,15 +46867,15 @@
Examples
Update-PfaSubnetSettings
-
(REST API 1.5+) Creates a subnet.
-
+
Updates a subnet on an array. (Requires REST API 1.5+)
+
Updates the configuration of a subnet that exists on the Array.
In Purity//FA, interfaces with common attributes can be organized into subnetworks, (or subnets) to enhance the efficiency of data (iSCSI, NVMe-RoCE, or file), management, and replication traffic if applicable.
If the subnet is assigned a valid IP address, once it is created, all of its enabled interfaces are immediately available for connection. The subnet inherits the services from all of its interfaces. Likewise, the interfaces contained in the subnet inherit the netmask, gateway, MTU, and VLAN ID (if applicable) attributes from the subnet.
Physical, virtual, and bond interfaces can belong to the same subnet. VLAN interfaces can only belong to subnets with other VLAN interfaces.
Physical, virtual, and bond interfaces in a subnet share common address, netmask, and MTU attributes. The subnet can contain a mix of physical, virtual, and bond interfaces, and the interface services can be of any type, such as iSCSI, management, NVMe-RoCE, or replication services. To add physical, virtual, or bond interfaces to a subnet, create the subnet and then run purenetwork eth setattr --subnet to add the interfaces to the subnet.
A VLAN interface is a dedicated virtual network interface that is designed to be used with an organization’s virtual local area network (VLAN). Through VLAN interfaces, Purity//FA employs VLAN tags to ensure the data passing between the array and VLANs is securely isolated and routed properly.
The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.
true
True (ByPropertyName, ByValue)
@@ -40085,87 +46902,98 @@
Parameters
-Subnet
-
none
-
@{Text=}
+
+
The subnet name.
true
True (ByPropertyName)
None
-Prefix
-
none
+
Sets the IPv4 address to be associated with the specified subnet. Prefixes must be specified in CIDR format (ddd.ddd.ddd.ddd/dd).
false
True (ByPropertyName)
None
-
-
-Vlan
-
none
-
VLAN ID. To remove the VLAN ID, set it to zero.
-
false
-
True (ByPropertyName)
-
None
-
-Gateway
-
none
-
Sets the IPv4 address (in ddd.ddd.ddd.ddd format) of the gateway through which the specified subnet is to communicate with the network. To remove the value, set it to empty string.
+
+
Sets the IPv4 address (in CIDR format ddd.ddd.ddd.ddd) of the gateway through which the specified subnet is to communicate with the network. To remove the value, set it to empty string.
false
True (ByPropertyName)
None
-Mtu
-
none
+
Maximum message transfer unit (packet) size for the subnet in bytes. Valid values are integers between 1280 and 9216 (inclusive). The default value is 1500.
false
True (ByPropertyName)
None
-
-Confirm
-
cf
-
Prompts you for confirmation before running the cmdlet.
+
-Vlan
+
+
The VLAN ID. To remove the VLAN ID, set it to zero (0).
false
-
False
-
False
+
True (ByPropertyName)
+
None
-WhatIf
wi
Shows what would happen if the cmdlet runs. The cmdlet is not run.
false
+
false
False
+
+
+
-Confirm
+
cf
+
Prompts you for confirmation before running the cmdlet.
+
false
+
false
False
-
+
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Enables or disables a subnet. (Requires REST API 1.5+)
+
Sets the enabled or disabled flag for a subnet on the array.
In Purity//FA, interfaces with common attributes can be organized into subnetworks, (or subnets) to enhance the efficiency of data (iSCSI, NVMe-RoCE, or file), management, and replication traffic if applicable.
If the subnet is assigned a valid IP address, once it is created, all of its enabled interfaces are immediately available for connection. The subnet inherits the services from all of its interfaces. Likewise, the interfaces contained in the subnet inherit the netmask, gateway, MTU, and VLAN ID (if applicable) attributes from the subnet.
Physical, virtual, and bond interfaces can belong to the same subnet. VLAN interfaces can only belong to subnets with other VLAN interfaces.
Physical, virtual, and bond interfaces in a subnet share common address, netmask, and MTU attributes. The subnet can contain a mix of physical, virtual, and bond interfaces, and the interface services can be of any type, such as iSCSI, management, NVMe-RoCE, or replication services. To add physical, virtual, or bond interfaces to a subnet, create the subnet and then run purenetwork eth setattr --subnet to add the interfaces to the subnet.
A VLAN interface is a dedicated virtual network interface that is designed to be used with an organization’s virtual local area network (VLAN). Through VLAN interfaces, Purity//FA employs VLAN tags to ensure the data passing between the array and VLANs is securely isolated and routed properly.
+ Copyright 2022 @ Pure Storage. All rights reserved.
diff --git a/README.md b/README.md
index 5b21371..124a9c6 100644
--- a/README.md
+++ b/README.md
@@ -1,29 +1,30 @@
-# Pure Storage FlashArray PowerShell SDK 1
+## Pure Storage FlashArray PowerShell SDK version 1
 
The Pure Storage FlashArray PowerShell SDK provides integration with the Purity Operating Environment and FlashArray. It provides functionalities of Purity's REST API as PowerShell cmdlets.
-This is __version 1__ of the SDK. Version 2 can be found in this repository:
-:octocat: [Github Repository for SDK version 2](https://www.github.com/PureStorage-Connect/PowerShellSDK2)
+This is __version 1__ of the SDK. This version support FlashArray Purity API versions 1.7 to 1.19.
+Version 2 of the SDK which supports FlashArray Purity API version 2.0 and later can be found in this repository :octocat: [SDK v2 Repository](https://www.github.com/PureStorage-Connect/PowerShellSDK2)
-## :floppy_disk: INSTALLATION
+### :floppy_disk: INSTALLATION
-There are two ways to install the SDK - via the PowerShell Gallery, or a standalone MSI installer. The recommended method for installation is to use the Install-Module cmdlet in PowerShell which will pull the latest release from the PowerShell Gallery.
+There are two ways to install the SDK:
+* __Recommended__ - Using Install-Module to pull the module from the PowerShell Gallery (PSGallery).
+* A standalone MSI installation package.
+The recommended method for installation is to use the Install-Module cmdlet in PowerShell which will pull the latest release from the PowerShell Gallery.
```powershell
Install-Module -Name PureStoragePowerShellSDK
```
-This repository contains the standalone MSI installer.
+This repository contains the standalone MSI installer in the Releases section.
-## :point_down: DOWNLOADS
+### :point_down: DOWNLOADS
:small_orange_diamond: [Version 1 MSI Installation Package](https://github.com/PureStorage-Connect/PowerShellSDK/blob/master/PureStoragePowerShellSDKInstaller.msi)
-:small_orange_diamond: [Version 2 MSI Installation Package](https://github.com/PureStorage-Connect/PowerShellSDK/blob/master/PureStoragePowerShellSDKInstaller.msi)
-
:small_orange_diamond: [Downloadable HTML Help File](https://github.com/PureStorage-Connect/PowerShellSDK/blob/master/PureStoragePowerShellSDK-Help.html)
:small_orange_diamond: [Pure Storage Support -- Programming Interfaces > PowerShell](https://support.purestorage.com/Solutions/Microsoft_Platform_Guide/a_Windows_PowerShell)
@@ -34,35 +35,30 @@ This repository contains the standalone MSI installer.
-## :rocket: LATEST MSI RELEASE OF SDK v1.x
-* [v1.17.16.0](https://github.com/PureStorage-Connect/PowerShellSDK/releases/tag/v1.17.16.0)
-
-## :date: HISTORY
-* [v1.17.11.0](https://github.com/PureStorage-Connect/PowerShellSDK/releases/tag/v1.17.11)
-* [v1.16.0](https://github.com/PureStorage-Connect/PowerShellSDK/releases/tag/v1.16)
-* [v1.13.0](https://github.com/PureStorage-Connect/PowerShellSDK/releases/tag/v1.13)
-* [v1.7.4](https://github.com/PureStorage-Connect/PowerShellSDK/releases/tag/v1.7.4.0)
-* [v1.6.6](https://github.com/PureStorage-Connect/PowerShellSDK/releases/tag/v1.6.6.0)
-* [v1.5.5](https://github.com/PureStorage-Connect/PowerShellSDK/releases/tag/v1.5.5.0)
-* [v1.5.4](https://github.com/PureStorage-Connect/PowerShellSDK/releases/tag/v1.5.4.0)
+### :rocket: LATEST MSI RELEASE OF SDK v1.x
+* [v1.19.37.0](https://github.com/PureStorage-Connect/PowerShellSDK/releases/tag/v1.19.37.0)
+### :date: HISTORY
+* [v1.17.16.0](https://github.com/PureStorage-Connect/PowerShellSDK/releases/tag/v1.17.16)
+* v1.17.11.0
+* v1.16.0
+* v1.13.0
+* v1.7.4
+* v1.6.6
+* v1.5.5
+* v1.5.4
-
-
-## :tv: VIDEOS
+### :tv: VIDEOS
[Check the Pure Storage YouTube channel for SDK v1 videos](https://www.youtube.com/user/purestorage)
-
-
-
-
:wrench: To report issues or request new features, please file an Issue.
To report issues or request new features, please file an Issue.
+
+:question: For questions, join our Pure Storage Code Slack team! Check out the #pfa-powershell channel
diff --git a/SDK-Examples.ps1 b/SDK-Examples.ps1
index c9698bf..984d88c 100644
--- a/SDK-Examples.ps1
+++ b/SDK-Examples.ps1
@@ -1,15 +1,15 @@
-<#
-Example PowerShell scripts for the Pure Storage PowerShell SDK
- This contains the step-by-step example script that follows along with the Quick Start Guide (https://support.purestorage.com/Solutions/Microsoft_Platform_Guide/a_Windows_PowerShell) as well as some further examples to help you create your own scripts using the SDK.
+# Example PowerShell code, scripts, and functions for the Pure Storage PowerShell SDK v1
+<#
+ This file contains the example script that follows along with the Quick Start Guide (https://support.purestorage.com/Solutions/Microsoft_Platform_Guide/a_Windows_PowerShell) as well as some further examples to help you create your own scripts using the SDK.
-This script is AS-IS. No warranties expressed or implied by Pure Storage or the creator.
+These examples are presented AS-IS. These examples are not meant to be implemented as-is in a production environment. No warranties expressed or implied by Pure Storage or the contributors.
: REVISION HISTORY
-:: 03.10.2021 - Added extended script and altered text for clarity. [mnelson]
-::
+:: 01.05.2022 - Added examples and clarified code.
+:: 03.10.2021 - Added extended script and altered text for clarity.
-: CONTRIBUTING AUTHORS
-:: Barkz, Mike Nelson, Julian Cates, Robert Quimbey -- @purestorage.com
+: CONTRIBUTORS
+:: Barkz, Mike Nelson, Julian Cates, Robert Quimbey -- @purestorage
#>
###START
@@ -29,87 +29,108 @@ Get-Help New-PfaArray -Examples
## Connecting to the FlashArray
###############################
$Creds = Get-Credential
-$FlashArray = New-PfaArray -EndPoint -Credentials $Creds -IgnoreCertificateError
-Get-PfaControllers -Array $FlashArray
-$Controllers = Get-PfaControllers –Array $FlashArray
+$fa = New-PfaArray -EndPoint 192.0.0.1 -Credentials $Creds -IgnoreCertificateError
+Get-PfaControllers -Array $fa
+$Controllers = Get-PfaControllers -Array $fa
$Controllers
## Working with Volumes
#######################
-New-PfaVolume –Array $FlashArray –VolumeName 'TEST-VOL' –Unit 'TB' –Size 2
-ForEach ($i in 2..10) { New-PfaVolume –Array $FlashArray –VolumeName “TEST-VOL$i” –Unit TB –Size 2 }
-Get-PfaVolume –Array $FlashArray –Name ‘TEST-VOL’ | Format-Table –Autosize
-Rename-PfaVolumeOrSnapshot –Array $FlashArray –NewName ‘TEST-VOL1’ –Name ‘TEST-VOL’
+New-PfaVolume -Array $fa -VolumeName "sdk-vol" -Unit "TB" -Size 2
+ForEach ($i in 2..10) { New-PfaVolume -Array $fa -VolumeName “sdk-vol$i” -Unit TB -Size 2 }
+Get-PfaVolume -Array $fa -Name "sdk-vol" | Format-Table -Autosize
+Rename-PfaVolumeOrSnapshot -Array $fa -NewName "sdk-vol1" -Name "sdk-vol"
## Volume and Host Connections
##############################
$wwn=@('10:00:00:00:00:00:11:11','10:00:00:00:00:00:12:12')
-New-PfaHost –Array $FlashArray –Name ‘TEST-HOST1’ –WwnList $wwn
-New-PfaHostGroup -Array $FlashArray -Hosts 'TEST-HOST1' -Name 'TEST-HOSTGROUP'
-New-PfaHostVolumeConnection -Array $FlashArray -VolumeName 'TEST-VOL1' -HostName 'TEST-HOST1'
-New-PfaHostGroupVolumeConnection -Array $FlashArray -VolumeName 'TEST-VOL2' -HostGroupName 'TEST-HOSTGROUP'
+New-PfaHost -Array $fa -Name "sdk-host1" -WwnList $wwn
+New-PfaHostGroup -Array $fa -Hosts "sdk-host1" -Name "sdk-hostgroup"
+New-PfaHostVolumeConnection -Array $fa -VolumeName "sdk-vol1" -HostName "sdk-host1"
+New-PfaHostGroupVolumeConnection -Array $fa -VolumeName "sdk-vol2" -HostGroupName "sdk-hostgroup"
## FlashRecover Snapshots
#########################
-New-PfaVolumeSnapshots -Array $FlashArray -Sources 'TEST-VOL1','TEST-VOL2' -Suffix 'EXAMPLE'
-New-PfaVolume -Array $FlashArray -Source 'TEST-VOL1.EXAMPLE' -VolumeName 'NEW-TEST-VOL1'
-New-PfaVolume -Array $FlashArray -Source 'TEST-VOL2.EXAMPLE' -VolumeName 'TEST-VOL2' –Overwrite
+New-PfaVolumeSnapshots -Array $fa -Sources "sdk-vol1","sdk-vol2" -Suffix "EXAMPLE"
+New-PfaVolume -Array $fa -Source "sdk-vol1.EXAMPLE" -VolumeName "new-sdk-vol1"
+New-PfaVolume -Array $fa -Source "sdk-vol2.EXAMPLE" -VolumeName "sdk-vol2" -Overwrite
## Protection Groups
####################
-New-PfaProtectionGroup -Array $FlashArray -Name ‘TEST-PGROUP’
+New-PfaProtectionGroup -Array $fa -Name "sdk-pgroup"
$Volumes = @()
-ForEach($i in 1..10) { $Volumes += @("TEST-VOL$i") }
+ForEach($i in 1..10) { $Volumes += @("sdk-vol$i") }
$Volumes
-Add-PfaVolumesToProtectionGroup -Array $FlashArray -VolumesToAdd $Volumes -Name 'TEST-PGROUP'
-New-PfaProtectionGroupSnapshot -Array $FlashArray -Protectiongroupname 'TEST-PGROUP' -Suffix 'EXAMPLE'
-Get-PfaProtectionGroupSnapshots -Array $FlashArray -Name 'TEST-PGROUP'
-Get-PfaProtectionGroupSchedule -Array $FlashArray -ProtectionGroupName 'TEST-PGROUP'
-Set-PfaProtectionGroupSchedule -Array $FlashArray -SnapshotFrequencyInSeconds 21600 -GroupName 'TEST-PGROUP'
-Enable-PfaSnapshotSchedule -Array $FlashArray -Name 'TEST-PGROUP'
+Add-PfaVolumesToProtectionGroup -Array $fa -VolumesToAdd $Volumes -Name "sdk-pgroup"
+New-PfaProtectionGroupSnapshot -Array $fa -Protectiongroupname "sdk-pgroup" -Suffix "EXAMPLE"
+Get-PfaProtectionGroupSnapshots -Array $fa -Name "sdk-pgroup"
+Get-PfaProtectionGroupSchedule -Array $fa -ProtectionGroupName "sdk-pgroup"
+Set-PfaProtectionGroupSchedule -Array $fa -SnapshotFrequencyInSeconds 21600 -GroupName "sdk-pgroup"
+Enable-PfaSnapshotSchedule -Array $fa -Name "sdk-pgroup"
$Volumes = @()
-ForEach($i in 1..10) { $Volumes += @("TEST-VOL$i") }
+ForEach($i in 1..10) { $Volumes += @("sdk-vol$i") }
$Volumes
-Remove-PfaVolumesFromProtectionGroup -Array $FlashArray -VolumesToRemove $Volumes -Name 'TEST-PGROUP'
+Remove-PfaVolumesFromProtectionGroup -Array $fa -VolumesToRemove $Volumes -Name "sdk-pgroup"
-Add-PfaHostsToProtectionGroup -Array $FlashArray -Name 'TEST-PGROUP' -HostsToAdd 'TEST-HOST1'
-New-PfaProtectionGroupSnapshot -Array $FlashArray -Protectiongroupname 'TEST-PGROUP'
-Remove-PfaHostsFromProtectionGroup -Array $FlashArray -HostsToRemove 'TEST-HOST1' -Name 'TEST-PGROUP'
+Add-PfaHostsToProtectionGroup -Array $fa -Name "sdk-pgroup" -HostsToAdd "sdk-host1"
+New-PfaProtectionGroupSnapshot -Array $fa -Protectiongroupname "sdk-pgroup"
+Remove-PfaHostsFromProtectionGroup -Array $fa -HostsToRemove "sdk-host1" -Name "sdk-pgroup"
-Add-PfaHostGroupsToProtectionGroup -Array $FlashArray -HostGroupsToAdd 'TEST-HOSTGROUP' -Name 'TEST-PGROUP'
-New-PfaProtectionGroupSnapshot -Array $FlashArray -Protectiongroupname 'TEST-PGROUP'
+Add-PfaHostGroupsToProtectionGroup -Array $fa -HostGroupsToAdd "sdk-hostgroup" -Name "sdk-pgroup"
+New-PfaProtectionGroupSnapshot -Array $fa -Protectiongroupname "sdk-pgroup"
## Monitor Metrics
##################
Get-Command -Module PureStoragePowerShellSDK *Metric
-Get-PfaVolumeIOMetrics -Array $FlashArray -VolumeName ‘TEST-VOL1’ –TimeRange 1h | Format-Table –AutoSize
-Get-PfaVolumeIOMetrics -Array $FlashArray -VolumeName ‘TEST-VOL1’ –TimeRange 1h | Export-Csv -Path ‘C:\temp\test.csv’
+Get-PfaVolumeIOMetrics -Array $fa -VolumeName "sdk-vol1" -TimeRange 1h | Format-Table -AutoSize
+Get-PfaVolumeIOMetrics -Array $fa -VolumeName "sdk-vol1" -TimeRange 1h | Export-Csv -Path "C:\temp\test.csv"
## END QUICK START EXAMPLES
## Miscellaneous
################
-# Use an Invoke method to run a Purity CLI command
+## EXAMPLE
+# Run a Purity CLI command via SSH using a plaintext password converted to a SecureString
$CommandText = "purevol create --size 10G volume-name-1"
-New-PfaCLICommand -EndPoint $array -Username $ArrayUsername -Password $ArrayPassword -CommandText $CommandText
+$Username = "pureuser"
+$Password = "pureuser"
+$SecurePassword = ConvertTo-SecureString -String $Password -AsPlainText -Force
+New-PfaCliCommand -EndPoint 192.0.0.1 -UserName $Username -Password $SecurePassword -CommandText $CommandText
+## EXAMPLE
+# Alternative using Get-Credentials in-line
+$CommandText = "purepgroup snap --replicate-now sdk-pgroup"
+New-PfaCliCommand -EndPoint 192.0.0.1 -Credential (Get-Credential) -CommandText $CommandText
+
+## EXAMPLE
+# Create a PowerShell array of authenticated FlashArray objects and perform a command against all of the objects in series
+$fa @()
+$fa += New-PfaArray -EndPoint 192.0.0.1 -Credentials (Get-Credential) -IgnoreCertificateError
+$fa += New-PfaArray -EndPoint 192.0.0.2 -Credentials (Get-Credential) -IgnoreCertificateError
+$fa += New-PfaArray -EndPoint 192.0.0.3 -Credentials (Get-Credential) -IgnoreCertificateError
+$fa += New-PfaArray -EndPoint 192.0.0.4 -Credentials (Get-Credential) -IgnoreCertificateError
+Get-PfaVolumes -Array $fa
+
+## EXAMPLE
# Get volumes created within the last 30 days
$a = (Get-Date).AddDays(-30)
-Get-PfaVolumes -Array $Array | Where-Object { ($_.name -like 'Volume0*') -and ($_.created -ge $a) }
+Get-PfaVolumes -Array $Array | Where-Object { ($_.name -like "Volume0*") -and ($_.created -ge $a) }
-# Destroy (not eradicate) snapshots older than "x" Days
+## EXAMPLE
+# Destroy (not eradicate) snapshots older than "x" Days for all volumes
$targetDate = (Get-Date).AddDays(-1 * $Days)
-$snaps = Get-PfaVolumeSnapshot -Array $FlashArray -SnapshotName * | Where-Object source -EQ $Volume
+$snaps = Get-PfaVolumeSnapshot -Array $fa -SnapshotName * | Where-Object source -EQ $Volume
foreach ($snap in $snaps) {
$snapDate = Get-Date($snap.created)
if ($snapDate -lt $targetDate) {
- Remove-PfaVolumeOrSnapshot -Array $FlashArray -Name $snap.name
+ Remove-PfaVolumeOrSnapshot -Array $fa -Name $snap.name
}
}
-# The above code put into a Function with command line parameters
+## EXAMPLE
+# The previous example code put into a Function with command line parameters
Function Remove-SnapshotsByTime {
Param (
[Parameter(Mandatory = $true)][PSCredential]$Credential,
@@ -117,7 +138,7 @@ Param (
[Parameter(Mandatory = $true)][String]$Volume,
[Parameter(Mandatory = $true)][Int]$Days
)
- $fa = New-PfaArray -Credentials $Credential -Endpoint $Array -IgnoreCertificateError
+ $fa = New-PfaArray -Credentials $Credential -Endpoint 192.0.0.1 -IgnoreCertificateError
$targetDate = (Get-Date).AddDays(-1 * $Days)
$snaps = Get-PfaVolumeSnapshot -Array $fa -SnapshotName * | Where-Object source -EQ $Volume
foreach ($snap in $snaps) {
@@ -128,9 +149,10 @@ Param (
}
}
-# Alternative method for destroy (not eradicate) snapshots older than "x" days
-$fa = new-pfaarray -endpoint x.x.x.x -username pureuser -ignorecertificateerror
- $purevolume = "nameofvolume"
+## EXAMPLE
+# Alternative method for destroy (not eradicate) snapshots older than "x" days for volume "vol1"
+$fa = New-PfaArray -EndPoint 192.0.0.1 -Username pureuser -IgnoreCertificateError
+ $purevolume = "vol1"
# Set number of days from today to retain
$retention = (Get-Date).adddays(-10)
$ListAllSnap = Get-PfaVolumeSnapshots -VolumeName $purevolume -Array $fa
@@ -144,6 +166,7 @@ $fa = new-pfaarray -endpoint x.x.x.x -username pureuser -ignorecertificateerror
}
}
+## EXAMPLE
# Protection Group information
$allVols = Get-PfaVolumes -Array $fa
$volProtection = @()
@@ -158,25 +181,94 @@ $fa = new-pfaarray -endpoint x.x.x.x -username pureuser -ignorecertificateerror
}
return $volProtection
-# Retrieve Protection Group snapshot information
-$pgs = Get-Pfaprotectiongroups -array $fa | Select-Object name
+## EXAMPLE
+# Retrieve all Protection Group snapshot information
+$pgs = Get-PfaProtectionGroups -Array $fa | Select-Object name
foreach ($pg in $pgs) {
- Get-PfaProtectionGroupSnapshots -array $fa -Name $pg.name | Select-Object Name, created | Format-Table -AutoSize
+ Get-PfaProtectionGroupSnapshots -Array $fa -Name $pg.name | Select-Object Name, created | Format-Table -AutoSize
}
-# Configure syslog on multiple arrays
+## EXAMPLE
+# Invoke REST API command to retrieve volumes
+Invoke-PfaRestCommand -EndPoint 192.0.0.1 -Method GET -Command "https://pure01.example.com/api/1.19/volume"
+
+## EXAMPLE
+# Invoke REST API command create a volume 10G in size on Array $array
+$command = "volume/sdk-vol1"
+$body = ' { "size": "10G" } '
+Invoke-PfaRestCommand -Array $fa -Method POST -Command $command -Body $body
+
+## EXAMPLE
+# Delete the volume created in the previous example
+$command = "volume/sdk-vol1"
+Invoke-PfaRestCommand -Array $fa -Method DELETE -Command $command
+
+## EXAMPLE
+# Eradicate the volume from the previous example
+$command = "volume/sdk-vol1?eradicate=true"
+Invoke-PfaRestCommand -Array $fa -Method DELETE -Command $command
+
+## EXAMPLE
+# Configure syslog server on multiple arrays
$cred = Get-Credential
-$arrays = "x.x.x.x,x.x.x.x,x.x.x.x"
-$SysLogServer = "tcp://x.x.x.x:514"
+$arrays = "192.0.0.1,192.0.0.2,192.0.0.3"
+$SysLogServer = "tcp://192.0.0.100:514"
Foreach ($array in $arrays) {
$array = New-PfaArray -EndPoint $array -Credentials $cred -IgnoreCertificateError | Set-PfaSyslogServer -Array $array -SyslogServer $SyslogServer | Format-List
}
-
-# Create a array-to-array replication connection
-$sourceArray = New-PfaArray -EndPoint "x.x.x.x" -IgnoreCertificateError -Credentials (Get-Credential)
-$targetArray = New-PfaArray -EndPoint "x.x.x.x" -IgnoreCertificateError -Credentials (Get-Credential)
+## EXAMPLE
+# Create an array-to-array replication connection
+$sourceArray = New-PfaArray -EndPoint 192.0.0.1 -IgnoreCertificateError -Credentials (Get-Credential)
+$targetArray = New-PfaArray -EndPoint 192.0.0.2 -IgnoreCertificateError -Credentials (Get-Credential)
$connectionKey = Get-PfaConnectionKey -Array $targetArray
# -ManagementAddress is the Target Array IP, -ReplicationAddress is the Target Array Replbond or Replication IP
-New-PfaReplicationConnection -Array $sourceArray -ManagementAddress "x.x.x.x" -replicationAddress "x.x.x.x" -connectionKey $connectionKey.connection_key -Types "replication"
+New-PfaReplicationConnection -Array $sourceArray -ManagementAddress 192.0.0.1 -replicationAddress 192.0.0.2 -connectionKey $connectionKey.connection_key -Types "replication"
+
+## EXAMPLE
+# This is an example script to change a user password on a FlashArray
+ Add-Type @"
+ using System.Net;
+ using System.Security.Cryptography.X509Certificates;
+ public class TrustAllCertsPolicy : ICertificatePolicy {
+ public bool CheckValidationResult(
+ ServicePoint srvPoint, X509Certificate certificate,
+ WebRequest request, int certificateProblem) {
+ return true;
+ }
+ }
+"@
+ [System.Net.ServicePointManager]::CertificatePolicy = New-Object TrustAllCertsPolicy
+ <# The "$OldPassword" and "$Newpassword" strings should not be changed to a SecureString unless the logic for the Invoke-WebRequest is also altered. #>
+ function Update-UserFaPassword {
+ Param (
+ [Parameter(Mandatory = $true)][String]$User,
+ [Parameter(Mandatory = $true)][String]$OldPassword,
+ [Parameter(Mandatory = $true)][String]$NewPassword,
+ [Parameter(Mandatory = $True)][Object[]]$Array
+ )
+ <# This function expects a connection to have already been made to the target array using the Pure PowerShell SDK v1. That array object must be passed to this function, as we use that to obtain endpoint and API token information. The api version could be 1.19 if present on the array. #>
+ $baseURI = "https://" + $fa + "/api/1.17"
+ <# Establish Connection Using API Token from SDK1 Array Variable. #>
+ $connectURI = $baseURI + "/auth/session"
+ $connectBody = @{
+ api_token = $fa.ApiToken
+ }
+ $result = Invoke-WebRequest -Uri $connectURI -Method Post -Body $connectBody -SessionVariable pure -UseBasicParsing
+ <# Update Password #>
+ $adminURI = $baseURI + "/admin/" + $User
+ $body = @{
+ password = $NewPassword;
+ old_password = $OldPassword;
+ }
+ $body = $body | ConvertTo-Json
+ $result = Invoke-WebRequest -Uri $adminURI -WebSession $pure -Method Put -Body $body -ContentType "application/json" -UseBasicParsing
+ <# Get and Return Updated User #>
+ $user = Invoke-WebRequest -Uri $adminURI -Method Get -WebSession $pure -UseBasicParsing
+ return ConvertFrom-Json($user)
+ }
+ <# Example Usage of the Update-UserFaPassword Function #>
+ $fa = New-PfaArray -EndPoint 192.0.0.1 -Credentials (Get-Credential) -IgnoreCertificateError
+ Update-UserFaPassword -Array $fa -User "user1" -OldPassword "myoldpassword" -NewPassword "mynewpassword"
+
-### END
\ No newline at end of file
+### END EXAMPLES FILE
\ No newline at end of file
diff --git a/docs/1.19/PureStoragePowerShellSDK_786ba582-3ebf-4fed-a1cf-33e763291f9e_HelpInfo.xml b/docs/1.19/PureStoragePowerShellSDK_786ba582-3ebf-4fed-a1cf-33e763291f9e_HelpInfo.xml
deleted file mode 100644
index 6a9eee8..0000000
--- a/docs/1.19/PureStoragePowerShellSDK_786ba582-3ebf-4fed-a1cf-33e763291f9e_HelpInfo.xml
+++ /dev/null
@@ -1,10 +0,0 @@
-
-
- https://purestorage-connect.github.io/PowerShellSDK/docs/1.19
-
-
- en-US
- 1.19.24
-
-
-
diff --git a/docs/1.19/about_PureStoragePowerShellSDK.dll.Help.txt b/docs/1.19/about_PureStoragePowerShellSDK.dll.Help.txt
deleted file mode 100644
index 23850dd..0000000
--- a/docs/1.19/about_PureStoragePowerShellSDK.dll.Help.txt
+++ /dev/null
@@ -1,25 +0,0 @@
-TOPIC
- about_PureStoragePowerShellSDK-1.19.24
-
-SHORT DESCRIPTION
- The help file for the Pure Storage PowerShell SDK.
-
-LONG DESCRIPTION
- The help file for the Pure Storage PowerShell SDK.
-
-NOTE
- This is a note.
-
-TROUBLESHOOTING NOTE
-
-
-
-EXAMPLES
- Place examples here.
-
-KEYWORDS
-
-
-
-SEE ALSO
- Place related topics here.
\ No newline at end of file
diff --git a/release_notes.txt b/release_notes.txt
index 8adb391..a761552 100644
--- a/release_notes.txt
+++ b/release_notes.txt
@@ -1,376 +1,92 @@
-PURE STORAGE POWERSHELL SDK 1.17 RELEASE NOTES
-The Pure Storage PowerShell SDK provides integration with the Purity Operating Environment and FlashArray. It provides functionalities of Purity's REST API as PowerShell cmdlets.
-There are currently two releases of the SDK, version 1 for Purity REST API version 1.0 to 1.17, and version 2, for Purity REST API version 2.0 and later.
-
-// RELEASE COMPATIBILITY
-- This release requires PowerShell versions 3.0 to 5.1.
-- This release requires .NET Framework 4.5.
-- This release is compatible with FlashArrays that support Pure Storage REST API 1.0 to 1.17 inclusive. You can determine what API versions are supported on an array by using a web browser to go to this URL - https:///api/api_version.
-- This release requires a 64-bit Windows operating system that is compatible with the required PowerShell versions noted previously.
-
-// INSTALLATION AND UNINSTALLATION
-- Full installation instructions are available from this link - https://support.purestorage.com/Solutions/Microsoft_Platform_Guide/a_Windows_PowerShell/Pure_Storage_PowerShell_SDK
-- An Administrator privilege is required to install.
-- To install the PowerShell SDK, there are two options for the method of installation. The recommened method is to use the PowerShell Gallery by using the Install-Module cmdlet. You can also install via a Windows MSI installer, where you
-extract and run the PurePowerShellSDKInstaller.msi and follow the instructions.
-- To verify the installation, run "Get-Command -Module PureStoragePowerShellSDK" in a new PowerShell prompt and verify the release version.
-
-- If you used the PowerShell Gallery installation, you uninstall the SDK by using the Uninstall-Module cmdlet. For MSI installations, you can use the "Programs and Features" of the Control Panel.
-
-// KNOWN ISSUES
-- Get-PfaProtectionGroupVolumeSnapshots does not work if the array is connected using REST API 1.4.
-- The following Cmdlets remove the "-CaCertificate" parameter. See the new "New-PfaKMIP" cmdlet.
- Import-PfaNamedCertificate
- New-PfaNamedCertificate
-- Get-PfaNamedCertificate no longer accepts the -ExportCaCertificate parameter.
-
-// RESOURCES
-- Join the Pure Storage Code Slack Team and talk allthings APIs and SDKs by using this self-invitation link - https://codeinvite.purestorage.com
-- Our https://code.purestorage.com site links to all available API and SDK information on Github and Support.
-
-// RELEASE INFORMATION
-RELEASE 1.17.16.0
-Release 1.17.16.0 adds the following changes to Release 1.17.11.0
-- Fix for possible race condition when using specific cmdlets.
-
-RELEASE 1.17.11.0
-Release 1.17.11 adds the following changes to Release 1.17.0.0
-- Added DisableLoggingToArray to New-PfaArray and New-PfaCLICommand to disabled phone home logging to the array (and the associated thread) for this connection.
-- Fixed resource consumption issue in a New-PfaCLICommand connection that could cause the number of threads in a process to continually increase.
-
-RELEASE 1.17.0.0
-Release 1.17.0.0 adds the following changes to Release 1.16.0
-- Added support for the following features.
-- Added support for Maintenance Window.
- New-PfaMaintenanceWindow
- Get-PfaMaintenanceWindow
- Remove-PfaMaintenanceWindow
-- Added CaCertificate to New-PfaKMIP command-let.
-- Added support for Azure Offload.
- Connect-PfaOffloadAzureTarget
- Get-PfaOffloadAzureTarget
- Get-PfaAllOffloadAzureTarget
- Disconnect-PfaOffloadAzureTarget
-- Added support for EULA.
- Get-PfaArrayEula
- Set-PfaArrayEulaAccept
-- Added support for Network Interface metrics.
- Get-PfaNetworkInterfaceMetrics
- Get-PfaNetworkInterfaceMetricsError
- Get-PfaAllNetworkInterfaceMetrics
- Get-PfaAllNetworkInterfaceMetricsError
- Get-PfaAllNetworkInterfaceMetricsErrorTotal
- Get-PfaAllNetworkInterfaceMetricsTotal
-- Added support for POD metrics.
- Get-PfaAllPodSpaceMetricsTotal
-- Added support for Protection Group replication bandwidth
- Get-PfaAllProtectionGroupReplicationBandwidth
- Get-PfaAllProtectionGroupReplicationBandwidthByTimeRange
- Get-PfaProtectionGroupReplicationBandwidth
- Get-PfaProtectionGroupReplicationBandwidthByTimeRange
-- Added support for reading volume host encryption key status
- Get-PfaVolumeHostEncryptionKeyStatus
- Get-PfaAllVolumeHostEncryptionKeyStatus
-- Added support for reading volume space metrics.
- Get-PfaAllVolumeSpaceMetricsTotal
- Get-PfaAllVolumeTotal
-- Added support for reading volume group bandwidth
- Set-PfaVolumeGroupBandwidthLimit
-- Added support for volume and volume group IOPS limit
- Set-PfaVolumeGroupIOPSLimit
- Set-PfaVolumeIOPSLimit
-- Added support for VNC support for software app
- Disable-PfaSoftwareVNC
- Enable-PfaSoftwareVNC
-- Added support for reading the software app nodes.
- Get-PfaAllSoftwareNode
- Get-PfaSoftwareNode
-
-RELEASE 1.16.0
-Release 1.16.0 adds the following changes to Release 1.13.2
-- Added support for REST 1.14, 1.15 and 1.16. The following features are implemented.
-- Added support for NFS and S3 snapshot offload
- Connect-PfaOffloadNFSTarget
- Connect-PfaOffloadS3Target
- Disconnect-PfaOffloadNFSTarget
- Disconnect-PfaOffloadS3Target
- Get-PfaAllProtectionGroupOffloadSnapshot
- Get-PfaAllVolumeOffloadSnapshot
- Get-PfaOffloadNFSTarget
- Get-PfaOffloadS3Target
- Get-PfaOffloadSnapshot
- Get-PfaOffloadTarget
- Get-PfaProtectionGroupOffloadSnapshot
- Restore-PfaAllVolumeOffloadSnapshot
-
-- Added support for how directory service roles are modified
- Get-PfaDirectoryServiceRole
- New-PfaDirectoryServiceRole
-
-- Added support for maximum login attempts and user lockout
- Get-PfaAdminSetting
- Get-PfaAllLockedUser
- Get-PfaLockedUser
- Set-PfaAdminSetting
- Unlock-PfaUser
-- Added support for host NQN's
- Add-PfaHostNqn
- Remove-PfaHostNqn
- Set-PfaHostNqn
-- Added support for creating and deleting local user
- New-PfaLocalUser
- Remove-PfaLocalUser
-- Added support to view and manage software applications on Purity Array
- New-PfaSoftware
- Get-PfaSoftware
- Disable-PfaSoftware
- Enable-PfaSoftware
- Remove-PfaSoftware
- Get-PfaSoftwareAttribute
-- Added ability to view pods on remote array
- Get-PfaAllRemotePod
- Get-PfaRemotePod
-- Added the ability to list latency values when viewing performance data.
- Get-PfaAllHostGroupIOLatencyMetrics
- Get-PfaAllHostGroupIOLatencyMetricsMirrored
- Get-PfaAllHostGroupIOLatencyMetricsTotal
- Get-PfaAllHostIOLatencyMetrics
- Get-PfaAllHostIOLatencyMetricsMirrored
- Get-PfaAllHostIOLatencyMetricsTotal
- Get-PfaAllPodIOLatencyMetricsMirrored
- Get-PfaAllVolumeGroupIOLatencyMetrics
- Get-PfaAllVolumeGroupIOLatencyMetricsByTimeRange
- Get-PfaAllVolumeGroupsIOLatencyMetricsTotal
- Get-PfaAllVolumeIOLatencyMetrics
- Get-PfaAllVolumeIOLatencyMetricsByTimeRange
- Get-PfaAllVolumeIOLatencyMetricsTotal
- Get-PfaArrayIOLatencyMetrics
- Get-PfaHostGroupIOLatencyMetrics
- Get-PfaHostGroupIOLatencyMetricsMirrored
- Get-PfaHostIOLatencyMetrics
- Get-PfaHostIOLatencyMetricsMirrored
- Get-PfaNamedVolumeGroupsIOLatencyMetricsByTimeRange
- Get-PfaNamedVolumesIOLatencyMetricsByTimeRange
- Get-PfaPodIOLatencyMetricsMirrored
- Get-PfaVolumeGroupIOLatencyMetrics
- Get-PfaVolumeGroupIOLatencyMetricsByTimeRange
- Get-PfaVolumeIOLatencyMetrics
- Get-PfaVolumeIOLatencyMetricsByTimeRange
-- Added the following new cmdlets:
- Set-PfaHost
- Set-PfaPod
- Set-PfaVolumeBandwidthLimit
- Set-PfaSmtpManagerAttribute
- Get-PfaSmtpManagerAttribute
-- Updated the following cmdlets:
- Get-PfaHost
- Get-PfaHosts
- Get-PfaPod
- Get-PfaPods
- Get-PfaVolume
- Get-PfaVolumes
- New-PfaHost
- New-PfaPod
- New-PfaVolume
- Remove-PfaProtectionGroupOrSnapshot
- Restore-PfaDestroyedProtectionGroup
-- The following cmdlets starting REST 1.16 do not return "san_usec_per_read_op", "san_usec_per_write_op". These values are part of new cmdlet mentioned above *IOLatency*.
- Get-PfaAllHostIOMetrics
- Get-PfaHostIOMetricsAverage
- Get-PfaAllHostIOMetricsTotal
- Get-PfaArrayIOMetrics
- Get-PfaArrayIOMetricsAverage
- Get-PfaAllVolumeIOMetricsByTimeRange
- Get-PfaNamedVolumesIOMetricsByTimeRange
- Get-PfaVolumeIOMetrics
- Get-PfaVolumeIOMetricsByTimeRange
- Get-PfaAllVolumeIOMetric
-
-RELEASE 1.13.2
-Release 1.13.2 adds the following changes to Release 1.13.1
-- Added New-PfaNamedCertificateSigningRequest that applies to REST 1.12 onwards.
-- Increased default http timeout from 5 seconds to 30 seconds.
-- Fixed bug with New-PfaCLICommand where it was not honoring TimeOutInMilliSeconds parameter
-- Ensured that certificate related cmdlets (eg Import-PfaCertificate) that don't work with REST 1.12+ return a helpful "Not Supported in REST API x" error.
-
-RELEASE 1.13.1
-Release 1.13.1 adds the following changes to Release 1.13.0
-- Fixed bug where Get-PfaArrayAttributes was interpreting Purity version string as a date
-
-RELEASE 1.13.0
-Release 1.13.0 adds the following changes to Release 1.7
-Support for REST 1.12 and REST 1.13, bug fixes.
-- Added notification property to SNMPManager object. New cmdlet:
- Set-PfaSnmpManagerNotification
-- Added -Filter parameter to cmdlets that return multiple objects to enable server side filtering. See new help topic about_Purity_Filtering.
-- Added the following new cmdlets related to Pod and sync-rep management
- Add-PfaArrayToPod
- Copy-PfaPod
- Get-PfaAllPodFootprint
- Get-PfaAllPodMediator
- Get-PfaAllPodSpaceHistory
- Get-PfaAllPodSpaces
- Get-PfaNamedPodFootprint
- Get-PfaNamedPodMediator
- Get-PfaNamedPodSpace
- Get-PfaNamedPodSpaceHistory
- Get-PfaNamedPods
- Get-PfaPendingDeletePods
- Get-PfaPendingPodFootprint
- Get-PfaPendingPodMediator
- Get-PfaPendingPodSpace
- Get-PfaPod
- Get-PfaPods
- New-PfaPod
- Remove-PfaArrayFromPod
- Remove-PfaPod
- Rename-PfaPod
- Restore-PfaPod
-- Added the following cmdlets to support named certificate management.
- Get-PfaNamedCertificate
- Get-PfaNamedCertificateAttribute
- Get-PfaNamedCertificateAttributes
- Import-PfaNamedCertificate
- Remove-PfaNamedCertificate
- New-PfaNamedCertificateImport
- New-PfaNamedSelfSignedCertificate
-- Added the following cmdlets to support reading mirrored IO statistics.
- Get-PfaAllHostGroupIOMetricsMirrored
- Get-PfaAllHostIOMetricsMirrored
- Get-PfaAllPodIOMetricsMirrored
- Get-PfaAllVolumeIOMetricsMirrored
- Get-PfaArrayIOMetricsMirrored
- Get-PfaHostGroupIOMetricsMirrored
- Get-PfaHostIOMetricsMirrored
- Get-PfaPodIOMetricsMirrored
- Get-PfaVolumeIOMetricsMirrored
-- Added the following cmdlets to support KMIP.
- Get-PfaKmip
- Get-PfaKmips
- New-PfaKmip
- Remove-PfaKmip
- Test-PfaKmip
- Update-PfaKmip
- - Added the following cmdlets to support Purity //Run apps
- Get-PfaPureAppAttributes
- Get-PfaPureAppsAttributes
-- Added the following cmdlets to support volume groups and vvols.
- Get-PfaAllVolumeGroupIOMetrics
- Get-PfaAllVolumeGroupIOMetricsByTimeRange
- Get-PfaAllVolumeGroupsIOMetricsAverage
- Get-PfaAllVolumeGroupsIOMetricsTotal
- Get-PfaVolumeGroupIOMetrics
- Get-PfaVolumeGroupIOMetricsAverage
- Get-PfaVolumeGroupIOMetricsByTimeRange
- Get-PfaVolumeGroupSpaceMetrics
- Get-PfaVolumeGroupSpaceMetrics
- Get-PfaNamedVolumeGroupsIOMetricsByTimeRange
- Get-PfaNamedVolumeGroups
- Get-PfaPendingDeleteVolumeGroups
- Get-PfaProtocolEndpointVolumes
- Get-PfaProtocolEndpointVolume
- Get-PfaVolumeGroups
- Get-PfaVolumeGroup
- New-PfaHostGroupProtocolEndpointVolumeConnection
- New-PfaHostProtocolEndpointVolumeConnection
- New-PfaProtocolEndpointVolume
- New-PfaVolumeGroup
- Remove-PfaVolumeGroup
- Restore-PfaVolumeGroup
-- Added the following cmdlets to support remote host/hostgroup/volume operations
- Get-PfaRemoteHost
- Get-PfaRemoteHostGroup
- Get-PfaRemoteHostGroupVolumeConnections
- Get-PfaRemoteHostGroups
- Get-PfaRemoteHosts
- Get-PfaRemoteVolumeHostConnections
- Get-PfaRemoteVolumeHostGroupConnections
- Get-PfaVolumeConnection
-Added the following cmdlets:
- Get-PfaArrayTCPConnection
-Bug fixes and cmdlets to support REST 1.7
-- Fixed Get-PfaProtectiongGroupVolumeSnapshot to work with REST 1.2 - REST 1.7. It still doesn't work with REST 1.4 (see KNOWN ISSUES above.)
-- Fixed bug where cmdlets were ignoring -ErrorAction.
-- Added mode (primary/secondary) property on the controller object returned by Get-PfaControllers.
-- Added cmdlets Get-PfaAllVolumeIOMetricsByTimeRange (Lists historical IO metrics for all volumes for a specified range) and Get-PfaNamedVolumesIOMetricsByTimeRange (Lists historical IO metrics for specified volumes for a specified range.)
-- Add Get-PfaProtectionGroupRetentions (retrieve snapshot replication retention policy for all protection groups.)
-- Add Get-PfaVolumeSnapshot (retrieve a particular snapshot by name.)
-- Set-PfaProtectionGroupRetention should have optional params, so that the user can change one property at a time and doesn't have to specify all properties.
-- Added Get cmdlets that support filtering by names. The names parameter accepts a single name or a comma-separated list for multiple values. The names parameter also accepts an asterisk ( * ) as a wildcard character.
- Get-PfaNamedVolumes
- Get-PfaNamedProtectionGroups
- Get-PfaNamedHosts
- Get-PfaNamedHostGroups
-
-RELEASE 1.7
-- Added support for Pure Storage arrays with IPv6 addresses
-
-RELEASE 1.6
-The following cmdlets have been added since the last release to support REST 1.5
-- Added Update-PfaArrayConnectionsThrottlingInformation.
-- Added Get-PfaArrayConnectionsThrottlingInformation.
-- Added Get-PfaAllHostIOMetrics.
-- Added Get-PfaHostIOMetrics.
-- Added Get-PfaAllHostGroupIOMetrics.
-- Added Get-PfaHostGroupIOMetrics.
-The following cmdlets have been added since the last release to support REST 1.6
-- Added Get-PfaArraySpaceMetricsByTimeRange.
-- Added Get-PfaAllVolumeSpaceMetricsByTimeRange.
-- Added Get-PfaVolumeSpaceMetricsByTimeRange.
-The following cmdlets have been added since the last release to support REST 1.7
-- Added Get-PfaArrayIOMetricsAverage.
-- Added Get-PfaAllHostIOMetricsTotal.
-- Added Get-PfaAllHostIOMetricsAverage.
-- Added Get-PfaHostIOMetricsAverage.
-- Added Get-PfaAllHostGroupIOMetricsTotal.
-- Added Get-PfaAllHostGroupIOMetricsAverage.
-- Added Get-PfaHostGroupIOMetricsAverage.
-- Added Get-PfaAllVolumeIOMetricsAverage.
-- Added Get-PfaAllVolumeIOMetricsTotal.
-- Added Get-PfaVolumeIOMetricsAverage.
-Other additions:
-- Added New-PfaCLICommand to be able to run any CLI command on the FlashArray
-- Added Get-PfaVolumeIOMetricsByTimeRange (old name was Get-PfaVolumeIOMetrics - see section CHANGES)
-- Added Get-PfaProtectionGroupSchedules.
-- Added Get-PfaSourceProtectionGroupSchedules.
-The following cmdlets related to Purity's integration with Active Directory to provide authentication.
-- Added Set-PfaDirectoryServiceStatus to enable/disable Active Directory integration.
-- Added Set-PfaDirectoryServiceAuthenticationStatus to enable/disable server authenticity enforcement using configured CA certificate.
-- Added Set-PfaDirectoryServiceGroupBase to set base OU for ArrayAdmin/StorageAdmin/Readonly security groups.
-CHANGES
-1) Removed CheckPeer and Enabled switch parameters from Set-PfaDirectoryServiceConfiguration - the functionality is provided by new cmdlets Set-PfaDirectoryServviceAuthenticationStatus and Set-PfaDirectoryServiceStatus.
-2) In 1.5 version of the SDK, Get-PfaVolumeIOMetrics would get historical performance data for the specified volume. This has been renamed to Get-PfaVolumeIOMetricsByTimeRange.
- A new cmdlet with the same name (Get-PfaVolumeIOMetrics) is added to list IO metrics attributes for the specified volume.
-3) In 1.5 version of the SDK, Get-PfaAllVolumeIOMetrics would get IO metrics for a specific volume - this has been renamed to Get-PfaVolumeIOmetrics (see change#2 above)
-4) Fixed bug with Get-PfaInitiatorPorts where it was only returning array ports.
-5) Added the ability to connect to an array using API token (see help for New-PfaArray)
+// PURE STORAGE FLASHARRAY POWERSHELL SDK 1.19.31 RELEASE NOTES
+The Pure Storage PowerShell SDK provides integration with the Purity Operating Environment and FlashArray. It provides functionalities of Purity's REST API as PowerShell cmdlets.
+There are currently two releases of the SDK:
+ - version 1 for Purity REST API versions 1.7 to 1.19
+ - version 2 for Purity REST API version 2.0 and later.
+
+// NOTICE: This SDK version 1.19.31 will be the last major version release for FlashArray API versions 1.19 and lower. The PowerShell SDK v2 should be used moving forward for API parity with FlashArray REST API 2.0 and later.
-// PERFORMANCE TESTING
-No performance testing was done for this release.
+// RELEASE COMPATIBILITY.
-// OPEN SOURCE LICENSES
-Json.NET:
-The MIT License (MIT)
-Copyright (c) 2007 James Newton-King
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+- This release requires PowerShell versions 3.0 to 5.x. This SDK is not compatible with PowerShell Core or later (version 6.0+).
+- This release requires .NET Framework 4.5.
+- This release is compatible with FlashArrays that support Pure Storage REST API 1.7 to 1.19 inclusive. You can determine what API versions are supported on an array by using a web browser to go to this URL on the array - https:///api/api_version.
+- This release requires a 64-bit Windows operating system that is compatible with the required PowerShell versions noted previously.
+- This release requires a Windows operating system that supports TLS versions 1.1 or later.
+
+// INSTALLATION AND REMOVAL.
+
+ - Full installation instructions are available from this link - https://support.purestorage.com/Solutions/Microsoft_Platform_Guide/a_Windows_PowerShell/Pure_Storage_PowerShell_SDK
+ - An Administrator privilege is required to install.
+- INSTALL.
+ - To install the PowerShell SDK, there are two options for the method of installation. The recommened method is to use the PowerShell Gallery by using the Install-Module cmdlet.
+ - You can also install via a Windows MSI installer, where you extract and run the PurePowerShellSDKInstaller.msi file, and follow the instructions.
+- INSTALL PATH.
+ - If the module is installed using the MSI installer, by default, the module will be installed to the \Program Files\Pure Storage\PowerShell\Modules folder. This path is configurable during the installation.
+ - When the module is installed using the PowerShell Gallery with the Install-Module cmdlet, the module is installed in the default scope $PSModulePath.
+- VERIFY INSTALL.
+ - To verify the installation, run "Get-Command -Module PureStoragePowerShellSDK" in a new PowerShell session and verify the release version.
+- REMOVAL.
+ - If you used the PowerShell Gallery installation method, you uninstall the SDK by using the Uninstall-Module cmdlet. Example: Uninstall-Module -Name PureStoragePowerShellSDK
+ - For MSI installations, you can use the "Programs and Features" of the Control Panel.
+
+
+// WHAT'S NEW.
+
+ 1. New Cmdlets added in this release. Total cmdlets available is 466.
+ - Add-PfaPodReplicaLink
+ - Add-PfaVolumesTag
+ - Get-PfaAllPodIOLatencyReplicationMetricsMirrored
+ - Get-PfaAllPodIOReplicationMetricsMirrored
+ - Get-PfaAllVolumeOffloadSnapshotRestoreStatus
+ - Get-PfaOffloadSnapshotRestoreStatus
+ - Get-PfaOffloadTargetWithSpace
+ - Get-PfaPendingDeleteSnapshotsTags
+ - Get-PfaPendingDeleteVolumesTags
+ - Get-PfaPodIOLatencyReplicationMetricsMirrored
+ - Get-PfaPodIOReplicationMetricsMirrored
+ - Get-PfaPodReplicaLink
+ - Get-PfaPodReplicaLinkHistory
+ - Get-PfaSnapshotTag
+ - Get-PfaSnapshotsTag
+ - Get-PfaVolumeIOLatencyMetricsMirroredByTimeRange
+ - Get-PfaVolumeIOMetricsMirroredByTimeRange
+ - Get-PfaVolumeTags
+ - Get-PfaVolumesTags
+ - Invoke-PfaRestCommand
+ - New-PfaRestApiToken
+ - Remove-PfaReplicaLink
+ - Remove-PfaVolumeTag
+ - Set-PfaPodDemote
+ - Set-PfaPodPromote
+
+ 2. Raised the required minimum FlashArray Purity API version to 1.7.
+ 3. Added PowerShell version check to New-PfaArray cmdlet. This was done to inform the user that the SDK v1 can not be executed in a PowerShell version 6 (.net Core) or later session as it is not compatible with those versions. Optimally, this warning should be presented at the time of the module load, but that is not possible within the PowerShell framework.
+ 4. Added support for persistent array connections. Once an array connection is made using the New-PfaArray cmdlet, a new global variable is created called $PURE_AUTH_1_X. All commands executed after will use that variable and that array connection. This removes the requirement of having to specify the -Array parameter for each cmdlet. When the cmdlet Disconnect-PfaArray is executed, the $PURE_AUTH_1_X variable is removed. This change coincides with the same functionality of the SDK version 2.
+
+// FIXES.
+
+ 1. Enhanced cmdlet help and online dynamic help.
+ 2. Due to changes in the REST API, not all cmdlets support the Filtering parameters that include -Filter, -Sort, -Offset, -Limit, and -TotalItemCountVariable, even though they allowed them when executed. This has been resolved whereas only the cmdlets that support Filtering will allow the parameters. Please see about_Purity_Filtering help for more information on filtering with examples.
+
+// DEPRECATED CMDLETS.
+
+ None
+
+
+// KNOWN ISSUES.
+
+ 1. When using the Get-PfaAllNetworkInterfaceMetricsErrorTotal cmdlet with API versions 1.17 to 1.19:
+ - The "Total" result is only returned for Purity versions 5.3.0, 5.3.2, and 6.0.0. "Total" is not returned on 6.1.6 or 6.2.0. This is due to a limitation in the Purity REST API.
+ 2. When using the Get-PfaAllDriveAttributes cmdlet with API version 1.0 to 1.19:
+ - "last_evac_completed" and "last_failure" results are only available with Purity versions 5.2.7, 5.3.0, and 5.3.2. This is due to a limitation in the Purity REST API.
+ 3. The cmdlet Get-PfaBlockDifferences contains a parameter called -VolumeName. This parameter name is incorrect in that the cmdlet only works with snapshots, not volumes. This parameter has an alternative alias of -SnapshotName that can be used. Since this is an alias of the -VolumeName parameter, scripts that use that parameter will continue to execute without error.
+ 4. After the final release code was finalized, it was discovered that the cmdlet Remove-PfaReplicaLink should have been named Remove-PfaPodReplicaLink. This may be corrected in a minor release.
+ 5. Any previous known issues in the 1.17.16 release that have not been listed as corrected in the "Fixes" section above.
+
+// RESOURCES.
+
+ - Join the Pure Storage Code Slack Team and talk all things APIs and SDKs by using this self-invitation link - https://codeinvite.purestorage.com
+ - Our https://code.purestorage.com site links to all available API and SDK information on Github and Support.
-SSH.NET:
-The MIT License (MIT)
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+## Pure Storage FlashArray PowerShell SDK version 1