create-storage-virtual-machine
Description
Creates a storage virtual machine (SVM) for an Amazon FSx for ONTAP file system.
See also: AWS API Documentation
Synopsis
create-storage-virtual-machine
[--active-directory-configuration <value>]
[--client-request-token <value>]
--file-system-id <value>
--name <value>
[--svm-admin-password <value>]
[--tags <value>]
[--root-volume-security-style <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
Options
--active-directory-configuration (structure)
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.
NetBiosName -> (string)
SelfManagedActiveDirectoryConfiguration -> (structure)
The configuration that Amazon FSx uses to join a FSx for Windows File Server file system or an FSx for ONTAP storage virtual machine (SVM) to a self-managed (including on-premises) Microsoft Active Directory (AD) directory. For more information, see Using Amazon FSx for Windows with your self-managed Microsoft Active Directory or Managing FSx for ONTAP SVMs .
DomainName -> (string)
corp.example.com .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.
Warning
Only Organizational Unit (OU) objects can be the direct parent of the file system that you’re creating.FileSystemAdministratorsGroup -> (string)
UserName -> (string)
OrganizationalUnitDistinguishedName , or in the default location of your AD domain.Password -> (string)
DnsIps -> (list)
A list of up to three IP addresses of DNS servers or domain controllers in the self-managed AD directory.
(string)
Shorthand Syntax:
NetBiosName=string,SelfManagedActiveDirectoryConfiguration={DomainName=string,OrganizationalUnitDistinguishedName=string,FileSystemAdministratorsGroup=string,UserName=string,Password=string,DnsIps=[string,string]}
JSON Syntax:
{
"NetBiosName": "string",
"SelfManagedActiveDirectoryConfiguration": {
"DomainName": "string",
"OrganizationalUnitDistinguishedName": "string",
"FileSystemAdministratorsGroup": "string",
"UserName": "string",
"Password": "string",
"DnsIps": ["string", ...]
}
}
--client-request-token (string)
--file-system-id (string)
--name (string)
--svm-admin-password (string)
fsxadmin user to manage the SVM.--tags (list)
A list of Tag values, with a maximum of 50 elements.
(structure)
Specifies a key-value pair for a resource tag.
Key -> (string)
TagKey , the name of the tag. Tag keys must be unique for the resource to which they are attached.Value -> (string)
TagValue , the value assigned to the corresponding tag key. Tag values can be null and don’t have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April .Shorthand Syntax:
Key=string,Value=string ...
JSON Syntax:
[
{
"Key": "string",
"Value": "string"
}
...
]
--root-volume-security-style (string)
The security style of the root volume of the SVM. Specify one of the following values:
-
UNIXif 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. -
NTFSif 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. -
MIXEDThis is an advanced setting. For more information, see Volume security style in the Amazon FSx for NetApp ONTAP User Guide.
Possible values:
UNIXNTFSMIXED
--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
Global Options
--debug (boolean)
Turn on debug logging.
--endpoint-url (string)
Override command’s default URL with the given URL.
--no-verify-ssl (boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate (boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output (string)
The formatting style for command output.
- json
- text
- table
- yaml
- yaml-stream
--query (string)
A JMESPath query to use in filtering the response data.
--profile (string)
Use a specific profile from your credential file.
--region (string)
The region to use. Overrides config/env settings.
--version (string)
Display the version of this tool.
--color (string)
Turn on/off color output.
- on
- off
- auto
--no-sign-request (boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle (string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout (int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout (int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
--cli-binary-format (string)
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.
- base64
- raw-in-base64-out
--no-cli-pager (boolean)
Disable cli pager for output.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
--no-cli-auto-prompt (boolean)
Disable automatically prompt for CLI input parameters.
Output
StorageVirtualMachine -> (structure)
Returned after a successful CreateStorageVirtualMachine operation; describes the SVM just created.
ActiveDirectoryConfiguration -> (structure)
Describes the Microsoft Active Directory configuration to which the SVM is joined, if applicable.
NetBiosName -> (string)
SelfManagedActiveDirectoryConfiguration -> (structure)
The configuration of the self-managed Microsoft Active Directory (AD) directory to which the Windows File Server or ONTAP storage virtual machine (SVM) instance is joined.
DomainName -> (string)
OrganizationalUnitDistinguishedName -> (string)
FileSystemAdministratorsGroup -> (string)
UserName -> (string)
DnsIps -> (list)
A list of up to three IP addresses of DNS servers or domain controllers in the self-managed AD directory.
(string)
CreationTime -> (timestamp)
Endpoints -> (structure)
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.
Iscsi -> (structure)
An endpoint for connecting using the Internet Small Computer Systems Interface (iSCSI) protocol.
DNSName -> (string)
IpAddresses -> (list)
The SVM endpoint’s IP addresses.
(string)
Management -> (structure)
An endpoint for managing SVMs using the NetApp ONTAP CLI, NetApp ONTAP API, or NetApp CloudManager.
DNSName -> (string)
IpAddresses -> (list)
The SVM endpoint’s IP addresses.
(string)
Nfs -> (structure)
An endpoint for connecting using the Network File System (NFS) protocol.
DNSName -> (string)
IpAddresses -> (list)
The SVM endpoint’s IP addresses.
(string)
Smb -> (structure)
An endpoint for connecting using the Server Message Block (SMB) protocol.
DNSName -> (string)
IpAddresses -> (list)
The SVM endpoint’s IP addresses.
(string)
FileSystemId -> (string)
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.
Name -> (string)
ResourceARN -> (string)
StorageVirtualMachineId -> (string)
Subtype -> (string)
UUID -> (string)
Tags -> (list)
A list of Tag values, with a maximum of 50 elements.
(structure)
Specifies a key-value pair for a resource tag.
Key -> (string)
TagKey , the name of the tag. Tag keys must be unique for the resource to which they are attached.Value -> (string)
TagValue , the value assigned to the corresponding tag key. Tag values can be null and don’t have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April .LifecycleTransitionReason -> (structure)
Describes why the SVM lifecycle state changed.
Message -> (string)
RootVolumeSecurityStyle -> (string)
© Copyright 2025, Amazon Web Services. Created using Sphinx.