Made modifications after additional testing.

Author: kcantrel

CloudFormation/NetApp-FSxN-Extensions/README.md

@@ -100,3 +100,19 @@ Once you have done this, you are ready to start using the examples in this repos
 |create_sm_without_peering.yaml|Creates a SnapMirror relationship with a specified source volume. It assumes that there is already a peering relationship between the source and destination clusters and vservers.|
 |create_snapshot.yaml|Creates a snapshot of an FSx for NetApp ONTAP volume.|
 |create_volume.yaml|Creates an FSx for NetApp ONTAP volume.|
+
+## 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.
+
+© 2025 NetApp, Inc. All Rights Reserved.

CloudFormation/NetApp-FSxN-Extensions/create_sm_with_peering.yaml

@@ -1,4 +1,4 @@
-Description: "Create a SM relationship between two volumes. Includes peering the clusters and vservers."
+Description: "Create a SM relationship between two volumes. Includes peering the clusters and vservers. It assumes the destination volume does not exist and will create it."
 
 Parameters:
   SourceLinkArn:
@@ -51,8 +51,8 @@ Parameters:
     Description: "The name of the destination volume."
     Type: String
 
-  DestinationAggregates:
-    Description: "The aggregates to use when creating the destination volume."
+  DestinationAggregate:
+    Description: "The aggregate to use when creating the destination volume."
     Type: CommaDelimitedList
     Default: "aggr1"
 
@@ -98,7 +98,7 @@ Resources:
         Volume: !Ref DestinationVolumeName
 
       SnapMirrorDestinationCreation:
-        Aggregates: !Ref DestinationAggregates
+        Aggregates: !Ref DestinationAggregate
 
       Policy: !Ref Policy
       Reverse: !Ref Reverse

CloudFormation/NetApp-FSxN-Extensions/create_sm_without_peering.yaml

@@ -1,4 +1,4 @@
-Description: "Create a SM relationship between two volumes. Assumes that the cluster and vservers are already peered."
+Description: "Create a SM relationship between two volumes. Assumes that the cluster and vservers are already peered and the destintion volume does not already exist."
 
 Parameters:
   SourceLinkArn:
@@ -51,8 +51,8 @@ Parameters:
     Description: "The name of the destination volume."
     Type: String
 
-  DestinationAggregates:
-    Description: "The aggregates to use to create the destination volume. If you don't specify an aggregate, then the destination volume should already exist."
+  DestinationAggregate:
+    Description: "The aggregates to use to create the destination volume. Default is aggr1."
     Type: CommaDelimitedList
     Default: "aggr1"
 
@@ -97,7 +97,7 @@ Resources:
         Volume: !Ref DestinationVolumeName
 
       SnapMirrorDestinationCreation:
-        Aggregates: !Ref DestinationAggregates
+        Aggregates: !Ref DestinationAggregate
 
       Policy: !Ref Policy
       Reverse: !Ref Reverse

CloudFormation/NetApp-FSxN-Extensions/create_volume.yaml

@@ -28,38 +28,57 @@ Parameters:
 
   Size:
     Description: "The size of the volume in bytes."
-    Default: 20971520
     Type: Number
+    Default: 20971520
+    MinValue: 20971520
 
   Aggregates:
     Description: "The aggregates to use."
     Type: CommaDelimitedList
 
   AutoSizeMode:
-    Description: "The mode of the auto size. The supported values are 'grow', 'grown_shrink' or 'off'."
-    Default: "off"
+    Description: "The mode of the auto size. The supported values are 'grow', 'grow_shrink' or 'off'."
     Type: String
+    AllowedValues: ["off", "grow", "grow_shrink"]
+    Default: "off"
 
   MinimumShrinkSize:
     Description: "The minimum size the volume can shrink to in bytes."
-    Default: 20971520
     Type: Number
+    MinValue: 20971520
+    Default: 20971520
 
   MaximumGrowSize:
-    Description: "The maximum size of the volume can grow to in bytes."
-    Default: 107374182400
     Type: Number
+    Description: "The maximum size of the volume can grow to in bytes. Default is a 160TB."
+    Default: 175921860444160
 
   GrowThresholdPercentage:
     Description: "The percentage of the volume size at which the volume is considered full."
     Default: 80
+    MaxValue: 100
+    MinValue: 0
     Type: Number
 
   ShrinkThresholdPercentage:
     Description: "The percentage of the volume size at which the volume is considered empty."
     Default: 50
