In this blog post, we will teach you all you need to know, about connecting the BitTitan PowerShell to your BitTitan account. That is obviously the first step you need to do, before running your BitTitan scripts and automation.
When you install and open our BitTitan PowerShell module, it’s default actions would be to send requests to our BitTitan.com platform, but although many of our customers don’t know, we also have dedicated BitTitan SaaS platforms in Germany and China.
To be able to change the environment you’re connecting to, you’ll have to leverage two cmdlets:
- Set-MW_Environment – this changes the MigrationWiz environment and will cover any *-MW* cmdlets, corresponding to the migrationwiz.bittitan* website.
- Set-BT_Environment – this changes the BitTitan environment and will cover any *-BT* cmdlets, corresponding to the manage.bittitan.* website.
You might need to use one or both of the cmdlets above, depending on the tasks you want to accomplish.
Common “*-MW*” tasks will include starting MigrationWiz migrations with the Add-MW_MailboxMigration cmdlet, or creating a MigrationWiz project with the Add-MW_MailboxConnector cmdlet, among many others.
Common “*-BT*” tasks will include listing your customers with the Get-BT_Customer cmdlet, or scheduling a DeploymentPro user with the Start-BT_DpUser cmdlet, among many others.
Although in out BitTitan cmdlet refererence page you will see many environments that can be set, the relevant externally available are the ones listed below, that apply for both BT and MW cmdlets:
Based on the above, to change your PowerShell environment to Germany, after you open our PowerShell module, you would run the following:
Set-BT_Environment -Environment Germany
Set-MW_Environment -Environment Germany
Note that you can and should include those lines in your scripting, if it’s to run it consistently in those environments. Also, you can’t run commands in two different environments for MW or BT, in the same session. You would have to switch environments and to switch back to our .com platform, use the value BT.
The concept of ticket and how to create it
Once you ramp up your skills in our SDK, you’ll quickly learn that you can’t do anything with it without a ticket.
So what is a ticket?
A ticket in the BitTitan PowerShell module is an authentication token with several parameters, that you use each time you execute an action. The main parameters of the ticket are:
- WorkgroupID – You can create a ticket specifically to a BitTitan Workgroup
- IncludeSharedProjects – When set to true this is the parameter that allows you to see all projects and not just the ones you created. This parameter is exclusive for MW tickets
- ExpirationDate – When the ticket expires. Tickets are by default valid for 1 week
How do I create a ticket?
You need to create 1 ticket specific for MW actions and 1 for BT actions, using the following cmdlets:
$MWTicket = Get-MW_Ticket -Credentials (Get-Credential)
$BTTicket = Get-BT_Ticket -Credentials (Get-Credential)
You can then leverage those tickets each time you run a cmdlet, for example:
Get-MW_Mailbox -Ticket $MWTicket
Get-BT_Workgroup -Ticket $BTTicket
Create a MigrationWiz ticket with project sharing
MigrationWiz enables collaboration. What that means is that either via the UI or PowerShell you can access and manage all objects within a workgroup, regardless if you created them or not.
Project sharing can be enabled or disabled. In the UI you have a checkbox for that, but with PowerShell what determines if you’re using project sharing is the way you create your ticket. We highly recommend that you use project sharing at all times, so now that you understand what a ticket is and how to create it, lets look at how to do it with the sharing enabled.
To create a ticket with project sharing you need to add 2 parameters to the cmdlet:
And here’s the completed command:
$MWTicket = Get-MW_Ticket -Credentials (Get-Credential) -WorkgroupId [yourworkgroupid] -IncludeSharedProjects
You can obtain your workgroup id either by running the Get-BT-Workgroup cmdlet or by copying it from the URL in your browser, when you’re inside the workgroup.
BT tickets do not need project sharing, it only applies to MW tickets.
The bottom line
Hopefully the information above will help you understand in more detail how to connect and authenticate to the BitTitan systems, via the SDK, and all the options you have to incorporate in your scripts.