HostPilot PowerShell is the command-line interface through which you can manage the HostPilot. It allows you to execute commands and scripts on groups of mailboxes and other HostPilot objects and services on the account.

How to use

  1. Download the HostPilot PowerShell zip file to Documents (My Documents) folder and extract it to the following directory:
    Documents/HostPilot.PowerShell (My Documents/HostPilot.PowerShell)
    https://exchange.intermedia.net/customization/downloads/platform/HostPilot.PowerShell.zip
  2. Start application.
    Note: Windows PowerShell execution policy should be set to AllSigned or Unrestricted, otherwise application will fail to load.
    To set the policy open Windows PowerShell and run:
    Set-ExecutionPolicy AllSigned
    For more information on execution policies see this Microsoft article: https://technet.microsoft.com/library/ee176961.aspx
  3. When asked for Credential type (Administrator or User):
    • Enter User (U) if you are listed as an Account Contact on one account
    • Enter Administrator (A) if you are listed as an Account Contact on several accounts

      Admin/User

  4. Enter your Account Contact credentials.

    HostPilot PowerShell login
    Note: if the login fails, make sure you are using correct username and password.
  5. If you logged in as User HostPilot Powershell will prompt you to enter your Account ID.

    Account ID
  6. HostPilot PowerShell is ready to use.

    HostPilot PowerShell window
  7. If you logged in Administrator, set HostPilot PowerShell to run commands on a particular account with this command:
    Set-ConnectionSettings -Account "YourAccountName"

    Set-ConnectionSettings

Functionality

HostPilot PowerShell allows you to automate most tasks associated with HostPilot provisioning and management:

Read the Knowledge Base article on HostPilot PowerShell Data Types And Common Parameters.

Terms and Abbreviations

Cmdlet - is a lightweight command that is used in the Windows PowerShell environment.

AD – Active Directory

CI – Company Information

CP – Control Panel

DEH Dedicated Exchange Hosting

DR Delivery restrictions

ESN Electronic Serial Number

IMEI - International Mobile Equipment Identity

MSA Master Service Agreement

OU – Organizational Unit

SEH – Shared Exchange Hosting