Directory

Get-NetstorageDirectory

Synopsis

Get a directory.

Syntax

dir (Default)

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

list

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

Description

Gets a NetStorage directory, either with an optional -Prefix (dir) or recursively with -Recurse (list).

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

-Encoding

Request the response in a specific encoding, for example, utf-8.

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

-EndPath

Include 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.

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

-MaxEntries

Set a limit on the number of entries returned.

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

-Path

Path of your directory within the NetStorage group.

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

-Prefix

Only list files whose names begins with the specified prefix.

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

-Recurse

Use the list action instead of dir and recurse into child directories.

Type: SwitchParameter
Parameter Sets: list
Aliases: None
Required: False
Position: Named
Default value: False
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

-SlashBoth

Sets the slash additional option to both.

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

-StartPath

Start with 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.

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