+    MaxValue: 100
+    MinValue: 0
     Type: Number
 
+  State:
+    Description: "The state of the volume. Either 'online', 'offline' or 'restricted'. Defaults to 'online'."
+    Type: String
+    Default: "online"
+    AllowedValues: ["online", "offline", "restricted"]
+
+  Type:
+    Description: "The type of the volume. Either 'rw' or 'dp'. Defaults to 'rw'."
+    Type: String
+    Default: "rw"
+    AllowedValues: ["rw", "dp"]
+
 Resources:
   FSxNVolume:
     Type: "NetApp::FSxN::Volume"
@@ -77,6 +96,8 @@ Resources:
 
       Size: !Ref Size
       Aggregates: !Ref Aggregates
+      State: !Ref State
+      Type: !Ref Type
 
       Autosize:
         Mode: !Ref AutoSizeMode

CloudFormation/NetApp-FSxN-Extensions/scripts/README.md

@@ -15,3 +15,19 @@ There are also a couple scripts that can be used to help enable the NetApp FSxN
 |deactivate_extensions | This script will deactivate all the NetApp FSxN CloudFormation extensions in the AWS account for a specific region.|
 |deploy_link | This script will use CloudFormation to deploy a Workload Factory Link.|
 |createClone.py | This is a Python script that will create a clone of a volume using boto to deploy a CloudFormation stack that creates a clone.|
+
+## 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.
+
+© 2025 NetApp, Inc. All Rights Reserved.

CloudFormation/NetApp-FSxN-Extensions/scripts/activate_extensions

@@ -1,7 +1,7 @@
 #!/bin/bash
 #
 # This script is used to activate all the NetApp FSxN CloudFormation
-# extenstions.
+# custom resources.
 ################################################################################
 #
 ################################################################################

CloudFormation/NetApp-FSxN-Extensions/scripts/create_SM_relationship

@@ -4,20 +4,22 @@
 # This script is used to create a SnapMirror relationship between two volumes 
 # in two different SVMs in two different file systems. It is dependent on a
 # a CloudFormation template that uses the NetApp CloudFormation extension. The
-# template should be passed as a parameter to this script.
+# template should be passed as a parameter to this script. The template
+# assumes that the destination volume does not already exist.
 ################################################################################
 
 ################################################################################
 ################################################################################
 usage () {
 cat <<EOF
-Usage: $(basename $0) [--region region] --source-link-arn linkArn --source-secret-arn secretArn [--source-secret-key password] --source-fsx fsxId --source-svm svmName  --source-vol volName \
-                                          --dest-link-arn linkArn   --dest-secret_arn secretAnr   [--dest-sceret-key password]   --dest-fsx FsxId   --dest-svm svmName [--dest-vol volName_dp] \
-                       --template templete_filename
+Usage: $(basename $0) [--region region] --source-link-arn link_arn --source-secret-arn secret_arn [--source-secret-key password] --source-fsx fsx_id --source-svm svm_name  --source-vol vol_name \\
+                                          --dest-link-arn link_arn   --dest-secret-arn secret_arn   [--dest-sceret-key password]   --dest-fsx fsx_id   --dest-svm svm_name [--dest-vol vol_name_dp] \\
+                               --template templete_filename [--dest-aggr aggregate1]
 Notes:
-  The default regions is whatever the default region is in the AWS CLI configuration.
+  The default region is whatever the default region is in the AWS CLI configuration.
   The default secret key is 'password'.
   The default destination volume name is the source volume name with '_dp' appended.
+  The default aggregate is 'aggr1'.
 EOF
 }
 #
@@ -33,6 +35,7 @@ destinationSecretArn=""
 destinationSecretKey="password"
 destinationFsxId=""
 destinationSvmName=""
+destinationAggregate="aggr1"
 template=""
 #
 # Get the default region from the AWS CLI configuration
@@ -79,6 +82,9 @@ while [ ! -z "$1" ]; do
   elif [ "$1" == "--dest-vol" ]; then
     destinationVolumeName=$2
     shift 1
+  elif [ "$1" == "--dest-aggrs" ]; then
+    destinationAggregate=$2
+    shift 1
   elif [ "$1" == "--template" ]; then
     template=$2
     shift 1
@@ -90,7 +96,7 @@ while [ ! -z "$1" ]; do
   shift 1
 done
 
-if [ -z "destinationVolumeName" ]; then
+if [ -z "$destinationVolumeName" ]; then
   destinationVolumeName="${sourceVolumeName}_dp"
 fi
 
