Set-SmbShare

Set-SmbShare

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

Syntaxe

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

Description détaillée

The Set-SMBShare cmdlet modifies the properties of the Server Message Block (SMB) 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

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

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

-CATimeout<UInt32>

Specifies the continuous availability timeout of the SMB share.

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

-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

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

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

-ContinuouslyAvailable<Boolean>

Indicates that the share is continuously available.

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

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

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

-EncryptData<Boolean>

Indicates that the SMB share is encrypted.

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

-FolderEnumerationMode<FolderEnumerationMode>

Specifies which files and folders in the new SMB share will be visible to the users. Les valeurs acceptables pour ce paramètre sont :
-- 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.

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

-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 the name of one or more SMB shares.

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 name of the SMB share.

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

-SecurityDescriptor<String>

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

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.

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

  The MSFT_SmbShare object represents the modified share.

Exemples

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

Rubriques connexes

Get-SmbShare

New-SmbShare

Remove-SmbShare