volume_create

#!/bin/bash
#
################################################################################
# This script is used to create a volume on an ONTAP file system.
#
# 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 volume on an ONTAP file system.

Usage: $(basename $0) -t refresh_token -a blueXP_account_ID -c credentials_ID -r aws_region -f filesystem_ID -s svm_id -v volume_name -z size [-S securityStyle] [-j junction_path]

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
       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
       aws_region        - is the AWS region where the FSx file systems are located
       filesystem_id     - is the AWS file system ID of the FSx file system where the volume resides
       svm_id            - is the name of the SVM where the volume will be created.
       volume_name       - is the name you want assigned to the new volume.
       size              - is the size, in Megabytes, of the volume to create.
       securityStyle     - is the security style for the volume. It can be either UNIX, NTFS or MIXED. The default is UNIX.
       junction_path     - is the junction path for the volume.

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>
    export CREDENTIALS_ID=<credentials_ID>
    export AWS_REGION=<aws_region>
EOF
  exit 1
}

################################################################################
# Main logic starts here.
################################################################################
tmpout=$(mktemp /tmp/create_share-out.XXXXXX)
tmperr=$(mktemp /tmp/create_share-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 command line options.
SECURITY_STYLE="UNIX"
while getopts "ht:a:c:r:f:s:v:z:S:j:" opt; do
  case $opt in
    t) REFRESH_TOKEN="$OPTARG" ;;
    a) BLUEXP_ACCOUNT_ID="$OPTARG" ;;
    c) CREDENTIALS_ID="$OPTARG" ;;
    r) AWS_REGION="$OPTARG" ;;
    f) FILESYSTEM_ID="$OPTARG" ;;
    s) SVM_ID="$OPTARG" ;;
    v) VOLUME_NAME="$OPTARG" ;;
    z) SIZE="$OPTARG" ;;
    S) SECURITY_STYLE="$OPTARG" ;;
    j) JUNCTION_PATH='"junctionPath": "'$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 token 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["CREDENTIALS_ID"]='Error: A Worload Factory Credential ID is required to run this script.
You can get a list of credentials 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["AWS_REGION"]='Error: The AWS region where the file system is located is required.\n\n'
required_options["FILESYSTEM_ID"]='Error: The ID of the FSxN file system is required.\n\n'
required_options["SVM_ID"]='Error: The ID of the SVM where the volume will be created is required.\n\n'
required_options["VOLUME_NAME"]='Error: The name of the volume to create is required.\n\n'
required_options["SIZE"]='Error: The size of the volume to create is required.\n\n'

check_required_options
#
# Check if 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

data='{
  "name": "'$VOLUME_NAME'",
  "region": "'$AWS_REGION'",
  "credentialsId": "'$CREDENTIALS_ID'",
  "fileSystemId": "'$FILESYSTEM_ID'",
  '$JUNCTION_PATH'
  "size": {"value": '$SIZE', "unit": "MiB"},
  "svmId": "'$SVM_ID'",
  "securityStyle": "'$SECURITY_STYLE'"
}'
#
# Create the volume
run_curl POST "$token" "https://api.workloads.netapp.com/accounts/${BLUEXP_ACCOUNT_ID}/fsx/v2/volumes" $tmpout $tmperr "$data"