Edit

Win32_ClusterShare class

  • Article

[The Win32_ClusterShare class is deprecated. Please use the MSFT_FileShare and MSFT_SMFileShare classes instead.]

The Win32_ClusterShare class represents a shared resource on a cluster.

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

Syntax

[Dynamic, Provider("CIMWin32"), UUID("{8502C4D6-5FBB-11D2-AAC1-006008C78BC7}"), SupportsCreate, CreateBy("Create"), SupportsDelete, DeleteBy("DeleteInstance"), AMENDMENT]
class Win32_ClusterShare : Win32_Share
{
  string   Caption;
  string   Description;
  datetime InstallDate;
  string   Status;
  uint32   AccessMask;
  boolean  AllowMaximum;
  uint32   MaximumAllowed;
  string   Name;
  string   Path;
  uint32   Type;
  string   ServerName;
};

Members

The Win32_ClusterShare class has these types of members:

Methods

The Win32_ClusterShare class has these methods.

Method Description
Create Creates a new Win32_ClusterShare instance.
Delete Deletes a Win32_ClusterShare instance.
GetAccessMask Returns a bitmap with the access rights to the share.
SetShareInfo Sets the parameters of the shared resource.

Properties

The Win32_ClusterShare class has these properties.

AccessMask

Data type: uint32

Access type: Read-only

Qualifiers: DEPRECATED

This property is obsolete and is no longer used. Use the Win32_Share.GetAccessMask method instead. The value of the AccessMask property is set to null by WMI. For more information about setting access when a share is created, see the Create method.

This property is inherited from Win32_Share.

AllowMaximum

Data type: boolean

Access type: Read-only

Qualifiers: MappingStrings ("Win32API|Network Management Structures|SHARE_INFO_502|shi502_max_uses")

Number of concurrent users for this resource has been limited. If True, the value in the MaximumAllowed property is ignored.

This property is inherited from Win32_Share.

Caption

Data type: string

Access type: Read-only

Qualifiers: MaxLen (64), DisplayName ("Caption")

A short textual description of the object.

This property is inherited from CIM_ManagedSystemElement.

Description

Data type: string

Access type: Read-only

Qualifiers: DisplayName ("Description")

A textual description of the object.

This property is inherited from CIM_ManagedSystemElement.

InstallDate

Data type: datetime

Access type: Read-only

Qualifiers: MappingStrings ("MIF.DMTF|ComponentID|001.5"), DisplayName ("Install Date")

Indicates when the object was installed. Lack of a value does not indicate that the object is not installed.

This property is inherited from CIM_ManagedSystemElement.

MaximumAllowed

Data type: uint32

Access type: Read-only

Qualifiers: MappingStrings ("Win32API|Network Management Structures|SHARE_INFO_502|shi502_max_uses")

Limit on the maximum number of users allowed to use this resource concurrently. The value is only valid if the AllowMaximum property is set to FALSE.

This property is inherited from Win32_Share.

Name

Data type: string

Access type: Read-only

Qualifiers: key, MappingStrings ("Win32API|Network Management Structures|SHARE_INFO_1|shi1_netname")

Alias given to a path set up as a share on a computer system running Windows.

Windows 2008 example: "\SERVER01\public" - Windows Server 2008 requires that you place the UNC in the name.

This property is inherited from Win32_Share.

Path

Data type: string

Access type: Read-only

Qualifiers: MappingStrings ("Win32API|Network Management Structures|SHARE_INFO_502|shi502_path")

Local path of the Windows share.

Example: "C:\Program Files"

This property is inherited from Win32_Share.

ServerName

Data type: string

Access type: Read-only

Qualifiers: Override ("ServerName"), MappingStrings ("Win32API|Network Management Structures|SHARE_INFO_503|shi503_servername")

The cluster server on which the share is hosted.

Status

Data type: string

Access type: Read-only

Qualifiers: MaxLen (10), DisplayName ("Status")

String that indicates the current status of the object. Operational and non-operational status can be defined. Operational status can include "OK", "Degraded", and "Pred Fail". "Pred Fail" indicates that an element is functioning properly, but is predicting a failure (for example, a SMART-enabled hard disk drive).

Non-operational status can include "Error", "Starting", "Stopping", and "Service". "Service" can apply during disk mirror-resilvering, reloading a user permissions list, or other administrative work. Not all such work is online, but the managed element is neither "OK" nor in one of the other states.

This property is inherited from CIM_ManagedSystemElement.

Values include the following:

OK ("OK")

Error ("Error")

Degraded ("Degraded")

Unknown ("Unknown")

Pred Fail ("Pred Fail")

Starting ("Starting")

Stopping ("Stopping")

Service ("Service")

Stressed ("Stressed")

NonRecover ("NonRecover")

No Contact ("No Contact")

Lost Comm ("Lost Comm")

Type

Data type: uint32

Access type: Read-only

Qualifiers: MappingStrings ("Win32API|Network Management Structures|SHARE_INFO_502|shi502_type")

Type of resource being shared. Types include: disk drives, print queues, interprocess communications (IPC), and general devices.

This property is inherited from Win32_Share.

Disk Drive (0)

Print Queue (1)

Device (2)

IPC (3)

Disk Drive Admin (2147483648)

Print Queue Admin (2147483649)

Device Admin (2147483650)

IPC Admin (2147483651)

Requirements

Requirement Value
Minimum supported client
 Windows 7
Minimum supported server
 Windows Server 2008 R2
Namespace
 Root\CIMV2
MOF
Cimwin32.mof
DLL
CIMWin32.dll

See also

Win32_Share