Guide

Directory

Read-NetstorageDirectory

Suggest Edits

Synopsis

Download a directory from NetStorage.

Syntax

Read-NetstorageDirectory [-Path] <String> [-Prefix <String>] -OutputDirectory <String> [-StartPath <String>] [-EndPath <String>] [-MaxEntries <Int32>] [-Encoding <String>] [-SlashBoth] [-AuthFile <String>] [-Section <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Read-NetstorageDirectory [-Path] <String> [-Recurse] -OutputDirectory <String> [-StartPath <String>] [-EndPath <String>] [-MaxEntries <Int32>] [-Encoding <String>] [-SlashBoth] [-AuthFile <String>] [-Section <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Downloads all files found in a given NetStorage path, either with a single top-level directory or recursively into all child folders. NetStorage folder structure is replicated locally.

Parameters

‑AuthFile
String Pipeline input: False

A location of your NetStorage auth file. Defaults to ~/.nsrc, but environment variables will take precedence.
‑Encoding
String Pipeline input: False

A specific encoding to use when requesting a response, for example, utf-8.
‑EndPath
String Pipeline input: False

A complete path to the last object to return in the list response. All other objects that exist after the noted path are left out of the response.

The zero 0 character exists in place of the trailing slash to accommodate NetStorage directory logic. As a result, the list will display everything up to, and including the last object in the path and possibly a path named [path]0 if one exists.
‑MaxEntries
Int Pipeline input: False

A limit on the number of entries returned.
‑OutputDirectory
Required
String Pipeline input: False

The path to the directory in which to place the new .nsrc file. Defaults to ~/.nsrc.
‑Path
Required
String Pipeline input: False

A path of your directory within the NetStorage group.
‑Prefix
String Parameter sets: dir Pipeline input: False

Lists files whose names begin with the specified prefix.
‑Recurse
Switch Parameter sets: list Pipeline input: False

Uses the list action instead of dir and recurses into child directories.
‑Section
String Pipeline input: False

The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to default.
‑SlashBoth
Switch Pipeline input: False

Sets an additional slash option to both.
‑StartPath
String Pipeline input: False

The first file in the directory whose name is greater than or equal to this value. This value is appended to the prefix if that field is also included.

Related Links

Updated 11 days ago