Skip to content

Commit 352aefa

Browse files
authored
Update README.md
1 parent 29d6b73 commit 352aefa

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

python/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Python scripts for snapshot and cloning a protection group on a Pure Flash Array
22

3-
The script fa_pg_snap.py provides for taking a snapshot of a protection group on a Pure Flash Array.
4-
It will also optionally copy that snapshot to a target protection group. In this case the target protection group must have an equal or greater number of volumes of equal or larger size than the source.
5-
The script can also copy an existing snapshot of a source protection group to a target protection group.
3+
The script fa_pg_snap.py provides for taking a snapshot of a protection group on a Pure Flash Array.\
4+
It will also optionally copy that snapshot to a target protection group. In this case the target protection group must have an equal or greater number of volumes of equal or larger size than the source.\
5+
The script can also copy an existing snapshot of a source protection group to a target protection group.\
66
If replication is set up for the source protection group, the snapshot can be replicated to a second Flash Array.
77

88
# Arguments:
@@ -14,13 +14,13 @@ If replication is set up for the source protection group, the snapshot can be re
1414
-r replicate the snapshot to the targets specified in the source protection group (optional)\
1515
-o output file with the names of the snapshot volumes (optional)\
1616
-i ignore tag (optional - see below)\
17-
-x execute lock - if this is NOT set, no destructive actions will be taken. Instead, the script will simply tell you would it would do. This may prove useful to make sure you have all the settings right before you overwrite a target protection group.\
17+
-x execute lock - if this is NOT set, no destructive actions will be taken. Instead, the script will simply tell you would it would do. This may prove useful to make sure you have all the settings right before you overwrite a target protection group.
1818

1919
# Notes:
2020

2121
If replication is not specified, both the source and target protection groups are assumed to be on the source Flash Array, and the target Flash Array is ignored.\
2222
If the JSON file does not specify authentication credentials, the code will try to read the OS variables FA_HOST and API_TOKEN for authentication to the source Flash Array.\
23-
If the JSON file does not specify authentication credentials, the code will try to read the OS variables FA_HOST_TGT and API_TOKEN_TGT for authentication to the target Flash Array.\
23+
If the JSON file does not specify authentication credentials, the code will try to read the OS variables FA_HOST_TGT and API_TOKEN_TGT for authentication to the target Flash Array.
2424

2525
# Excluding Volumes in the Protection Group
2626

@@ -31,7 +31,7 @@ In this example, the JSON file allows the user to specify source volumes in the
3131

3232
If a target protection group is specified, the code will overwrite the volumes of the target protection group with the contents of the source snapshot.\
3333
To achieve this, the code will look for matching volumes of the same size. If none can be found, then the code will consider volumes of larger size. Volumes are considered in alphabetical order, so if the same naming convention is used for both source and target, the volumes will be considered in order. Once a suitable target has been identified, the code tags the volume of the target protection group with the volume id of the source volume. This means that every subsequent execution of the code wil see the same target volume ovewritten from the same source snapshot volume.
34-
The -i flag may be used to ignore these tags and re-establish a new source-snapshot/target volume pairing, such as the user decides to snapshot from a different source protection group.\
34+
The -i flag may be used to ignore these tags and re-establish a new source-snapshot/target volume pairing, such as the user decides to snapshot from a different source protection group.
3535

3636
# A Worked Example
3737

0 commit comments

Comments
 (0)