Managing FSx for ONTAP file systems - FSx for ONTAP

Managing FSx for ONTAP file systems

A file system is the primary FSx for ONTAP resource, analogous to a NetApp ONTAP cluster. You create a file system in a particular virtual private cloud (VPC), and specify the file system's primary storage capacity and throughput capacity at creation. If you enable data-tiering, data stored in a file system can be transferred to lower-cost storage.

Creating FSx for ONTAP file systems

By default, when you create a new file system from the AWS Management Console, Amazon FSx automatically creates a file system with a single storage virtual machine (SVM) and one volume, allowing for quick access to data from Linux instances over the Network File System (NFS) protocol. When creating the file system, you can optionally join the SVM to an Active Directory to enable access from Windows and macOS clients over the Server Message Block (SMB) protocol. After your file system is created, you can create additional SVMs and volumes as needed.

You can create an FSx for ONTAP file system using the Amazon FSx console, AWS CLI, or the Amazon FSx API.

This procedure uses the Standard create creation option to create an FSx for ONTAP file system with a configuration that you customize for your needs. For information about using the Quick create creation option to rapidly create a file system with a default set of configuration parameters, see Step 1: Create an Amazon FSx for NetApp ONTAP file system.

  1. Open the Amazon FSx console at https://console.aws.amazon.com/fsx/.

  2. On the dashboard, choose Create file system to start the file system creation wizard.

  3. On the Select file system type page, choose Amazon FSx for NetApp ONTAP, and then choose Next. The Create file system page appears.

  4. For Creation method, choose Standard create.

    Begin your configuration with the File system details section.

    
                                    Standard create File system basics
                                        section, showing options for file system parameters such as
                                        name, SSD storage capacity, and throughput
                                        capacity.
  5. For File system name - optional, enter a name for your file system. It's easier to find and manage your file systems when you name them. You can use a maximum of 256 Unicode letters, white space, and numbers, plus these special characters: + - = . _ : /

  6. For SSD storage capacity, enter the storage capacity of your file system, in GB. Enter any whole number in the range of 1024–196608.

  7. For Provisioned SSD IOPS, you have two options to provision the number of IOPS for your file system:

    • Choose Automatic (the default) if you want Amazon FSx to automatically provision 3 IOPS per GB of SSD storage.

    • Choose User-provisioned if you want to specify the number of IOPS. You can provision a maximum of 80,000 SSD IOPS per file system.

  8. For Throughput capacity, choose a value that is your desired throughput capacity in MB per second (MBps). Throughput capacity is the sustained speed at which the file server that hosts your file system can serve data. The Recommended value is based on the amount of storage capacity that you chose. For more information, see Amazon FSx for NetApp ONTAP performance.

  9. In the Networking section, for Virtual Private Cloud (VPC), choose the VPC that you want to associate with your file system.

  10. Each file system has a primary file server and a standby file server, each in a separate AWS Availability Zone and subnet. For the primary file server, choose a Preferred subnet value. For the standby file server, choose a Standby subnet value.

  11. For VPC route tables, specify the VPC route tables in which your file system's endpoints will be created. You should select all VPC route tables associated with the subnets in which your clients are located. By default, Amazon FSx selects your VPC's default route table.

  12. Endpoint IP address range specifies the IP address range in which the endpoints to access your file system will be created. You have two options to create the IP address range:

    • If you want Amazon FSx to choose an unused IP address range for you from the 198.19.0.0/16 range, choose No preference.

      Note

      By default, FSx for ONTAP uses 198.19.0.0/16 as the default endpoint IP address range for the file system. This IP address range is also used by Amazon WorkSpaces for management traffic range, as described in IP address and port requirements for WorkSpaces in the Amazon WorkSpaces Administration Guide. If you intend to use WorkSpaces, you must select a non-overlapping endpoint IP address range for your FSx for ONTAP file system.

    • If you want to provide the address range, choose Select an IP address range.

      Note

      Do not choose the following ranges, as they are incompatible with FSx for ONTAP:

      • 0.0.0.0/8

      • 127.0.0.0/8

      • 198.19.0.0/20

      • 224.0.0.0/4

      • 240.0.0.0/4

      • 255.255.255.255/32

  13. In the Security & encryption section, for Encryption key, choose the AWS Key Management Service (AWS KMS) encryption key that protects your file system's data at rest.

  14. For File system administrative password, enter a secure password for the fsxadmin user. Confirm the password.

    You can use the fsxadmin user to administer your file system using the ONTAP CLI and REST API. For more information about the fsxadmin user, see Managing file systems with the NetApp ONTAP CLI.

  15. In the Default storage virtual machine configuration section, provide the following information:

    • In the Storage virtual machine name field, provide a name for the storage virtual machine. You can use a maximum of 47 alphanumeric characters, plus the underscore (_) special character.

    • For SVM administrative password, you can optionally choose Specify a password and provide a password for the SVM's vsadmin user. You can use the vsadmin user to administer the SVM using the ONTAP CLI or REST API. For more information about the vsadmin user, see Managing SVMs using the NetApp ONTAP CLI.

      If you choose Don't specify a password (the default), you can still use the file system's fsxadmin user to manage your file system using the ONTAP CLI or REST API, but you can't use your SVM's vsadmin user to do the same.

    • In the Active Directory section, you can join an Active Directory to the SVM. Joining an Active Directory provides user authentication and access control for Windows and macOS clients accessing the file system.

      If you don't want to join your SVM to an Active Directory, choose Do not join an Active Directory.

      If you want to join your SVM to a self-managed Active Directory domain, choose Join an Active Directory, and provide the following details for your Active Directory:

      • The NetBIOS name of the Active Directory computer object to create for your SVM. The NetBIOS name cannot exceed 15 characters.

      • The fully qualified domain name of your Active Directory. The domain name cannot exceed 255 characters.

      • DNS server IP addresses – The IPv4 addresses of the Domain Name System (DNS) servers for your domain.

      • Service account username – The user name of the service account in your existing Active Directory. Do not include a domain prefix or suffix.

      • Service account password – The password for the service account.

      • Confirm password – The password for the service account.

      • (Optional) Organizational Unit (OU) – The distinguished path name of the organizational unit to which you want to join your file system.

      • (Optional) Delegated file system administrators group – The name of the group in your Active Directory that can administer your file system. The default group is Domain Admins.

  16. In Backup and maintenance - optional, you can set the following options:

    • For Daily automatic backup, choose Enabled for automatic daily backups. This option is enabled by default.

    • For Daily automatic backup window, set the time of the day in Coordinated Universal Time (UTC) that you want the daily automatic backup window to start. The window is 30 minutes starting from this specified time. This window can't overlap with the weekly maintenance backup window.

    • For Automatic backup retention period, set a period from 1–90 days that you want to retain automatic backups.

    • For Weekly maintenance window, you can set the time of the week that you want the maintenance window to start. Day 1 is Monday, 2 is Tuesday, and so on. The window is 30 minutes starting from this specified time. This window can't overlap with the daily automatic backup window.

  17. For Tags - optional, you can enter a key and value to add tags to your file system. A tag is a case-sensitive key-value pair that helps you manage, filter, and search for your file system.

    Choose Next.

  18. Review the file system configuration shown on the Create file system page. For your reference, note which file system settings you can modify after the file system is created.

  19. Choose Create file system.

  • To create an FSx for ONTAP file system, use the create-file-system CLI command (or the equivalent CreateFileSystem API operation), as shown in the following example.

    aws fsx create-file-system \ --file-system-type ONTAP \ --storage-capacity 1024 \ --storage-type SSD \ --security-group-ids security-group-id \ --subnet-ids subnet-id1 subnet-id2 \ --ontap-configuration DeploymentType=MULTI_AZ_HA_1,ThroughputCapacity=512,PreferredSubnetId=subnet-id1
