Edit

Share via


Get-DfsnRootTarget

Gets settings for root targets of a DFS namespace.

Syntax

Default (Default)

Get-DfsnRootTarget
    [-Path] <String>
    [[-TargetPath] <String>]
    [-CimSession <CimSession[]>]
    [-ThrottleLimit <Int32>]
    [-AsJob]
    [<CommonParameters>]

Description

The Get-DfsnRootTarget cmdlet gets settings for root targets of a Distributed File System (DFS) namespace. You can specify a DFS namespace path to see all the root targets for that namespace. You can specify a namespace path and a target path to see settings for a single root target.

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

Examples

Example 1: Get root targets for a DFS namespace

Get-DfsnRootTarget -Path '\\Contoso\AccountingSoftware'

This command gets the DFS namespace root targets for the namespace that has the path \\Contoso\AccountingSoftware.

Example 2: Get a specified root target

Get-DfsnRootTarget -Path '\\Contoso\AccountingSoftware' -TargetPath '\\Contoso-FS\Software'

This command gets a single root target, specified by using the path \\Contoso\AccountingSoftware and the target path \\Contoso-FS\Software.

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

-Path

Specifies a path for the root folder of a DFS namespace.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:DfsPath, NamespaceRoot

Parameter sets

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

-TargetPath

Specifies a path for the root folder target of a DFS namespace. This cmdlet gets settings for the root target that has the path specified.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:Target, DfsTarget, RootTargetPath

Parameter sets

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

Inputs

String

Outputs

CimInstance