< Back
Grant-FileShareAccess
Post
NAME Grant-FileShareAccess
SYNOPSIS
Grants access to a file share.
SYNTAX
Grant-FileShareAccess [-CimSession <CimSession[]>] [-FileServer <CimInstance>] [-PassThru] [-ThrottleLimit <Int32>] -AccessRight {Full | Modify | Read |
Custom} -AccountName <String[]> -Name <String[]> [-Confirm] [-WhatIf] [<CommonParameters>]
Grant-FileShareAccess [-CimSession <CimSession[]>] [-PassThru] [-ThrottleLimit <Int32>] -AccessRight {Full | Modify | Read | Custom} -AccountName
<String[]> -UniqueId <String[]> [-Confirm] [-WhatIf] [<CommonParameters>]
Grant-FileShareAccess [-CimSession <CimSession[]>] [-PassThru] [-ThrottleLimit <Int32>] -AccessRight {Full | Modify | Read | Custom} -AccountName
<String[]> [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Grant-FileShareAccess cmdlet grants access to a file share for the specified accounts by adding an Allow access control entry (ACE) to the share's
security descriptor.
PARAMETERS
-AccessRight <AccessRight>
Specifies the access rights for the accounts. The acceptable values for this parameter are:
-- Full
-- Modify
-- Read
-- Custom
Required? true
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-AccountName <String[]>
Specifies an array of account names. This cmdlet grants file share access to the account names that you specify.
Required? true
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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-FileServer [<CimInstance>]
Specifies a file server.
Required? false
Position? named
Default value none
Accept pipeline input? true(ByValue)
Accept wildcard characters? false
-Name <String[]>
Specifies an array of file share names. This cmdlet grants access to the file share names you specify. Because the file share name is not a
worldwide unique name, you can use a different parameter set to avoid confusion.
Required? true
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-PassThru [<SwitchParameter>]
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
Required? false
Position? named
Default value none
Accept pipeline input? false
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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-UniqueId <String[]>
Specifies an array of unique IDs of file shares.
Required? true
Position? named
Default value none
Accept pipeline input? true(ByPropertyName)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value false
Accept pipeline input? false
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.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, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
Example 1: Grant full access to a user
PS C:\\>Grant-FileShare -Name "SalesFiles" -AccessRight "Full" -AccountName "Contoso\\Jack"
This command grants Jack full access to the SalesFiles file share.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=816427
Block-FileShareAccess
Revoke-FileShareAccess
Unblock-FileShareAccess
SYNOPSIS
Grants access to a file share.
SYNTAX
Grant-FileShareAccess [-CimSession <CimSession[]>] [-FileServer <CimInstance>] [-PassThru] [-ThrottleLimit <Int32>] -AccessRight {Full | Modify | Read |
Custom} -AccountName <String[]> -Name <String[]> [-Confirm] [-WhatIf] [<CommonParameters>]
Grant-FileShareAccess [-CimSession <CimSession[]>] [-PassThru] [-ThrottleLimit <Int32>] -AccessRight {Full | Modify | Read | Custom} -AccountName
<String[]> -UniqueId <String[]> [-Confirm] [-WhatIf] [<CommonParameters>]
Grant-FileShareAccess [-CimSession <CimSession[]>] [-PassThru] [-ThrottleLimit <Int32>] -AccessRight {Full | Modify | Read | Custom} -AccountName
<String[]> [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Grant-FileShareAccess cmdlet grants access to a file share for the specified accounts by adding an Allow access control entry (ACE) to the share's
security descriptor.
PARAMETERS
-AccessRight <AccessRight>
Specifies the access rights for the accounts. The acceptable values for this parameter are:
-- Full
-- Modify
-- Read
-- Custom
Required? true
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-AccountName <String[]>
Specifies an array of account names. This cmdlet grants file share access to the account names that you specify.
Required? true
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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-FileServer [<CimInstance>]
Specifies a file server.
Required? false
Position? named
Default value none
Accept pipeline input? true(ByValue)
Accept wildcard characters? false
-Name <String[]>
Specifies an array of file share names. This cmdlet grants access to the file share names you specify. Because the file share name is not a
worldwide unique name, you can use a different parameter set to avoid confusion.
Required? true
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-PassThru [<SwitchParameter>]
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
Required? false
Position? named
Default value none
Accept pipeline input? false
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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-UniqueId <String[]>
Specifies an array of unique IDs of file shares.
Required? true
Position? named
Default value none
Accept pipeline input? true(ByPropertyName)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value false
Accept pipeline input? false
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.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, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
Example 1: Grant full access to a user
PS C:\\>Grant-FileShare -Name "SalesFiles" -AccessRight "Full" -AccountName "Contoso\\Jack"
This command grants Jack full access to the SalesFiles file share.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=816427
Block-FileShareAccess
Revoke-FileShareAccess
Unblock-FileShareAccess