Note

If you use the EndpointIpAddressRange parameter, don't specify any of the following ranges, as they are incompatible with FSx for ONTAP:

  • 0.0.0.0/8

  • 127.0.0.0/8

  • 198.19.0.0/20

  • 224.0.0.0/4

  • 240.0.0.0/4

  • 255.255.255.255/32

After successfully creating the file system, Amazon FSx returns the file system's description in JSON format.

Note

Unlike the console file creation procedure, the create-file-system CLI command and the CreateFileSystem API operation don't create an SVM and a volume. To create an SVM, see Creating a storage virtual machine; to create a volume, see Creating a volume.

Updating a file system

You can update the configuration of an FSx for ONTAP file system using the Amazon FSx console, the AWS CLI, and the Amazon FSx API.

  1. Open the Amazon FSx console at https://console.aws.amazon.com/fsx/.

  2. In the left navigation pane, choose File systems, and then choose the ONTAP file system that you want to update.

  3. Choose a tab for the setting you want to update. For example:

    • To change the weekly maintenance window or the ONTAP administrative password for the fsxadmin user, choose the Administration tab.

    • To update the daily automatic backup window and the automatic backup retention period, choose the Backups tab.

  4. Choose Update next to a setting and provide the new information in the dialog box.

  • To update the configuration of an FSx for ONTAP file system, use the update-file-system CLI command (or the equivalent UpdateFileSystem API operation), as shown in the following example.

    aws fsx update-file-system \ --file-system-id fs-0123456789abcdef0 \ --ontap-configuration AutomaticBackupRetentionDays=30,DailyAutomaticBackupStartTime=01:00, \ WeeklyMaintenanceStartTime=1:01:30,FSxAdminPassword=new-fsx-admin-password

Deleting a file system

You can delete an FSx for ONTAP file system using the Amazon FSx console, the AWS CLI, and the Amazon FSx API and SDKs.

To delete a file system:

Viewing your file system

You can view the details of your FSx for ONTAP file system using the Amazon FSx console, the AWS CLI, and the Amazon FSx API and SDKs.

To view a file system:

  • Using the console – Choose a file system to view the File systems detail page. The Summary panel shows the file system's ID, lifecycle status, deployment type, SSD storage capacity, throughput capacity, provisioned IOPS, Availability Zones, and creation time.

    The tabs provide detailed information and configuration functions for the file system's features, such as backups, SVMs, and volumes.

  • Using the CLI or API – Use the describe-file-systems CLI command or the DescribeFileSystems API operation.