PowerShell is a scripting language developed by Microsoft to enable automation of administrative tasks. The LoadMaster PowerShell wrapper enables direct access to the LoadMaster Application Program Interface (API) from PowerShell to simplify automation of configuration, deployment and lifecycle management of LoadMaster instances.

Progress Kemp products optimize web and application infrastructure as defined by high-availability, high-performance, flexible scalability, security and ease of management. They minimize the total cost-of-ownership for web infrastructure, while enabling flexible and comprehensive deployment options.

Document Purpose

This document provides some information on how to import the Progress Kemp PowerShell module, how to enable the API interface on the LoadMaster and how to use the Get-Help command to retrieve help text relating to the various commands and parameters that can be used.

Prerequisites

Before proceeding with using the LoadMaster PowerShell module, it is beneficial to have a basic understanding of how to run PowerShell commands, set variables, and view the response data.

For the PowerShell API to work with the LoadMaster, the following prerequisites must be met:

  • Either TLS1.1 or TLS1.2 must be enabled in the LoadMaster Web User Interface (WUI) Settings. These are enabled by default. SSLv3 and TLS1.0 are unsupported with the PowerShell API. To set the Supported TLS Protocols, go to Certificates & Security > Admin WUI Access and select the check boxes provided.
  • The API interface must be enabled on the LoadMaster. To enable it – go to Certificates & Security > Remote Access and tick the Enable API Interface check box or enable the API programmatically using the Enable-SecAPIAccess command. If you license the LoadMaster using the API, the API interface gets automatically enabled.
  • PowerShell version 5 or above is recommended.
  • A WUI Cipher set other than Null_Ciphers must be selected in Certificates & Security > Admin WUI Access.
  • The API only works on the WUI interface unless Allow Multi Interface Access is enabled in Certificates & Security > Remote Access.