Set-DfsnFolder

Changes settings for a DFS namespace folder.

Syntax

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

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:

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 on TechNet.

Examples

Example 1: Enable settings for a DFS namespace folder

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

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

Required Parameters

-Path

Specifies a path for the DFS namespace folder. This cmdlet modifies the folder that has the path specified.

Type:String
Aliases:DfsPath, FolderPath, NamespacePath
Position:0
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Optional 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
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
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
Accept pipeline input:False
Accept wildcard characters:False
-Description

Specifies a description for a DFS namespace folder.

Type:String
Aliases:desc
Position:5
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-EnableInsiteReferrals

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.

Type:Boolean
Aliases:insite
Position:1
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-EnableTargetFailback

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.

Type:Boolean
Aliases:failback, TargetFailback
Position:2
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-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.

Type:State
Parameter Sets:Offline, Online
Position:3
Default value:None
Accept pipeline input:True (ByPropertyName)
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
Accept pipeline input:False
Accept wildcard characters:False
-TimeToLiveSec

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

Type:UInt32
Aliases:ttl, TimeToLive
Position:4
Default value:None
Accept pipeline input:True (ByPropertyName)
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
Accept pipeline input:False
Accept wildcard characters:False

Outputs

Microsoft.Management.Infrastructure.CimInstance#MSFT_DfsNamespaceFolder