Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Vsphere Provider
  3. API Docs
  4. NasDatastore
vSphere v4.12.1 published on Tuesday, Oct 22, 2024 by Pulumi
pulumi/pulumi-vsphere

vsphere.NasDatastore

Explore with Pulumi AI

vsphere logo
vSphere v4.12.1 published on Tuesday, Oct 22, 2024 by Pulumi
pulumi/pulumi-vsphere

    The vsphere.NasDatastore resource can be used to create and manage NAS datastores on an ESXi host or a set of hosts. The resource supports mounting NFS v3 and v4.1 shares to be used as datastores.

    NOTE: Unlike vsphere.VmfsDatastore, a NAS datastore is only mounted on the hosts you choose to mount it on. To mount on multiple hosts, you must specify each host that you want to add in the host_system_ids argument.

    Create NasDatastore Resource

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

    Constructor syntax

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

@overload
def NasDatastore(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 host_system_ids: Optional[Sequence[str]] = None,
                 remote_hosts: Optional[Sequence[str]] = None,
                 remote_path: Optional[str] = None,
                 access_mode: Optional[str] = None,
                 custom_attributes: Optional[Mapping[str, str]] = None,
                 datastore_cluster_id: Optional[str] = None,
                 folder: Optional[str] = None,
                 name: Optional[str] = None,
                 security_type: Optional[str] = None,
                 tags: Optional[Sequence[str]] = None,
                 type: Optional[str] = None)
    func NewNasDatastore(ctx *Context, name string, args NasDatastoreArgs, opts ...ResourceOption) (*NasDatastore, error)
    public NasDatastore(string name, NasDatastoreArgs args, CustomResourceOptions? opts = null)
    public NasDatastore(String name, NasDatastoreArgs args)
public NasDatastore(String name, NasDatastoreArgs args, CustomResourceOptions options)

    type: vsphere:NasDatastore
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args NasDatastoreArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args NasDatastoreArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args NasDatastoreArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args NasDatastoreArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args NasDatastoreArgs
    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 nasDatastoreResource = new VSphere.NasDatastore("nasDatastoreResource", new()
{
    HostSystemIds = new[]
    {
        "string",
    },
    RemoteHosts = new[]
    {
        "string",
    },
    RemotePath = "string",
    AccessMode = "string",
    CustomAttributes = 
    {
        { "string", "string" },
    },
    DatastoreClusterId = "string",
    Folder = "string",
    Name = "string",
    SecurityType = "string",
    Tags = new[]
    {
        "string",
    },
    Type = "string",
});

    example, err := vsphere.NewNasDatastore(ctx, "nasDatastoreResource", &vsphere.NasDatastoreArgs{
	HostSystemIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	RemoteHosts: pulumi.StringArray{
		pulumi.String("string"),
	},
	RemotePath: pulumi.String("string"),
	AccessMode: pulumi.String("string"),
	CustomAttributes: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	DatastoreClusterId: pulumi.String("string"),
	Folder:             pulumi.String("string"),
	Name:               pulumi.String("string"),
	SecurityType:       pulumi.String("string"),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
	Type: pulumi.String("string"),
})

    var nasDatastoreResource = new NasDatastore("nasDatastoreResource", NasDatastoreArgs.builder()
    .hostSystemIds("string")
    .remoteHosts("string")
    .remotePath("string")
    .accessMode("string")
    .customAttributes(Map.of("string", "string"))
    .datastoreClusterId("string")
    .folder("string")
    .name("string")
    .securityType("string")
    .tags("string")
    .type("string")
    .build());

    nas_datastore_resource = vsphere.NasDatastore("nasDatastoreResource",
    host_system_ids=["string"],
    remote_hosts=["string"],
    remote_path="string",
    access_mode="string",
    custom_attributes={
        "string": "string",
    },
    datastore_cluster_id="string",
    folder="string",
    name="string",
    security_type="string",
    tags=["string"],
    type="string")

    const nasDatastoreResource = new vsphere.NasDatastore("nasDatastoreResource", {
    hostSystemIds: ["string"],
    remoteHosts: ["string"],
    remotePath: "string",
    accessMode: "string",
    customAttributes: {
        string: "string",
    },
    datastoreClusterId: "string",
    folder: "string",
    name: "string",
    securityType: "string",
    tags: ["string"],
    type: "string",
});

    type: vsphere:NasDatastore
