0 out of 1 rated this helpful - Rate this topic

Win32_DFSNode class

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.

The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties. Properties are listed in alphabetic order, not MOF order.

Syntax

class Win32_DFSNode : CIM_LogicalElement
{
  string   Caption;
  string   Description;
  datetime InstallDate;
  string   Name;
  boolean  Root;
  uint32   State;
  string   Status;
  uint32   Timeout;
};

Members

The Win32_DFSNode class has these types of members:

Methods
Properties

Methods

The Win32_DFSNode class has these methods.

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

Properties

The Win32_DFSNode class has these properties.

Caption

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

Short description of the object—a one-line string. This property is inherited from CIM_ManagedSystemElement.

Description

Data type: string
Access type: Read/write

Comment that describes the link. This property is inherited from CIM_ManagedSystemElement.

InstallDate

Data type: datetime
Access type: Read-only

Date that an object is installed. This property does not need a value to indicate that the object is installed. This property is inherited from CIM_ManagedSystemElement.

Name

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

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.

Root

Data type: boolean
Access type: Read-only

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

State

Data type: uint32
Access type: Read-only

Status of the node.

Value	Meaning
0	OK
1	Inconsistent
2	Online
3	Offline

Status

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

Current status of the object. Various operational and nonoperational statuses can be defined. Operational statuses include: "OK", "Degraded", and "Pred Fail" (an element, such as a SMART-enabled hard disk drive, may be functioning properly but predicting a failure in the near future). Nonoperational statuses include: "Error", "Starting", "Stopping", and "Service". The latter, "Service", could apply during mirror-resilvering of a disk, reload of a user permissions list, or other administrative work. Not all such work is online, yet the managed element is neither "OK" nor in one of the other states. This property is inherited from the CIM_ManagedSystemElement class.

The values are:

"OK"
"Error"
"Degraded"
"Unknown"
"Pred Fail"
"Starting"
"Stopping"
"Service"

Timeout

Data type: uint32
Access type: Read/write
Qualifiers: Units ("Seconds")

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

Remarks

The Win32_DFSNode class is derived from CIM_LogicalElement, which derives from the CIM_ManagedSystemElement class.

Examples

For script code examples, see WMI Tasks for Scripts and Applications and the TechNet ScriptCenter Script Repository.

For C++ code examples, see WMI C++ Application Examples.

Requirements

Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Namespace	\root\CIMV2
MOF	Wmipdfs.mof
DLL	Wmipdfs.dll

Community Additions

ADD