HostMountInfo

HostMountInfo
HostMountInfo

The HostMountInfo data object provides information related to a configured mount point.

This object does not include information about the mounted file system. (See HostFileSystemMountInfo.)

AllOf
This class requires all of the following:
JSON Example
{
    "_typeName": "string",
    "path": "string",
    "accessMode": "string",
    "mounted": false,
    "accessible": false,
    "inaccessibleReason": "string",
    "vmknicName": "string",
    "vmknicActive": false,
    "mountFailedReason": "string",
    "numTcpConnections": 0
}
string
path
Optional

Local file path where file system volume is mounted, if applicable.

This path identifies the file system volume from the point of view of the host.

string
accessMode
Required

Access mode to the underlying file system for this host.

boolean
mounted
Optional

The mount state of this mount point.

For a discovered volume, which is mounted, this is true. When this value is unset, the default value is true.

boolean
accessible
Optional

Flag that indicates if the datastore is currently accessible from the host.

For the case of a standalone host, this property has the same value as DatastoreSummary.accessible. You can use the DatastoreSummary property if the HostMountInfo property is not set. The VirtualCenter Server will always make sure the DatastoreSummary property is set correctly.

string
inaccessibleReason
Optional

This optional property for inaccessible reason is reported only if a datastore becomes inaccessible as reported by accessible and DatastoreSummary.accessible.

The values for inaccessible reason are defined in the enum HostMountInfoInaccessibleReasonEnum This helps to determine host specific reason for datastore inaccessibility. If the datastore becomes accessible following an inaccessible condition, the property inaccessibleReason will be unset.

string
vmknicName
Optional

The name of the vmknic used during mount.

Populated by the vmk control layer if the NAS volume is mounted successfully with a vmknic binding.

Since: vSphere API Release 8.0.1.0

boolean
vmknicActive
Optional

Indicates whether vmknic is active or inactive.

This field will be populated by vmk control layer during NAS volume mount, and will be set to true if the vmknic binding is active.

Since: vSphere API Release 8.0.1.0

string
mountFailedReason
Optional

The optional property which gives the reason for mount operation failure of NFS datastore.

This field is applicable for only those mounts for which retry mount operation is configured. The values for the mount failed reason are defined in the enum HostMountInfoMountFailedReasonEnum. If mount operation on NFS volume succeeds in the retry, then the property mountFailedReason will be unset.

Since: vSphere API Release 8.0.0.1

integer As int32 As int32
numTcpConnections
Optional

Maintained for each Host, it indicates the total number of TCP connections for the NAS datastore

Since: vSphere API Release 8.0.1.0