Set-DfsnFolder
Changes settings for a DFS namespace folder.
Syntax
Default (Default)
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:
- 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 on TechNet.
Examples
Example 1: Enable settings for a DFS namespace folder
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.
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.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | Session |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Description
Specifies a description for a DFS namespace folder.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | desc |
Parameter sets
(All)
| Position: | 5 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | insite |
Parameter sets
(All)
| Position: | 1 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | failback, TargetFailback |
Parameter sets
(All)
| Position: | 2 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-Path
Specifies a path for the DFS namespace folder. This cmdlet modifies the folder that has the path specified.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | DfsPath, FolderPath, NamespacePath |
Parameter sets
(All)
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-State
Specifies the state of the DFS namespace folder. The acceptable values for this parameter are:
OnlineOffline
Clients do not receive referrals for a DFS namespace folder that is offline.
Parameter properties
| Type: | Microsoft.PowerShell.Cmdletization.GeneratedTypes.DfsNamespaceRootTarget.State |
| Default value: | None |
| Accepted values: | Offline, Online |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 3 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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).
Parameter properties
| Type: | UInt32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | ttl, TimeToLive |
Parameter sets
(All)
| Position: | 4 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.