Set-SmbShare
SYNOPSIS
Changes properties of a SMB share.
SYNTAX
Set-SmbShare [-Cluster] <Cluster> [-Id] <string> [-Description] <string> [-Umask <string>]
[-AccessPolicy {Manual | Documents | Programs | None}] [-EnableAbe <Boolean>]
[-EnableBranchCache <Boolean>] [-EnableContinuousAvailability <Boolean>]
[-EnableEncryption <Boolean>] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Supports changing SMB share properties; description, umask, access policy, ABE, branch caching, continuous availability, and encryption.
EXAMPLES
Example 1
PS C:\> Set-SmbShare $cluster -Id 627411c4-1b81-548f-daa2-4687da6fdce8 -Description "New description"
Where $cluster is a PowerStore cluster instance. Sets the description of the SMB share to “New description”.
Example 2
PS C:\> Set-SmbShare $cluster -Id 627411c4-1b81-548f-daa2-4687da6fdce8 -Umask 020
Where $cluster is a PowerStore cluster instance. Sets the new default UNIX umask on the SMB server to 020.
Example 3
PS C:\> Set-SmbShare $cluster -Id 627411c4-1b81-548f-daa2-4687da6fdce8 -EnableEncryption $False
Where $cluster is a PowerStore cluster instance. Disables encryption on the SMB share.
PARAMETERS
-Cluster
The PowerStore cluster.
Type: Cluster
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Id
The SMB share ID.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
-Description
SMB share description.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-OfflineAvailability
Defines state of offline availability.
- Manual - Only specified files will be available offline.
- Documents - All files that users open will be available offline.
- Programs - Program will preferably run from the offline cache even when connected to the network. All files that users open will be available offline.
- None - Prevents clients from storing documents and programs in offline cache.
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: Manual, Documents, Programs, None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Umask
The default UNIX umask for new files created on the Share.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-EnableAbe
Enables Access-based Enumeration (ABE) if set to true. ABE filters the list of available files and folders on a server to include only those to which the requesting user has access.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-EnableBranchCache
Enables BranchCache optimization if set to true. BranchCache optimization technology copies content from your main office or hosted cloud content servers and caches the content at branch office locations, allowing client computers at branch offices to access the content locally rather than over the WAN.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-EnableContinuousAvailability
Enables continuous availability for Server Message Block (SMB) 3.0 for the SMB Share if set to true.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-EnableEncryption
Enables encryption for Server Message Block (SMB) 3.0 at the shared folder level if set to true.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.