Logo

Documentation home for Transend tools

Show-WINUserDrives

SYNOPSIS

Shows user drives in a Windows filesystem.

SYNTAX

Help (Default)

Show-WINUserDrives [-ShowPrereqs] [<CommonParameters>]

Action

Show-WINUserDrives -Csv <String> [-SourceFolder <String>] [-IncludePattern <String>] [-Verbosity <String>]
 [<CommonParameters>]

DESCRIPTION

Use the Show-WINUserDrives cmdlet to show user drives in a Windows filesystem.

See the Examples section for cmdlet requirements.

EXAMPLES

Example 1: Show entire Windows filesystem drives

Description

This example shows Windows filesystem drives listed in user_drives.csv.

Tenant configuration

Tenant Direction APIs Scopes
Windows filesystem Source N/A N/A

CSV format

SourceId
C:\Drives\user@source.org

TMCTools

@{
  Source = @{}
}

Show-WINUserDrives -Csv 'user_drives.csv'

Example 2: Show folders in Windows filesystem drives

Description

This example shows a named folder in Windows filesystem drives listed in user_drives.csv.

Additional parameters change the basic functionality shown in Example 1:

  • Using -SourceFolder restricts the operation to the Migration folder.

Tenant configuration

Tenant Direction APIs Scopes
Windows filesystem Source N/A N/A

CSV format

SourceId
C:\Drives\user@source.org

TMCTools

@{
  Source = @{}
}

Show-WINUserDrives -Csv 'user_drives.csv' -SourceFolder 'Migration'

PARAMETERS

-Csv

The path to a CSV file containing drives to process. See the examples for the required CSV format.

Type: String
Parameter Sets: Action
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-IncludePattern

A matching pattern to determine which folders and files to include. See https://rclone.org/filtering/ for syntax details.

Type: String
Parameter Sets: Action
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ShowPrereqs

Prints the cmdlet prerequisites.

Type: SwitchParameter
Parameter Sets: Help
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-SourceFolder

Restrict the source-side listing to the specified folder.

Note that this parameter is a global option that applies to all drives listed in the CSV file.

This parameter has no effect if the SourceFolder CSV field is set.

Type: String
Parameter Sets: Action
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Verbosity

The amount of detail logged during processing.

Type: String
Parameter Sets: Action
Aliases:
Accepted values: None, Normal, Detailed, Diagnostic

Required: False
Position: Named
Default value: Detailed
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.Void

NOTES

TMCTools configuration options