New-SmbShare
SYNOPSIS
Creates a new SMB share.
SYNTAX
New-SmbShare [-Cluster] <Cluster> [-FileSystemId] <string> [Path] <string> [-Name] <string> [-Description] <string>
[-Umask <string>] [-AccessPolicy {Manual | Documents | Programs | None}] [-EnableAbe] [-EnableBranchCache] [-EnableContinuousAvailability] [-EnableEncryption] [-WhatIf] [-Confirm]
[<CommonParameters>]
DESCRIPTION
Creates a new SMB share.
EXAMPLES
Example 1
PS C:\> New-SmbShare $cluster uuid1 /fsname1 smb1
Where $cluster is a PowerStore cluster instance. Creates a new SMB share named smb1 on the file system with ID uuid1 and local path /fsname1.
Example 2
PS C:\> New-SmbShare $cluster uuid1 /fsname1 smb02 -OfflineAvailability Documents
Where $cluster is a PowerStore cluster instance. Creates a new SMB share named smb02 on the file system with ID uuid1 and local path /fsname1. The SMB share will have ‘Documents’ chosen as its state of offline availability.
Example 3
PS C:\> New-SmbShare $cluster uuid1 /fsname1 smb03 -Umask 020
Where $cluster is a PowerStore cluster instance. Creates a new SMB share named smb03 on the file system with ID uuid1 and local path /fsname1. This SMB share will have a UNIX umask of 020.
Example 4
PS C:\> New-SmbShare $cluster uuid1 /fsname1 smb04 -EnableEncryption
Where $cluster is a PowerStore cluster instance. Creates a new SMB share named smb04 on the file system with ID uuid1 and local path /fsname1. Encryption will be enabled at the shared folder level 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
-FileSystemId
The UUID of the file system to place the SMB share on.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Path
Local path to the file system or any existing sub-folder of the file system that is shared over the network. This path is relative to the NAS Server and must start with the file system’s mountpoint path, which is the file system name. For example, to share the top-level of a file system named svr1fs1, which is on the /svr1fs1 mountpoint of the NAS Server, use /svr1fs1 in the path parameter. SMB shares allow you to create multiple network shares for the same local path.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Name
The name of the SMB share.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 3
Default value: None
Accept pipeline input: False
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 (default).
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. If not specified the umask defaults to 022.
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). 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 BranchCace optimization. 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.
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.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
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.