Introduction to BitTitan SDK

Installing BitTitan SDK

The BitTitan SDK gives you access to the BitTitan Command Shell and Management Console, which you can use to automate or execute many MigrationWiz actions.

For guidance installing and using the SDK, see the following: 

Important: If you have previously installed the BitTitan SDK, you must uninstall previous versions before re-installing. Earlier versions of the SDK may be named "MigrationWiz PowerShell," or "BitTitan PowerShell."  If you need to keep the deprecated package to support legacy scripts, you can do so as it should not conflict with the new package.

  • Before installing the BitTitan SDK, make sure that you have installed the prerequisites:
    • Microsoft Windows Management Framework (WMF) 4.0 or later
    • Windows PowerShell 4.0 or later
    • Microsoft .NET Framework 4.6.2 or later

Download the PowerShell Setup File

Once the SDK is installed, you will see the BitTitan Command Shell and the BitTitan Management Console in the Start window.

 ​Notes:

  • The BitTitan SDK is updated periodically, so return to this page periodically to download and install the latest version. You can check your SDK version by going to Control Panel, then Programs and Features, then locate BitTitan PowerShell in the list of installed programs.
  • For guidance on using the BitTitan SDK to write automation scripts, see SDK Introduction.
  • The BitTitan PowerShell SDK has been implemented as a PowerShell module. PowerShell package management provides a seamless experience for installing and managing third-party binaries directly from the PowerShell console using a series of simple cmdlets.  Partners should find installing, upgrading, and interacting with the SDK as a PowerShell module quicker and easier than the tradition .msi package.
  • Supplemental information around PowerShell package management can be found in the MSDN article,  PackageManagement Cmdlets .
  • The TechNet article Introducing PackageManagement in Windows 10 provides additional information.

Package Management is available by default on Windows 10, and can be supported on all versions of both the client and server operating system down to Windows 7/Server 2008 R2, by installing the newest versions of the Windows Management Framework.

 

Accessing the BitTitan PowerShell Console

  1. Make sure the BitTitan PowerShell commandlets are installed on the PC you are using.
  2. Click on the Start Menu.
  3. Click on All Programs.
  4. Click on BitTitan.
  5. Click on BitTitan PowerShell.
  6. Right-click on BitTitan Command Shell.
  7. Click on Run as administrator.

How do I verify that I have PowerShell installed?

  1. Click on the  Start Menu .
  2. Click on  All Programs .​
  3. Click on  Accessories .
  4. Click on  Windows PowerShell .

    Note: If it is not listed under Accessories, you do not have PowerShell installed.

Check your PowerShell version:

  1. Within the Windows PowerShell console, type the following command and press  Enter .

    $Host.Version
  2. If the Major column shows 2, you have PowerShell v2.

Unrestrict PowerShell

In some cases, PowerShell may be restricted to only local commandlets and may not allow you to execute remote PowerShell commands.

To determine your current PowerShell restrictions:

  1. Make sure the PowerShell is installed on the PC you are using.
  2. Click on the Start Menu .
  3. Click on All Programs .
  4. Click on Accessories .
  5. Click on Windows PowerShell .
  6. Right-click on Windows PowerShell and select Run as administrator .
  7. Type the following command into the PowerShell window and press Enter :
    Get-ExecutionPolicy

 

To unrestrict PowerShell, perform the following:

  1. Make sure the PowerShell is installed on the PC you are using.
  2. Click the Start Menu .
  3. Click on All Programs .
  4. Click on Accessories .
  5. Click on Windows PowerShell .
  6. Right-click on Windows PowerShell and select Run as administrator
  7. Type the following command into the PowerShell window and press Enter :
    Set-ExecutionPolicy RemoteSigned

 

Sharing Projects with PowerShell

  • These are the steps for sharing projects through PowerShell using the BitTitan SDK
  • MigrationWiz supports the capability to share migration projects across a Workgroup. Migration projects are no longer tied to individual accounts, they are tied to Workgroups. When Workgroup Administrators turn on the Project Sharing feature, all Agents besides those who are Inactive are able to view all migrations projects. For more information, visit Project Sharing in MigrationWiz.

 

Prerequisites

 

Steps

In order to retrieve shared projects via the BitTitan SDK, a special ticket needs to be used. This is to ensure backward-compatibility with existing scripts that use regular tickets.
The following example shows how to obtain a ticket with the project sharing option set:
$mwTicketWithProjectSharing = Get-MW_Ticket -Credentials $credential -WorkgroupId $workgroupId -IncludeSharedProjects

  • WorkgroupId: ID of the workgroup that we're getting a ticket for
  • IncludeSharedProjects: Sets the project sharing option on the ticket

The ticket can then be used to retrieve shared projects. The following example shows how to retrieve shared projects, assuming we previously retrieved some customers:
$projects = Get-MW_MailboxConnector -Ticket $mwTicketWithProjectSharing -OrganizationId $customers.OrganizationId

 

Sample script

This sample script in our Github shows a full example of how to use project sharing in the SDK.

 

Notes

  • The ticket with project sharing option can only be used with the Get-MW_* cmdlets. It cannot be used with the Get-BT_* cmdlets
  • The option - IncludeSharedProjects requires the use of - WorkgroupId (it cannot be used independently). The workgroup ID should reference a workgroup that the agent has access to.

BitTitan PowerShell cmdlets 

Download the BitTitan PowerShell cmdlets here.

To use cmdlets:

 

 Managing Customers and Resources 

 

Troubleshooting

Check account access

Check PowerShell Version

Remove PowerShell Restrictions

Was this article helpful?
0 out of 0 found this helpful