properties:
    accessMode: string
    customAttributes:
        string: string
    datastoreClusterId: string
    folder: string
    hostSystemIds:
        - string
    name: string
    remoteHosts:
        - string
    remotePath: string
    securityType: string
    tags:
        - string
    type: string

    NasDatastore 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 NasDatastore resource accepts the following input properties:

    HostSystemIds List<string>
    The managed object IDs of the hosts to mount the datastore on.
    RemoteHosts List<string>
    The hostnames or IP addresses of the remote servers. Only one element should be present for NFS v3 but multiple can be present for NFS v4.1. Forces a new resource if changed.
    RemotePath string
    The remote path of the mount point. Forces a new resource if changed.
    AccessMode string
    Access mode for the mount point. Can be one of readOnly or readWrite. Note that readWrite does not necessarily mean that the datastore will be read-write depending on the permissions of the actual share. Default: readWrite. Forces a new resource if changed.
    CustomAttributes Dictionary<string, string>

    Map of custom attribute ids to attribute value strings to set on datasource resource.

    NOTE: Custom attributes are unsupported on direct ESXi connections and require vCenter.

    DatastoreClusterId string
    The managed object ID of a datastore cluster to put this datastore in. Conflicts with folder.
    Folder string
    The relative path to a folder to put this datastore in. This is a path relative to the datacenter you are deploying the datastore to. Example: for the dc1 datacenter, and a provided folder of foo/bar, The provider will place a datastore named test in a datastore folder located at /dc1/datastore/foo/bar, with the final inventory path being /dc1/datastore/foo/bar/test. Conflicts with datastore_cluster_id.
    Name string
    The name of the datastore. Forces a new resource if changed.
    SecurityType string
    The security type to use when using NFS v4.1. Can be one of AUTH_SYS, SEC_KRB5, or SEC_KRB5I. Forces a new resource if changed.
    Tags List<string>

    The IDs of any tags to attach to this resource.

    NOTE: Tagging support is unsupported on direct ESXi connections and requires vCenter 6.0 or higher.

    Type string
    The type of NAS volume. Can be one of NFS (to denote v3) or NFS41 (to denote NFS v4.1). Default: NFS. Forces a new resource if changed.
    HostSystemIds []string
    The managed object IDs of the hosts to mount the datastore on.
    RemoteHosts []string
    The hostnames or IP addresses of the remote servers. Only one element should be present for NFS v3 but multiple can be present for NFS v4.1. Forces a new resource if changed.
    RemotePath string
    The remote path of the mount point. Forces a new resource if changed.
    AccessMode string
    Access mode for the mount point. Can be one of readOnly or readWrite. Note that readWrite does not necessarily mean that the datastore will be read-write depending on the permissions of the actual share. Default: readWrite. Forces a new resource if changed.
    CustomAttributes map[string]string

    Map of custom attribute ids to attribute value strings to set on datasource resource.

    NOTE: Custom attributes are unsupported on direct ESXi connections and require vCenter.

    DatastoreClusterId string
    The managed object ID of a datastore cluster to put this datastore in. Conflicts with folder.
    Folder string
    The relative path to a folder to put this datastore in. This is a path relative to the datacenter you are deploying the datastore to. Example: for the dc1 datacenter, and a provided folder of foo/bar, The provider will place a datastore named test in a datastore folder located at /dc1/datastore/foo/bar, with the final inventory path being /dc1/datastore/foo/bar/test. Conflicts with datastore_cluster_id.
    Name string
    The name of the datastore. Forces a new resource if changed.
    SecurityType string
    The security type to use when using NFS v4.1. Can be one of AUTH_SYS, SEC_KRB5, or SEC_KRB5I. Forces a new resource if changed.
    Tags []string

    The IDs of any tags to attach to this resource.

    NOTE: Tagging support is unsupported on direct ESXi connections and requires vCenter 6.0 or higher.

    Type string
    The type of NAS volume. Can be one of NFS (to denote v3) or NFS41 (to denote NFS v4.1). Default: NFS. Forces a new resource if changed.
    hostSystemIds List<String>
    The managed object IDs of the hosts to mount the datastore on.
    remoteHosts List<String>
    The hostnames or IP addresses of the remote servers. Only one element should be present for NFS v3 but multiple can be present for NFS v4.1. Forces a new resource if changed.
    remotePath String
    The remote path of the mount point. Forces a new resource if changed.
    accessMode String
    Access mode for the mount point. Can be one of readOnly or readWrite. Note that readWrite does not necessarily mean that the datastore will be read-write depending on the permissions of the actual share. Default: readWrite. Forces a new resource if changed.
    customAttributes Map<String,String>

    Map of custom attribute ids to attribute value strings to set on datasource resource.

    NOTE: Custom attributes are unsupported on direct ESXi connections and require vCenter.

    datastoreClusterId String
    The managed object ID of a datastore cluster to put this datastore in. Conflicts with folder.
    folder String
    The relative path to a folder to put this datastore in. This is a path relative to the datacenter you are deploying the datastore to. Example: for the dc1 datacenter, and a provided folder of foo/bar, The provider will place a datastore named test in a datastore folder located at /dc1/datastore/foo/bar, with the final inventory path being /dc1/datastore/foo/bar/test. Conflicts with datastore_cluster_id.
    name String
    The name of the datastore. Forces a new resource if changed.
    securityType String
    The security type to use when using NFS v4.1. Can be one of AUTH_SYS, SEC_KRB5, or SEC_KRB5I. Forces a new resource if changed.
    tags List<String>

    The IDs of any tags to attach to this resource.

    NOTE: Tagging support is unsupported on direct ESXi connections and requires vCenter 6.0 or higher.

    type String
    The type of NAS volume. Can be one of NFS (to denote v3) or NFS41 (to denote NFS v4.1). Default: NFS. Forces a new resource if changed.
    hostSystemIds string[]
    The managed object IDs of the hosts to mount the datastore on.
    remoteHosts string[]
    The hostnames or IP addresses of the remote servers. Only one element should be present for NFS v3 but multiple can be present for NFS v4.1. Forces a new resource if changed.
    remotePath string
    The remote path of the mount point. Forces a new resource if changed.
    accessMode string
    Access mode for the mount point. Can be one of readOnly or readWrite. Note that readWrite does not necessarily mean that the datastore will be read-write depending on the permissions of the actual share. Default: readWrite. Forces a new resource if changed.
    customAttributes {[key: string]: string}

    Map of custom attribute ids to attribute value strings to set on datasource resource.

    NOTE: Custom attributes are unsupported on direct ESXi connections and require vCenter.

    datastoreClusterId string
    The managed object ID of a datastore cluster to put this datastore in. Conflicts with folder.
    folder string
    The relative path to a folder to put this datastore in. This is a path relative to the datacenter you are deploying the datastore to. Example: for the dc1 datacenter, and a provided folder of foo/bar, The provider will place a datastore named test in a datastore folder located at /dc1/datastore/foo/bar, with the final inventory path being /dc1/datastore/foo/bar/test. Conflicts with datastore_cluster_id.
    name string
    The name of the datastore. Forces a new resource if changed.
    securityType string
    The security type to use when using NFS v4.1. Can be one of AUTH_SYS, SEC_KRB5, or SEC_KRB5I. Forces a new resource if changed.
    tags string[]

    The IDs of any tags to attach to this resource.

    NOTE: Tagging support is unsupported on direct ESXi connections and requires vCenter 6.0 or higher.

    type string
    The type of NAS volume. Can be one of NFS (to denote v3) or NFS41 (to denote NFS v4.1). Default: NFS. Forces a new resource if changed.
    host_system_ids Sequence[str]
    The managed object IDs of the hosts to mount the datastore on.
    remote_hosts Sequence[str]
    The hostnames or IP addresses of the remote servers. Only one element should be present for NFS v3 but multiple can be present for NFS v4.1. Forces a new resource if changed.
    remote_path str
    The remote path of the mount point. Forces a new resource if changed.
    access_mode str
    Access mode for the mount point. Can be one of readOnly or readWrite. Note that readWrite does not necessarily mean that the datastore will be read-write depending on the permissions of the actual share. Default: readWrite. Forces a new resource if changed.
    custom_attributes Mapping[str, str]

    Map of custom attribute ids to attribute value strings to set on datasource resource.

    NOTE: Custom attributes are unsupported on direct ESXi connections and require vCenter.

    datastore_cluster_id str
    The managed object ID of a datastore cluster to put this datastore in. Conflicts with folder.
    folder str
    The relative path to a folder to put this datastore in. This is a path relative to the datacenter you are deploying the datastore to. Example: for the dc1 datacenter, and a provided folder of foo/bar, The provider will place a datastore named test in a datastore folder located at /dc1/datastore/foo/bar, with the final inventory path being /dc1/datastore/foo/bar/test. Conflicts with datastore_cluster_id.
    name str
    The name of the datastore. Forces a new resource if changed.
    security_type str
    The security type to use when using NFS v4.1. Can be one of AUTH_SYS, SEC_KRB5, or SEC_KRB5I. Forces a new resource if changed.
    tags Sequence[str]

    The IDs of any tags to attach to this resource.

    NOTE: Tagging support is unsupported on direct ESXi connections and requires vCenter 6.0 or higher.

    type str
    The type of NAS volume. Can be one of NFS (to denote v3) or NFS41 (to denote NFS v4.1). Default: NFS. Forces a new resource if changed.
    hostSystemIds List<String>
    The managed object IDs of the hosts to mount the datastore on.
    remoteHosts List<String>
    The hostnames or IP addresses of the remote servers. Only one element should be present for NFS v3 but multiple can be present for NFS v4.1. Forces a new resource if changed.
    remotePath String
    The remote path of the mount point. Forces a new resource if changed.
    accessMode String
    Access mode for the mount point. Can be one of readOnly or readWrite. Note that readWrite does not necessarily mean that the datastore will be read-write depending on the permissions of the actual share. Default: readWrite. Forces a new resource if changed.
    customAttributes Map<String>

    Map of custom attribute ids to attribute value strings to set on datasource resource.

    NOTE: Custom attributes are unsupported on direct ESXi connections and require vCenter.

    datastoreClusterId String
    The managed object ID of a datastore cluster to put this datastore in. Conflicts with folder.
    folder String
    The relative path to a folder to put this datastore in. This is a path relative to the datacenter you are deploying the datastore to. Example: for the dc1 datacenter, and a provided folder of foo/bar, The provider will place a datastore named test in a datastore folder located at /dc1/datastore/foo/bar, with the final inventory path being /dc1/datastore/foo/bar/test. Conflicts with datastore_cluster_id.
    name String
    The name of the datastore. Forces a new resource if changed.
    securityType String
    The security type to use when using NFS v4.1. Can be one of AUTH_SYS, SEC_KRB5, or SEC_KRB5I. Forces a new resource if changed.
    tags List<String>

    The IDs of any tags to attach to this resource.

    NOTE: Tagging support is unsupported on direct ESXi connections and requires vCenter 6.0 or higher.

    type String
    The type of NAS volume. Can be one of NFS (to denote v3) or NFS41 (to denote NFS v4.1). Default: NFS. Forces a new resource if changed.

    Outputs

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

    Accessible bool
    The connectivity status of the datastore. If this is false, some other computed attributes may be out of date.
    Capacity int
    Maximum capacity of the datastore, in megabytes.
    FreeSpace int
    Available space of this datastore, in megabytes.
    Id string
    The provider-assigned unique ID for this managed resource.
    MaintenanceMode string
    The current maintenance mode state of the datastore.
    MultipleHostAccess bool
    If true, more than one host in the datacenter has been configured with access to the datastore.
    ProtocolEndpoint bool
    Indicates that this NAS volume is a protocol endpoint. This field is only populated if the host supports virtual datastores.
    UncommittedSpace int
    Total additional storage space, in megabytes, potentially used by all virtual machines on this datastore.
    Url string
    The unique locator for the datastore.
    Accessible bool
    The connectivity status of the datastore. If this is false, some other computed attributes may be out of date.
    Capacity int
    Maximum capacity of the datastore, in megabytes.
    FreeSpace int
    Available space of this datastore, in megabytes.
    Id string
    The provider-assigned unique ID for this managed resource.
    MaintenanceMode string
    The current maintenance mode state of the datastore.
    MultipleHostAccess bool
    If true, more than one host in the datacenter has been configured with access to the datastore.
    ProtocolEndpoint bool
    Indicates that this NAS volume is a protocol endpoint. This field is only populated if the host supports virtual datastores.
    UncommittedSpace int
    Total additional storage space, in megabytes, potentially used by all virtual machines on this datastore.
    Url string
    The unique locator for the datastore.
    accessible Boolean
    The connectivity status of the datastore. If this is false, some other computed attributes may be out of date.
    capacity Integer
    Maximum capacity of the datastore, in megabytes.
    freeSpace Integer
    Available space of this datastore, in megabytes.
    id String
    The provider-assigned unique ID for this managed resource.
    maintenanceMode String
    The current maintenance mode state of the datastore.
    multipleHostAccess Boolean
    If true, more than one host in the datacenter has been configured with access to the datastore.
    protocolEndpoint Boolean
    Indicates that this NAS volume is a protocol endpoint. This field is only populated if the host supports virtual datastores.
    uncommittedSpace Integer
    Total additional storage space, in megabytes, potentially used by all virtual machines on this datastore.
    url String
    The unique locator for the datastore.
    accessible boolean
    The connectivity status of the datastore. If this is false, some other computed attributes may be out of date.
    capacity number
    Maximum capacity of the datastore, in megabytes.
    freeSpace number
    Available space of this datastore, in megabytes.
    id string
    The provider-assigned unique ID for this managed resource.
    maintenanceMode string
    The current maintenance mode state of the datastore.
    multipleHostAccess boolean
    If true, more than one host in the datacenter has been configured with access to the datastore.
    protocolEndpoint boolean
    Indicates that this NAS volume is a protocol endpoint. This field is only populated if the host supports virtual datastores.
    uncommittedSpace number
    Total additional storage space, in megabytes, potentially used by all virtual machines on this datastore.
    url string
    The unique locator for the datastore.
    accessible bool
    The connectivity status of the datastore. If this is false, some other computed attributes may be out of date.
    capacity int
    Maximum capacity of the datastore, in megabytes.
    free_space int
    Available space of this datastore, in megabytes.
    id str
    The provider-assigned unique ID for this managed resource.
    maintenance_mode str
    The current maintenance mode state of the datastore.
    multiple_host_access bool
    If true, more than one host in the datacenter has been configured with access to the datastore.
    protocol_endpoint bool
    Indicates that this NAS volume is a protocol endpoint. This field is only populated if the host supports virtual datastores.
    uncommitted_space int
    Total additional storage space, in megabytes, potentially used by all virtual machines on this datastore.
    url str
    The unique locator for the datastore.
    accessible Boolean
    The connectivity status of the datastore. If this is false, some other computed attributes may be out of date.
    capacity Number
    Maximum capacity of the datastore, in megabytes.
    freeSpace Number
    Available space of this datastore, in megabytes.
    id String
    The provider-assigned unique ID for this managed resource.
    maintenanceMode String
    The current maintenance mode state of the datastore.
    multipleHostAccess Boolean
    If true, more than one host in the datacenter has been configured with access to the datastore.
    protocolEndpoint Boolean
    Indicates that this NAS volume is a protocol endpoint. This field is only populated if the host supports virtual datastores.
    uncommittedSpace Number
    Total additional storage space, in megabytes, potentially used by all virtual machines on this datastore.
    url String
    The unique locator for the datastore.

    Look up Existing NasDatastore Resource

    Get an existing NasDatastore 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?: NasDatastoreState, opts?: CustomResourceOptions): NasDatastore
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access_mode: Optional[str] = None,
        accessible: Optional[bool] = None,
        capacity: Optional[int] = None,
        custom_attributes: Optional[Mapping[str, str]] = None,
        datastore_cluster_id: Optional[str] = None,
        folder: Optional[str] = None,
        free_space: Optional[int] = None,
        host_system_ids: Optional[Sequence[str]] = None,
        maintenance_mode: Optional[str] = None,
        multiple_host_access: Optional[bool] = None,
        name: Optional[str] = None,
        protocol_endpoint: Optional[bool] = None,
        remote_hosts: Optional[Sequence[str]] = None,
        remote_path: Optional[str] = None,
        security_type: Optional[str] = None,
        tags: Optional[Sequence[str]] = None,
        type: Optional[str] = None,
        uncommitted_space: Optional[int] = None,
        url: Optional[str] = None) -> NasDatastore
    func GetNasDatastore(ctx *Context, name string, id IDInput, state *NasDatastoreState, opts ...ResourceOption) (*NasDatastore, error)
    public static NasDatastore Get(string name, Input<string> id, NasDatastoreState? state, CustomResourceOptions? opts = null)
    public static NasDatastore get(String name, Output<String> id, NasDatastoreState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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:
    AccessMode string
    Access mode for the mount point. Can be one of readOnly or readWrite. Note that readWrite does not necessarily mean that the datastore will be read-write depending on the permissions of the actual share. Default: readWrite. Forces a new resource if changed.
    Accessible bool
    The connectivity status of the datastore. If this is false, some other computed attributes may be out of date.
    Capacity int
    Maximum capacity of the datastore, in megabytes.
    CustomAttributes Dictionary<string, string>

    Map of custom attribute ids to attribute value strings to set on datasource resource.

    NOTE: Custom attributes are unsupported on direct ESXi connections and require vCenter.

    DatastoreClusterId string
    The managed object ID of a datastore cluster to put this datastore in. Conflicts with folder.
    Folder string
    The relative path to a folder to put this datastore in. This is a path relative to the datacenter you are deploying the datastore to. Example: for the dc1 datacenter, and a provided folder of foo/bar, The provider will place a datastore named test in a datastore folder located at /dc1/datastore/foo/bar, with the final inventory path being /dc1/datastore/foo/bar/test. Conflicts with datastore_cluster_id.
    FreeSpace int
    Available space of this datastore, in megabytes.
    HostSystemIds List<string>
    The managed object IDs of the hosts to mount the datastore on.
    MaintenanceMode string
    The current maintenance mode state of the datastore.
    MultipleHostAccess bool
    If true, more than one host in the datacenter has been configured with access to the datastore.
    Name string
    The name of the datastore. Forces a new resource if changed.
    ProtocolEndpoint bool
    Indicates that this NAS volume is a protocol endpoint. This field is only populated if the host supports virtual datastores.
    RemoteHosts List<string>
    The hostnames or IP addresses of the remote servers. Only one element should be present for NFS v3 but multiple can be present for NFS v4.1. Forces a new resource if changed.
    RemotePath string
    The remote path of the mount point. Forces a new resource if changed.
    SecurityType string
    The security type to use when using NFS v4.1. Can be one of AUTH_SYS, SEC_KRB5, or SEC_KRB5I. Forces a new resource if changed.
    Tags List<string>

    The IDs of any tags to attach to this resource.

    NOTE: Tagging support is unsupported on direct ESXi connections and requires vCenter 6.0 or higher.

    Type string
    The type of NAS volume. Can be one of NFS (to denote v3) or NFS41 (to denote NFS v4.1). Default: NFS. Forces a new resource if changed.
    UncommittedSpace int
    Total additional storage space, in megabytes, potentially used by all virtual machines on this datastore.
    Url string
    The unique locator for the datastore.
    AccessMode string
    Access mode for the mount point. Can be one of readOnly or readWrite. Note that readWrite does not necessarily mean that the datastore will be read-write depending on the permissions of the actual share. Default: readWrite. Forces a new resource if changed.
    Accessible bool
    The connectivity status of the datastore. If this is false, some other computed attributes may be out of date.
    Capacity int
    Maximum capacity of the datastore, in megabytes.
    CustomAttributes map[string]string

    Map of custom attribute ids to attribute value strings to set on datasource resource.

    NOTE: Custom attributes are unsupported on direct ESXi connections and require vCenter.

    DatastoreClusterId string
    The managed object ID of a datastore cluster to put this datastore in. Conflicts with folder.
    Folder string
    The relative path to a folder to put this datastore in. This is a path relative to the datacenter you are deploying the datastore to. Example: for the dc1 datacenter, and a provided folder of foo/bar, The provider will place a datastore named test in a datastore folder located at /dc1/datastore/foo/bar, with the final inventory path being /dc1/datastore/foo/bar/test. Conflicts with datastore_cluster_id.
    FreeSpace int
    Available space of this datastore, in megabytes.
    HostSystemIds []string
    The managed object IDs of the hosts to mount the datastore on.
    MaintenanceMode string
    The current maintenance mode state of the datastore.
    MultipleHostAccess bool
    If true, more than one host in the datacenter has been configured with access to the datastore.
    Name string
    The name of the datastore. Forces a new resource if changed.
    ProtocolEndpoint bool
    Indicates that this NAS volume is a protocol endpoint. This field is only populated if the host supports virtual datastores.
    RemoteHosts []string
    The hostnames or IP addresses of the remote servers. Only one element should be present for NFS v3 but multiple can be present for NFS v4.1. Forces a new resource if changed.
    RemotePath string
    The remote path of the mount point. Forces a new resource if changed.
    SecurityType string
    The security type to use when using NFS v4.1. Can be one of AUTH_SYS, SEC_KRB5, or SEC_KRB5I. Forces a new resource if changed.
    Tags []string

    The IDs of any tags to attach to this resource.

    NOTE: Tagging support is unsupported on direct ESXi connections and requires vCenter 6.0 or higher.

    Type string
    The type of NAS volume. Can be one of NFS (to denote v3) or NFS41 (to denote NFS v4.1). Default: NFS. Forces a new resource if changed.
    UncommittedSpace int
    Total additional storage space, in megabytes, potentially used by all virtual machines on this datastore.
    Url string
    The unique locator for the datastore.
    accessMode String
    Access mode for the mount point. Can be one of readOnly or readWrite. Note that readWrite does not necessarily mean that the datastore will be read-write depending on the permissions of the actual share. Default: readWrite. Forces a new resource if changed.
    accessible Boolean
    The connectivity status of the datastore. If this is false, some other computed attributes may be out of date.
    capacity Integer
    Maximum capacity of the datastore, in megabytes.
    customAttributes Map<String,String>

    Map of custom attribute ids to attribute value strings to set on datasource resource.

    NOTE: Custom attributes are unsupported on direct ESXi connections and require vCenter.

    datastoreClusterId String
    The managed object ID of a datastore cluster to put this datastore in. Conflicts with folder.
    folder String
    The relative path to a folder to put this datastore in. This is a path relative to the datacenter you are deploying the datastore to. Example: for the dc1 datacenter, and a provided folder of foo/bar, The provider will place a datastore named test in a datastore folder located at /dc1/datastore/foo/bar, with the final inventory path being /dc1/datastore/foo/bar/test. Conflicts with datastore_cluster_id.
    freeSpace Integer
    Available space of this datastore, in megabytes.
    hostSystemIds List<String>
    The managed object IDs of the hosts to mount the datastore on.
    maintenanceMode String
    The current maintenance mode state of the datastore.
    multipleHostAccess Boolean
    If true, more than one host in the datacenter has been configured with access to the datastore.
    name String
    The name of the datastore. Forces a new resource if changed.
    protocolEndpoint Boolean
    Indicates that this NAS volume is a protocol endpoint. This field is only populated if the host supports virtual datastores.
    remoteHosts List<String>
    The hostnames or IP addresses of the remote servers. Only one element should be present for NFS v3 but multiple can be present for NFS v4.1. Forces a new resource if changed.
    remotePath String
    The remote path of the mount point. Forces a new resource if changed.
    securityType String
    The security type to use when using NFS v4.1. Can be one of AUTH_SYS, SEC_KRB5, or SEC_KRB5I. Forces a new resource if changed.
    tags List<String>

    The IDs of any tags to attach to this resource.

    NOTE: Tagging support is unsupported on direct ESXi connections and requires vCenter 6.0 or higher.

    type String
    The type of NAS volume. Can be one of NFS (to denote v3) or NFS41 (to denote NFS v4.1). Default: NFS. Forces a new resource if changed.
    uncommittedSpace Integer
    Total additional storage space, in megabytes, potentially used by all virtual machines on this datastore.
    url String
    The unique locator for the datastore.
    accessMode string
    Access mode for the mount point. Can be one of readOnly or readWrite. Note that readWrite does not necessarily mean that the datastore will be read-write depending on the permissions of the actual share. Default: readWrite. Forces a new resource if changed.
    accessible boolean
    The connectivity status of the datastore. If this is false, some other computed attributes may be out of date.
    capacity number
    Maximum capacity of the datastore, in megabytes.
    customAttributes {[key: string]: string}

    Map of custom attribute ids to attribute value strings to set on datasource resource.

    NOTE: Custom attributes are unsupported on direct ESXi connections and require vCenter.

    datastoreClusterId string
    The managed object ID of a datastore cluster to put this datastore in. Conflicts with folder.
    folder string
    The relative path to a folder to put this datastore in. This is a path relative to the datacenter you are deploying the datastore to. Example: for the dc1 datacenter, and a provided folder of foo/bar, The provider will place a datastore named test in a datastore folder located at /dc1/datastore/foo/bar, with the final inventory path being /dc1/datastore/foo/bar/test. Conflicts with datastore_cluster_id.
    freeSpace number
    Available space of this datastore, in megabytes.
    hostSystemIds string[]
    The managed object IDs of the hosts to mount the datastore on.
    maintenanceMode string
    The current maintenance mode state of the datastore.
    multipleHostAccess boolean
    If true, more than one host in the datacenter has been configured with access to the datastore.
    name string
    The name of the datastore. Forces a new resource if changed.
    protocolEndpoint boolean
    Indicates that this NAS volume is a protocol endpoint. This field is only populated if the host supports virtual datastores.
    remoteHosts string[]
    The hostnames or IP addresses of the remote servers. Only one element should be present for NFS v3 but multiple can be present for NFS v4.1. Forces a new resource if changed.
    remotePath string
    The remote path of the mount point. Forces a new resource if changed.
    securityType string
    The security type to use when using NFS v4.1. Can be one of AUTH_SYS, SEC_KRB5, or SEC_KRB5I. Forces a new resource if changed.
    tags string[]

    The IDs of any tags to attach to this resource.

    NOTE: Tagging support is unsupported on direct ESXi connections and requires vCenter 6.0 or higher.

    type string
    The type of NAS volume. Can be one of NFS (to denote v3) or NFS41 (to denote NFS v4.1). Default: NFS. Forces a new resource if changed.
    uncommittedSpace number
    Total additional storage space, in megabytes, potentially used by all virtual machines on this datastore.
    url string
    The unique locator for the datastore.
    access_mode str
    Access mode for the mount point. Can be one of readOnly or readWrite. Note that readWrite does not necessarily mean that the datastore will be read-write depending on the permissions of the actual share. Default: readWrite. Forces a new resource if changed.
    accessible bool
    The connectivity status of the datastore. If this is false, some other computed attributes may be out of date.
    capacity int
    Maximum capacity of the datastore, in megabytes.
    custom_attributes Mapping[str, str]

    Map of custom attribute ids to attribute value strings to set on datasource resource.

    NOTE: Custom attributes are unsupported on direct ESXi connections and require vCenter.

    datastore_cluster_id str
    The managed object ID of a datastore cluster to put this datastore in. Conflicts with folder.
    folder str
    The relative path to a folder to put this datastore in. This is a path relative to the datacenter you are deploying the datastore to. Example: for the dc1 datacenter, and a provided folder of foo/bar, The provider will place a datastore named test in a datastore folder located at /dc1/datastore/foo/bar, with the final inventory path being /dc1/datastore/foo/bar/test. Conflicts with datastore_cluster_id.
    free_space int
    Available space of this datastore, in megabytes.
    host_system_ids Sequence[str]
    The managed object IDs of the hosts to mount the datastore on.
    maintenance_mode str
    The current maintenance mode state of the datastore.
    multiple_host_access bool
    If true, more than one host in the datacenter has been configured with access to the datastore.
    name str
    The name of the datastore. Forces a new resource if changed.
    protocol_endpoint bool
    Indicates that this NAS volume is a protocol endpoint. This field is only populated if the host supports virtual datastores.
    remote_hosts Sequence[str]
    The hostnames or IP addresses of the remote servers. Only one element should be present for NFS v3 but multiple can be present for NFS v4.1. Forces a new resource if changed.
    remote_path str
    The remote path of the mount point. Forces a new resource if changed.
    security_type str
    The security type to use when using NFS v4.1. Can be one of AUTH_SYS, SEC_KRB5, or SEC_KRB5I. Forces a new resource if changed.
    tags Sequence[str]

    The IDs of any tags to attach to this resource.

    NOTE: Tagging support is unsupported on direct ESXi connections and requires vCenter 6.0 or higher.

    type str
    The type of NAS volume. Can be one of NFS (to denote v3) or NFS41 (to denote NFS v4.1). Default: NFS. Forces a new resource if changed.
    uncommitted_space int
    Total additional storage space, in megabytes, potentially used by all virtual machines on this datastore.
    url str
    The unique locator for the datastore.
    accessMode String
    Access mode for the mount point. Can be one of readOnly or readWrite. Note that readWrite does not necessarily mean that the datastore will be read-write depending on the permissions of the actual share. Default: readWrite. Forces a new resource if changed.
    accessible Boolean
    The connectivity status of the datastore. If this is false, some other computed attributes may be out of date.
    capacity Number
    Maximum capacity of the datastore, in megabytes.
    customAttributes Map<String>

    Map of custom attribute ids to attribute value strings to set on datasource resource.

    NOTE: Custom attributes are unsupported on direct ESXi connections and require vCenter.

    datastoreClusterId String
    The managed object ID of a datastore cluster to put this datastore in. Conflicts with folder.
    folder String
    The relative path to a folder to put this datastore in. This is a path relative to the datacenter you are deploying the datastore to. Example: for the dc1 datacenter, and a provided folder of foo/bar, The provider will place a datastore named test in a datastore folder located at /dc1/datastore/foo/bar, with the final inventory path being /dc1/datastore/foo/bar/test. Conflicts with datastore_cluster_id.
    freeSpace Number
    Available space of this datastore, in megabytes.
    hostSystemIds List<String>
    The managed object IDs of the hosts to mount the datastore on.
    maintenanceMode String
    The current maintenance mode state of the datastore.
    multipleHostAccess Boolean
    If true, more than one host in the datacenter has been configured with access to the datastore.
    name String
    The name of the datastore. Forces a new resource if changed.
    protocolEndpoint Boolean
    Indicates that this NAS volume is a protocol endpoint. This field is only populated if the host supports virtual datastores.
    remoteHosts List<String>
    The hostnames or IP addresses of the remote servers. Only one element should be present for NFS v3 but multiple can be present for NFS v4.1. Forces a new resource if changed.
    remotePath String
    The remote path of the mount point. Forces a new resource if changed.
    securityType String
    The security type to use when using NFS v4.1. Can be one of AUTH_SYS, SEC_KRB5, or SEC_KRB5I. Forces a new resource if changed.
    tags List<String>

    The IDs of any tags to attach to this resource.

    NOTE: Tagging support is unsupported on direct ESXi connections and requires vCenter 6.0 or higher.

    type String
    The type of NAS volume. Can be one of NFS (to denote v3) or NFS41 (to denote NFS v4.1). Default: NFS. Forces a new resource if changed.
    uncommittedSpace Number
    Total additional storage space, in megabytes, potentially used by all virtual machines on this datastore.
    url String
    The unique locator for the datastore.

    Import

    An existing NAS datastore can be imported into this resource via

    its managed object ID, via the following command:

    $ pulumi import vsphere:index/nasDatastore:NasDatastore datastore datastore-123

    You need a tool like govc that can display managed object IDs.

    In the case of govc, you can locate a managed object ID from an inventory path

    by doing the following:

    $ govc ls -i /dc/datastore/terraform-test

    Datastore:datastore-123

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

    Package Details

    Repository
    vSphere pulumi/pulumi-vsphere
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the vsphere Terraform Provider.
    vsphere logo
    vSphere v4.12.1 published on Tuesday, Oct 22, 2024 by Pulumi
    pulumi/pulumi-vsphere