Logo

Documentation home for Transend tools

  • Build-ArtifactArchive
  • Build-ExceptionReport
  • Build-FolderReport
  • Build-Report
  • Compress-Folders
  • Expand-ArtifactArchive
  • Find-UserListErrors
  • Format-Csv
  • Initialize-ToolsDirectory
  • Mount-ToolsDirectory
  • New-SampleFiles
  • Remove-EmptyFolders
  • Select-Pattern
  • Show-Config

    • Home

    Build-ArtifactArchive

    SYNOPSIS

    Builds an archive of migration artifacts.

    SYNTAX

    Build-ArtifactArchive [[-Type] <String>] [[-MigrationReportFolder] <String>] [[-Include] <String[]>]
 [-SkipCleanup] [<CommonParameters>]

    DESCRIPTION

    Use the Build-ArtifactArchive cmdlet to build a zip archive of artifacts from a migration instance.

    EXAMPLES

    Example 1: Collect customer artifacts

    Build-ArtifactArchive -Type Customer

    Builds a zip archive of customer artifacts.

    Example 2: Collect Transend artifacts

    Build-ArtifactArchive -Type Transend

    Builds a zip archive of Transend artifacts. In this example, migration reports must reside in $env:USERPROFILE\Downloads because the -MigrationReportFolder option was not provided.

    Example 3: Collect Tools artifacts only

    Build-ArtifactArchive -Type ToolsOnly

    Builds a zip archive of tools-only Transend artifacts.

    Example 4: Collect drive artifacts

    Build-ArtifactArchive -Type Drives -Include @('user1@example.org', 'user2@example.org')

    Builds a zip archive of drive artifacts for users user1@example.org and user2@example.org.

    PARAMETERS

    -Include

    Specifies a list of drive artifacts to collect when -Type Drives is used.

    Type: String[]
Parameter Sets: (All)
Aliases:

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

    -MigrationReportFolder

    Specifies the path to a folder containing one or more migration reports. Migration reports must following the naming convention of Migration Report*.csv. These names are valid:

    • Migration Report for Project.csv
    • Migration Report for Project 1.csv
    • Migration Report for Transend Corporation.csv

    These names are not valid:

    • Migration 1.csv
    • Transend Corporation.csv
    Type: String
Parameter Sets: (All)
Aliases:

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

    -SkipCleanup

    Intermediate artifacts are removed by default. Use -SkipCleanup to preserve them. This is useful for troubleshooting purposes.

    Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

    -Type

    Determines the type of artifacts to collect in the archive.

    Type: String
Parameter Sets: (All)
Aliases:
Accepted values: Customer, Drives, Transend, ToolsOnly

Required: False
Position: 0
Default value: Transend
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