New-DfsnRoot
New-DfsnRoot
Creates a DFS namespace.
Syntax
Parameter Set: NewNamespace2
New-DfsnRoot [-TargetPath] <String> [-Type] <Type> [[-EnableSiteCosting] <Boolean> ] [[-EnableInsiteReferrals] <Boolean> ] [[-EnableAccessBasedEnumeration] <Boolean> ] [[-EnableRootScalability] <Boolean> ] [[-EnableTargetFailback] <Boolean> ] [[-Description] <String> ] [[-State] <State> ] [[-TimeToLiveSec] <UInt32> ] [[-GrantAdminAccounts] <String[]> ] [[-TargetState] <State> ] [[-ReferralPriorityClass] <ReferralPriorityClass> ] [[-ReferralPriorityRank] <UInt32> ] [-AsJob] [-CimSession <CimSession[]> ] [-Path <String> ] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The New-DfsnRoot cmdlet creates a Distributed File System (DFS) namespace. Specify the root path and the root target path for the new namespace. You must also specify a type: stand-alone namespace, Windows 2000 Server mode (Domain v1) namespace, or Windows Server 2008 mode (Domain v2) namespace.
You can specify settings for the new 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 a descriptive comment, select the state of the DFS namespace and DFS root target, and set the Time to Live (TTL) interval for referrals.
To manage the DFS namespace, you can grant 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 (https://technet.microsoft.com/library/cc730736) on TechNet.
Parameters
-AsJob
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-CimSession<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.
Aliases |
Session |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Description<String>
Specifies a description for a DFS namespace.
Aliases |
desc |
Required? |
false |
Position? |
8 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-EnableAccessBasedEnumeration<Boolean>
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.
Aliases |
abe,abde |
Required? |
false |
Position? |
5 |
Default Value |
False |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-EnableInsiteReferrals<Boolean>
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.
Aliases |
insite |
Required? |
false |
Position? |
4 |
Default Value |
False |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-EnableRootScalability<Boolean>
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.
Aliases |
RootScalability,rootscale |
Required? |
false |
Position? |
6 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-EnableSiteCosting<Boolean>
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, DFS namespace favors high-speed links over wide area network (WAN) links.
Aliases |
SiteCosting,sitecost |
Required? |
false |
Position? |
3 |
Default Value |
False |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-EnableTargetFailback<Boolean>
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.
Aliases |
failback,TargetFailback |
Required? |
false |
Position? |
7 |
Default Value |
False |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-GrantAdminAccounts<String[]>
Specifies an array of accounts. This cmdlet grants management permissions for the DFS namespace to the users and user groups specifies.Users can add, remove, and modify namespace folders and folder targets.
Aliases |
GrantAdmin,GrantAdminAccess |
Required? |
false |
Position? |
11 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Path<String>
Specifies a path for the root of a DFS namespace. This path must be unique. This path cannot be the name of an existing DFS namespace.
Aliases |
RootPath,root,namespace,NamespaceRoot |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-ReferralPriorityClass<ReferralPriorityClass>
Specifies the target priority class for a DFS namespace root. 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.
Aliases |
PriorityClass,Class |
Required? |
false |
Position? |
13 |
Default Value |
sitecost-normal |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-ReferralPriorityRank<UInt32>
Specifies the priority rank, as an integer, for a root target of the DFS namespace. Lower values have greater preference. A value of zero (0) is the greatest preference.
Aliases |
PriorityRank,Rank |
Required? |
false |
Position? |
14 |
Default Value |
0 |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-State<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.
Aliases |
none |
Required? |
false |
Position? |
9 |
Default Value |
ONLINE |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-TargetPath<String>
Specifies a path for a root target of the DFS namespace.
Aliases |
NamespaceRootTarget |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-TargetState<State>
Specifies the state of the DFS namespace root target. The acceptable values for this parameter are:
-- Online
-- Offline
Clients do not receive referrals for a DFS namespace folder target that is Offline.
Aliases |
none |
Required? |
false |
Position? |
12 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-ThrottleLimit<Int32>
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-TimeToLiveSec<UInt32>
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.
Aliases |
ttl,TimeToLive |
Required? |
false |
Position? |
10 |
Default Value |
300 |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Type<Type>
Specifies the type of a DFS namespace as a Type object. The acceptable values for this parameter are:
-- Standalone. Specifies a stand-alone namespace.
-- DomainV1. Specifies a Windows 2000 Server mode domain namespace.
-- DomainV2. Specifies a Windows Server 2008 mode domain namespace.
Aliases |
none |
Required? |
true |
Position? |
2 |
Default Value |
domain-v2 |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
- Microsoft.Management.Infrastructure.CimInstance#MSFT_DfsNamespace
Examples
Example 1: Create a Windows Server 2008 mode DomainV2 DFS namespaceWindows Server 2008 mode
This command creates a DFS namespace that has a root at the path \\Contoso\AccountingResources. The root target for the path is the shared folder \\Contoso-FS\AccountingResources. The namespace type is Windows Server 2008 mode, specified as a type of DomainV2.
PS C:\> New-DfsnRoot -TargetPath "\\Contoso-FS\AccountingResources" -Type DomainV2 -Path "\\Contoso\AccountingResources"
Example 2: Create a stand-alone DFS namespace
This command creates a stand-alone DFS namespace that has a root at path \\Contoso\Software that has a namespace root target pointing to \\Contoso-FS\Software. This namespace uses cost-based site selection.
PS C:\> New-DfsnRoot -TargetPath "\\Contoso-FS\Software" -Type Standalone -EnableSiteCosting -Path "\\Contoso\Software"