Documentation Center

Getting started with ISHDeploy

With ISHDeploy installed, you can then examine the available cmdlets and how to use them. If it is not already installed, you can obtain the latest version from the PowerShell Gallery.

Verify ISHDeploy presence

The ISHDeploy module, along with ISHRemote, may have been previously installed. To verify that the module is installed and check the version, execute the following cmdlet:

Get-Module ISHDeploy -ListAvailable |Format-Table Name,Version

If the module is available, then the result should be one line, such as:

Name                              Version
----                              -------
ISHDeploy                          3.0.0

If you need to install or upgrade the module, the sections that follow provide instructions.

Prerequisites

  • Microsoft Windows PowerShell 5.1 (part of Windows Management Framework 5.1)
    To quickly check your installed PowerShell version, execute the following script:
    $PSVersionTable

    If your operating system has an earlier version of PowerShell, then you need to install PowerShell 5.1.

  • You must be logged on as an administrator user to perform this task.

Install ISHDeploy

The module is available on PowerShell Gallery.

If you have administrator rights, you can install the module for all users by running the following PowerShell command:

Install-Module ISHDeploy -RequiredVersion 3.0.0

To install the module for the user who is currently logged in, run this command:

Install-Module ISHDeploy -Scope CurrentUser -RequiredVersion 3.0.0

Upgrade ISHDeploy

Newer versions of the module will become available on PowerShell Gallery.

To install a new version for all users execute:

# All users. Requires administration rights
Install-Module ISHDeploy -Force
# Current user. No administration rights are required.
Install-Module ISHDeploy -Scope CurrentUser -Force

Available cmdlets

To retrieve all cmdlets offered by the module then execute:

Get-Command -Module ISHDeploy | Select-Object Name

Documentation

Each cmdlet offers support for the Get-Help cmdlet. Each cmdlet provides a full description, parameter syntax and examples. For example, to show the help of Get-ISHDeployment, execute the following:

Get-Help Get-ISHDeployment -Full

In addition to the cmdlets help, this documentation provides articles and sample scripts that explain how to work with the core cmdlets of the module against a specific deployment.