Get-DfsnRoot
Gets settings for DFS namespaces.
Syntax
ByDomain (Default)
Get-DfsnRoot
[[-Domain] <String>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>]
ByRoot
Get-DfsnRoot
[[-Path] <String>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>]
ByServer
Get-DfsnRoot
[[-ComputerName] <String>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>]
Description
The Get-DfsnRoot cmdlet gets configuration settings for Distributed File System (DFS) namespaces. You can specify DFS namespaces by using a standalone or domain-based namespace path, by using a server, or by using a domain. Use this cmdlet without parameters to see information on all DFS namespaces. You can make changes to DFS settings by using the Set-DfsnRoot cmdlet.
For more information about DFS namespaces, see Overview of DFS Namespaces on TechNet.
Examples
Example 1: Get DFS namespace configuration settings
Get-DfsnRoot -Path '\\Contoso\AccountingResources' | Format-List
Path : \\Contoso\AccountingResources
Description :
Type : Standalone
State : Online
Flags : Site Costing
TimeToLiveSec : 300
This command gets configuration settings for the namespace that has the Path
\\Contoso\AccountingResources. The command uses the Format-List cmdlet to format the output.
For more information about this cmdlet, type Get-Help Format-List.
Example 2: Get all DFS namespaces for a domain
Get-DfsnRoot -Domain 'Contoso.com'
This command gets all the DFS namespaces hosted in the domain Contoso.com.
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 |
-ComputerName
Specifies the name of a server. This cmdlet gets configuration settings for all DFS namespaces that the specified server hosts.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | Server |
Parameter sets
ByServer
| Position: | 0 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-Domain
Specifies a domain name. This cmdlet gets configuration settings for DFS namespaces in the domain specified.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByDomain
| Position: | 0 |
| 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 folder of a DFS namespace. This cmdlet gets configuration settings for the DFS namespace that has the root path specified.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | RootPath, root, namespace, NamespaceRoot |
Parameter sets
ByRoot
| Position: | 0 |
| 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 |
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.