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

Description¶

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

Usage¶

fsx_create_storage_virtual_machine(ActiveDirectoryConfiguration,
  ClientRequestToken, FileSystemId, Name, SvmAdminPassword, Tags,
  RootVolumeSecurityStyle)

Arguments¶

ActiveDirectoryConfiguration

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

(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.
FileSystemId

[required] The globally unique ID of the file system, assigned by Amazon FSx.
Name

[required] The name of the SVM.
SvmAdminPassword

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

A list of Tag values, with a maximum of 50 elements.
RootVolumeSecurityStyle

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.

Value¶

A list with the following syntax:

list(
  StorageVirtualMachine = list(
    ActiveDirectoryConfiguration = list(
      NetBiosName = "string",
      SelfManagedActiveDirectoryConfiguration = list(
        DomainName = "string",
        OrganizationalUnitDistinguishedName = "string",
        FileSystemAdministratorsGroup = "string",
        UserName = "string",
        DnsIps = list(
          "string"
        ),
        DomainJoinServiceAccountSecret = "string"
      )
    ),
    CreationTime = as.POSIXct(
      "2015-01-01"
    ),
    Endpoints = list(
      Iscsi = list(
        DNSName = "string",
        IpAddresses = list(
          "string"
        ),
        Ipv6Addresses = list(
          "string"
        )
      ),
      Management = list(
        DNSName = "string",
        IpAddresses = list(
          "string"
        ),
        Ipv6Addresses = list(
          "string"
        )
      ),
      Nfs = list(
        DNSName = "string",
        IpAddresses = list(
          "string"
        ),
        Ipv6Addresses = list(
          "string"
        )
      ),
      Smb = list(
        DNSName = "string",
        IpAddresses = list(
          "string"
        ),
        Ipv6Addresses = list(
          "string"
        )
      )
    ),
    FileSystemId = "string",
    Lifecycle = "CREATED"|"CREATING"|"DELETING"|"FAILED"|"MISCONFIGURED"|"PENDING",
    Name = "string",
    ResourceARN = "string",
    StorageVirtualMachineId = "string",
    Subtype = "DEFAULT"|"DP_DESTINATION"|"SYNC_DESTINATION"|"SYNC_SOURCE",
    UUID = "string",
    Tags = list(
      list(
        Key = "string",
        Value = "string"
      )
    ),
    LifecycleTransitionReason = list(
      Message = "string"
    ),
    RootVolumeSecurityStyle = "UNIX"|"NTFS"|"MIXED"
  )
)

Request syntax¶

svc$create_storage_virtual_machine(
  ActiveDirectoryConfiguration = list(
    NetBiosName = "string",
    SelfManagedActiveDirectoryConfiguration = list(
      DomainName = "string",
      OrganizationalUnitDistinguishedName = "string",
      FileSystemAdministratorsGroup = "string",
      UserName = "string",
      Password = "string",
      DnsIps = list(
        "string"
      ),
      DomainJoinServiceAccountSecret = "string"
    )
  ),
  ClientRequestToken = "string",
  FileSystemId = "string",
  Name = "string",
  SvmAdminPassword = "string",
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  ),
  RootVolumeSecurityStyle = "UNIX"|"NTFS"|"MIXED"
)