snapmirror_create

#!/bin/bash
#
################################################################################
# This script is used to create a SnapMirror relationship on a
# FSx for ONTAP file systems.
# 
# It is dependent on the 'wf_utils' file that is included in this repo. That
# file contains the 'get_token' function that is used to obtain a valid
# access token that is needed to run the Workload Factory APIs. The file needs
# to either be in the command search path or in the current directory.
################################################################################

################################################################################
# This function just prints the usage of this script and exits the program.
################################################################################
usage() {
  cat >&2 <<EOF
This script is used to create a SnapMirror relationship on a FSx for ONTAP file systems.

Usage: $(basename $0) -t refresh_token -a blueXP_account_ID [-l throttle] [-s schedule] \\
    -C source_credentials_id -R source_aws_region -F source_fs_id [-Y source_type] -M source_svm_ID -N source_svm_name -V source_volume \\
    -c destination_credentials_id -r destination_aws_region -f destination_fs_id [-y destination_type] -m destination_svm_ID -n destination_svm_name

Where: refresh_token - Is a refresh token used to obtain an access token needed
                       to run the Workload Factory APIs. You can obtain a refresh
                       token by going to https://services.cloud.netapp.com/refresh-token
       blueXP_account_ID - is the BlueXP account ID. Run 'list_bluexp_accts' to get a
                           list of accounts you have access to
       throttle - is the network throughput limit during transfers (optional, defaults to 100 MiB/s. 0 means unlimited)
       schedule - is the schedule to use for the SnapMirror relationship (optional, defaults to "hourly")

       source_credentials_ID - is the Workload Factory credentials ID for the AWS account. Run
                              'list_credentials' to get a list of credentials you have access to.
       source_aws_region - is the AWS region of the source file system. Not required if the source is on-prem.
       source_fs_ID - is the file system ID of the file system that is the source of the SnapMirror relationship. Run
                      'list_filesystems' to get a list of file systems you have access to.
       source_svm_ID - is the SVM ID on the source file system where you want the volume replicated from
       source_svm_name - is the name of the SVM on the source file system where you want the volume replicated from
       source_type - is the file system type of the source cluster. Either 'FSx' or 'on-prem' (optional, defaults to "FSx")
       source_volume - is the name of the source volume to be mirrored

       destination_credentials_ID - is the Workload Factory credentials ID for the AWS account. Run
                                    'list_credentials' to get a list of credentials you have access to
       destination_aws_region - is the AWS region where the destination file system is located
       destination_fs_ID - is the AWS file system ID of the file system that is the destination of the relationship relationship
       destination_svm_ID - is the SVM ID of the within destination file system where you want the volume replicated to
       destination_svm_name - is the name of the SVM on the destination file system where you want the volume replicated to
       destination_type - is the type of the destination file system. Either 'FSx' or 'on-prem' (optional, defaults to "FSx")

Instead of passing parameters on the command line, you can set the
following environment variables:

    export REFRESH_TOKEN=<refresh_token>
    export BLUEXP_ACCOUNT_ID=<blueXP_account_ID>
EOF
  exit 1
}

################################################################################
# Main logic starts here.
################################################################################
tmpout=$(mktemp /tmp/create_mirror-out.XXXXXX)
tmperr=$(mktemp /tmp/create_mirror-err.XXXXXX)
trap 'rm -f $tmpout $tmperr' exit
#
# Source the wf_utils file.
wf_utils=$(command -v wf_utils)
if [ -z "$wf_utils" ]; then
  if [ ! -x "./wf_utils" ]; then
    cat >&2 <<EOF
Error: The 'wf_utils' script was not found in the current directory or in the command search path.
It is required to run this script. You can download it from:
https://github.com/NetApp/FSx-ONTAP-samples-scripts/tree/main/Management-Utilities/Workload-Factory-API-Samples
EOF
    exit 1
  else
    wf_utils=./wf_utils
  fi
