MSCluster_AvailableDisk class

A dynamic WMI class that represents an available disk.

Windows Server 2008 R2 and Windows Server 2008:  

Before Windows Server 2012 this class inherited directly from MSCluster_LogicalElement. Beginning in Windows Server 2012 it inherits from MSCluster_ClusterDisk.

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("{A4F69DC3-DD5A-41AB-8108-E7C293E643AD}"), AMENDMENT]
class MSCluster_AvailableDisk : MSCluster_ClusterDisk
{
  string   Caption;
  string   Description;
  datetime InstallDate;
  string   Name;
  string   Status;
  uint32   Flags;
  uint32   Characteristics;
  string   Id;
  uint32   Signature;
  string   GptGuid;
  uint32   ScsiPort;
  uint32   ScsiBus;
  uint32   ScsiTargetID;
  uint32   ScsiLUN;
  uint64   Size;
  uint32   Number;
  string   VirtualDiskId;
  string   StoragePoolId;
  string   Node;
  string   ResourceName;
  string   ConnectedNodes[];
};

Members

The MSCluster_AvailableDisk class has these types of members:

Methods

The MSCluster_AvailableDisk class has these methods.

MethodDescription
AddToCluster

Adds the available disk to the cluster.

CreateStorageResource

Windows Server 2008 R2 and Windows Server 2008:  

This method is not supported before Windows Server 2012.

 

Properties

The MSCluster_AvailableDisk class has these properties.

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

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

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.

ConnectedNodes
Data type: string array
Access type: Read-only

The names of the nodes which are connected to the available disk.

Windows Server 2008 R2 and Windows Server 2008:  

This property is not supported before Windows Server 2012.

Description
Data type: string
Access type: Read-only

Provides a textual description of the disk.

This property is inherited from CIM_ManagedSystemElement.

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.

GptGuid
Data type: string
Access type: Read-only

Provides the GUID for GPT disks. For MBR disks, this property is not populated.

This property is inherited from MSCluster_ClusterDisk.

Id
Data type: string
Access type: Read-only
Qualifiers: Key

Provides the ID of the disk. For virtual disks, the property value is "Space Id". For non-virtual disks, the property value contains the same value as either the GptGuid property (for GPT disks) or the Signature property (for MBR disks).

This property is inherited from MSCluster_ClusterDisk.

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

A datetime value indicating when the disk was installed. A lack of a value does not indicate that the disk is not installed.

This property is inherited from CIM_ManagedSystemElement.

Name
Data type: string
Access type: Read-only
Qualifiers: MaxLen (256)

The Name property defines the label by which the disk is known. When subclassed, the Name property can be overridden to be a Key property.

This property is inherited from CIM_ManagedSystemElement.

Node
Data type: string
Access type: Read-only

The node which provided the disk information.

Windows Server 2008 R2 and Windows Server 2008:  

This property is not supported before Windows Server 2012.

Number
Data type: uint32
Access type: Read-only

The disk number on the node hosting the disk.

This property is inherited from MSCluster_ClusterDisk.

Windows Server 2008 R2 and Windows Server 2008:  

Due to inheritance restructuring, this property is not available on this class before Windows Server 2012.

ResourceName
Data type: string
Access type: Read-only

The resource name to try when adding the disk to the cluster.

Windows Server 2008 R2 and Windows Server 2008:  

This property is not supported before Windows Server 2012.

ScsiBus
Data type: uint32
Access type: Read-only

Provides the SCSI bus of the disk.

This property is inherited from MSCluster_ClusterDisk.

ScsiLUN
Data type: uint32
Access type: Read-only

Provides the SCSI LUN of the disk.

This property is inherited from MSCluster_ClusterDisk.

ScsiPort
Data type: uint32
Access type: Read-only

Provides the SCSI port number of the disk.

This property is inherited from MSCluster_ClusterDisk.

ScsiTargetID
Data type: uint32
Access type: Read-only

Provides the SCSI target ID of the disk.

This property is inherited from MSCluster_ClusterDisk.

Signature
Data type: uint32
Access type: Read-only

Provides the signature for MBR disks. For GPT disks, this property is not populated.

This property is inherited from MSCluster_ClusterDisk.

Size
Data type: uint64
Access type: Read-only

The physical size of the disk.

This property is inherited from MSCluster_ClusterDisk.

Windows Server 2008 R2 and Windows Server 2008:  

Due to inheritance restructuring, this property is not available on this class before Windows Server 2012.

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

A string indicating the current status of the object. Various operational and non-operational statuses are defined. Operational statuses are "OK", "Degraded", "Stressed" and "Pred Fail". "Stressed" indicates that the Element is functioning, but needs attention. Examples of "Stressed" states are overload, overheated, etc. The condition "Pred Fail" (failure predicted) indicates that an Element is functioning properly but predicting a failure in the near future. An example is a SMART-enabled hard drive. Non-operational statuses can also be specified. These are "Error", "NonRecover", "Starting", "Stopping" and "Service". "NonRecover" indicates that a non-recoverable error has occurred. "Service" describes an Element being configured, maintained or cleaned, or otherwise administered. This status could apply during mirror-resilvering of a disk, reload of a user permissions list, or other administrative task. Not all such work is on-line, yet the Element is neither "OK" nor in one of the other states.

This property is inherited from CIM_ManagedSystemElement.

("OK")

("Error")

("Degraded")

("Unknown")

("Pred Fail")

("Starting")

("Stopping")

("Service")

("Stressed")

("NonRecover")

StoragePoolId
Data type: string
Access type: Read-only

Provides the storage pool ID for MBR disks. For GPT disks, this property is not populated.

This property is inherited from MSCluster_ClusterDisk.

VirtualDiskId
Data type: string
Access type: Read-only

The id of the virtual disk.

This property is inherited from MSCluster_ClusterDisk.

Windows Server 2008 R2 and Windows Server 2008:  

Due to inheritance restructuring, this property is not available on this class before Windows Server 2012.

Requirements

Minimum supported client

None supported

Minimum supported server

Windows Server 2008

Namespace

Root\MSCluster

MOF

ClusWmi.mof

DLL

ClusWMI.dll

See also

MSCluster_ClusterDisk
Failover Cluster Provider Reference

 

 

Show: