|
| 1 | +#!/bin/bash |
| 2 | +# |
| 3 | +################################################################################ |
| 4 | +# This script is used to set the credentials for an FSxN file system. |
| 5 | +# |
| 6 | +# It is dependent on the 'wf_utils' file that is included in this repo. That |
| 7 | +# file contains the 'get_token' function that is used to obtain a valid |
| 8 | +# access token that is needed to run the Workload Factory APIs. The file needs |
| 9 | +# to either be in the command search path or in the current directory. |
| 10 | +################################################################################ |
| 11 | +# |
| 12 | +################################################################################ |
| 13 | +# This function displays the usage of this script and exits. |
| 14 | +################################################################################ |
| 15 | +usage() { |
| 16 | + cat >&2 <<EOF |
| 17 | +
|
| 18 | +This script is used to set the credentials for an FSxN file system. |
| 19 | +
|
| 20 | +usage: $(basename $0) -t refresh_token -a blueXP_account_ID -c credentials_ID -r aws_region -f filesystem_ID -u user_ID -p password |
| 21 | +
|
| 22 | +Where: refresh_token - Is a refresh token used to obtain an access token needed |
| 23 | + to run the Workload Factory APIs. You can obtain a refresh |
| 24 | + token by going to https://services.cloud.netapp.com/refresh-token |
| 25 | + blueXP_account_ID - Is the BlueXP account ID. Run 'list_bluexp_accts' to get a |
| 26 | + list of accounts you have access to. |
| 27 | + credentials_ID - Is the Workload Factory credentials ID for the AWS account. |
| 28 | + Run 'list_credentials' to get a list of Workload Factory |
| 29 | + credentials you have access to. |
| 30 | + aws_region - Is the AWS region where the file system is located. |
| 31 | + filesystem_ID - Is the ID of the FSxN file system. |
| 32 | + user_ID - Is the user ID to set for the FSxN file system. |
| 33 | + password - Is the password to set for the FSxN file system. |
| 34 | +
|
| 35 | +Instead of passing parameters on the command line, you can set the |
| 36 | +following environment variables: |
| 37 | +
|
| 38 | + export REFRESH_TOKEN=<refresh_token> |
| 39 | + export BLUEXP_ACCOUNT_ID=<blueXP_account_ID> |
| 40 | + export CREDENTIALS_ID=<credentials_ID> |
| 41 | + export AWS_REGION=<aws_region> |
| 42 | + export FILESYSTEM_ID=<filesystem_ID> |
| 43 | + export USER_ID=<user_ID> |
| 44 | + export PASSWORD=<password> |
| 45 | +EOF |
| 46 | + exit 1 |
| 47 | +} |
| 48 | + |
| 49 | +################################################################################ |
| 50 | +# Main logic starts here. |
| 51 | +################################################################################ |
| 52 | + |
| 53 | +tmpout=$(mktemp /tmp/fsxn_credentials_set-out.XXXXXX) |
| 54 | +tmperr=$(mktemp /tmp/fsxn_credentials_set-err.XXXXXX) |
| 55 | +trap 'rm -f $tmpout $tmperr' exit |
| 56 | +# |
| 57 | +# Source the wf_utils file. |
| 58 | +wf_utils=$(command -v wf_utils) |
| 59 | +if [ -z "$wf_utils" ]; then |
| 60 | + if [ ! -x "./wf_utils" ]; then |
| 61 | + cat >&2 <<EOF |
| 62 | +Error: The 'wf_utils' script was not found in the current directory or in the command search path. |
| 63 | +It is required to run this script. You can download it from: |
| 64 | +https://github.com/NetApp/FSx-ONTAP-samples-scripts/tree/main/Management-Utilities/Workload-Factory-API-Samples |
| 65 | +EOF |
| 66 | + exit 1 |
| 67 | + else |
| 68 | + wf_utils=./wf_utils |
| 69 | + fi |
| 70 | +fi |
| 71 | +. "$wf_utils" |
| 72 | +# |
| 73 | +# Process command line options. |
| 74 | +while getopts "ht:a:c:r:f:u:p:" opt; do |
| 75 | + case $opt in |
| 76 | + t) REFRESH_TOKEN="$OPTARG" ;; |
| 77 | + a) BLUEXP_ACCOUNT_ID="$OPTARG" ;; |
| 78 | + c) CREDENTIALS_ID="$OPTARG" ;; |
| 79 | + r) AWS_REGION="$OPTARG" ;; |
| 80 | + f) FILESYSTEM_ID="$OPTARG" ;; |
| 81 | + u) USER_ID="$OPTARG" ;; |
| 82 | + p) PASSWORD="$OPTARG" ;; |
| 83 | + *) usage ;; |
| 84 | + esac |
| 85 | +done |
| 86 | +# |
| 87 | +# Declare an array of required options and the error message to display if they are not set. |
| 88 | +declare -A required_options |
| 89 | +required_options["REFRESH_TOKEN"]='Error: A BlueXP refresh tokon is required to run this script. It can be obtain from this web page: |
| 90 | + https://services.cloud.netapp.com/refresh-token\n\n' |
| 91 | +required_options["BLUEXP_ACCOUNT_ID"]='Error: A BlueXP account ID is required to run this script. |
| 92 | +You can get the list of accounts you have access to by running the "list_bluexp_accts" script |
| 93 | +found in this GitHub repository: https://github.com/NetApp/FSx-ONTAP-samples-scripts/tree/main/Management-Utilities/Workload-Factory-API-Samples\n\n' |
| 94 | +required_options["CREDENTIALS_ID"]='Error: The ID of the credentials to delete is required. |
| 95 | +You can get a list of credentials by running the "list_credentials" script |
| 96 | +found in this GitHub repository: https://github.com/NetApp/FSx-ONTAP-samples-scripts/tree/main/Management-Utilities/Workload-Factory-API-Samples\n\n' |
| 97 | +required_options["AWS_REGION"]='Error: The AWS region where the file system is located is required.\n\n' |
| 98 | +required_options["FILESYSTEM_ID"]='Error: The ID of the FSxN file system is required.\n\n' |
| 99 | +required_options["USER_ID"]='Error: The user ID to set for the FSxN file system is required.\n\n' |
| 100 | +required_options["PASSWORD"]='Error: The password to set for the FSxN file system is required.\n\n' |
| 101 | + |
| 102 | +check_required_options |
| 103 | +# |
| 104 | +# Check that the required commands are available. |
| 105 | +for cmd in jq curl; do |
| 106 | + if ! command -v $cmd &> /dev/null; then |
| 107 | + echo "Error: The required command '$cmd' was not found. Please install it." >&2 |
| 108 | + exit 1 |
| 109 | + fi |
| 110 | +done |
| 111 | +# |
| 112 | +# Get the token to use for the API call. |
| 113 | +token=$(get_token) |
| 114 | +if [ -z "$token" ]; then |
| 115 | + echo "Error: Failed to obtain an access token. Exiting." >&2 |
| 116 | + exit 1 |
| 117 | +fi |
| 118 | +run_curl POST "$token" "https://api.workloads.netapp.com/accounts/${BLUEXP_ACCOUNT_ID}/fsx/v2/credentials/${CREDENTIALS_ID}/regions/${AWS_REGION}/file-systems/${FILESYSTEM_ID}/ontap-credentials" "$tmpout" "$tmperr" '{"user":"'${USER_ID}'","password":"'${PASSWORD}'","resetFsxAdminPassword":false}' |
0 commit comments