Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

New-DfsnFolderTarget

New-DfsnFolderTarget

dfsnamespacefoldertarget.cdxml

Synopsis

Adds a target to a DFS namespace folder.

Syntax

New-DfsnFolderTarget [-Path] [-TargetPath] [-State] [-ReferralPriorityClass] [-ReferralPriorityRank] [-AsJob] [-CimSession] [-ThrottleLimit] [-Confirm] [-WhatIf] [<CommonParameters>]

Detailed Description

The New-DfsnFolderTarget cmdlet adds a target to a Distributed File System (DFS) namespace folder. Specify the DFS namespace folder and the folder target. You can set 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 <SwitchParameter>

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 of the DFS namespace folder. This cmdlet adds a target for the folder that has the path specified.

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 root target. The acceptable values for this parameter are:  -- Online -- Offline

Clients do not receive referrals for a DFS namespace folder 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 adds this path specified as the folder target.

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 <SwitchParameter>

Prompts you for confirmation before running the cmdlet.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

-WhatIf <SwitchParameter>

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

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type


Return Type

Microsoft.Management.Infrastructure.CimInstance#MSFT_DfsNamespaceFolderTarget

Notes

None

Examples

Example 1: Add a folder target

This command adds \\Contoso-FS\Software as a target for the DFS namespace folder \\Contoso\AccountingResources\LegacySoftware with a referral priority of global low.

PS C:\> New-DfsnFolderTarget -Path "\\Contoso\AccountingResources\LegacySoftware" -TargetPath "\\Contoso-FS\Software" -ReferralPriorityClass GlobalLow

Online Version
Get-DfsnFolderTarget
Remove-DfsnFolderTarget
Set-DfsnFolderTarget