Made minor tweaks to the documentation; Added the volume name to the fsx_inventor_report.

Author: kcantrel

Ansible/fsx_inventory_report/README.md

@@ -1,10 +1,36 @@
 # Ansible Inventory Report
 This Ansible playbook generates a report of all the FSx for ONTAP file systems within an AWS account.
-In includes all the SVMs and Volumes.
+In includes all the SVMs and Volumes. The format of the report is as follows:
+```
+Region: <region_name>
+  File System ID: <file-system-id-1>
+    SVM ID: <svm-id-1-1>
+      Volumes:
+        <volume-id-1-1-1> <volume-type> <security-style> <volume-size-in-megabytes> <volume-name>
+        <volume-id-1-1-2> <volume-type> <security-style> <volume-size-in-megabytes> <volume-name>
+    SVM ID: <svm-id-1-2>
+      Volumes:
+        <volume-id-1-2-2> <volume-type> <security-style> <volume-size-in-megabytes> <volume-name>
+        <volume-id-1-2-2> <volume-type> <security-style> <volume-size-in-megabytes> <volume-name>
+  File System ID: <file-system-id-2>
+    SVM ID: <svm-id-2-1>
+      Volumes:
+        <volume-id-2-1-1> <volume-type> <security-style> <volume-size-in-megabytes> <volume-name>
+        <volume-id-2-1-2> <volume-type> <security-style> <volume-size-in-megabytes> <volume-name>
+    SVM ID: <svm-id-2-2>
+      Volumes:
+        <volume-id-2-2-1> <volume-type> <security-style> <volume-size-in-megabytes> <volume-name>
+        <volume-id-2-2-2> <volume-type> <security-style> <volume-size-in-megabytes> <volume-name>
+```
+Where:
+  - \<volume-size-in-megabytes> is the provisioned size of the volume in megabytes.
+  - \<security-style> is the security style of the volume (e.g. UNIX, NTFS).
+  - \<volume-type> is the type of the volume (e.g. RW, DP).
 
 ## Requirements
