Share via


SetNamespaceRootTarget method of the MSFT_DfsNamespaceRootTarget class

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

Syntax

uint32 SetNamespaceRootTarget(
  [in]  string                      NamespaceRoot,
  [in]  string                      RootTargetPath,
  [in]  uint32                      State,
  [in]  uint32                      ReferralPriorityRank,
  [in]  sint32                      ReferralPriorityClass,
  [out] MSFT_DfsNamespaceRootTarget cmdletOutput
);

Parameters

NamespaceRoot [in]

The Universal Naming Convention (UNC) path of the DFS-N root that has a target with properties to be modified. The UNC path can be in one of these two formats:

Server Format Domain Format
\\ServerName\DFSName \\DomainName\DFSName

where:

  • The ServerName component represents the host name of a DFS root target of a namespace.
  • The DomainName component represents the domain name of the domain that hosts the domain-based namespace.
  • The DFSName component represents the DFS-N name.

A stand-alone namespace must have a root with the format shown in the first column, as it must contain a server name. A domain-based namespace can have a root with the format from either column, although the second column's format (which contains a domain name instead of a server name) is the preferred format.

RootTargetPath [in]

The UNC path of the target of a DFS-N root.

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.

State [in]

The new state of the target of a DFS-N root.

OFFLINE (3)

Not online. Referrals are disabled.

ONLINE (4)

Online. Referrals are enabled.

ReferralPriorityRank [in]

The new priority rank of the target of a DFS-N root.

ReferralPriorityClass [in]

The new priority class of the target of a DFS-N root.

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.

cmdletOutput [out]

When this method returns, contains output from the Set-DFSNamespaceRootTarget cmdlet. This parameter is passed uninitialized.

Requirements

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

See also

MSFT_DfsNamespaceRootTarget