Updated it to use the ONTAP Ansible collection as opposed to invoking 'curl' commands to get the SnapMirror information.

Author: kcantrel

Infrastructure_as_Code/Ansible/snapmirror_report/README.md

@@ -15,16 +15,18 @@ the number of hours. If the letter is 'M' then the number before it represents t
 the number before it represents the number of seconds. For example, 'P1DT2H3M4S' represents 1 day, 2 hours, 3 minutes, and 4 seconds.
 
 ## Requirements
-- 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.
+- NetApp ONTAP Ansible collection.
+- AWS Ansible collection.
 - 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.
+- The `aws` cli installed and configured. Installation instructions can be found [here](https://docs.aws.amazon.com/cli/latest/userguide/install-cliv2.html).
+- A file with a list of the FSx for ONTAP file systems and their corresponding secrets. The format of the file is described below.
 
 ## Installation
 There are three files used to create the report:
-- `generate_report.yaml`: The Ansible playbook that generates the report.
-- `processs_region.yaml`: A collection of tasks that will process all the FSxNs in a region.
-- `get_all_fsxn_regions.yaml`: A collection of tasks that retrieves all the regions, that are enabled for the account, where FSx for ONTAP is available.
+- `generate_report.yaml`: The main Ansible playbook that generates the report.
+- `get_all_fsxn_regions.yaml`: A collection of tasks that retrieves all the regions, that are enabled for the account, where FSx for ONTAP is also available.
+- `processs_region.yaml`: A collection of tasks that will process all the FSxNs within a region.
 
 You will also need to create a file named (by default) `secrets_list.csv` that list the secret name for each FSx file systems.
 The format of the file should be:

Infrastructure_as_Code/Ansible/snapmirror_report/generate_report.yaml

@@ -1,11 +1,40 @@
+#################################################################################
+# This Ansible playbook generates a csv file that contains the following
+# information for each SnapMirror relationship in all of the FSxNs in all
+# of the AWS regions:
+#
+#   FilesystemID
+#   source
+#   destination
+#   state
+#   healthy
+#   lag_time
+#
+# This playbook is dependent on the 'aws' cli being installed and configured
+# (i.e. authenticated.) It is need to list all the FSxNs within a region
+# since there isn't an amazon.aws.fsx_info module that can do that.
+#
+# It is also dependent on a csv file that should contain the AWS
+# secret for each FSxNs. The format of the secrets.csv file is as follows:
+#
+#   FilesystemID,serect_name
+#
+# Each secret should have two keys 'username' and 'password'.
+#
+# The name of the file is set vai the "secrets_list_file" variable below.
+#
+# It is assumed that all secrets will be in the same region, which is defined
+# in the secrets_region variable below.
+#
+# The output of the playbook is a CSV file that contains the following columns:
+#
+#   fs,source,destination,state,healthy,lag_time
 #
-# This Ansible playbook generates a SnapMirrorreport for all the
-# SnapMirror relationships, in all the FSxNs, in all regions,
 #################################################################################
 ---
 - vars:
     report_name: output.csv
-    secrets_list_file: secrets_list.csv
+    secrets_list_file: secrets.csv
     secrets_region: us-west-2
 #################################################################################
 #
@@ -19,14 +48,15 @@
   hosts: localhost
   collections:
     - amazon.aws
+    - netapp.ontap
   gather_facts: false
 
   tasks:
     - name: Delete previous report while adding the header line.
       ansible.builtin.shell:
         cmd: echo fs,source,destination,state,healthy,lag_time > {{ report_name }}
 
-    - name: Get all the regions that support FSxN that I am opted into.
+    - name: Get all the regions that support FSxN that are opted into.
       include_tasks: get_fsxn_regions.yaml
 
     - name: Generate the report for all the FSxNs.

Infrastructure_as_Code/Ansible/snapmirror_report/get_fsxn_regions.yaml

@@ -1,7 +1,8 @@
-#
-# These tasks are used to set a variable named 'fsnx_regions' that contains a
-# list of regions that support FSxN and are opted-in.
 ################################################################################
+# This Ansiable playbook it used to return all of the regions that support FSxN
+# and are opted-in. It stores the list of regions in the fsxn_regions variable.
+################################################################################
+#
 - name: Get all the opted-in regions
   amazon.aws.aws_region_info:
   register: region_info

Infrastructure_as_Code/Ansible/snapmirror_report/process_region.yaml

@@ -1,36 +1,51 @@
+################################################################################
+# Since Ansible can't handle nested loops, this is a block of tasks that is run
+# for each region. It assumes that the calling playbook used 'region' as its
+# loop variable.
 #
-# Since Ansible can't handle nested loops, this is a block of tasked that is
-# run for each region. It assume that the calling playbook used 'region' as its loop variable.
-#################################################################################
+# It gathers all the snapmirror information for all the FSxNs with a region
+# that a secret is defined for in the secrets.csv file. Once it has gathered
+# all the information, it writes it to an output.csv file in the format:
+#
+#   source_cluster::source_path,destination_cluster::destination_path,state,healthy,lag_time
+#
+################################################################################
 ---
+- name:
+  debug:
+    msg: "Processing region {{ region }}"
+
 - 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[*].{ID:FileSystemId,IP:OntapConfiguration.Endpoints.Management.IpAddresses[0]}' --output text | sed -e '/^$/d'
   register: fsxn_ids_per_region
 
 - name: Get the SnapMirror relationships for each FSxN.
   when: secret != 'n/a'
-  ansible.builtin.shell:
-    cmd: |
-      fs={{ item }};
-      username="{{ lookup('amazon.aws.aws_secret', '{{ secret }}.username', region=secrets_region, nested=true, on_missing='skip') }}";
-      password="{{ lookup('amazon.aws.aws_secret', '{{ secret }}.password', region=secrets_region, nested=true, on_missing='skip') }}";
-      if [ "$username" = '[]' -o "$password" = '[]' ]; then
-        echo "Missing secret for file system $fs" 1>&2;
-        exit 0;
-      fi;
-      ip=$(aws fsx describe-file-systems --region {{ region }} --file-system-ids $fs --query 'FileSystems[0].OntapConfiguration.Endpoints.Management.IpAddresses[0]' --output=text);
-      curl -s -u "${username}:${password}" -k https://$ip/api/snapmirror/relationships?fields=source,destination,lag_time,state,healthy | jq -r '.records[] | "'${fs}',\(.source.path),\(.destination.path),\(.state),\(.healthy),\(.lag_time)"'
+  netapp.ontap.na_ontap_rest_info:
+    username: "{{ lookup('amazon.aws.aws_secret', '{{ secret }}.username', region=secrets_region, nested=true, on_missing='skip') }}"
+    password: "{{ lookup('amazon.aws.aws_secret', '{{ secret }}.password', region=secrets_region, nested=true, on_missing='skip') }}"
+    hostname: "{{ item.split('\t')[1] }}"
+    validate_certs: false
+    fields:
+       - source
+       - destination
+       - healthy
+       - lag_time
+       - state
+    gather_subset:
+      - snapmirror/relationships
   loop: "{{ fsxn_ids_per_region.stdout_lines }}"
   register: snapmirror_relationships
   vars:
-    secret: "{{ lookup('ansible.builtin.csvfile', item, file=secrets_list_file, delimiter=',', default='n/a') }}"
+    secret: "{{ lookup('ansible.builtin.csvfile', item.split('\t')[0], file=secrets_list_file, delimiter=',', default='n/a') }}"
 
-- name: Write the SnapMirror relationships to a file.
-  when: item.stdout is defined
-  ansible.builtin.shell:
-    cmd: |
-      if [ "{{ item.stdout }}" != "" ]; then
-        echo "{{ item.stdout }}" >> {{ report_name }};
-      fi
-  loop: "{{ snapmirror_relationships.results }}"
+- name: Write the SnapMirror relationship infor to a file.
+  ansible.builtin.lineinfile:
+    insertafter: EOF
+    path: output.csv
+    line: "{{ item.source.cluster.name }}::{{ item.source.path }},{{ item.destination.cluster.name }}::{{ item.destination.path }},{{ item.state }},{{ item.healthy }},{{ lag_time }}"
+  loop: "{{ snapmirror_relationships.results[0].ontap_info['snapmirror/relationships'].records }}"
+  when: snapmirror_relationships.results | length > 0 and snapmirror_relationships.results[0].ontap_info is defined
+  vars:
+    lag_time: "{{ item.lag_time if item.lag_time is defined else 'n/a' }}"