Edit

Share via

Set-DfsnRoot

Module:
DFSN Module

Changes settings for a DFS namespace.

Syntax

Default (Default) 

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

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.

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:

CimSession[]

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.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:desc

Parameter sets

(All)
Position:6
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments: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.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False
Aliases:abe, abde

Parameter sets

(All)
Position:3
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:2
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments: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.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False
Aliases:RootScalability, rootscale

Parameter sets

(All)
Position:4
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments: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.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False
Aliases:SiteCosting, sitecost

Parameter sets

(All)
Position:1
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
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 fail back to the preferred server.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False
Aliases:failback, TargetFailback

Parameter sets

(All)
Position:5
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments: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.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:GrantAdmin, GrantAdminAccess

Parameter sets

(All)
Position:9
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-Path

Specifies a path for the root of a DFS namespace.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:RootPath, root, namespace, NamespaceRoot

Parameter sets

(All)
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-RevokeAdminAccounts

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

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:RevokeAdmin, RevokeAdminAccess

Parameter sets

(All)
Position:10
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments: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.

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:7
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 root targets for this length of time. The default TTL interval for root referrals is 300 seconds.

Parameter properties

Type:UInt32
Default value:None
Supports wildcards:False
DontShow:False
Aliases:ttl, TimeToLive

Parameter sets

(All)
Position:8
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.

Inputs

String

Boolean

Microsoft.PowerShell.Cmdletization.GeneratedTypes.DfsNamespace.State

UInt32

String

Outputs

CimInstance