Set-DfsnFolder
Set-DfsnFolder
Changes settings for a DFS namespace folder.
Syntax
Parameter Set: SetNamespaceFolder4
Set-DfsnFolder [-Path] <String> [[-EnableInsiteReferrals] <Boolean> ] [[-EnableTargetFailback] <Boolean> ] [[-State] <State> ] [[-TimeToLiveSec] <UInt32> ] [[-Description] <String> ] [-AsJob] [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [-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 (https://technet.microsoft.com/library/cc730736) on TechNet.
Parameters
-AsJob
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
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 (https://go.microsoft.com/fwlink/p/?LinkID=113216).
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_DfsNamespaceFolder
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