|
|
 Data ONTAP® PowerShell Toolkit
|
Cmdlet: Read-NcFile
NAME
Read-NcFile
SYNOPSIS
Read data from a named file.
SYNTAX
Read-NcFile [-Path] <String> [-Raw] [-VserverContext <String>] [-Controller
<NcController[]>] [<CommonParameters>]
Read-NcFile [-Path] <String> [-Raw] [-VserverContext <String>] [-Controller
<NcController[]>] -Length <Int32> -Offset <Int64> [<CommonParameters>]
DESCRIPTION
Read data from a named file. This cmdlet is limited to transfers of 1 MB an
d should only be used on normal files. The results for other file types suc
h as LUNs is undefined.
PARAMETERS
-Path <String>
The path of the file to read.
Required? true
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Raw
Specify to get a byte array instead of the default ASCII interpretation.
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
-Length <Int32>
Number of bytes to read.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Offset <Int64>
Offset into file at which to start reading.
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
System.String
NOTES
Category: file
API: file-read-file
Family: vserver
-------------- Example 1 --------------
C:\PS>Read-NcFile /vol/vol1/hosts
Read a file 'hosts' that contains host info.
10.61.161.206 xyratex02.rtprre.testdomain xyratex02
10.61.167.148 x3550rre8.rtprre.testdomain x3550rre8
RELATED LINKS
Get-NcFile
Read-NcDirectory
Write-NcFile
| Copyright © 2012 NetApp. All rights reserved. Use is subject to license terms. |
|
Data ONTAP® PowerShell Toolkit
|