fi
. "$wf_utils"
#
# Process the command line arguments.
#
# Set default values for the parameters.
SOURCE_TYPE="FSx"
DESTINATION_TYPE="FSx"
THROTTLE=102400 # 100 MiB/s
SCHEDULE="hourly"
while getopts "ht:a:l:s:C:R:F:Y:M:N:V:c:r:f:y:m:n:" opt; do
  case $opt in
    t) REFRESH_TOKEN="$OPTARG" ;;
    a) BLUEXP_ACCOUNT_ID="$OPTARG" ;;
    l) THROTTLE="$OPTARG" ;;
    s) SCHEDULE="$OPTARG" ;;
    c) DESTINATION_CREDENTIALS_ID="$OPTARG" ;;
    r) DESTINATION_AWS_REGION="$OPTARG" ;;
    f) DESTINATION_FS_ID="$OPTARG" ;;
    y) DESTINATION_TYPE="$OPTARG" ;;
    m) DESTINATION_SVM_ID="$OPTARG" ;;
    n) DESTINATION_SVM_NAME="$OPTARG" ;;
    F) SOURCE_FS_ID="$OPTARG" ;;
    C) SOURCE_CREDENTIALS_ID="$OPTARG" ;;
    R) SOURCE_AWS_REGION="$OPTARG" ;;
    Y) SOURCE_TYPE="$OPTARG" ;;
    M) SOURCE_SVM_ID="$OPTARG" ;;
    N) SOURCE_SVM_NAME="$OPTARG" ;;
    V) SOURCE_VOLUME="$OPTARG" ;;
    *) usage ;;
  esac
done
#
# Declare an array of required options and the error message to display if they are not set.
declare -A required_options
required_options["REFRESH_TOKEN"]='Error: A BlueXP refresh tokon is required to run this script. It can be obtain from this web page:
  https://services.cloud.netapp.com/refresh-token\n\n'
required_options["BLUEXP_ACCOUNT_ID"]='Error: A BlueXP account ID is required to run this script.
You can get the list of accounts you have access to by running the "list_bluexp_accts" script
found in this GitHub repository: https://github.com/NetApp/FSx-ONTAP-samples-scripts/tree/main/Management-Utilities/Workload-Factory-API-Samples\n\n'
required_options["DESTINATION_CREDENTIALS_ID"]='Error: The Workload Factory credentials ID for the destination file system is required to run this script.
You can get the list of credentials you have access to by running the "list_credentials" script
found in this GitHub repository: https://github.com/NetApp/FSx-ONTAP-samples-scripts/tree/main/Management-Utilities/Workload-Factory-API-Samples\n\n'
required_options["SOURCE_CREDENTIALS_ID"]='Error: The Workload Factory credentials ID for the source file system is required to run this script.
You can get the list of credentials you have access to by running the "list_credentials" script
found in this GitHub repository: https://github.com/NetApp/FSx-ONTAP-samples-scripts/tree/main/Management-Utilities/Workload-Factory-API-Samples\n\n'
required_options["DESTINATION_AWS_REGION"]='Error: The AWS region where the destination of the SnapMirror is located is required to run this script.\n\n'
required_options["SOURCE_AWS_REGION"]='Error: The AWS region where the source of the SnapMirror relationship is located is required to run this script.\n\n'
required_options["DESTINATION_FS_ID"]='Error: The destination FSx file system ID is required to run this script.
You can get the list of file systems you have access to by running the "list_filesystems" script
found in this GitHub repository: https://github.com/NetApp/FSx-ONTAP-samples-scripts/tree/main/Management-Utilities/Workload-Factory-API-Samples\n\n'
required_options["SOURCE_FS_ID"]='Error: The source FSx file system ID is required to run this script.
You can get the list of file systems you have access to by running the "list_filesystems" script
found in this GitHub repository: https://github.com/NetApp/FSx-ONTAP-samples-scripts/tree/main/Management-Utilities/Workload-Factory-API-Samples\n\n'
required_options["DESTINATION_SVM_ID"]='Error: The destination SVM ID is required to run this script.
You can get the list of svm IDs by running the "list_svms" script
found in this GitHub repository: https://github.com/NetApp/FSx-ONTAP-samples-scripts/tree/main/Management-Utilities/Workload-Factory-API-Samples\n\n'
required_options["SOURCE_SVM_ID"]='Error: The source SVM ID is required to run this script.
You can get the list of svm IDs by running the "list_svms" script
found in this GitHub repository: https://github.com/NetApp/FSx-ONTAP-samples-scripts/tree/main/Management-Utilities/Workload-Factory-API-Samples\n\n'
required_options["DESTINATION_SVM_NAME"]='Error: The destination SVM name is required to run this script.
You can get the list of svm IDs by running the "list_svms" script
found in this GitHub repository: https://github.com/NetApp/FSx-ONTAP-samples-scripts/tree/main/Management-Utilities/Workload-Factory-API-Samples\n\n'
required_options["SOURCE_SVM_NAME"]='Error: The source SVM name is required to run this script.
You can get the list of svm IDs by running the "list_svms" script
found in this GitHub repository: https://github.com/NetApp/FSx-ONTAP-samples-scripts/tree/main/Management-Utilities/Workload-Factory-API-Samples\n\n'
required_options["SOURCE_VOLUME"]='Error: The source volume name is required to run this script.
You can get the list of volumes by running the "list_volumes" script
found in this GitHub repository: https://github.com/NetApp/FSx-ONTAP-samples-scripts/tree/main/Management-Utilities/Workload-Factory-API-Samples\n\n'

