< Back
Set-NsSmbShare
Post
NAME Set-NsSmbShare
SYNOPSIS
Sets the options for an SMB share
SYNTAX
Set-NsSmbShare [-Path] <String> [-ShareName <String>] [-AccessBasedEnum] [-clientSideCaching <String>]
[-Encryption] [-GuestOk] [-Description <String>] [-ShareQuotas] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Sets the options for an SMB share
PARAMETERS
-Path <String>
Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-ShareName <String>
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-AccessBasedEnum [<SwitchParameter>]
Enable Access based enumeration feature for the share
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-clientSideCaching <String>
Required? false
Position? named
Default value manual
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Encryption [<SwitchParameter>]
Enable encryption for share
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-GuestOk [<SwitchParameter>]
Enable guest access to share
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Description <String>
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-ShareQuotas [<SwitchParameter>]
SMB quotas presented and supported
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
Updated share object
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Set-SmbShare -Path p2/top2 -ShareName test-share3 -AccessBasedEnum | ft
filesystem shareState shareName guestOk encryption accessBasedEnum shareDescription shareQuotas clientSideCaching
---------- ---------- --------- ------- ---------- --------------- ---------------- ----------- -----------------
p2/top2 online test-share3 False False True False manual
Change the share name of p2/top2 and enable ABE
RELATED LINKS
SYNOPSIS
Sets the options for an SMB share
SYNTAX
Set-NsSmbShare [-Path] <String> [-ShareName <String>] [-AccessBasedEnum] [-clientSideCaching <String>]
[-Encryption] [-GuestOk] [-Description <String>] [-ShareQuotas] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Sets the options for an SMB share
PARAMETERS
-Path <String>
Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-ShareName <String>
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-AccessBasedEnum [<SwitchParameter>]
Enable Access based enumeration feature for the share
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-clientSideCaching <String>
Required? false
Position? named
Default value manual
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Encryption [<SwitchParameter>]
Enable encryption for share
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-GuestOk [<SwitchParameter>]
Enable guest access to share
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Description <String>
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-ShareQuotas [<SwitchParameter>]
SMB quotas presented and supported
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
Updated share object
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Set-SmbShare -Path p2/top2 -ShareName test-share3 -AccessBasedEnum | ft
filesystem shareState shareName guestOk encryption accessBasedEnum shareDescription shareQuotas clientSideCaching
---------- ---------- --------- ------- ---------- --------------- ---------------- ----------- -----------------
p2/top2 online test-share3 False False True False manual
Change the share name of p2/top2 and enable ABE
RELATED LINKS