Close-SmbOpenFile
Close-SmbOpenFile
Forcibly closes a file that is open by one of the clients of the Server Message Block (SMB) server.
Syntaxe
Parameter Set: Query (cdxml)
Close-SmbOpenFile [[-FileId] <UInt64[]> ] [-AsJob] [-CimSession <CimSession[]> ] [-ClientComputerName <String[]> ] [-ClientUserName <String[]> ] [-ClusterNodeName <String[]> ] [-Force] [-PassThru] [-ScopeName <String[]> ] [-SessionId <UInt64[]> ] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: InputObject (cdxml)
Close-SmbOpenFile -InputObject <CimInstance[]> [-AsJob] [-CimSession <CimSession[]> ] [-Force] [-PassThru] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Description détaillée
The Close-SMBOpenFile cmdlet forcibly closes a file that is open by one of the clients of the Server Message Block (SMB) server. This cmdlet should be used with care as it may result in data loss to the client for which the file is being closed if the client has not flushed all of the file modifications back to the server before the file is closed.
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 |
-ClientComputerName<String[]>
Specifies the client computer name to filter the returned open files so that only the matching files are opened.
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 |
-ClientUserName<String[]>
Specifies the name of the user for which the open files are retrieved.
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 |
-ClusterNodeName<String[]>
Specifies, if a share is hosted by a windows cluster, the name of the server which is hosting the open files to be retrieved.
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 |
-FileId<UInt64[]>
Specifies the file identifier (ID) of the file to forcibly close.
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 ? |
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 |
-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 open files to be retrieved.
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 |
-SessionId<UInt64[]>
Specifies a session ID. Only files that have been opened in the specified session will be returned.
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 |
-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.
- None
Sorties
Le type de sortie est le type des objets émis par l’applet de commande.
- None
Exemples
EXAMPLE 1
This example closes a file identified as 4415226383589 that is open by one of the clients of the SMB server.
PS C:\> Close-SmbOpenFile -FileId 4415226383589
EXAMPLE 2
This example closes one or more files that are open by one of the client identified with the session identifier (ID) 4415226380393 of the SMB server.
PS C:\> Close-SmbOpenFile -SessionId 4415226380393
EXAMPLE 3
This example closes, without user confirmation, one or more files that are open by one of the clients of the SMB server and that match the file extension ".DOCX".
PS C:\> Get-SmbOpenFile | Where-Object -Property ShareRelativePath -Match ".DOCX" | Close-SmbOpenFile –Force