NAME
Get-FileShare
SYNOPSIS
Retrieves file share objects and their properties.SYNTAX
Get-FileShare [-CimSession
] [-FileServer ] [-Name ] [-Protocol
] [-ThrottleLimit ] [ ] Get-FileShare [-CimSession
] [-ThrottleLimit ] [-UniqueId ] [ ] Get-FileShare [-CimSession
] [-Name ] [-Protocol ] [-ThrottleLimit
] [-Volume ] [ ] Get-FileShare [-CimSession
] [-Name ] [-Protocol ] [-Subsystem
] [-ThrottleLimit ] [ ] DESCRIPTION
The Get-FileShare cmdlet gets objects that correspond to the file shares on the specified server. You must have
local administrator credentials on a server to retrieve the objects.PARAMETERS
-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 [
Specifies the file server on which the file share is hosted. To obtain a FileServer, use the] Get-StorageFileServer cmdlet.
Required? false Position? named Default value none Accept pipeline input? true(ByValue) Accept wildcard characters? false-Name [
Specifies the name of the file share to get. Required? false Position? named Default value none Accept pipeline input? false Accept wildcard characters? false] -Protocol [
Specifies the file sharing protocol of the file shares that this cmdlet gets. The acceptable values for this parameter are: SMB and NFS. Required? false Position? named Default value none Accept pipeline input? false Accept wildcard characters? false] -Subsystem [
Specifies the storage subsystem from which to get file shares. To obtain a StorageSubsystem object, use the] Get-StorageSubSystem cmdlet.
Required? false Position? named Default value none Accept pipeline input? true(ByValue) 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 PowerShellr 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 [
Specifies a unique ID. Required? false Position? named Default value none] Accept pipeline input? true(ByPropertyName)
Accept wildcard characters? false-Volume [
] Specified the volume object that contains the file share to get. To obtain a volume, use the Get-Volume cmdlet.
Required? false Position? named Default value none Accept pipeline input? true(ByValue) Accept wildcard characters? falseThis 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: Get all file shares on the local server
PS C:\>Get-FileShare
This command lists all the file shares on the local server. You must have local administrator permissions on the server to run this command.Example 2: Get all NFS file shares on the specified file server
PS C:\>Get-FileShare -Protocol NFS -FileServer (Get-StorageFileServer -FriendlyName "FileServer01")
This command lists all NFS file shares on the file server named FileServer01. You must have local administratorcredentials on the server to run this command. The command gets the file server by using the Get-StorageFileServer
cmdlet.RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=816379Get-StorageFileServer
Get-StorageSubSystem
Get-Volume