storage_virtual_machines

Creates, updates, deletes, gets or lists a storage_virtual_machines resource.

Overview

Name	storage_virtual_machines
Type	Resource
Id	aws.fsx.storage_virtual_machines

Fields

The following fields are returned by SELECT queries:

describe_storage_virtual_machines

Name	Datatype	Description
active_directory_configuration	object	Describes the Microsoft Active Directory configuration to which the SVM is joined, if applicable.
creation_time	string (date-time)	The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.
endpoints	object	The endpoints that are used to access data or to manage the SVM using the NetApp ONTAP CLI, REST API, or NetApp CloudManager. They are the Iscsi, Management, Nfs, and Smb endpoints.
file_system_id	string	The globally unique ID of the file system, assigned by Amazon FSx. (pattern: <code>^(fs-[0-9a-f]{8,})$</code>)
lifecycle	string	Describes the SVM's lifecycle status. CREATED - The SVM is fully available for use. CREATING - Amazon FSx is creating the new SVM. DELETING - Amazon FSx is deleting an existing SVM. FAILED - Amazon FSx was unable to create the SVM. MISCONFIGURED - The SVM is in a failed but recoverable state. PENDING - Amazon FSx has not started creating the SVM. (CREATED, CREATING, DELETING, FAILED, MISCONFIGURED, PENDING)
lifecycle_transition_reason	object	Describes why a resource lifecycle state changed.
name	string	The name of the SVM, if provisioned. (pattern: <code>^[^\u0000\u0085\u2028\u2029\r\n]{1,47}$</code>)
resource_arn	string	The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference. (pattern: <code>^arn:(?=[^:]+:fsx:[^:]+:\d{12}:)((|(?=[a-z0-9-.]{1,63})(?!\d{1,3}(.\d{1,3}){3})(?![^:]-{2})(?![^:]-.)(?![^:].-)[a-z0-9].(?<!-)):){4}(?!/).{0,1024}$</code>)
root_volume_security_style	string	The security style of the root volume of the SVM. (UNIX, NTFS, MIXED)
storage_virtual_machine_id	string	The SVM's system generated unique ID. (pattern: <code>^(svm-[0-9a-f]{17,})$</code>)
subtype	string	Describes the SVM's subtype. (DEFAULT, DP_DESTINATION, SYNC_DESTINATION, SYNC_SOURCE)
tags	array	A list of Tag values, with a maximum of 50 elements.
uuid	string	The SVM's UUID (universally unique identifier). (pattern: <code>^[^\u0000\u0085\u2028\u2029\r\n]{1,36}$</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_storage_virtual_machines	select	region		Describes one or more Amazon FSx for NetApp ONTAP storage virtual machines (SVMs).
create_storage_virtual_machine	insert	region, FileSystemId		Creates a storage virtual machine (SVM) for an Amazon FSx for ONTAP file system.
update_storage_virtual_machine	update	region, StorageVirtualMachineId		Updates an FSx for ONTAP storage virtual machine (SVM).
delete_storage_virtual_machine	delete	region		Deletes an existing Amazon FSx for ONTAP storage virtual machine (SVM). Prior to deleting an SVM, you must delete all non-root volumes in the SVM, otherwise the operation will fail.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_storage_virtual_machines

Describes one or more Amazon FSx for NetApp ONTAP storage virtual machines (SVMs).

SELECT
active_directory_configuration,
creation_time,
endpoints,
file_system_id,
lifecycle,
lifecycle_transition_reason,
name,
resource_arn,
root_volume_security_style,
storage_virtual_machine_id,
subtype,
tags,
uuid
FROM aws.fsx.storage_virtual_machines
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_storage_virtual_machine

Creates a storage virtual machine (SVM) for an Amazon FSx for ONTAP file system.

INSERT INTO aws.fsx.storage_virtual_machines (
ActiveDirectoryConfiguration,
ClientRequestToken,
FileSystemId,
Name,
SvmAdminPassword,
Tags,
RootVolumeSecurityStyle,
region
)
SELECT 
'{{ ActiveDirectoryConfiguration }}',
'{{ ClientRequestToken }}',
'{{ FileSystemId }}' /* required */,
'{{ Name }}',
'{{ SvmAdminPassword }}',
'{{ Tags }}',
'{{ RootVolumeSecurityStyle }}',
'{{ region }}'
RETURNING
storage_virtual_machine
;

Manifest

# Description fields are for documentation purposes
- name: storage_virtual_machines
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the storage_virtual_machines resource.
  - name: ActiveDirectoryConfiguration
    description: |
      Describes the self-managed Microsoft Active Directory to which you want to join the SVM. Joining an Active Directory provides user authentication and access control for SMB clients, including Microsoft Windows and macOS clients accessing the file system.
    value:
      NetBiosName: "{{ NetBiosName }}"
      SelfManagedActiveDirectoryConfiguration:
        DomainName: "{{ DomainName }}"
        OrganizationalUnitDistinguishedName: "{{ OrganizationalUnitDistinguishedName }}"
        FileSystemAdministratorsGroup: "{{ FileSystemAdministratorsGroup }}"
        UserName: "{{ UserName }}"
        Password: "{{ Password }}"
        DnsIps:
          - "{{ DnsIps }}"
        DomainJoinServiceAccountSecret: "{{ DomainJoinServiceAccountSecret }}"
  - name: ClientRequestToken
    value: "{{ ClientRequestToken }}"
    description: |
      (Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
  - name: FileSystemId
    value: "{{ FileSystemId }}"
    description: |
      The globally unique ID of the file system, assigned by Amazon FSx.
  - name: Name
    value: "{{ Name }}"
    description: |
      The name of the SVM.
  - name: SvmAdminPassword
    value: "{{ SvmAdminPassword }}"
    description: |
      The password to use when managing the SVM using the NetApp ONTAP CLI or REST API. If you do not specify a password, you can still use the file system's fsxadmin user to manage the SVM.
  - name: Tags
    description: |
      A list of Tag values, with a maximum of 50 elements.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"
  - name: RootVolumeSecurityStyle
    value: "{{ RootVolumeSecurityStyle }}"
    description: |
      The security style of the root volume of the SVM. Specify one of the following values: UNIX if the file system is managed by a UNIX administrator, the majority of users are NFS clients, and an application accessing the data uses a UNIX user as the service account. NTFS if the file system is managed by a Microsoft Windows administrator, the majority of users are SMB clients, and an application accessing the data uses a Microsoft Windows user as the service account. MIXED This is an advanced setting. For more information, see Volume security style in the Amazon FSx for NetApp ONTAP User Guide.
    valid_values: ['UNIX', 'NTFS', 'MIXED']

UPDATE examples

update_storage_virtual_machine

Updates an FSx for ONTAP storage virtual machine (SVM).

UPDATE aws.fsx.storage_virtual_machines
SET 
ActiveDirectoryConfiguration = '{{ ActiveDirectoryConfiguration }}',
ClientRequestToken = '{{ ClientRequestToken }}',
StorageVirtualMachineId = '{{ StorageVirtualMachineId }}',
SvmAdminPassword = '{{ SvmAdminPassword }}'
WHERE 
region = '{{ region }}' --required
AND StorageVirtualMachineId = '{{ StorageVirtualMachineId }}' --required
RETURNING
storage_virtual_machine;

DELETE examples

delete_storage_virtual_machine

Deletes an existing Amazon FSx for ONTAP storage virtual machine (SVM). Prior to deleting an SVM, you must delete all non-root volumes in the SVM, otherwise the operation will fail.

DELETE FROM aws.fsx.storage_virtual_machines
WHERE region = '{{ region }}' --required
;