15f7be9a52
This external documentation for pyVmomi was generated using Googly Docs (aka Google Standard Documentation) which renders very cleanly in GitHub. Internal documentation for a class should be done in Sphinx format because tools like pyCharm and Eclipse can use that documentation as a hint for code completion. Note: External docs as Googly Docs, internal docs as Sphinx. Closes bug#15
37 lines
2.8 KiB
ReStructuredText
37 lines
2.8 KiB
ReStructuredText
.. _str: https://docs.python.org/2/library/stdtypes.html
|
|
|
|
.. _accessMode: ../../../vim/host/MountInfo.rst#accessMode
|
|
|
|
.. _HostMountMode: ../../../vim/host/MountInfo/AccessMode.rst
|
|
|
|
.. _vmodl.DynamicData: ../../../vmodl/DynamicData.rst
|
|
|
|
|
|
vim.host.NasVolume.Specification
|
|
================================
|
|
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.
|
|
:extends: vmodl.DynamicData_
|
|
|
|
Attributes:
|
|
remoteHost (`str`_):
|
|
|
|
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
|
|
remotePath (`str`_):
|
|
|
|
The remote path of the NFS mount point.
|
|
localPath (`str`_):
|
|
|
|
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.
|
|
accessMode (`str`_):
|
|
|
|
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`_
|
|
type (`str`_, optional):
|
|
|
|
The type of the the NAS volume (CIFS / NFS). If not specified, defaults to nfs.
|
|
userName (`str`_, optional):
|
|
|
|
If type is CIFS, the user name to use when connecting to the CIFS server. If type is NFS, this field will be ignored.
|
|
password (`str`_, optional):
|
|
|
|
If type is CIFS, the password to use when connecting to the CIFS server. If type is NFS, this field will be ignored.
|