@@ -121,4 +127,5 @@ aws cloudformation create-stack --region $region --stack-name $stackName --templ
   ParameterKey=DestinationSecretKey,ParameterValue=$destinationSecretKey \
   ParameterKey=DestinationFileSystemId,ParameterValue=$destinationFsxId \
   ParameterKey=DestinationSvmName,ParameterValue=$destinationSvmName \
-  ParameterKey=DestinationVolumeName,ParameterValue=$destinationVolumeName 
+  ParameterKey=DestinationVolumeName,ParameterValue=$destinationVolumeName \
+  ParameterKey=DestinationAggregate,ParameterValue=$destinationAggregate

CloudFormation/NetApp-FSxN-Extensions/scripts/create_clone

@@ -1,18 +1,19 @@
 #!/bin/bash
 #
 ################################################################################
-# This script create a clnne of a volume in a NetApp ONTAP file system.
+# This script creates a clone of a volume in a Fsx for ONTAP file system by
+# using the custom NetApp CloudFormation NetApp::FSxN::Volume resource.
 ################################################################################
 
 ################################################################################
 ################################################################################
 usage () {
 cat <<EOF
-Usage: $(basename $0) [-r region] -l linkArn -s secretArn [-k secretKey] -f fsxId -v svmName -p parentVolumeName [-c cloneVolumeName] -t templete_filename
+Usage: $(basename $0) [-r region] -l link_arn -s secret_arn [-k secretKey] -f fsx_id -v svm_name -p parent_volume_name [-c clone_volume_name] -t templete_filename
 Notes:
     The default region is whatever the default region is for the AWS CLI.
-    The secretKey defaults to 'password'.
-    The cloneVolumeName defaults to the parentVolumeName with '_clone' appended.
+    The default secretKey is 'password'.
+    The clone_volume_name defaults to the parent_volume_name with '_clone' appended.
 EOF
 }
 #
@@ -69,7 +70,6 @@ if [ -z "$cloneVolumeName" ]; then
 fi
 
 if [ -z "$linkArn" -o -z "$region" -o -z "$secretArn" -o -z "$fsxId" -o -z "$svmName" -o -z "$parentVolumeName" -o -z "$template" ]; then
-  echo linkARN="$linkArn" region="$region" secretnArn="$secretArn" fsxid="$fsxId" svm="$svmName" par="$parentVolumeName" tempate="$template"
   echo "Missing required arguments."
   usage
   exit 1

CloudFormation/NetApp-FSxN-Extensions/scripts/create_export_policy

@@ -3,14 +3,15 @@
 ################################################################################
 # This script creates an export policy for an FSx for ONTAP file system.
 # It is dependent on a CloudFormation template that uses the NetApp
-# CloudFormation extensions. The template should be passed in as an argument.
+# CloudFormation custom resources. The template should be passed in as an
+# argument.
 ################################################################################
 
 ################################################################################
 ################################################################################
 usage () {
 cat <<EOF
-Usage: $(basename $0) [-r region] -l link_ARN -s secret_ARN -k secret_key -f fsxId -v svm_name -n policy_name [-p protocols] -c match_CIDR -t templete_filename
+Usage: $(basename $0) [-r region] -l link_ARN -s secret_ARN -k secret_key -f fsx_id -v svm_name -n policy_name [-p protocols] -c match_CIDR -t templete_filename
 Notes:
     The default region is whatever the default region is set in the AWS CLI.
     The default protocols is "any"

CloudFormation/NetApp-FSxN-Extensions/scripts/create_snapshot

@@ -3,14 +3,14 @@
 ################################################################################
 # This script creates a snapshot of an FSx for ONTAP volume.
 # It is dependent of a CloudFormation template that uses the
-# Netapp CloudFormation extension. The template is passed as an argument.
+# Netapp CloudFormation custom resources. The template is passed as an argument.
 ################################################################################
 
 ################################################################################
 ################################################################################
 usage () {
 cat <<EOF
-Usage: $(basename $0) [-r region] -l link_ARN -s secret_ARN [-k secret_key] -f FSx_Id -v svm_name -n volume_name -p snapshot_name -t templete_filename
+Usage: $(basename $0) [-r region] -l link_ARN -s secret_ARN [-k secret_key] -f fsx_id -v svm_name -n volume_name -p snapshot_name -t templete_filename
 Notes:
   The default region is the region configured in the AWS CLI.
   The default secret key is 'password'.