Get-SmbShare

Get-SmbShare

Retrieves the Server Message Block (SMB) shares on the computer.

Syntax

Parameter Set: Query (cdxml)
Get-SmbShare [[-Name] <String[]> ] [[-ScopeName] <String[]> ] [-AsJob] [-AvailabilityType <AvailabilityType[]> ] [-CachingMode <CachingMode[]> ] [-CaTimeout <UInt32[]> ] [-CimSession <CimSession[]> ] [-ConcurrentUserLimit <UInt32[]> ] [-ContinuouslyAvailable <Boolean[]> ] [-EncryptData <Boolean[]> ] [-FolderEnumerationMode <FolderEnumerationMode[]> ] [-IncludeHidden] [-Scoped <Boolean[]> ] [-ShareState <ShareState[]> ] [-Special <Boolean[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Detailed Description

The Get-SMBShare cmdlet retrieves objects that represent the Server Message Block (SMB) shares being displayed by the computer.

Parameters

-AsJob

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-AvailabilityType<AvailabilityType[]>

Specifies the cluster type of the shares being enumerated.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-CachingMode<CachingMode[]>

Specifies the caching mode of the shares being enumerated.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-CaTimeout<UInt32[]>

Specifies the continuous availability timeout of the shares being enumerated.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
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	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-ConcurrentUserLimit<UInt32[]>

Specifies the concurrent user limit of the shares being enumerated.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-ContinuouslyAvailable<Boolean[]>

Indicates that the shares being enumerated should be continuously available.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-EncryptData<Boolean[]>

Indicates that the shares being enumerated should be encrypted.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-FolderEnumerationMode<FolderEnumerationMode[]>

Specifies the folder enumeration mode of the shares being enumerated.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-IncludeHidden

Indicates that shares that are created and used internally are also enumerated.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Name<String[]>

Specifies one or more SMB shares by share name.

Aliases	none
Required?	false
Position?	2
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	true

-Scoped<Boolean[]>

Indicates that the shares to be numerated should be scoped.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-ScopeName<String[]>

Specifies the scope of the share by name.

Aliases	none
Required?	false
Position?	3
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-ShareState<ShareState[]>

Specifies the state of the shares being enumerated.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-Special<Boolean[]>

Indicates that the shares to be numerated should be special. Admin share, default shares, IPC$ share are examples of special shares.

Aliases	none
Required?	false
Position?	named
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

<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.

• System.String

Outputs

The output type is the type of the objects that the cmdlet emits.

• Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/SMB/MSFT_SmbShare

  The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.
  The MSFT_SmbShare object represents the SMB shares on the computer.

Examples

EXAMPLE 1

This example retrieves the SMB shares on the computer.

PS C:\> Get-SMBShare

EXAMPLE 2

This example retrieves the SMB shares on the computer named VMS1.

PS C:\> Get-SmbShare –Name VMS1

EXAMPLE 3

This example displays the information about the SMB shares on the computer named VMS1.

PS C:\> Get-SmbShare –Name VMS1 | Format-List

EXAMPLE 4

This example displays all of the information about the SMB shares on the computer named VMS1.

PS C:\> Get-SmbShare –Name VMS1 | Format-List –Property *

EXAMPLE 5

This example retrieves the SMB shares on the computer with scaled out availability.

PS C:\> Get-SmbShare | Where-Object -Property AvailabilityType -Eq ScaleOut

EXAMPLE 6

This example retrieves the SMB shares on the computer that are connect to the SMB server named Contoso-FS.

PS C:\> Get-SmbShare -ScopeName Contoso-FS

Related topics

New-SmbShare

Remove-SmbShare

Set-SmbShare