Class NasDatastore

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.

Inheritance

System.Object

Resource

CustomResource

NasDatastore

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.VSphere

Assembly: Pulumi.VSphere.dll

Syntax

public class NasDatastore : CustomResource

Constructors

NasDatastore(String, NasDatastoreArgs, CustomResourceOptions)

Create a NasDatastore resource with the given unique name, arguments, and options.

Declaration

public NasDatastore(string name, NasDatastoreArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
NasDatastoreArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

Accessible

The connectivity status of the datastore. If this is false, some other computed attributes may be out of date.

Declaration

public Output<bool> Accessible { get; }

Property Value

Type	Description
Output<System.Boolean>

AccessMode

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.

Declaration

public Output<string> AccessMode { get; }

Property Value

Type	Description
Output<System.String>

Capacity

Maximum capacity of the datastore, in megabytes.

Declaration

public Output<int> Capacity { get; }

Property Value

Type	Description
Output<System.Int32>

CustomAttributes

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

Declaration

public Output<ImmutableDictionary<string, string>> CustomAttributes { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.String>>

DatastoreClusterId

The managed object ID of a datastore cluster to put this datastore in. Conflicts with folder.

Declaration

public Output<string> DatastoreClusterId { get; }

Property Value

Type	Description
Output<System.String>

Folder

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.

Declaration

public Output<string> Folder { get; }

Property Value

Type	Description
Output<System.String>

FreeSpace

Available space of this datastore, in megabytes.

Declaration

public Output<int> FreeSpace { get; }

Property Value

Type	Description
Output<System.Int32>

HostSystemIds

The managed object IDs of the hosts to mount the datastore on.

Declaration

public Output<ImmutableArray<string>> HostSystemIds { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

MaintenanceMode

The current maintenance mode state of the datastore.

Declaration

public Output<string> MaintenanceMode { get; }

Property Value

Type	Description
Output<System.String>

MultipleHostAccess

If true, more than one host in the datacenter has been configured with access to the datastore.

Declaration

public Output<bool> MultipleHostAccess { get; }

Property Value

Type	Description
Output<System.Boolean>

Name

The name of the datastore. Forces a new resource if changed.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

ProtocolEndpoint

Indicates that this NAS volume is a protocol endpoint. This field is only populated if the host supports virtual datastores.

Declaration

public Output<string> ProtocolEndpoint { get; }

Property Value

Type	Description
Output<System.String>

RemoteHosts

The hostnames or IP addresses of the remote server or 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.

Declaration

public Output<ImmutableArray<string>> RemoteHosts { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

RemotePath

The remote path of the mount point. Forces a new resource if changed.

Declaration

public Output<string> RemotePath { get; }

Property Value

Type	Description
Output<System.String>

SecurityType

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.

Declaration

public Output<string> SecurityType { get; }

Property Value

Type	Description
Output<System.String>

Tags

The IDs of any tags to attach to this resource.

Declaration

public Output<ImmutableArray<string>> Tags { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

Type

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.

Declaration

public Output<string> Type { get; }

Property Value

Type	Description
Output<System.String>

UncommittedSpace

Total additional storage space, in megabytes, potentially used by all virtual machines on this datastore.

Declaration

public Output<int> UncommittedSpace { get; }

Property Value

Type	Description
Output<System.Int32>

Url

The unique locator for the datastore.

Declaration

public Output<string> Url { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, NasDatastoreState, CustomResourceOptions)

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

Declaration

public static NasDatastore Get(string name, Input<string> id, NasDatastoreState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
NasDatastoreState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
NasDatastore