Logo

Documentation home for Transend tools

Show-WINUserDrive

SYNOPSIS

Shows a user drive in a Windows filesystem.

SYNTAX

Action (Default)

Show-WINUserDrive -SourceId <String> [-SourceFolder <String>] [-IncludePattern <String>] [-NoCache]
 [-Verbosity <String>] [<CommonParameters>]

Help

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

DESCRIPTION

Use the Show-WINUserDrive cmdlet to show a user drive in a Windows filesystem.

See the Examples section for cmdlet requirements.

EXAMPLES

Example 1: Show entire Windows filesystem drive

Description

This example shows a Windows filesystem drive.

Tenant configuration

No tenant configuration is required.

TMCTools

@{
  Source = @{}
}

Show-WINUserDrive -SourceId 'C:\Drives\user@source.org'

Example 2: Show folder in Windows filesystem drive

Description

This example shows a named folder in a Windows filesystem drive.

Additional parameters change the basic functionality shown in Example 1:

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

Tenant configuration

No tenant configuration is required.

TMCTools

@{
  Source = @{}
}

Show-WINUserDrive -SourceFolder 'Migration'

PARAMETERS

-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

-NoCache

Refresh tokens obtained from a prior authentication will be used by default. If you are running different tools that require different permissions or want to log in as a different user, use the -NoCache option to bypass an existing refresh token.

Type: SwitchParameter
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.

Type: String
Parameter Sets: Action
Aliases:

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

-SourceId

The full path to a local drive. For example, C:\Drives\user@source.org.

Type: String
Parameter Sets: Action
Aliases:

Required: True
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