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
 

Set-DfsnFolder

Set-DfsnFolder

dfsnamespacefolder.cdxml

Synopsis

Changes settings for a DFS namespace folder.

Syntax

Set-DfsnFolder [-Path] [-EnableInsiteReferrals] [-EnableTargetFailback] [-State] [-TimeToLiveSec] [-Description] [-AsJob] [-CimSession] [-ThrottleLimit] [-Confirm] [-WhatIf] [<CommonParameters>]

Detailed Description

The Set-DfsnFolder cmdlet changes settings for a Distributed File System (DFS) namespace folder.

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.

You can use this cmdlet to enable or disable the following settings: -- In-site referrals. -- Target failback.

You can also add or change a descriptive comment, change the state of the DFS namespace, or set the Time to Live (TTL) interval for referrals.

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

-Description <String>

Specifies a description for a DFS namespace folder.

Aliases

desc

Required?

false

Position

6

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-EnableInsiteReferrals <Boolean>

Indicates whether a DFS namespace server provides a client only with referrals that are in the same site as the client. If this value is $True, a DFS namespace server provides only in-site referrals. If this value is $False, the DFS namespace server provides in-site referrals first, then other referrals.

Aliases

insite

Required?

false

Position

2

Default value

False

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-EnableTargetFailback <Boolean>

Indicates whether a DFS namespace uses target failback. If a client attempts to access target link on a server and that server is not available, the client fails over to another referral. If this value is $True, once the first server becomes available again, the client fails back to the first server. If this value is $False, the DFS namespace server does not require the client to use the preferred server.

Aliases

failback,TargetFailback

Required?

false

Position

3

Default value

False

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-Path <String>

Specifies a path for the DFS namespace folder. This cmdlet modifies 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

-State <State>

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

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

Aliases

None

Required?

false

Position

4

Default value

ONLINE

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

-TimeToLiveSec <UInt32>

Specifies a TTL interval, in seconds, for referrals. Clients store referrals to targets for this length of time. The default TTL interval for folder referrals is 1800 seconds (30 minutes).

Aliases

ttl,TimeToLive

Required?

false

Position

5

Default value

300

Accept pipeline input?

True (ByPropertyName)

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_DfsNamespaceFolder

Notes

None

Examples

Example 1: Enable settings for a DFS namespace folder

This command enables in-site referrals and target failback for the DFS namespace folder \\Contoso\AccountingResources\LegacySoftware.

PS C:\> Set-DfsnFolder -Path "\\Contoso\AccountingResources\LegacySoftware" -EnableInsiteReferrals $True -EnableTargetFailback $True

Online Version
Get-DfsnFolder
Move-DfsnFolder
New-DfsnFolder
Remove-DfsnFolder