MSFT_DfsNamespaceRootTarget class

Represents the target of a DFS namespace (DFS-N) root.

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_DfsNamespaceRootTarget : MSFT_DfsNamespaceTargetBase
{
  string NamespacePath;
  sint32 ReferralPriorityClass;
  uint32 ReferralPriorityRank;
  uint32 State;
  string TargetPath;
};

Members

The MSFT_DfsNamespaceRootTarget class has these types of members:

Methods

The MSFT_DfsNamespaceRootTarget class has these methods.

Method Description
AddNamespaceRootTarget Adds a new target for a DFS namespace (DFS-N) root.
GetNamespaceRootTarget Retrieves the properties of the target of a DFS namespace (DFS-N) root.
RemoveNamespaceRootTarget Removes a target of a DFS namespace (DFS-N) root.
SetNamespaceRootTarget Modifies the properties of the target of a DFS namespace (DFS-N) root.

Properties

The MSFT_DfsNamespaceRootTarget class has these properties.

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 DFS-N link for which a target is to be created.

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

ReferralPriorityClass

Data type: sint32

Access type: Read-only

Gets or sets the priority class of the DFS folder target. The default value is "Normal".

This property is inherited from MSFT_DfsNamespaceTargetBase.

"Invalid" (-1)

Invalid priority.

"Normal" (0)

Site cost, normal priority.

"global-high" (1)

Global, high priority.

"sitecost-high" (2)

Site cost, high priority.

"sitecost-low" (3)

Site cost, low priority.

"global-low" (4)

Global, low priority.

ReferralPriorityRank

Data type: uint32

Access type: Read-only

Gets or sets the priority rank of the DFS folder target. The default value is 0.

This property is inherited from MSFT_DfsNamespaceTargetBase.

State

Data type: uint32

Access type: Read-only

Gets or sets the state of the DFS namespace folder target. The default value is "ONLINE".

This property is inherited from MSFT_DfsNamespaceTargetBase.

"OFFLINE" (3)

Not online. Referrals are disabled.

"ONLINE" (4)

Online. Referrals are enabled.

TargetPath

Data type: string

Access type: Read-only

Qualifiers: key

Gets or sets the UNC path of the target of a DFS-N root or a DFS-N link.

The DFS-N root target has a format of \\ServerName\ShareName, where the ServerName component is the host name of a DFS-N root target server, and the ShareName component is the share name corresponding to a namespace on the DFS-N root target server.

The DFS-N link target has a format of \\HostName\SharedName[\ObjectName]*, where:

  • The HostName component represents either the host name of a server or the domain name of a domain that hosts resources.
  • The SharedName component represents the share name or the name of the resource that is being accessed.
  • Each ObjectName component represents the name of a directory on the resource that is being accessed.

This property is inherited from MSFT_DfsNamespaceTargetBase.

Requirements

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