AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon FSx CreateStorageVirtualMachine API operation.

Syntax

New-FSXStorageVirtualMachine
-Name <String>
-ClientRequestToken <String>
-SelfManagedActiveDirectoryConfiguration_DnsIp <String[]>
-SelfManagedActiveDirectoryConfiguration_DomainName <String>
-SelfManagedActiveDirectoryConfiguration_FileSystemAdministratorsGroup <String>
-FileSystemId <String>
-ActiveDirectoryConfiguration_NetBiosName <String>
-SelfManagedActiveDirectoryConfiguration_OrganizationalUnitDistinguishedName <String>
-SelfManagedActiveDirectoryConfiguration_Password <String>
-RootVolumeSecurityStyle <StorageVirtualMachineRootVolumeSecurityStyle>
-SvmAdminPassword <String>
-Tag <Tag[]>
-SelfManagedActiveDirectoryConfiguration_UserName <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonFSxConfig>

Description

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

Parameters

-ActiveDirectoryConfiguration_NetBiosName <String>
The NetBIOS name of the Active Directory computer object that will be created for your SVM.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonFSxConfig>
Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientRequestToken <String>
The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-FileSystemId <String>
The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Name <String>
The name of the SVM.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-RootVolumeSecurityStyle <StorageVirtualMachineRootVolumeSecurityStyle>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'StorageVirtualMachine'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FSx.Model.CreateStorageVirtualMachineResponse). Specifying the name of a property of type Amazon.FSx.Model.CreateStorageVirtualMachineResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SelfManagedActiveDirectoryConfiguration_DnsIp <String[]>
A list of up to three IP addresses of DNS servers or domain controllers in the self-managed AD directory. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesActiveDirectoryConfiguration_SelfManagedActiveDirectoryConfiguration_DnsIps
-SelfManagedActiveDirectoryConfiguration_DomainName <String>
The fully qualified domain name of the self-managed AD directory, such as corp.example.com.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesActiveDirectoryConfiguration_SelfManagedActiveDirectoryConfiguration_DomainName
-SelfManagedActiveDirectoryConfiguration_FileSystemAdministratorsGroup <String>
(Optional) The name of the domain group whose members are granted administrative privileges for the file system. Administrative privileges include taking ownership of files and folders, setting audit controls (audit ACLs) on files and folders, and administering the file system remotely by using the FSx Remote PowerShell. The group that you specify must already exist in your domain. If you don't provide one, your AD domain's Domain Admins group is used.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesActiveDirectoryConfiguration_SelfManagedActiveDirectoryConfiguration_FileSystemAdministratorsGroup
-SelfManagedActiveDirectoryConfiguration_OrganizationalUnitDistinguishedName <String>
(Optional) The fully qualified distinguished name of the organizational unit within your self-managed AD directory. Amazon FSx only accepts OU as the direct parent of the file system. An example is OU=FSx,DC=yourdomain,DC=corp,DC=com. To learn more, see RFC 2253. If none is provided, the FSx file system is created in the default location of your self-managed AD directory.Only Organizational Unit (OU) objects can be the direct parent of the file system that you're creating.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesActiveDirectoryConfiguration_SelfManagedActiveDirectoryConfiguration_OrganizationalUnitDistinguishedName
-SelfManagedActiveDirectoryConfiguration_Password <String>
The password for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesActiveDirectoryConfiguration_SelfManagedActiveDirectoryConfiguration_Password
-SelfManagedActiveDirectoryConfiguration_UserName <String>
The user name for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain. This account must have the permission to join computers to the domain in the organizational unit provided in OrganizationalUnitDistinguishedName, or in the default location of your AD domain.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesActiveDirectoryConfiguration_SelfManagedActiveDirectoryConfiguration_UserName
-SvmAdminPassword <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tag <Tag[]>
Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.FSx.Model.StorageVirtualMachine or Amazon.FSx.Model.CreateStorageVirtualMachineResponse
This cmdlet returns an Amazon.FSx.Model.StorageVirtualMachine object. The service call response (type Amazon.FSx.Model.CreateStorageVirtualMachineResponse) can be returned by specifying '-Select *'.
Amazon FSx for Windows File Server User Guide
Amazon FSx for Lustre User Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z