Getting started
Requirements
PowerShell requirements
ISHDeploy requires PowerShell version 4.0 installed in the operating system.
To quickly check your installed PowerShell version execute
$PSVersionTable
A version 4.0 console would return
Name Value
---- -----
PSVersion 4.0
WSManStackVersion 3.0
SerializationVersion 1.1.0.1
CLRVersion 4.0.30319.42000
BuildVersion 6.3.9600.17400
PSCompatibleVersions {1.0, 2.0, 3.0, 4.0}
PSRemotingProtocolVersion 2.2
If your operating system has a PowerShell version earlier than 4.0 then install it following the instructions on technet.
PowerShellGet module
To query and install modules from the PowerShell gallery, requires the PowerShellGet module. PowerShell version 5.0 has the PowerShellGet module available out of the box.
To install the PowerShellGet module on PowerShell version 4.0, install the Package Management installer.
Setting up PowerShellGet
PowerShellGet provides a default repository registration for PowerShell Gallery, therefore no action is necessary. To verify that PowerShell gallery is registered correctly execute:
Get-PSRepository
and the outcome should be
Name PackageManagementProvider InstallationPolicy SourceLocation
---- ------------------------- ------------------ --------------
PSGallery NuGet Untrusted https://www.powershellgallery.com/api/v2/
To register or unregister repositories use the Register-PSRepository and Unregister-PSRepository cmdlets respectively.
Install the module
The module is available on powershell gallery here.
If you have administrator rights, you can install the module for all users, by running the following PowerShell command:
Install-Module ISHDeploy -RequiredVersion 2.3.0
To install the module for the user who is currently logged in, run this command:
Install-Module ISHDeploy -Scope CurrentUser -RequiredVersion 2.3.0
Upgrading the module
Newer versions of the module will become available on powershell gallery here.
To install a new version, run one of the following commands:
# All users. Requires administration rights
Install-Module ISHDeploy -Force -RequiredVersion 2.3.0
# Current user only. No administration rights are required.
Install-Module ISHDeploy -Scope CurrentUser -Force -RequiredVersion 2.3.0
Verify the module presence
To verify that the module is installed and check the version execute:
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 2.3.0
Available cmdlets
To retrieve all cmdlets offered by the module then execute:
Get-Command -Module ISHDeploy | Select-Object Name
Each cmdlet offers support for the Get-Help cmdlet. Each cmdlet provides a full description, parameter syntax and examples.
To show the help of Get-ISHDeployment execute
Get-Help Get-ISHDeployment -Full
Administrator privileges required
The purpose of the module is to modify the files of a deployment.
For this reason, most cmdlets require elevated administrator privileges.
Each cmdlet is optimized to validate upfront if the process has the necessary permissions and when not throw early.
All cmdlets with verb Get- such as Get-ISHDeployment are exempt from this requirement as they do not modify any files.
The documentation portal
Although the module contains help for each cmdlet from within the module, this documentation portal offers also the same content.
Get-ISHDeployment for example is the online equivalent for the PowerShell command Get-Help Get-ISHDeployment -Full.
Additional to the cmdlets help, the documentation portal offers an article base where different subjects are analyzed and sample scripts are provided. For example Work with one or multiple deployments explains how to work with the core cmdlets of the module against a specific deployment. When there is only one deployment then it is possible to simplify the invocation of all cmdlets as explained in Work with one deployment.
Open source and feedback
The module's code and the content of this portal is available on github.