Skip to content

Commit 64bdf7b

Browse files
mikenelson-iomikenelson-io
authored
added/updated 2.47.190 about_ files
1 parent 4cd5bef commit 64bdf7b

2 files changed

Lines changed: 155 additions & 0 deletions

File tree

‎about_Pfa2Configuration.help.txt‎

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
TOPIC
2+
about_Pfa2Configuration
3+
4+
SHORT DESCRIPTION
5+
Describes how to set global PureStoragePowerShellSDK2 options.
6+
7+
LONG DESCRIPTION
8+
The PureStoragePowerShellSDK2 supports configuration of several options globally to allow
9+
an administrator to set some default behaviors.
10+
11+
The configuration file is always named:
12+
App.Config.JSON
13+
14+
This file is located in the same folder at the PureStoragePowerShellSDK2 module.
15+
Typically this will be in one of a several locations
16+
17+
%ProgramFiles%\WindowsPowerShell\Modules\PureStoragePowerShellSDK2\
18+
%USERPROFILE%\Documents\WindowsPowerShell\Modules\PureStoragePowerShellSDK2
19+
20+
The exact location can be determined with PowerShell after importing the SDK
21+
22+
Import-Module PureStoragePowerShellSDK2
23+
Get-Module PureStoragePowerShellSDK2 | Select-Object Name, Path | Format-List
24+
25+
PureRest.HttpTimeoutInMilliseconds:
26+
Gets or sets the timeout value for the HTTP requests.
27+
The default is 30000ms (30 seconds).
28+
29+
PureRest.NoOfRetries:
30+
How many times to retry on network failure.
31+
The default value is 3.
32+
33+
PureRest.RetryIntervalBase:
34+
The time (in ms) to wait before retrying a web request. Only retries on network issues,
35+
not for HTTP errors.
36+
The default value is 100ms.
37+
38+
PureRest.RetryIntervalGrowthFactor:
39+
The growth factor of the retryIntervalBase for subsequent retries.
40+
The default value is 3.
41+
42+
PureRest.SshPublicKeyTimeoutInMilliseconds:
43+
Time to wait for the "Please enter public key" prompt from SSH.
44+
The default value is 5000ms.
45+
46+
PureRest.SshPublicKeyResponseTimeoutInMilliseconds:
47+
Time to wait for response or error from pureapiclient create.
48+
The default value is 1000ms.
49+
50+
PureRest.SshPublicKeyWriteTimeoutInMilliseconds:
51+
Time to wait after writing public key before reading response from pureapiclient create.
52+
The default value is 5ms.
53+
54+
PureRest.LoggingToArrayEnabled:
55+
Can be set to false to disable logging REST commands to the array.
56+
The default value is true.
57+
58+
EXAMPLES
59+
60+
Example 1: Set the default HTTP timeout to 60 seconds
61+
{
62+
"PureRest.HttpTimeoutInMilliseconds": "60000"
63+
}
64+
65+
Example 2: All of the supported options specified with their default values
66+
{
67+
"PureRest.HttpTimeoutInMilliseconds": "30000",
68+
"PureRest.NoOfRetries": 3,
69+
"PureRest.RetryIntervalBase": 100,
70+
"PureRest.RetryIntervalGrowthFactor": 3,
71+
"PureRest.SshPublicKeyResponseTimeoutInMilliseconds": 1000,
72+
"PureRest.SshPublicKeyTimeoutInMilliseconds": 5000,
73+
"PureRest.SshPublicKeyWriteTimeoutInMilliseconds": 5
74+
}
75+
76+
Example 3: Opening the configuration file with Notepad:
77+
78+
PS C:\> Import-Module PureStoragePowerShellSDK2
79+
PS C:\> Get-Module PureStoragePowerShellSDK2 | Select-Object Name, Path | Format-List
80+
Name : PureStoragePowerShellSDK2
81+
Path : C:\Program Files\WindowsPowerShell\Modules\PureStoragePowerShellSDK2\PureStoragePowerShellSDK2.dll
82+
83+
PS C:\> Notepad "C:\Program Files\WindowsPowerShell\Modules\PureStoragePowerShellSDK2\App.Config.JSON"
84+
85+
86+
87+
KEYWORDS
88+
89+
90+
SEE ALSO
91+
- Connect-Pfa2Array
92+

