Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: Read-NcDirectory


NAME
Read-NcDirectory

SYNOPSIS
List the contents of a directory.

SYNTAX
Read-NcDirectory [-Path] <String> [-Attributes <FileInfo>] [-VserverContext
<String>] [-Controller <NcController[]>] [<CommonParameters>]

Read-NcDirectory -Template [-VserverContext <String>] [-Controller <NcContro
ller[]>] [<CommonParameters>]


DESCRIPTION
List the contents of a directory.


PARAMETERS
-Path <String>
The path of the directory to query.

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

-Attributes <FileInfo>
For improved scalability in large clusters, provide a FileInfo object wi
th various fields set to indicate which fields to return on all objects.
Undesired fields should remain set to null. Use "Read-NcDirectory -Te
mplate" to get the initially empty FileInfo object. If not specified, a
ll 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 FileInfo object for use with advanced queries in
volving the Attributes parameter.

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.File.FileInfo


NOTES


Category: file
API: file-list-directory-iter
Family: vserver

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

C:\PS>Read-NcDirectory /vol/vol1


List the contents of volume 'vol1'.


Name Type Size Created Modified Owner Group Perm Empty
---- ---- ---- ------- -------- ----- ----- ---- -----
. directory 4 KB 11/14/2011 11/14/2011 0 1 700 False
.. directory 4 KB 10/3/2011 11/14/2011 0 1 777 False
.snapshot directory 4 KB 11/14/2011 11/14/2011 0 0 777 False
hosts file 0 11/14/2011 11/14/2011 0 0 644
users directory 4 KB 11/14/2011 11/14/2011 0 0 755 False



RELATED LINKS
New-NcDirectory
Remove-NcDirectory
Read-NcFile







 Data ONTAP® PowerShell Toolkit