Object

Synopsis

Download a file from NetStorage.

Syntax

Read-NetstorageObject [-RemotePath] <String> [-LocalPath <String>] [-AuthFile <String>] [-Section <String>]
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Downloads a NetStorage file from its remote path to a local path on your local machine.

Note: You don't need to prepend paths with the upload directory CP code, this is implied.

Parameters

-AuthFile

Location of your NetStorage auth file. Defaults to ~/.nsrc, but environment variables will take precedence.

Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-LocalPath

The location on disk of the file you wish to upload.

Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-RemotePath

The remote location you wish to upload your file to. The upload directory prefix is not required.

Type: String
Parameter Sets: (All)
Aliases: None
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Section

EdgeRC section to retrieve authentication credentials from. Defaults to default.

Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None

Outputs

System.Object