Set-Dfsn Root

Module:
dfsn
Changes settings for a DFS namespace.

Syntax 

Set-DfsnRoot
   [-Path] <String>
   [[-EnableSiteCosting] <Boolean>]
   [[-EnableInsiteReferrals] <Boolean>]
   [[-EnableAccessBasedEnumeration] <Boolean>]
   [[-EnableRootScalability] <Boolean>]
   [[-EnableTargetFailback] <Boolean>]
   [[-Description] <String>]
   [[-State] <State>]
   [[-TimeToLiveSec] <UInt32>]
   [[-GrantAdminAccounts] <String[]>]
   [[-RevokeAdminAccounts] <String[]>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

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

You can use this cmdlet to enable or disable the following settings:

  • Site costing.
  • In-site referrals.
  • Access-based enumeration.
  • Root scalability.
  • 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.

To manage the DFS namespace, you can use this cmdlet to grant or revoke permissions to users or user groups. Users who have these permissions can add, remove, and modify namespace folders and folder targets for the DFS namespace.

For more information about DFS namespaces, see Overview of DFS Namespaces on TechNet.

Examples

Example 1: Change root scalability and TTL 

PS C:\> Set-DfsnRoot -Path "\\Contoso\AccountingResources" -EnableRootScalability $True -TimeToLiveSec 900

This command modifies settings for the DFS namespace that has the path \\Contoso\AccountingResources. The command enables root scalability, which allows the DFS namespace server to poll domain controllers for updates. The command also sets the referral TTL interval to 900 seconds.

Required Parameters

-Path

Specifies a path for the root of a DFS namespace.

Type: String
Aliases: RootPath, root, namespace, NamespaceRoot
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.

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

Indicates whether a DFS namespace uses Access-based enumeration. If this value is $True, a DFS namespace server shows a user only the files and folders that the user can access.

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

Indicates whether a DFS namespace uses root scalability mode. If this value is $True, DFS namespace servers connect to the nearest domain controllers for periodic namespace updates. If this value is $False, the servers connect to the primary domain controller (PDC) emulator.

Type: Boolean
Aliases: RootScalability, rootscale
Position: 4
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-EnableSiteCosting

Indicates whether a DFS namespace uses cost-based selection. If a client cannot access a folder target in-site, a DFS namespace server selects the least resource-intensive alternative. If you provide a value of $True for this parameter, the DFS namespace favors high-speed links over wide area network (WAN) links.

Type: Boolean
Aliases: SiteCosting, sitecost
Position: 1
Default value: None
Accept pipeline input: False
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 fail back to the preferred server.

Type: Boolean
Aliases: failback, TargetFailback
Position: 5
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-GrantAdminAccounts

Specifies an array of accounts. This cmdlet grants management permissions the users and user groups specified for the DFS namespace. Users can add, remove, and modify namespace folders and folder targets.

Type: String[]
Aliases: GrantAdmin, GrantAdminAccess
Position: 9
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-RevokeAdminAccounts

Specifies an array of accounts. This cmdlet removes management permissions for the users and user groups specified for the DFS namespace.

Type: String[]
Aliases: RevokeAdmin, RevokeAdminAccess
Position: 10
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-State

Specifies the state of the DFS namespace root. The acceptable values for this parameter are:

  • Online
  • Offline

Clients do not receive referrals for a DFS namespace folder that is offline. If you set a namespace root to a value of Offline, the entire namespace becomes inaccessible.

Type: State
Parameter Sets: Offline, Online
Position: 7
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 root targets for this length of time. The default TTL interval for root referrals is 300 seconds.

Type: UInt32
Aliases: ttl, TimeToLive
Position: 8
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_DfsNamespace