This guide is designed to provide a quick reference for start using the Binary Tree PowerShell module. This guide assumes some familiarity with the Power365 platform.
The Binary Tree PowerShell module is a set of PowerShell commands that let you manage your Power365 data. Here are some common examples of operations you can perform with the Binary Tree PowerShell module:
Manage multiple clients, projects, profiles and more
Getting user status and statistics
Starting actions and monitoring progress
Creating and managing migration waves
Retrieving job history and downloading logs
PowerShell 5.1.
.Net 4.5.2 or above
An access token issued from an authorized client administrator
Only an authorized Client Administrator may manage API keys. To generate a new API key, follow these steps:
Log in to Power365
Select API KEYS from the Admin section of the top right menu
Click New to create a new key
Follow the prompts
Give the key a Name
Select a Role (Read, Write)
Select an Expiration date
Copy and save the key
It is best practice is to create a new key for each user to maintain an audit trail.
Please Note: The key is only available to copy during the key creation process. If that key copy is subsequently lost, it will be necessary to create a new key.
|
Install-Module BinaryTree.Power365 -Force |
|
Get-InstalledModule -Name BinaryTree.Power365 | FL |
To verify your installed version against the latest version in PSGallery run the following then compare the results.
|
# Get module version from PSGallery Get-Module BinaryTree.Power365 | select version # Get installed module version Get-InstalledModule BinaryTree.Power365 | select version |
In order to connect to Power365 using PowerShell, you will need an API key generated from within Power365. Once you have an API key then run the following:
|
$apiKey = "<API Key>" Connect-BTSession -ApiKey (ConvertTo-SecureString $apiKey -AsPlainText -Force) |
Help is only a command away. Each module has a help file to keep you updated on the latest cmdlets’ functions and properties.
|
# Get a list of Binary Tree cmdlets Get-Help *-BT* | select name, synopsis # Get list of installed cmdlets and their parameters Get-Command -Module BinaryTree.Power365 | select name, ParameterSets # Get detailed help from a single cmdlet Get-Help <command name> -Detailed |
This guide is designed to provide a quick reference for start using the Binary Tree PowerShell module. This guide assumes some familiarity with the Power365 platform.
The Binary Tree PowerShell module is a set of PowerShell commands that let you manage your Power365 data. Here are some common examples of operations you can perform with the Binary Tree PowerShell module:
Manage multiple clients, projects, profiles and more
Getting user status and statistics
Starting actions and monitoring progress
Creating and managing migration waves
Retrieving job history and downloading logs
PowerShell 5.1.
.Net 4.5.2 or above
An access token issued from an authorized client administrator
Only an authorized Client Administrator may manage API keys. To generate a new API key, follow these steps:
Log in to Power365
Select API KEYS from the Admin section of the top right menu
Click New to create a new key
Follow the prompts
Give the key a Name
Select a Role (Read, Write)
Select an Expiration date
Copy and save the key
It is best practice is to create a new key for each user to maintain an audit trail.
Please Note: The key is only available to copy during the key creation process. If that key copy is subsequently lost, it will be necessary to create a new key.
|
Install-Module BinaryTree.Power365 -Force |
|
Get-InstalledModule -Name BinaryTree.Power365 | FL |
To verify your installed version against the latest version in PSGallery run the following then compare the results.
|
# Get module version from PSGallery Get-Module BinaryTree.Power365 | select version # Get installed module version Get-InstalledModule BinaryTree.Power365 | select version |
In order to connect to Power365 using PowerShell, you will need an API key generated from within Power365. Once you have an API key then run the following:
|
$apiKey = "<API Key>" Connect-BTSession -ApiKey (ConvertTo-SecureString $apiKey -AsPlainText -Force) |
Help is only a command away. Each module has a help file to keep you updated on the latest cmdlets’ functions and properties.
|
# Get a list of Binary Tree cmdlets Get-Help *-BT* | select name, synopsis # Get list of installed cmdlets and their parameters Get-Command -Module BinaryTree.Power365 | select name, ParameterSets # Get detailed help from a single cmdlet Get-Help <command name> -Detailed |
This guide is designed to provide a quick reference for start using the Binary Tree PowerShell module. This guide assumes some familiarity with the Power365 platform.
The Binary Tree PowerShell module is a set of PowerShell commands that let you manage your Power365 data. Here are some common examples of operations you can perform with the Binary Tree PowerShell module:
Manage multiple clients, projects, profiles and more
Getting user status and statistics
Starting actions and monitoring progress
Creating and managing migration waves
Retrieving job history and downloading logs
PowerShell 5.1.
.Net 4.5.2 or above
An access token issued from an authorized client administrator
Only an authorized Client Administrator may manage API keys. To generate a new API key, follow these steps:
Log in to Power365
Select API KEYS from the Admin section of the top right menu
Click New to create a new key
Follow the prompts
Give the key a Name
Select a Role (Read, Write)
Select an Expiration date
Copy and save the key
It is best practice is to create a new key for each user to maintain an audit trail.
Please Note: The key is only available to copy during the key creation process. If that key copy is subsequently lost, it will be necessary to create a new key.
|
Install-Module BinaryTree.Power365 -Force |
|
Get-InstalledModule -Name BinaryTree.Power365 | FL |
To verify your installed version against the latest version in PSGallery run the following then compare the results.
|
# Get module version from PSGallery Get-Module BinaryTree.Power365 | select version # Get installed module version Get-InstalledModule BinaryTree.Power365 | select version |
In order to connect to Power365 using PowerShell, you will need an API key generated from within Power365. Once you have an API key then run the following:
|
$apiKey = "<API Key>" Connect-BTSession -ApiKey (ConvertTo-SecureString $apiKey -AsPlainText -Force) |
Help is only a command away. Each module has a help file to keep you updated on the latest cmdlets’ functions and properties.
|
# Get a list of Binary Tree cmdlets Get-Help *-BT* | select name, synopsis # Get list of installed cmdlets and their parameters Get-Command -Module BinaryTree.Power365 | select name, ParameterSets # Get detailed help from a single cmdlet Get-Help <command name> -Detailed |
This guide is designed to provide a quick reference for start using the Binary Tree PowerShell module. This guide assumes some familiarity with the Power365 platform.
The Binary Tree PowerShell module is a set of PowerShell commands that let you manage your Power365 data. Here are some common examples of operations you can perform with the Binary Tree PowerShell module:
Manage multiple clients, projects, profiles and more
Getting user status and statistics
Starting actions and monitoring progress
Creating and managing migration waves
Retrieving job history and downloading logs
PowerShell 5.1.
.Net 4.5.2 or above
An access token issued from an authorized client administrator
Only an authorized Client Administrator may manage API keys. To generate a new API key, follow these steps:
Log in to Power365
Select API KEYS from the Admin section of the top right menu
Click New to create a new key
Follow the prompts
Give the key a Name
Select a Role (Read, Write)
Select an Expiration date
Copy and save the key
It is best practice is to create a new key for each user to maintain an audit trail.
Please Note: The key is only available to copy during the key creation process. If that key copy is subsequently lost, it will be necessary to create a new key.
|
Install-Module BinaryTree.Power365 -Force |
|
Get-InstalledModule -Name BinaryTree.Power365 | FL |
To verify your installed version against the latest version in PSGallery run the following then compare the results.
|
# Get module version from PSGallery Get-Module BinaryTree.Power365 | select version # Get installed module version Get-InstalledModule BinaryTree.Power365 | select version |
In order to connect to Power365 using PowerShell, you will need an API key generated from within Power365. Once you have an API key then run the following:
|
$apiKey = "<API Key>" Connect-BTSession -ApiKey (ConvertTo-SecureString $apiKey -AsPlainText -Force) |
Help is only a command away. Each module has a help file to keep you updated on the latest cmdlets’ functions and properties.
|
# Get a list of Binary Tree cmdlets Get-Help *-BT* | select name, synopsis # Get list of installed cmdlets and their parameters Get-Command -Module BinaryTree.Power365 | select name, ParameterSets # Get detailed help from a single cmdlet Get-Help <command name> -Detailed |
© 2024 Quest Software Inc. ALL RIGHTS RESERVED. Feedback Terms of Use Privacy Cookie Preference Center