‎about_Pfa2Safemode.help.txt‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
TOPIC
2+
about_Pfa2SafeMode
3+
4+
SHORT DESCRIPTION
5+
Describes how the Pure Storage PowerShell SDK2 cmdlets supports SafeMode
6+
7+
LONG DESCRIPTION
8+
The Pure Storage PowerShell SDK2 following SafeMode variations:
9+
10+
ARRAY-WIDE SAFEMODE
11+
You can get Array-Wide SafeMode status using Get-Pfa2Array
12+
- Manual eradication status applied on the array level
13+
- The status is reflected by property `EradicationConfig`. Values include `all-disabled` and `all-enabled`
14+
You cannot disable/enable array-wide SafeMode using the SDK. Please contact Pure Storage Technical Services if there is need.
15+
16+
GLOBAL VOLUME PROTECTION (GVP)
17+
You cannot get status or enable/disable GVP using the SDK with this release. Please contact Pure Storage Technical Services if there is need.
18+
Once the default protection group is setup, all of volumes (including existing ones) created by New-Pfa2Volume will be protected by the protection group automatically. You don't need to specify any parameter.
19+
20+
OBJECT-LEVEL SAFEMODE
21+
You can get Object-Level SafeMode status per protection group using Get-Pfa2ProtectionGroup
22+
- Manual eradication status applied on the protection group level
23+
- The status is reflected by property EradicationConfig. Values include `disabled` and `enabled`
24+
You can enable Object-Level SafeMode per protection group using Update-Pfa2ProtectionGroup
25+
- Use retention_lock parameter. The value could be `ratcheted` or `unlocked`
26+
You cannot disable Object-Level SafeMode per protection group with the SDK. Please contact Pure Storage Technical Services if there is need.
27+
28+
DEFAULT PROTECTION FOR VOLUMES
29+
Default protection for volumes is available with arrays running Purity 6.3.4 and higher.
30+
With Purity 6.3.4, default protection for volumes is an opt-in feature and is configured by creating a default protection group list with `PATCH /api/2.16/container-default-protections Update-Pfa2ContainerDefaultProtections`. With Purity 6.3.5, default protection for volumes is automatically enabled, a default protection group name `pgroup-auto` is automatically created, and the default protection group list is initially set to `pgroup-auto`.
31+
When enabled, new pods inherit the default protection group list for the root of the array. Any volumes newly created by New-Pfa2Volume are automatically put into each protection group named in the applicable default protection group list for either the pod or the root of the array. Default protection for volumes does not affect existing volumes.
32+
33+
Notes:
34+
- Currently, when default protection for volumes or other SafeMode features are enabled, a volume in a protection group cannot be moved out of the protection group. Contact Pure Storage Technical Services for assistance.
35+
- For SDK equal or under 2.15, and Purity 6.3.5 or higher, the SDK does not support a way to avoid putting volumes into the default protection groups.
36+
37+
DISABLED ERADICATION UNDER SAFEMODE
38+
Under SafeMode, if you try to eradicate objects protected using the SDK, you receive PowerShell error stating `Eradication is disabled.`
39+
40+
EXAMPLES
41+
Example 1: Get Array-Wide SafeMode status
42+
(Get-Pfa2Array).EradicationConfig
43+
44+
Example 2: Get Object-Level SafeMode status of a protection group. Please note either Array-Wide or Object-Level SafeMode is on, the status would be "enabled"
45+
(Get-Pfa2ProtectionGroup -Name "testpg").EradicationConfig
46+
47+
Example 3: Enable Object-Level SafeMode status
48+
Update-Pfa2ProtectionGroup -Name "testpg" -RetentionLock "ratcheted"
49+
50+
Example 4: If Auto-On SafeMode is on, create volume and put the volume in the default protection group
51+
New-Pfa2Volume -Name "testpg" -Provisioned 10gb
52+
53+
SEE ALSO
54+
55+
See the following links for more SafeMode information
56+
57+
Array-Wide SafeMode "https://support.purestorage.com/FlashArray/FlashArray_Security/SafeMode/FlashArray_SafeMode_FAQ"
58+
59+
Global Volume Protection "https://support.purestorage.com/FlashArray/FlashArray_Security/SafeMode/SafeMode_Global_Volume_Protection"
60+
61+
Auto-On SafeMode "https://support.purestorage.com/FlashArray/FlashArray_Security/SafeMode/FlashArray_Auto-On_SafeMode_FAQ"
62+
63+
Object-level SafeMode "https://support.purestorage.com/FlashArray/FlashArray_Security/SafeMode/FlashArray_Object-level_SafeMode_FAQ"

0 commit comments

Comments
 (0)