Grant-DfsnAccess
Grant-DfsnAccess
Grants permissions to users and groups to access a DFS namespace folder.
Syntax
Parameter Set: GrantNamespaceAccessRights1
Grant-DfsnAccess [-Path] <String> [-AccountName] <String[]> [-AsJob] [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Grant-DfsnAccess cmdlet grants permissions to users and groups for a Distributed File System (DFS) namespace folder. This cmdlet grants permissions to access a folder and to enumerate its contents. You can use the Get-DfsnAccess cmdlet to see the current permissions, and you can use the Revoke-DfsnAccess cmdlet to revoke permissions.
For a DFS namespace which has Access-based enumeration enabled, users can see only the folders that they can access.
For more information about DFS namespaces, see Overview of DFS Namespaces (https://technet.microsoft.com/library/cc730736) on TechNet.
Parameters
-AccountName<String[]>
Specifies an array of user and group accounts. This cmdlet grants permissions to the accounts specified.
Aliases |
Account,user |
Required? |
true |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-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 |
-Path<String>
Specifies a path for a DFS namespace folder. This cmdlet grants permissions to access the folder specified.
Aliases |
DfsPath,FolderPath,NamespacePath |
Required? |
true |
Position? |
1 |
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 |
-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_DfsNamespaceAccess
Examples
Example 1: Grant a permission to a user
This command grants the user Western\SarahJones permissions for the folder \\Contoso\Software\Projects.
PS C:\> Grant-DfsnAccess -Path "\\Contoso\Software\Projects" -AccountName "Western\SarahJones"