Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP Cluster-mode documentation.

Cmdlet: Set-NaCifsShare


NAME
Set-NaCifsShare

SYNOPSIS
Changes settings of one or more CIFS shares at any time, even if the shares
are in use.

SYNTAX
Set-NaCifsShare [-Share] <String> [-Comment <String>] [-MaxUsers <Int32>] [-
Group <String>] [-Widelink [<Boolean>]] [-SymlinkStrictSecurity [<Boolean>]]
[-VirusScan [<Boolean>]] [-VirusScanRead [<Boolean>]] [-Browse [<Boolean>]]
[-Umask <Int32>] [-DirectoryUmask <Int32>] [-FileUmask <Int32>] [-Caching <
String>] [-AccessBasedEnum [<Boolean>]] [-NamespaceChaching [<Boolean>]] [-C
ontroller <NaController>] [-WhatIf] [-Confirm] [<CommonParameters>]


DESCRIPTION
Changes settings of one or more CIFS shares at any time, even if the shares
are in use.


PARAMETERS
-Share <String>
If fully specified, it's the name of the existing share to be changed. I
f the name contains the wildcard characters * or ?, then all the shares
matching the specified name are to be changed.

Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false

-Comment <String>
If specified, changes description of the share. CIFS clients see this de
scription when browsing the filer's shares. Specifying an empty string c
lears the previous description.

Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-MaxUsers <Int32>
If specified, changes the maximum number of simultaneous connections to
the new share. It must be a positive number or else zero, in which case
no limit is imposed on the number of connections to the share.

Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-Group <String>
If specified, changes name of the group to which files to be created in
the share belong. The groupname is the name of a group in the UNIX group
database. If the string is empty, files to be created in the share do n
ot belong to a particular UNIX group. That is, each file belongs to the
same group as the owner of the file.

Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-Widelink [<Boolean>]
If true, allows clients to follow absolute symbolic links outside of thi
s share, subject to NT security. This feature requires an entry in the /
etc/symlink.translations file and it requires that the client supports
Microsoft's Distributed File System (DFS). If false or not specified, wi
delinks in the share are disabled.

Required? false
Position? named
Default value false
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-SymlinkStrictSecurity [<Boolean>]
If true or not specified, strict symlink security is enabled. If false,
allows clients to follow symbolic links to destinations on this filer bu
t outside of the current share. It is not checked if the client is authe
nticated to the symbolic link's destination.

Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-VirusScan [<Boolean>]
If true or not specified, virus scan is done when clients open files on
this share, else no virus scan is done.

Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-VirusScanRead [<Boolean>]
If true or not specified, virus scan is done when clients open files on
this share for read access, else no virus scan is done for read access o
n this share.

Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-Browse [<Boolean>]
If true or not specified, shares are visible to browsing clients and can
be enumerated (e.g. "net view", SrvMgr, AD).

Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-Umask <Int32>
If specified, sets file mode creation mask for a share in qtrees with Un
ix or mixed security styles. The mask restricts the initial permissions
setting of a newly created file or directory. If not specified, the file
mode creation mask of the share is 0. This field is ignored when both D
irectoryUmask and FileUmask are present.

Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-DirectoryUmask <Int32>
If specified, sets file mode creation mask for a share in qtrees with Un
ix or mixed security styles. The mask restricts the initial permissions
setting of a newly created directory. For directories, this mask overrid
es one set with "Umask".

Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-FileUmask <Int32>
If specified, sets file mode creation mask for a share in qtrees with Un
ix or mixed security styles. The mask restricts the initial permissions
setting of a newly created file. For files, this mask overrides one set
with "Umask".

Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-Caching <String>
If specified, the following is done based on the value of the string: "n
o_caching": disallow Windows clients from caching any files on this shar
e. This is the default value. "auto_document_caching": allow Windows cli
ents to cache user documents on this share. "auto_program_caching": allo
w Windows clients to cache programs on this share. The actual caching be
havior depends on the Windows client.

Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-AccessBasedEnum [<Boolean>]
If true, Access Based Enumeration (ABE) is enabled. ABE filtered shared
folders are visible to a user based on that individual user's access rig
hts, preventing the display of folders or other shared resources that th
e user does not have rights to access.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-NamespaceChaching [<Boolean>]
If true, namespace caching is enabled on the share. If namespace caching
is enabled on a share, clients are allowed to cache the directory enume
ration results for better performance.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Controller <NaController>
The Data ONTAP controller object, embodied by an NaController object. T
his parameter is returned by the Connect-NaController cmdlet. If not sp
ecified, the value in the global variable CurrentNaController is used.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-WhatIf


Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Confirm


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 and OutVariable. For more information, type,
"get-help about_commonparameters".

INPUTS



OUTPUTS
DataONTAP.Types.Cifs.CifsShareInfo


NOTES


Category: cifs
API: cifs-share-change

-------------- Example 1 --------------

C:\PS>Set-NaCifsShare MyFiles -Comment "My development projects"


Add a comment to a CIFS share.


Caching :
Description : My development projects
DirUmask :
FileUmask :
Forcegroup :
IsSymlinkStrictSecurity :
IsVolOffline :
IsVscan :
IsVscanread :
IsWidelink :
Maxusers :
MountPoint : /vol/vol2
ShareName : MyFiles
Umask :
DirUmaskSpecified : False
FileUmaskSpecified : False
IsSymlinkStrictSecuritySpecified : False
IsVolOfflineSpecified : False
IsVscanSpecified : False
IsVscanreadSpecified : False
IsWidelinkSpecified : False
MaxusersSpecified : False
UmaskSpecified : False



RELATED LINKS
Add-NaCifsShare
Remove-NaCifsShare
Get-NaCifsShare







 Data ONTAP® PowerShell Toolkit