check_required_options
#
# Check that the parameters are valid.
case "$SOURCE_TYPE" in
  "FSx") SOURCE_TYPE="FileSystem" ;;
  "on-prem") SOURCE_TYPE="OnPrem" ;;
  *) echo "Error: Invalid destination type '$SOURCE_TYPE'. Must be either 'FSx' or 'on-prem'." >&2
    usage ;;
esac
case "$DESTINATION_TYPE" in
  "FSx") DESTINATION_TYPE="FileSystem" ;;
  "on-prem") DESTINATION_TYPE="OnPrem" ;;
  *) echo "Error: Invalid destination type '$DESTINATION_TYPE'. Must be either 'FSx' or 'on-prem'." >&2
    usage ;;
esac
#
# Check that the required commands are available.
for cmd in jq curl; do
  if ! command -v $cmd &> /dev/null; then
    echo "Error: The required command '$cmd' was not found. Please install it." >&2
    exit 1
  fi
done

token=$(get_token)
if [ -z "$token" ]; then
  echo "Error: Failed to obtain an access token. Exiting." >&2
  exit 1
fi

run_curl POST "$token" "https://api.workloads.netapp.com/accounts/${BLUEXP_ACCOUNT_ID}/fsx/v2/replication" \
  $tmpout $tmperr \
  '{"source": {
      "type":"'${SOURCE_TYPE}'",
      "id":"'${SOURCE_FS_ID}'",
      "credentialsId":"'${SOURCE_CREDENTIALS_ID}'",
      "region":"'${SOURCE_AWS_REGION}'",
      "volumes": [
        {
          "name":"'${SOURCE_VOLUME}'",
          "svmName":"'${SOURCE_SVM_NAME}'",
          "svmId":"'${SOURCE_SVM_ID}'"
        }
      ]
    },
    "destination": {
      "type":"'${DESTINATION_TYPE}'",
      "id":"'${DESTINATION_FS_ID}'",
      "credentialsId":"'${DESTINATION_CREDENTIALS_ID}'",
      "region":"'${DESTINATION_AWS_REGION}'",
      "svm": {"id":"'${DESTINATION_SVM_ID}'", "name":"'${DESTINATION_SVM_NAME}'"},
      "volume": {"tieringPolicy": {"coolingPeriod": 2, "name": "AUTO"}}
    },
    "throttle":'${THROTTLE}',
    "schedule": "'${SCHEDULE}'"
  }'