Initial Version

Author: kcantrel

Ansible/snapmirror_report/README.md

@@ -0,0 +1,55 @@
+# Ansible SnapMirror Report
+This Ansible playbook generates a report of all the FSx for ONTAP SnapMirror relationships within an AWS account.
+The output of the report is a CSV file with the following columns:
+- File System ID
+- Source Path (svm:volume)
+- Destination Path (svm:volume)
+- State (e.g. snapmirrored, broken-off)
+- Healthy (true or false)
+- lag\_time (in "P#DT#H#M#S" format)
+
+## Requirements
+- Ansible 2.9 or later
+- AWS collection
+
+## 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 colleciton of tasks that retrieves all the regions, that are enabled for the account, where FSx for ONTAP is available.
+
+You will also need to create a file named (by default) `secrets_list.csv` that list the secret name for each FSx file system.
+The format of the file should be:
+```
+file_system_id,secret_name
+```
+You should have all four of these files in a single directory.
+
+## Configuration
+There are a few varaibles that can be changed at the top of the `generate_report.yaml` file:
+- report\_name - Sets the file path of the report that will be generated. 
+- secrets\_list\_file - Sets the file path of the file that contains the list of FSx file systems and their secrets.
+- secrets\_region - Set the region where the secrets are stored.
+
+## Usage
+To generate the report, run the following command:
+```bash
+ansible-playbook generate_report.yaml
+```
+After a succesful run, the report will be saved to the file path specified in the `report_name` variable.
+
+## Author Information
+
+This repository is maintained by the contributors listed on [GitHub](https://github.com/NetApp/FSx-ONTAP-samples-scripts/graphs/contributors).
+
+## License
+
+Licensed under the Apache License, Version 2.0 (the "License").
+
+You may obtain a copy of the License at [apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0).
+
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an _"AS IS"_ basis, without WARRANTIES or conditions of any kind, either express or implied.
+
+See the License for the specific language governing permissions and limitations under the License.
+
+© 2024 NetApp, Inc. All Rights Reserved.

Ansible/snapmirror_report/generate_report.yaml

@@ -0,0 +1,36 @@
+#
+# This Ansible playbook generates a SnapMirror lag time report for all the
+# SnapMirror relationships, in all the FSxNs, in all regions,
+#################################################################################
+---
+- vars:
+    report_name: output.csv
+    secrets_list_file: secrets.csv
+    secrets_region: us-west-2
+#################################################################################
+#
+# Don't change anything below this line.
+#
+#################################################################################
+    fsxn_regions: []
+    opted_in_regions: []
+
+  name: Playbook to generate a SnapMirror report on all the FSxNs.
+  hosts: localhost
+  collections:
+    - amazon.aws
+  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.
+      include_tasks: get_fsxn_regions.yaml
+
+    - name: Generate the report for all the FSxNs.
+      include_tasks: process_region.yaml
+      loop: "{{ fsxn_regions }}"
+      loop_control:
+        loop_var: region

Ansible/snapmirror_report/get_fsxn_regions.yaml

@@ -0,0 +1,26 @@
+- name: Get all the opted-in regions
+  amazon.aws.aws_region_info:
+  register: region_info
+
+- name: Get region names
+  set_fact:
+    enabled_regions: "{{ region_info.regions | map(attribute='region_name') | list }}"
+
+- name: Get the capabilities of all regions
+  set_fact:
+    regions_capabilities: "{{ lookup('ansible.builtin.url', 'https://api.regional-table.region-services.aws.a2z.com/index.json', split_lines=false) }}"
+
+- name: Filter regions that support FSxN and are opted-in
+  set_fact:
+    fsxn_regions: >-
+      {{
+        regions_capabilities.prices
+        | selectattr("attributes.aws:serviceName", "equalto", "Amazon FSx for NetApp ONTAP")
+        | selectattr("attributes.aws:region", "in", enabled_regions)
+        | map(attribute="attributes.aws:region")
+        | list
+      }}
+
+- name: Output the FSxN regions
+  debug:
+    msg: "fsxn_regions={{ fsxn_regions }}"

Ansible/snapmirror_report/process_region.yaml

@@ -0,0 +1,35 @@
+#
+# 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.
+---
+- 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' 
+  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)"'
+  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') }}"
+
+- 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 }}"