Remove-SmbShare
Remove-SmbShare
Deletes the specified Server Message Block (SMB) shares.
Syntaxe
Parameter Set: InputObject (cdxml)
Remove-SmbShare -InputObject <CimInstance[]> [-AsJob] [-CimSession <CimSession[]> ] [-Force] [-PassThru] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: Query
Remove-SmbShare [-Name] <String[]> [[-ScopeName] <String[]> ] [-AsJob] [-CimSession <CimSession[]> ] [-Force] [-PassThru] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Description détaillée
The Remove-SMBShare cmdlet deletes one or more Server Message Block (SMB) shares.
Removing an SMB share forcibly disconnects all of the existing connections to the share. Use this cmdlet with caution. Clients that are forcibly disconnected from a share will not have an opportunity to flush locally cached data before being disconnected, which may result in data loss. The Get-SmbSession cmdlet may be used to determine if users are connected to a share.
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 |
-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 |
-Force
Force la commande à s’exécuter sans demander confirmation à l’utilisateur.
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 |
-InputObject<CimInstance[]>
Spécifie l’entrée de cette applet de commande. Vous pouvez utiliser ce paramètre ou transmettre l’entrée à cette applet de commande.
Alias |
none |
Obligatoire ? |
true |
Position ? |
named |
Valeur par défaut |
none |
Accepter l’entrée de pipeline ? |
True (ByValue) |
Accepter les caractères génériques ? |
false |
-Name<String[]>
Specifies one or more SMB shares by share name.
Alias |
none |
Obligatoire ? |
true |
Position ? |
2 |
Valeur par défaut |
none |
Accepter l’entrée de pipeline ? |
True (ByPropertyName) |
Accepter les caractères génériques ? |
false |
-PassThru
Retourne un objet qui représente l’élément avec lequel vous travaillez. Par défaut, cette applet de commande ne génère aucun résultat.
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 |
-ScopeName<String[]>
Specifies the scope of the SMB share to delete.
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 |
-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 |
-Confirm
Votre confirmation sera requise avant l’exécution de l’applet de commande.
Obligatoire ? |
false |
Position ? |
named |
Valeur par défaut |
false |
Accepter l’entrée de pipeline ? |
false |
Accepter les caractères génériques ? |
false |
-WhatIf
Présente les conséquences éventuelles de l’exécution de l’applet de commande. L’applet de commande n’est pas exécutée.
Obligatoire ? |
false |
Position ? |
named |
Valeur par défaut |
false |
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.
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.
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.
Exemples
EXAMPLE 1
This example deletes the SMB share named Data.
PS C:\> Remove-SmbShare –Name Data
EXAMPLE 2
This example deletes the SMB share named VMFiles without user confirmation.
PS C:\> Remove-SmbShare -Name VMFiles -ScopeName Contoso-SO -Force