Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: Get-NcCifsShare


NAME
Get-NcCifsShare

SYNOPSIS
Get a list of CIFS shares.

SYNTAX
Get-NcCifsShare [[-Name] <String[]>] [[-CifsServer] <String[]>] [-VserverCon
text <String>] [-Attributes <CifsShare>] [-Controller <NcController[]>] [<Co
mmonParameters>]

Get-NcCifsShare [-VserverContext <String>] -Template [-Controller <NcControl
ler[]>] [<CommonParameters>]

Get-NcCifsShare [-VserverContext <String>] -Query <CifsShare> [-Attributes <
CifsShare>] [-Controller <NcController[]>] [<CommonParameters>]


DESCRIPTION
Get a list of CIFS shares.


PARAMETERS
-Name <String[]>
The name of one or more CIFS shares to get. Data ONTAP wildcards are pe
rmitted.

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

-CifsServer <String[]>
Restrict results to the specified CIFS server(s). Data ONTAP wildcards
are permitted.

Required? false
Position? 2
Default value
Accept pipeline input? true (ByPropertyName)
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

-Attributes <CifsShare>
For improved scalability in large clusters, provide a CifsShare object w
ith various fields set to indicate which fields to return on all objects
. Undesired fields should remain set to null. Use "Get-NcCifsShare -Te
mplate" to get the initially empty CifsShare object. If not specified,
all data is returned for each object.

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

-Template
Specify to get an empty CifsShare object for use with advanced queries i
nvolving the Query attribute.

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

-Query <CifsShare>
For advanced queries, provide a CifsShare object with various fields set
to indicate which records to retrieve. Other fields should remain set
to null. Use "Get-NcCifsShare -Template" to get the initially empty Cif
sShare object.

Required? true
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
NetApp.Ontapi.Filer.C.Cifs810.CifsShare


NOTES


Category: cifs
API: cifs-share-get-iter
Family: cluster, vserver

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

C:\PS>Get-NcCifsShare


Get all of the CIFS shares on the current cluster or vserver.


CifsServer ShareName Path
Comment
---------- --------- ----
-------
CIFS01 admin$ /
CIFS01 cifsvol1 /cifsvol1
CIFS01 ipc$ /


-------------- Example 2 --------------

C:\PS>$query = Get-NcCifsShare -Template
$query.ShareProperties = "browsable"
Get-NcCifsShare -Query $query


Get all the CIFS shares with the "browsable" share property.


CifsServer : CIFS01
ShareName : admin$
Acl :
AttributeCacheTtl :
Comment :
DirUmask :
FileUmask :
Path : /
ShareProperties : {browsable}
SymlinkProperties :
AttributeCacheTtlSpecified : False
DirUmaskSpecified : False
FileUmaskSpecified : False

CifsServer : CIFS01
ShareName : cifsvol1
Acl : {Everyone / Full Control, Users / Read}
AttributeCacheTtl :
Comment :
DirUmask :
FileUmask :
Path : /cifsvol1
ShareProperties : {oplocks, browsable, changenotify}
SymlinkProperties :
AttributeCacheTtlSpecified : False
DirUmaskSpecified : False
FileUmaskSpecified : False

CifsServer : CIFS01
ShareName : ipc$
Acl :
AttributeCacheTtl :
Comment :
DirUmask :
FileUmask :
Path : /
ShareProperties : {browsable}
SymlinkProperties :
AttributeCacheTtlSpecified : False
DirUmaskSpecified : False
FileUmaskSpecified : False



RELATED LINKS
Add-NcCifsShare
Remove-NcCifsShare
Set-NcCifsShare







 Data ONTAP® PowerShell Toolkit