Skip to content

Commit ea2ab80

Browse files
committed
Added additional information.
1 parent 1d77fb3 commit ea2ab80

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

Ansible/snapmirror_report/README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ The output of the report is a CSV file with the following columns:
1111
## Requirements
1212
- Ansible 2.9 or later
1313
- AWS Ansible collection
14+
- AWS secret(s) with the credentials neccesary to run SnapMirror ONTAP APIs against the FSx for ONTAP file systems.
1415

1516
## Installation
1617
There are three files used to create the report:
@@ -23,20 +24,24 @@ The format of the file should be:
2324
```
2425
file_system_id,secret_name
2526
```
26-
You should have all four of these files in a single directory.
27+
Each secret should have two `keys`:
28+
| Key | Value |
29+
| --- | --- |
30+
| `username` | The username to use to authenticate with the FSx for ONTAP file system. |
31+
| `password` | The password to use to authenticate with the FSx for ONTAP file system. |
2732

2833
## Configuration
2934
There are a few variables that can be changed at the top of the `generate_report.yaml` file:
3035
- report\_name - Sets the file path of the report that will be generated.
31-
- secrets\_list\_file - Sets the file path of the file that contains the list of FSx file systems and their secrets.
36+
- secrets\_list\_file - Sets the file path of the file that contains the list of FSx file systems and their secrets. See above for more information.
3237
- secrets\_region - Set the region where the secrets are stored.
3338

3439
## Usage
3540
To generate the report, run the following command:
3641
```bash
3742
ansible-playbook generate_report.yaml
3843
```
39-
After a successful run, the report will be saved to the file path specified in the `report_name` variable.
44+
After a successful run, the report will be stored in the file specified by the `report_name` variable.
4045

4146
## Author Information
4247

0 commit comments

Comments
 (0)