Remove-SmbShare

Remove-SmbShare

Deletes the specified Server Message Block (SMB) shares.

構文

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

詳細説明

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.

パラメーター

-AsJob

-CimSession<CimSession[]>

リモート セッションまたはリモート コンピューターでコマンドレットを実行します。New-CimSession コマンドレットや Get-CimSession コマンドレットの出力など、コンピューター名またはセッション オブジェクトを入力します。既定値は、ローカル コンピューターで実行中の現在のセッションです。

-Force

ユーザーの確認を求めずにコマンドを強制的に実行します。

-InputObject<CimInstance[]>

このコマンドレットへの入力を指定します。このパラメーターを使用するか、パイプを使用して入力をこのコマンドレットに渡すことができます。

-Name<String[]>

Specifies one or more SMB shares by share name.

-PassThru

作業中の項目を表すオブジェクトを返します。既定では、このコマンドレットによる出力はありません。

-ScopeName<String[]>

Specifies the scope of the SMB share to delete.

-ThrottleLimit<Int32>

このコマンドレットを実行するために確立できる最大同時操作数を指定します。このパラメーターを省略するか、値として 0 を入力した場合、Windows PowerShell® では、コンピューターで実行している CIM コマンドレットの数に基づいて、コマンドレットに対する最適なスロットル制限を計算します。スロットル制限は現在のコマンドレットのみに適用され、セッションまたはコンピューターには適用されません。

-Confirm

コマンドレットを実行する前に、ユーザーに確認を求めます。

-WhatIf

コマンドレットを実行するとどのような結果になるかを表示します。コマンドレットは実行されません。

<CommonParameters>

このコマンドレットは次の共通パラメーターをサポートします。-Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer、-OutVariable.詳細については、以下を参照してください。 about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216)。

入力

入力型は、コマンドレットにパイプできるオブジェクトの型です。

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

  Microsoft.Management.Infrastructure.CimInstance オブジェクトは、Windows Management Instrumentation (WMI) オブジェクトを表示するラッパー クラスです。シャープ記号 (#) の後のパスは、基になる WMI オブジェクトの名前空間とクラス名です。

出力

出力型は、コマンドレットによって生成されるオブジェクトの型です。

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

  Microsoft.Management.Infrastructure.CimInstance オブジェクトは、Windows Management Instrumentation (WMI) オブジェクトを表示するラッパー クラスです。シャープ記号 (#) の後のパスは、基になる WMI オブジェクトの名前空間とクラス名です。

例

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

関連トピック

Get-SmbShare

New-SmbShare

Set-SmbShare