Get-SmbShare

Get-SmbShare

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

Syntaxe

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

Description détaillée

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

Paramètres

-AsJob

Alias

none

Obligatoire ?

false

Position ?

named

Valeur par défaut

none

Accepter l’entrée de pipeline ?

false

Accepter les caractères génériques ?

false

-AvailabilityType<AvailabilityType[]>

Specifies the cluster type of the shares being enumerated.

Alias

none

Obligatoire ?

false

Position ?

named

Valeur par défaut

none

Accepter l’entrée de pipeline ?

True (ByPropertyName)

Accepter les caractères génériques ?

false

-CachingMode<CachingMode[]>

Specifies the caching mode of the shares being enumerated.

Alias

none

Obligatoire ?

false

Position ?

named

Valeur par défaut

none

Accepter l’entrée de pipeline ?

True (ByPropertyName)

Accepter les caractères génériques ?

false

-CaTimeout<UInt32[]>

Specifies the continuous availability timeout of the shares being enumerated.

Alias

none

Obligatoire ?

false

Position ?

named

Valeur par défaut

none

Accepter l’entrée de pipeline ?

True (ByPropertyName)

Accepter les caractères génériques ?

false

-CimSession<CimSession[]>

Exécute l’applet de commande dans une session à distance ou sur un ordinateur distant. Entrez un nom d’ordinateur ou un objet de session, comme la sortie d’une applet de commande New-CimSession ou Get-CimSession. La valeur par défaut est la session active sur l’ordinateur local.

Alias

none

Obligatoire ?

false

Position ?

named

Valeur par défaut

none

Accepter l’entrée de pipeline ?

false

Accepter les caractères génériques ?

false

-ConcurrentUserLimit<UInt32[]>

Specifies the concurrent user limit of the shares being enumerated.

Alias

none

Obligatoire ?

false

Position ?

named

Valeur par défaut

none

Accepter l’entrée de pipeline ?

True (ByPropertyName)

Accepter les caractères génériques ?

false

-ContinuouslyAvailable<Boolean[]>

Indicates that the shares being enumerated should be continuously available.

Alias

none

Obligatoire ?

false

Position ?

named

Valeur par défaut

none

Accepter l’entrée de pipeline ?

True (ByPropertyName)

Accepter les caractères génériques ?

false

-EncryptData<Boolean[]>

Indicates that the shares being enumerated should be encrypted.

Alias

none

Obligatoire ?

false

Position ?

named

Valeur par défaut

none

Accepter l’entrée de pipeline ?

True (ByPropertyName)

Accepter les caractères génériques ?

false

-FolderEnumerationMode<FolderEnumerationMode[]>

Specifies the folder enumeration mode of the shares being enumerated.

Alias

none

Obligatoire ?

false

Position ?

named

Valeur par défaut

none

Accepter l’entrée de pipeline ?

True (ByPropertyName)

Accepter les caractères génériques ?

false

-IncludeHidden

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

Alias

none

Obligatoire ?

false

Position ?

named

Valeur par défaut

none

Accepter l’entrée de pipeline ?

false

Accepter les caractères génériques ?

false

-Name<String[]>

Specifies one or more SMB shares by share name.

Alias

none

Obligatoire ?

false

Position ?

2

Valeur par défaut

none

Accepter l’entrée de pipeline ?

True (ByPropertyName)

Accepter les caractères génériques ?

true

-Scoped<Boolean[]>

Indicates that the shares to be numerated should be scoped.

Alias

none

Obligatoire ?

false

Position ?

named

Valeur par défaut

none

Accepter l’entrée de pipeline ?

True (ByPropertyName)

Accepter les caractères génériques ?

false

-ScopeName<String[]>

Specifies the scope of the share by name.

Alias

none

Obligatoire ?

false

Position ?

3

Valeur par défaut

none

Accepter l’entrée de pipeline ?

True (ByPropertyName)

Accepter les caractères génériques ?

false

-ShareState<ShareState[]>

Specifies the state of the shares being enumerated.

Alias

none

Obligatoire ?

false

Position ?

named

Valeur par défaut

none

Accepter l’entrée de pipeline ?

True (ByPropertyName)

Accepter les caractères génériques ?

false

-Special<Boolean[]>

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

Alias

none

Obligatoire ?

false

Position ?

named

Valeur par défaut

none

Accepter l’entrée de pipeline ?

True (ByPropertyName)

Accepter les caractères génériques ?

false

-ThrottleLimit<Int32>

Spécifie le nombre maximal d’opérations simultanées qui peuvent être établies pour exécuter cette applet de commande. Si ce paramètre est omis ou si la valeur 0 est entrée, Windows PowerShell ® calcule une limitation optimale pour l’applet de commande en fonction du nombre d’applets de commande CIM qui s’exécutent sur l’ordinateur. La limitation s’applique seulement à l’applet de commande actuelle, et non pas à la session ni à l’ordinateur.

Alias

none

Obligatoire ?

false

Position ?

named

Valeur par défaut

none

Accepter l’entrée de pipeline ?

false

Accepter les caractères génériques ?

false

<CommonParameters>

Cette applet de commande prend en charge les paramètres courants : -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer et -OutVariable. Pour plus d’informations, consultez about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Entrées

Le type d’entrée correspond au type des objets que vous pouvez transmettre à l’applet de commande.

  • System.String

Sorties

Le type de sortie est le type des objets émis par l’applet de commande.

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

    L’objet Microsoft.Management.Infrastructure.CimInstance est une classe wrapper qui affiche des objets WMI (Windows Management Instrumentation). Le chemin d’accès situé après le symbole dièse (#) fournit l’espace de noms et le nom de classe de l’objet WMI sous-jacent.
    The MSFT_SmbShare object represents the SMB shares on the computer.

Exemples

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

Rubriques connexes

New-SmbShare

Remove-SmbShare

Set-SmbShare