Set-DfsnRootTarget

Module:

DFSN

Changes settings for a root target of a DFS namespace.

Syntax

Set-DfsnRootTarget
   [-Path] <String>
   [-TargetPath] <String>
   [[-State] <State>]
   [[-ReferralPriorityClass] <ReferralPriorityClass>]
   [[-ReferralPriorityRank] <UInt32>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Set-DfsnRootTarget cmdlet changes settings for a root target of a Distributed File System (DFS) namespace. You can change the state of the DFS namespace target and configure priority class and priority rank for referrals.

A DFS namespace folder has one or more folder targets that are shared folders on computers. When a client attempts to connect to a folder, the DFS namespace server provides a list of folder targets, called referrals. The server determines the order for referrals and clients attempt to connect to a folder target in the order that the server provides.

For more information about DFS namespaces, see Overview of DFS Namespaces on TechNet.

Examples

Example 1: Set a referral priority value

Set-DfsnRootTarget -Path '\\contoso.com\dfsroot' -TargetPath '\\Contoso-fs\dfsroot' -ReferralPriorityClass 'GlobalLow'

This command sets the referral priority class to a value of GlobalLow for the DFS namespace root target that has the path \\Contoso\AccountingSoftware and the target path \\Contoso-FS\AccountingSoftware.

Parameters

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.

The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet.

For more information about Windows PowerShell background jobs, see about_Jobs.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-CimSession

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.

Type:	CimSession[]
Aliases:	Session
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Path

Specifies a path for the root of a DFS namespace.

Type:	String
Aliases:	DfsPath, NamespaceRoot
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-ReferralPriorityClass

Specifies the priority class for a DFS namespace root target. Target priority offers you the ability to classify and rank in-site targets. You can specify targets to receive the highest or lowest preference, and you can divide the remaining targets based on their site cost for a DFS client to connect to them. The acceptable values for this parameter are:

• GlobalHigh - The highest priority class for a DFS target. Targets assigned this class receive global preference.
• SiteCostHigh - The highest site cost priority class for a DFS target. Targets assigned this class receive the most preference among targets of the same site cost for a given DFS client.
• SiteCostNormal - The middle or normal site cost priority class for a DFS target.
• SiteCostLow - The lowest site cost priority class for a DFS target. Targets assigned this class receive the least preference among targets of the same site cost for a given DFS client.
• GlobalLow - The lowest level of priority class for a DFS target. Targets assigned this class receive the least preference globally.

Type:	Microsoft.PowerShell.Cmdletization.GeneratedTypes.DfsNamespaceRootTarget.ReferralPriorityClass
Aliases:	PriorityClass, Class
Accepted values:	SiteCostNormal, GlobalHigh, SiteCostHigh, SiteCostLow, GlobalLow
Position:	3
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-ReferralPriorityRank

Specifies the priority rank, as an integer, for a root target of the DFS namespace. Lower values have greater preference. A value of zero (0) is the greatest preference.

Type:	UInt32
Aliases:	PriorityRank, Rank
Position:	4
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-State

Specifies the state of the DFS namespace root target. The acceptable values for this parameter are:

• Online
• Offline

Clients do not receive referrals for a DFS namespace target that is offline.

Type:	Microsoft.PowerShell.Cmdletization.GeneratedTypes.DfsNamespaceRootTarget.State
Accepted values:	Offline, Online
Position:	2
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-TargetPath

Specifies a path for a root target of the DFS namespace. This cmdlet changes settings for the root target that the path specifies.

Type:	String
Aliases:	Target, DfsTarget, RootTargetPath
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-ThrottleLimit

Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.

Type:	Int32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

String

Microsoft.PowerShell.Cmdletization.GeneratedTypes.DfsNamespaceRootTarget.State

Microsoft.PowerShell.Cmdletization.GeneratedTypes.DfsNamespaceRootTarget.ReferralPriorityClass

UInt32

Outputs

CimInstance

Related Links

• Get-DfsnRootTarget
• New-DfsnRootTarget
• Remove-DfsnRootTarget