-- Ansible 2.9 or later
-- AWS Ansible collection
+- jq - A lightweight and flexible command-line JSON processor. Installation instructions can be found [here](https://jqlang.github.io/jq/download/)
+- Ansible 2.9 or later. Installation instructions can be found [here](https://docs.ansible.com/ansible/latest/installation_guide/index.html)
+- AWS Ansible collection. This should be included with the base installation of Ansible.
 
 ## Installation
 There are three files used to create the report:
@@ -25,35 +51,6 @@ To generate the report copy the three files mentioned above and run the followin
 ansible-playbook generate_report.yaml
 ```
 
-## Output
-After a successful run, the report will be saved to the file path specified in the `report_name` variable.
-The format of the report is as follows:
-```
-Region: <region_name>
-  File System ID: <file-system-id-1>
-    SVM ID: <svm-id-1-1>
-      Volumes:
-        <volume-id-1-1-1> <volume-size-in-megabytes> <security-style> <volume-type>
-        <volume-id-1-1-2> <volume-size-in-megabytes> <security-style> <volume-type>
-    SVM ID: <svm-id-1-2>
-      Volumes:
-        <volume-id-1-1-1> <volume-size-in-megabytes> <security-style> <volume-type>
-        <volume-id-1-1-2> <volume-size-in-megabytes> <security-style> <volume-type>
-  File System ID: <file-system-id-2>
-    SVM ID: <svm-id-2-1>
-      Volumes:
-        <volume-id-2-1-1> <volume-size-in-megabytes> <security-style> <volume-type>
-        <volume-id-2-1-2> <volume-size-in-megabytes> <security-style> <volume-type>
-    SVM ID: <svm-id-2-2>
-      Volumes:
-        <volume-id-2-2-1> <volume-size-in-megabytes> <security-style> <volume-type>
-        <volume-id-2-2-2> <volume-size-in-megabytes> <security-style> <volume-type>
-```
-Where:
-  - \<volume-size-in-megabytes> is the provisioned size of the volume in megabytes.
-  - \<security-style> is the security style of the volume (e.g. UNIX, NTFS).
-  - \<volume-type> is the type of the volume (e.g. RW, DP).
-
 ## Author Information
 
 This repository is maintained by the contributors listed on [GitHub](https://github.com/NetApp/FSx-ONTAP-samples-scripts/graphs/contributors).

Ansible/fsx_inventory_report/process_region.yaml

@@ -6,7 +6,7 @@
 ---
 - name: Get all the FSxNs for the specified region.
   ansible.builtin.shell:
-    cmd: aws fsx describe-file-systems --region {{ region }} --query 'FileSystems[*].{FileSystemId:FileSystemId}' --output text | sed -e '/^$/d' 
+    cmd: aws fsx describe-file-systems --region {{ region }} --query 'FileSystems[*].{FileSystemId:FileSystemId}' --output text | sed -e '/^$/d'
   register: fsxn_ids_per_region
 
 - name: Get all the SVMs and volumes for each FSxN.
@@ -19,6 +19,6 @@
       for svm in $svms; do
         echo "    SVM ID: ${svm}" >> {{ report_name }};
         echo "      Volume IDs:" >> {{ report_name }};
-        aws fsx describe-volumes --filters Name=storage-virtual-machine-id,Values=${svm} --region {{ region }} --output=text --query 'Volumes[*].{Size: OntapConfiguration.SizeInMegabytes, ID: VolumeId, Type: OntapConfiguration.OntapVolumeType, Style: OntapConfiguration.SecurityStyle}' | sed -e 's/^/        /' >> {{ report_name }};
+        aws fsx describe-volumes --filters Name=storage-virtual-machine-id,Values=${svm} --region {{ region }} --output=json --query 'Volumes[*].{Size: OntapConfiguration.SizeInMegabytes, ID: VolumeId, Name: Name, Type: OntapConfiguration.OntapVolumeType, Style: OntapConfiguration.SecurityStyle}' | jq -r '.[] | "        \(.ID) \(.Type) \(.Style) \(.Size) \(.Name)"' >> {{ report_name }};
       done
   loop: "{{ fsxn_ids_per_region.stdout_lines }}"

Ansible/snapmirror_report/README.md

@@ -6,12 +6,19 @@ The output of the report is a CSV file with the following columns:
 - Destination Path (svm:volume)
 - State (e.g. snapmirrored, broken-off)
 - Healthy (true or false)
-- lag\_time (in "P#DT#H#M#S" format, where 'P' and 'T' are fixed characters, and the number before the other letters specify how many Days, Hours, Minutes and Seconds have transpired)
+- lag\_time (in "P#DT#H#M#S" format. See below for an explanation)
+
+The lag\_time format always starts with the letter 'P' and if the lag time is more than 24 hours it is followed by
+a number and the letter 'D'. The number is the number of days. The next character is always a 'T' and is followed by
+a number, letter pairs, where the letter is either an 'H', 'M', or 'S'. If the letter is 'H' then number before it is
+the number of hours. If the letter is 'M' then number before it is the number of minutes. If the letter is 'S' then
+number before it is the number of seconds. For example, 'P1DT2H3M4S' represents 1 day, 2 hours, 3 minutes, and 4 seconds.
 
 ## Requirements
-- Ansible 2.9 or later
-- AWS Ansible collection
-- AWS secret(s) with the credentials neccesary to run SnapMirror ONTAP APIs against the FSx for ONTAP file systems.
+- jq - A lightweight and flexible command-line JSON processor. Installation instructions can be found [here](https://jqlang.github.io/jq/download/)
+- Ansible 2.9 or later. Installation instructions can be found [here](https://docs.ansible.com/ansible/latest/installation_guide/index.html)
+- AWS Ansible collection. This should be included with the base installation of Ansible.
+- AWS secret(s) with the credentials necessary to run SnapMirror ONTAP APIs against the FSx for ONTAP file systems. The required format of the secret is described below.
 
 ## Installation
 There are three files used to create the report:
@@ -24,6 +31,8 @@ The format of the file should be:
 ```
 file_system_id,secret_name
 ```
+NOTE: Do not add any spaces before or after the file\_system\_id or secret\_name.
+
 Each secret should have two `keys`:
 | Key | Value |
 | --- | --- |

Ansible/snapmirror_report/generate_report.yaml

@@ -5,7 +5,7 @@
 ---
 - vars:
     report_name: output.csv
-    secrets_list_file: secrets.csv
+    secrets_list_file: secrets_list.csv
     secrets_region: us-west-2
 #################################################################################
 #