Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. fsx
  5. OntapStorageVirtualMachine
AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-aws

aws.fsx.OntapStorageVirtualMachine

Explore with Pulumi AI

AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-aws

Manages a FSx Storage Virtual Machine. See the FSx ONTAP User Guide for more information.

Example Usage

Basic Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const test = new aws.fsx.OntapStorageVirtualMachine("test", {
    fileSystemId: testAwsFsxOntapFileSystem.id,
    name: "test",
});
Copy
import pulumi
import pulumi_aws as aws

test = aws.fsx.OntapStorageVirtualMachine("test",
    file_system_id=test_aws_fsx_ontap_file_system["id"],
    name="test")
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/fsx"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := fsx.NewOntapStorageVirtualMachine(ctx, "test", &fsx.OntapStorageVirtualMachineArgs{
			FileSystemId: pulumi.Any(testAwsFsxOntapFileSystem.Id),
			Name:         pulumi.String("test"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var test = new Aws.Fsx.OntapStorageVirtualMachine("test", new()
    {
        FileSystemId = testAwsFsxOntapFileSystem.Id,
        Name = "test",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.fsx.OntapStorageVirtualMachine;
import com.pulumi.aws.fsx.OntapStorageVirtualMachineArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var test = new OntapStorageVirtualMachine("test", OntapStorageVirtualMachineArgs.builder()
            .fileSystemId(testAwsFsxOntapFileSystem.id())
            .name("test")
            .build());

    }
}
Copy
resources:
  test:
    type: aws:fsx:OntapStorageVirtualMachine
    properties:
      fileSystemId: ${testAwsFsxOntapFileSystem.id}
      name: test
Copy

Using a Self-Managed Microsoft Active Directory

Additional information for using AWS Directory Service with ONTAP File Systems can be found in the FSx ONTAP Guide.

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const test = new aws.fsx.OntapStorageVirtualMachine("test", {
    fileSystemId: testAwsFsxOntapFileSystem.id,
    name: "mysvm",
    activeDirectoryConfiguration: {
        netbiosName: "mysvm",
        selfManagedActiveDirectoryConfiguration: {
            dnsIps: [
                "10.0.0.111",
                "10.0.0.222",
            ],
            domainName: "corp.example.com",
            password: "avoid-plaintext-passwords",
            username: "Admin",
        },
    },
});
Copy
import pulumi
import pulumi_aws as aws

test = aws.fsx.OntapStorageVirtualMachine("test",
    file_system_id=test_aws_fsx_ontap_file_system["id"],
    name="mysvm",
    active_directory_configuration={
        "netbios_name": "mysvm",
        "self_managed_active_directory_configuration": {
            "dns_ips": [
                "10.0.0.111",
                "10.0.0.222",
            ],
            "domain_name": "corp.example.com",
            "password": "avoid-plaintext-passwords",
            "username": "Admin",
        },
    })
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/fsx"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := fsx.NewOntapStorageVirtualMachine(ctx, "test", &fsx.OntapStorageVirtualMachineArgs{
			FileSystemId: pulumi.Any(testAwsFsxOntapFileSystem.Id),
			Name:         pulumi.String("mysvm"),
			ActiveDirectoryConfiguration: &fsx.OntapStorageVirtualMachineActiveDirectoryConfigurationArgs{
				NetbiosName: pulumi.String("mysvm"),
				SelfManagedActiveDirectoryConfiguration: &fsx.OntapStorageVirtualMachineActiveDirectoryConfigurationSelfManagedActiveDirectoryConfigurationArgs{
					DnsIps: pulumi.StringArray{
						pulumi.String("10.0.0.111"),
						pulumi.String("10.0.0.222"),
					},
					DomainName: pulumi.String("corp.example.com"),
					Password:   pulumi.String("avoid-plaintext-passwords"),
					Username:   pulumi.String("Admin"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var test = new Aws.Fsx.OntapStorageVirtualMachine("test", new()
    {
        FileSystemId = testAwsFsxOntapFileSystem.Id,
        Name = "mysvm",
        ActiveDirectoryConfiguration = new Aws.Fsx.Inputs.OntapStorageVirtualMachineActiveDirectoryConfigurationArgs
        {
            NetbiosName = "mysvm",
            SelfManagedActiveDirectoryConfiguration = new Aws.Fsx.Inputs.OntapStorageVirtualMachineActiveDirectoryConfigurationSelfManagedActiveDirectoryConfigurationArgs
            {
                DnsIps = new[]
                {
                    "10.0.0.111",
                    "10.0.0.222",
                },
                DomainName = "corp.example.com",
                Password = "avoid-plaintext-passwords",
                Username = "Admin",
            },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.fsx.OntapStorageVirtualMachine;
import com.pulumi.aws.fsx.OntapStorageVirtualMachineArgs;
import com.pulumi.aws.fsx.inputs.OntapStorageVirtualMachineActiveDirectoryConfigurationArgs;
import com.pulumi.aws.fsx.inputs.OntapStorageVirtualMachineActiveDirectoryConfigurationSelfManagedActiveDirectoryConfigurationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var test = new OntapStorageVirtualMachine("test", OntapStorageVirtualMachineArgs.builder()
            .fileSystemId(testAwsFsxOntapFileSystem.id())
            .name("mysvm")
            .activeDirectoryConfiguration(OntapStorageVirtualMachineActiveDirectoryConfigurationArgs.builder()
                .netbiosName("mysvm")
                .selfManagedActiveDirectoryConfiguration(OntapStorageVirtualMachineActiveDirectoryConfigurationSelfManagedActiveDirectoryConfigurationArgs.builder()
                    .dnsIps(                    
                        "10.0.0.111",
                        "10.0.0.222")
                    .domainName("corp.example.com")
                    .password("avoid-plaintext-passwords")
                    .username("Admin")
                    .build())
                .build())
            .build());

    }
}
Copy
resources:
  test:
    type: aws:fsx:OntapStorageVirtualMachine
    properties:
      fileSystemId: ${testAwsFsxOntapFileSystem.id}
      name: mysvm
      activeDirectoryConfiguration:
        netbiosName: mysvm
        selfManagedActiveDirectoryConfiguration:
          dnsIps:
            - 10.0.0.111
            - 10.0.0.222
          domainName: corp.example.com
          password: avoid-plaintext-passwords
          username: Admin
Copy

Create OntapStorageVirtualMachine Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new OntapStorageVirtualMachine(name: string, args: OntapStorageVirtualMachineArgs, opts?: CustomResourceOptions);
@overload
def OntapStorageVirtualMachine(resource_name: str,
                               args: OntapStorageVirtualMachineArgs,
                               opts: Optional[ResourceOptions] = None)

@overload
def OntapStorageVirtualMachine(resource_name: str,
                               opts: Optional[ResourceOptions] = None,
                               file_system_id: Optional[str] = None,
                               active_directory_configuration: Optional[OntapStorageVirtualMachineActiveDirectoryConfigurationArgs] = None,
                               name: Optional[str] = None,
                               root_volume_security_style: Optional[str] = None,
                               svm_admin_password: Optional[str] = None,
                               tags: Optional[Mapping[str, str]] = None)
func NewOntapStorageVirtualMachine(ctx *Context, name string, args OntapStorageVirtualMachineArgs, opts ...ResourceOption) (*OntapStorageVirtualMachine, error)
public OntapStorageVirtualMachine(string name, OntapStorageVirtualMachineArgs args, CustomResourceOptions? opts = null)
public OntapStorageVirtualMachine(String name, OntapStorageVirtualMachineArgs args)
public OntapStorageVirtualMachine(String name, OntapStorageVirtualMachineArgs args, CustomResourceOptions options)

type: aws:fsx:OntapStorageVirtualMachine
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. OntapStorageVirtualMachineArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. OntapStorageVirtualMachineArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. OntapStorageVirtualMachineArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. OntapStorageVirtualMachineArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. OntapStorageVirtualMachineArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var ontapStorageVirtualMachineResource = new Aws.Fsx.OntapStorageVirtualMachine("ontapStorageVirtualMachineResource", new()
{
    FileSystemId = "string",
    ActiveDirectoryConfiguration = new Aws.Fsx.Inputs.OntapStorageVirtualMachineActiveDirectoryConfigurationArgs
    {
        NetbiosName = "string",
        SelfManagedActiveDirectoryConfiguration = new Aws.Fsx.Inputs.OntapStorageVirtualMachineActiveDirectoryConfigurationSelfManagedActiveDirectoryConfigurationArgs
        {
            DnsIps = new[]
            {
                "string",
            },
            DomainName = "string",
            Password = "string",
            Username = "string",
            FileSystemAdministratorsGroup = "string",
            OrganizationalUnitDistinguishedName = "string",
        },
    },
    Name = "string",
    RootVolumeSecurityStyle = "string",
    SvmAdminPassword = "string",
    Tags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := fsx.NewOntapStorageVirtualMachine(ctx, "ontapStorageVirtualMachineResource", &fsx.OntapStorageVirtualMachineArgs{
	FileSystemId: pulumi.String("string"),
	ActiveDirectoryConfiguration: &fsx.OntapStorageVirtualMachineActiveDirectoryConfigurationArgs{
		NetbiosName: pulumi.String("string"),
		SelfManagedActiveDirectoryConfiguration: &fsx.OntapStorageVirtualMachineActiveDirectoryConfigurationSelfManagedActiveDirectoryConfigurationArgs{
			DnsIps: pulumi.StringArray{
				pulumi.String("string"),
			},
			DomainName:                          pulumi.String("string"),
			Password:                            pulumi.String("string"),
			Username:                            pulumi.String("string"),
			FileSystemAdministratorsGroup:       pulumi.String("string"),
			OrganizationalUnitDistinguishedName: pulumi.String("string"),
		},
	},
	Name:                    pulumi.String("string"),
	RootVolumeSecurityStyle: pulumi.String("string"),
	SvmAdminPassword:        pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var ontapStorageVirtualMachineResource = new OntapStorageVirtualMachine("ontapStorageVirtualMachineResource", OntapStorageVirtualMachineArgs.builder()
    .fileSystemId("string")
    .activeDirectoryConfiguration(OntapStorageVirtualMachineActiveDirectoryConfigurationArgs.builder()
        .netbiosName("string")
        .selfManagedActiveDirectoryConfiguration(OntapStorageVirtualMachineActiveDirectoryConfigurationSelfManagedActiveDirectoryConfigurationArgs.builder()
            .dnsIps("string")
            .domainName("string")
            .password("string")
            .username("string")
            .fileSystemAdministratorsGroup("string")
            .organizationalUnitDistinguishedName("string")
            .build())
        .build())
    .name("string")
    .rootVolumeSecurityStyle("string")
    .svmAdminPassword("string")
    .tags(Map.of("string", "string"))
    .build());
Copy
ontap_storage_virtual_machine_resource = aws.fsx.OntapStorageVirtualMachine("ontapStorageVirtualMachineResource",
    file_system_id="string",
    active_directory_configuration={
        "netbios_name": "string",
        "self_managed_active_directory_configuration": {
            "dns_ips": ["string"],
            "domain_name": "string",
            "password": "string",
            "username": "string",
            "file_system_administrators_group": "string",
            "organizational_unit_distinguished_name": "string",
        },
    },
    name="string",
    root_volume_security_style="string",
    svm_admin_password="string",
    tags={
        "string": "string",
    })
Copy
const ontapStorageVirtualMachineResource = new aws.fsx.OntapStorageVirtualMachine("ontapStorageVirtualMachineResource", {
    fileSystemId: "string",
    activeDirectoryConfiguration: {
        netbiosName: "string",
        selfManagedActiveDirectoryConfiguration: {
            dnsIps: ["string"],
            domainName: "string",
            password: "string",
            username: "string",
            fileSystemAdministratorsGroup: "string",
            organizationalUnitDistinguishedName: "string",
        },
    },
    name: "string",
    rootVolumeSecurityStyle: "string",
    svmAdminPassword: "string",
    tags: {
        string: "string",
    },
});
Copy
type: aws:fsx:OntapStorageVirtualMachine
properties:
    activeDirectoryConfiguration:
        netbiosName: string
        selfManagedActiveDirectoryConfiguration:
            dnsIps:
                - string
            domainName: string
            fileSystemAdministratorsGroup: string
            organizationalUnitDistinguishedName: string
            password: string
            username: string
    fileSystemId: string
    name: string
    rootVolumeSecurityStyle: string
    svmAdminPassword: string
    tags:
        string: string
Copy

OntapStorageVirtualMachine Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The OntapStorageVirtualMachine resource accepts the following input properties:

FileSystemId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Amazon FSx ONTAP File System that this SVM will be created on.
ActiveDirectoryConfiguration OntapStorageVirtualMachineActiveDirectoryConfiguration
Configuration block that Amazon FSx uses to join the FSx ONTAP Storage Virtual Machine(SVM) to your Microsoft Active Directory (AD) directory. Detailed below.
Name Changes to this property will trigger replacement. string
The name of the SVM. You can use a maximum of 47 alphanumeric characters, plus the underscore (_) special character.
RootVolumeSecurityStyle Changes to this property will trigger replacement. string
Specifies the root volume security style, Valid values are UNIX, NTFS, and MIXED. All volumes created under this SVM will inherit the root security style unless the security style is specified on the volume. Default value is UNIX.
SvmAdminPassword string
Specifies the password to use when logging on to the SVM using a secure shell (SSH) connection to the SVM's management endpoint. Doing so enables you to manage 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 Dictionary<string, string>
A map of tags to assign to the storage virtual machine. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
FileSystemId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Amazon FSx ONTAP File System that this SVM will be created on.
ActiveDirectoryConfiguration OntapStorageVirtualMachineActiveDirectoryConfigurationArgs
Configuration block that Amazon FSx uses to join the FSx ONTAP Storage Virtual Machine(SVM) to your Microsoft Active Directory (AD) directory. Detailed below.
Name Changes to this property will trigger replacement. string
The name of the SVM. You can use a maximum of 47 alphanumeric characters, plus the underscore (_) special character.
RootVolumeSecurityStyle Changes to this property will trigger replacement. string
Specifies the root volume security style, Valid values are UNIX, NTFS, and MIXED. All volumes created under this SVM will inherit the root security style unless the security style is specified on the volume. Default value is UNIX.
SvmAdminPassword string
Specifies the password to use when logging on to the SVM using a secure shell (SSH) connection to the SVM's management endpoint. Doing so enables you to manage 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 map[string]string
A map of tags to assign to the storage virtual machine. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
fileSystemId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the Amazon FSx ONTAP File System that this SVM will be created on.
activeDirectoryConfiguration OntapStorageVirtualMachineActiveDirectoryConfiguration
Configuration block that Amazon FSx uses to join the FSx ONTAP Storage Virtual Machine(SVM) to your Microsoft Active Directory (AD) directory. Detailed below.
name Changes to this property will trigger replacement. String
The name of the SVM. You can use a maximum of 47 alphanumeric characters, plus the underscore (_) special character.
rootVolumeSecurityStyle Changes to this property will trigger replacement. String
Specifies the root volume security style, Valid values are UNIX, NTFS, and MIXED. All volumes created under this SVM will inherit the root security style unless the security style is specified on the volume. Default value is UNIX.
svmAdminPassword String
Specifies the password to use when logging on to the SVM using a secure shell (SSH) connection to the SVM's management endpoint. Doing so enables you to manage 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 Map<String,String>
A map of tags to assign to the storage virtual machine. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
fileSystemId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Amazon FSx ONTAP File System that this SVM will be created on.
activeDirectoryConfiguration OntapStorageVirtualMachineActiveDirectoryConfiguration
Configuration block that Amazon FSx uses to join the FSx ONTAP Storage Virtual Machine(SVM) to your Microsoft Active Directory (AD) directory. Detailed below.
name Changes to this property will trigger replacement. string
The name of the SVM. You can use a maximum of 47 alphanumeric characters, plus the underscore (_) special character.
rootVolumeSecurityStyle Changes to this property will trigger replacement. string
Specifies the root volume security style, Valid values are UNIX, NTFS, and MIXED. All volumes created under this SVM will inherit the root security style unless the security style is specified on the volume. Default value is UNIX.
svmAdminPassword string
Specifies the password to use when logging on to the SVM using a secure shell (SSH) connection to the SVM's management endpoint. Doing so enables you to manage 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 {[key: string]: string}
A map of tags to assign to the storage virtual machine. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
file_system_id
This property is required.
Changes to this property will trigger replacement.
str
The ID of the Amazon FSx ONTAP File System that this SVM will be created on.
active_directory_configuration OntapStorageVirtualMachineActiveDirectoryConfigurationArgs
Configuration block that Amazon FSx uses to join the FSx ONTAP Storage Virtual Machine(SVM) to your Microsoft Active Directory (AD) directory. Detailed below.
name Changes to this property will trigger replacement. str
The name of the SVM. You can use a maximum of 47 alphanumeric characters, plus the underscore (_) special character.
root_volume_security_style Changes to this property will trigger replacement. str
Specifies the root volume security style, Valid values are UNIX, NTFS, and MIXED. All volumes created under this SVM will inherit the root security style unless the security style is specified on the volume. Default value is UNIX.
svm_admin_password str
Specifies the password to use when logging on to the SVM using a secure shell (SSH) connection to the SVM's management endpoint. Doing so enables you to manage 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 Mapping[str, str]
A map of tags to assign to the storage virtual machine. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
fileSystemId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the Amazon FSx ONTAP File System that this SVM will be created on.
activeDirectoryConfiguration Property Map
Configuration block that Amazon FSx uses to join the FSx ONTAP Storage Virtual Machine(SVM) to your Microsoft Active Directory (AD) directory. Detailed below.
name Changes to this property will trigger replacement. String
The name of the SVM. You can use a maximum of 47 alphanumeric characters, plus the underscore (_) special character.
rootVolumeSecurityStyle Changes to this property will trigger replacement. String
Specifies the root volume security style, Valid values are UNIX, NTFS, and MIXED. All volumes created under this SVM will inherit the root security style unless the security style is specified on the volume. Default value is UNIX.
svmAdminPassword String
Specifies the password to use when logging on to the SVM using a secure shell (SSH) connection to the SVM's management endpoint. Doing so enables you to manage 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 Map<String>
A map of tags to assign to the storage virtual machine. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

Outputs

All input properties are implicitly available as output properties. Additionally, the OntapStorageVirtualMachine resource produces the following output properties:

Arn string
Amazon Resource Name of the storage virtual machine.
Endpoints List<OntapStorageVirtualMachineEndpoint>
The endpoints that are used to access data or to manage the storage virtual machine using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror. See Endpoints below.
Id string
The provider-assigned unique ID for this managed resource.
Subtype string
Describes the SVM's subtype, e.g. DEFAULT
TagsAll Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Uuid string
The SVM's UUID (universally unique identifier).
Arn string
Amazon Resource Name of the storage virtual machine.
Endpoints []OntapStorageVirtualMachineEndpoint
The endpoints that are used to access data or to manage the storage virtual machine using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror. See Endpoints below.
Id string
The provider-assigned unique ID for this managed resource.
Subtype string
Describes the SVM's subtype, e.g. DEFAULT
TagsAll map[string]string
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Uuid string
The SVM's UUID (universally unique identifier).
arn String
Amazon Resource Name of the storage virtual machine.
endpoints List<OntapStorageVirtualMachineEndpoint>
The endpoints that are used to access data or to manage the storage virtual machine using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror. See Endpoints below.
id String
The provider-assigned unique ID for this managed resource.
subtype String
Describes the SVM's subtype, e.g. DEFAULT
tagsAll Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

uuid String
The SVM's UUID (universally unique identifier).
arn string
Amazon Resource Name of the storage virtual machine.
endpoints OntapStorageVirtualMachineEndpoint[]
The endpoints that are used to access data or to manage the storage virtual machine using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror. See Endpoints below.
id string
The provider-assigned unique ID for this managed resource.
subtype string
Describes the SVM's subtype, e.g. DEFAULT
tagsAll {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

uuid string
The SVM's UUID (universally unique identifier).
arn str
Amazon Resource Name of the storage virtual machine.
endpoints Sequence[OntapStorageVirtualMachineEndpoint]
The endpoints that are used to access data or to manage the storage virtual machine using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror. See Endpoints below.
id str
The provider-assigned unique ID for this managed resource.
subtype str
Describes the SVM's subtype, e.g. DEFAULT
tags_all Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

uuid str
The SVM's UUID (universally unique identifier).
arn String
Amazon Resource Name of the storage virtual machine.
endpoints List<Property Map>
The endpoints that are used to access data or to manage the storage virtual machine using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror. See Endpoints below.
id String
The provider-assigned unique ID for this managed resource.
subtype String
Describes the SVM's subtype, e.g. DEFAULT
tagsAll Map<String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

uuid String
The SVM's UUID (universally unique identifier).

Look up Existing OntapStorageVirtualMachine Resource

Get an existing OntapStorageVirtualMachine resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: OntapStorageVirtualMachineState, opts?: CustomResourceOptions): OntapStorageVirtualMachine
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        active_directory_configuration: Optional[OntapStorageVirtualMachineActiveDirectoryConfigurationArgs] = None,
        arn: Optional[str] = None,
        endpoints: Optional[Sequence[OntapStorageVirtualMachineEndpointArgs]] = None,
        file_system_id: Optional[str] = None,
        name: Optional[str] = None,
        root_volume_security_style: Optional[str] = None,
        subtype: Optional[str] = None,
        svm_admin_password: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        uuid: Optional[str] = None) -> OntapStorageVirtualMachine
func GetOntapStorageVirtualMachine(ctx *Context, name string, id IDInput, state *OntapStorageVirtualMachineState, opts ...ResourceOption) (*OntapStorageVirtualMachine, error)
public static OntapStorageVirtualMachine Get(string name, Input<string> id, OntapStorageVirtualMachineState? state, CustomResourceOptions? opts = null)
public static OntapStorageVirtualMachine get(String name, Output<String> id, OntapStorageVirtualMachineState state, CustomResourceOptions options)
resources:  _:    type: aws:fsx:OntapStorageVirtualMachine    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
ActiveDirectoryConfiguration OntapStorageVirtualMachineActiveDirectoryConfiguration
Configuration block that Amazon FSx uses to join the FSx ONTAP Storage Virtual Machine(SVM) to your Microsoft Active Directory (AD) directory. Detailed below.
Arn string
Amazon Resource Name of the storage virtual machine.
Endpoints List<OntapStorageVirtualMachineEndpoint>
The endpoints that are used to access data or to manage the storage virtual machine using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror. See Endpoints below.
FileSystemId Changes to this property will trigger replacement. string
The ID of the Amazon FSx ONTAP File System that this SVM will be created on.
Name Changes to this property will trigger replacement. string
The name of the SVM. You can use a maximum of 47 alphanumeric characters, plus the underscore (_) special character.
RootVolumeSecurityStyle Changes to this property will trigger replacement. string
Specifies the root volume security style, Valid values are UNIX, NTFS, and MIXED. All volumes created under this SVM will inherit the root security style unless the security style is specified on the volume. Default value is UNIX.
Subtype string
Describes the SVM's subtype, e.g. DEFAULT
SvmAdminPassword string
Specifies the password to use when logging on to the SVM using a secure shell (SSH) connection to the SVM's management endpoint. Doing so enables you to manage 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 Dictionary<string, string>
A map of tags to assign to the storage virtual machine. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
TagsAll Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Uuid string
The SVM's UUID (universally unique identifier).
ActiveDirectoryConfiguration OntapStorageVirtualMachineActiveDirectoryConfigurationArgs
Configuration block that Amazon FSx uses to join the FSx ONTAP Storage Virtual Machine(SVM) to your Microsoft Active Directory (AD) directory. Detailed below.
Arn string
Amazon Resource Name of the storage virtual machine.
Endpoints []OntapStorageVirtualMachineEndpointArgs
The endpoints that are used to access data or to manage the storage virtual machine using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror. See Endpoints below.
FileSystemId Changes to this property will trigger replacement. string
The ID of the Amazon FSx ONTAP File System that this SVM will be created on.
Name Changes to this property will trigger replacement. string
The name of the SVM. You can use a maximum of 47 alphanumeric characters, plus the underscore (_) special character.
RootVolumeSecurityStyle Changes to this property will trigger replacement. string
Specifies the root volume security style, Valid values are UNIX, NTFS, and MIXED. All volumes created under this SVM will inherit the root security style unless the security style is specified on the volume. Default value is UNIX.
Subtype string
Describes the SVM's subtype, e.g. DEFAULT
SvmAdminPassword string
Specifies the password to use when logging on to the SVM using a secure shell (SSH) connection to the SVM's management endpoint. Doing so enables you to manage 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 map[string]string
A map of tags to assign to the storage virtual machine. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
TagsAll map[string]string
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Uuid string
The SVM's UUID (universally unique identifier).
activeDirectoryConfiguration OntapStorageVirtualMachineActiveDirectoryConfiguration
Configuration block that Amazon FSx uses to join the FSx ONTAP Storage Virtual Machine(SVM) to your Microsoft Active Directory (AD) directory. Detailed below.
arn String
Amazon Resource Name of the storage virtual machine.
endpoints List<OntapStorageVirtualMachineEndpoint>
The endpoints that are used to access data or to manage the storage virtual machine using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror. See Endpoints below.
fileSystemId Changes to this property will trigger replacement. String
The ID of the Amazon FSx ONTAP File System that this SVM will be created on.
name Changes to this property will trigger replacement. String
The name of the SVM. You can use a maximum of 47 alphanumeric characters, plus the underscore (_) special character.
rootVolumeSecurityStyle Changes to this property will trigger replacement. String
Specifies the root volume security style, Valid values are UNIX, NTFS, and MIXED. All volumes created under this SVM will inherit the root security style unless the security style is specified on the volume. Default value is UNIX.
subtype String
Describes the SVM's subtype, e.g. DEFAULT
svmAdminPassword String
Specifies the password to use when logging on to the SVM using a secure shell (SSH) connection to the SVM's management endpoint. Doing so enables you to manage 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 Map<String,String>
A map of tags to assign to the storage virtual machine. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

uuid String
The SVM's UUID (universally unique identifier).
activeDirectoryConfiguration OntapStorageVirtualMachineActiveDirectoryConfiguration
Configuration block that Amazon FSx uses to join the FSx ONTAP Storage Virtual Machine(SVM) to your Microsoft Active Directory (AD) directory. Detailed below.
arn string
Amazon Resource Name of the storage virtual machine.
endpoints OntapStorageVirtualMachineEndpoint[]
The endpoints that are used to access data or to manage the storage virtual machine using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror. See Endpoints below.
fileSystemId Changes to this property will trigger replacement. string
The ID of the Amazon FSx ONTAP File System that this SVM will be created on.
name Changes to this property will trigger replacement. string
The name of the SVM. You can use a maximum of 47 alphanumeric characters, plus the underscore (_) special character.
rootVolumeSecurityStyle Changes to this property will trigger replacement. string
Specifies the root volume security style, Valid values are UNIX, NTFS, and MIXED. All volumes created under this SVM will inherit the root security style unless the security style is specified on the volume. Default value is UNIX.
subtype string
Describes the SVM's subtype, e.g. DEFAULT
svmAdminPassword string
Specifies the password to use when logging on to the SVM using a secure shell (SSH) connection to the SVM's management endpoint. Doing so enables you to manage 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 {[key: string]: string}
A map of tags to assign to the storage virtual machine. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

uuid string
The SVM's UUID (universally unique identifier).
active_directory_configuration OntapStorageVirtualMachineActiveDirectoryConfigurationArgs
Configuration block that Amazon FSx uses to join the FSx ONTAP Storage Virtual Machine(SVM) to your Microsoft Active Directory (AD) directory. Detailed below.
arn str
Amazon Resource Name of the storage virtual machine.
endpoints Sequence[OntapStorageVirtualMachineEndpointArgs]
The endpoints that are used to access data or to manage the storage virtual machine using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror. See Endpoints below.
file_system_id Changes to this property will trigger replacement. str
The ID of the Amazon FSx ONTAP File System that this SVM will be created on.
name Changes to this property will trigger replacement. str
The name of the SVM. You can use a maximum of 47 alphanumeric characters, plus the underscore (_) special character.
root_volume_security_style Changes to this property will trigger replacement. str
Specifies the root volume security style, Valid values are UNIX, NTFS, and MIXED. All volumes created under this SVM will inherit the root security style unless the security style is specified on the volume. Default value is UNIX.
subtype str
Describes the SVM's subtype, e.g. DEFAULT
svm_admin_password str
Specifies the password to use when logging on to the SVM using a secure shell (SSH) connection to the SVM's management endpoint. Doing so enables you to manage 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 Mapping[str, str]
A map of tags to assign to the storage virtual machine. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tags_all Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

uuid str
The SVM's UUID (universally unique identifier).
activeDirectoryConfiguration Property Map
Configuration block that Amazon FSx uses to join the FSx ONTAP Storage Virtual Machine(SVM) to your Microsoft Active Directory (AD) directory. Detailed below.
arn String
Amazon Resource Name of the storage virtual machine.
endpoints List<Property Map>
The endpoints that are used to access data or to manage the storage virtual machine using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror. See Endpoints below.
fileSystemId Changes to this property will trigger replacement. String
The ID of the Amazon FSx ONTAP File System that this SVM will be created on.
name Changes to this property will trigger replacement. String
The name of the SVM. You can use a maximum of 47 alphanumeric characters, plus the underscore (_) special character.
rootVolumeSecurityStyle Changes to this property will trigger replacement. String
Specifies the root volume security style, Valid values are UNIX, NTFS, and MIXED. All volumes created under this SVM will inherit the root security style unless the security style is specified on the volume. Default value is UNIX.
subtype String
Describes the SVM's subtype, e.g. DEFAULT
svmAdminPassword String
Specifies the password to use when logging on to the SVM using a secure shell (SSH) connection to the SVM's management endpoint. Doing so enables you to manage 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 Map<String>
A map of tags to assign to the storage virtual machine. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll Map<String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

uuid String
The SVM's UUID (universally unique identifier).

Supporting Types

OntapStorageVirtualMachineActiveDirectoryConfiguration
, OntapStorageVirtualMachineActiveDirectoryConfigurationArgs

NetbiosName string
The NetBIOS name of the Active Directory computer object that will be created for your SVM. This is often the same as the SVM name but can be different. AWS limits to 15 characters because of standard NetBIOS naming limits.
SelfManagedActiveDirectoryConfiguration OntapStorageVirtualMachineActiveDirectoryConfigurationSelfManagedActiveDirectoryConfiguration
NetbiosName string
The NetBIOS name of the Active Directory computer object that will be created for your SVM. This is often the same as the SVM name but can be different. AWS limits to 15 characters because of standard NetBIOS naming limits.
SelfManagedActiveDirectoryConfiguration OntapStorageVirtualMachineActiveDirectoryConfigurationSelfManagedActiveDirectoryConfiguration
netbiosName String
The NetBIOS name of the Active Directory computer object that will be created for your SVM. This is often the same as the SVM name but can be different. AWS limits to 15 characters because of standard NetBIOS naming limits.
selfManagedActiveDirectoryConfiguration OntapStorageVirtualMachineActiveDirectoryConfigurationSelfManagedActiveDirectoryConfiguration
netbiosName string
The NetBIOS name of the Active Directory computer object that will be created for your SVM. This is often the same as the SVM name but can be different. AWS limits to 15 characters because of standard NetBIOS naming limits.
selfManagedActiveDirectoryConfiguration OntapStorageVirtualMachineActiveDirectoryConfigurationSelfManagedActiveDirectoryConfiguration
netbios_name str
The NetBIOS name of the Active Directory computer object that will be created for your SVM. This is often the same as the SVM name but can be different. AWS limits to 15 characters because of standard NetBIOS naming limits.
self_managed_active_directory_configuration OntapStorageVirtualMachineActiveDirectoryConfigurationSelfManagedActiveDirectoryConfiguration
netbiosName String
The NetBIOS name of the Active Directory computer object that will be created for your SVM. This is often the same as the SVM name but can be different. AWS limits to 15 characters because of standard NetBIOS naming limits.
selfManagedActiveDirectoryConfiguration Property Map

OntapStorageVirtualMachineActiveDirectoryConfigurationSelfManagedActiveDirectoryConfiguration
, OntapStorageVirtualMachineActiveDirectoryConfigurationSelfManagedActiveDirectoryConfigurationArgs

DnsIps This property is required. List<string>
A list of up to three IP addresses of DNS servers or domain controllers in the self-managed AD directory.
DomainName This property is required. string
The fully qualified domain name of the self-managed AD directory. For example, corp.example.com.
Password This property is required. string
The password for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain.
Username This property is required. 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.
FileSystemAdministratorsGroup string
The name of the domain group whose members are granted administrative privileges for the SVM. The group that you specify must already exist in your domain. Defaults to Domain Admins.
OrganizationalUnitDistinguishedName string
The fully qualified distinguished name of the organizational unit within your self-managed AD directory that the Windows File Server instance will join. For example, OU=FSx,DC=yourdomain,DC=corp,DC=com. Only accepts OU as the direct parent of the SVM. If none is provided, the SVM is created in the default location of your self-managed AD directory. To learn more, see RFC 2253.
DnsIps This property is required. []string
A list of up to three IP addresses of DNS servers or domain controllers in the self-managed AD directory.
DomainName This property is required. string
The fully qualified domain name of the self-managed AD directory. For example, corp.example.com.
Password This property is required. string
The password for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain.
Username This property is required. 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.
FileSystemAdministratorsGroup string
The name of the domain group whose members are granted administrative privileges for the SVM. The group that you specify must already exist in your domain. Defaults to Domain Admins.
OrganizationalUnitDistinguishedName string
The fully qualified distinguished name of the organizational unit within your self-managed AD directory that the Windows File Server instance will join. For example, OU=FSx,DC=yourdomain,DC=corp,DC=com. Only accepts OU as the direct parent of the SVM. If none is provided, the SVM is created in the default location of your self-managed AD directory. To learn more, see RFC 2253.
dnsIps This property is required. List<String>
A list of up to three IP addresses of DNS servers or domain controllers in the self-managed AD directory.
domainName This property is required. String
The fully qualified domain name of the self-managed AD directory. For example, corp.example.com.
password This property is required. String
The password for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain.
username This property is required. 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.
fileSystemAdministratorsGroup String
The name of the domain group whose members are granted administrative privileges for the SVM. The group that you specify must already exist in your domain. Defaults to Domain Admins.
organizationalUnitDistinguishedName String
The fully qualified distinguished name of the organizational unit within your self-managed AD directory that the Windows File Server instance will join. For example, OU=FSx,DC=yourdomain,DC=corp,DC=com. Only accepts OU as the direct parent of the SVM. If none is provided, the SVM is created in the default location of your self-managed AD directory. To learn more, see RFC 2253.
dnsIps This property is required. string[]
A list of up to three IP addresses of DNS servers or domain controllers in the self-managed AD directory.
domainName This property is required. string
The fully qualified domain name of the self-managed AD directory. For example, corp.example.com.
password This property is required. string
The password for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain.
username This property is required. 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.
fileSystemAdministratorsGroup string
The name of the domain group whose members are granted administrative privileges for the SVM. The group that you specify must already exist in your domain. Defaults to Domain Admins.
organizationalUnitDistinguishedName string
The fully qualified distinguished name of the organizational unit within your self-managed AD directory that the Windows File Server instance will join. For example, OU=FSx,DC=yourdomain,DC=corp,DC=com. Only accepts OU as the direct parent of the SVM. If none is provided, the SVM is created in the default location of your self-managed AD directory. To learn more, see RFC 2253.
dns_ips This property is required. Sequence[str]
A list of up to three IP addresses of DNS servers or domain controllers in the self-managed AD directory.
domain_name This property is required. str
The fully qualified domain name of the self-managed AD directory. For example, corp.example.com.
password This property is required. str
The password for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain.
username This property is required. str
The user name for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain.
file_system_administrators_group str
The name of the domain group whose members are granted administrative privileges for the SVM. The group that you specify must already exist in your domain. Defaults to Domain Admins.
organizational_unit_distinguished_name str
The fully qualified distinguished name of the organizational unit within your self-managed AD directory that the Windows File Server instance will join. For example, OU=FSx,DC=yourdomain,DC=corp,DC=com. Only accepts OU as the direct parent of the SVM. If none is provided, the SVM is created in the default location of your self-managed AD directory. To learn more, see RFC 2253.
dnsIps This property is required. List<String>
A list of up to three IP addresses of DNS servers or domain controllers in the self-managed AD directory.
domainName This property is required. String
The fully qualified domain name of the self-managed AD directory. For example, corp.example.com.
password This property is required. String
The password for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain.
username This property is required. 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.
fileSystemAdministratorsGroup String
The name of the domain group whose members are granted administrative privileges for the SVM. The group that you specify must already exist in your domain. Defaults to Domain Admins.
organizationalUnitDistinguishedName String
The fully qualified distinguished name of the organizational unit within your self-managed AD directory that the Windows File Server instance will join. For example, OU=FSx,DC=yourdomain,DC=corp,DC=com. Only accepts OU as the direct parent of the SVM. If none is provided, the SVM is created in the default location of your self-managed AD directory. To learn more, see RFC 2253.

OntapStorageVirtualMachineEndpoint
, OntapStorageVirtualMachineEndpointArgs

Iscsis List<OntapStorageVirtualMachineEndpointIscsi>
An endpoint for accessing data on your storage virtual machine via iSCSI protocol. See Endpoint.
Managements List<OntapStorageVirtualMachineEndpointManagement>
An endpoint for managing your file system using the NetApp ONTAP CLI and NetApp ONTAP API. See Endpoint.
Nfs List<OntapStorageVirtualMachineEndpointNf>
An endpoint for accessing data on your storage virtual machine via NFS protocol. See Endpoint.
Smbs List<OntapStorageVirtualMachineEndpointSmb>
An endpoint for accessing data on your storage virtual machine via SMB protocol. This is only set if an active_directory_configuration has been set. See Endpoint.
Iscsis []OntapStorageVirtualMachineEndpointIscsi
An endpoint for accessing data on your storage virtual machine via iSCSI protocol. See Endpoint.
Managements []OntapStorageVirtualMachineEndpointManagement
An endpoint for managing your file system using the NetApp ONTAP CLI and NetApp ONTAP API. See Endpoint.
Nfs []OntapStorageVirtualMachineEndpointNf
An endpoint for accessing data on your storage virtual machine via NFS protocol. See Endpoint.
Smbs []OntapStorageVirtualMachineEndpointSmb
An endpoint for accessing data on your storage virtual machine via SMB protocol. This is only set if an active_directory_configuration has been set. See Endpoint.
iscsis List<OntapStorageVirtualMachineEndpointIscsi>
An endpoint for accessing data on your storage virtual machine via iSCSI protocol. See Endpoint.
managements List<OntapStorageVirtualMachineEndpointManagement>
An endpoint for managing your file system using the NetApp ONTAP CLI and NetApp ONTAP API. See Endpoint.
nfs List<OntapStorageVirtualMachineEndpointNf>
An endpoint for accessing data on your storage virtual machine via NFS protocol. See Endpoint.
smbs List<OntapStorageVirtualMachineEndpointSmb>
An endpoint for accessing data on your storage virtual machine via SMB protocol. This is only set if an active_directory_configuration has been set. See Endpoint.
iscsis OntapStorageVirtualMachineEndpointIscsi[]
An endpoint for accessing data on your storage virtual machine via iSCSI protocol. See Endpoint.
managements OntapStorageVirtualMachineEndpointManagement[]
An endpoint for managing your file system using the NetApp ONTAP CLI and NetApp ONTAP API. See Endpoint.
nfs OntapStorageVirtualMachineEndpointNf[]
An endpoint for accessing data on your storage virtual machine via NFS protocol. See Endpoint.
smbs OntapStorageVirtualMachineEndpointSmb[]
An endpoint for accessing data on your storage virtual machine via SMB protocol. This is only set if an active_directory_configuration has been set. See Endpoint.
iscsis Sequence[OntapStorageVirtualMachineEndpointIscsi]
An endpoint for accessing data on your storage virtual machine via iSCSI protocol. See Endpoint.
managements Sequence[OntapStorageVirtualMachineEndpointManagement]
An endpoint for managing your file system using the NetApp ONTAP CLI and NetApp ONTAP API. See Endpoint.
nfs Sequence[OntapStorageVirtualMachineEndpointNf]
An endpoint for accessing data on your storage virtual machine via NFS protocol. See Endpoint.
smbs Sequence[OntapStorageVirtualMachineEndpointSmb]
An endpoint for accessing data on your storage virtual machine via SMB protocol. This is only set if an active_directory_configuration has been set. See Endpoint.
iscsis List<Property Map>
An endpoint for accessing data on your storage virtual machine via iSCSI protocol. See Endpoint.
managements List<Property Map>
An endpoint for managing your file system using the NetApp ONTAP CLI and NetApp ONTAP API. See Endpoint.
nfs List<Property Map>
An endpoint for accessing data on your storage virtual machine via NFS protocol. See Endpoint.
smbs List<Property Map>
An endpoint for accessing data on your storage virtual machine via SMB protocol. This is only set if an active_directory_configuration has been set. See Endpoint.

OntapStorageVirtualMachineEndpointIscsi
, OntapStorageVirtualMachineEndpointIscsiArgs

DnsName string
The Domain Name Service (DNS) name for the storage virtual machine. You can mount your storage virtual machine using its DNS name.
IpAddresses List<string>
IP addresses of the storage virtual machine endpoint.
DnsName string
The Domain Name Service (DNS) name for the storage virtual machine. You can mount your storage virtual machine using its DNS name.
IpAddresses []string
IP addresses of the storage virtual machine endpoint.
dnsName String
The Domain Name Service (DNS) name for the storage virtual machine. You can mount your storage virtual machine using its DNS name.
ipAddresses List<String>
IP addresses of the storage virtual machine endpoint.
dnsName string
The Domain Name Service (DNS) name for the storage virtual machine. You can mount your storage virtual machine using its DNS name.
ipAddresses string[]
IP addresses of the storage virtual machine endpoint.
dns_name str
The Domain Name Service (DNS) name for the storage virtual machine. You can mount your storage virtual machine using its DNS name.
ip_addresses Sequence[str]
IP addresses of the storage virtual machine endpoint.
dnsName String
The Domain Name Service (DNS) name for the storage virtual machine. You can mount your storage virtual machine using its DNS name.
ipAddresses List<String>
IP addresses of the storage virtual machine endpoint.

OntapStorageVirtualMachineEndpointManagement
, OntapStorageVirtualMachineEndpointManagementArgs

DnsName string
The Domain Name Service (DNS) name for the storage virtual machine. You can mount your storage virtual machine using its DNS name.
IpAddresses List<string>
IP addresses of the storage virtual machine endpoint.
DnsName string
The Domain Name Service (DNS) name for the storage virtual machine. You can mount your storage virtual machine using its DNS name.
IpAddresses []string
IP addresses of the storage virtual machine endpoint.
dnsName String
The Domain Name Service (DNS) name for the storage virtual machine. You can mount your storage virtual machine using its DNS name.
ipAddresses List<String>
IP addresses of the storage virtual machine endpoint.
dnsName string
The Domain Name Service (DNS) name for the storage virtual machine. You can mount your storage virtual machine using its DNS name.
ipAddresses string[]
IP addresses of the storage virtual machine endpoint.
dns_name str
The Domain Name Service (DNS) name for the storage virtual machine. You can mount your storage virtual machine using its DNS name.
ip_addresses Sequence[str]
IP addresses of the storage virtual machine endpoint.
dnsName String
The Domain Name Service (DNS) name for the storage virtual machine. You can mount your storage virtual machine using its DNS name.
ipAddresses List<String>
IP addresses of the storage virtual machine endpoint.

OntapStorageVirtualMachineEndpointNf
, OntapStorageVirtualMachineEndpointNfArgs

DnsName string
The Domain Name Service (DNS) name for the storage virtual machine. You can mount your storage virtual machine using its DNS name.
IpAddresses List<string>
IP addresses of the storage virtual machine endpoint.
DnsName string
The Domain Name Service (DNS) name for the storage virtual machine. You can mount your storage virtual machine using its DNS name.
IpAddresses []string
IP addresses of the storage virtual machine endpoint.
dnsName String
The Domain Name Service (DNS) name for the storage virtual machine. You can mount your storage virtual machine using its DNS name.
ipAddresses List<String>
IP addresses of the storage virtual machine endpoint.
dnsName string
The Domain Name Service (DNS) name for the storage virtual machine. You can mount your storage virtual machine using its DNS name.
ipAddresses string[]
IP addresses of the storage virtual machine endpoint.
dns_name str
The Domain Name Service (DNS) name for the storage virtual machine. You can mount your storage virtual machine using its DNS name.
ip_addresses Sequence[str]
IP addresses of the storage virtual machine endpoint.
dnsName String
The Domain Name Service (DNS) name for the storage virtual machine. You can mount your storage virtual machine using its DNS name.
ipAddresses List<String>
IP addresses of the storage virtual machine endpoint.

OntapStorageVirtualMachineEndpointSmb
, OntapStorageVirtualMachineEndpointSmbArgs

DnsName string
The Domain Name Service (DNS) name for the storage virtual machine. You can mount your storage virtual machine using its DNS name.
IpAddresses List<string>
IP addresses of the storage virtual machine endpoint.
DnsName string
The Domain Name Service (DNS) name for the storage virtual machine. You can mount your storage virtual machine using its DNS name.
IpAddresses []string
IP addresses of the storage virtual machine endpoint.
dnsName String
The Domain Name Service (DNS) name for the storage virtual machine. You can mount your storage virtual machine using its DNS name.
ipAddresses List<String>
IP addresses of the storage virtual machine endpoint.
dnsName string
The Domain Name Service (DNS) name for the storage virtual machine. You can mount your storage virtual machine using its DNS name.
ipAddresses string[]
IP addresses of the storage virtual machine endpoint.
dns_name str
The Domain Name Service (DNS) name for the storage virtual machine. You can mount your storage virtual machine using its DNS name.
ip_addresses Sequence[str]
IP addresses of the storage virtual machine endpoint.
dnsName String
The Domain Name Service (DNS) name for the storage virtual machine. You can mount your storage virtual machine using its DNS name.
ipAddresses List<String>
IP addresses of the storage virtual machine endpoint.

Import

Using pulumi import, import FSx Storage Virtual Machine using the id. For example:

$ pulumi import aws:fsx/ontapStorageVirtualMachine:OntapStorageVirtualMachine example svm-12345678abcdef123
Copy

Certain resource arguments, like svm_admin_password and the self_managed_active_directory configuation block password, do not have a FSx API method for reading the information after creation. If these arguments are set in the Pulumi program on an imported resource, Pulumi will always show a difference. To workaround this behavior, either omit the argument from the Pulumi program or use ignore_changes to hide the difference. For example:

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.
AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-aws