Chat now with support
Chat with Support

Welcome, erwin customers to Quest Support Portal click here for for frequently asked questions regarding servicing your supported assets.

Binary Tree Power365 Current - PowerShell for Power365 Quick Start Guide

Table of Contents

Introduction

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.

What is the Binary Tree PowerShell Module?

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  

What is required to run the Binary Tree PowerShell module?

  1. PowerShell 5.1.

  2. .Net 4.5.2 or above

  3. An access token issued from an authorized client administrator

Where do I get an access key?

Only an authorized Client Administrator may manage API keys. To generate a new API key, follow these steps:

  1. Log in to Power365

  2. Select API KEYS from the Admin section of the top right menu

  3. Click New to create a new key

  4. Follow the prompts

  5. Give the key a Name

  6. Select a Role (Read, Write)

  7. Select an Expiration date

  8. 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.

How do I install the module?

Install-Module BinaryTree.Power365 -Force

How can I verify the module?

Get-InstalledModule -Name BinaryTree.Power365 | FL

How can I verify the latest version?

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

How do I connect?

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)

Where can I find help?

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

 

Introduction

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.

What is the Binary Tree PowerShell Module?

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  

What is required to run the Binary Tree PowerShell module?

  1. PowerShell 5.1.

  2. .Net 4.5.2 or above

  3. An access token issued from an authorized client administrator

Where do I get an access key?

Only an authorized Client Administrator may manage API keys. To generate a new API key, follow these steps:

  1. Log in to Power365

  2. Select API KEYS from the Admin section of the top right menu

  3. Click New to create a new key

  4. Follow the prompts

  5. Give the key a Name

  6. Select a Role (Read, Write)

  7. Select an Expiration date

  8. 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.

How do I install the module?

Install-Module BinaryTree.Power365 -Force

How can I verify the module?

Get-InstalledModule -Name BinaryTree.Power365 | FL

How can I verify the latest version?

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

How do I connect?

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)

Where can I find help?

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

 

What is the Binary Tree PowerShell Module?

Introduction

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  

What is required to run the Binary Tree PowerShell module?

  1. PowerShell 5.1.

  2. .Net 4.5.2 or above

  3. An access token issued from an authorized client administrator

Where do I get an access key?

Only an authorized Client Administrator may manage API keys. To generate a new API key, follow these steps:

  1. Log in to Power365

  2. Select API KEYS from the Admin section of the top right menu

  3. Click New to create a new key

  4. Follow the prompts

  5. Give the key a Name

  6. Select a Role (Read, Write)

  7. Select an Expiration date

  8. 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.

How do I install the module?

Install-Module BinaryTree.Power365 -Force

How can I verify the module?

Get-InstalledModule -Name BinaryTree.Power365 | FL

How can I verify the latest version?

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

How do I connect?

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)

Where can I find help?

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

 

What is required to run the Binary Tree PowerShell module?

Introduction

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.

What is the Binary Tree PowerShell Module?

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  

  1. PowerShell 5.1.

  2. .Net 4.5.2 or above

  3. An access token issued from an authorized client administrator

Where do I get an access key?

Only an authorized Client Administrator may manage API keys. To generate a new API key, follow these steps:

  1. Log in to Power365

  2. Select API KEYS from the Admin section of the top right menu

  3. Click New to create a new key

  4. Follow the prompts

  5. Give the key a Name

  6. Select a Role (Read, Write)

  7. Select an Expiration date

  8. 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.

How do I install the module?

Install-Module BinaryTree.Power365 -Force

How can I verify the module?

Get-InstalledModule -Name BinaryTree.Power365 | FL

How can I verify the latest version?

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

How do I connect?

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)

Where can I find help?

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

 

Self Service Tools
Knowledge Base
Notifications & Alerts
Product Support
Software Downloads
Technical Documentation
User Forums
Video Tutorials
RSS Feed
Contact Us
Licensing Assistance
Technical Support
View All
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating