en-US/PureStoragePowerShellSDK.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems xmlns="http://msh" schema="maml"> <!--Edited with: SAPIEN PowerShell HelpWriter 2015 v1.0.10--> <!--Generated by: SAPIEN PowerShell HelpWriter 2015 v1.0.10--> <!--All Commands--> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Add-PfaHostGroupsToProtectionGroup</command:name> <maml:description> <maml:para>(REST API 1.2+) Adds a list of host groups to the existing list.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>PfaHostGroupsToProtectionGroup</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Add-PfaHostGroupsToProtectionGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>HostGroupsToAdd</maml:name> <maml:description> <maml:para>List of host groups to be added to the existing list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target protection group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>HostGroupsToAdd</maml:name> <maml:description> <maml:para>List of host groups to be added to the existing list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target protection group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Add-PfaHostGroupsToProtectionGroup -Array $Array -HostGroupsToAdd hostgroup1,hostgroup2,hostgroup3 -Name protectionGroup1</dev:code> <dev:remarks> <maml:para>Adds the specified host groups ("hostgroup1", "hostgroup2, and "hostgroup3") to the existing list of host groups in the protection group "protectionGroup1".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Add-PfaHostIqns</command:name> <maml:description> <maml:para>Adds IQNs for the specified host.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>PfaHostIqns</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Add-PfaHostIqns</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target host name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>AddIqnList</maml:name> <maml:description> <maml:para>Adds the list of iSCSI qualified names (IQNs) to the specified host.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target host name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>AddIqnList</maml:name> <maml:description> <maml:para>Adds the list of iSCSI qualified names (IQNs) to the specified host.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Add-PfaHostIqns -Array $Array -Name host1 -AddIqnList iqn.2015-06.com.example:str1,iqn.2015-06.com.example:str2,iqn.2015-06.com.example:str3</dev:code> <dev:remarks> <maml:para>Adds the three IQNs ("iqn.2015-06.com.example:str1", "iqn.2015-06.com.example:str2", "iqn.2015-06.com.example:str3") to host "host1".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Add-PfaHosts</command:name> <maml:description> <maml:para>Adds host members of the specified host group.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>PfaHosts</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Add-PfaHosts</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target host group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>HostsToAdd</maml:name> <maml:description> <maml:para>Adds a list of hosts to the existing list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target host group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>HostsToAdd</maml:name> <maml:description> <maml:para>Adds a list of hosts to the existing list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Add-PfaHosts -Array $Array -Name hostGroup1 -HostsToAdd host1,host2</dev:code> <dev:remarks> <maml:para>Adds hosts "host1" and "host2" as members to the host group "hostGroup1".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Add-PfaHostsToProtectionGroup</command:name> <maml:description> <maml:para>(REST API 1.2+) Adds a list of hosts to the existing list.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>PfaHostsToProtectionGroup</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Add-PfaHostsToProtectionGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target protection group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>HostsToAdd</maml:name> <maml:description> <maml:para>List of hosts to be added to the existing list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target protection group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>HostsToAdd</maml:name> <maml:description> <maml:para>List of hosts to be added to the existing list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Add-PfaHostsToProtectionGroup -Array $Array -Name protectionGroup1 -HostsToAdd host1,host2</dev:code> <dev:remarks> <maml:para>Adds hosts "host1" and "host2" as members to the protection group "protectionGroup1".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Add-PfaHostWwns</command:name> <maml:description> <maml:para>Adds WWNs for the specified host.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>PfaHostWwns</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Add-PfaHostWwns</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>AddWwnList</maml:name> <maml:description> <maml:para>Adds the list of Fibre Channel worldwide names (WWNs) to the specified host.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target host name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>AddWwnList</maml:name> <maml:description> <maml:para>Adds the list of Fibre Channel worldwide names (WWNs) to the specified host.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target host name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Add-PfaHostWwns -Array $Array -Name host1 -AddWwnList 0123456789abcde1,01:23:45:67:89:ab:cd:e2</dev:code> <dev:remarks> <maml:para>Adds two WWNs ("0123456789abcde1","01:23:45:67:89:ab:cd:e2") for the host "host1".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Add-PfaSlaveInterfaces</command:name> <maml:description> <maml:para>Adds slaves to the existing list. May only be used on network bond interfaces.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>PfaSlaveInterfaces</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>NO EXAMPLE YET</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Add-PfaSlaveInterfaces</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target network component.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>AddSlaveList</maml:name> <maml:description> <maml:para>List of slaves to be added to the existing list. May only be used on network bond interfaces.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target network component.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>AddSlaveList</maml:name> <maml:description> <maml:para>List of slaves to be added to the existing list. May only be used on network bond interfaces.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Add-PfaSlaveInterfaces -Array $Array -Name bond009 -AddSlaveList eth2,eth3</dev:code> <dev:remarks> <maml:para>Adds the Ethernet interfaces "eth2" and "eth3" as slaves to the bond interface "bond009".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Add-PfaTargetArrays</command:name> <maml:description> <maml:para>(REST API 1.2+) Adds a list of target arrays to the existing list.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>PfaTargetArrays</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Add-PfaTargetArrays</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target protection group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>TargetsToAdd</maml:name> <maml:description> <maml:para>List of target arrays to be added to the existing list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target protection group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>TargetsToAdd</maml:name> <maml:description> <maml:para>List of target arrays to be added to the existing list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Add-PfaTargetArrays -Array $Array -Name protectionGroup1 -TargetsToAdd array2,array3</dev:code> <dev:remarks> <maml:para>Adds arrays "array2" and "array3" as members to the protection group "protectionGroup1".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Add-PfaVolumesToProtectionGroup</command:name> <maml:description> <maml:para>(REST API 1.2+) Adds a list of volumes to the existing list.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>PfaVolumesToProtectionGroup</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Add-PfaVolumesToProtectionGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>VolumesToAdd</maml:name> <maml:description> <maml:para>List of volumes to be added to the existing list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target protection group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>VolumesToAdd</maml:name> <maml:description> <maml:para>List of volumes to be added to the existing list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target protection group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Add-PfaVolumesToProtectionGroup -Array $Array -Name protectionGroup1 -VolumesToAdd vol1,vol2,vol3</dev:code> <dev:remarks> <maml:para>Adds three volumes ("vol1","vol2","vol3") as members to the protection group "protectionGroup1".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Clear-PfaItemFlag</command:name> <maml:description> <maml:para>Unflags an audit, alert, or user session message.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Clear</command:verb> <command:noun>PfaItemFlag</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Clear-PfaItemFlag</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Id</maml:name> <maml:description> <maml:para>Target message ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Id</maml:name> <maml:description> <maml:para>Target message ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Clear-PfaItemFlag -Array $Array -Id 36171</dev:code> <dev:remarks> <maml:para>Unflags the message with Id 36171.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Disable-PfaAlert</command:name> <maml:description> <maml:para>Disables the transmission of alert messages to the specified email address.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Disable</command:verb> <command:noun>PfaAlert</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Disable-PfaAlert</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Email address specified for this action.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Email address specified for this action.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Disable-PfaAlert -Array $Array -Name admin@example.com</dev:code> <dev:remarks> <maml:para>Disables the transmission of alert messages to the email address "admin@example.com".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Disable-PfaIdLight</command:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Disable</command:verb> <command:noun>PfaIdLight</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Disable-PfaIdLight</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the hardware component</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the hardware component</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Disable-PfaIdLight -Array $Array -Name SH0.BAY3</dev:code> <dev:remarks> <maml:para>Turns off the chassis identification light for bay 3 in storage shelf 0.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Disable-PfaNetworkInterface</command:name> <maml:description> <maml:para>Disables communication between the specified Ethernet interface and the administrative network. Do not disable the interface through which the administrative session is being conducted.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Disable</command:verb> <command:noun>PfaNetworkInterface</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Disable-PfaNetworkInterface</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target network component.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target network component.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Disable-PfaNetworkInterface -Array $Array -Name CT0-ETH1</dev:code> <dev:remarks> <maml:para>Disables communication between the CT0-ETH1 controller and the administrative network.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Disable-PfaReplicationSchedule</command:name> <maml:description> <maml:para>(REST API 1.2+) Disables replication for the specified protection group.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Disable</command:verb> <command:noun>PfaReplicationSchedule</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Disable-PfaReplicationSchedule</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target protection group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target protection group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Disable-PfaReplicationSchedule -Array $Array -Name protectionGroup1</dev:code> <dev:remarks> <maml:para>Disables replication for the protection group "protectionGroup1".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Disable-PfaSnapshotSchedule</command:name> <maml:description> <maml:para>(REST API 1.2+) Disables the protection group snapshot schedule.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Disable</command:verb> <command:noun>PfaSnapshotSchedule</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Disable-PfaSnapshotSchedule</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target protection group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target protection group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Disable-PfaSnapshotSchedule -Array $Array -Name protectionGroup1</dev:code> <dev:remarks> <maml:para>Disables the protection group snapshot schedule for the protection group "protectionGroup1".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Disconnect-PfaArray</command:name> <maml:description> <maml:para>Terminates the user session on the array (logs out).</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Disconnect</command:verb> <command:noun>PfaArray</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Disconnect-PfaArray</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Disconnect-PfaArray -Array $Array</dev:code> <dev:remarks> <maml:para>Terminates the user session on array $Array (logs out).</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Enable-PfaAlert</command:name> <maml:description> <maml:para>Enables the transmission of alert messages to the specified email address.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Enable</command:verb> <command:noun>PfaAlert</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Enable-PfaAlert</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Email address specified for this action.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Email address specified for this action.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Enable-PfaAlert -Array $Array -Name admin@example.com</dev:code> <dev:remarks> <maml:para>Enables the transmission of alert messages to the email address "admin@example.com".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Enable-PfaIdLight</command:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Enable</command:verb> <command:noun>PfaIdLight</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Enable-PfaIdLight</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the hardware component</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the hardware component</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Enable-PfaIdLight -Array $Array -Name SH0.BAY3</dev:code> <dev:remarks> <maml:para>Turns on the chassis identification light for bay 3 in storage shelf 0.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Enable-PfaNetworkInterface</command:name> <maml:description> <maml:para>Enables communication between the specified Ethernet interface and the administrative network.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Enable</command:verb> <command:noun>PfaNetworkInterface</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Enable-PfaNetworkInterface</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target network component.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target network component.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Enable-PfaNetworkInterface -Array $Array -Name CT0-ETH1</dev:code> <dev:remarks> <maml:para>Enables communication between CT0-ETH1 and the administrative network.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Enable-PfaReplicationSchedule</command:name> <maml:description> <maml:para>(REST API 1.2+) Enables replication schedule for the specified protection group.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Enable</command:verb> <command:noun>PfaReplicationSchedule</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Enable-PfaReplicationSchedule</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target protection group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target protection group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Enable-PfaReplicationSchedule -Array $Array -Name protectionGroup1</dev:code> <dev:remarks> <maml:para>Enable the protection group snapshot schedule for the protection group "protectionGroup1" on array $Array.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Enable-PfaSnapshotSchedule</command:name> <maml:description> <maml:para>(REST API 1.2+) Enables the protection group snapshot schedule.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Enable</command:verb> <command:noun>PfaSnapshotSchedule</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Enable-PfaSnapshotSchedule</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target protection group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target protection group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Enable-PfaSnapshotSchedule -Array $Array -Name protectionGroup1</dev:code> <dev:remarks> <maml:para>Enables the protection group snapshot schedule for the protection group "protectionGroup1".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaAlert</command:name> <maml:description> <maml:para>Lists information about the specified email recipient.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaAlert</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaAlert</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Email address specified for this action.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Email address specified for this action.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaAlert -Array $Array -Name admin@example.com</dev:code> <dev:remarks> <maml:para>Lists information about the specified email recipient "admin@example.com".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaAlerts</command:name> <maml:description> <maml:para>Lists email recipients that are designated to receive Purity alert messages.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaAlerts</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaAlerts</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaAlerts -Array $Array</dev:code> <dev:remarks> <maml:para>Lists email recipients that are designated to receive Purity alert messages for the specified array.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaAllApiTokens</command:name> <maml:description> <maml:para>Lists API token information for all users.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaAllApiTokens</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaAllApiTokens</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaAllApiTokens -Array $Array</dev:code> <dev:remarks> <maml:para>Lists API token information for all users on the specified array.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaAllDriveAttributes</command:name> <maml:description> <maml:para>Lists flash modules and NVRAM modules, as well as their attributes.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaAllDriveAttributes</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaAllDriveAttributes</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaAllDriveAttributes -Array $Array</dev:code> <dev:remarks> <maml:para>Lists flash modules and NVRAM modules, including their attributes, for the specifed array.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaAllHardwareAttributes</command:name> <maml:description> <maml:para>Lists array hardware component information.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaAllHardwareAttributes</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaAllHardwareAttributes</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaAllHardwareAttributes -Array $Array</dev:code> <dev:remarks> <maml:para>Lists information about hardware components on the specifed array.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaAllHostGroupIOMetrics</command:name> <maml:description> <maml:para>(REST API 1.5+) Lists IO metrics attributes for all host groups</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaAllHostGroupIOMetrics</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaAllHostGroupIOMetrics</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaAllHostGroupIOMetricsAverage</command:name> <maml:description> <maml:para>(REST API 1.7+) Lists IO metrics attributes for all host groups and also lists average IO sizes</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaAllHostGroupIOMetricsAverage</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaAllHostGroupIOMetricsAverage</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaAllHostGroupIOMetricsTotal</command:name> <maml:description> <maml:para>(REST API 1.7+) Lists IO metrics attributes for all host groups and also return aggregate totals</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaAllHostGroupIOMetricsTotal</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaAllHostGroupIOMetricsTotal</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaAllHostGroupSpaceMetrics</command:name> <maml:description> <maml:para>Lists size and space consumption information for each volume associated with all host groups.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaAllHostGroupSpaceMetrics</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaAllHostGroupSpaceMetrics</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaAllHostGroupSpaceMetrics -Array $Array</dev:code> <dev:remarks> <maml:para>Lists size and space consumption information for each volume associated with all host groups on the specified array.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaAllHostIOMetrics</command:name> <maml:description> <maml:para>(REST API 1.5+) Lists IO metrics attributes for all hosts.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaAllHostIOMetrics</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaAllHostIOMetrics</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaAllHostIOMetricsAverage</command:name> <maml:description> <maml:para>(REST API 1.7+) Lists IO metrics attributes for all hosts and also lists the average IO size.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaAllHostIOMetricsAverage</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaAllHostIOMetricsAverage</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaAllHostIOMetricsTotal</command:name> <maml:description> <maml:para>(REST API 1.7+) Lists IO metrics attributes for all hosts and and also return aggregate totals</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaAllHostIOMetricsTotal</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaAllHostIOMetricsTotal</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaAllHostSpaceMetrics</command:name> <maml:description> <maml:para>Lists information about provisioned (virtual) size and physical storage consumption for each volume connected to all hosts on the array.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaAllHostSpaceMetrics</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaAllHostSpaceMetrics</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaAllHostSpaceMetrics -Array $Array</dev:code> <dev:remarks> <maml:para>Lists information about provisioned size and physical storage consumption for each volume connected to any host on the specified array.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaAllProtectedHostGroups</command:name> <maml:description> <maml:para>Returns all hostgroups that are members of a protection group.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaAllProtectedHostGroups</command:noun> <dev:version /> </command:details> <maml:description> <maml:para> </maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaAllProtectedHostGroups</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaAllProtectedHosts</command:name> <maml:description> <maml:para>Returns all hosts that are members of a protection group.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaAllProtectedHosts</command:noun> <dev:version /> </command:details> <maml:description> <maml:para> </maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaAllProtectedHosts</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaAllProtectedVolumes</command:name> <maml:description> <maml:para>Returns all volumes that are members of a protection group.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaAllProtectedVolumes</command:noun> <dev:version /> </command:details> <maml:description> <maml:para> </maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaAllProtectedVolumes</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaAllPublicKeys</command:name> <maml:description> <maml:para>Lists public key information for all users.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaAllPublicKeys</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaAllPublicKeys</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaAllPublicKeys -Array $Array</dev:code> <dev:remarks> <maml:para>Lists public key information for all users on the specified array.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaAllSnapshotSpaceMetrics</command:name> <maml:description> <maml:para>Lists size and space consumption attributes for each volume's snapshots.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaAllSnapshotSpaceMetrics</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaAllSnapshotSpaceMetrics</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaAllSnapshotSpaceMetrics -Array $Array</dev:code> <dev:remarks> <maml:para>Lists size and space consumption attributes for each volume's snapshots on the specified array.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaAllVolumeIOMetrics</command:name> <maml:description> <maml:para>Lists real-time performance data at a specified resolution for all volumes.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaAllVolumeIOMetrics</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaAllVolumeIOMetrics</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaAllVolumeIOMetrics -Array $Array</dev:code> <dev:remarks> <maml:para>List real-time performance data for all volumes on the array.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaAllVolumeIOMetricsAverage</command:name> <maml:description> <maml:para>(REST API 1.7+) Lists IO metrics attributes for all volumes and also display average IO sizes</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaAllVolumeIOMetricsAverage</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaAllVolumeIOMetricsAverage</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaAllVolumeIOMetricsTotal</command:name> <maml:description> <maml:para>(REST API 1.7+) Lists IO metrics attributes for all volumes and also return aggregate totals</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaAllVolumeIOMetricsTotal</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaAllVolumeIOMetricsTotal</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaAllVolumeSnapshots</command:name> <maml:description> <maml:para>Lists snapshots and their attributes.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaAllVolumeSnapshots</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaAllVolumeSnapshots</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>IncludePendingDeletes</maml:name> <maml:description> <maml:para>Includes (true) destroyed volumes that are in the eradication pending state.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>IncludePendingDeletes</maml:name> <maml:description> <maml:para>Includes (true) destroyed volumes that are in the eradication pending state.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaAllVolumeSnapshots -Array $Array</dev:code> <dev:remarks> <maml:para>Lists snapshots, with their attributes, on the specified array.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaAllVolumeSpaceMetrics</command:name> <maml:description> <maml:para>Lists size and space consumption attributes for each volume</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaAllVolumeSpaceMetrics</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaAllVolumeSpaceMetrics</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaAllVolumeSpaceMetrics -Array $Array</dev:code> <dev:remarks> <maml:para>Lists size and space attributes for all volumes on the array.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaAllVolumeSpaceMetricsByTimeRange</command:name> <maml:description> <maml:para>(REST API 1.6+) Lists historical data size and space consumption attributes for each volume</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaAllVolumeSpaceMetricsByTimeRange</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaAllVolumeSpaceMetricsByTimeRange</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>TimeRange</maml:name> <maml:description> <maml:para>Time range for historical data with units. Valid historical values are: 1h, 3h, 24h, 7d, 30d, 90d, 1y.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>TimeRange</maml:name> <maml:description> <maml:para>Time range for historical data with units. Valid historical values are: 1h, 3h, 24h, 7d, 30d, 90d, 1y.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaApiToken</command:name> <maml:description> <maml:para>Lists the API token of the specified user.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaApiToken</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaApiToken</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>User</maml:name> <maml:description> <maml:para>The user whose API token is to be displayed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>User</maml:name> <maml:description> <maml:para>The user whose API token is to be displayed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaApiToken -Array $Array -User pureuser</dev:code> <dev:remarks> <maml:para>Lists the API token of the user "pureuser".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaArrayAttributes</command:name> <maml:description> <maml:para>Lists the attributes for the array, including the array name, Purity version and Purity revision number.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaArrayAttributes</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaArrayAttributes</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaArrayAttributes -Array $Array</dev:code> <dev:remarks> <maml:para>Lists the attributes for the specified array, including the array name, Purity version and Purity revision number.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaArrayConnections</command:name> <maml:description> <maml:para>(REST API 1.2+) Lists connected arrays.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaArrayConnections</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaArrayConnections</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaArrayConnections -Array $Array</dev:code> <dev:remarks> <maml:para>Lists arrays that are connected to the specified array.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaArrayConnectionsThrottlingInformation</command:name> <maml:description> <maml:para>(REST API 1.5+) Lists connected arrays throttling information.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaArrayConnectionsThrottlingInformation</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaArrayConnectionsThrottlingInformation</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaArrayId</command:name> <maml:description> <maml:para>Deprecated. Use Get-PfaArrayAttributes instead.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaArrayId</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaArrayId</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaArrayIOMetrics</command:name> <maml:description> <maml:para>Lists historical performance data for the array.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaArrayIOMetrics</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaArrayIOMetrics</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PfaArrayIOMetrics</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>TimeRange</maml:name> <maml:description> <maml:para>Time range for historical data with units. Valid historical values are: 1h, 3h, 24h, 7d, 30d, 90d, 1y.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>TimeRange</maml:name> <maml:description> <maml:para>Time range for historical data with units. Valid historical values are: 1h, 3h, 24h, 7d, 30d, 90d, 1y.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaArrayIOMetrics -Array $Array -TimeRange 7d</dev:code> <dev:remarks> <maml:para>Lists historical performance data over the past 7 days for the specified array.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaArrayIOMetrics -Array $Array</dev:code> <dev:remarks> <maml:para>Lists all available historical performance data (up to one year) for the specified array.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaArrayIOMetricsAverage</command:name> <maml:description> <maml:para>(REST API 1.7+) Lists average IO size data for the array.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaArrayIOMetricsAverage</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaArrayIOMetricsAverage</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaArrayPorts</command:name> <maml:description> <maml:para>Lists array ports and the worldwide names assigned to each port.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaArrayPorts</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaArrayPorts</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaArrayPorts -Array $Array</dev:code> <dev:remarks> <maml:para>For array $Array, lists array ports and the worldwide names assigned to each port.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaArraySpaceMetrics</command:name> <maml:description> <maml:para>Lists the amount of usable physical storage on the array and the amount of storage occupied by data and metadata.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaArraySpaceMetrics</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaArraySpaceMetrics</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaArraySpaceMetrics -Array $Array</dev:code> <dev:remarks> <maml:para>Lists the amount of usable physical storage on array $Array, with the amount of storage occupied by data and metadata.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaArraySpaceMetricsByTimeRange</command:name> <maml:description> <maml:para>(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.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaArraySpaceMetricsByTimeRange</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaArraySpaceMetricsByTimeRange</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>TimeRange</maml:name> <maml:description> <maml:para>Time range for historical data with units. Example: '1h'</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>TimeRange</maml:name> <maml:description> <maml:para>Time range for historical data with units. Example: '1h'</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaAuditRecords</command:name> <maml:description> <maml:para>Lists audit records.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaAuditRecords</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaAuditRecords</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>User</maml:name> <maml:description> <maml:para>Name of target user.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>User</maml:name> <maml:description> <maml:para>Name of target user.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaAuditRecords -Array $Array -User admin@example.com</dev:code> <dev:remarks> <maml:para>Lists audit records for the user "admin@example.com".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaAuditRecords -Array $Array -User pureuser</dev:code> <dev:remarks> <maml:para>Lists audit records for the administrator "pureuser".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaBanner</command:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaBanner</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaBanner</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaBanner -Array $Array</dev:code> <dev:remarks> <maml:para>Displays the "message of the day" (MOTD) text for the specified array.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaBlockDifferences</command:name> <maml:description> <maml:para>(REST API 1.3+) Lists block differences for the specified volume.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaBlockDifferences</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaBlockDifferences</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>VolumeName</maml:name> <maml:description> <maml:para>Target volume name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Length</maml:name> <maml:description> <maml:para>Length of the region, in bytes, to compare. (Commas are not supported.)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3"> <maml:name>Granularity</maml:name> <maml:description> <maml:para>Granularity, in bytes, at which to compare.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Offset</maml:name> <maml:description> <maml:para>Absolute offset, in bytes, of the region to compare. Must be a multiple of block_size.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>BaseName</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>VolumeName</maml:name> <maml:description> <maml:para>Target volume name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Length</maml:name> <maml:description> <maml:para>Length of the region, in bytes, to compare. (Commas are not supported.)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Offset</maml:name> <maml:description> <maml:para>Absolute offset, in bytes, of the region to compare. Must be a multiple of block_size.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1</command:parameterValue> <dev:type> <maml:name>Nullable`1</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>BaseName</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3"> <maml:name>Granularity</maml:name> <maml:description> <maml:para>Granularity, in bytes, at which to compare.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Nullable`1[[System.Int64, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaBlockDifferences -Array $Array -VolumeName vol1 -Length 1073741824 -Granularity 512</dev:code> <dev:remarks> <maml:para>Lists block differences for the first 1 gigabyte (1,073,741,824 bytes) of volume "vol1", using a block size of 512 bytes.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaBlockDifferences -Array $Array -VolumeName vol1 -Length 1073741824 -Offset 5120000 -Granularity 512</dev:code> <dev:remarks> <maml:para>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.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaBlockDifferences -Array $Array -VolumeName vol1 -Length 2Gb -BaseName vol1.snap -Granularity 512</dev:code> <dev:remarks> <maml:para>Lists block differences for 2 gigabytes in the volume "vol1", using snapshot "vol1.snap" as the base for the diff and using a block size of 512 bytes.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaCertificate</command:name> <maml:description> <maml:para>(REST API 1.3+) Lists the current SSL certificate. Optionally exports either the current certificate or intermediate certificate.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaCertificate</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaCertificate</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ExportCurrent</maml:name> <maml:description> <maml:para>Exports the current certificate.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ExportCurrentIntermediate</maml:name> <maml:description> <maml:para>Exports the current intermediate certificate. Do not specify both -ExportCurrent and -ExportCurrentIntermediate parameters together.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ExportCurrent</maml:name> <maml:description> <maml:para>Exports the current certificate.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ExportCurrentIntermediate</maml:name> <maml:description> <maml:para>Exports the current intermediate certificate. Do not specify both -ExportCurrent and -ExportCurrentIntermediate parameters together.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$Cert1 = Get-PfaCertificate -Array $Array -ExportCurrent -ExportCurrentIntermediate $Cert1.certificate $Cert1.intermediate_certificate</dev:code> <dev:remarks> <maml:para>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.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaChapStatus</command:name> <maml:description> <maml:para>Lists the CHAP status for the specified host.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaChapStatus</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaChapStatus</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target host name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target host name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaChapStatus -Array $Array -Name host1</dev:code> <dev:remarks> <maml:para>Lists CHAP status for the host "host1".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaChapStatuses</command:name> <maml:description> <maml:para>Lists CHAP status of all hosts on the array.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaChapStatuses</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaChapStatuses</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaChapStatuses -Array $Array</dev:code> <dev:remarks> <maml:para>Lists CHAP status of all hosts on the specified array.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaConnectionKey</command:name> <maml:description> <maml:para>Displays a connection key that can be used to connect to this array.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaConnectionKey</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaConnectionKey</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaConnectionKey -Array $Array</dev:code> <dev:remarks> <maml:para>Displays a connection key that can be used to connect to the specified array.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaConsoleLock</command:name> <maml:description> <maml:para>Displays the status (enabled or disabled) of the console lock.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaConsoleLock</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaConsoleLock</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaConsoleLock -Array $Array</dev:code> <dev:remarks> <maml:para>Displays the status of the console lock for the specified array.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaControllers</command:name> <maml:description> <maml:para>Lists information about the array controllers.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaControllers</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaControllers</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaControllers -Array $Array</dev:code> <dev:remarks> <maml:para>Lists information about the array controllers for the array $Array.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaCurrentCertificate</command:name> <maml:description> <maml:para>(REST API 1.3+) Exports the current SSL certificate.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaCurrentCertificate</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaCurrentCertificate</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaCurrentCertificate -Array $Array</dev:code> <dev:remarks> <maml:para>Exports the current SSL certificate for the specified array.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$Cert = Get-PfaCurrentCertificate -Array $Array</dev:code> <dev:remarks> <maml:para>Exports the current SSL certificate for the specified array, saving it into $Cert.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaCurrentCertificateAttributes</command:name> <maml:description> <maml:para>(REST API 1.3+) Lists current certificate attributes</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaCurrentCertificateAttributes</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaCurrentCertificateAttributes</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaCurrentCertificateAttributes -Array $Array</dev:code> <dev:remarks> <maml:para>Lists attributes for the current SSL certificate used by the specified array.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaCurrentIntermediateCertificate</command:name> <maml:description> <maml:para>(REST API 1.3+) Exports the current intermediate certificate</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaCurrentIntermediateCertificate</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaCurrentIntermediateCertificate</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$Cert = Get-PfaCurrentIntermediateCertificate -Array $Array</dev:code> <dev:remarks> <maml:para>Exports the current intermediate SSL certificate in use on the specified array, saving it into $Cert.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaDirectoryServiceCACertificate</command:name> <maml:description> <maml:para>Gets the currently configured CA certificate for the directory service used with the specified array.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaDirectoryServiceCACertificate</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaDirectoryServiceCACertificate</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$CACert = Get-PfaDirectoryServiceCACertificate -Array $Array</dev:code> <dev:remarks> <maml:para>Exports the currently configured CA certificate for the specified array, saving it into $CACert.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaDirectoryServiceConfiguration</command:name> <maml:description> <maml:para>Lists current base configuration information for the directory service used with the specified array.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaDirectoryServiceConfiguration</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaDirectoryServiceConfiguration</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaDirectoryServiceConfiguration -Array $Array</dev:code> <dev:remarks> <maml:para>Lists current base configuration information for the directory service in use with the specified array.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaDirectoryServiceGroups</command:name> <maml:description> <maml:para>Lists information about the group configuration in the directory service used with the specified array.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaDirectoryServiceGroups</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaDirectoryServiceGroups</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaDirectoryServiceGroups -Array $Array</dev:code> <dev:remarks> <maml:para>Lists information about the directory service group configuration for the specified array.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaDnsAttributes</command:name> <maml:description> <maml:para>Lists DNS attributes for the array administrative network.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaDnsAttributes</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaDnsAttributes</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaDnsAttributes -Array $Array</dev:code> <dev:remarks> <maml:para>Lists DNS attributes for the administrative network on the specified array.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaDriveAttributes</command:name> <maml:description> <maml:para>Lists the attributes for the specified flash module or NVRAM module.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaDriveAttributes</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaDriveAttributes</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the specified flash module or NVRAM module.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the specified flash module or NVRAM module.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaDriveAttributes -Array $Array -Name SH0.BAY0</dev:code> <dev:remarks> <maml:para>Lists the attributes for the flash module in bay 0 in storage shelf 0.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaDriveAttributes -Array $Array -Name CH0.NVB1</dev:code> <dev:remarks> <maml:para>Lists the attributes for the NVRAM bay 1 (FlashArray//m only).</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaEngineId</command:name> <maml:description> <maml:para>Displays the SNMP v3 engine ID generated by Purity for the specified array (SNMP v3 only).</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaEngineId</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaEngineId</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaEngineId -Array $Array</dev:code> <dev:remarks> <maml:para>Displays the SNMP v3 engine ID generated by Purity for the array $Array.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaFlaggedAuditRecords</command:name> <maml:description> <maml:para>Lists audit records. Limited to flagged messages.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaFlaggedAuditRecords</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaFlaggedAuditRecords</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>User</maml:name> <maml:description> <maml:para>Name of target user.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>User</maml:name> <maml:description> <maml:para>Name of target user.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaFlaggedAuditRecords -Array $Array</dev:code> <dev:remarks> <maml:para>Lists all flagged audit records for the specified array.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaFlaggedAuditRecords -Array $Array -User admin@example.com</dev:code> <dev:remarks> <maml:para>Lists flagged audit records associated with the specified user ("admin@eample.com") on the specified array.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaFlaggedAuditRecords -Array $Array -User pureuser</dev:code> <dev:remarks> <maml:para>Lists flagged audit records associated with the specified user ("pureuser") on the specified array.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaFlaggedMessages</command:name> <maml:description> <maml:para>Lists alert events. Limited to flagged messages.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaFlaggedMessages</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaFlaggedMessages</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaFlaggedMessages -Array $Array</dev:code> <dev:remarks> <maml:para>Lists flagged alert events for the specified array.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaHardwareAttributes</command:name> <maml:description> <maml:para>Lists the attributes for the specified hardware component.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaHardwareAttributes</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaHardwareAttributes</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the hardware component</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the hardware component</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaHardwareAttributes -Array $Array -Name SH0.FAN1</dev:code> <dev:remarks> <maml:para>Lists the attributes for the fan 1 on storage shelf 0 on the specified array.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaHost</command:name> <maml:description> <maml:para>Lists the attributes for the specified host.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaHost</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaHost</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target host name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target host name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaHost -Array $Array -Name host1</dev:code> <dev:remarks> <maml:para>Lists the attributes for the host named "host1".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaHostGroup</command:name> <maml:description> <maml:para>Lists details of a single host group, including its host members.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaHostGroup</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaHostGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target host group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target host group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaHostGroup -Array $Array -Name hostGroup1</dev:code> <dev:remarks> <maml:para>For array $Array, lists the hosts in the host group "hostGroup1".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaHostGroupIOMetrics</command:name> <maml:description> <maml:para>(REST API 1.5+) Lists IO metrics attributes for the specified host group.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaHostGroupIOMetrics</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaHostGroupIOMetrics</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>HostGroupName</maml:name> <maml:description> <maml:para>Target host group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>HostGroupName</maml:name> <maml:description> <maml:para>Target host group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaHostGroupIOMetricsAverage</command:name> <maml:description> <maml:para>(REST API 1.7+) Lists IO metrics attributes for the specified host group and also lists the average IO sizes.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaHostGroupIOMetricsAverage</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaHostGroupIOMetricsAverage</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>HostGroupName</maml:name> <maml:description> <maml:para>Target host group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>HostGroupName</maml:name> <maml:description> <maml:para>Target host group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaHostGroupProtectionGroups</command:name> <maml:description> <maml:para>Returns all protection groups that contain a host group as a member.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaHostGroupProtectionGroups</command:noun> <dev:version /> </command:details> <maml:description> <maml:para> </maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaHostGroupProtectionGroups</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>HostGroupName</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>HostGroupName</maml:name> <maml:description> <maml:para>Target HostGroup name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaHostGroups</command:name> <maml:description> <maml:para>Lists all host groups on an array.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaHostGroups</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaHostGroups</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaHostGroups -Array $Array</dev:code> <dev:remarks> <maml:para>For array $Array, lists all host groups and their member hosts.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaHostGroupSpaceMetrics</command:name> <maml:description> <maml:para>Lists size and space consumption information for each volume associated with a single host group.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaHostGroupSpaceMetrics</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaHostGroupSpaceMetrics</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target host group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target host group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaHostGroupSpaceMetrics -Array $Array -Name hostGroup1</dev:code> <dev:remarks> <maml:para>Lists the size and space consumption information for each volume associated with the specified host group ("hostGroup1").</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaHostGroupVolumeConnections</command:name> <maml:description> <maml:para>Lists volumes associated with the specified host groups and the LUNs used to address those volumes.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaHostGroupVolumeConnections</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaHostGroupVolumeConnections</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>HostGroupName</maml:name> <maml:description> <maml:para>Target host group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>HostGroupName</maml:name> <maml:description> <maml:para>Target host group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaHostGroupVolumeConnections -Array $Array -HostGroupName hostGroup1</dev:code> <dev:remarks> <maml:para>For the specified array, lists volumes associated with the host group "hostGroup1" and the LUNs used to address them.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaHostIOMetrics</command:name> <maml:description> <maml:para>(REST API 1.5+) Lists IO metrics attributes for the specified host.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaHostIOMetrics</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaHostIOMetrics</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>HostName</maml:name> <maml:description> <maml:para>Target host name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>HostName</maml:name> <maml:description> <maml:para>Target host name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaHostIOMetricsAverage</command:name> <maml:description> <maml:para>(REST API 1.7+) Lists IO metrics attributes for the specified host and also lists the average IO sizes.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaHostIOMetricsAverage</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaHostIOMetricsAverage</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>HostName</maml:name> <maml:description> <maml:para>Target host name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>HostName</maml:name> <maml:description> <maml:para>Target host name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaHostPrivateVolumeConnections</command:name> <maml:description> <maml:para>Lists volumes associated with the specified host and the LUNs used to address them. Limited to private connections.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaHostPrivateVolumeConnections</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaHostPrivateVolumeConnections</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target host name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target host name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaHostPrivateVolumeConnections -Array $Array -Name host1</dev:code> <dev:remarks> <maml:para>Lists volumes associated with the specified host ("host1") and the LUNs used to address those volumes. Lists only private connections.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaHostProtectionGroups</command:name> <maml:description> <maml:para>Returns all protection groups that contain a host as a member.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaHostProtectionGroups</command:noun> <dev:version /> </command:details> <maml:description> <maml:para> </maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaHostProtectionGroups</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>HostName</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>HostName</maml:name> <maml:description> <maml:para>Target host name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaHosts</command:name> <maml:description> <maml:para>Lists all hosts on the array.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaHosts</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaHosts</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaHosts -Array $Array</dev:code> <dev:remarks> <maml:para>Lists all hosts on the specified array.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaHostSharedVolumeConnections</command:name> <maml:description> <maml:para>Lists volumes associated with the specified host and the LUNs used to address them. Limited to shared connections.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaHostSharedVolumeConnections</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaHostSharedVolumeConnections</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target host name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target host name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaHostSharedVolumeConnections -Array $Array -Name host1</dev:code> <dev:remarks> <maml:para>Lists volumes associated with the host "host1" and the LUNs used to address those volumes. Lists only shared connections.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaHostSpaceMetrics</command:name> <maml:description> <maml:para>Lists information about provisioned (virtual) size and physical storage consumption for each volume connected to the specified host.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaHostSpaceMetrics</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaHostSpaceMetrics</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target host name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target host name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaHostSpaceMetrics -Array $Array -Name host1</dev:code> <dev:remarks> <maml:para>Lists size and physical storage consumption for each volume connected to the host named "host1".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaHostVolumeConnections</command:name> <maml:description> <maml:para>Lists volumes associated with the specified host and the LUNs used to address them.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaHostVolumeConnections</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaHostVolumeConnections</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target host name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target host name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaHostVolumeConnections -Array $Array -Name host1</dev:code> <dev:remarks> <maml:para>Lists volumes associated with the host named "host1", with the LUNs used to address the volumes.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaIdleTimeout</command:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaIdleTimeout</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaIdleTimeout</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaIdleTimeout -Array $Array</dev:code> <dev:remarks> <maml:para>Displays the idle time limit, in minutes, for the specified array.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaInitiatorPorts</command:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaInitiatorPorts</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaInitiatorPorts</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaInitiatorPorts -Array $Array</dev:code> <dev:remarks> <maml:para>For array $Array, lists host worldwide names and the array ports (targets) on which they are eligible to communicate.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaMessages</command:name> <maml:description> <maml:para>Lists alert events.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaMessages</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaMessages</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaMessages -Array $Array</dev:code> <dev:remarks> <maml:para>Lists alert events on the specified array.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaNetworkInterface</command:name> <maml:description> <maml:para>Lists the attributes for the specified network component.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaNetworkInterface</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaNetworkInterface</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target network component.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target network component.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaNetworkInterface -Array $Array -Name CT0.ETH1</dev:code> <dev:remarks> <maml:para>Lists the attributes for network component CT0.ETH1 (Ethernet port ETH1 on controller CT0).</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaNetworkInterfaces</command:name> <maml:description> <maml:para>Lists array administrative network interfaces and their statuses (enabled or disabled) and attributes.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaNetworkInterfaces</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaNetworkInterfaces</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaNetworkInterfaces -Array $Array</dev:code> <dev:remarks> <maml:para>Lists array administrative network interfaces, with the status (enabled or disabled) and attributes of each.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaNtpServers</command:name> <maml:description> <maml:para>Displays the hostnames or IP addresses of the NTP servers currently being used by the array to maintain reference time.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaNtpServers</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaNtpServers</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaNtpServers -Array $Array</dev:code> <dev:remarks> <maml:para>Displays the hostnames or IP addresses of the NTP servers used to maintain reference time on the specified array.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaOpenMessages</command:name> <maml:description> <maml:para>Lists alert events. Limited to open messages.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaOpenMessages</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaOpenMessages</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaOpenMessages -Array $Array</dev:code> <dev:remarks> <maml:para>Lists the open alert messages on the specified array.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaPendingDeleteProtectionGroups</command:name> <maml:description> <maml:para>(REST API 1.2+) Lists protection groups and their attributes. Limited to destroyed groups pending eradication.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaPendingDeleteProtectionGroups</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaPendingDeleteProtectionGroups</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaPendingDeleteProtectionGroups -Array $Array</dev:code> <dev:remarks> <maml:para>Lists only those protection groups that are pending eradication on the specified array.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaPendingDeleteVolumes</command:name> <maml:description> <maml:para>(REST API 1.2+) Lists volumes and their attributes. Limited to destroyed volumes pending eradication.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaPendingDeleteVolumes</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaPendingDeleteVolumes</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaPendingDeleteVolumes -Array $Array</dev:code> <dev:remarks> <maml:para>List only those volumes that are pending eradication on the specified array.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaPendingDeleteVolumeSnapshots</command:name> <maml:description> <maml:para>Lists volume snapshots and their attributes. Limited to destroyed volume snapshots pending eradication.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaPendingDeleteVolumeSnapshots</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaPendingDeleteVolumeSnapshots</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaPendingDeleteVolumeSnapshots -Array $Array</dev:code> <dev:remarks> <maml:para>List only those volume snapshots that are pending eradication on the specified array.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaPersonalities</command:name> <maml:description> <maml:para>Lists personality setting associated with all hosts on the array.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaPersonalities</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaPersonalities</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaPersonalities -Array $Array</dev:code> <dev:remarks> <maml:para>Lists the personality settings associated with all hosts on the specified array.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaPersonality</command:name> <maml:description> <maml:para>Lists the personality setting for the specified host.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaPersonality</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaPersonality</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target host name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target host name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaPersonalities -Array $Array -Name host1</dev:code> <dev:remarks> <maml:para>Lists the personality setting associated with the host "host1" on the specified array.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaPhoneHomeActionStatus</command:name> <maml:description> <maml:para>Lists information about the status of the transmission logs for the phonehome facility.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaPhoneHomeActionStatus</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaPhoneHomeActionStatus</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaPhoneHomeActionStatus -Array $Array</dev:code> <dev:remarks> <maml:para>Displays information about status of Purity phonehome transmission logs for the specified array.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaPhoneHomeStatus</command:name> <maml:description> <maml:para>Displays the current state (enabled or disabled) of the Purity phonehome automatic hourly log transmission facility.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaPhoneHomeStatus</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaPhoneHomeStatus</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaPhoneHomeStatus -Array $Array</dev:code> <dev:remarks> <maml:para>Displays the current state (enabled or disabled) of the Purity phonehome automatic hourly log transmission facility for the specified array.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaProtectionGroup</command:name> <maml:description> <maml:para>(REST API 1.2+) Lists the attributes for the specified protection group.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaProtectionGroup</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaProtectionGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target protection group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target protection group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaProtectionGroup -Array $Array -Name protectionGroup1</dev:code> <dev:remarks> <maml:para>Lists the attributes for the protection group "protectionGroup1".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaProtectionGroupRetention</command:name> <maml:description> <maml:para>(REST API 1.2+) Lists a protection group's source/target retention policy.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaProtectionGroupRetention</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaProtectionGroupRetention</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>ProtectionGroupName</maml:name> <maml:description> <maml:para>Target protection group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>ProtectionGroupName</maml:name> <maml:description> <maml:para>Target protection group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaProtectionGroupRetention -Array $Array -protectionGroupName protectionGroup1</dev:code> <dev:remarks> <maml:para>Lists the source/target retention policy for the protection group "protectionGroup1".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaProtectionGroups</command:name> <maml:description> <maml:para>(REST API 1.2+) Lists protection groups and their attributes.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaProtectionGroups</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaProtectionGroups</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>IncludePending</maml:name> <maml:description> <maml:para>Include protection groups that have been destroyed and are pending eradication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>IncludePending</maml:name> <maml:description> <maml:para>Include protection groups that have been destroyed and are pending eradication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaProtectionGroups -Array $Array</dev:code> <dev:remarks> <maml:para>Lists all protection groups and their attributes for the specified array. Does not include destroyed protection groups.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaProtectionGroups -Array $Array -IncludePending</dev:code> <dev:remarks> <maml:para>Lists all protection groups and their attributes for the specified array, including protection groups that have been destroyed and are pending eradication.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaProtectionGroupSchedule</command:name> <maml:description> <maml:para>(REST API 1.2+) Lists the snapshot/replication schedule for the specified protection group.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaProtectionGroupSchedule</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaProtectionGroupSchedule</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>ProtectionGroupName</maml:name> <maml:description> <maml:para>Target protection group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>ProtectionGroupName</maml:name> <maml:description> <maml:para>Target protection group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaProtectionGroupSchedule -Array $Array -protectionGroupName protectionGroup1</dev:code> <dev:remarks> <maml:para>Lists the snapshot and retention schedules for the protection group "protectionGroup1".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaProtectionGroupSchedules</command:name> <maml:description> <maml:para>(REST API 1.2+) Get the snapshot/replication schedule list.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaProtectionGroupSchedules</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaProtectionGroupSchedules</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaProtectionGroupSnapshotReplicationStatus</command:name> <maml:description> <maml:para>(REST API 1.2+) Lists the replication status of a specified protection group snapshot.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaProtectionGroupSnapshotReplicationStatus</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaProtectionGroupSnapshotReplicationStatus</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target protection group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target protection group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaProtectionGroupSnapshotReplicationStatus -Array $Array -Name protectionGroup1</dev:code> <dev:remarks> <maml:para>Lists the replication status of the protection group snapshot for protection group "protectionGroup1".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaProtectionGroupSnapshots</command:name> <maml:description> <maml:para>(REST API 1.2+) Lists the snapshots for the specified protection group snapshot.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaProtectionGroupSnapshots</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaProtectionGroupSnapshots</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target protection group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target protection group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaProtectionGroupSnapshots -Array $Array -Name protectionGroup1</dev:code> <dev:remarks> <maml:para>Lists the snapshots for protection group "protectionGroup1".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaProtectionGroupSnapshotSpaceMetrics</command:name> <maml:description> <maml:para>(REST API 1.2+) Lists the space consumption for all snapshots in the specified protection group.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaProtectionGroupSnapshotSpaceMetrics</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaProtectionGroupSnapshotSpaceMetrics</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target protection group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target protection group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaProtectionGroupSnapshotSpaceMetrics -Array $Array -Name protectionGroup1</dev:code> <dev:remarks> <maml:para>Lists the space consumption for all snapshots taken as part of the protection group "protectionGroup1" snapshot.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaProtectionGroupVolumeSnapshots</command:name> <maml:description> <maml:para>(REST API 1.2+) Lists the attributes for a specified protection group snapshot.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaProtectionGroupVolumeSnapshots</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaProtectionGroupVolumeSnapshots</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target protection group snapshot name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target protection group snapshot name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaProtectionGroupVolumeSnapshots -Array $Array -Name protectionGroupSnapshot1</dev:code> <dev:remarks> <maml:para>Lists the attributes for the protection group snapshot "protectionGroupSnapshot1".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaProtectionGroupVolumeSpaceMetrics</command:name> <maml:description> <maml:para>(REST API 1.2+) Gets size and space consumption information items listed below for each volume associated with each specified protection group.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaProtectionGroupVolumeSpaceMetrics</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaProtectionGroupVolumeSpaceMetrics</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target protection group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target protection group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaProtectionGroupVolumeSpaceMetrics -Array $Array -Name protectionGroup1</dev:code> <dev:remarks> <maml:para>Lists the space consumption for each volume member in protection group "protectionGroup1".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaProxy</command:name> <maml:description> <maml:para>Displays the proxy host for the phonehome facility when HTTPS is the phonehome protocol (the phonehome facility itself determines which protocol to use).</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaProxy</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaProxy</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaProxy -Array $Array</dev:code> <dev:remarks> <maml:para>Displays the phonehome proxy host for the specified array.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaPublicKey</command:name> <maml:description> <maml:para>Gets public key information for the specified user.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaPublicKey</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaPublicKey</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>User</maml:name> <maml:description> <maml:para>The user whose public key is requested.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>User</maml:name> <maml:description> <maml:para>The user whose public key is requested.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaPublicKey -Array $Array -User admin@example.com</dev:code> <dev:remarks> <maml:para>Lists public key information for the user "admin@example.com" on the specified array.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaRecentAuditRecords</command:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaRecentAuditRecords</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaRecentAuditRecords</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>User</maml:name> <maml:description> <maml:para>Name of target user.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>User</maml:name> <maml:description> <maml:para>Name of target user.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaRecentAuditRecords -Array $Array</dev:code> <dev:remarks> <maml:para>Lists recent audit records for all users on the specified array.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaRecentAuditRecords -Array $Array -User admin@example.com</dev:code> <dev:remarks> <maml:para>Lists recent audit records for the user "admin@example.com" on the specified array.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaRecentMessages</command:name> <maml:description> <maml:para>Lists recent alerts, audit records, and user session logs.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaRecentMessages</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaRecentMessages</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaRecentMessages -Array $Array</dev:code> <dev:remarks> <maml:para>Lists recent alerts, audit records, and user session logs for the specified array.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaRecentUserSessionRecords</command:name> <maml:description> <maml:para>(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.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaRecentUserSessionRecords</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaRecentUserSessionRecords</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>User</maml:name> <maml:description> <maml:para>Name of target user.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>User</maml:name> <maml:description> <maml:para>Name of target user.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaRecentUserSessionRecords -Array $Array</dev:code> <dev:remarks> <maml:para>Lists recent user session messages for all users on the specified array.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaRecentUserSessionRecords -Array $Array -User admin@example.com</dev:code> <dev:remarks> <maml:para>Lists recent user session messages for user "admin@example.com" on the specified array.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaRelayHost</command:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaRelayHost</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaRelayHost</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaRelayHost -Array $Array</dev:code> <dev:remarks> <maml:para>Displays the hostname or IP address of the electronic mail relay server used to forward email alerts generated by the specified array.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaRemoteAssistSession</command:name> <maml:description> <maml:para>Lists information about the status (enabled or disabled) of a remote assist session.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaRemoteAssistSession</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaRemoteAssistSession</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaRemoteAssistSession -Array $Array</dev:code> <dev:remarks> <maml:para>Lists the status (enabled or disabled) of the remote assist session on the specified array.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaScsiTimeout</command:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaScsiTimeout</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaScsiTimeout</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaScsiTimeout -Array $Array</dev:code> <dev:remarks> <maml:para>Displays the iSCSI timeout (in seconds) for the specified array.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaSenderDomain</command:name> <maml:description> <maml:para>Displays the domain name from which Purity sends email alert messages.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaSenderDomain</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaSenderDomain</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaSenderDomain -Array $Array</dev:code> <dev:remarks> <maml:para>Displays the domain name from which Purity sends email alert messages for the specified array.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaSnapshotSpaceMetrics</command:name> <maml:description> <maml:para>Lists size and space consumption attributes for the snapshots of the specified volume.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaSnapshotSpaceMetrics</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaSnapshotSpaceMetrics</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Volume name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>IncludePendingDeletes</maml:name> <maml:description> <maml:para>Includes (true) destroyed snapshots that are in the eradication pending state.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>IncludePendingDeletes</maml:name> <maml:description> <maml:para>Includes (true) destroyed snapshots that are in the eradication pending state.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Volume name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaSnapshotSpaceMetrics -Array $Array -Name vol1</dev:code> <dev:remarks> <maml:para>Lists size and space consumption attributes for all snapshots taken of volume "vol1" (not including destroyed snapshots in the eradication pending state).</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaSnapshotSpaceMetrics -Array $Array -Name vol1 -IncludePendingDeletes</dev:code> <dev:remarks> <maml:para>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.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaSnmpManager</command:name> <maml:description> <maml:para>Lists communication and security attributes for the specified SNMP manager.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaSnmpManager</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaSnmpManager</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Targe SNMP manager name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Targe SNMP manager name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaSnmpManager -Array $Array -Name ExampleManager</dev:code> <dev:remarks> <maml:para>Lists communication and security attributes for the SNMP manager named "ExampleManager" on the specified array.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaSnmpManagers</command:name> <maml:description> <maml:para>Lists an array's SNMP managers and their communication and security attributes.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaSnmpManagers</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaSnmpManagers</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaSnmpManagers -Array $Array</dev:code> <dev:remarks> <maml:para>Lists communication and security attributes for all SNMP managers on the specified array.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaSourceProtectionGroups</command:name> <maml:description> <maml:para>(REST API 1.2+) Lists protection groups and their attributes. Limited to groups created on this array.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaSourceProtectionGroups</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaSourceProtectionGroups</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaSourceProtectionGroups -Array $Array</dev:code> <dev:remarks> <maml:para>Lists protection groups and their attributes, for groups created on the specified array.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaSourceProtectionGroupSchedules</command:name> <maml:description> <maml:para>(REST API 1.2+) Get the snapshot/replication schedule list from the source only.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaSourceProtectionGroupSchedules</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaSourceProtectionGroupSchedules</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaSyslogServers</command:name> <maml:description> <maml:para>Displays remote syslog servers for the specified array.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaSyslogServers</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaSyslogServers</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaSyslogServers -Array $Array</dev:code> <dev:remarks> <maml:para>Displays remote syslog servers for the specified array.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaTargetProtectionGroups</command:name> <maml:description> <maml:para>(REST API 1.2+) Lists protection groups and their attributes. Limited to groups replicated to this array.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaTargetProtectionGroups</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaTargetProtectionGroups</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaTargetProtectionGroups -Array $Array</dev:code> <dev:remarks> <maml:para>Lists the protection groups (with their attributes) that are replicated to the specified array.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaTotalSnapshotSpaceMetrics</command:name> <maml:description> <maml:para>(REST API 1.2+) Lists the total space consumption for all snapshots of a protection group.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaTotalSnapshotSpaceMetrics</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaTotalSnapshotSpaceMetrics</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target protection group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target protection group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaTotalSnapshotSpaceMetrics -Array $Array -Name protectionGroup1</dev:code> <dev:remarks> <maml:para>Lists the total space consumption for all snapshots of the protection group "protectionGroup1" on the specified array.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaUserSessionRecords</command:name> <maml:description> <maml:para>(REST API 1.4+) Lists user login sessions.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaUserSessionRecords</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaUserSessionRecords</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>User</maml:name> <maml:description> <maml:para>Name of target user.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>User</maml:name> <maml:description> <maml:para>Name of target user.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaUserSessionRecords -Array $Array</dev:code> <dev:remarks> <maml:para>Lists all user login sessions on the specified array.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaUserSessionRecords -Array $Array -User admin@example.com</dev:code> <dev:remarks> <maml:para>Lists user login sessions for the user "admin@example.com" on the specified array.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaVolume</command:name> <maml:description> <maml:para>Lists the attributes for the specified volume.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaVolume</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaVolume</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target volume name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target volume name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaVolume -Array $Array -Name vol1</dev:code> <dev:remarks> <maml:para>Lists attributes for the volume "vol1" on array $Array.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaVolumeHostConnections</command:name> <maml:description> <maml:para>Lists private connections for the specified volume.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaVolumeHostConnections</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaVolumeHostConnections</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>VolumeName</maml:name> <maml:description> <maml:para>Target volume name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>VolumeName</maml:name> <maml:description> <maml:para>Target volume name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaVolumeHostConnections -Array $Array -VolumeName vol1</dev:code> <dev:remarks> <maml:para>Lists private connections for the volume "vol1" on the specified array.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaVolumeHostGroupConnections</command:name> <maml:description> <maml:para>Lists shared connections for the specified volume.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaVolumeHostGroupConnections</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaVolumeHostGroupConnections</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>VolumeName</maml:name> <maml:description> <maml:para>Target volume name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>VolumeName</maml:name> <maml:description> <maml:para>Target volume name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaVolumeHostGroupConnections -Array $Array -VolumeName vol1</dev:code> <dev:remarks> <maml:para>Lists shared connections for the volume "vol1" on the specified array.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaVolumeIOMetrics</command:name> <maml:description> <maml:para>Lists performance data for the specified volume.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaVolumeIOMetrics</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaVolumeIOMetrics</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>VolumeName</maml:name> <maml:description> <maml:para>Target volume name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>VolumeName</maml:name> <maml:description> <maml:para>Target volume name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaVolumeIOMetrics -Array $Array -VolumeName vol1</dev:code> <dev:remarks> <maml:para>Lists performance data for volume "vol1".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaVolumeIOMetricsAverage</command:name> <maml:description> <maml:para>(REST API 1.7+) Lists IO metrics attributes for the specified volume and also display average IO sizes</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaVolumeIOMetricsAverage</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaVolumeIOMetricsAverage</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>VolumeName</maml:name> <maml:description> <maml:para>Target volume name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>VolumeName</maml:name> <maml:description> <maml:para>Target volume name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaVolumeIOMetricsByTimeRange</command:name> <maml:description> <maml:para>Get historical performance data at a specified resolution for the specified volume. Valid historical values are: 1h, 3h, 24h, 7d, 30d, 90d, 1y.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaVolumeIOMetricsByTimeRange</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaVolumeIOMetricsByTimeRange</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>VolumeName</maml:name> <maml:description> <maml:para>Target volume name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>TimeRange</maml:name> <maml:description> <maml:para>Valid historical values are: 1h, 3h, 24h, 7d, 30d, 90d, 1y.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>VolumeName</maml:name> <maml:description> <maml:para>Target volume name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>TimeRange</maml:name> <maml:description> <maml:para>Valid historical values are: 1h, 3h, 24h, 7d, 30d, 90d, 1y.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaVolumeProtectionGroups</command:name> <maml:description> <maml:para>Returns all protection groups that contain a volume as a member.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaVolumeProtectionGroups</command:noun> <dev:version /> </command:details> <maml:description> <maml:para> </maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaVolumeProtectionGroups</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>VolumeName</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>VolumeName</maml:name> <maml:description> <maml:para>Target volume name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaVolumes</command:name> <maml:description> <maml:para>Lists volumes and their attributes.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaVolumes</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaVolumes</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>IncludePendingDeletes</maml:name> <maml:description> <maml:para>Includes (true) destroyed volumes that are in the eradication pending state. Time remaining in the eradication pending state is displayed in seconds.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>IncludePendingDeletes</maml:name> <maml:description> <maml:para>Includes (true) destroyed volumes that are in the eradication pending state. Time remaining in the eradication pending state is displayed in seconds.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaVolumes -Array $Array</dev:code> <dev:remarks> <maml:para>Lists volumes on the array, not including those in the eradication pending stage.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaVolumes -Array $Array -IncludePendingDeletes</dev:code> <dev:remarks> <maml:para>Lists volumes on the array, including those in eradication pending stage.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaVolumeSnapshots</command:name> <maml:description> <maml:para>Lists snapshots for the specified volume.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaVolumeSnapshots</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaVolumeSnapshots</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>VolumeName</maml:name> <maml:description> <maml:para>Target volume name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>IncludePendingDeletes</maml:name> <maml:description> <maml:para>Includes (true) destroyed snapshots that are in the eradication pending state. Time remaining is displayed in seconds.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>VolumeName</maml:name> <maml:description> <maml:para>Target volume name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>IncludePendingDeletes</maml:name> <maml:description> <maml:para>Includes (true) destroyed snapshots that are in the eradication pending state. Time remaining is displayed in seconds.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaVolumeSnapshots -Array $Array -VolumeName vol1</dev:code> <dev:remarks> <maml:para>Lists snapshots taken of volume vol1 (not incuding destroyed snapshots in the eradication pending stage).</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaVolumeSnapshots -Array $Array -VolumeName vol1 -IncludePendingDeletes</dev:code> <dev:remarks> <maml:para>Lists snapshots taken of volume "vol1", incuding destroyed snapshots that are still in the eradication pending stage.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaVolumeSpaceMetrics</command:name> <maml:description> <maml:para>Lists size and space consumption attributes for the specified volume.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaVolumeSpaceMetrics</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaVolumeSpaceMetrics</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>VolumeName</maml:name> <maml:description> <maml:para>Target volume name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>IncludePendingDeletes</maml:name> <maml:description> <maml:para>Includes (true) destroyed volumes that are in the eradication pending state.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>VolumeName</maml:name> <maml:description> <maml:para>Target volume name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>IncludePendingDeletes</maml:name> <maml:description> <maml:para>Includes (true) destroyed volumes that are in the eradication pending state.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaVolumeSpaceMetrics -Array $Array -VolumeName vol1</dev:code> <dev:remarks> <maml:para>Lists size and space consumption attributes for "vol1" on the array. Does not list attributes for a destroyed volume in the eradication pending stage.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-PfaVolumeSpaceMetrics -Array $Array -VolumeName vol1 -IncludePendingDeletes</dev:code> <dev:remarks> <maml:para>Lists size and space consumption attributes for "vol1" on the array, including a destroyed volume in the eradication pending stage.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-PfaVolumeSpaceMetricsByTimeRange</command:name> <maml:description> <maml:para>(REST API 1.6+) Lists size and space consumption attributes for the specified volume.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PfaVolumeSpaceMetricsByTimeRange</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-PfaVolumeSpaceMetricsByTimeRange</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>VolumeName</maml:name> <maml:description> <maml:para>Target volume name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>TimeRange</maml:name> <maml:description> <maml:para>Time range for historical data with units. Valid historical values are: 1h, 3h, 24h, 7d, 30d, 90d, 1y.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>IncludePendingDeletes</maml:name> <maml:description> <maml:para>Includes (true) destroyed volumes that are in the eradication pending state.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>VolumeName</maml:name> <maml:description> <maml:para>Target volume name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>IncludePendingDeletes</maml:name> <maml:description> <maml:para>Includes (true) destroyed volumes that are in the eradication pending state.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>TimeRange</maml:name> <maml:description> <maml:para>Time range for historical data with units. Valid historical values are: 1h, 3h, 24h, 7d, 30d, 90d, 1y.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Grant-PfaReplicationToTargetProtectionGroup</command:name> <maml:description> <maml:para>(REST API 1.2+) Allows a protection group to be replicated.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Grant</command:verb> <command:noun>PfaReplicationToTargetProtectionGroup</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Grant-PfaReplicationToTargetProtectionGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target protection group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target protection group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Grant-PfaReplicationToTargetProtectionGroup -Array $Array -Name protectionGroup1</dev:code> <dev:remarks> <maml:para>Allows the protection group "protectionGroup1" to be replicated.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Import-PfaCertificate</command:name> <maml:description> <maml:para>(REST API 1.3+) Imports a certificate signed by a certificate authority (CA).</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Import</command:verb> <command:noun>PfaCertificate</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Import-PfaCertificate</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Certificate</maml:name> <maml:description> <maml:para>Certificate signed by a certificate authority.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Passphrase</maml:name> <maml:description> <maml:para>Used with the "key" parameter to decrypt the private key.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Key</maml:name> <maml:description> <maml:para>Used with the "certificate" parameter to specify the private key to import.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>IntermediateCertificate</maml:name> <maml:description> <maml:para>Used with the "certificate" parameter to specify the intermediate certificate to import.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Passphrase</maml:name> <maml:description> <maml:para>Used with the "key" parameter to decrypt the private key.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Key</maml:name> <maml:description> <maml:para>Used with the "certificate" parameter to specify the private key to import.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Certificate</maml:name> <maml:description> <maml:para>Certificate signed by a certificate authority.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>IntermediateCertificate</maml:name> <maml:description> <maml:para>Used with the "certificate" parameter to specify the intermediate certificate to import.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Import-PfaCertificate -Array $Array -Certificate "-----BEGIN CERTIFICATE-----\nMIIDUjCCAjoCCQD/4yZG1V0b2DANBgkqhkiG9w0BAQsFADBrMRY [ truncated ] 1Xv4nNr+O0BBFuaaOQbe+Q2gFDdYg0g=\n-----END CERTIFICATE-----"</dev:code> <dev:remarks> <maml:para>Imports a certificate signed by a certificate authority (CA).</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Import-PfaCertificate -Array $Array -Certificate "-----BEGIN CERTIFICATE-----\nMIIDUjCCAjoCCQD/4yZG1V0b2DANBgkqhkiG9w0BAQsFADBrMRY [ truncated ] 1Xv4nNr+O0BBFuaaOQbe+Q2gFDdYg0g=\n-----END CERTIFICATE-----" -Passphrase ExamplePassphrase -Key ExampleKey</dev:code> <dev:remarks> <maml:para>Imports a certificate signed by a certificate authority (CA), using a key and its passphrase.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Import-PfaCertificate -Array $Array -Certificate $Cert -IntermediateCertificate $InterCert</dev:code> <dev:remarks> <maml:para>Imports an intermediate certificate (in addition to the certificate).</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Invoke-PfaPhoneHomeAction</command:name> <maml:description> <maml:para>Transmits event logs stored in the array to the Pure Storage Support team via the phonehome channel.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Invoke</command:verb> <command:noun>PfaPhoneHomeAction</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Invoke-PfaPhoneHomeAction</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Action</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArrayPhoneHomeAction</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Action</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArrayPhoneHomeAction</command:parameterValue> <dev:type> <maml:name>PureArrayPhoneHomeAction</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>PureStorage.Rest.PureArrayPhoneHomeAction</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Invoke-PfaPhoneHomeAction -Array $Array -Action SendToday</dev:code> <dev:remarks> <maml:para>Transmits all of today's event logs stored in the specified array to the Pure Storage Support team via the phonehome channel.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Invoke-PfaPhoneHomeAction -Array $Array -Action Cancel</dev:code> <dev:remarks> <maml:para>Cancels transmission of event logs from the specified array to the Pure Storage Support team via the phonehome channel.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>New-PfaAlert</command:name> <maml:description> <maml:para>Designates any valid email address to receive Purity alert messages.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>PfaAlert</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-PfaAlert</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>User name to be added to the list of email addresses that receive Purity alert messages.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>User name to be added to the list of email addresses that receive Purity alert messages.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-PfaAlert -Array $Array -Name example@example.com</dev:code> <dev:remarks> <maml:para>Adds "example@example.com" to the list of email addresses that receive Purity alert messages.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>New-PfaApiToken</command:name> <maml:description> <maml:para>Creates an API token for the specified user.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>PfaApiToken</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-PfaApiToken</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>User</maml:name> <maml:description> <maml:para>The user to create the API token for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>User</maml:name> <maml:description> <maml:para>The user to create the API token for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-PfaApiToken -Array $Array -User admin@example.com</dev:code> <dev:remarks> <maml:para>Generates an API token for the user "admin@example.com".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>New-PfaArray</command:name> <maml:description> <maml:para>Logs onto the specified FlashArray.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>PfaArray</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-PfaArray</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>EndPoint</maml:name> <maml:description> <maml:para>The name or IP address of the FlashArray.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ApiToken</maml:name> <maml:description> <maml:para>The API token for the FlashArray</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Version</maml:name> <maml:description> <maml:para>The version of the REST API to use. 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.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>IgnoreCertificateError</maml:name> <maml:description> <maml:para>Prevents certificate errors such as an unknown certificate issuer or non-matching names from causing the request to fail.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>HttpTimeOutInMilliSeconds</maml:name> <maml:description> <maml:para>The request times out if not completed within this number of milliseconds.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>RoleRequired</maml:name> <maml:description> <maml:para>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. Values accepted: ArrayAdmin, StorageAdmin, ReadOnly.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-PfaArray</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>EndPoint</maml:name> <maml:description> <maml:para>The name or IP address of the FlashArray.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>UserName</maml:name> <maml:description> <maml:para>The administrator user name used to log onto the array. Either -UserName or -Credential (but not both) are required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Password</maml:name> <maml:description> <maml:para>The password of the administrator name (-UserName).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Version</maml:name> <maml:description> <maml:para>The version of the REST API to use. 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.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>IgnoreCertificateError</maml:name> <maml:description> <maml:para>Prevents certificate errors such as an unknown certificate issuer or non-matching names from causing the request to fail.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>HttpTimeOutInMilliSeconds</maml:name> <maml:description> <maml:para>The request times out if not completed within this number of milliseconds.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>RoleRequired</maml:name> <maml:description> <maml:para>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. Values accepted: ArrayAdmin, StorageAdmin, ReadOnly.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-PfaArray</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>EndPoint</maml:name> <maml:description> <maml:para>The name or IP address of the FlashArray.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named"> <maml:name>Credentials</maml:name> <maml:description> <maml:para>A PSCredential object, replacing the -UserName and -Password parameters. Either -UserName or -Credential (but not both) are required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Version</maml:name> <maml:description> <maml:para>The version of the REST API to use. 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.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>IgnoreCertificateError</maml:name> <maml:description> <maml:para>Prevents certificate errors such as an unknown certificate issuer or non-matching names from causing the request to fail.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>HttpTimeOutInMilliSeconds</maml:name> <maml:description> <maml:para>The request times out if not completed within this number of milliseconds.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>RoleRequired</maml:name> <maml:description> <maml:para>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. Values accepted: ArrayAdmin, StorageAdmin, ReadOnly.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>EndPoint</maml:name> <maml:description> <maml:para>The name or IP address of the FlashArray.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ApiToken</maml:name> <maml:description> <maml:para>The API token for the FlashArray</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Version</maml:name> <maml:description> <maml:para>The version of the REST API to use. 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.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>IgnoreCertificateError</maml:name> <maml:description> <maml:para>Prevents certificate errors such as an unknown certificate issuer or non-matching names from causing the request to fail.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>HttpTimeOutInMilliSeconds</maml:name> <maml:description> <maml:para>The request times out if not completed within this number of milliseconds.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1</command:parameterValue> <dev:type> <maml:name>Nullable`1</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>RoleRequired</maml:name> <maml:description> <maml:para>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. Values accepted: ArrayAdmin, StorageAdmin, ReadOnly.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1</command:parameterValue> <dev:type> <maml:name>Nullable`1</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>UserName</maml:name> <maml:description> <maml:para>The administrator user name used to log onto the array. Either -UserName or -Credential (but not both) are required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Password</maml:name> <maml:description> <maml:para>The password of the administrator name (-UserName).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named"> <maml:name>Credentials</maml:name> <maml:description> <maml:para>A PSCredential object, replacing the -UserName and -Password parameters. Either -UserName or -Credential (but not both) are required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Nullable`1[[PureStorage.Rest.PureUserRole, PureStorage.Rest, Version=1.6.37.0, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Security.SecureString</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$Array = New-PfaArray -EndPoint pure01.example.com -UserName pureuser -HttpTimeOutInMilliSeconds 300000 -Version 1.3</dev:code> <dev:remarks> <maml:para>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").</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$myCredential = Get-Credential $myArray = New-PfaArray -EndPoint pure01.example.com -Credentials $myCredential -IgnoreCertificateError</dev:code> <dev:remarks> <maml:para>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.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$SecurePassword = ConvertTo-SecureString -String $ArrayPassword -AsPlaintext -Force $Array = New-PfaArray -EndPoint pure01.example.com -username pureuser -Password $SecurePassword -IgnoreCertificateError</dev:code> <dev:remarks> <maml:para>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.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$Array = New-PfaArray -EndPoint pure01.example.com -UserName pureuser -RoleRequired ArrayAdmin</dev:code> <dev:remarks> <maml:para>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.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 5 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$Array = New-PfaArray -EndPoint pure01.example.com -ApiToken 99ce4e5a-3593-f724-4c44-e1a8c19c0c49 -IgnoreCertificateError</dev:code> <dev:remarks> <maml:para>Connects to the FlashArray named "pure01.example.com", ignoring any certificate errors and using an API token for authentication</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>New-PfaCertificateSigningRequest</command:name> <maml:description> <maml:para>(REST API 1.3+) Constructs a certificate signing request (CSR) for signing by a certificate authority (CA).</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>PfaCertificateSigningRequest</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-PfaCertificateSigningRequest</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Locality</maml:name> <maml:description> <maml:para>Name of the city where your organization is located.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Country</maml:name> <maml:description> <maml:para>Country name of the CSR. The country name represents the two-letter ISO code for the country where your organization is located.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3"> <maml:name>CommonName</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="4"> <maml:name>State</maml:name> <maml:description> <maml:para>Name of the state or province where your organization is located.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="5"> <maml:name>Organization</maml:name> <maml:description> <maml:para>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."</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="6"> <maml:name>Email</maml:name> <maml:description> <maml:para>Email address used to contact your organization.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="7"> <maml:name>OrganizationalUnit</maml:name> <maml:description> <maml:para>Name of the department within your organization that you want to appear in the certificate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Locality</maml:name> <maml:description> <maml:para>Name of the city where your organization is located.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Country</maml:name> <maml:description> <maml:para>Country name of the CSR. The country name represents the two-letter ISO code for the country where your organization is located.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3"> <maml:name>CommonName</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="4"> <maml:name>State</maml:name> <maml:description> <maml:para>Name of the state or province where your organization is located.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="5"> <maml:name>Organization</maml:name> <maml:description> <maml:para>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."</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="6"> <maml:name>Email</maml:name> <maml:description> <maml:para>Email address used to contact your organization.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="7"> <maml:name>OrganizationalUnit</maml:name> <maml:description> <maml:para>Name of the department within your organization that you want to appear in the certificate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-PfaCertificateSigningRequest -Array $Array -CommonName pure01.example.com -State "CA" -Locality "Mountain View" -Country "US" -Organization "Pure Storage, Inc." -Email "admin@example.com" -OrganizationalUnit "Pubs"</dev:code> <dev:remarks> <maml:para>Constructs a certificate signing request.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>New-PfaCLICommand</command:name> <maml:description> <maml:para>New-PfaCLICommand -EndPoint <string> -Credentials <pscredential> -CommandText <string> [-TimeOutInMilliSeconds <int>] [<CommonParameters>]</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>PfaCLICommand</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-PfaCLICommand</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>EndPoint</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>UserName</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Password</maml:name> <maml:description> <maml:para>Enter the secure password</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>TimeOutInMilliSeconds</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>CommandText</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-PfaCLICommand</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>EndPoint</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named"> <maml:name>Credentials</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>TimeOutInMilliSeconds</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>CommandText</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>EndPoint</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>UserName</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Password</maml:name> <maml:description> <maml:para>Enter the secure password</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>TimeOutInMilliSeconds</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1</command:parameterValue> <dev:type> <maml:name>Nullable`1</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>CommandText</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named"> <maml:name>Credentials</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Security.SecureString</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>New-PfaHost</command:name> <maml:description> <maml:para>Creates a host with the specified name.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>PfaHost</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-PfaHost</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the new host to be created.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>WwnList</maml:name> <maml:description> <maml:para>Sets the list of Fibre Channel worldwide names (WWNs) for the new host.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>IqnList</maml:name> <maml:description> <maml:para>Sets the list of iSCSI qualified names (IQNs) for the new host.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>WwnList</maml:name> <maml:description> <maml:para>Sets the list of Fibre Channel worldwide names (WWNs) for the new host.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the new host to be created.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>IqnList</maml:name> <maml:description> <maml:para>Sets the list of iSCSI qualified names (IQNs) for the new host.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-PfaHost -Array $Array -Name host1</dev:code> <dev:remarks> <maml:para>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.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-PfaHost -Array $Array -Name host2 -WwnList 111112222233333a,111112222233333b</dev:code> <dev:remarks> <maml:para>Creates a host named "host2" and associates the WWNs "11:11:122:22:23:33:33:a" and "11:11:122:22:23:33:33:b" with it.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-PfaHost -Array $Array -Name host3 -IqnList iqn.2015-06.com.example:pure-01</dev:code> <dev:remarks> <maml:para>Creates a host named "host3" and associates the IQN "iqn.2015-06.com.example:pure-01" with it.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>New-PfaHostGroup</command:name> <maml:description> <maml:para>Creates a host group with the specified name.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>PfaHostGroup</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-PfaHostGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target host group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Hosts</maml:name> <maml:description> <maml:para>List of member hosts.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Hosts</maml:name> <maml:description> <maml:para>List of member hosts.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target host group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-PfaHostGroup -Array $Array -Name hostGroup1</dev:code> <dev:remarks> <maml:para>Creates an empty host group named "hostGroup1".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-PfaHostGroup -Array $Array -Name hostGroup2 -Hosts host1,host2,host3</dev:code> <dev:remarks> <maml:para>Creates a host group named "hostGroup2" with 3 hosts ("host1", "host2", "host3") as members.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>New-PfaHostGroupVolumeConnection</command:name> <maml:description> <maml:para>Connects a volume to all hosts in the specified host group.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>PfaHostGroupVolumeConnection</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-PfaHostGroupVolumeConnection</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>VolumeName</maml:name> <maml:description> <maml:para>Target volume name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>HostGroupName</maml:name> <maml:description> <maml:para>Target host group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>LUN</maml:name> <maml:description> <maml:para>Assigns the specified LUN to each connection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>VolumeName</maml:name> <maml:description> <maml:para>Target volume name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>LUN</maml:name> <maml:description> <maml:para>Assigns the specified LUN to each connection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1</command:parameterValue> <dev:type> <maml:name>Nullable`1</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>HostGroupName</maml:name> <maml:description> <maml:para>Target host group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-PfaHostGroupVolumeConnection -Array $Array -VolumeName vol1 -HostGroupName hostGroup1</dev:code> <dev:remarks> <maml:para>Connects volume "vol1" to all hosts in the host group "hostGroup1". Purity assigns the lowest available LUN in the [10...255] range to the volume.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-PfaHostGroupVolumeConnection -Array $Array -VolumeName vol2 -LUN 25 -HostGroupName hostGroup2</dev:code> <dev:remarks> <maml:para>Connects volume "vol2" to all hosts in the host group "hostGroup2". Purity assigns the LUN "25" (if available) to "vol2".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>New-PfaHostVolumeConnection</command:name> <maml:description> <maml:para>Connects a volume to the host.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>PfaHostVolumeConnection</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-PfaHostVolumeConnection</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>VolumeName</maml:name> <maml:description> <maml:para>Target volume name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>HostName</maml:name> <maml:description> <maml:para>Target host name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>LUN</maml:name> <maml:description> <maml:para>Assigns the same LUN to each connection. The connection fails for any host for which the specified LUN is already in use.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>VolumeName</maml:name> <maml:description> <maml:para>Target volume name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>HostName</maml:name> <maml:description> <maml:para>Target host name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>LUN</maml:name> <maml:description> <maml:para>Assigns the same LUN to each connection. The connection fails for any host for which the specified LUN is already in use.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1</command:parameterValue> <dev:type> <maml:name>Nullable`1</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-PfaHostVolumeConnection -Array $Array -VolumeName vol1 -HostName host1</dev:code> <dev:remarks> <maml:para>Connects volume "vol1" to the hosts "host1". Purity assigns the lowest available LUN (starting at 1) to the volume.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-PfaHostVolumeConnection -Array $Array -VolumeName vol2 -HostName host2 -LUN 25</dev:code> <dev:remarks> <maml:para>Connects volume "vol2" to the hosts "host2" and assigns LUN 25 to the volume.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>New-PfaProtectionGroup</command:name> <maml:description> <maml:para>(REST API 1.2+) Creates a protection group with the specified name. Optionally adds target arrays or host, hostgroup, or volume members.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>PfaProtectionGroup</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-PfaProtectionGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target protection group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Volumes</maml:name> <maml:description> <maml:para>List of one or more volumes to be included in the new protection group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Targets</maml:name> <maml:description> <maml:para>List of one or more targets to be included in the new protection group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-PfaProtectionGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target protection group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-PfaProtectionGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target protection group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>HostGroups</maml:name> <maml:description> <maml:para>List of one or more host groups to be included in the new protection group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Targets</maml:name> <maml:description> <maml:para>List of one or more targets to be included in the new protection group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-PfaProtectionGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target protection group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Hosts</maml:name> <maml:description> <maml:para>List of one or more hosts to be included in the new protection group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Targets</maml:name> <maml:description> <maml:para>List of one or more targets to be included in the new protection group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-PfaProtectionGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target protection group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Source</maml:name> <maml:description> <maml:para>(REST API 1.5+) The source pgroup snapshot to copy from.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Overwrite</maml:name> <maml:description> <maml:para>(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.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target protection group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Volumes</maml:name> <maml:description> <maml:para>List of one or more volumes to be included in the new protection group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Targets</maml:name> <maml:description> <maml:para>List of one or more targets to be included in the new protection group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>HostGroups</maml:name> <maml:description> <maml:para>List of one or more host groups to be included in the new protection group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Hosts</maml:name> <maml:description> <maml:para>List of one or more hosts to be included in the new protection group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Source</maml:name> <maml:description> <maml:para>(REST API 1.5+) The source pgroup snapshot to copy from.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Overwrite</maml:name> <maml:description> <maml:para>(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.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-PfaProtectionGroup -Array $Array -Name protectionGroup1</dev:code> <dev:remarks> <maml:para>Creates an empty protection group named "protectionGroup1".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-PfaProtectionGroup -Array $Array -Name protectionGroup2 -Hosts host1,host2,host3</dev:code> <dev:remarks> <maml:para>Creates a protection group named "protectionGroup2" with 3 hosts ("host1", "host2", "host3") as members.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-PfaProtectionGroup -Array $Array -Name protectionGroup3 -Hosts host1,host2,host3 -Targets RemoteArray1</dev:code> <dev:remarks> <maml:para>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).</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-PfaProtectionGroup -Array $Array -Name protectionGroup4 -HostGroups hostGroup1,hostGroup2</dev:code> <dev:remarks> <maml:para>Creates a protection group named "protectionGroup4" with 3 hostgroups ("hostGroup1", "hostGroup2", "hostGroup3") as members.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 5 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-PfaProtectionGroup -Array $Array -Name protectionGroup5 -HostGroups hostGroup1,hostGroup2 -Targets RemoteArray2</dev:code> <dev:remarks> <maml:para>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).</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 6 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-PfaProtectionGroup -Array $Array -Name protectionGroup6 -Volumes vol1,vol2,vol3</dev:code> <dev:remarks> <maml:para>Creates a protection group named "protectionGroup6" with 3 volumes ("vol1", "vol2", "vol3") as members.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>New-PfaProtectionGroupSnapshot</command:name> <maml:description> <maml:para>Creates local snapshots of the content of all volumes in one or more protection groups.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>PfaProtectionGroupSnapshot</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Protection group snapshots capture the content of all volumes on the source array for the specified protection group (or groups) at a single point in time. The snapshot is an immutable image of the volume data at that instance in time. The volumes are either direct members of the protection group or connected to any of its hosts or host groups within the protection group.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-PfaProtectionGroupSnapshot</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Protectiongroupname</maml:name> <maml:description> <maml:para>The name of the protection group that is the source of the snapshots.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Suffix</maml:name> <maml:description> <maml:para>A custom suffix string to be appended to each snapshot name.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ApplyRetention</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Replicate</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ReplicateNow</maml:name> <maml:description> <maml:para>If the -ReplicateNow option is used, the on-demand snapshot is replicated immediately to the target arrays that allow protection group replication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-PfaProtectionGroupSnapshot</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>ProtectionGroups</maml:name> <maml:description> <maml:para>The names of the protection groups that are the source of the snapshots.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Suffix</maml:name> <maml:description> <maml:para>A custom suffix string to be appended to each snapshot name.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ApplyRetention</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Replicate</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ReplicateNow</maml:name> <maml:description> <maml:para>If the -ReplicateNow option is used, the on-demand snapshot is replicated immediately to the target arrays that allow protection group replication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Protectiongroupname</maml:name> <maml:description> <maml:para>The name of the protection group that is the source of the snapshots.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Suffix</maml:name> <maml:description> <maml:para>A custom suffix string to be appended to each snapshot name.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ApplyRetention</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Replicate</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ReplicateNow</maml:name> <maml:description> <maml:para>If the -ReplicateNow option is used, the on-demand snapshot is replicated immediately to the target arrays that allow protection group replication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>ProtectionGroups</maml:name> <maml:description> <maml:para>The names of the protection groups that are the source of the snapshots.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-PfaProtectionGroupSnapshot -Array $Array -Protectiongroupname protectionGroup1 -Suffix example</dev:code> <dev:remarks> <maml:para>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.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-PfaProtectionGroupSnapshot -Array $Array -Protectiongroupname protectionGroup1 -Replicate -ApplyRetention</dev:code> <dev:remarks> <maml:para>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.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-PfaProtectionGroupSnapshot -Array $Array -ProtectionGroups protectionGroup1,protectionGroup2 -ReplicateNow -ApplyRetention</dev:code> <dev:remarks> <maml:para>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.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>New-PfaReplicationConnection</command:name> <maml:description> <maml:para>(REST API 1.2+) Creates a new connection to a target array.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>PfaReplicationConnection</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-PfaReplicationConnection</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>ReplicationAddress</maml:name> <maml:description> <maml:para>The replication address of the array to be connected.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>ConnectionKey</maml:name> <maml:description> <maml:para>The connection_key of the array to be connected.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3"> <maml:name>ManagementAddress</maml:name> <maml:description> <maml:para>The address of the array to be connected.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="4"> <maml:name>Types</maml:name> <maml:description> <maml:para>The type(s) of connection desired. The only option supported in this version is "replication".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>ReplicationAddress</maml:name> <maml:description> <maml:para>The replication address of the array to be connected.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>ConnectionKey</maml:name> <maml:description> <maml:para>The connection_key of the array to be connected.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3"> <maml:name>ManagementAddress</maml:name> <maml:description> <maml:para>The address of the array to be connected.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="4"> <maml:name>Types</maml:name> <maml:description> <maml:para>The type(s) of connection desired. The only option supported in this version is "replication".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-PfaReplicationConnection -Array $Array -ReplicationAddress 102.00.00.00 -ConnectionKey $KeyString -ManagementAddress pure-example -Types Replication</dev:code> <dev:remarks> <maml:para>Creates a new replication connection to the target array "pure-example".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>New-PfaSelfSignedCertificate</command:name> <maml:description> <maml:para>(REST API 1.3+) Creates a self-signed certificate.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>PfaSelfSignedCertificate</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-PfaSelfSignedCertificate</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>NewKey</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Nullable`1</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Locality</maml:name> <maml:description> <maml:para>The city where your organization is located.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3"> <maml:name>Country</maml:name> <maml:description> <maml:para>The two-letter ISO code for the country where your organization is located.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="4"> <maml:name>CommonName</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="5"> <maml:name>Days</maml:name> <maml:description> <maml:para>The number of valid days for the self-signed certificate being generated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Nullable`1</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="6"> <maml:name>State</maml:name> <maml:description> <maml:para>The state or province where your organization is located.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="7"> <maml:name>KeySize</maml:name> <maml:description> <maml:para>The key size in bits. Valid values are 512, 1024, 2048 (default) or 4096. A key size smaller than 2048 is considered insecure.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Nullable`1</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="8"> <maml:name>Organization</maml:name> <maml:description> <maml:para>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."</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="9"> <maml:name>Email</maml:name> <maml:description> <maml:para>The email address used to contact your organization.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="10"> <maml:name>OrganizationalUnit</maml:name> <maml:description> <maml:para>The department within your organization that you want to appear in the certificate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>NewKey</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Nullable`1</command:parameterValue> <dev:type> <maml:name>Nullable`1</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Locality</maml:name> <maml:description> <maml:para>The city where your organization is located.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3"> <maml:name>Country</maml:name> <maml:description> <maml:para>The two-letter ISO code for the country where your organization is located.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="4"> <maml:name>CommonName</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="5"> <maml:name>Days</maml:name> <maml:description> <maml:para>The number of valid days for the self-signed certificate being generated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Nullable`1</command:parameterValue> <dev:type> <maml:name>Nullable`1</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="6"> <maml:name>State</maml:name> <maml:description> <maml:para>The state or province where your organization is located.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="7"> <maml:name>KeySize</maml:name> <maml:description> <maml:para>The key size in bits. Valid values are 512, 1024, 2048 (default) or 4096. A key size smaller than 2048 is considered insecure.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Nullable`1</command:parameterValue> <dev:type> <maml:name>Nullable`1</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="8"> <maml:name>Organization</maml:name> <maml:description> <maml:para>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."</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="9"> <maml:name>Email</maml:name> <maml:description> <maml:para>The email address used to contact your organization.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="10"> <maml:name>OrganizationalUnit</maml:name> <maml:description> <maml:para>The department within your organization that you want to appear in the certificate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Nullable`1[[System.Int64, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-PfaSelfSignedCertificate -Array $Array -NewKey 0 -Locality MountainView -Country USA -CommonName purearray.example.com -Days 365 -State CA -KeySize 2048 -Organization "Pure Storage, Inc." -Email admin@example.com -OrganizationalUnit Pubs</dev:code> <dev:remarks> <maml:para>Generates a new self-signed certificate. Due to the use of "-NewKey 0", the certificate uses the existing private key.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-PfaSelfSignedCertificate -Array $Array -NewKey 1 -Locality MountainView -Country USA -CommonName purearray.example.com -Days 365 -State CA -KeySize 2048 -Organization "Pure Storage, Inc." -Email admin@example.com -OrganizationalUnit Pubs</dev:code> <dev:remarks> <maml:para>Generates a new self-signed certificate. Due to the use of "-NewKey 1", a new private key is generated.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>New-PfaV2SnmpManager</command:name> <maml:description> <maml:para>Creates a Purity SNMP v2c manager object that identifies a host (SNMP manager) and specifies the protocol attributes for communicating with it.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>PfaV2SnmpManager</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-PfaV2SnmpManager</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Host</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Name</maml:name> <maml:description> <maml:para>Targe SNMP manager name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3"> <maml:name>Community</maml:name> <maml:description> <maml:para>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)}.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Host</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Name</maml:name> <maml:description> <maml:para>Targe SNMP manager name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3"> <maml:name>Community</maml:name> <maml:description> <maml:para>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)}.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-PfaV2SnmpManager -Array $Array -Host SNMPServer.example.com -Name MyMgr -Community ExampleID</dev:code> <dev:remarks> <maml:para>Creeate a v2c SNMP manager object named "MyMgr" with the community ID "ExampleID". The SNMP server is hosted on SNMPServer.example.com.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>New-PfaV3SnmpManager</command:name> <maml:description> <maml:para>Creates a Purity SNMP v3 manager object that identifies a host (SNMP manager) and specifies the protocol attributes for communicating with it.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>PfaV3SnmpManager</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-PfaV3SnmpManager</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>PrivacyProtocol</maml:name> <maml:description> <maml:para>SNMP v3 only. Encryption protocol for SNMP messages. Valid values are "AES" or "DES".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Name</maml:name> <maml:description> <maml:para>Targe SNMP manager name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3"> <maml:name>AuthPassphrase</maml:name> <maml:description> <maml:para>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)}.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="4"> <maml:name>PrivacyPassphrase</maml:name> <maml:description> <maml:para>SNMP v3 only. Passphrase used to encrypt SNMP messages. The value must be between 8 and 63 non-space ASCII characters in length.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="5"> <maml:name>AuthProtocol</maml:name> <maml:description> <maml:para>SNMP v3 only. Hash algorithm used to validate the authentication passphrase. Valid values are "MD5" or "SHA".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="6"> <maml:name>Host</maml:name> <maml:description> <maml:para>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.</maml:para> <maml:para> Required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="7"> <maml:name>User</maml:name> <maml:description> <maml:para>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)}.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>PrivacyProtocol</maml:name> <maml:description> <maml:para>SNMP v3 only. Encryption protocol for SNMP messages. Valid values are "AES" or "DES".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Name</maml:name> <maml:description> <maml:para>Targe SNMP manager name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3"> <maml:name>AuthPassphrase</maml:name> <maml:description> <maml:para>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)}.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="4"> <maml:name>PrivacyPassphrase</maml:name> <maml:description> <maml:para>SNMP v3 only. Passphrase used to encrypt SNMP messages. The value must be between 8 and 63 non-space ASCII characters in length.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="5"> <maml:name>AuthProtocol</maml:name> <maml:description> <maml:para>SNMP v3 only. Hash algorithm used to validate the authentication passphrase. Valid values are "MD5" or "SHA".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="6"> <maml:name>Host</maml:name> <maml:description> <maml:para>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.</maml:para> <maml:para> Required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="7"> <maml:name>User</maml:name> <maml:description> <maml:para>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)}.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-PfaV3SnmpManager -Array $Array -PrivacyProtocol AES -Name MyV3Mgr -AuthPassphrase authphrase -PrivacyPassphrase passphrase -AuthProtocol MD5 -Host SNMPServer2.example.com -User user1</dev:code> <dev:remarks> <maml:para>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.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>New-PfaVolume</command:name> <maml:description> <maml:para>Creates a volume.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>PfaVolume</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-PfaVolume</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>VolumeName</maml:name> <maml:description> <maml:para>Target volume name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Source</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Overwrite</maml:name> <maml:description> <maml:para>(REST API 1.1+) When used with "source", overwrites ("true") an existing volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-PfaVolume</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>VolumeName</maml:name> <maml:description> <maml:para>Target volume name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Size</maml:name> <maml:description> <maml:para>Size in bytes of the volume.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-PfaVolume</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>VolumeName</maml:name> <maml:description> <maml:para>Target volume name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Size</maml:name> <maml:description> <maml:para>Size in bytes of the volume.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3"> <maml:name>Unit</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Source</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>VolumeName</maml:name> <maml:description> <maml:para>Target volume name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Overwrite</maml:name> <maml:description> <maml:para>(REST API 1.1+) When used with "source", overwrites ("true") an existing volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Size</maml:name> <maml:description> <maml:para>Size in bytes of the volume.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3"> <maml:name>Unit</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-PfaVolume -Array $Array -VolumeName myvolume -Size 3000 -Unit K</dev:code> <dev:remarks> <maml:para>On array $Array, creates a new volume named "myvolume" of size 3000 KiB.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-PfaVolume -Array $Array -VolumeName myvolume -Size 30 -Unit G</dev:code> <dev:remarks> <maml:para>On array $Array, creates a new volume named "myvolume" of size 30 GiB.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-PfaVolume -Array $Array -VolumeName myvolume -Size 32212254720</dev:code> <dev:remarks> <maml:para>On array $Array, creates a new volume named "myvolume" of size 32212254720 bytes (30 GiB).</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-PfaVolume -Array $Array -VolumeName vol2 -Source vol1</dev:code> <dev:remarks> <maml:para>Copies the data from the volume "vol1" into a new volume "vol2".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 5 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-PfaVolume -Array $Array -VolumeName vol2 -Source vol1 -Overwrite</dev:code> <dev:remarks> <maml:para>Copies the data from the volume "vol1" and into volume "vol2". "vol2" is overwritten if it already exists, otherwise a new volume is created.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>New-PfaVolumeSnapshots</command:name> <maml:description> <maml:para>Creates a snapshot.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>PfaVolumeSnapshots</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-PfaVolumeSnapshots</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Sources</maml:name> <maml:description> <maml:para>Specify the name of a volume to be the snapshot target.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Suffix</maml:name> <maml:description> <maml:para>Specify a custom suffix that is added to the snapshot name.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Sources</maml:name> <maml:description> <maml:para>Specify the name of a volume to be the snapshot target.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Suffix</maml:name> <maml:description> <maml:para>Specify a custom suffix that is added to the snapshot name.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-PfaVolumeSnapshots -Array $Array -Sources vol1,vol2</dev:code> <dev:remarks> <maml:para>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").</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-PfaVolumeSnapshots -Array $Array -Sources vol1,vol2 -suffix failover-backup</dev:code> <dev:remarks> <maml:para>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").</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Remove-PfaAlert</command:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>PfaAlert</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-PfaAlert</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Email address specified for this action.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Email address specified for this action.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Remove-PfaAlert -Array $Array -Name admin@example.com</dev:code> <dev:remarks> <maml:para>Disables the transmission of alert messages to the email address "admin@example.com".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Remove-PfaApiToken</command:name> <maml:description> <maml:para>Removes the API token of the specified user.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>PfaApiToken</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-PfaApiToken</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>User</maml:name> <maml:description> <maml:para>The user of the API token to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>User</maml:name> <maml:description> <maml:para>The user of the API token to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Remove-PfaApiToken -Array $Array -User admin@example.com</dev:code> <dev:remarks> <maml:para>Removes the API token for user "admin@example.com" on the specified array.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Remove-PfaHost</command:name> <maml:description> <maml:para>Removes the specified host. A host cannot be deleted while it has a private connection to a volume or while it is associated with a host group.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>PfaHost</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-PfaHost</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target host name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target host name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Remove-PfaHost -Array $Array -Name host1</dev:code> <dev:remarks> <maml:para>Removes the host "host1" on the specified array.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Remove-PfaHostGroup</command:name> <maml:description> <maml:para>Deletes the specified host group. The host group must be empty to be deleted.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>PfaHostGroup</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-PfaHostGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target host group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target host group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Remove-PfaHostGroup -Array $Array -Name hostGroup1</dev:code> <dev:remarks> <maml:para>Removes the host group "hostGroup1" on the specified array. The host group must be empty to be deleted.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Remove-PfaHostGroupsFromProtectionGroup</command:name> <maml:description> <maml:para>(REST API 1.2+) Removes a list of host groups from the existing list.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>PfaHostGroupsFromProtectionGroup</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-PfaHostGroupsFromProtectionGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>HostGroupsToRemove</maml:name> <maml:description> <maml:para>List of host groups to be removed from the existing list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target protection group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>HostGroupsToRemove</maml:name> <maml:description> <maml:para>List of host groups to be removed from the existing list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target protection group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Remove-PfaHostGroupsFromProtectionGroup -Array $Array -HostGroupsToRemove hostgroup1,hostgroup2,hostgroup3 -Name protectionGroup1</dev:code> <dev:remarks> <maml:para>Removes the specified host groups ("hostgroup1", "hostgroup2, and "hostgroup3") from the existing list of host groups in the protection group "protectionGroup1".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Remove-PfaHostGroupVolumeConnection</command:name> <maml:description> <maml:para>Breaks the connections between all hosts associated with the host group and the specified volume.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>PfaHostGroupVolumeConnection</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-PfaHostGroupVolumeConnection</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>VolumeName</maml:name> <maml:description> <maml:para>Target volume name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>HostGroupName</maml:name> <maml:description> <maml:para>Target host group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>VolumeName</maml:name> <maml:description> <maml:para>Target volume name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>HostGroupName</maml:name> <maml:description> <maml:para>Target host group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Remove-PfaHostGroupVolumeConnection -Array $Array -VolumeName vol1 -HostGroupName hostGroup1</dev:code> <dev:remarks> <maml:para>For the specified array, breaks the connections between the volume "vol1" and all hosts associated with the host group "hostGroup1".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Remove-PfaHostIqns</command:name> <maml:description> <maml:para>Removes IQNs for the specified host.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>PfaHostIqns</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-PfaHostIqns</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target host name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>RemoveIqnList</maml:name> <maml:description> <maml:para>Removes the list of iSCSI qualified names (IQNs) from the specified host.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target host name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>RemoveIqnList</maml:name> <maml:description> <maml:para>Removes the list of iSCSI qualified names (IQNs) from the specified host.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Remove-PfaHostIqns -Array $Array -Name host1 -RemoveIqnList iqn.2015-06.com.example:str1,iqn.2015-06.com.example:str2,iqn.2015-06.com.example:str3</dev:code> <dev:remarks> <maml:para>Removes the three IQNs ("iqn.2015-06.com.example:str1", "iqn.2015-06.com.example:str2", "iqn.2015-06.com.example:str3") from the host "host1".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Remove-PfaHosts</command:name> <maml:description> <maml:para>Removes host members of the specified host group.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>PfaHosts</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-PfaHosts</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>HostsToRemove</maml:name> <maml:description> <maml:para>Removes the list of hosts from the existing list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target host group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>HostsToRemove</maml:name> <maml:description> <maml:para>Removes the list of hosts from the existing list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target host group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Remove-PfaHosts -Array $Array -Name hostGroup1 -HostsToRemove host1,host2</dev:code> <dev:remarks> <maml:para>Removes hosts "host1" and "host2" from membership in the host group "hostGroup1".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Remove-PfaHostsFromProtectionGroup</command:name> <maml:description> <maml:para>(REST API 1.2+) Removes a list of hosts from the existing list.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>PfaHostsFromProtectionGroup</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-PfaHostsFromProtectionGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>HostsToRemove</maml:name> <maml:description> <maml:para>List of hosts to be removed from the existing list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target protection group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>HostsToRemove</maml:name> <maml:description> <maml:para>List of hosts to be removed from the existing list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target protection group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Remove-PfaHostsFromProtectionGroup -Array $Array -Name protectionGroup1 -HostsToRemove host1,host2</dev:code> <dev:remarks> <maml:para>Removes hosts "host1" and "host2" from membership in the protection group "protectionGroup1".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Remove-PfaHostVolumeConnection</command:name> <maml:description> <maml:para>Breaks the connection between a host and volume.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>PfaHostVolumeConnection</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-PfaHostVolumeConnection</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>VolumeName</maml:name> <maml:description> <maml:para>Target volume name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>HostName</maml:name> <maml:description> <maml:para>Target host name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>VolumeName</maml:name> <maml:description> <maml:para>Target volume name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>HostName</maml:name> <maml:description> <maml:para>Target host name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Remove-PfaHostVolumeConnection -Array $Array -VolumeName vol1 -HostName host1</dev:code> <dev:remarks> <maml:para>For the specified array, breaks the connection between the volume "vol1" and the host "host1".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Remove-PfaHostWwns</command:name> <maml:description> <maml:para>Removes WWNs for the specified host.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>PfaHostWwns</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-PfaHostWwns</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target host name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>RemoveWwnList</maml:name> <maml:description> <maml:para>Removes the list of Fibre Channel worldwide names (WWNs) from the specified host.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target host name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>RemoveWwnList</maml:name> <maml:description> <maml:para>Removes the list of Fibre Channel worldwide names (WWNs) from the specified host.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Remove-PfaHostWwns -Array $Array -Name host1 -RemoveWwnList 0123456789abcde1,01:23:45:67:89:ab:cd:e2</dev:code> <dev:remarks> <maml:para>Removes two WWNs ("0123456789abcde1","01:23:45:67:89:ab:cd:e2") from the host "host1".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Remove-PfaProtectionGroupOrSnapshot</command:name> <maml:description> <maml:para>(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.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>PfaProtectionGroupOrSnapshot</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-PfaProtectionGroupOrSnapshot</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target protection group or protection group snapshot name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Eradicate</maml:name> <maml:description> <maml:para>Eradicates the destroyed protection group or protection group snapshot. Recovery of the eradicated protection group or snapshot is not supported.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target protection group or protection group snapshot name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Eradicate</maml:name> <maml:description> <maml:para>Eradicates the destroyed protection group or protection group snapshot. Recovery of the eradicated protection group or snapshot is not supported.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Remove-PfaProtectionGroupOrSnapshot -Array $Array -Name protectionGroup1</dev:code> <dev:remarks> <maml:para>Destroys the protection group "protectionGroup1" and all associated snapshots. The destroyed objects enter a 24-hour eradication period during which they can be restored.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Remove-PfaProtectionGroupOrSnapshot -Array $Array -Name snapshot1 -Eradicate</dev:code> <dev:remarks> <maml:para>Eradicates the snapshot "snapshot1". Recovery of the eradicated snapshot is not supported.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Remove-PfaReplicationConnection</command:name> <maml:description> <maml:para>(REST API 1.2+) Disconnects from a target array.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>PfaReplicationConnection</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-PfaReplicationConnection</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the connection to be deleted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the connection to be deleted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Remove-PfaReplicationConnection -Array $Array -Name $PeerArrayName</dev:code> <dev:remarks> <maml:para>Disconnects from the replication target array with the peer array $PeerArrayName.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Remove-PfaSlaveInterfaces</command:name> <maml:description> <maml:para>Removes the list of slaves from the existing list. May only be used on network bond interfaces.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>PfaSlaveInterfaces</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-PfaSlaveInterfaces</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target network component.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>RemoveSlaveList</maml:name> <maml:description> <maml:para>List of slaves to be removed from the existing list. May only be used on network bond interfaces.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target network component.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>RemoveSlaveList</maml:name> <maml:description> <maml:para>List of slaves to be removed from the existing list. May only be used on network bond interfaces.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Remove-PfaSlaveInterfaces -Array $Array -Name bond009 -RemoveSlaveList eth2,eth3</dev:code> <dev:remarks> <maml:para>Removes the Ethernet interfaces "eth2" and "eth3" as slaves from the bond interface "bond009".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Remove-PfaSnmpManager</command:name> <maml:description> <maml:para>Stops communication with the specified managers and deletes the SNMP manager object.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>PfaSnmpManager</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-PfaSnmpManager</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Targe SNMP manager name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Targe SNMP manager name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Remove-PfaSnmpManager -Array $Array -Name MyMgr</dev:code> <dev:remarks> <maml:para>Stops communication from array $Array to the SNMP manager object name "MyMgr" and deletes the SNMP amanger object.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Remove-PfaTargetArrays</command:name> <maml:description> <maml:para>(REST API 1.2+) Removes a list of target arrays from the existing list.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>PfaTargetArrays</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-PfaTargetArrays</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>TargetsToRemove</maml:name> <maml:description> <maml:para>List of target arrays to be removed from the existing list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target protection group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>TargetsToRemove</maml:name> <maml:description> <maml:para>List of target arrays to be removed from the existing list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target protection group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Remove-PfaTargetArrays -Array $Array -TargetsToRemove array1,array2,array3 -Name protectionGroup1</dev:code> <dev:remarks> <maml:para>Removes the arrays "array1", "array2", "array3" from the protect group "protectionGroup1". These arrays no longer receive replication snapshots from array $Array.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Remove-PfaVolumeOrSnapshot</command:name> <maml:description> <maml:para>Destroys the specified volume or snapshot.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>PfaVolumeOrSnapshot</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Unless the -Eradicate parameter is used, the destroyed object enters a 24-hour eradication pending period during which the object can be recovered.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-PfaVolumeOrSnapshot</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the volume or snapshot to destroy or eradicate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Eradicate</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the volume or snapshot to destroy or eradicate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Eradicate</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Remove-PfaVolumeOrSnapshot -Array $Array -Name vol1</dev:code> <dev:remarks> <maml:para>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.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Remove-PfaVolumeOrSnapshot -Array $Array -Name vol1.example.snap -Eradicate</dev:code> <dev:remarks> <maml:para>Destroys and eradicates the snapshot named "vol1.example.snap". There is no 24-hour eradication pending period and the destroyed snapshot cannot be recovered.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Remove-PfaVolumesFromProtectionGroup</command:name> <maml:description> <maml:para>(REST API 1.2+) Removes a list of volumes from the existing list.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>PfaVolumesFromProtectionGroup</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-PfaVolumesFromProtectionGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>VolumesToRemove</maml:name> <maml:description> <maml:para>List of volumes to be removed from the existing list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target protection group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>VolumesToRemove</maml:name> <maml:description> <maml:para>List of volumes to be removed from the existing list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target protection group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Remove-PfaVolumesFromProtectionGroup -Array $Array -Name protectionGroup1 -VolumesToRemove vol1,vol2,vol3</dev:code> <dev:remarks> <maml:para>Removes three volumes ("vol1","vol2","vol3") from membership in the protection group "protectionGroup1".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Rename-PfaHost</command:name> <maml:description> <maml:para>Renames the specified host.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Rename</command:verb> <command:noun>PfaHost</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Rename-PfaHost</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>NewName</maml:name> <maml:description> <maml:para>The new name for the host</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target host name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>NewName</maml:name> <maml:description> <maml:para>The new name for the host</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target host name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Rename-PfaHost -Array $Array -NewName host1-renamed -Name host1</dev:code> <dev:remarks> <maml:para>Renames "host1" to "host1-renamed".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Rename-PfaHostGroup</command:name> <maml:description> <maml:para>Renames the specified host group.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Rename</command:verb> <command:noun>PfaHostGroup</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Rename-PfaHostGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>NewName</maml:name> <maml:description> <maml:para>Changes the name of the host group to the specified name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target host group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>NewName</maml:name> <maml:description> <maml:para>Changes the name of the host group to the specified name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target host group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Rename-PfaHostGroup -Array $Array -NewName hostGroup1-renamed -Name hostGroup1</dev:code> <dev:remarks> <maml:para>Renames "hostGroup1" to "hostGroup1-renamed".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Rename-PfaProtectionGroup</command:name> <maml:description> <maml:para>(REST API 1.2+) Renames the specified protection group.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Rename</command:verb> <command:noun>PfaProtectionGroup</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Rename-PfaProtectionGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>NewName</maml:name> <maml:description> <maml:para>New name for protection group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target protection group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>NewName</maml:name> <maml:description> <maml:para>New name for protection group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target protection group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Rename-PfaProtectionGroup -Array $Array -NewName protectionGroup1-renamed -Name protectionGroup1</dev:code> <dev:remarks> <maml:para>Renames "protectionGroup1" to "protectionGroup1-renamed".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Rename-PfaSnmpManager</command:name> <maml:description> <maml:para>Renames the specified SNMP manager.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Rename</command:verb> <command:noun>PfaSnmpManager</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Rename-PfaSnmpManager</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>NewName</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Name</maml:name> <maml:description> <maml:para>Targe SNMP manager name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>NewName</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Name</maml:name> <maml:description> <maml:para>Targe SNMP manager name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Rename-PfaSnmpManager -Array $Array -NewName MyMgr2 -Name MyMgr</dev:code> <dev:remarks> <maml:para>Renames the SNMP manager "MyMgr" to "MyMgr2".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Rename-PfaVolumeOrSnapshot</command:name> <maml:description> <maml:para>Renames the specified volume or volume snapshot. Snapshot renaming is only supported in versions 1.4 and later.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Rename</command:verb> <command:noun>PfaVolumeOrSnapshot</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Rename-PfaVolumeOrSnapshot</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>NewName</maml:name> <maml:description> <maml:para>Renames the specified volume or volume snapshot. When renaming a snapshot, only the suffix can be changed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target volume name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>NewName</maml:name> <maml:description> <maml:para>Renames the specified volume or volume snapshot. When renaming a snapshot, only the suffix can be changed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target volume name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Rename-PfaVolumeOrSnapshot -Array $Array -Name vol1 -NewName vol2</dev:code> <dev:remarks> <maml:para>Renames volume "vol1" to "vol2".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Rename-PfaVolumeOrSnapshot -Array $Array -Name vol1.38626 -NewName vol1.backup-snapshot</dev:code> <dev:remarks> <maml:para>Renames the volume snapshot "vol1.38626" to "vol1.backup-snapshot". Note: for volume snapshots, only the suffix can be renamed.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Resize-PfaVolume</command:name> <maml:description> <maml:para>Resizes the specified volume.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Resize</command:verb> <command:noun>PfaVolume</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Resize-PfaVolume</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>VolumeName</maml:name> <maml:description> <maml:para>Target volume name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>NewSize</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Truncate</maml:name> <maml:description> <maml:para>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.</maml:para> <maml:para> Required if the volume "size" is set to a size that is smaller than the original.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>VolumeName</maml:name> <maml:description> <maml:para>Target volume name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>NewSize</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Truncate</maml:name> <maml:description> <maml:para>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.</maml:para> <maml:para> Required if the volume "size" is set to a size that is smaller than the original.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Resize-PfaVolume -Array $Array -VolumeName vol1 -NewSize 32212254720</dev:code> <dev:remarks> <maml:para>Sets the size of volume "vol1" to 32212254720. This command is not valid if the current size of "vol1" is greater than 32212254720 bytes.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Resize-PfaVolume -Array $Array -VolumeName vol1 -NewSize 32212254720 -Truncate</dev:code> <dev:remarks> <maml:para>Sets the size of volume "vol1" to 32212254720. This command is only valid if the current size of "vol1" is greater than 32212254720 bytes. Before the volume is truncated, Purity automatically takes an undo snapshot, which provides a 24-hour window during which the previous contents can be retrieved. After that 24-hour window, the data in truncated sectors cannot be retrieved.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Restore-PfaDestroyedProtectionGroup</command:name> <maml:description> <maml:para>(REST API 1.2+) Recovers a destroyed protection group.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Restore</command:verb> <command:noun>PfaDestroyedProtectionGroup</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The destroyed protection group must not have been eradicated and must still be within the 24-hour eradication pending period.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Restore-PfaDestroyedProtectionGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target protection group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target protection group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Restore-PfaDestroyedProtectionGroup -Array $Array -Name protectionGroup1</dev:code> <dev:remarks> <maml:para>Recovers the destroyed protection group named "protectionGroup1".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Restore-PfaDestroyedVolume</command:name> <maml:description> <maml:para>Recovers the specified volume.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Restore</command:verb> <command:noun>PfaDestroyedVolume</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The destroyed volume must not have been eradicated and must still be within the 24-hour eradication pending period.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Restore-PfaDestroyedVolume</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target volume name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target volume name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Restore-PfaDestroyedVolume -Array $Array -Name vol1</dev:code> <dev:remarks> <maml:para>Recovers the destroyed volume named "vol1". If any snapshots based on "vol1" were implicitly destroyed by a "Remove-PfaVolumeOrSnapshot ... -Name vol1" command, those snapshots are automatically recovered as well. Snapshots based on "vol1" that were destroyed explicitly by separate "Remove-PfaVolumeOrSnapshot ... -Name <snapshot>" commands are not recovered automatically when the source volume is recovered.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Restore-PfaDestroyedVolumeSnapshot</command:name> <maml:description> <maml:para>(REST API 1.4+) Recovers the specified volume snapshot.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Restore</command:verb> <command:noun>PfaDestroyedVolumeSnapshot</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The destroyed volume snapshot must not have been eradicated and must still be within the 24-hour eradication pending period.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Restore-PfaDestroyedVolumeSnapshot</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target volume snapshot name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target volume snapshot name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Restore-PfaDestroyedVolumeSnapshot -Array $Array -Name vol1.example.snap</dev:code> <dev:remarks> <maml:para>Recovers the destroyed volume snapshot named "vol1.example.snap".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Revoke-PfaReplicationToTargetProtectionGroup</command:name> <maml:description> <maml:para>(REST API 1.2+) Disallows a protection group from being replicated.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Revoke</command:verb> <command:noun>PfaReplicationToTargetProtectionGroup</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Revoke-PfaReplicationToTargetProtectionGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target protection group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target protection group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Revoke-PfaReplicationToTargetProtectionGroup -Array $Array -Name protectionGroup1</dev:code> <dev:remarks> <maml:para>Disables replication for the protection group "protectionGroup1".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Set-PfaArrayName</command:name> <maml:description> <maml:para>Modifies the attributes for the array.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PfaArrayName</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-PfaArrayName</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>New name for the array.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>New name for the array.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-PfaArrayName -Array $Array -Name NewArrayName</dev:code> <dev:remarks> <maml:para>Renames the array to "NewArrayName".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Set-PfaBanner</command:name> <maml:description> <maml:para>Sets the welcome banner for the array. The banner is displayed on the GUI login screen and in the console login messages.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PfaBanner</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-PfaBanner</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Banner</maml:name> <maml:description> <maml:para>New banner value.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Banner</maml:name> <maml:description> <maml:para>New banner value.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-PfaBanner -Array $Array -Banner "New banner"</dev:code> <dev:remarks> <maml:para>Sets the welcome banner for the array to "New banner".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Set-PfaConsoleLock</command:name> <maml:description> <maml:para>Enables or disables the console lock, which prevents the root user from logging in through the system console.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PfaConsoleLock</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-PfaConsoleLock</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Status</maml:name> <maml:description> <maml:para>"Enabled" enables the lock. "Disabled" disables the lock (and allows root logins at the console).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArrayStatus</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Status</maml:name> <maml:description> <maml:para>"Enabled" enables the lock. "Disabled" disables the lock (and allows root logins at the console).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArrayStatus</command:parameterValue> <dev:type> <maml:name>PureArrayStatus</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>PureStorage.Rest.PureArrayStatus</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-PfaConsoleLock -Array $Array -Status Enabled</dev:code> <dev:remarks> <maml:para>Enables the console lock. Prevents root access through the console.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-PfaConsoleLock -Array $Array -Status Disabled</dev:code> <dev:remarks> <maml:para>Disables the console lock. Allows root access through the console.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Set-PfaDirectoryServiceArrayAdminGroup</command:name> <maml:description> <maml:para>Sets the common Name (CN) of the directory service group containing administrators with full privileges when managing the FlashArray.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PfaDirectoryServiceArrayAdminGroup</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-PfaDirectoryServiceArrayAdminGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>ArrayAdminGroup</maml:name> <maml:description> <maml:para>The name should be just the Common Name of the group without the CN= specifier. Common Names should not exceed 64 characters in length.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>ArrayAdminGroup</maml:name> <maml:description> <maml:para>The name should be just the Common Name of the group without the CN= specifier. Common Names should not exceed 64 characters in length.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-PfaDirectoryServiceArrayAdminGroup -Array $Array -ArrayAdminGroup PureArrayAdminUsers</dev:code> <dev:remarks> <maml:para>Sets "PureArrayAdminUsers" as the name of the directory service group ("CN=PureArrayAdminUsers") that contains users with array administrator privileges.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Set-PfaDirectoryServiceAuthenticationStatus</command:name> <maml:description> <maml:para>Enables or disables the directory service configuration.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PfaDirectoryServiceAuthenticationStatus</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-PfaDirectoryServiceAuthenticationStatus</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>CheckPeer</maml:name> <maml:description> <maml:para>Enables (true) or disables (false) server authenticity enforcement with the configured CA certificate.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>CheckPeer</maml:name> <maml:description> <maml:para>Enables (true) or disables (false) server authenticity enforcement with the configured CA certificate.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Set-PfaDirectoryServiceCACertificate</command:name> <maml:description> <maml:para>Sets the CA certificate.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PfaDirectoryServiceCACertificate</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-PfaDirectoryServiceCACertificate</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Certificate</maml:name> <maml:description> <maml:para>Certificate string in PEM format, including the "-----BEGIN CERTIFICATE-----" and "-----END CERTIFICATE-----" lines.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SkipChainTrustVerification</maml:name> <maml:description> <maml:para>(REST 1.1+) Sets to true to trust the certificate and skip certificate chain trust verification</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ConfirmServerCertificate</maml:name> <maml:description> <maml:para>Sets to true to download and confirm the server certificate</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SkipChainTrustVerification</maml:name> <maml:description> <maml:para>(REST 1.1+) Sets to true to trust the certificate and skip certificate chain trust verification</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ConfirmServerCertificate</maml:name> <maml:description> <maml:para>Sets to true to download and confirm the server certificate</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Certificate</maml:name> <maml:description> <maml:para>Certificate string in PEM format, including the "-----BEGIN CERTIFICATE-----" and "-----END CERTIFICATE-----" lines.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-PfaDirectoryServiceCACertificate -Array $Array -Certificate "-----BEGIN CERTIFICATE-----\nMIIE6jCCBFOgAwIBAgIDEIGKMA0GCSqGSIb3 [truncated] bizna\ninu9YTrN/4P/w6KzHho=\n-----END CERTIFICATE-----"</dev:code> <dev:remarks> <maml:para>Sets the array's CA certificate to the certificate entered after the -Certificate parameter. Does not download and confirm the server certificate.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-PfaDirectoryServiceCACertificate -Array $Array -SkipChainTrustVerification -Certificate "-----BEGIN CERTIFICATE-----\nMIIE6jCCBFOgAwIBAgIDEIGKMA0GCSqGSIb3 [truncated] bizna\ninu9YTrN/4P/w6KzHho=\n-----END CERTIFICATE-----"</dev:code> <dev:remarks> <maml:para>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.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-PfaDirectoryServiceCACertificate -Array $Array -ConfirmServerCertificate -Certificate "-----BEGIN CERTIFICATE-----\nMIIE6jCCBFOgAwIBAgIDEIGKMA0GCSqGSIb3 [truncated] bizna\ninu9YTrN/4P/w6KzHho=\n-----END CERTIFICATE-----"</dev:code> <dev:remarks> <maml:para>Sets the array's CA certificate to the certificate entered after the -Certificate parameter. Downloads and confirms the server certificate.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Set-PfaDirectoryServiceConfiguration</command:name> <maml:description> <maml:para>Modifies the directory service configuration.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PfaDirectoryServiceConfiguration</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-PfaDirectoryServiceConfiguration</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>BaseDN</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>BindUser</maml:name> <maml:description> <maml:para>The user name that can be used to bind to and query the directory. Often referred to as sAMAccountName or User Logon Name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3"> <maml:name>URI</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="4"> <maml:name>BindPassword</maml:name> <maml:description> <maml:para>The password of the bind_user user name account.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>BaseDN</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>BindUser</maml:name> <maml:description> <maml:para>The user name that can be used to bind to and query the directory. Often referred to as sAMAccountName or User Logon Name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3"> <maml:name>URI</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="4"> <maml:name>BindPassword</maml:name> <maml:description> <maml:para>The password of the bind_user user name account.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-PfaDirectoryServiceConfiguration -Array $Array -BindUser admin1 -BindPassword ExamplePassword -BaseDN "DC=ad1,DC=example,DC=com" -Enabled 1 -URI ldaps://ad1.example.com -CheckPeer 1</dev:code> <dev:remarks> <maml:para>As user "admin1", enables server authenticity enforcement with the configured CA certificate.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-PfaDirectoryServiceConfiguration -Array $Array -BindUser admin1 -BindPassword ExamplePassword -BaseDN "DC=ad1,DC=example,DC=com" -Enabled 0 -URI ldaps://ad1.example.com -CheckPeer 1</dev:code> <dev:remarks> <maml:para>As user "admin1", disables directory service support.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Set-PfaDirectoryServiceGroupBase</command:name> <maml:description> <maml:para>.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PfaDirectoryServiceGroupBase</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-PfaDirectoryServiceGroupBase</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>GroupBase</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>GroupBase</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Set-PfaDirectoryServiceReadOnlyGroup</command:name> <maml:description> <maml:para>Sets the common Name (CN) of the configured directory service group containing users with read-only privileges on the FlashArray.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PfaDirectoryServiceReadOnlyGroup</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-PfaDirectoryServiceReadOnlyGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>ReadOnlyGroup</maml:name> <maml:description> <maml:para>The name should be just the Common Name of the group without the CN= specifier. Common Names should not exceed 64 characters in length.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>ReadOnlyGroup</maml:name> <maml:description> <maml:para>The name should be just the Common Name of the group without the CN= specifier. Common Names should not exceed 64 characters in length.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-PfaDirectoryServiceReadOnlyGroup -Array $Array -ReadOnlyGroup PureReadOnlyUsers</dev:code> <dev:remarks> <maml:para>Sets "PureReadOnlyUsers" as the name of the directory service group ("CN=PureReadOnlyUsers") that contains users with read-only privileges.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Set-PfaDirectoryServiceStatus</command:name> <maml:description> <maml:para>Enables or disables the directory service configuration.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PfaDirectoryServiceStatus</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-PfaDirectoryServiceStatus</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Enabled</maml:name> <maml:description> <maml:para>Enables (true) or disables (false) directory service support.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Enabled</maml:name> <maml:description> <maml:para>Enables (true) or disables (false) directory service support.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Set-PfaDirectoryServiceStorageAdminGroup</command:name> <maml:description> <maml:para>Sets the common Name (CN) of the configured directory service group containing administrators with storage-related privileges on the FlashArray.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PfaDirectoryServiceStorageAdminGroup</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-PfaDirectoryServiceStorageAdminGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>StorageAdminGroup</maml:name> <maml:description> <maml:para>The name should be just the Common Name of the group without the CN= specifier. Common Names should not exceed 64 characters in length.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>StorageAdminGroup</maml:name> <maml:description> <maml:para>The name should be just the Common Name of the group without the CN= specifier. Common Names should not exceed 64 characters in length.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-PfaDirectoryServiceStorageAdminGroup -Array $Array -StorageAdminGroup PureStorageAdmins</dev:code> <dev:remarks> <maml:para>Sets "PureStorageAdmins" as the name of the directory service group containing users with storage administrator privileges (CN=PureStorageAdmins).</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Set-PfaDnsDomain</command:name> <maml:description> <maml:para>Sets the DNS domain for the array administrative network.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PfaDnsDomain</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-PfaDnsDomain</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Domain</maml:name> <maml:description> <maml:para>Domain suffix to be appended by the array when performing DNS lookups.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Domain</maml:name> <maml:description> <maml:para>Domain suffix to be appended by the array when performing DNS lookups.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-PfaDnsDomain -Array $Array -Domain example.com</dev:code> <dev:remarks> <maml:para>Appends the domain suffix "example.com" when performing DNS lookups.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Set-PfaDnsNameServers</command:name> <maml:description> <maml:para>Sets the DNS server list for the array administrative network.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PfaDnsNameServers</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-PfaDnsNameServers</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>NameServers</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>NameServers</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-PfaDnsNameServers -Array $Array -NameServers 102.00.00.01,102.00.00.02,102.00.00.03</dev:code> <dev:remarks> <maml:para>Sets the DNS server list for the array administrative network to 102.00.00.01,102.00.00.02,102.00.00.03.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Set-PfaHardwareIndex</command:name> <maml:description> <maml:para>Displays the specified number on the identifying component.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PfaHardwareIndex</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-PfaHardwareIndex</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Index</maml:name> <maml:description> <maml:para>Displays the specified number on the identifying component.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the hardware component</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Index</maml:name> <maml:description> <maml:para>Displays the specified number on the identifying component.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the hardware component</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-PfaHardwareIndex -Array $Array -Index 7 -Name SH1</dev:code> <dev:remarks> <maml:para>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").</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Set-PfaHostCredentials</command:name> <maml:description> <maml:para>Sets host credentials for the specified host.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PfaHostCredentials</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-PfaHostCredentials</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>HostPassword</maml:name> <maml:description> <maml:para>Sets the host password for CHAP authentication.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target host name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3"> <maml:name>HostUser</maml:name> <maml:description> <maml:para>Sets the host user name for CHAP authentication.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>HostPassword</maml:name> <maml:description> <maml:para>Sets the host password for CHAP authentication.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target host name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3"> <maml:name>HostUser</maml:name> <maml:description> <maml:para>Sets the host user name for CHAP authentication.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-PfaHostCredentials -Array $Array -HostPassword ExamplePass -Name host1 -HostUser user1</dev:code> <dev:remarks> <maml:para>Sets the CHAP host credentials for "host1" to "user1" and "ExamplePass".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Set-PfaHostGroupsInProtectionGroup</command:name> <maml:description> <maml:para>(REST API 1.2+) Replaces the list of member host groups.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PfaHostGroupsInProtectionGroup</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-PfaHostGroupsInProtectionGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>HostGroups</maml:name> <maml:description> <maml:para>List of host groups to replace the list of member host groups.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target protection group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>HostGroups</maml:name> <maml:description> <maml:para>List of host groups to replace the list of member host groups.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target protection group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-PfaHostGroupsInProtectionGroup -Array $Array -HostGroups hostGroup1,hostGroup2,hostGroup3,hostGroup4 -Name protectionGroup1</dev:code> <dev:remarks> <maml:para>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".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Set-PfaHostIqns</command:name> <maml:description> <maml:para>Sets IQNs for the specified host.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PfaHostIqns</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-PfaHostIqns</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target host name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>IqnList</maml:name> <maml:description> <maml:para>Assigns the list of iSCSI qualified names (IQNs) to the specified host.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target host name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>IqnList</maml:name> <maml:description> <maml:para>Assigns the list of iSCSI qualified names (IQNs) to the specified host.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-PfaHostIqns -Array $Array -Name host1 -IqnList iqn.2015-06.com.example:str1,iqn.2015-06.com.example:str2,iqn.2015-06.com.example:str3</dev:code> <dev:remarks> <maml:para>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".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Set-PfaHosts</command:name> <maml:description> <maml:para>Sets host members of the specified host group. Replaces the previous member list.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PfaHosts</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-PfaHosts</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Hosts</maml:name> <maml:description> <maml:para>Replaces the list of member hosts.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target host group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Hosts</maml:name> <maml:description> <maml:para>Replaces the list of member hosts.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target host group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-PfaHosts -Array $Array -Hosts host1,host2,host3,host4 -Name hostGroup1</dev:code> <dev:remarks> <maml:para>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".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Set-PfaHostsInProtectionGroup</command:name> <maml:description> <maml:para>(REST API 1.2+) Replaces the list of member hosts.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PfaHostsInProtectionGroup</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-PfaHostsInProtectionGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Hosts</maml:name> <maml:description> <maml:para>List of hosts to replace the list of member hosts.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target protection group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Hosts</maml:name> <maml:description> <maml:para>List of hosts to replace the list of member hosts.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target protection group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-PfaHostsInProtectionGroup -Array $Array -Hosts host1,host2,host3,host4 -Name protectionGroup1</dev:code> <dev:remarks> <maml:para>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.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Set-PfaHostWwns</command:name> <maml:description> <maml:para>Sets WWNs for the specified host.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PfaHostWwns</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-PfaHostWwns</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target host name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>WwnList</maml:name> <maml:description> <maml:para>Assigns the list of Fibre Channel worldwide names (WWNs) to the specified host.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target host name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>WwnList</maml:name> <maml:description> <maml:para>Assigns the list of Fibre Channel worldwide names (WWNs) to the specified host.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-PfaHostWwns -Array $Array -Name host1 -WwnList 111112222233333a,111112222233333b,111112222233333c</dev:code> <dev:remarks> <maml:para>Assigns the WWNs "111112222233333a", "111112222233333b", "111112222233333c" to host "host1". This command removes any WWNs that previously were assigned to host1.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Set-PfaIdleTimeout</command:name> <maml:description> <maml:para>Modifies the IdleTimeout for the array.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PfaIdleTimeout</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-PfaIdleTimeout</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>IdleTimeout</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>IdleTimeout</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-PfaIdleTimeout -Array $Array -IdleTimeout 15</dev:code> <dev:remarks> <maml:para>Sets the idle time limit to 15 minutes, for the specified array.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-PfaIdleTimeout -Array $Array -IdleTimeout 0</dev:code> <dev:remarks> <maml:para>Disables the idle timeout for the specified array.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Set-PfaInterfaceAddress</command:name> <maml:description> <maml:para>Sets the IP address for a specified interface.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PfaInterfaceAddress</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-PfaInterfaceAddress</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target network component.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Address</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target network component.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Address</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-PfaInterfaceAddress -Array $Array -Name CT0.ETH0 -Address 192.168.0.25</dev:code> <dev:remarks> <maml:para>Sets the IP address for CT0.ETH0.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Set-PfaInterfaceAddressAndNetmask</command:name> <maml:description> <maml:para>Sets the IP address and netmask for a specified interface.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PfaInterfaceAddressAndNetmask</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-PfaInterfaceAddressAndNetmask</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Netmask</maml:name> <maml:description> <maml:para>The netmask in ddd.ddd.ddd.ddd format.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target network component.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3"> <maml:name>Address</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Netmask</maml:name> <maml:description> <maml:para>The netmask in ddd.ddd.ddd.ddd format.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target network component.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3"> <maml:name>Address</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-PfaInterfaceAddressAndNetmask -Array $Array -Netmask 255.255.255.0 -Name CT0.ETH0 -Address 192.168.0.25</dev:code> <dev:remarks> <maml:para>Sets the IP address and netmask for CT0.ETH0.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Set-PfaInterfaceGateway</command:name> <maml:description> <maml:para>Sets the IPv4 address (in ddd.ddd.ddd.ddd format) of the gateway through which the specified interface is to communicate with the network.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PfaInterfaceGateway</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-PfaInterfaceGateway</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target network component.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Gateway</maml:name> <maml:description> <maml:para>IPv4 address (in ddd.ddd.ddd.ddd format) of the gateway through which the specified interface is to communicate with the network.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target network component.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Gateway</maml:name> <maml:description> <maml:para>IPv4 address (in ddd.ddd.ddd.ddd format) of the gateway through which the specified interface is to communicate with the network.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-PfaInterfaceGateway -Array $Array -Name CT0.ETH1 -Gateway 102.102.102.102</dev:code> <dev:remarks> <maml:para>Sets "102.102.102.102" as the IPv4 address of the gateway through which CT0.ETH1 is to communicate with the network.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Set-PfaInterfaceMtu</command:name> <maml:description> <maml:para>Sets the maximum message transfer unit (packet) size for the interface in bytes.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PfaInterfaceMtu</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-PfaInterfaceMtu</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target network component.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Mtu</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target network component.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Mtu</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-PfaInterfaceMtu -Array $Array -Name CT0.ETH1 -Mtu 5000</dev:code> <dev:remarks> <maml:para>Sets the maximum message transfer unit (packet) size for CT0.ETH1 to 5000 bytes.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Set-PfaItemFlag</command:name> <maml:description> <maml:para>Flags a message.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PfaItemFlag</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-PfaItemFlag</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Id</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Id</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-PfaItemFlag -Array $Array -Id 36171</dev:code> <dev:remarks> <maml:para>Flags the message with Id 36171.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Set-PfaNtpServers</command:name> <maml:description> <maml:para>Sets the NTP server for the array.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PfaNtpServers</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-PfaNtpServers</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>NTPServers</maml:name> <maml:description> <maml:para>Alternate NTP servers, by IP address or hostname, assigned as the array source for reference time. Supersedes any previous NTP server assignments.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>NTPServers</maml:name> <maml:description> <maml:para>Alternate NTP servers, by IP address or hostname, assigned as the array source for reference time. Supersedes any previous NTP server assignments.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-PfaNTPServers -Array $Array -NTPServers server1,server2</dev:code> <dev:remarks> <maml:para>Sets "server1" and "server2" as the NTP servers for the array. The previous server list is removed.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Set-PfaPersonality</command:name> <maml:description> <maml:para>Sets the personality of the specified host.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PfaPersonality</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>For hosts running the HP-UX operating system, tunes the protocol used between the array and the initiator.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-PfaPersonality</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target host name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Personality</maml:name> <maml:description> <maml:para>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".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target host name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Personality</maml:name> <maml:description> <maml:para>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".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-PfaPersonality -Array $Array -Name host1 -Personality hpux</dev:code> <dev:remarks> <maml:para>For the host "host1" running on HP-UX, tunes the protocol used between the array and the initiator.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Set-PfaPhoneHomeStatus</command:name> <maml:description> <maml:para>Enables or disables the automatic hourly transmission of array logs to the Pure Storage Support team.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PfaPhoneHomeStatus</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-PfaPhoneHomeStatus</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Status</maml:name> <maml:description> <maml:para>Enables ("Enabled") or disables ("Disabled") the transmission of phonehome logs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArrayStatus</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Status</maml:name> <maml:description> <maml:para>Enables ("Enabled") or disables ("Disabled") the transmission of phonehome logs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArrayStatus</command:parameterValue> <dev:type> <maml:name>PureArrayStatus</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>PureStorage.Rest.PureArrayStatus</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-PfaPhoneHomeStatus -Array $Array -Status Enabled</dev:code> <dev:remarks> <maml:para>Enables phonehome logs from the array.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-PfaPhoneHomeStatus -Array $Array -Status Disabled</dev:code> <dev:remarks> <maml:para>Disables phonehome logs from the array.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Set-PfaProtectionGroupRetention</command:name> <maml:description> <maml:para>Sets the retention rules for a protection group's snapshots. Replaces the previous set of retention rules for the protection group.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PfaProtectionGroupRetention</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The following are default retention rules. Protection groups are scheduled to retain all snapshots for 1 day. After that, Purity keeps 4 snapshots (known as per_day snapshots) per day for an additional 7 days and eradicates the others. Seven days later, Purity eradicates the 4 snapshots.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-PfaProtectionGroupRetention</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>DefaultRetentionForAllTargetSnapshots</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>PostDefaultTargetSnapshotsPerDay</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3"> <maml:name>PostDefaultSourceSnapshotRetentionInDays</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="4"> <maml:name>PostDefaultSourceSnapshotsPerDay</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="5"> <maml:name>GroupName</maml:name> <maml:description> <maml:para>Target protection group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="6"> <maml:name>PostDefaultTargetSnapshotRetentionInDays</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="7"> <maml:name>DefaultRetentionForAllSourceSnapshots</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>DefaultRetentionForAllTargetSnapshots</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>PostDefaultTargetSnapshotsPerDay</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3"> <maml:name>PostDefaultSourceSnapshotRetentionInDays</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="4"> <maml:name>PostDefaultSourceSnapshotsPerDay</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="5"> <maml:name>GroupName</maml:name> <maml:description> <maml:para>Target protection group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="6"> <maml:name>PostDefaultTargetSnapshotRetentionInDays</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="7"> <maml:name>DefaultRetentionForAllSourceSnapshots</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-PfaProtectionGroupRetention -Array $Array -DefaultRetentionForAllTargetSnapshots 43200 -PostDefaultTargetSnapshotsPerDay 5 -PostDefaultSourceSnapshotRetentionInDays 3 -PostDefaultSourceSnapshotsPerDay 2 -GroupName protectionGroup1 -PostDefaultTargetSnapshotRetentionInDays 6 -DefaultRetentionForAllSourceSnapshots 7</dev:code> <dev:remarks> <maml:para>Sets the retention rules for the protection group protectionGroup1. -DefaultRetentionForAllTargetSnapshots 43200 The default length of time to keep replicated snapshots on the target (remote) arrays: 30 days (43200 mintues). (PostDefaultTargetSnapshotRetentionInDays extends this number of days for per_day snapshots.) -PostDefaultTargetSnapshotsPerDay 5 On the target arrays, after the DefaultRetentionForAllTargetSnapshots period is finished, keeps 5 per_day snapshots. (These snapshots are kept for PostDefaultTargetSnapshotRetentionInDays number of days.) -PostDefaultSourceSnapshotRetentionInDays 3 On the source array, after the PostDefaultSourceSnapshotRetentionInDays period is finished, keeps per_day snapshots an additional 3 days before they are eradicated. -PostDefaultSourceSnapshotsPerDay 2 On the source array, after the DefaultRetentionForAllSourceSnapshots period is finished, keeps 2 per_day snapshots. (These snapshots are kept for PostDefaultSourceSnapshotRetentionInDays number of days.) -PostDefaultTargetSnapshotRetentionInDays 6 On the target array, after the DefaultRetentionForAllTargetSnapshots period is finished, keeps target_per_day replicated snapshots 6 additional days before they are eradicated. -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.)</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$CurrentRetention = Get-PfaProtectionGroupRetention -Array $Array -ProtectionGroupName protectionGroup1 Set-PfaProtectionGroupRetention -Array $Array -GroupName protectionGroup1 -PostDefaultTargetSnapshotsPerDay 10 -PostDefaultSourceSnapshotsPerDay 12 -PostDefaultSourceSnapshotRetentionInDays 7 -DefaultRetentionForAllTargetSnapshots $CurrentRetention.target_all_for -DefaultRetentionForAllSourceSnapshots $CurrentRetention.all_for -PostDefaultTargetSnapshotRetentionInDays $CurrentRetention.target_days</dev:code> <dev:remarks> <maml:para>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. Run the Get-PfaProtectionGroupRetention cmdlet first to save the current values. Set-PfaProtectionGroupRetention requires that all parameters by specified.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Set-PfaProtectionGroupSchedule</command:name> <maml:description> <maml:para>Configures snapshot and replication schedules for a protection group. By default, protection groups are scheduled to generate snapshots every hour and replicate snapshots to the target arrays every 4 hours. At least one of the optional arguments is required.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PfaProtectionGroupSchedule</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-PfaProtectionGroupSchedule</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>GroupName</maml:name> <maml:description> <maml:para>The target protection group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SnapshotFrequencyInSeconds</maml:name> <maml:description> <maml:para>How often snapshots will be generated. Maps to the "snap_frequency" parameter in the REST API.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>PreferredTimeOfDayToGenerateSnapshot</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ReplicateAtSecondsOfDay</maml:name> <maml:description> <maml:para>Time of day (in seconds from midnight) to initiate the transfer of replicated snapshots. Maps to the "replicate_at" parameter in the REST API.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ReplicationFrequencyInSeconds</maml:name> <maml:description> <maml:para>How often the transfer of replicated snapshots will occur. Maps to the "replication_frequency" parameter in the REST API.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Blackouts</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Blackout[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SnapshotFrequencyInSeconds</maml:name> <maml:description> <maml:para>How often snapshots will be generated. Maps to the "snap_frequency" parameter in the REST API.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1</command:parameterValue> <dev:type> <maml:name>Nullable`1</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>PreferredTimeOfDayToGenerateSnapshot</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1</command:parameterValue> <dev:type> <maml:name>Nullable`1</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ReplicateAtSecondsOfDay</maml:name> <maml:description> <maml:para>Time of day (in seconds from midnight) to initiate the transfer of replicated snapshots. Maps to the "replicate_at" parameter in the REST API.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1</command:parameterValue> <dev:type> <maml:name>Nullable`1</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>GroupName</maml:name> <maml:description> <maml:para>The target protection group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ReplicationFrequencyInSeconds</maml:name> <maml:description> <maml:para>How often the transfer of replicated snapshots will occur. Maps to the "replication_frequency" parameter in the REST API.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1</command:parameterValue> <dev:type> <maml:name>Nullable`1</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Blackouts</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Blackout[]</command:parameterValue> <dev:type> <maml:name>Blackout[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>PureStorage.Rest.Blackout[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-PfaProtectionGroupSchedule -Array $Array -GroupName protectionGroup1 -PreferredTimeOfDayToGenerateSnapshot 28800 -SnapshotFrequencyInSeconds 432000</dev:code> <dev:remarks> <maml:para>Sets 3 AM (10800 seconds from midnight) as the preferred time of day to generate snapshots. Snapshots are generated every 5 days (432000 seconds).</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-PfaProtectionGroupSchedule -Array $Array -ReplicationFrequencyInSeconds 14400 -GroupName protectionGroup1 -SnapshotFrequencyInSeconds 3600</dev:code> <dev:remarks> <maml:para>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).</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$blackout = New-Object PureStorage.Rest.Blackout $blackout.StartSecondsOfDay = 36000 $blackout.EndSecondsOfDay = 43200 Set-PfaProtectionGroupSchedule -Array $Array -GroupName protectionGroup1 -Blackouts $blackout</dev:code> <dev:remarks> <maml:para>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.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Set-PfaProxy</command:name> <maml:description> <maml:para>Sets phonehome proxy settings for the array.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PfaProxy</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-PfaProxy</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Proxy</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Proxy</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-PfaProxy -Array $Array -Proxy https://proxy_example:555</dev:code> <dev:remarks> <maml:para>Sets the phonehome proxy host for the specified array to "https://proxy_example:555" (hostname "proxy_example", port "555").</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Set-PfaRelayHost</command:name> <maml:description> <maml:para>Sets the relay host for the array's alerts emails.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PfaRelayHost</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-PfaRelayHost</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>RelayHost</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>RelayHost</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-PfaRelayHost -Array $Array -RelayHost relay_example</dev:code> <dev:remarks> <maml:para>Sets the electronic mail relay server (used to forward email alerts generated by the specified array) to "relay_example".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Set-PfaRemoteAssistStatus</command:name> <maml:description> <maml:para>Initiates a remote assistance session with Pure Storage Support or terminate an in-progress remote assistance session.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PfaRemoteAssistStatus</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-PfaRemoteAssistStatus</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Action</maml:name> <maml:description> <maml:para>Initiate ("connect") a remote assistance session or terminate ("disconnect") an in-progress remote assistance session.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RemoteAssistStatus</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Action</maml:name> <maml:description> <maml:para>Initiate ("connect") a remote assistance session or terminate ("disconnect") an in-progress remote assistance session.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RemoteAssistStatus</command:parameterValue> <dev:type> <maml:name>RemoteAssistStatus</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>PureStorage.Rest.RemoteAssistStatus</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-PfaRemoteAssistStatus -Array $Array -Action connect</dev:code> <dev:remarks> <maml:para>Enables remote assist sessions on the specified array.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-PfaRemoteAssistStatus -Array $Array -Action disconnect</dev:code> <dev:remarks> <maml:para>Disables remote assist sessions on the specified array.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Set-PfaScsiTimeout</command:name> <maml:description> <maml:para>Sets the iSCSI timeout for the array.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PfaScsiTimeout</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-PfaScsiTimeout</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>ScsiTimeout</maml:name> <maml:description> <maml:para>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.</maml:para> <maml:para> 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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>ScsiTimeout</maml:name> <maml:description> <maml:para>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.</maml:para> <maml:para> 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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-PfaScsiTimeout -Array $Array -ScsiTimeout 30</dev:code> <dev:remarks> <maml:para>Sets the iSCSI timeout for the specified array to 30 seconds.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Set-PfaSenderDomain</command:name> <maml:description> <maml:para>Sets the sender domain from which Purity sends email alert messages for the array.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PfaSenderDomain</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-PfaSenderDomain</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>SenderDomain</maml:name> <maml:description> <maml:para>Domain name from which Purity sends email alert messages.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>SenderDomain</maml:name> <maml:description> <maml:para>Domain name from which Purity sends email alert messages.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-PfaSenderDomain -Array $Array -SenderDomain example.com</dev:code> <dev:remarks> <maml:para>Sets the domain name (from which Purity sends email alert messages) to "example.com" on the specified array.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Set-PfaSlaveInterfaces</command:name> <maml:description> <maml:para>Replaces the existing slave list. May only be used on network bond interfaces.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PfaSlaveInterfaces</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-PfaSlaveInterfaces</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>SlaveList</maml:name> <maml:description> <maml:para>List of slaves to replace the existing list. May only be used on network bond interfaces.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target network component.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>SlaveList</maml:name> <maml:description> <maml:para>List of slaves to replace the existing list. May only be used on network bond interfaces.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target network component.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-PfaSlaveInterfaces -Array $Array -SlaveList eth2,eth3 -Name bond009</dev:code> <dev:remarks> <maml:para>Adds the Ethernet interfaces "eth2" and "eth3" as slaves to the bond interface "bond009" (overwrites the previous slave list).</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Set-PfaSnmpManagerAuthPassphrase</command:name> <maml:description> <maml:para>Sets the auth passphrase for the specified SNMP manager.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PfaSnmpManagerAuthPassphrase</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Valid only with SNMP v3.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-PfaSnmpManagerAuthPassphrase</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>AuthPassphrase</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target SNMP manager name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>AuthPassphrase</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target SNMP manager name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-PfaSnmpManagerAuthPassphrase -Array $Array -AuthPassphrase ExamplePass -Name MyMgr</dev:code> <dev:remarks> <maml:para>Sets "ExamplePass" the authentication passphrase to use with the SNMP manager "MyMgr". Requires that the authentication protocol also be set.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Set-PfaSnmpManagerAuthProtocol</command:name> <maml:description> <maml:para>Sets the auth protocol for the specified SNMP manager.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PfaSnmpManagerAuthProtocol</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Valid only with SNMP v3.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-PfaSnmpManagerAuthProtocol</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target SNMP manager name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>AuthProtocol</maml:name> <maml:description> <maml:para>SNMP v3 only. Hash algorithm used to validate the authentication passphrase. Valid values are "MD5" or "SHA".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target SNMP manager name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>AuthProtocol</maml:name> <maml:description> <maml:para>SNMP v3 only. Hash algorithm used to validate the authentication passphrase. Valid values are "MD5" or "SHA".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-PfaSnmpManagerAuthProtocol -Array $Array -AuthProtocol MD5 -Name MyMgr</dev:code> <dev:remarks> <maml:para>Sets "MD5" as the authentication protocol to use with the SNMP manager "MyMgr". Requires that the authentication passphrase also be set.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Set-PfaSnmpManagerCommunity</command:name> <maml:description> <maml:para>Sets the community manager ID for the specified SNMP manager.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PfaSnmpManagerCommunity</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Valid only with SNMP v2c.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-PfaSnmpManagerCommunity</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target SNMP manager name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Community</maml:name> <maml:description> <maml:para>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)}.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target SNMP manager name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Community</maml:name> <maml:description> <maml:para>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)}.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-PfaSnmpManagerCommunity -Array $Array -Name MyMgr -Community ExampleId</dev:code> <dev:remarks> <maml:para>Sets the Community Id address associated with the SNMP manager "MyMgr" to "ExampleId".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Set-PfaSnmpManagerHost</command:name> <maml:description> <maml:para>Sets the DNS hostname or IP address for the specified SNMP manager.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PfaSnmpManagerHost</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-PfaSnmpManagerHost</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Host</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target SNMP manager name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Host</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target SNMP manager name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-PfaSnmpManagerHost -Array $Array -Host 102.00.00.01 -Name MyMgr</dev:code> <dev:remarks> <maml:para>Sets the IP address associated with the SNMP manager "MyMgr" to "102.00.00.01".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Set-PfaSnmpManagerPrivacyPassphrase</command:name> <maml:description> <maml:para>Sets the privacy passphrase for the the specified SNMP manager.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PfaSnmpManagerPrivacyPassphrase</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-PfaSnmpManagerPrivacyPassphrase</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target SNMP manager name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>PrivacyPassphrase</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target SNMP manager name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>PrivacyPassphrase</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-PfaSnmpManagerPrivacyPassphrase -Array $Array -PrivacyPassphrase ExamplePass -Name MyMgr</dev:code> <dev:remarks> <maml:para>Sets "ExamplePass" as the privacy passphrase to use with the SNMP manager "MyMgr". Requires that the privacy protocol also be set.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Set-PfaSnmpManagerPrivacyProtocol</command:name> <maml:description> <maml:para>Sets the privacy protocol for the the specified SNMP manager.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PfaSnmpManagerPrivacyProtocol</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Valid only with SNMP v3.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-PfaSnmpManagerPrivacyProtocol</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>PrivacyProtocol</maml:name> <maml:description> <maml:para>SNMP v3 only. Encryption protocol for SNMP messages. Valid values are "AES" or "DES".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target SNMP manager name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>PrivacyProtocol</maml:name> <maml:description> <maml:para>SNMP v3 only. Encryption protocol for SNMP messages. Valid values are "AES" or "DES".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target SNMP manager name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-PfaSnmpManagerPrivacyProtocol -Array $Array -PrivacyProtocol DES -Name MyMgr</dev:code> <dev:remarks> <maml:para>Sets "DES" as the privacy protocol to use with the SNMP manager "MyMgr". Requires that the privacy passphrase must be set.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Set-PfaSnmpManagerUser</command:name> <maml:description> <maml:para>Sets the user for the specified SNMP manager.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PfaSnmpManagerUser</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Valid ony with SNMP v3.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-PfaSnmpManagerUser</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Targe SNMP manager name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>User</maml:name> <maml:description> <maml:para>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)}.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Targe SNMP manager name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>User</maml:name> <maml:description> <maml:para>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)}.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-PfaSnmpManagerUser -Array $Array -Name MyMgr -User user1</dev:code> <dev:remarks> <maml:para>Sets "user1" as the user name to use with the SNMP manager "MyMgr".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Set-PfaSnmpManagerVersion</command:name> <maml:description> <maml:para>Sets the version of the SNMP protocol to be used for the specified SNMP manager.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PfaSnmpManagerVersion</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-PfaSnmpManagerVersion</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Version</maml:name> <maml:description> <maml:para>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".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target SNMP manager name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Version</maml:name> <maml:description> <maml:para>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".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target SNMP manager name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-PfaSnmpManagerVersion -Array $Array -Version v3 -Name MyMgr</dev:code> <dev:remarks> <maml:para>Sets v3 as the SNMP protocol version to use with the SNMP manager "MyMgr".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Set-PfaSyslogServers</command:name> <maml:description> <maml:para>Specifies the remote syslog servers for delivering alert, audit, and log notifications.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PfaSyslogServers</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-PfaSyslogServers</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>SyslogServers</maml:name> <maml:description> <maml:para>Hosts to serve as remote syslog servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>SyslogServers</maml:name> <maml:description> <maml:para>Hosts to serve as remote syslog servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-PfaSyslogServers -Array $Array -SyslogServers server1,server2</dev:code> <dev:remarks> <maml:para>Sets "server1" and "server2" as the syslog servers for the array.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Set-PfaTargetArrays</command:name> <maml:description> <maml:para>(REST API 1.2+) Replaces the list of member target arrays.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PfaTargetArrays</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-PfaTargetArrays</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target protection group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Targets</maml:name> <maml:description> <maml:para>List of member target arrays to replace existing list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target protection group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Targets</maml:name> <maml:description> <maml:para>List of member target arrays to replace existing list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-PfaTargetArrays -Array $Array -Name protectionGroup1 -Targets array1,array2</dev:code> <dev:remarks> <maml:para>Adds the arrays "array1" and "array2" as members to the protection group "protectionGroup1". The previous array list is removed.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Set-PfaTargetCredentials</command:name> <maml:description> <maml:para>Sets target credentials for the specified host.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PfaTargetCredentials</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-PfaTargetCredentials</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>TargetUser</maml:name> <maml:description> <maml:para>Sets the target user name for CHAP authentication.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>TargetPassword</maml:name> <maml:description> <maml:para>Sets the target password for CHAP authentication.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target host name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>TargetUser</maml:name> <maml:description> <maml:para>Sets the target user name for CHAP authentication.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>TargetPassword</maml:name> <maml:description> <maml:para>Sets the target password for CHAP authentication.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target host name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-PfaTargetCredentials -Array $Array -TargetUser user2 -TargetPassword ExampleTargetPass -Name host1</dev:code> <dev:remarks> <maml:para>Sets the CHAP target credentials for "host1" to "user2" and "ExampleTargetPass".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Set-PfaVolumesInProtectionGroup</command:name> <maml:description> <maml:para>(REST API 1.2+) Replaces a protection group's list of member volumes.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PfaVolumesInProtectionGroup</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-PfaVolumesInProtectionGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target protection group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Volumes</maml:name> <maml:description> <maml:para>List of member volumes to replace the existing list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target protection group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Volumes</maml:name> <maml:description> <maml:para>List of member volumes to replace the existing list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-PfaVolumesInProtectionGroup -Array $Array -Name protectionGroup1 -Volumes vol1,vol2,vol3,vol4</dev:code> <dev:remarks> <maml:para>Adds the volumes "vol1", "vol2", "vol3", "vol4" as members to the protection group "protectionGroup1". The previous volume list is removed.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Test-PfaAlert</command:name> <maml:description> <maml:para>Tests the transmission of alert messages to the specified email address.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Test</command:verb> <command:noun>PfaAlert</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Test-PfaAlert</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Email address specified for this action.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Email address specified for this action.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Test-PfaAlert -Array $Array -Name admin@example.com</dev:code> <dev:remarks> <maml:para>Tests the ability of the array to send alert messages to the specified email address.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Test-PfaAlerts</command:name> <maml:description> <maml:para>Tests the ability of the array to send alert messages to all of the designated email addresses.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Test</command:verb> <command:noun>PfaAlerts</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Test-PfaAlerts</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Test-PfaAlerts -Array $Array</dev:code> <dev:remarks> <maml:para>Tests the ability of the array to send alert messages to all of the designated email addresses.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Test-PfaDirectoryService</command:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Test</command:verb> <command:noun>PfaDirectoryService</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Test-PfaDirectoryService</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Test-PfaDirectoryService -Array $Array</dev:code> <dev:remarks> <maml:para>Tests the current directory service configuration for the array.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Test-PfaSnmpTrap</command:name> <maml:description> <maml:para>Sends a test trap to the specified SNMP manager</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Test</command:verb> <command:noun>PfaSnmpTrap</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Test-PfaSnmpTrap</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target SNMP manager name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Target SNMP manager name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Test-PfaSnmpTrap -Array $Array -Name MyMgr</dev:code> <dev:remarks> <maml:para>Sends a test trap to the SNMP manager object named "MyMgr".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Update-PfaArrayConnectionsThrottlingInformation</command:name> <maml:description> <maml:para>Updates connected arrays throttling information.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Update</command:verb> <command:noun>PfaArrayConnectionsThrottlingInformation</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Update-PfaArrayConnectionsThrottlingInformation</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>DefaultLimit</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Connection</maml:name> <maml:description> <maml:para>The name of the connection to apply the throttling settins. The connection name is the array name of the peer array.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3"> <maml:name>Window</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ThrottlingWindow</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="4"> <maml:name>WindowLimit</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>DefaultLimit</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Connection</maml:name> <maml:description> <maml:para>The name of the connection to apply the throttling settins. The connection name is the array name of the peer array.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3"> <maml:name>Window</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ThrottlingWindow</command:parameterValue> <dev:type> <maml:name>ThrottlingWindow</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="4"> <maml:name>WindowLimit</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>PureStorage.Rest.ThrottlingWindow</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Update-PfaItemFlag</command:name> <maml:description> <maml:para>Flags or unflags a message.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Update</command:verb> <command:noun>PfaItemFlag</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Update-PfaItemFlag</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Id</maml:name> <maml:description> <maml:para>Target message ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Flagged</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Array</maml:name> <maml:description> <maml:para>The PureArray object representing a connection to a Pure Storage FlashArray. Created using the "New-PfaArray" cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PureArray</command:parameterValue> <dev:type> <maml:name>PureArray</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Id</maml:name> <maml:description> <maml:para>Target message ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Flagged</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PurePowerShell.PureArray</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Update-PfaItemFlag -Array $Array -Id 20001 -Flagged 0</dev:code> <dev:remarks> <maml:para>Unflags message number 20001.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Update-PfaItemFlag -Array $Array -Id 20001 -Flagged 1</dev:code> <dev:remarks> <maml:para>Flags message number 20001.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!--Generated by: SAPIEN PowerShell HelpWriter 2015 v1.0.10--> </helpItems> |