New-DfsnFolder
Creates a folder in a DFS namespace.
Syntax
New-DfsnFolder
[-Path] <String>
[-TargetPath] <String>
[[-EnableInsiteReferrals] <Boolean>]
[[-EnableTargetFailback] <Boolean>]
[[-State] <State>]
[[-TimeToLiveSec] <UInt32>]
[[-Description] <String>]
[[-TargetState] <State>]
[[-ReferralPriorityClass] <ReferralPriorityClass>]
[[-ReferralPriorityRank] <UInt32>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
The New-DfsnFolder cmdlet creates a folder in a Distributed File System (DFS) namespace. Specify the path and a path for a folder target for the new 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 specify settings for the new folder. You can use this cmdlet to enable or disable the following settings:
- In-site referrals
- Target failback
You can also add a descriptive comment, select the state of the folder and folder target, and set the Time to Live (TTL) interval for referrals.
Finally, you can specify the priority class and priority rank for referrals.
For more information about DFS namespaces, see Overview of DFS Namespaces on TechNet.
Examples
Example 1: Create a DFS namespace folder
PS C:\> New-DfsnFolder -Path '\\Contoso\AccountingResources\LegacySoftware' -TargetPath '\\Contoso-FS\AccountingLegacy' -EnableTargetFailback $true -Description 'Folder for legacy software.'This command creates a folder called LegacySoftware in the \\Contoso\AccountingResources
namespace. The folder target is \\Contoso-FS\AccountingLegacy. The command enables target failback
for the folder. The command includes a description for the new folder.
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 |
| Required: | False |
| 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 |
| Required: | False |
| 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 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Description
Specifies a description for a DFS namespace folder.
| Type: | String |
| Aliases: | desc |
| Position: | 6 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| 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, the 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 |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-EnableTargetFailback
Indicates whether a DFS namespace uses target failback. If a client attempts to access a target 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: | 3 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Path
Specifies a path for the folder. This path must be unique. This path cannot be the name of an existing DFS namespace folder.
| Type: | String |
| Aliases: | DfsPath, FolderPath, NamespacePath |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ReferralPriorityClass
Specifies the target priority class for a DFS namespace folder. Target priority offers you the ability to classify and rank in-site targets. You can specify targets to receive the highest or lowest preference, and you can divide the remaining targets based on their site cost for a DFS client to connect to them. The acceptable values for this parameter are:
GlobalHigh- The highest priority class for a DFS target. Targets assigned this class receive global preference.SiteCostHigh- The highest site cost priority class for a DFS target. Targets assigned this class receive the most preference among targets of the same site cost for a given DFS client.SiteCostNormal- The middle or normal site cost priority class for a DFS target.SiteCostLow- The lowest site cost priority class for a DFS target. Targets assigned this class receive the least preference among targets of the same site cost for a given DFS client.GlobalLow- The lowest level of priority class for a DFS target. Targets assigned this class receive the least preference globally.
| Type: | Microsoft.PowerShell.Cmdletization.GeneratedTypes.DfsNamespaceRootTarget.ReferralPriorityClass |
| Aliases: | PriorityClass, Class |
| Accepted values: | SiteCostNormal, GlobalHigh, SiteCostHigh, SiteCostLow, GlobalLow |
| Position: | 8 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ReferralPriorityRank
Specifies the priority rank, as an integer, for a target in the DFS namespace. Lower values have greater preference. A value of zero (0) is the greatest preference.
| Type: | UInt32 |
| Aliases: | PriorityRank, Rank |
| Position: | 9 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-State
Specifies the state of the DFS namespace folder. The acceptable values for this parameter are:
OnlineOffline
Clients do not receive referrals for a DFS namespace folder that is offline.
| Type: | Microsoft.PowerShell.Cmdletization.GeneratedTypes.DfsNamespaceRootTarget.State |
| Accepted values: | Offline, Online |
| Position: | 4 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-TargetPath
Specifies a path for a target for the DFS namespace folder.
| Type: | String |
| Aliases: | Target, DfsTarget, FolderTarget |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-TargetState
Specifies the state of the DFS namespace folder target. The acceptable values for this parameter are:
OnlineOffline
Clients do not receive referrals for a DFS namespace folder target that is offline.
| Type: | Microsoft.PowerShell.Cmdletization.GeneratedTypes.DfsNamespaceRootTarget.State |
| Accepted values: | Offline, Online |
| Position: | 7 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| 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 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-TimeToLiveSec
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).
| Type: | UInt32 |
| Aliases: | ttl, TimeToLive |
| Position: | 5 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| 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 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
Microsoft.PowerShell.Cmdletization.GeneratedTypes.DfsNamespaceFolder.State
Microsoft.PowerShell.Cmdletization.GeneratedTypes.DfsNamespaceFolderTarget.State
Microsoft.PowerShell.Cmdletization.GeneratedTypes.DfsNamespaceFolderTarget.ReferralPriorityClass