Set-SmbShare

Set-SmbShare

Modifies the properties of the Server Message Block (SMB) share.

構文

Parameter Set: InputObject (cdxml)
Set-SmbShare -InputObject <CimInstance[]> [-AsJob] [-CachingMode <CachingMode> ] [-CATimeout <UInt32> ] [-CimSession <CimSession[]> ] [-ConcurrentUserLimit <UInt32> ] [-ContinuouslyAvailable <Boolean> ] [-Description <String> ] [-EncryptData <Boolean> ] [-FolderEnumerationMode <FolderEnumerationMode> ] [-Force] [-PassThru] [-SecurityDescriptor <String> ] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: Query
Set-SmbShare [-Name] <String[]> [[-ScopeName] <String[]> ] [-AsJob] [-CachingMode <CachingMode> ] [-CATimeout <UInt32> ] [-CimSession <CimSession[]> ] [-ConcurrentUserLimit <UInt32> ] [-ContinuouslyAvailable <Boolean> ] [-Description <String> ] [-EncryptData <Boolean> ] [-FolderEnumerationMode <FolderEnumerationMode> ] [-Force] [-PassThru] [-SecurityDescriptor <String> ] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

詳細説明

The Set-SMBShare cmdlet modifies the properties of the Server Message Block (SMB) share.

パラメーター

-AsJob

-CachingMode<CachingMode>

Specifies the caching mode of the offline files for the SMB share. There are five different caching modes:
-- None: Prevents users from storing documents and programs offline.
-- Manual: Allows users to identify the documents and programs that they want to store offline.
-- Programs: Automatically stores documents and programs offline.
-- Documents: Automatically stores documents offline.
-- BranchCache: Enables BranchCache and manual caching of documents on the shared folder.

-CATimeout<UInt32>

Specifies the continuous availability timeout of the SMB share.

-CimSession<CimSession[]>

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

-ConcurrentUserLimit<UInt32>

Specifies the maximum number of concurrently connected users that the new SMB share may accommodate. If this parameter is set to zero (0), then the number of users is unlimited. By default, new SMB shares have no limit on the number of concurrent connections.

-ContinuouslyAvailable<Boolean>

Indicates that the share is continuously available.

-Description<String>

Specifies an optional description of the SMB share. A description of the share can be displayed by running the Get-SMBShare cmdlet. Specify an empty string to clear the current description. The description may not contain more than 256 characters.

-EncryptData<Boolean>

Indicates that the SMB share is encrypted.

-FolderEnumerationMode<FolderEnumerationMode>

Specifies which files and folders in the new SMB share will be visible to the users. このパラメーターに対して使用できる値:
-- AccessBased: SMB will not the display the files and folders for a share to a user unless that user has rights to access the files and folders. By default, access-based enumeration is disabled for new SMB shares.
-- Unrestricted: SMB will display files and folders to a user even when the user does not have permission to access those items.
The default value is Unrestricted.

-Force

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

-InputObject<CimInstance[]>

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

-Name<String[]>

Specifies the name of one or more SMB shares.

-PassThru

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

-ScopeName<String[]>

Specifies the scope name of the SMB share.

-SecurityDescriptor<String>

Specifies the security descriptor for the SMB share in string format.

-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)。

入力

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

• None

出力

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

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

  The MSFT_SmbShare object represents the modified share.

例

EXAMPLE 1

This example modifies the properties of an SMB share.

PS C:\> Set-SmbShare -Name VMFiles -EncryptData $true

EXAMPLE 2

This example modifies the properties of an SMB share without user confirmation.

PS C:\> Set-SmbShare -Name VMFiles -EncryptData $true -Force

関連トピック

Get-SmbShare

New-SmbShare

Remove-SmbShare