Export (0) Print
Expand All

Set-DfsnFolderTarget

Windows Server 2012 R2 and Windows 8.1

Updated: October 17, 2013

Applies To: Windows 8.1, Windows PowerShell 4.0, Windows Server 2012 R2

Set-DfsnFolderTarget

Changes settings for a target of a DFS namespace folder.

Syntax

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




Detailed Description

The Set-DfsnRootTarget cmdlet changes settings for a target of a Distributed File System (DFS) namespace folder. 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 (http://technet.microsoft.com/library/cc730736) on TechNet.

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

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


Aliases

Session

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Path<String>

Specifies a path for the DFS namespace folder.


Aliases

DfsPath,FolderPath,NamespacePath

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-ReferralPriorityClass<ReferralPriorityClass>

Specifies the priority class for a DFS namespace folder 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.


Aliases

PriorityClass,Class

Required?

false

Position?

4

Default Value

sitecost-normal

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-ReferralPriorityRank<UInt32>

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


Aliases

PriorityRank,Rank

Required?

false

Position?

5

Default Value

0

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-State<State>

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

-- Online
-- Offline

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


Aliases

none

Required?

false

Position?

3

Default Value

ONLINE

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-TargetPath<String>

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


Aliases

Target,DfsTarget,FolderTarget

Required?

true

Position?

2

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-ThrottleLimit<Int32>

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before running the cmdlet.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

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


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

  • Microsoft.Management.Infrastructure.CimInstance#MSFT_DfsNamespaceFolderTarget

Examples

Example 1: Change the state for a folder target

This command changes the state for a target for the folder \\Contoso\AccountingResources\LegacySoftware to Online. The folder target is \\Contoso-FS\LegacySoftware.


PS C:\> Set-DfsnFolderTarget -Path "\\Contoso\AccountingResources\LegacySoftware" -TargetPath "\\Contoso-FS\LegacySoftware" -State Online

Related topics

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft