MSFT_DFSNamespace class
Represents a DFS namespace (DFS-N). This class can be used to enumerate, modify, delete, and create new namespaces.
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_DFSNamespace : MSFT_DfsNamespaceLinkBase
{
string Description;
string NamespacePath;
uint32 State;
uint32 TimeToLive;
uint32 Flags;
string GrantAdminAccess[];
uint32 Type;
};
Members
The MSFT_DFSNamespace class has these types of members:
Methods
The MSFT_DFSNamespace class has these methods.
| Method | Description |
|---|---|
| GetNamespaces | Retrieves configuration settings for an existing namespace or enumerates namespaces by server, domain, or namespace path. |
| NewNamespace | Creates a new namespace. |
| RemoveNamespace | Removes a namespace and any child namespace links. |
| SetNamespace | Updates a property on a namespace root. |
Properties
The MSFT_DFSNamespace 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", "1", "2", "3", "5"), Override ("Flags"), BitValues ("InsiteReferrals", "RootScalability", "SiteCosting", "TargetFailback", "AccessBasedEnumeration")
Gets or sets a bitwise combination of the enumeration values that represent the properties of the namespace.
-
-
"InsiteReferrals" ("0")
-
True if in-site referrals are enabled for the namespace; otherwise, false. The default value is false.
-
"RootScalability" ("1")
-
True if namespace polling mode is enabled for the namespace; otherwise, false. The default value is false.
-
"SiteCosting" ("2")
-
True if cost-based site selection is enabled for the namespace; otherwise, false. The default value is false.
Site cost is a relative, numeric value that indicates the bandwidth or actual monetary cost of transmitting data between two sites, with the lower-cost site being preferred to a higher-cost site. Only a comparison between site costs is meaningful; a single site's cost value by itself does not provide any information.
-
"TargetFailback" ("3")
-
True if target failback is enabled for the namespace; otherwise, false. The default value is false.
-
"AccessBasedEnumeration" ("5")
-
True if access-based enumeration is enabled for the namespace; otherwise, false. The default value is false.
GrantAdminAccess
-
Data type: string array
-
Access type: Read-only
Gets or sets an array that represents the list of user and group accounts that have been delegated administrative access to this namespace.
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.
Type
-
Data type: uint32
-
Access type: Read-only
Gets the type of namespace to create. The default value is "Domain v2".
"Stand-alone" (0)
A stand-alone namespace.
"Domain v1" (1)
A domain namespace of Windows 2000 Server mode.
"Domain v2" (2)
A domain namespace of Windows Server 2008 mode.
Requirements
| Minimum supported client |
None supported |
| Minimum supported server |
Windows Server 2012 |
| Namespace |
Root\Microsoft\Windows\dfsn |
| MOF |
|
| DLL |
|