Work with one deployment
This article explains a possibly simpler interaction with the module's cmdlets when there is only one Content Manager deployment.
Cmdlets without an ISHDeployment parameter.
All cmdlets, with the exception of Get-ISHDeployment
, offer the -ISHDeployment
parameter to help them target a deployment.
When there is only one deployment available, it is possible to omit the -ISHDeployment
and the module will automatically use the only deployment available.
For example, lets assume that Get-ISHDeployment
outputs one deployment:
Get-ISHDeployment|Format-Table Name
Name SoftwareVersion DatabaseType AccessHostName
---- --------------- ------------ --------------
InfoShare 12.0.6112.5 sqlserver2014 ish.example.com
In this case, the following two invocation of Get-ISHDeploymentHistory
are equal:
Get-ISHDeploymentHistory -ISHDeployment "InfoShare"
Get-ISHDeploymentHistory
Although the system automatically figures out this one deployment named InfoShare
, the history file will contain records with an explicit value for the -ISHDeployment
parameter.
For example, either of the following lines will generate the same entry in the history:
Enable-ISHUIContentEditor -ISHDeployment "InfoShare"
Enable-ISHUIContentEditor
And the history will be:
<#ISHDeployScriptInfo
.VERSION 1.0
.MODULE ISHDeploy
.CREATEDBYMODULEVERSION 1.2
.UPDATEDBYMODULEVERSION 1.2
#>
param(
[Parameter(Mandatory=$false)]
[switch]$IncludeCustomFile=$false
)
# 20160314
$deploymentName = "InfoShare"
Enable-ISHUIContentEditor -ISHDeployment $deploymentName