vSAN Management API


Data Object - VsanFileServiceShareHealthSummary(vim.host.VsanFileServiceShareHealthSummary)

Property of
VsanFileServiceHealthSummary
Extends
DynamicData
See also
VsanObjectOverallHealth
Since
7.0

Data Object Description

This class defines file service share health summary in cluster level.

Properties

Name Type Description
description*xsd:string

The description of the health status. It includes the detail of the vSAN objects in error state and the status of file server.
domainName*xsd:string

The name of the domain. See VsanDirectoryServerConfig for more detailed information about vSAN file service domain.
extensible*xsd:boolean

The extensibility of this file share. The file share is backed by vSAN objects, and each vSAN object can provide 255GB in maximum. So if the file share needs to grow beyond this limit, more vSAN objects should be provisioned. This item is to check whether the storage policy of this file share can be met by the current cluster for provisioning more backing vSAN objects. If the storage policy cannot be met by the cluster, and the quota of the file share cannot be satisfied by current backing vSAN object, this field will be set to False to indicate this issue. Note: the provisioning of the vSAN object will be impacted by other facts, e.g., network partition. Check the network health and host state first before validating the extensibility of the file share.

Since vSAN 7.0U1
objectHealth*VsanObjectOverallHealth

The health status of share's backing vSAN objects. If any object is not healthy the overall healthy will be 'red'.
overallHealth*xsd:string

Overall health state for this vSAN file service share. The possible state of the file service share could be one of the following:
  • 'green' if the file server for this file share is running properly and all its backing vSAN objects are healthy.
  • 'red' if the file server for this file share is in error state or any of its backing vSAN objects are degraded.
shareName*xsd:string

The name of the file share.
sharePolicyMismatch*xsd:boolean

This field is to check whether the storage policy of this file share mismatches latest version of the SPBM policy. Whenever SPBM policy is changed, the change needs to be propagated to associated file shares.The mismatch status would be used as a health check when file share is queried.

Since 9.0.0.0
shareUuid*xsd:string

The UUID of the file share.
spbmProfileGenerationId*xsd:string

Generation ID of SPBM profile used for the policy of the object when it was applied to vSAN File Service share. Not set if the share doesn't use a SPBM managed policy.

Since 9.0.0.0
spbmProfileUuid*xsd:string

UUID of SPBM profile used for the policy of the object when it was applied to vSAN File Service share. Not set if the share doesn't use an SPBM managed policy.

Since 9.0.0.0
Properties inherited from DynamicData
None
*Need not be set
Show WSDL type definition