Managing FSx for ONTAP storage virtual machines - FSx for ONTAP

Managing FSx for ONTAP storage virtual machines

You can create one or multiple storage virtual machines (SVMs) on each FSx for ONTAP file system. Each SVM is a virtual, isolated file server with its own administrative credentials and IP address for accessing data.

Every storage virtual machine has a root volume (/) that resides at the top level of the namespace hierarchy and contains junction paths (also known as mount points) for the volumes that you create in your SVM. We recommend that you not store user data in the root volume, but you can create additional volumes within your storage virtual machine at any time.

You can optionally join your storage virtual machines to your organization's Active Directory during the SVM's creation. Joining an SVM to your Active Directory enables your users to use their existing AD-based identities to authenticate and access FSx for ONTAP over the Network File System (NFS) or Server Message Block (SMB) protocol.

Creating a storage virtual machine

You can create an FSx for ONTAP SVM using the Amazon FSx console, the AWS CLI, and the Amazon FSx API, as well as the NetApp ONTAP command-line interface (CLI) and REST API.

The maximum number of SVMs you can create for a file system depends on the amount of throughput capacity provisioned. For more information, see Storage virtual machines (SVM).

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

  2. In the left navigation pane, choose Storage virtual machines.

  3. Choose Create new storage virtual machine.

    The Create new storage virtual machine dialog box appears.

    
                                    The Create new storage virtual machine
                                            (SVM) dialog box.
  4. For File system, choose the file system to create the storage virtual machine on.

  5. 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.

  6. For SVM administrative password, you can optionally choose Specify a password and provide a password for this 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 9.9.1 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.

  7. For Active Directory, you have the following options:

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

    • If you want to join your file system 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.

  8. For SVM root volume security style, choose the security style for the SVM depending on the type of clients that will access your data. Choose Unix (Linux) if you will primarily access your data using Linux clients; choose NTFS if you will primarily access your data using Windows clients.

  9. Choose Confirm to create the storage virtual machine.

You can monitor the update progress on the File systems detail page, in the Status column of the Storage virtual machines pane. The storage virtual machine is ready for use when its status is Created.

  • To create an FSx for ONTAP storage virtual machine (SVM), use the create-storage-virtual-machine CLI command (or the equivalent CreateStorageVirtualMachine API operation), as shown in the following example.

    aws fsx create-storage-virtual-machine \ --file-system-id fs-0123456789abcdef0 \ --name vol1 \ --svm-admin-password password \ --ontap-configuration SelfManagedActiveDirectoryConfiguration='{DomainName="corp.example.com", \ OrganizationalUnitDistinguishedName="OU=FileSystems,DC=corp,DC=example,DC=com",FileSystemAdministratorsGroup="FSxAdmins", \ UserName="FSxService",Password="password", \ DnsIps=["10.0.1.18"]}',NetBiosName=amznfsx12345

After successfully creating the storage virtual machine, Amazon FSx returns its description in JSON format.

Updating a storage virtual machine

You can update the configuration of an FSx for ONTAP storage virtual machine using the Amazon FSx console, the AWS CLI, and the Amazon FSx API, in addition to the NetApp ONTAP command line interface (CLI) and REST 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 a storage virtual machine for.

  3. Choose the Storage virtual machines tab.

  4. Choose the storage virtual machine that you want to update.

  5. For Actions, choose Update storage virtual machine.

  6. For SVM administrative password, you can choose Specify a password and provide a new password for this SVM's vsadmin user. You can use the vsadmin user to administer your SVM using the ONTAP CLI or REST API.

    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.

  7. For Active Directory, you can update the following properties of your Active Directory configuration:

    • 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.

  8. Choose Confirm to update the storage virtual machine.

  • To update the configuration of an FSx for ONTAP volume, use the update-storage-virtual-machine CLI command (or the equivalent UpdateStorageVirtualMachine API operation), as shown in the following example.

    aws fsx update-storage-virtual-machine \ --storage-virtual-machine-id svm-5ab87160b8e4ad90d \ --svm-admin-password new-svm-password \ --ontap-configuration SelfManagedActiveDirectoryConfiguration='{UserName="new-user-name", \ Password="new-password", DnsIps=["10.0.1.28"]}'

Deleting a storage virtual machine

You can delete an FSx for ONTAP storage virtual machine (SVM) using the Amazon FSx console, the AWS CLI, and the Amazon FSx API, in addition to the NetApp ONTAP command line interface (CLI) and REST API.

Note

Before you delete a storage virtual machine, make sure that no applications are accessing the data in the SVM that you want to delete and that you have deleted all non-root volumes.

  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 delete an SVM from.

  3. Choose the Storage virtual machines tab.

  4. Choose the storage virtual machine that you want to delete.

  5. For Actions, choose Delete storage virtual machine.

  6. In the delete confirmation dialog box, choose Delete storage virtual machines.

  • To delete an FSx for ONTAP storage virtual machine, use the delete-storage-virtual-machine CLI command (or the equivalent DeleteStorageVirtualMachine API operation), as shown in the following example.

    aws fsx delete-storage-virtual-machine --storage-virtual-machine-id svm-5ab87160b8e4ad90d

Viewing a storage virtual machine

You can see the FSx for ONTAP storage virtual machines that are currently on your file system using the Amazon FSx console, the AWS CLI, and the Amazon FSx API and SDKs.

To view a storage virtual machine on your file system:

  • Using the console – Choose a file system to view its File systems detail page. To list all the storage virtual machines on the file system, choose the Storage virtual machines tab, and then choose the storage virtual machine that you want to view.

  • Using the CLI or API – Use the delete-storage-virtual-machine CLI command or the DescribeStorageVirtualMachines API operation.