New-SmbShare

New-SmbShare

Creates a new Server Message Block (SMB) share.

構文

Parameter Set: CreateShare0
New-SmbShare [-Name] <String> [-Path] <String> [[-ScopeName] <String> ] [-AsJob] [-CachingMode <CachingMode> ] [-CATimeout <UInt32> ] [-ChangeAccess <String[]> ] [-CimSession <CimSession[]> ] [-ConcurrentUserLimit <UInt32> ] [-ContinuouslyAvailable <Boolean> ] [-Description <String> ] [-EncryptData <Boolean> ] [-FolderEnumerationMode <FolderEnumerationMode> ] [-FullAccess <String[]> ] [-NoAccess <String[]> ] [-ReadAccess <String[]> ] [-Temporary] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

詳細説明

The New-SMBShare cmdlet exposes a file system folder to remote clients as a new Server Message Block (SMB) share.

To delete a share that was created by this cmdlet, use the Remove-SMBShare cmdlet.

パラメーター

-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 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 for the share.

-ChangeAccess<String[]>

Specifies which user will be granted modify permission to access the share. Multiple users can be specified by using a comma-separated list.

-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. The default value is zero (0).

-ContinuouslyAvailable<Boolean>

Indicates that the share is continuously available.

-Description<String>

Specifies an optional description of the new SMB share. A description of the share is displayed by running the Get-SmbShare cmdlet. The description may not contain more than 256 characters. The default value no description, or an empty description

-EncryptData<Boolean>

Indicates that the share is encrypted.

-FolderEnumerationMode<FolderEnumerationMode>

Specifies which files and folders in the new SMB share are visible to 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 the items.
The default value is Unrestricted.

-FullAccess<String[]>

Specifies which accounts are granted full permission to access the share. Use a comma-separated list to specify multiple accounts. An account may not be specified more than once in the FullAccess, ChangeAccess, or ReadAccess parameter lists, but may be specified once in the FullAccess, ChangeAccess, or ReadAccess parameter list and once in the NoAccess parameter list.

-Name<String>

Specifies a name for the new SMB share. The name may be composed of any valid file name characters, but must be less than 80 characters in length. The names pipe and mailslot are reserved for use by the computer.

-NoAccess<String[]>

Specifies which accounts are denied access to the share. Multiple accounts can be specified by supplying a comma-separated list.

-Path<String>

Specifies the path to the location of the folder to share. The path must be fully qualified; relative paths or paths that contain wildcard characters are not permitted.

-ReadAccess<String[]>

Specifies which user is granted read permission to access the share. Multiple users can be specified by supplying a comma-separated list.

-ScopeName<String>

Specifies the scope name of the share.

-Temporary

Specifies the lifetime of the new SMB share. A temporary share does not persist beyond the next reboot of the computer. By default, new SMB shares are persistent, and non-temporary.

-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

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

例

EXAMPLE 1

This example creates a new SMB share.

PS C:\> New-SmbShare –Name VMSFiles –Path C:\ClusterStorage\Volume1\VMFiles -FullAccess Contoso\Administrator, Contoso\Contoso-HV1$

EXAMPLE 2

This example creates a new encrypted SMB share.

PS C:\> New-SmbShare -Name Data -Path J:\Data -EncryptData $true

関連トピック

Get-SmbShare

Remove-SmbShare

Set-SmbShare