Win32_ClusterShare

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

[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.

Methods

Win32_ClusterShare has 4 methods:

| Method | Description | | ———————- | ———– | System.Object[]

Learn more about Invoke-CimMethod and how to invoke commands. Click any of the methods listed above to learn more about their purpose, parameters, and return value.

Properties

Win32_ClusterShare returns 11 properties:

'AccessMask','AllowMaximum','Caption','Description','InstallDate','MaximumAllowed',
'Name','Path','ServerName','Status','Type'

Unless explicitly marked as writeable, all properties are read-only.

AccessMask

UINT32

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.

AllowMaximum

BOOLEAN

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

Caption

STRING MAX 64 CHAR

A short textual description of the object.

Description

STRING

A textual description of the object.

InstallDate

DATETIME

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

MaximumAllowed

UINT32

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.

Name

KEY PROPERTY STRING

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.

Path

STRING

Local path of the Windows share.

Example: “C:\Program Files”

ServerName

STRING

The cluster server on which the share is hosted.

Status

STRING MAX 10 CHAR

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.

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

UINT32

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

Type returns a numeric value. To translate it into a meaningful text, use any of the following approaches:

Use a PowerShell Hashtable
$Type_map = @{
      0 = 'Disk Drive'
      1 = 'Print Queue'
      2 = 'Device'
      3 = 'IPC'
2147483648 = 'Disk Drive Admin'
2147483649 = 'Print Queue Admin'
2147483650 = 'Device Admin'
2147483651 = 'IPC Admin'
}
Use a switch statement
switch([int]$value)
{
  0          {'Disk Drive'}
  1          {'Print Queue'}
  2          {'Device'}
  3          {'IPC'}
  2147483648 {'Disk Drive Admin'}
  2147483649 {'Print Queue Admin'}
  2147483650 {'Device Admin'}
  2147483651 {'IPC Admin'}
  default    {"$value"}
}
Use Enum structure
Enum EnumType
{
  Disk_Drive          = 0
  Print_Queue         = 1
  Device              = 2
  IPC                 = 3
  Disk_Drive_Admin    = 2147483648
  Print_Queue_Admin   = 2147483649
  Device_Admin        = 2147483650
  IPC_Admin           = 2147483651
}

Examples

Use $Type_map in a calculated property for Select-Object
<# 
  this example uses a hashtable to translate raw numeric values for 
  property "Type" to friendly text

  Note: to use other properties than "Type", look up the appropriate 
  translation hashtable for the property you would like to use instead.
#>

#region define hashtable to translate raw values to friendly text

# Please note: this hashtable is specific for property "Type" 
# to translate other properties, use their translation table instead
$Type_map = @{
      0 = 'Disk Drive'
      1 = 'Print Queue'
      2 = 'Device'
      3 = 'IPC'
2147483648 = 'Disk Drive Admin'
2147483649 = 'Print Queue Admin'
2147483650 = 'Device Admin'
2147483651 = 'IPC Admin'
}

#endregion define hashtable

#region define calculated property (to be used with Select-Object)

<#
  a calculated property is defined by a hashtable with keys "Name" and "Expression"
  "Name" defines the name of the property (in this example, it is "Type", but you can rename it to anything else)
  "Expression" defines a scriptblock that calculates the content of this property
  in this example, the scriptblock uses the hashtable defined earlier to translate each numeric
  value to its friendly text counterpart:
#>
 
$Type = @{
  Name = 'Type'
  Expression = {
    # property is an array, so process all values
    $value = $_.Type)
    $Type_map[[int]$value]
  }  
}
#endregion define calculated property

# retrieve the instances, and output the properties "Caption" and "Type". The latter
# is defined by the hashtable in $Type: 
Get-CimInstance -Class Win32_ClusterShare | Select-Object -Property Caption, $Type

# ...or dump content of property Type:
$friendlyValues = Get-CimInstance -Class Win32_ClusterShare | 
    Select-Object -Property $Type |
    Select-Object -ExpandProperty Type

# output values
$friendlyValues

# output values as comma separated list
$friendlyValues -join ', '

# output values as bullet list
$friendlyValues | ForEach-Object { "- $_" }
Use $Type_map to directly translate raw values from an instance
<# 
  this example uses a hashtable to manually translate raw numeric values 
  for property "Win32_ClusterShare" to friendly text. This approach is ideal when
  there is just one instance to work with.

  Note: to use other properties than "Win32_ClusterShare", look up the appropriate 
  translation hashtable for the property you would like to use instead.
#>

#region define hashtable to translate raw values to friendly text

# Please note: this hashtable is specific for property "Win32_ClusterShare" 
# to translate other properties, use their translation table instead
$Type_map = @{
      0 = 'Disk Drive'
      1 = 'Print Queue'
      2 = 'Device'
      3 = 'IPC'
2147483648 = 'Disk Drive Admin'
2147483649 = 'Print Queue Admin'
2147483650 = 'Device Admin'
2147483651 = 'IPC Admin'
}

#endregion define hashtable

# get one instance:
$instance = Get-CimInstance -Class Win32_ClusterShare | Select-Object -First 1

<#
  IMPORTANT: this example processes only one instance to illustrate
  the number-to-text translation. To process all instances, replace
  "Select-Object -First 1" with a "Foreach-Object" loop, and use
  the iterator variable $_ instead of $instance
#>

# query the property
$rawValue = $instance.Type  

# translate raw value to friendly text:
$friendlyName = $Type_map[[int]$rawValue]

# output value
$friendlyName
Use a switch statement inside a calculated property for Select-Object
<# 
  this example uses a switch clause to translate raw numeric 
  values for property "Type" to friendly text. The switch
  clause is embedded into a calculated property so there is
  no need to refer to external variables for translation.

  Note: to use other properties than "Type", look up the appropriate 
  translation switch clause for the property you would like to use instead.
#>

#region define calculated property (to be used with Select-Object)

<#
  a calculated property is defined by a hashtable with keys "Name" and "Expression"
  "Name" defines the name of the property (in this example, it is "Type", but you can rename it to anything else)
  "Expression" defines a scriptblock that calculates the content of this property
  in this example, the scriptblock uses the hashtable defined earlier to translate each numeric
  value to its friendly text counterpart:
#>
 
$Type = @{
  Name = 'Type'
  Expression = {
    # property is an array, so process all values
    $value = $_.BiosCharacteristics
    
    switch([int]$value)
      {
        0          {'Disk Drive'}
        1          {'Print Queue'}
        2          {'Device'}
        3          {'IPC'}
        2147483648 {'Disk Drive Admin'}
        2147483649 {'Print Queue Admin'}
        2147483650 {'Device Admin'}
        2147483651 {'IPC Admin'}
        default    {"$value"}
      }
      
  }  
}
#endregion define calculated property

# retrieve all instances...
Get-CimInstance -ClassName Win32_ClusterShare | 
  # ...and output properties "Caption" and "Type". The latter is defined
  # by the hashtable in $Type:
  Select-Object -Property Caption, $Type
Use the Enum from above to auto-translate the code values
<# 
  this example translates raw values by means of type conversion
  the friendly names are defined as enumeration using the
  keyword "enum" (PowerShell 5 or better)
  
  The raw value(s) are translated to friendly text by 
  simply converting them into the enum type.
  
  Note: to use other properties than "Win32_ClusterShare", look up the appropriate 
  enum definition for the property you would like to use instead.
#>


#region define enum with value-to-text translation:
Enum EnumType
{
  Disk_Drive          = 0
  Print_Queue         = 1
  Device              = 2
  IPC                 = 3
  Disk_Drive_Admin    = 2147483648
  Print_Queue_Admin   = 2147483649
  Device_Admin        = 2147483650
  IPC_Admin           = 2147483651
}

#endregion define enum

# get one instance:
$instance = Get-CimInstance -Class Win32_ClusterShare | Select-Object -First 1

<#
  IMPORTANT: this example processes only one instance to focus on
  the number-to-text type conversion. 
  
  To process all instances, replace   "Select-Object -First 1" 
  with a "Foreach-Object" loop, and use the iterator variable 
  $_ instead of $instance
#>

# query the property:
$rawValue = $instance.Type

#region using strict type conversion

<#
  Note: strict type conversion fails if the raw value is 
  not defined by the enum. So if the list of allowable values
  was extended and the enum does not match the value,
  an exception is thrown
#>

# convert the property to the enum **Type** 
[EnumType]$rawValue 

# get a comma-separated string:
[EnumType]$rawValue -join ',' 
#endregion

#region using operator "-as"

<#
  Note: the operator "-as" accepts values not defined
  by the enum and returns $null instead of throwing
  an exception
#>

$rawValue -as [EnumType]
#endregion

Enums must cover all possible values. If Type returns a value that is not defined in the enum, an exception occurs. The exception reports the value that was missing in the enum. To fix, add the missing value to the enum.

Examples

List all instances of Win32_ClusterShare
Get-CimInstance -ClassName Win32_ClusterShare

Learn more about Get-CimInstance and the deprecated Get-WmiObject.

View all properties
Get-CimInstance -ClassName Win32_ClusterShare -Property *
View key properties only
Get-CimInstance -ClassName Win32_ClusterShare -Property *

Selecting Properties

To select only some properties, pipe the results to Select-Object -Property a,b,c with a comma-separated list of the properties you require. Wildcards are permitted.

Get-CimInstance always returns all properties but only retrieves the ones that you specify. All other properties are empty but still present. That’s why you need to pipe the results into Select-Object if you want to limit the visible properties, i.e. for reporting.

Selecting Properties

The code below lists all available properties. Remove the ones you do not need:

$properties = 'AccessMask',
              'AllowMaximum',
              'Caption',
              'Description',
              'InstallDate',
              'MaximumAllowed',
              'Name',
              'Path',
              'ServerName',
              'Status',
              'Type'

Get-CimInstance -ClassName Win32_ClusterShare | Select-Object -Property $properties
Limiting Network Bandwidth

If you work remotely, it makes sense to limit network bandwidth by filtering the properties on the server side, too:

Get-CimInstance -Class Win32_ClusterShare -Property $property | 
Select-Object -Property $property

Selecting Instances

To select some instances, use Get-CimInstance and a WMI Query. The wildcard character in WMI Queries is % (and not “*”).

The parameter -Filter runs a simple query.

Listing all instances where the property Caption starts with “A”
Get-CimInstance -Class Win32_ClusterShare -Filter 'Caption LIKE "a%"' 
Using a WQL Query

The parameter -Query uses a query similar to SQL and combines the parameters -Filter and -Property. This returns all instances where the property Caption starts with “A”, and returns the properties specified:

Get-CimInstance -Query "SELECT AccessMask, Path, Name, AllowMaximum FROM Win32_ClusterShare WHERE Caption LIKE 'a%'"

Any property you did not specify is still present but empty. You might need to use Select-Object to remove all unwanted properties:

Get-CimInstance -Query "SELECT AccessMask, Path, Name, AllowMaximum FROM Win32_ClusterShare WHERE Caption LIKE 'a%'" | Select-Object -Property AccessMask, Path, Name, AllowMaximum

Accessing Remote Computers

To access remote systems, you need to have proper permissions. User the parameter -ComputerName to access one or more remote systems.

Authenticating as Current User
# one or more computer names or IP addresses:
$list = 'server1', 'server2'

# authenticate with your current identity:
$result = Get-CimInstance -ClassName Win32_ClusterShare -ComputerName $list 
$result
Authenticating as Different User

Use a CIMSession object to authenticate with a new identity:

# one or more computer names or IP addresses:
$list = 'server1', 'server2'

# authenticate with a different identity:
$cred = Get-Credential -Message 'Authenticate to retrieve WMI information:'
$session = New-CimSession -ComputerName $list -Credential $cred

$result = Get-CimInstance Win32_ClusterShare -CimSession $session

# remove the session after use (if you do not plan to re-use it later)
Remove-CimSession -CimSession $session

$result

Learn more about accessing remote computers.

More Examples

Visit the Example Page for more examples.

Requirements

To use Win32_ClusterShare, the following requirements apply:

PowerShell

Get-CimInstance was introduced with PowerShell Version 3.0, which in turn was introduced on clients with Windows 8 and on servers with Windows Server 2012.

If necessary, update Windows PowerShell to Windows PowerShell 5.1, or install PowerShell 7 side-by-side.

Operating System

Win32_ClusterShare was introduced on clients with Windows 7 and on servers with Windows Server 2008 R2.

Namespace

Win32_ClusterShare lives in the Namespace Root\CIMV2. This is the default namespace. There is no need to use the -Namespace parameter in Get-CimInstance.

Implementation

Win32_ClusterShare is implemented in CIMWin32.dll and defined in Cimwin32.mof. Both files are located in the folder C:\Windows\system32\wbem:

explorer $env:windir\system32\wbem
notepad $env:windir\system32\wbem\Cimwin32.mof