Installing the PowerShell module

Migrate for Compute Engine allows you to script actions from PowerShell using commands from a custom module. This document covers installing and using the built-in help within the PowerShell module.

Module Installation

  1. Download the Migrate for Compute Engine PowerShell module installer from the Downloads page, or open your Migrate for Compute Engine Manager and click the PowerShell module download icon on the home page.
  2. Run the installation file and follow the wizard's directions. You must accept the Velostrata End User Service Agreement and choose an installation location.

  3. The following PowerShell modules are installed:

    • Velostrata.PowerShell
    • Velostrata.Runbook
  4. You can now connect to Migrate for Compute Engine Manager by using:

PS C:\Users\Demo> Import-Module Velostrata.PowerShell
PS C:\Users\Demo> Connect-VelostrataManager

The script prompts you for the IP of your Migrate for Compute Engine Manager. When prompted for your user name, use apiuser. The password is the one you set when creating your Migrate for Compute Engine Manager.

Getting help from PowerShell

The PowerShell module provides help via the Get-Help command.

PS C:\Users\Demo> Get-help Connect-VelostrataManager


    This cmdlet establishes a connection to a Velostrata Manager Server

    Connect-VelostrataManager [-Server] <String> [-Username] <String>
[-Password] <SecureString> [-Port [<Int32>]]

    Connect-VelostrataManager [-Server] <String> [-Port <Int32>] [-Username]
<String> [-Password] <SecureString>  [<CommonParameters>]

    The cmdlet starts a new session or re-establishes a previous session with
Velostrata Manager Server using the specified parameters.
    When you attempt to connect to a server, the server checks for valid
credentials and then sets the relevant PSVariables.
    Once the user is authenticated successfully, the session remains in effect
until the PowerShell session is closed or a new Migrate for Compute Engine Manager session is established.
    Note: You can have only one active connection to a Migrate for Compute Engine Manager server
per PowerShell local session.

    To see the examples, type: "get-help Connect-VelostrataManager -examples".
    For more information, type: "get-help Connect-VelostrataManager -detailed".
    For technical information, type: "get-help Connect-VelostrataManager -full".
    For online help, type: "get-help Connect-VelostrataManager -online"