Export (0) Print
Expand All

Get-SmbShare

Updated: August 15, 2012

Applies To: Windows Server 2012

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

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet. For more information about Windows PowerShell® background jobs, see about_Jobs.


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.

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
Name                          ScopeName                     Path                          Description 
----                          ---------                     ----                          ----------- 
ADMIN$                        *                             C:\Windows                    Remote Admin 
C$                            *                             C:\                           Default share 
ClusterStorage$               Contoso-SO                    C:\ClusterStorage             Cluster Shared Volumes Def... 
D$                            *                             D:\                           Default share 
F$                            *                             F:\                           Default share 
G$                            *                             G:\                           Default share 
H$                            *                             H:\                           Default share 
I$                            Contoso-FS                    I:\                           Cluster Default Share 
I$                            *                             I:\                           Default share 
IPC$                          *                                                           Remote IPC 
J$                            Contoso-FS                    J:\                           Cluster Default Share 
J$                            *                             J:\                           Default share 
K$                            *                             K:\                           Default share 
L$                            *                             L:\                           Default share 
M$                            *                             M:\                           Default share 
N$                            *                             N:\                           Default share 
VMS1                          Contoso-FS                    I:\VMS 
VMS2                          Contoso-FS                    J:\VMS 
VMS3                          Contoso-SO                    C:\ClusterStorage\Volume1\VMS 
VMS4                          Contoso-SO                    C:\ClusterStorage\Volume2\VMS 
VMS5                          *                             D:\VMS 

EXAMPLE 2

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


PS C:\> Get-SmbShare –Name VMS1
Name                          ScopeName                     Path                          Description 
----                          ---------                     ----                          ----------- 
VMS1                          Contoso-FS                    I:\VMS 

EXAMPLE 3

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


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

Name        : VMS1 
ScopeName   : Contoso-FS 
Path        : I:\VMS 
Description : 

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 *
PresetPathAcl         : System.Security.AccessControl.DirectorySecurity 
ShareState            : Online 
AvailabilityType      : Clustered 
ShareType             : FileSystemDirectory 
FolderEnumerationMode : Unrestricted 
CachingMode           : Manual 
CATimeout             : 0 
ConcurrentUserLimit   : 0 
ContinuouslyAvailable : True 
CurrentUsers          : 3 
Description           : 
EncryptData           : False 
Name                  : VMS1 
Path                  : I:\VMS 
Scoped                : True 
ScopeName             : Contoso-FS 
SecurityDescriptor    : O:BAG:DUD:(A;;FA;;;S-1-5-21-219828122-4198910963-4161819395-500)(A;;FA;;;S-1-5-21-219828122-419 
                        8910963-4161819395-1106)(A;;FA;;;S-1-5-21-219828122-4198910963-4161819395-1109) 
ShadowCopy            : False 
Special               : False 
Temporary             : False 
Volume                : \\?\Volume{b02c4ba7-e6f1-11e1-93eb-0008a1c0ef0d}\ 
PSComputerName        : 
CimClass              : ROOT/Microsoft/Windows/SMB:MSFT_SmbShare 
CimInstanceProperties : {AvailabilityType, CachingMode, CATimeout, ConcurrentUserLimit...} 
CimSystemProperties   : Microsoft.Management.Infrastructure.CimSystemProperties 

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
Name                          ScopeName                     Path                          Description 
----                          ---------                     ----                          ----------- 
ClusterStorage$               Contoso-SO                    C:\ClusterStorage             Cluster Shared Volumes Def... 
VMS3                          Contoso-SO                    C:\ClusterStorage\Volume1\VMS 
VMS4                          Contoso-SO                    C:\ClusterStorage\Volume2\VMS 

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
Name                          ScopeName                     Path                          Description 
----                          ---------                     ----                          ----------- 
I$                            Contoso-FS                    I:\                           Cluster Default Share 
J$                            Contoso-FS                    J:\                           Cluster Default Share 
VMS1                          Contoso-FS                    I:\VMS 
VMS2                          Contoso-FS                    J:\VMS 

Related topics

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft