Share via


MSFT_DfsNamespaceFolder class

Represents a DFS folder. This class can be used for the creation, modification, deletion, and movement of DFS folders.

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

Syntax

[dynamic, provider("dfsncimprov"), ClassVersion("1.0"), AMENDMENT]
class MSFT_DfsNamespaceFolder : MSFT_DfsNamespaceLinkBase
{
  string Description;
  uint32 Flags;
  string NamespacePath;
  uint32 State;
  uint32 TimeToLive;
};

Members

The MSFT_DfsNamespaceFolder class has these types of members:

Methods

The MSFT_DfsNamespaceFolder class has these methods.

Method Description
GetNamespaceFolder Retrieves the properties of a DFS folder.
MoveNamespaceFolder Moves a DFS folder to another location within the same namespace.
NewNamespaceFolder Creates a new DFS folder in the existing namespace.
RemoveNamespaceFolder Removes a DFS folder.
SetNamespaceFolder Updates the properties of a DFS folder.

Properties

The MSFT_DfsNamespaceFolder class has these properties.

Description

Data type: string

Access type: Read-only

Gets or sets a short description of the purpose of the DFS-N root or the DFS-N link.

This property is inherited from MSFT_DfsNamespaceLinkBase.

Flags

Data type: uint32

Access type: Read-only

Qualifiers: BitMap ("0", "3"), BitValues ("InsiteReferrals", "TargetFailback")

Gets or sets a bitwise combination of the enumeration values that represent the properties of the DFS-N root or the DFS-N link.

This property is inherited from MSFT_DfsNamespaceLinkBase.

"InsiteReferrals" ("0")

True if in-site referrals are enabled for the DFS-N root or the DFS-N link; otherwise, false. The default value is false.

"TargetFailback" ("3")

True if target failback is enabled for the DFS-N root or the DFS-N link; otherwise, false. The default value is false.

NamespacePath

Data type: string

Access type: Read-only

Qualifiers: key

Gets or sets the Universal Naming Convention (UNC) path of the DFS-N root or the DFS-N link.

A DFS-N root or a DFS-N link can have one of the following UNC path formats:

Server Format Domain Format
DFS-N Root \\ServerName\DFSName \\DomainName\DFSName
DFS-N Link \\ServerName\DFSName\LinkPath \\DomainName\DFSName\LinkPath

where:

  • The ServerName component represents the host name of a DFS root target of a DFS namespace.
  • The DomainName component represents the domain name of the domain that hosts the domain-based DFS namespace.
  • The DFSName component represents the DFS-N name.
  • The LinkPath component represents the path of the DFS-N link relative to the DFS root target share.

Stand-alone DFS namespaces must have links and roots with the formats shown in the first column, as they must contain a server name. Domain-based DFS namespaces can have links and roots with the formats from either column, although the second column's formats (which contain a domain name instead of a server name) are the preferred format.

This property is inherited from MSFT_DfsNamespaceLinkBase.

State

Data type: uint32

Access type: Read-only

Gets or sets the state of the DFS-N root or the DFS-N link. The default value is "ONLINE".

This property is inherited from MSFT_DfsNamespaceLinkBase.

"OFFLINE" (3)

Not online.

"ONLINE" (4)

Online.

TimeToLive

Data type: uint32

Access type: Read-only

Gets or sets the interval time, in seconds, of the time to live (TTL) of the referral. A referral TTL determines the amount of time that clients cache (store) referrals for this DFS-N root or DFS-N link. The default value is 300.

This property is inherited from MSFT_DfsNamespaceLinkBase.

Requirements

Minimum supported client
None supported
Minimum supported server
Windows Server 2012
Namespace
Root\Microsoft\Windows\dfsn
MOF
DfsNCimProv.mof
DLL
DfsNCimProv.dll