|
|
 Data ONTAP® PowerShell Toolkit
|
Cmdlet: Add-NcCifsShare
NAME
Add-NcCifsShare
SYNOPSIS
Creates a new CIFS share rooted at the specified path.
SYNTAX
Add-NcCifsShare [-Name] <String> [-Path] <String> [-ShareProperties <String[
]>] [-SymlinkProperties <String[]>] [-FileUmask <Int32>] [-DirUmask <Int32>]
[-Comment <String>] [-AttributeCacheTtl <Int32>] [-VserverContext <String>]
[-Controller <NcController[]>] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Creates a new CIFS share rooted at the specified path.
PARAMETERS
-Name <String>
The name of the CIFS share. The CIFS share name is a UTF-8 string with t
he following characters being illegal: control characters from 0x00 to 0
x1F, both inclusive, 0x22 (double quotes) and the characters \/[]:|<>+=;
,?
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Path <String>
The file system path that is shared through this CIFS share.
Required? true
Position? 2
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-ShareProperties <String[]>
The list of properties for this CIFS share. Possible values:
"oplocks" - This specifies that opportunistic locks (client-side
caching) are enabled on this share.
"browsable" - This specifies that the share can be browsed by Windo
ws clients.
"showsnapshot" - This specifies that Snapshots can be viewed and trave
rsed by clients.
"changenotify" - This specifies that CIFS clients can request for chan
ge notifications for directories on this share.
"homedirectory" - This specifies that the share is added and enabled as
part of the CIFS home directory feature. The configuration of this shar
e should be done using CIFS home directory feature interface.
"attributecache" - This specifies that connections through this share ar
e caching attributes for a short time to improve performance.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SymlinkProperties <String[]>
This flag controls whether the symlinks under this shared directory are
hidden (option 'hide'), accessible (option 'enable') or are accessible a
s read-only (option 'read-only' along with option 'enable'). Possible va
lues: "enable", "hide", "read_only"
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-FileUmask <Int32>
The value of this field controls the file mode creation mask for the CIF
S share in qtrees with UNIX or Mixed security styles. The mask restricts
the initial permissions setting of a newly created file. The input valu
e is a numeric mode comprising of one to three octal digits (0-7), deriv
ed by adding up the bits with values 4, 2, and 1. The first digit select
s permissions for the user who owns the file: read (4), write (2), and e
xecute (1); the second selects permissions for other users in the file's
group, with the same values; and the third for other users not in the f
ile's group, with the same values.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DirUmask <Int32>
The value of this field controls the file mode creation mask for the CIF
S share in qtrees with UNIX or Mixed security styles. The mask restricts
the initial permissions setting of a newly created directory. The input
value is a numeric mode comprising of one to three octal digits (0-7),
derived by adding up the bits with values 4, 2, and 1. The first digit s
elects permissions for the user who owns the file: read (4), write (2),
and execute (1); the second selects permissions for other users in the f
ile's group, with the same values; and the third for other users not in
the file's group, with the same values.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Comment <String>
This string gives a description of the CIFS share. CIFS clients see this
description when browsing the Vserver's CIFS shares.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-AttributeCacheTtl <Int32>
The lifetime of an entry in the file attribute cache, in seconds. This v
alue is used if the share has the 'attributecache' property set, which i
mproves the performance of certain metadata operations in common workloa
ds. The default is 10 seconds. Raising this value may improve performanc
e, but the likelihood that stale metadata will be served increases as we
ll. The value of this field must be in the range of 1 to 86400.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-VserverContext <String>
Vserver to which to direct this command. If the currently connected con
troller (as embodied by an NcController object) represents a cluster, th
ere are multiple means to address commands to one of its vservers. Eith
er set the Vserver field on the NcController object to direct all subseq
uent commands to that vserver, or supply the VserverContext parameter to
an individual cmdlet. Only cmdlets which may be invoked on vservers of
fer the VserverContext parameter.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Controller <NcController[]>
A Data ONTAP cluster-mode controller to receive this cmdlet, as embodied
by an NcController object. This parameter is returned by the Connect-N
cController cmdlet. If not specified, the value in the global variable
CurrentNcController is used. In the latter case, if CurrentNcController
contains a collection of NcController objects, this cmdlet is invoked o
n each controller in succession.
Required? false
Position? named
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
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
NOTES
Category: cifs
API: cifs-share-create
Family: vserver
-------------- Example 1 --------------
C:\PS>Add-NcCifsShare -Name cifsvol1 -Path /cifsvol1
Add a CIFS share called cifsvol1 which shares path /cifsvol1.
CifsServer ShareName Path
Comment
---------- --------- ----
-------
CIFS01 cifsvol1 /cifsvol1
RELATED LINKS
Set-NcCifsShare
Remove-NcCifsShare
Get-NcCifsShare
| Copyright © 2012 NetApp. All rights reserved. Use is subject to license terms. |
|
Data ONTAP® PowerShell Toolkit
|