MSCluster_ClusterSharedVolume class

A dynamic WMI class that represents a cluster shared volume (CSV).

The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.

Syntax

[Dynamic, Provider("MS_CLUSTER_PROVIDER"), UUID("{15b2185f-3e18-4685-9136-5a3695ef62a6}"), AMENDMENT]
class MSCluster_ClusterSharedVolume : MSCluster_LogicalElement
{
  string   Caption;
  string   Description;
  datetime InstallDate;
  string   Status;
  string   Name;
  uint32   Flags;
  uint32   Characteristics;
  string   VolumeName;
  uint32   FaultState;
  uint64   VolumeOffset;
  uint32   BackupState;
};

Members

The MSCluster_ClusterSharedVolume class has these types of members:

Methods

The MSCluster_ClusterSharedVolume class has these methods.

MethodDescription
MoveToNewHost

Moves the cluster shared volume to a another node. All volumes of this resource will also be moved.

TurnOffMaintenance

Takes the cluster shared volume out of maintenance mode.

TurnOffRedirectedAccess

Disables direct IO on the cluster shared volume.

TurnOnMaintenance

Places the cluster shared volume into maintenance mode.

TurnOnRedirectedAccess

Enables direct IO on the cluster shared volume.

 

Properties

The MSCluster_ClusterSharedVolume class has these properties.

BackupState
Data type: uint32
Access type: Read-only

Returns the backup state of the cluster shared volume.

None (0)

In Progress (1)

Windows Server 2012 and Windows Server 2008 R2:  This value was InProgress before Windows Server 2012 R2.

Caption
Data type: string
Access type: Read-only
Qualifiers: MaxLen (64)

A short textual description (one-line string) of the object.

This property is inherited from CIM_ManagedSystemElement.

Characteristics
Data type: uint32
Access type: Read-only

Provides the characteristics of the object. The cluster defines characteristics only for resources. For a description of these characteristics, see CLUSCTL_RESOURCE_GET_CHARACTERISTICS.

Windows Server 2008 R2 and Windows Server 2008:  

This property is read/write before Windows Server 2012.

This property is inherited from MSCluster_LogicalElement

Description
Data type: string
Access type: Read-only

Provides a textual description of the object.

This property is inherited from CIM_ManagedSystemElement.

FaultState
Data type: uint32
Access type: Read-only

Returns the fault state of the cluster shared volume.

No Faults (0)

Windows Server 2012 and Windows Server 2008 R2:  This value was NoFaults before Windows Server 2012 R2.

Redirected Access (1)

Windows Server 2012 and Windows Server 2008 R2:  This value was NoDirectIO before Windows Server 2012 R2.

No Access (2)

Windows Server 2012 and Windows Server 2008 R2:  This value was NoAccess before Windows Server 2012 R2.

In Maintenance (4)

Windows Server 2012 and Windows Server 2008 R2:  This value was Maintenence before Windows Server 2012 R2.

Flags
Data type: uint32
Access type: Read-only

Provides access to the flags set for the object. The cluster defines flags only for resources. For a description of these flags, see CLUSCTL_RESOURCE_GET_FLAGS.

Windows Server 2008 R2 and Windows Server 2008:  

This property is read/write before Windows Server 2012.

This property is inherited from MSCluster_LogicalElement

InstallDate
Data type: datetime
Access type: Read-only
Qualifiers: MappingStrings ("MIF.DMTF|ComponentID|001.5")

Indicates when the element was installed. A lack of a value does not indicate that the object is not installed.

This property is inherited from CIM_ManagedSystemElement.

Name
Data type: string
Access type: Read-only
Qualifiers: Override (Name), Key

Returns the friendly name of the cluster shared volume.

Status
Data type: string
Access type: Read-only
Qualifiers: MaxLen (10)

A string indicating the current status of the element.

This property is inherited from CIM_ManagedSystemElement.

("OK")

("Error")

("Degraded")

("Unknown")

("Pred Fail")

("Starting")

("Stopping")

("Service")

("Stressed")

("NonRecover")

VolumeName
Data type: string
Access type: Read-only

Returns the device Id of the cluster shared volume.

VolumeOffset
Data type: uint64
Access type: Read-only

Returns the volume offset of the cluster shared volume.

Requirements

Minimum supported client

None supported

Minimum supported server

Windows Server 2008 R2

Namespace

Root\MSCluster

MOF

ClusWmi.mof

DLL

ClusWMI.dll

See also

MSCluster_LogicalElement
Failover Cluster Provider Reference

 

 

Show: