Win32_DFSNode - powershell.one

The Win32_DFSNode WMI class represents a root or junction node of a domain-based or stand-alone Distributed file system (DFS). The DFS root is also represented by this class because the root is also a node. Each link has one or more targets or actual share paths for the storage defined by the Win32_DFSTarget class.

Methods

Win32_DFSNode has 1 methods:

Method	Description
Create	Creates a new instance of the Win32_DFSNode class.

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_DFSNode returns 8 properties:

'Caption','Description','InstallDate','Name','Root','State','Status','Timeout'

Unless explicitly marked as writeable, all properties are read-only. Read all properties for all instances:

Get-CimInstance -ClassName Win32_DFSNode -Property *

Most WMI classes return one or more instances.

When Get-CimInstance returns no result, then apparently no instances of class Win32_DFSNode exist. This is normal behavior.

Either the class is not implemented on your system (may be deprecated or due to missing drivers, i.e. CIM_VideoControllerResolution), or there are simply no physical representations of this class currently available (i.e. Win32_TapeDrive).

Caption

STRING

Get-CimInstance -ClassName Win32_DFSNode | Select-Object -Property Name, Caption

Description

WRITEABLE STRING

TBD

Get-CimInstance -ClassName Win32_DFSNode | Select-Object -Property Name, Description

InstallDate

DATETIME

Get-CimInstance -ClassName Win32_DFSNode | Select-Object -Property Name, InstallDate

Name

KEY PROPERTY STRING

Identifier for the DFS node. It is the same as the entry path of a node, based on the Universal Naming Convention (UNC). It can take one of the following two forms:

\\DfsServerName\ShareName\PathToLink

\\DomainName\FtDfsName\PathToLink

where

DfsServerName is the name of a server that hosts the DFS root volume.

ShareName is the name of the share published on the host server.

PathToLink is the path to the physical share.

DomainName is the name of the domain that hosts the DFS root volume.

FtDfsName is the name of the fault-tolerant DFS root published.

PathToLink is the path to the physical share.

This property overrides the Name property in CIM_ManagedSystemElement.

Get-CimInstance -ClassName Win32_DFSNode | Select-Object -Property Name

Root

BOOLEAN

Indicates whether the node is a DFS root or a link. A value of TRUE indicates that the node is a root.

Get-CimInstance -ClassName Win32_DFSNode | Select-Object -Property Name, Root

State

UINT32

Status of the node.

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

Use a PowerShell Hashtable

$State_map = @{
      0 = 'Ok'
      1 = 'Inconsistent'
      2 = 'Online'
      3 = 'Offline'
}

Use a switch statement

switch([int]$value)
{
  0          {'Ok'}
  1          {'Inconsistent'}
  2          {'Online'}
  3          {'Offline'}
  default    {"$value"}
}

Use Enum structure

Enum EnumState
{
  Ok             = 0
  Inconsistent   = 1
  Online         = 2
  Offline        = 3
}

Examples

Use $State_map in a calculated property for Select-Object

<# 
  this example uses a hashtable to translate raw numeric values for 
  property "State" to friendly text

  Note: to use other properties than "State", 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 "State" 
# to translate other properties, use their translation table instead
$State_map = @{
      0 = 'Ok'
      1 = 'Inconsistent'
      2 = 'Online'
      3 = 'Offline'
}

#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 "State", 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:
#>
 
$State = @{
  Name = 'State'
  Expression = {
    # property is an array, so process all values
    $value = $_.State
    $State_map[[int]$value]
  }  
}
#endregion define calculated property

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

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

# output values
$friendlyValues

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

# output values as bullet list
$friendlyValues | ForEach-Object { "- $_" }

Use $State_map to directly translate raw values from an instance

<# 
  this example uses a hashtable to manually translate raw numeric values 
  for property "Win32_DFSNode" to friendly text. This approach is ideal when
  there is just one instance to work with.

  Note: to use other properties than "Win32_DFSNode", 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_DFSNode" 
# to translate other properties, use their translation table instead
$State_map = @{
      0 = 'Ok'
      1 = 'Inconsistent'
      2 = 'Online'
      3 = 'Offline'
}

#endregion define hashtable

# get one instance:
$instance = Get-CimInstance -Class Win32_DFSNode | 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.State  

# translate raw value to friendly text:
$friendlyName = $State_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 "State" 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 "State", 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 "State", 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:
#>
 
$State = @{
  Name = 'State'
  Expression = {
    # property is an array, so process all values
    $value = $_.State
    
    switch([int]$value)
      {
        0          {'Ok'}
        1          {'Inconsistent'}
        2          {'Online'}
        3          {'Offline'}
        default    {"$value"}
      }
      
  }  
}
#endregion define calculated property

# retrieve all instances...
Get-CimInstance -ClassName Win32_DFSNode | 
  # ...and output properties "Caption" and "State". The latter is defined
  # by the hashtable in $State:
  Select-Object -Property Caption, $State

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_DFSNode", look up the appropriate 
  enum definition for the property you would like to use instead.
#>


#region define enum with value-to-text translation:
Enum EnumState
{
  Ok             = 0
  Inconsistent   = 1
  Online         = 2
  Offline        = 3
}

#endregion define enum

# get one instance:
$instance = Get-CimInstance -Class Win32_DFSNode | 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.State

#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 **State** 
[EnumState]$rawValue 

# get a comma-separated string:
[EnumState]$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 [EnumState]
#endregion

Enums must cover all possible values. If State 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.

Status

STRING

Current status of an object. Various operational and nonoperational statuses can be defined. Available values:

$values = 'Degraded','Error','Lost Comm','No Contact','NonRecover','OK','Pred Fail','Service','Starting','Stopping','Stressed','Unknown'

Get-CimInstance -ClassName Win32_DFSNode | Select-Object -Property Name, Status

Timeout

WRITEABLE UINT32 “SECONDS”

Time, in seconds, that the client caches the referral of this link.

Get-CimInstance -ClassName Win32_DFSNode | Select-Object -Property Name, Timeout

Examples

List all instances of Win32_DFSNode

Get-CimInstance -ClassName Win32_DFSNode

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

View all properties

Get-CimInstance -ClassName Win32_DFSNode -Property *

View key properties only

Get-CimInstance -ClassName Win32_DFSNode -KeyOnly

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 = 'Caption',
              'Description',
              'InstallDate',
              'Name',
              'Root',
              'State',
              'Status',
              'Timeout'
Get-CimInstance -ClassName Win32_DFSNode | 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_DFSNode -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_DFSNode -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 InstallDate, Status, Caption, Description FROM Win32_DFSNode 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 InstallDate, Status, Caption, Description FROM Win32_DFSNode WHERE Caption LIKE 'a%'" | Select-Object -Property InstallDate, Status, Caption, Description

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

Requirements

To use Win32_DFSNode, 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_DFSNode was introduced on clients with Windows Vista and on servers with Windows Server 2008.

Namespace

Win32_DFSNode 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_DFSNode is implemented in Wmipdfs.dll and defined in Wmipdfs.mof. Both files are located in the folder C:\Windows\system32\wbem:

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

PREVIOUSArchive