Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: Get-NcCifsSessionFile


NAME
Get-NcCifsSessionFile

SYNOPSIS
Retrieve the list of the opened CIFS files.

SYNTAX
Get-NcCifsSessionFile [[-FileId] <String[]>] [[-SessionId] <String[]>] [[-Co
nnectionId] <String[]>] [[-Node] <String[]>] [[-Vserver] <String[]>] [-Attri
butes <CifsSessionFile>] [-VserverContext <String>] [-Controller <NcControll
er[]>] [<CommonParameters>]

Get-NcCifsSessionFile -Template [-VserverContext <String>] [-Controller <NcC
ontroller[]>] [<CommonParameters>]

Get-NcCifsSessionFile -Query <CifsSessionFile> [-Attributes <CifsSessionFile
>] [-VserverContext <String>] [-Controller <NcController[]>] [<CommonParamet
ers>]


DESCRIPTION
Retrieve the list of the opened CIFS files.


PARAMETERS
-FileId <String[]>
One or more unique identifiers for opened files. Data ONTAP wildcards a
re permitted.

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

-SessionId <String[]>
One or more unique identifiers for the session. Data ONTAP wildcards ar
e permitted.

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

-ConnectionId <String[]>
One or more unique identifiers for the connection. Data ONTAP wildcards
are permitted.

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

-Node <String[]>
The name of one or more nodes on which the session listing is done. Dat
a ONTAP wildcards are permitted.

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

-Vserver <String[]>
Restrict the results to one or more Vservers. Data ONTAP wildcards are
permitted.

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

-Attributes <CifsSessionFile>
For improved scalability in large clusters, provide a CifsSessionFile ob
ject with various fields set to indicate which fields to return on all o
bjects. Undesired fields should remain set to null. Use "Get-NcCifsSes
sionFile -Template" to get the initially empty CifsSessionFile 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

-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 clustered Data ONTAP controller to receive this cmdlet, as embodied by
an NcController object. This parameter is returned by the Connect-NcCo
ntroller cmdlet. If not specified, the value in the global variable Cur
rentNcController is used. In the latter case, if CurrentNcController co
ntains a collection of NcController objects, this cmdlet is invoked on e
ach 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 CifsSessionFile object for use with advanced que
ries involving the Query attribute.

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

-Query <CifsSessionFile>
For advanced queries, provide a CifsSessionFile object with various fiel
ds set to indicate which records to retrieve. Other fields should remai
n set to null. Use "Get-NcCifsSessionFile -Template" to get the initial
ly empty CifsSessionFile 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
DataONTAP.C.Types.Cifs.CifsSessionFile


NOTES


Category: cifs
API: cifs-session-file-get-iter
Family: cluster, vserver

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

C:\PS>Get-NcCifsSessionFile


Get all CIFS session files for the current cluster.


ConnectionId : 363597761
ContinuouslyAvailable : yes
FileId : 7
FileType : regular
HostingAggregate : aggr_2
HostingVolume : vsMMSvmstore
NcController : 10.58.95.206
Node : Varuna-01
OpenMode : rw
Path : APP08\Virtual Machines\43020A08-3FB3-433C-B91B-33341
74D72AF.xml
RangeLocks : 0
Reconnected : Yes
SessionId : 1
Share : DS2
ShareMode : rw
Vserver : vsMMS
ConnectionIdSpecified : True
FileIdSpecified : True
RangeLocksSpecified : True
SessionIdSpecified : True


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

C:\PS>$q = Get-NcCifsSessionFile -Template
$q.ConnectionId = 248115473
Get-NcCifsSessionFile -Query $q


Get all the files for a certain CIFS connection.


Path
ConnectionId Vserver
----
------------ -------
Virtual Machines\C4A8A66A-169C-41D9-9990-01A9F6A2167D.xml
248115473 no_odx



RELATED LINKS
Get-NcCifsSession







 Data ONTAP® PowerShell Toolkit