Data Object - HostNasVolumeSpec(

Property of
Parameter to

Data Object Description

Specification for creating NAS volume.

When mounting a NAS volume on multiple hosts, the same remoteHost and remotePath values should be used on every host, otherwise it will be treated as different datastores. For example, if one host references the remotePath of a NAS volume as "/mnt/mount1" and another references it as "/mnt/mount1/", it will not be recognized as the same datastore.


Name Type Description

Access mode for the mount point.

Mounting in read-write mode would be successful irregardless on how the mount point is exported or access permissions. For example, mounting a volume that is exported as read-only as readWrite will succeed. Hence, that a readWrite mount succeeds should not be taken as an indication that all files on a mount is writable.

If a file system is mounted readOnly, the system cannot create or modify any files on the file system. This is mostly useful for storing ISO images and templates, since a virtual machine cannot be powered on from a readOnly volume.

The access mode of a mounted NFS volume can be obtained at accessMode.

See HostMountMode


The localPath refers to the name of the NAS datastore to be created using this specification.

In the case of ESX Server, the datastore name is a component in the file system path at which the NAS volume can be found. For example, if localPath is set to "nas_volume" the created NAS datastore will be named "nas_volume" and it can be accessed via the file system path "/vmfs/volumes/nas_volume".

In the case of VMware Server, the localPath will also be used as the datastore name, but the datastore name may not necessarily be reflected in the file system path where the NAS volume may be accessed.


If type is CIFS, the password to use when connecting to the CIFS server. If type is NFS, this field will be ignored.

Since VI API 2.5

The host that runs the NFS v3 or CIFS server. For NFS v4.1 and beyond use remoteHostNames defined later. The field remotehost may be deprecated in future for NFS, so clients should plan to use the property remoteHostNames to send in the host name(s) for both NFS v3 and v4.1

Hostnames or IP addresses of remote NFS server. In case of NFS v4.1 this may have multiple entries. For NFS v3 the input should be same in both remoteHost and remoteHostNames.

Since vSphere API 6.0

The remote path of the NFS mount point.

Provided during mount indicating what security type, if any, to use See HostNasVolumeSecurityType

Since vSphere API 6.0

Specifies the type of the the NAS volume. Supported types are CIFS, NFS, NFS41 If not specified, defaults to NFS

Since VI API 2.5

If type is CIFS, the user name to use when connecting to the CIFS server. If type is NFS, this field will be ignored.

Since VI API 2.5
Properties inherited from DynamicData
*Need not be set
Show WSDL type definition