ISHDeploy.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <!-- Cmdlet: Set-ISHActor --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-ISHActor</command:name> <command:verb>Set</command:verb> <command:noun>ISHActor</command:noun> <maml:description> <maml:para>Sets Actor user credentials.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-ISHActor cmdlet sets new security credentials of Actor user.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: PSCredential --> <command:syntaxItem> <maml:name>Set-ISHActor</maml:name> <!-- Parameter: Credential --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The credential that will be set.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UserName</maml:name> <maml:description> <maml:para>The operation system user's name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserPassword --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UserPassword</maml:name> <maml:description> <maml:para>The operation system user's password.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: UserName/UserPassword --> <command:syntaxItem> <maml:name>Set-ISHActor</maml:name> <!-- Parameter: Credential --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The credential that will be set.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>UserName</maml:name> <maml:description> <maml:para>The operation system user's name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserPassword --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>UserPassword</maml:name> <maml:description> <maml:para>The operation system user's password.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Credential --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The credential that will be set.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>UserName</maml:name> <maml:description> <maml:para>The operation system user's name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserPassword --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>UserPassword</maml:name> <maml:description> <maml:para>The operation system user's password.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Set-ISHActor -ISHDeployment $deployment -Credential $credential</dev:code> <dev:remarks> <maml:para>This command sets new Actor user credentials. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\>Set-ISHActor -ISHDeployment $deployment -UserName $userName -UserPassword $userPassword</dev:code> <dev:remarks> <maml:para>This command sets new Actor user credentials. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Set-ISHOSUser</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-ISHServiceUser</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Set-ISHAPIWCFServiceCertificate --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-ISHAPIWCFServiceCertificate</command:name> <command:verb>Set</command:verb> <command:noun>ISHAPIWCFServiceCertificate</command:noun> <maml:description> <maml:para>Sets WCF service certificate.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-ISHAPIWCFServiceCertificate cmdlet sets WCF service certificate to Content Manager deployment.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-ISHAPIWCFServiceCertificate</maml:name> <!-- Parameter: Thumbprint --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Thumbprint</maml:name> <maml:description> <maml:para>Certificate Thumbprint.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ValidationMode --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ValidationMode</maml:name> <maml:description> <maml:para>Selected validation mode.</maml:para> <maml:para>Possible values: None, PeerTrust, ChainTrust, PeerOrChainTrust, Custom</maml:para> </maml:description> <command:parameterValue required="true">X509CertificateValidationMode</command:parameterValue> <dev:type> <maml:name>System.ServiceModel.Security.X509CertificateValidationMode</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">PeerTrust</command:parameterValue> <command:parameterValue required="false" variableLength="false">ChainTrust</command:parameterValue> <command:parameterValue required="false" variableLength="false">PeerOrChainTrust</command:parameterValue> <command:parameterValue required="false" variableLength="false">Custom</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Thumbprint --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Thumbprint</maml:name> <maml:description> <maml:para>Certificate Thumbprint.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ValidationMode --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ValidationMode</maml:name> <maml:description> <maml:para>Selected validation mode.</maml:para> <maml:para>Possible values: None, PeerTrust, ChainTrust, PeerOrChainTrust, Custom</maml:para> </maml:description> <command:parameterValue required="true">X509CertificateValidationMode</command:parameterValue> <dev:type> <maml:name>System.ServiceModel.Security.X509CertificateValidationMode</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">PeerTrust</command:parameterValue> <command:parameterValue required="false" variableLength="false">ChainTrust</command:parameterValue> <command:parameterValue required="false" variableLength="false">PeerOrChainTrust</command:parameterValue> <command:parameterValue required="false" variableLength="false">Custom</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Set-ISHAPIWCFServiceCertificate -ISHDeployment $deployment -Thumbprint "t1"</dev:code> <dev:remarks> <maml:para>This command configure WCF service to use specified certificate. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\>Set-ISHAPIWCFServiceCertificate -ISHDeployment $deployment -Thumbprint "t1" -ValidationMode "None" </dev:code> <dev:remarks> <maml:para>This command configure WCF service to use specified certificate and sets credentials with no Validation Mode. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-ISHCMCUILResourceGroup --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-ISHCMCUILResourceGroup</command:name> <command:verb>Set</command:verb> <command:noun>ISHCMCUILResourceGroup</command:noun> <maml:description> <maml:para>Sets resource group in ~\Author\ASP\UI\Extensions\_config.xml.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-ISHCMCUILResourceGroup cmdlet sets resource group in "~\Author\ASP\UI\Extensions\_config.xml".</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-ISHCMCUILResourceGroup</maml:name> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of resource group in "~\Author\ASP\UI\Extensions\_config.xml".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Trisoft.Extensions</dev:defaultValue> </command:parameter> <!-- Parameter: Path --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path or paths to resource files.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of resource group in "~\Author\ASP\UI\Extensions\_config.xml".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Trisoft.Extensions</dev:defaultValue> </command:parameter> <!-- Parameter: Path --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path or paths to resource files.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Set-ISHCMCUILResourceGroup -ISHDeployment $deployment -Path "Extensions\custom\custom.js"</dev:code> <dev:remarks> <maml:para>This command updates "~\Author\ASP\UI\Extensions\_config.xml" CUIF config file with default Name "Trisoft.Extensions" and adds path to "Extensions\custom\custom.js" file in resource group with name "Trisoft.Extensions". In case resource group with such name does not exist this command will add new resource group. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\>Set-ISHCMCUILResourceGroup -ISHDeployment $deployment -Name "Trisoft.Extensions" -Path @("Extensions\custom\custom1.js", "Extensions\custom\custom2.js")</dev:code> <dev:remarks> <maml:para>This command updates "~\Author\ASP\UI\Extensions\_config.xml" CUIF config file and adds paths to bunch of files in resource group with name "Trisoft.Extensions". In case resource group with such name does not exist this command will add new resource group. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Disable-ISHCOMPlus --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Disable-ISHCOMPlus</command:name> <command:verb>Disable</command:verb> <command:noun>ISHCOMPlus</command:noun> <maml:description> <maml:para>Disables COM+ components.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Disable-ISHCOMPlus cmdlet disables COM+ components.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Disable-ISHCOMPlus</maml:name> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Disable-ISHCOMPlus -ISHDeployment $deployment</dev:code> <dev:remarks> <maml:para>This command disables all COM+ components of deployment. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-ISHCOMPlus</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-ISHCOMPlus</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-ISHIISAppPool</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-ISHServiceTranslationBuilder</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-ISHServiceTranslationOrganizer</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Enable-ISHCOMPlus --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Enable-ISHCOMPlus</command:name> <command:verb>Enable</command:verb> <command:noun>ISHCOMPlus</command:noun> <maml:description> <maml:para>Enables COM+ components.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Enable-ISHCOMPlus cmdlet enables COM+ components.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Enable-ISHCOMPlus</maml:name> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Enable-ISHCOMPlus -ISHDeployment $deployment</dev:code> <dev:remarks> <maml:para>This command enables all COM+ components of specified deployment. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Enable-ISHCOMPlus</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ISHCOMPlus</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-ISHIISAppPool</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-ISHServiceTranslationBuilder</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-ISHServiceTranslationOrganizer</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-ISHCOMPlus --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-ISHCOMPlus</command:name> <command:verb>Get</command:verb> <command:noun>ISHCOMPlus</command:noun> <maml:description> <maml:para>Gets list of COM+ components.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-ISHCOMPlus cmdlet gets list of COM+ components.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-ISHCOMPlus</maml:name> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Get-ISHCOMPlus -ISHDeployment $deployment</dev:code> <dev:remarks> <maml:para>This command shows list of COM+ components. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Enable-ISHCOMPlus</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-ISHCOMPlus</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-ISHComponent --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-ISHComponent</command:name> <command:verb>Get</command:verb> <command:noun>ISHComponent</command:noun> <maml:description> <maml:para>Acquire the components of a specific deployment.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-ISHComponent cmdlet gets components for Content Manager deployment.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-ISHComponent</maml:name> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Get-ISHComponent -ISHDeployment $deployment</dev:code> <dev:remarks> <maml:para>This command gets list of components of Content Manager deployment Parameter $deployment is an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-ISHContentEditor --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-ISHContentEditor</command:name> <command:verb>Set</command:verb> <command:noun>ISHContentEditor</command:noun> <maml:description> <maml:para>Sets new license for Content Editor.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-ISHContentEditor cmdlet sets new license for Content Editor using domain name and license key parameters.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-ISHContentEditor</maml:name> <!-- Parameter: Domain --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Domain</maml:name> <maml:description> <maml:para>Specifies the domain name for license.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LicenseKey --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>LicenseKey</maml:name> <maml:description> <maml:para>Specifies the license key value.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Domain --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Domain</maml:name> <maml:description> <maml:para>Specifies the domain name for license.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LicenseKey --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>LicenseKey</maml:name> <maml:description> <maml:para>Specifies the license key value.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Set-ISHContentEditor -ISHDeployment $deployment -Domain "localhost" -LicenseKey "123445345342331313432423"</dev:code> <dev:remarks> <maml:para>This command sets new license for Content Editor using domain name and license key. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Test-ISHContentEditor</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Test-ISHContentEditor --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Test-ISHContentEditor</command:name> <command:verb>Test</command:verb> <command:noun>ISHContentEditor</command:noun> <maml:description> <maml:para>Tests if Content Editor license exists for specific domain name.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Test-ISHContentEditor cmdlet tests if Content Editor license exists for specific domain name.</maml:para> <maml:para>If license for 'com' domain was created then all domains that ends with '.com' will be valid.</maml:para> <maml:para>In that case localhost.com domain will be valid, but localhost.com.net will be invalid.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Test-ISHContentEditor</maml:name> <!-- Parameter: Domain --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Domain</maml:name> <maml:description> <maml:para>Specifies the domain name to be verified.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Domain --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Domain</maml:name> <maml:description> <maml:para>Specifies the domain name to be verified.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Test-ISHContentEditor -Domain "localhost" -ISHDeployment $deployment</dev:code> <dev:remarks> <maml:para>This command checks if license for domain name 'localhost' exists. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Set-ISHContentEditor</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Backup-ISHDeployment --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Backup-ISHDeployment</command:name> <command:verb>Backup</command:verb> <command:noun>ISHDeployment</command:noun> <maml:description> <maml:para>Backup data from Web, App, Data folders.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Will Backup data from Web, App, Data folders depends on switch.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Web --> <command:syntaxItem> <maml:name>Backup-ISHDeployment</maml:name> <!-- Parameter: Path --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path to files for backup.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Web --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>Working with Web folder.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: App --> <command:syntaxItem> <maml:name>Backup-ISHDeployment</maml:name> <!-- Parameter: Path --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path to files for backup.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: App --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>App</maml:name> <maml:description> <maml:para>Working with App folder.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Data --> <command:syntaxItem> <maml:name>Backup-ISHDeployment</maml:name> <!-- Parameter: Path --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path to files for backup.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Data --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Data</maml:name> <maml:description> <maml:para>Working with Data folder.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Path --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path to files for backup.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Web --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>Working with Web folder.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: App --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>App</maml:name> <maml:description> <maml:para>Working with App folder.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Data --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Data</maml:name> <maml:description> <maml:para>Working with Data folder.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Backup-ISHDeployment -Web -Path Author\ASP\Web.config </dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-ISHDeployment --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-ISHDeployment</command:name> <command:verb>Get</command:verb> <command:noun>ISHDeployment</command:noun> <maml:description> <maml:para>Gets all installed Content Management deployments.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-ISHDeployment cmdlet gets all installed Content Management deployments.</maml:para> <maml:para>You can get specific instance of the installed Content Manager deployment by specifying the deployment name.</maml:para> <maml:para>All Content Manager deployment instances' names start with 'InfoShare' prefix.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-ISHDeployment</maml:name> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the installed Content Manager deployment.</maml:para> <maml:para>All names start with InfoShare</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the installed Content Manager deployment.</maml:para> <maml:para>All names start with InfoShare</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Get-ISHDeployment</dev:code> <dev:remarks> <maml:para>This command retrieves a list of all installed Content Manager deployments.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\>Get-ISHDeployment -Name 'InfoShare'</dev:code> <dev:remarks> <maml:para>This command retrieves specific instance of the Content Manager deployment by name 'InfoShare'.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Clear-ISHDeploymentHistory</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ISHDeploymentHistory</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Undo-ISHDeployment</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ISHDeploymentParameters</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Restart-ISHDeployment --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Restart-ISHDeployment</command:name> <command:verb>Restart</command:verb> <command:noun>ISHDeployment</command:noun> <maml:description> <maml:para>Restarts components of specific Content Manager deployment that marked as "Enabled" in tracking file.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Restart-ISHDeployment cmdlet restarts components of specific Content Manager deployment that marked as "Enabled" in tracking file.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Restart-ISHDeployment</maml:name> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Restart-ISHDeployment -ISHDeployment $deployment</dev:code> <dev:remarks> <maml:para>This command restarts components of specific Content Manager deployment that marked as "Enabled" in tracking file. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Start-ISHDeployment</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-ISHDeployment</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-ISHCOMPlus</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-ISHIISAppPool</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-ISHServiceTranslationBuilder</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-ISHServiceTranslationOrganizer</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Start-ISHDeployment --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Start-ISHDeployment</command:name> <command:verb>Start</command:verb> <command:noun>ISHDeployment</command:noun> <maml:description> <maml:para>Starts and enables components of specific Content Manager deployment that marked as "Enabled" in tracking file.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Start-ISHDeployment cmdlet starts and enables components of specific Content Manager deployment that marked as "Enabled" in tracking file.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Start-ISHDeployment</maml:name> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Start-ISHDeployment -ISHDeployment $deployment</dev:code> <dev:remarks> <maml:para>This command enables components of specific Content Manager deployment that marked as "Enabled" in tracking file. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Stop-ISHDeployment</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Restart-ISHDeployment</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-ISHCOMPlus</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-ISHIISAppPool</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-ISHServiceTranslationBuilder</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-ISHServiceTranslationOrganizer</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Stop-ISHDeployment --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Stop-ISHDeployment</command:name> <command:verb>Stop</command:verb> <command:noun>ISHDeployment</command:noun> <maml:description> <maml:para>Stops and disables all active components of specific Content Manager deployment.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Stop-ISHDeployment cmdlet stops and disables all active components of specific Content Manager deployment, such as InfoShare Windows Services, COM+ components and IIS application pools.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Stop-ISHDeployment</maml:name> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Stop-ISHDeployment -ISHDeployment $deployment</dev:code> <dev:remarks> <maml:para>This command disables all active components of specific Content Manager deployment. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Start-ISHDeployment</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Restart-ISHDeployment</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-ISHCOMPlus</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-ISHIISAppPool</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-ISHServiceTranslationBuilder</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-ISHServiceTranslationOrganizer</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Clear-ISHDeploymentHistory --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Clear-ISHDeploymentHistory</command:name> <command:verb>Clear</command:verb> <command:noun>ISHDeploymentHistory</command:noun> <maml:description> <maml:para>Clears customization history for Content Manager deployment.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Clear-ISHDeploymentHistory cmdlet clears customization history information for Content Manager deployment that was generated by other cmdlets.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Clear-ISHDeploymentHistory</maml:name> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Clear-ISHDeploymentHistory -ISHDeployment $deployment</dev:code> <dev:remarks> <maml:para>This command clears the history information for Content Manager deployment. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-ISHDeployment</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ISHDeploymentHistory</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Undo-ISHDeployment</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ISHDeploymentParameters</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-ISHDeploymentHistory --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-ISHDeploymentHistory</command:name> <command:verb>Get</command:verb> <command:noun>ISHDeploymentHistory</command:noun> <maml:description> <maml:para>Gets customization history for Content Manager deployment.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-ISHDeploymentHistory cmdlet gets the customization history information for Content Manager deployment that was generated by other cmdlets.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-ISHDeploymentHistory</maml:name> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: String --> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Get-ISHDeploymentHistory -ISHDeployment $deployment</dev:code> <dev:remarks> <maml:para>This command gets the history information for Content Manager deployment. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Clear-ISHDeploymentHistory</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ISHDeployment</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Undo-ISHDeployment</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ISHDeploymentParameters</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-ISHDeploymentParameters --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-ISHDeploymentParameters</command:name> <command:verb>Get</command:verb> <command:noun>ISHDeploymentParameters</command:noun> <maml:description> <maml:para>Acquire the input parameters of a specific deployment.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-ISHDeploymentParameters cmdlet gets parameters for Content Manager deployment.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Default --> <command:syntaxItem> <maml:name>Get-ISHDeploymentParameters</maml:name> <!-- Parameter: Original --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Original</maml:name> <maml:description> <maml:para>Switch parameter to get data from original file</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Changed --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Changed</maml:name> <maml:description> <maml:para>Switch parameter to get difference from changed and original file</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ShowPassword --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ShowPassword</maml:name> <maml:description> <maml:para>Switch parameter to show real passwords in parameters</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: SpecificParameter --> <command:syntaxItem> <maml:name>Get-ISHDeploymentParameters</maml:name> <!-- Parameter: Original --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Original</maml:name> <maml:description> <maml:para>Switch parameter to get data from original file</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Changed --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Changed</maml:name> <maml:description> <maml:para>Switch parameter to get difference from changed and original file</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ShowPassword --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ShowPassword</maml:name> <maml:description> <maml:para>Switch parameter to show real passwords in parameters</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the parameter to receive</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ValueOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ValueOnly</maml:name> <maml:description> <maml:para>Output only the value</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Original --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Original</maml:name> <maml:description> <maml:para>Switch parameter to get data from original file</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Changed --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Changed</maml:name> <maml:description> <maml:para>Switch parameter to get difference from changed and original file</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ShowPassword --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ShowPassword</maml:name> <maml:description> <maml:para>Switch parameter to show real passwords in parameters</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the parameter to receive</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ValueOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ValueOnly</maml:name> <maml:description> <maml:para>Output only the value</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Get-ISHDeploymentParameters -ISHDeployment $deployment</dev:code> <dev:remarks> <maml:para>This command gets the input parameters of Content Manager deployment with hidden passwords. Parameter $deployment is an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\>Get-ISHDeploymentParameters -ISHDeployment $deployment -ShowPassword</dev:code> <dev:remarks> <maml:para>This command gets the input parameters of "InfoShare" deployment with real passwords. Parameter $deployment is an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\>Get-ISHDeploymentParameters -ISHDeployment $deployment -Original</dev:code> <dev:remarks> <maml:para>This command return original values (from the backup folder) of "InfoShare" deployment. Parameter $deployment is an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>PS C:\>Get-ISHDeploymentParameters -ISHDeployment $deployment -Changed</dev:code> <dev:remarks> <maml:para>This command return only changed parameters of "InfoShare" deployment. Parameter $deployment is an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 5 ----------</maml:title> <dev:code>PS C:\>Get-ISHDeploymentParameters -ISHDeployment $deployment -Name "issuercertificatethumbprint"</dev:code> <dev:remarks> <maml:para>This command return the parameter with name "issuercertificatethumbprint". Parameter $deployment is an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 6 ----------</maml:title> <dev:code>PS C:\>Get-ISHDeploymentParameters -ISHDeployment $deployment -Name "issuercertificatethumbprint" -ValueOnly</dev:code> <dev:remarks> <maml:para>This command return the value of parameter with name "issuercertificatethumbprint". Parameter $deployment is an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-ISHDeployment</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ISHDeploymentHistory</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Undo-ISHDeployment</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Clear-ISHDeploymentHistory</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Disable-ISHExternalPreview --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Disable-ISHExternalPreview</command:name> <command:verb>Disable</command:verb> <command:noun>ISHExternalPreview</command:noun> <maml:description> <maml:para>Disables external preview for Content Manager deployment.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Disable-ISHExternalPreview cmdlet disables external preview for Content Manager deployment.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Disable-ISHExternalPreview</maml:name> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Disable-ISHExternalPreview -ISHDeployment $deployment</dev:code> <dev:remarks> <maml:para>This command disables the external preview. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Enable-ISHExternalPreview</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Enable-ISHExternalPreview --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Enable-ISHExternalPreview</command:name> <command:verb>Enable</command:verb> <command:noun>ISHExternalPreview</command:noun> <maml:description> <maml:para>Enables external preview for Content Manager deployment for specific user.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Enable-ISHExternalPreview cmdlet enables external preview for Content Manager deployment for specific user.</maml:para> <maml:para>If user id is not specified, the default value 'ServiceUser' is taken.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Enable-ISHExternalPreview</maml:name> <!-- Parameter: ExternalId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExternalId</maml:name> <maml:description> <maml:para>External user id for which external preview will be enabled. Default value is ServiceUser.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>ServiceUser</dev:defaultValue> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ExternalId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExternalId</maml:name> <maml:description> <maml:para>External user id for which external preview will be enabled. Default value is ServiceUser.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>ServiceUser</dev:defaultValue> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Enable-ISHExternalPreview -ISHDeployment $deployment -ExternalId 'user1'</dev:code> <dev:remarks> <maml:para>This command enables the external preview for user 'user1'. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Disable-ISHExternalPreview</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: New-ISHFieldMetadata --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-ISHFieldMetadata</command:name> <command:verb>New</command:verb> <command:noun>ISHFieldMetadata</command:noun> <maml:description> <maml:para>Creates a new ISH Metadata Field for TMS in Translation Organizer.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The New-ISHFieldMetadata cmdlet creates an object that represents structure of ISH metadata field for organizer service.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>New-ISHFieldMetadata</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of ISHMetadata field.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Level --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Level</maml:name> <maml:description> <maml:para>The Level of ISHMetadata field.</maml:para> <maml:para>Possible values: logical, version, lng, none</maml:para> </maml:description> <command:parameterValue required="true">ISHFieldMetadataLevel</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Enums.ISHFieldMetadataLevel</maml:name> <maml:uri /> <maml:description> <maml:para>Levels of value of ISHMetadata field.</maml:para> </maml:description> </dev:type> <dev:defaultValue>logical</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">logical</command:parameterValue> <command:parameterValue required="false" variableLength="false">version</command:parameterValue> <command:parameterValue required="false" variableLength="false">lng</command:parameterValue> <command:parameterValue required="false" variableLength="false">none</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: ValueType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ValueType</maml:name> <maml:description> <maml:para>The Type of value of ISHMetadata field.</maml:para> <maml:para>Possible values: element, id, value</maml:para> </maml:description> <command:parameterValue required="true">ISHFieldMetadataValueType</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Enums.ISHFieldMetadataValueType</maml:name> <maml:uri /> <maml:description> <maml:para>Types of value of ISHMetadata field.</maml:para> </maml:description> </dev:type> <dev:defaultValue>element</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">element</command:parameterValue> <command:parameterValue required="false" variableLength="false">id</command:parameterValue> <command:parameterValue required="false" variableLength="false">value</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of ISHMetadata field.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Level --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Level</maml:name> <maml:description> <maml:para>The Level of ISHMetadata field.</maml:para> <maml:para>Possible values: logical, version, lng, none</maml:para> </maml:description> <command:parameterValue required="true">ISHFieldMetadataLevel</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Enums.ISHFieldMetadataLevel</maml:name> <maml:uri /> <maml:description> <maml:para>Levels of value of ISHMetadata field.</maml:para> </maml:description> </dev:type> <dev:defaultValue>logical</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">logical</command:parameterValue> <command:parameterValue required="false" variableLength="false">version</command:parameterValue> <command:parameterValue required="false" variableLength="false">lng</command:parameterValue> <command:parameterValue required="false" variableLength="false">none</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: ValueType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ValueType</maml:name> <maml:description> <maml:para>The Type of value of ISHMetadata field.</maml:para> <maml:para>Possible values: element, id, value</maml:para> </maml:description> <command:parameterValue required="true">ISHFieldMetadataValueType</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Enums.ISHFieldMetadataValueType</maml:name> <maml:uri /> <maml:description> <maml:para>Types of value of ISHMetadata field.</maml:para> </maml:description> </dev:type> <dev:defaultValue>element</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">element</command:parameterValue> <command:parameterValue required="false" variableLength="false">id</command:parameterValue> <command:parameterValue required="false" variableLength="false">value</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>New-ISHFieldMetadata -Name "testName" -Level "logical" -ValueType "value"</dev:code> <dev:remarks> <maml:para>This command creates new object with metadata with name testName, level "logical" and valuetype "value".</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Set-ISHServiceTranslationOrganizer</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-ISHIntegrationTMS</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Copy-ISHFile --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Copy-ISHFile</command:name> <command:verb>Copy</command:verb> <command:noun>ISHFile</command:noun> <maml:description> <maml:para>Copies custom files to deployment directories and replaces parameters in files on values of the deployment.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Will copy custom files to deployment directories and replace the placeholders of files with the corresponding values of the deployment. Replacement of values occurs only in files of certain extensions. Before you start working with deployment files, you need to stop the deployments processes, see: Stop-ISHDeployment and Start-ISHDeployment cmdlets.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: CdSimilarFolder --> <command:syntaxItem> <maml:name>Copy-ISHFile</maml:name> <!-- Parameter: ISHCD --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHCD</maml:name> <maml:description> <maml:para>The path to folder with custom files with the same structure as CD</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Replaces existing files</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: CopyingAsIs --> <command:syntaxItem> <maml:name>Copy-ISHFile</maml:name> <!-- Parameter: SourceFolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceFolderPath</maml:name> <maml:description> <maml:para>The path to folder with custom files</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DestinationFolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>DestinationFolderPath</maml:name> <maml:description> <maml:para>The path to destination folder</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Replaces existing files</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ISHCD --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHCD</maml:name> <maml:description> <maml:para>The path to folder with custom files with the same structure as CD</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SourceFolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceFolderPath</maml:name> <maml:description> <maml:para>The path to folder with custom files</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DestinationFolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>DestinationFolderPath</maml:name> <maml:description> <maml:para>The path to destination folder</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Replaces existing files</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Copy-ISHFile -ISHDeployment $deployment -ISHCD "c:\customfiles\"</dev:code> <dev:remarks> <maml:para>The cmdlet copies all files from subfolders "Applications", "Database", "DocTypes", "Websites", "CustomerSpecificFiles" of the root folder specified in the parameter -ISHCD to appropriate deployment's folders. This means that the root folder should have similar to CD structure and can contain only subfolders: "Applications", "Database", "DocTypes", "Websites", "CustomerSpecificFiles". Note: the "CustomerSpecificFiles" folder must contain the "FilesToCopy" subfolder and the "FilesToCopy" folder can contain only folders "Applications", "Database", "DocTypes", "Websites". The files of any other subfolder of the CD or of "CustomerSpecificFiles/FilesToCopy" folder will be ignored if the structure of folders does not correspond to above. The cmdlet also replaces the placeholders ​​like "#!#installtool:SomeValueName#!#" in files with the corresponding parameters of specified deployment.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\>Copy-ISHFile -ISHDeployment $deployment -SourceFolderPath "c:\customfiles\Plugins" -DestinationFolderPath "C:\InfoShare\App\Plugins"</dev:code> <dev:remarks> <maml:para>The cmdlet makes a copy of all the files from the folder specified in the parameter -SourceFolderPath to folder with path from parameter -DestinationFolderPath. The cmdlet also replaces the placeholders ​​like "#!#installtool:SomeValueName#!#" in files with the corresponding parameters of specified deployment.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Stop-ISHDeployment</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-ISHDeployment</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>../Articles/Customization/Work with files</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Undo-ISHFile --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Undo-ISHFile</command:name> <command:verb>Undo</command:verb> <command:noun>ISHFile</command:noun> <maml:description> <maml:para>The Undo-ISHFile reverts to the original state changes made by Copy-ISHFile and other cmd-lets that changed configuration files of ISHDeployment.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Will revert changed files to the original state and remove backups of this files.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Undo-ISHFile</maml:name> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Undo-ISHFile -ISHDeployment $deployment</dev:code> <dev:remarks> <maml:para>Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Copy-ISHFile</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>../Articles/Customization/Work with files</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Set-ISHFontoSchemaExperience --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-ISHFontoSchemaExperience</command:name> <command:verb>Set</command:verb> <command:noun>ISHFontoSchemaExperience</command:noun> <maml:description> <maml:para>Creates the SchemaLocationConfig.xml and compiled schemas files in the "Web\InfoShareCS\custom" folder by using the Fonto Schema Compiler, so they can be used by Collective Spaces.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Before creating the SchemaLocationConfig.xml and compiling the schemas, this command first checks that:</maml:para> <maml:para>* The catalog.xml, catalog-mapping.xml and schema files available in the "Web\Author\ASP\DocTypes" folder are valid, can be compiled and contain proper matching schema URN - DTD Public Id mappings.</maml:para> <maml:para>* The behaviorConfig.xml available in the "Web\InfoShareCS\custom" location is valid against it's schema (behaviorConfig.xsd).</maml:para> <maml:para>* The files can be converted and prepared in such a way they can be used as input to the schema compiler.</maml:para> <maml:para>Notes:</maml:para> <maml:para>* Only the "match" XML elements in the catalog-mapping.xml that have a non-empty "dtdpublicid" attribute value and a "xsdsystemid" attribute value that starts with "urn:" will be taken into account and compiled.</maml:para> <maml:para>* This cmdlet will create the "SchemaLocationConfig.xml" file in the "Web\InfoShareCS\custom" folder and the compiled schemas in the "schemas" subfolder in that folder.</maml:para> <maml:para>* This cmdlet will also delete and create a "CSTemp" folder in the "Web\InfoShareCS\custom" folder to prepare files for the schema compiler.</maml:para> <maml:para>* For CM versions >= 14.0.2, this cmdlet will also add additional configuration to optimize the handling of whitespace characters for Draft Space and Review Space:</maml:para> <maml:para>** Adds an "xmlNormalization" section to the "Author" and "InfoShareCS" "web.config" containing the elements for which to preserve whitespace and the list of inline elements</maml:para> <maml:para>** Recycles the application pool (TrisoftAppPoolISHCM).</maml:para> <maml:para>** Adds the "xpath" attribute value of any "block" element that has a "type" attribute containing "candirectlycontaintext" in the "BehaviorConfig.xml" to the Fonto Review service "appsettings.json" "BlockTest" value as an extra " or " clause.</maml:para> <maml:para>** Adds the "xpath" attribute value of any "image" element in the "BehaviorConfig.xml" to the Fonto Review service "appsettings.json" "ObjectTest" value as an extra " or " clause.</maml:para> <maml:para>** Restarts the Fonto Review service.</maml:para> <maml:para>* For CM versions >= 14.0.3, this cmdlet will also adapt the FDiff "sx.xml" configuration used by the Document History service if you have elements configured in the "BehaviorConfig.xml" file</maml:para> <maml:para>** Adds the "xpath" attributes (and "elementname" attributes prefixed with self::") configured in the "BehaviorConfig.xml" to the appropriate "*Test" attribute in the FDiff sx.xml configuration file if needed. (Note that xpaths containing "self::*" are excluded)</maml:para> <maml:para>** Restarts the Fonto Document History service.</maml:para> <maml:para>* This cmdlet will recycle the application pool (TrisoftAppPoolISHCS).</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-ISHFontoSchemaExperience</maml:name> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Set-ISHFontoSchemaExperience -ISHDeployment $deployment</dev:code> <dev:remarks> <maml:para>Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Test-ISHFontoSchemaExperience --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Test-ISHFontoSchemaExperience</command:name> <command:verb>Test</command:verb> <command:noun>ISHFontoSchemaExperience</command:noun> <maml:description> <maml:para>Tests that the files used to configure custom schemas and behavior for Collective Spaces are valid and can be parsed and converted properly for compilation with the Fonto Schema Compiler.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This command checks that:</maml:para> <maml:para>* The catalog.xml, catalog-mapping.xml and schema files available in the "Web\Author\ASP\DocTypes" folder are valid, can be compiled and contain proper matching schema URN - DTD Public Id mappings.</maml:para> <maml:para>* The behaviorConfig.xml available in the "Web\InfoShareCS\custom" location is valid against it's schema (behaviorConfig.xsd).</maml:para> <maml:para>* The files can be converted and prepared in such a way they can be used as input to the schema compiler.</maml:para> <maml:para>Notes:</maml:para> <maml:para>* Only the "match" XML elements in the catalog-mapping.xml that have a non-empty "dtdpublicid" attribute value and a "xsdsystemid" attribute value that starts with "urn:" will be taken into account and validated.</maml:para> <maml:para>* This cmdlet will also delete and create a "CSTemp" folder in the "Web\InfoShareCS\custom" folder to test the preparation of files for the schema compiler.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Test-ISHFontoSchemaExperience</maml:name> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Test-ISHFontoSchemaExperience -ISHDeployment $deployment</dev:code> <dev:remarks> <maml:para>Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-ISHFreePortNumber --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-ISHFreePortNumber</command:name> <command:verb>Get</command:verb> <command:noun>ISHFreePortNumber</command:noun> <maml:description> <maml:para>Gets for the free port number in specified range.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet gets free port number in specified range.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-ISHFreePortNumber</maml:name> <!-- Parameter: StartOfRange --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>StartOfRange</maml:name> <maml:description> <maml:para>The start of range to search.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: EndOfRange --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>EndOfRange</maml:name> <maml:description> <maml:para>The end of range to search.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: StartOfRange --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>StartOfRange</maml:name> <maml:description> <maml:para>The start of range to search.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: EndOfRange --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>EndOfRange</maml:name> <maml:description> <maml:para>The end of range to search.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Get-ISHFreePortNumber -StartOfRange $startOfRange -EndOfRange $endOfRange</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Test-ISHFreePortNumber --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Test-ISHFreePortNumber</command:name> <command:verb>Test</command:verb> <command:noun>ISHFreePortNumber</command:noun> <maml:description> <maml:para>Tests that the specified port can be used.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet checks that specified port is not in use and returns True if port is not in use, or False if it's in use.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Test-ISHFreePortNumber</maml:name> <!-- Parameter: PortNumber --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>PortNumber</maml:name> <maml:description> <maml:para>The port number.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: PortNumber --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>PortNumber</maml:name> <maml:description> <maml:para>The port number.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Test-ISHFreePortNumber -PortNumber $portNumber</dev:code> <dev:remarks> <maml:para>This cmdlet checks that specified port is not in use and returns True if port is not in use, or False if is used. Parameter $portNumber is a number of port.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Disable-ISHIISAppPool --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Disable-ISHIISAppPool</command:name> <command:verb>Disable</command:verb> <command:noun>ISHIISAppPool</command:noun> <maml:description> <maml:para>Disables IIS application pools of specified deployment.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Disable-ISHIISAppPool cmdlet disables IIS application pools of specified deployment.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Disable-ISHIISAppPool</maml:name> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Disable-ISHIISAppPool -ISHDeployment $deployment</dev:code> <dev:remarks> <maml:para>This command disables all IIS application pools of specified deployment. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Enable-ISHIISAppPool</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ISHIISAppPool</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-ISHCOMPlus</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-ISHServiceTranslationBuilder</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-ISHServiceTranslationOrganizer</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Enable-ISHIISAppPool --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Enable-ISHIISAppPool</command:name> <command:verb>Enable</command:verb> <command:noun>ISHIISAppPool</command:noun> <maml:description> <maml:para>Enables IIS application pools of specified deployment.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Enable-ISHIISAppPool cmdlet enables IIS application pools of specified deployment.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Enable-ISHIISAppPool</maml:name> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Enable-ISHIISAppPool -ISHDeployment $deployment</dev:code> <dev:remarks> <maml:para>This command enables all IIS application pools of specified deployment. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Disable-ISHIISAppPool</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ISHIISAppPool</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-ISHCOMPlus</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-ISHServiceTranslationBuilder</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-ISHServiceTranslationOrganizer</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-ISHIISAppPool --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-ISHIISAppPool</command:name> <command:verb>Get</command:verb> <command:noun>ISHIISAppPool</command:noun> <maml:description> <maml:para>Gets list of IIS application pools.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-ISHIISAppPool cmdlet gets list of IIS application pools for Content Manager deployment.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-ISHIISAppPool</maml:name> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Get-ISHIISAppPool -ISHDeployment $deployment</dev:code> <dev:remarks> <maml:para>This command shows list of IIS application pools of specified deployment. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Enable-ISHIISAppPool</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-ISHIISAppPool</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-ISHIntegrationDB --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-ISHIntegrationDB</command:name> <command:verb>Get</command:verb> <command:noun>ISHIntegrationDB</command:noun> <maml:description> <maml:para>Return connection string to database for certain environment.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet returns connection string and type of database for certain environment.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-ISHIntegrationDB</maml:name> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Get-ISHIntegrationDB -ISHDeployment $deployment</dev:code> <dev:remarks> <maml:para>This cmdlet returns connection string and type of database for certain environment. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-ISHIntegrationDB --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-ISHIntegrationDB</command:name> <command:verb>Set</command:verb> <command:noun>ISHIntegrationDB</command:noun> <maml:description> <maml:para>Change connection string and type of database for certain environment.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet change connection string to database for certain environment.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-ISHIntegrationDB</maml:name> <!-- Parameter: ConnectionString --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ConnectionString</maml:name> <maml:description> <maml:para>Connection string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Engine --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Engine</maml:name> <maml:description> <maml:para>The type of database.</maml:para> <maml:para>Possible values: oracle, sqlserver2012, sqlserver2014, sqlserver2016, sqlserver2017, sqlserver2019</maml:para> </maml:description> <command:parameterValue required="true">DatabaseType</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Enums.DatabaseType</maml:name> <maml:uri /> <maml:description> <maml:para>Enumeration listing the supported database types.</maml:para> </maml:description> </dev:type> <dev:defaultValue>oracle</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">oracle</command:parameterValue> <command:parameterValue required="false" variableLength="false">sqlserver2012</command:parameterValue> <command:parameterValue required="false" variableLength="false">sqlserver2014</command:parameterValue> <command:parameterValue required="false" variableLength="false">sqlserver2016</command:parameterValue> <command:parameterValue required="false" variableLength="false">sqlserver2017</command:parameterValue> <command:parameterValue required="false" variableLength="false">sqlserver2019</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Raw --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Set connection string as a string parameter. **Note:** This is a legacy parameter which is no longer used.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ConnectionString --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ConnectionString</maml:name> <maml:description> <maml:para>Connection string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Engine --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Engine</maml:name> <maml:description> <maml:para>The type of database.</maml:para> <maml:para>Possible values: oracle, sqlserver2012, sqlserver2014, sqlserver2016, sqlserver2017, sqlserver2019</maml:para> </maml:description> <command:parameterValue required="true">DatabaseType</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Enums.DatabaseType</maml:name> <maml:uri /> <maml:description> <maml:para>Enumeration listing the supported database types.</maml:para> </maml:description> </dev:type> <dev:defaultValue>oracle</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">oracle</command:parameterValue> <command:parameterValue required="false" variableLength="false">sqlserver2012</command:parameterValue> <command:parameterValue required="false" variableLength="false">sqlserver2014</command:parameterValue> <command:parameterValue required="false" variableLength="false">sqlserver2016</command:parameterValue> <command:parameterValue required="false" variableLength="false">sqlserver2017</command:parameterValue> <command:parameterValue required="false" variableLength="false">sqlserver2019</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Raw --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Set connection string as a string parameter. **Note:** This is a legacy parameter which is no longer used.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Set-ISHIntegrationDB -ISHDeployment $deployment -ConnectionString "" -Engine "sqlserver2016"</dev:code> <dev:remarks> <maml:para>This command sets connection string and type of database for certain environment. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Test-ISHIntegrationDB --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Test-ISHIntegrationDB</command:name> <command:verb>Test</command:verb> <command:noun>ISHIntegrationDB</command:noun> <maml:description> <maml:para>Test connection string to database.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet check connection to database for certain environment and returns True if connection is Ok, or False if connection is invalid</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Test-ISHIntegrationDB</maml:name> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Test-ISHIntegrationDB -ISHDeployment $deployment</dev:code> <dev:remarks> <maml:para>This cmdlet tests connection to database for certain environment and returns True if connection is Ok, or False if connection is invalid. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Save-ISHIntegrationDBSTSSQLServerConfiguration --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Save-ISHIntegrationDBSTSSQLServerConfiguration</command:name> <command:verb>Save</command:verb> <command:noun>ISHIntegrationDBSTSSQLServerConfiguration</command:noun> <maml:description> <maml:para>Generates SQL Server script that grants necessary permissions.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Save-ISHIntegrationDBSTSSQLServerConfigurationCmdlet generates SQL Server script that grants necessary permissions into package folder.</maml:para> <maml:para>Cmdlet will overwrite the file if there is already one with same name.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Save-ISHIntegrationDBSTSSQLServerConfiguration</maml:name> <!-- Parameter: FileName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>FileName</maml:name> <maml:description> <maml:para>Name of the output file.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Type --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Type</maml:name> <maml:description> <maml:para>Specifies the output file type. Default value is 'SQL'.</maml:para> <maml:para>Possible values: PS1, SQL</maml:para> </maml:description> <command:parameterValue required="true">OutputType</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Enums.OutputType</maml:name> <maml:uri /> <maml:description> <maml:para>Enumeration of output file types.</maml:para> </maml:description> </dev:type> <dev:defaultValue>SQL</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PS1</command:parameterValue> <command:parameterValue required="false" variableLength="false">SQL</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: FileName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>FileName</maml:name> <maml:description> <maml:para>Name of the output file.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Type --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Type</maml:name> <maml:description> <maml:para>Specifies the output file type. Default value is 'SQL'.</maml:para> <maml:para>Possible values: PS1, SQL</maml:para> </maml:description> <command:parameterValue required="true">OutputType</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Enums.OutputType</maml:name> <maml:uri /> <maml:description> <maml:para>Enumeration of output file types.</maml:para> </maml:description> </dev:type> <dev:defaultValue>SQL</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PS1</command:parameterValue> <command:parameterValue required="false" variableLength="false">SQL</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Save-ISHIntegrationDBSTSSQLServerConfigurationCmdlet -ISHDeployment $deployment -FileName GrantPermissions.sql</dev:code> <dev:remarks> <maml:para>Generates SQL script that grants necessary permissions. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\>Save-ISHIntegrationDBSTSSQLServerConfigurationCmdlet -ISHDeployment $deployment -FileName GrantPermissions.ps1 -Type PS1</dev:code> <dev:remarks> <maml:para>Generates PS1 script that runs sql command on server and grants necessary permissions. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-ISHIntegrationFullTextIndex --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-ISHIntegrationFullTextIndex</command:name> <command:verb>Set</command:verb> <command:noun>ISHIntegrationFullTextIndex</command:noun> <maml:description> <maml:para>Sets target lucene Uri.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-ISHIntegrationFullTextIndex cmdlet sets target lucene Uri. Note: If you want to access the full text index remotely, you need to add a firewall rule to allow access to this port remotely. For example: New-NetFirewallRule -DisplayName 'ISHDeploy port:8080 opening' -LocalPort 8080 -Protocol TCP -Action Allow</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-ISHIntegrationFullTextIndex</maml:name> <!-- Parameter: Uri --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Uri</maml:name> <maml:description> <maml:para>The target lucene Uri.</maml:para> </maml:description> <command:parameterValue required="true">Uri</command:parameterValue> <dev:type> <maml:name>System.Uri</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Uri --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Uri</maml:name> <maml:description> <maml:para>The target lucene Uri.</maml:para> </maml:description> <command:parameterValue required="true">Uri</command:parameterValue> <dev:type> <maml:name>System.Uri</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Set-ISHIntegrationFullTextIndex -ISHDeployment $deployment -Uri "http://127.0.0.1:8080/solr/"</dev:code> <dev:remarks> <maml:para>This command changes the target Uri of instances of SolrLucene services. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Set-ISHServiceFullTextIndex</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Remove-ISHIntegrationSTSCertificate --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-ISHIntegrationSTSCertificate</command:name> <command:verb>Remove</command:verb> <command:noun>ISHIntegrationSTSCertificate</command:noun> <maml:description> <maml:para>Removes STS certificate.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Remove-ISHIntegrationSTSCertificate cmdlet removes certificate based on a issuer name.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Remove-ISHIntegrationSTSCertificate</maml:name> <!-- Parameter: Issuer --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Issuer</maml:name> <maml:description> <maml:para>Issuer name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Issuer --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Issuer</maml:name> <maml:description> <maml:para>Issuer name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Remove-ISHIntegrationSTSCertificate -ISHDeployment $deployment -Issuer "20151028ADFS"</dev:code> <dev:remarks> <maml:para>This command removes STS trusted issuer credentials. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Disable-ISHIntegrationSTSInternalAuthentication</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-ISHIntegrationSTSInternalAuthentication</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-ISHIntegrationSTSCertificate</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Save-ISHIntegrationSTSConfigurationPackage</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-ISHIntegrationSTSWSFederation</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-ISHIntegrationSTSWSTrust</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Set-ISHIntegrationSTSCertificate --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-ISHIntegrationSTSCertificate</command:name> <command:verb>Set</command:verb> <command:noun>ISHIntegrationSTSCertificate</command:noun> <maml:description> <maml:para>Sets STS certificate.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-ISHIntegrationSTSCertificate cmdlet sets Thumbprint and issuers values to configuration.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-ISHIntegrationSTSCertificate</maml:name> <!-- Parameter: Thumbprint --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Thumbprint</maml:name> <maml:description> <maml:para>Certificate Thumbprint.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Issuer --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Issuer</maml:name> <maml:description> <maml:para>Issuer name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ValidationMode --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ValidationMode</maml:name> <maml:description> <maml:para>Selected validation mode.</maml:para> <maml:para>Possible values: None, PeerTrust, ChainTrust, PeerOrChainTrust, Custom</maml:para> </maml:description> <command:parameterValue required="true">X509CertificateValidationMode</command:parameterValue> <dev:type> <maml:name>System.ServiceModel.Security.X509CertificateValidationMode</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">PeerTrust</command:parameterValue> <command:parameterValue required="false" variableLength="false">ChainTrust</command:parameterValue> <command:parameterValue required="false" variableLength="false">PeerOrChainTrust</command:parameterValue> <command:parameterValue required="false" variableLength="false">Custom</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Thumbprint --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Thumbprint</maml:name> <maml:description> <maml:para>Certificate Thumbprint.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Issuer --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Issuer</maml:name> <maml:description> <maml:para>Issuer name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ValidationMode --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ValidationMode</maml:name> <maml:description> <maml:para>Selected validation mode.</maml:para> <maml:para>Possible values: None, PeerTrust, ChainTrust, PeerOrChainTrust, Custom</maml:para> </maml:description> <command:parameterValue required="true">X509CertificateValidationMode</command:parameterValue> <dev:type> <maml:name>System.ServiceModel.Security.X509CertificateValidationMode</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">PeerTrust</command:parameterValue> <command:parameterValue required="false" variableLength="false">ChainTrust</command:parameterValue> <command:parameterValue required="false" variableLength="false">PeerOrChainTrust</command:parameterValue> <command:parameterValue required="false" variableLength="false">Custom</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Set-ISHIntegrationSTSCertificate -ISHDeployment $deployment -Thumbprint "t1" -Issuer "20151028ADFS"</dev:code> <dev:remarks> <maml:para>This command sets STS trusted issuer credentials. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\>Set-ISHIntegrationSTSCertificate -ISHDeployment $deployment -Thumbprint "t1" -Issuer "20151028ADFS" -ValidationMode "None" </dev:code> <dev:remarks> <maml:para>This command sets STS trusted issuer credentials with no Validation Mode. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Disable-ISHIntegrationSTSInternalAuthentication</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-ISHIntegrationSTSInternalAuthentication</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-ISHIntegrationSTSCertificate</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Save-ISHIntegrationSTSConfigurationPackage</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-ISHIntegrationSTSWSFederation</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-ISHIntegrationSTSWSTrust</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Save-ISHIntegrationSTSConfigurationPackage --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Save-ISHIntegrationSTSConfigurationPackage</command:name> <command:verb>Save</command:verb> <command:noun>ISHIntegrationSTSConfigurationPackage</command:noun> <maml:description> <maml:para>Saves STS integration configuration to zip archive in package folder.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Save-ISHIntegrationSTSConfigurationPackage saves STS integration configuration to zip archive in package folder.</maml:para> <maml:para>Cmdlet will overwrite zip archive if there is already one with same name.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Save-ISHIntegrationSTSConfigurationPackage</maml:name> <!-- Parameter: FileName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>FileName</maml:name> <maml:description> <maml:para>Name of the output package file.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ADFS --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ADFS</maml:name> <maml:description> <maml:para>Specifies that ADFS configuration should be packed.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: FileName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>FileName</maml:name> <maml:description> <maml:para>Name of the output package file.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ADFS --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ADFS</maml:name> <maml:description> <maml:para>Specifies that ADFS configuration should be packed.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Save-ISHIntegrationSTSConfigurationPackage -ISHDeployment $deployment -FileName packageFile.zip</dev:code> <dev:remarks> <maml:para>Creates a zip archive in package folder with current STS integration configurations. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\>Save-ISHIntegrationSTSConfigurationPackage -ISHDeployment $deployment -ADFS -FileName packageFile.zip</dev:code> <dev:remarks> <maml:para>Creates a zip archive in package folder with current STS integration configurations for ADFS. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Disable-ISHIntegrationSTSInternalAuthentication</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-ISHIntegrationSTSInternalAuthentication</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-ISHIntegrationSTSCertificate</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-ISHIntegrationSTSCertificate</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-ISHIntegrationSTSWSFederation</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-ISHIntegrationSTSWSTrust</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-ISHIntegrationSTSWSFederation</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Disable-ISHIntegrationSTSInternalAuthentication --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Disable-ISHIntegrationSTSInternalAuthentication</command:name> <command:verb>Disable</command:verb> <command:noun>ISHIntegrationSTSInternalAuthentication</command:noun> <maml:description> <maml:para>Removes additional login redirect.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Deleted directory with created for internal login STS files.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Disable-ISHIntegrationSTSInternalAuthentication</maml:name> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Disable-ISHIntegrationSTSInternalAuthentication -ISHDeployment $deployment</dev:code> <dev:remarks> <maml:para>This command disable internal STS authentication and removes files created for internal STS login. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Enable-ISHIntegrationSTSInternalAuthentication</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-ISHIntegrationSTSCertificate</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-ISHIntegrationSTSCertificate</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Save-ISHIntegrationSTSConfigurationPackage</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-ISHIntegrationSTSWSFederation</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-ISHIntegrationSTSWSTrust</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Enable-ISHIntegrationSTSInternalAuthentication --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Enable-ISHIntegrationSTSInternalAuthentication</command:name> <command:verb>Enable</command:verb> <command:noun>ISHIntegrationSTSInternalAuthentication</command:noun> <maml:description> <maml:para>Create new page with additional login redirect.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Create new index.html page with additional login redirect. Also create connectionconfiguration.xml file to use STS.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Enable-ISHIntegrationSTSInternalAuthentication</maml:name> <!-- Parameter: LcHost --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LcHost</maml:name> <maml:description> <maml:para>Host name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LcWebAppName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LcWebAppName</maml:name> <maml:description> <maml:para>Web application name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: LcHost --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LcHost</maml:name> <maml:description> <maml:para>Host name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LcWebAppName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LcWebAppName</maml:name> <maml:description> <maml:para>Web application name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Enable-ISHIntegrationSTSInternalAuthentication -ISHDeployment $deployment</dev:code> <dev:remarks> <maml:para>This command enable internal STS authentication with new index.html page. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\>Enable-ISHIntegrationSTSInternalAuthentication -ISHDeployment $deployment -LCHost "lc.example.com" -LCWebAppName "ContentDelivery" </dev:code> <dev:remarks> <maml:para>This command enable internal STS authentication with new index.html page. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet. Parameter LCHost define host name Parameter LCWebAppName define web application name by default it is "ContentDelivery".</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Disable-ISHIntegrationSTSInternalAuthentication</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-ISHIntegrationSTSCertificate</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-ISHIntegrationSTSCertificate</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Save-ISHIntegrationSTSConfigurationPackage</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-ISHIntegrationSTSWSFederation</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-ISHIntegrationSTSWSTrust</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Set-ISHIntegrationSTSWSFederation --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-ISHIntegrationSTSWSFederation</command:name> <command:verb>Set</command:verb> <command:noun>ISHIntegrationSTSWSFederation</command:noun> <maml:description> <maml:para>Sets WSFederation configuration.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-ISHIntegrationSTSWSFederation cmdlet sets WSFederation configuration to Content Manager deployment.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-ISHIntegrationSTSWSFederation</maml:name> <!-- Parameter: Endpoint --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Endpoint</maml:name> <maml:description> <maml:para>Specifies the url of the Security Token Service.</maml:para> </maml:description> <command:parameterValue required="true">Uri</command:parameterValue> <dev:type> <maml:name>System.Uri</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Endpoint --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Endpoint</maml:name> <maml:description> <maml:para>Specifies the url of the Security Token Service.</maml:para> </maml:description> <command:parameterValue required="true">Uri</command:parameterValue> <dev:type> <maml:name>System.Uri</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Set-ISHIntegrationSTSWSFederation -ISHDeployment $deployment -Endpoint "https://adfs.example.corp/adfs/ls/"</dev:code> <dev:remarks> <maml:para>This command configure WS Federation to use specified endpoint of STS server. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Disable-ISHIntegrationSTSInternalAuthentication</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-ISHIntegrationSTSInternalAuthentication</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-ISHIntegrationSTSCertificate</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-ISHIntegrationSTSCertificate</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Save-ISHIntegrationSTSConfigurationPackage</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-ISHIntegrationSTSWSTrust</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Set-ISHIntegrationSTSWSTrust --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-ISHIntegrationSTSWSTrust</command:name> <command:verb>Set</command:verb> <command:noun>ISHIntegrationSTSWSTrust</command:noun> <maml:description> <maml:para>Sets WSTrust configuration.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-ISHIntegrationSTSWSTrust cmdlet sets WSTrust configuration to Content Manager deployment.</maml:para> <maml:para>When -IncludeInternalClients is switched on then the -ActorUsername and -ActorPassword must be specified.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-ISHIntegrationSTSWSTrust</maml:name> <!-- Parameter: Endpoint --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Endpoint</maml:name> <maml:description> <maml:para>Specifies the URL to issuer WSTrust endpoint.</maml:para> </maml:description> <command:parameterValue required="true">Uri</command:parameterValue> <dev:type> <maml:name>System.Uri</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MexEndpoint --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>MexEndpoint</maml:name> <maml:description> <maml:para>Specifies the URL to issuer WSTrust mexEndpoint.</maml:para> </maml:description> <command:parameterValue required="true">Uri</command:parameterValue> <dev:type> <maml:name>System.Uri</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: BindingType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>BindingType</maml:name> <maml:description> <maml:para>Specifies the STS issuer authentication type.</maml:para> <maml:para>Possible values: UserNameMixed, WindowsMixed</maml:para> </maml:description> <command:parameterValue required="true">BindingType</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Enums.BindingType</maml:name> <maml:uri /> <maml:description> <maml:para>Enumeration of Binding Types.</maml:para> </maml:description> </dev:type> <dev:defaultValue>UserNameMixed</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">UserNameMixed</command:parameterValue> <command:parameterValue required="false" variableLength="false">WindowsMixed</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: IncludeInternalClients --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeInternalClients</maml:name> <maml:description> <maml:para>Specifies that STS -ActorUsername and -ActorPassword need to be updated.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ActorUsername --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ActorUsername</maml:name> <maml:description> <maml:para>Specifies the STS actor Username.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ActorPassword --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ActorPassword</maml:name> <maml:description> <maml:para>Specifies the STS actor password.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Endpoint --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Endpoint</maml:name> <maml:description> <maml:para>Specifies the URL to issuer WSTrust endpoint.</maml:para> </maml:description> <command:parameterValue required="true">Uri</command:parameterValue> <dev:type> <maml:name>System.Uri</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MexEndpoint --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>MexEndpoint</maml:name> <maml:description> <maml:para>Specifies the URL to issuer WSTrust mexEndpoint.</maml:para> </maml:description> <command:parameterValue required="true">Uri</command:parameterValue> <dev:type> <maml:name>System.Uri</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: BindingType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>BindingType</maml:name> <maml:description> <maml:para>Specifies the STS issuer authentication type.</maml:para> <maml:para>Possible values: UserNameMixed, WindowsMixed</maml:para> </maml:description> <command:parameterValue required="true">BindingType</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Enums.BindingType</maml:name> <maml:uri /> <maml:description> <maml:para>Enumeration of Binding Types.</maml:para> </maml:description> </dev:type> <dev:defaultValue>UserNameMixed</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">UserNameMixed</command:parameterValue> <command:parameterValue required="false" variableLength="false">WindowsMixed</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: IncludeInternalClients --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeInternalClients</maml:name> <maml:description> <maml:para>Specifies that STS -ActorUsername and -ActorPassword need to be updated.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ActorUsername --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ActorUsername</maml:name> <maml:description> <maml:para>Specifies the STS actor Username.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ActorPassword --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ActorPassword</maml:name> <maml:description> <maml:para>Specifies the STS actor password.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Set-ISHIntegrationSTSWSTrust -ISHDeployment $deployment -Endpoint "https://adfs.example.com/adfs/services/trust/13/windowsmixed" -MexEndpoint "https://adfs.example.com/adfs/services/trust/mex" -BindingType "WindowsMixed" -Verbose</dev:code> <dev:remarks> <maml:para>This command configure WS to use specified Endpoint and MexEndpoint of STS server and sets type of authentication as WindowsMixed. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\>Set-ISHIntegrationSTSWSTrust -ISHDeployment $deployment -Endpoint "https://adfs.example.com/adfs/services/trust/13/windowsmixed" -MexEndpoint "https://adfs.example.com/adfs/services/trust/mex" -BindingType "WindowsMixed" -IncludeInternalClients -Verbose</dev:code> <dev:remarks> <maml:para>This command configure WS to use specified Endpoint and MexEndpoint of STS server, sets type of authentication as WindowsMixed and sets internal clients credentials. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Disable-ISHIntegrationSTSInternalAuthentication</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-ISHIntegrationSTSInternalAuthentication</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-ISHIntegrationSTSCertificate</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-ISHIntegrationSTSCertificate</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Save-ISHIntegrationSTSConfigurationPackage</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-ISHIntegrationSTSWSFederation</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Remove-ISHIntegrationTMS --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-ISHIntegrationTMS</command:name> <command:verb>Remove</command:verb> <command:noun>ISHIntegrationTMS</command:noun> <maml:description> <maml:para>TMS Instance from Translation Organizer.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Remove-ISHIntegrationTMS cmdlet removes TMS Instance from Translation Organizer.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Remove-ISHIntegrationTMS</maml:name> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Remove-ISHIntegrationTMS -ISHDeployment $deployment</dev:code> <dev:remarks> <maml:para>Removes TMS Instance from Translation Organizer. This command removes TMS Instance from Translation Organizer. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Set-ISHIntegrationTMS</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Set-ISHIntegrationTMS --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-ISHIntegrationTMS</command:name> <command:verb>Set</command:verb> <command:noun>ISHIntegrationTMS</command:noun> <maml:description> <maml:para>Sets configuration of TMS.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-ISHIntegrationTMS cmdlet sets configuration of TMS.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ApiSecret --> <command:syntaxItem> <maml:name>Set-ISHIntegrationTMS</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name (alias) of TMS.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Uri --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Uri</maml:name> <maml:description> <maml:para>The Uri to TMS.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UseSsl --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UseSsl</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MaximumJobSize --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaximumJobSize</maml:name> <maml:description> <maml:para>The max value of total size in bytes of uncompressed external job (externalJobMaxTotalUncompressedSizeBytes).</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>5242880</dev:defaultValue> </command:parameter> <!-- Parameter: RetriesOnTimeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RetriesOnTimeout</maml:name> <maml:description> <maml:para>The number of retries on timeout.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>3</dev:defaultValue> </command:parameter> <!-- Parameter: Mappings --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Mappings</maml:name> <maml:description> <maml:para>The mapping between ISHLanguage and TmsLanguage.</maml:para> </maml:description> <command:parameterValue required="true">ISHLanguageToTmsLanguageMapping[]</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.TranslationOrganizer.ISHLanguageToTmsLanguageMapping[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Templates --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Templates</maml:name> <maml:description> <maml:para>The TMS templates.</maml:para> </maml:description> <command:parameterValue required="true">TmsTemplate[]</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.TranslationOrganizer.TmsTemplate[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RequestMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequestMetadata</maml:name> <maml:description> <maml:para>The requested metadata.</maml:para> </maml:description> <command:parameterValue required="true">ISHFieldMetadata[]</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.TranslationOrganizer.ISHFieldMetadata[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: GroupMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>GroupMetadata</maml:name> <maml:description> <maml:para>The grouping metadata.</maml:para> </maml:description> <command:parameterValue required="true">ISHFieldMetadata[]</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.TranslationOrganizer.ISHFieldMetadata[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ApiKey --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ApiKey</maml:name> <maml:description> <maml:para>API key that is associated with a user.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SecretKey --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SecretKey</maml:name> <maml:description> <maml:para>Secret - API key encrypted using HMACSHA256 with the password.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: HttpTimeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>HttpTimeout</maml:name> <maml:description> <maml:para>The HTTP timeout. Supported since version 13.0.0 of CM</maml:para> </maml:description> <command:parameterValue required="true">TimeSpan</command:parameterValue> <dev:type> <maml:name>System.TimeSpan</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00:00:00</dev:defaultValue> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: PSCredential --> <command:syntaxItem> <maml:name>Set-ISHIntegrationTMS</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name (alias) of TMS.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Uri --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Uri</maml:name> <maml:description> <maml:para>The Uri to TMS.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UseSsl --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UseSsl</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MaximumJobSize --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaximumJobSize</maml:name> <maml:description> <maml:para>The max value of total size in bytes of uncompressed external job (externalJobMaxTotalUncompressedSizeBytes).</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>5242880</dev:defaultValue> </command:parameter> <!-- Parameter: RetriesOnTimeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RetriesOnTimeout</maml:name> <maml:description> <maml:para>The number of retries on timeout.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>3</dev:defaultValue> </command:parameter> <!-- Parameter: Mappings --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Mappings</maml:name> <maml:description> <maml:para>The mapping between ISHLanguage and TmsLanguage.</maml:para> </maml:description> <command:parameterValue required="true">ISHLanguageToTmsLanguageMapping[]</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.TranslationOrganizer.ISHLanguageToTmsLanguageMapping[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Templates --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Templates</maml:name> <maml:description> <maml:para>The TMS templates.</maml:para> </maml:description> <command:parameterValue required="true">TmsTemplate[]</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.TranslationOrganizer.TmsTemplate[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RequestMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequestMetadata</maml:name> <maml:description> <maml:para>The requested metadata.</maml:para> </maml:description> <command:parameterValue required="true">ISHFieldMetadata[]</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.TranslationOrganizer.ISHFieldMetadata[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: GroupMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>GroupMetadata</maml:name> <maml:description> <maml:para>The grouping metadata.</maml:para> </maml:description> <command:parameterValue required="true">ISHFieldMetadata[]</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.TranslationOrganizer.ISHFieldMetadata[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Credential --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The user credential to get access to TMS. Supported since version 13.0.3 of CM</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: HttpTimeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>HttpTimeout</maml:name> <maml:description> <maml:para>The HTTP timeout. Supported since version 13.0.0 of CM</maml:para> </maml:description> <command:parameterValue required="true">TimeSpan</command:parameterValue> <dev:type> <maml:name>System.TimeSpan</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00:00:00</dev:defaultValue> </command:parameter> <!-- Parameter: UserName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UserName</maml:name> <maml:description> <maml:para>The operation system user's name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserPassword --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UserPassword</maml:name> <maml:description> <maml:para>The operation system user's password.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: UserName/UserPassword --> <command:syntaxItem> <maml:name>Set-ISHIntegrationTMS</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name (alias) of TMS.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Uri --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Uri</maml:name> <maml:description> <maml:para>The Uri to TMS.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UseSsl --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UseSsl</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MaximumJobSize --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaximumJobSize</maml:name> <maml:description> <maml:para>The max value of total size in bytes of uncompressed external job (externalJobMaxTotalUncompressedSizeBytes).</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>5242880</dev:defaultValue> </command:parameter> <!-- Parameter: RetriesOnTimeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RetriesOnTimeout</maml:name> <maml:description> <maml:para>The number of retries on timeout.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>3</dev:defaultValue> </command:parameter> <!-- Parameter: Mappings --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Mappings</maml:name> <maml:description> <maml:para>The mapping between ISHLanguage and TmsLanguage.</maml:para> </maml:description> <command:parameterValue required="true">ISHLanguageToTmsLanguageMapping[]</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.TranslationOrganizer.ISHLanguageToTmsLanguageMapping[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Templates --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Templates</maml:name> <maml:description> <maml:para>The TMS templates.</maml:para> </maml:description> <command:parameterValue required="true">TmsTemplate[]</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.TranslationOrganizer.TmsTemplate[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RequestMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequestMetadata</maml:name> <maml:description> <maml:para>The requested metadata.</maml:para> </maml:description> <command:parameterValue required="true">ISHFieldMetadata[]</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.TranslationOrganizer.ISHFieldMetadata[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: GroupMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>GroupMetadata</maml:name> <maml:description> <maml:para>The grouping metadata.</maml:para> </maml:description> <command:parameterValue required="true">ISHFieldMetadata[]</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.TranslationOrganizer.ISHFieldMetadata[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Credential --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The user credential to get access to TMS. Supported since version 13.0.3 of CM</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: HttpTimeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>HttpTimeout</maml:name> <maml:description> <maml:para>The HTTP timeout. Supported since version 13.0.0 of CM</maml:para> </maml:description> <command:parameterValue required="true">TimeSpan</command:parameterValue> <dev:type> <maml:name>System.TimeSpan</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00:00:00</dev:defaultValue> </command:parameter> <!-- Parameter: UserName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>UserName</maml:name> <maml:description> <maml:para>The operation system user's name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserPassword --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>UserPassword</maml:name> <maml:description> <maml:para>The operation system user's password.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name (alias) of TMS.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Uri --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Uri</maml:name> <maml:description> <maml:para>The Uri to TMS.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UseSsl --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UseSsl</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MaximumJobSize --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaximumJobSize</maml:name> <maml:description> <maml:para>The max value of total size in bytes of uncompressed external job (externalJobMaxTotalUncompressedSizeBytes).</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>5242880</dev:defaultValue> </command:parameter> <!-- Parameter: RetriesOnTimeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RetriesOnTimeout</maml:name> <maml:description> <maml:para>The number of retries on timeout.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>3</dev:defaultValue> </command:parameter> <!-- Parameter: Mappings --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Mappings</maml:name> <maml:description> <maml:para>The mapping between ISHLanguage and TmsLanguage.</maml:para> </maml:description> <command:parameterValue required="true">ISHLanguageToTmsLanguageMapping[]</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.TranslationOrganizer.ISHLanguageToTmsLanguageMapping[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Templates --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Templates</maml:name> <maml:description> <maml:para>The TMS templates.</maml:para> </maml:description> <command:parameterValue required="true">TmsTemplate[]</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.TranslationOrganizer.TmsTemplate[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RequestMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequestMetadata</maml:name> <maml:description> <maml:para>The requested metadata.</maml:para> </maml:description> <command:parameterValue required="true">ISHFieldMetadata[]</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.TranslationOrganizer.ISHFieldMetadata[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: GroupMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>GroupMetadata</maml:name> <maml:description> <maml:para>The grouping metadata.</maml:para> </maml:description> <command:parameterValue required="true">ISHFieldMetadata[]</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.TranslationOrganizer.ISHFieldMetadata[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ApiKey --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ApiKey</maml:name> <maml:description> <maml:para>API key that is associated with a user.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SecretKey --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SecretKey</maml:name> <maml:description> <maml:para>Secret - API key encrypted using HMACSHA256 with the password.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Credential --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The user credential to get access to TMS. Supported since version 13.0.3 of CM</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: HttpTimeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>HttpTimeout</maml:name> <maml:description> <maml:para>The HTTP timeout. Supported since version 13.0.0 of CM</maml:para> </maml:description> <command:parameterValue required="true">TimeSpan</command:parameterValue> <dev:type> <maml:name>System.TimeSpan</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00:00:00</dev:defaultValue> </command:parameter> <!-- Parameter: UserName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>UserName</maml:name> <maml:description> <maml:para>The operation system user's name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserPassword --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>UserPassword</maml:name> <maml:description> <maml:para>The operation system user's password.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Set-ISHIntegrationTMS -ISHDeployment $deployment -Name "ws1" -Uri "https:\\ws1.sd.com" -MaximumJobSize 5242880 -RetriesOnTimeout 3 -ApiKey "someApiKey" -SecretKey "someSecretKey" -Mapping $mapping -Templates $templates</dev:code> <dev:remarks> <maml:para>This command enables the translation organizer windows service. The pair of -ApiKey and -SecretKey parameters ​​is used for authorization with TMS server. Parameter -MaximumJobSize is the max value of total size in bytes of uncompressed external job. In the TMS configuration section, this parameter has name "externalJobMaxTotalUncompressedSizeBytes". Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet. Parameter $mapping is a object with pair of properties, where ISHLanguage is InfoShare language identifier retrieved from New-ISHIntegrationTMSMapping cmdlet.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\>Set-ISHIntegrationTMS -ISHDeployment $deployment -Name "ws1" -Uri "https:\\ws1.sd.com" -MaximumJobSize 5242880 -RetriesOnTimeout 3 -Credential $credential -Mapping $mapping -Templates $templates</dev:code> <dev:remarks> <maml:para>This command enables the translation organizer windows service and does authorization with TMS server by using of pair of username and password values. Parameter $credential is PSCredential object with username and password which is supported starting from 13.0.3 version of CM. Parameter -MaximumJobSize is the max value of total size in bytes of uncompressed external job. In the TMS configuration section, this parameter has name "externalJobMaxTotalUncompressedSizeBytes". Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet. Parameter $mapping is a object with pair of properties, where ISHLanguage is InfoShare language identifier retrieved from New-ISHIntegrationTMSMapping cmdlet.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\>Set-ISHIntegrationTMS -ISHDeployment $deployment -Name "ws1" -Uri "https:\\ws1.sd.com" -MaximumJobSize 5242880 -RetriesOnTimeout 3 -UserName $userName -UserPassword $userPassword -Mapping $mapping -Templates $templates</dev:code> <dev:remarks> <maml:para>This command enables the translation organizer windows service and does authorization with TMS server by using of pair of username and password values. Parameter $userName is operation system's user name. Parameter $userPassword is operation system's user password. Parameter -MaximumJobSize is the max value of total size in bytes of uncompressed external job. In the TMS configuration section, this parameter has name "externalJobMaxTotalUncompressedSizeBytes". Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet. Parameter $mapping is a object with pair of properties, where ISHLanguage is InfoShare language identifier retrieved from New-ISHIntegrationTMSMapping cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-ISHIntegrationTMSMapping</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-ISHIntegrationTMSTemplate</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-ISHFieldMetadata</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-ISHIntegrationTMS</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: New-ISHIntegrationTMSMapping --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-ISHIntegrationTMSMapping</command:name> <command:verb>New</command:verb> <command:noun>ISHIntegrationTMSMapping</command:noun> <maml:description> <maml:para>Creates a new mapping pair ISHLanguage to TmsLanguage.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The New-ISHIntegrationTMSMapping cmdlet creates an object with pair of properties, where ISHLanguage is InfoShare language identifier (example: "en") and TmsLanguage is language identifier of TMS (example: "EN-US").</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>New-ISHIntegrationTMSMapping</maml:name> <!-- Parameter: TmsLanguage --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TmsLanguage</maml:name> <maml:description> <maml:para>The language identifier of TMS.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHLanguage --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHLanguage</maml:name> <maml:description> <maml:para>The trisoft language identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: TmsLanguage --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TmsLanguage</maml:name> <maml:description> <maml:para>The language identifier of TMS.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHLanguage --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHLanguage</maml:name> <maml:description> <maml:para>The trisoft language identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>New-ISHIntegrationTMSMapping -ISHLanguage "en" -TmsLanguage "EN-US"</dev:code> <dev:remarks> <maml:para>This command creates new object for English language where ID of the same language on TMS is EN-US.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Set-ISHIntegrationTMS</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: New-ISHIntegrationTMSTemplate --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-ISHIntegrationTMSTemplate</command:name> <command:verb>New</command:verb> <command:noun>ISHIntegrationTMSTemplate</command:noun> <maml:description> <maml:para>Creates a new ISH Template Field for TMS in Translation Organizer.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The New-ISHIntegrationTMSTemplate cmdlet creates an object with pair of properties: Template ID and Name. Used for tms translation integration.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>New-ISHIntegrationTMSTemplate</maml:name> <!-- Parameter: TemplateId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TemplateId</maml:name> <maml:description> <maml:para>The TMS template Id.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of TMS template.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: TemplateId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TemplateId</maml:name> <maml:description> <maml:para>The TMS template Id.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of TMS template.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>New-ISHIntegrationTMSTemplate -Name "testName" -TemplateId "testTemplateId"</dev:code> <dev:remarks> <maml:para>This command creates new object with metadata with name testName, level testLevel and valuetype testValueType.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Set-ISHIntegrationTMS</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Remove-ISHIntegrationWorldServer --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-ISHIntegrationWorldServer</command:name> <command:verb>Remove</command:verb> <command:noun>ISHIntegrationWorldServer</command:noun> <maml:description> <maml:para>World Server Instance from Translation Organizer.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Remove-ISHIntegrationWorldServer cmdlet removes World Server Instance from Translation Organizer.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Remove-ISHIntegrationWorldServer</maml:name> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Remove-ISHIntegrationWorldServer -ISHDeployment $deployment</dev:code> <dev:remarks> <maml:para>Removes World Server Instance from Translation Organizer. This command removes World Server Instance from Translation Organizer. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Set-ISHIntegrationWorldServer</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Set-ISHIntegrationWorldServer --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-ISHIntegrationWorldServer</command:name> <command:verb>Set</command:verb> <command:noun>ISHIntegrationWorldServer</command:noun> <maml:description> <maml:para>Sets configuration of WorldServer.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-ISHIntegrationWorldServer cmdlet sets configuration of WorldServer.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: SOAP --> <command:syntaxItem> <maml:name>Set-ISHIntegrationWorldServer</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name (alias) of WorldServer.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Uri --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Uri</maml:name> <maml:description> <maml:para>The Uri to WorldServer.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MaximumJobSize --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaximumJobSize</maml:name> <maml:description> <maml:para>The max value of total size in bytes of uncompressed external job (externalJobMaxTotalUncompressedSizeBytes).</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>5242880</dev:defaultValue> </command:parameter> <!-- Parameter: RetriesOnTimeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RetriesOnTimeout</maml:name> <maml:description> <maml:para>The number of retries on timeout.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>3</dev:defaultValue> </command:parameter> <!-- Parameter: Timeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>The HTTP timeout (Used for REST client only). Supported since version 13.0.3 of CM</maml:para> </maml:description> <command:parameterValue required="true">TimeSpan</command:parameterValue> <dev:type> <maml:name>System.TimeSpan</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00:00:00</dev:defaultValue> </command:parameter> <!-- Parameter: SOAP --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SOAP</maml:name> <maml:description> <maml:para>The type of the API Protocol. Supported since version 13.0.3 of CM</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Mappings --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Mappings</maml:name> <maml:description> <maml:para>The mapping between trisoftLanguage and worldServerLocaleId.</maml:para> </maml:description> <command:parameterValue required="true">ISHLanguageToWorldServerLocaleIdMapping[]</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.TranslationOrganizer.ISHLanguageToWorldServerLocaleIdMapping[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: PSCredential --> <command:syntaxItem> <maml:name>Set-ISHIntegrationWorldServer</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name (alias) of WorldServer.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Uri --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Uri</maml:name> <maml:description> <maml:para>The Uri to WorldServer.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MaximumJobSize --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaximumJobSize</maml:name> <maml:description> <maml:para>The max value of total size in bytes of uncompressed external job (externalJobMaxTotalUncompressedSizeBytes).</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>5242880</dev:defaultValue> </command:parameter> <!-- Parameter: RetriesOnTimeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RetriesOnTimeout</maml:name> <maml:description> <maml:para>The number of retries on timeout.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>3</dev:defaultValue> </command:parameter> <!-- Parameter: Timeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>The HTTP timeout (Used for REST client only). Supported since version 13.0.3 of CM</maml:para> </maml:description> <command:parameterValue required="true">TimeSpan</command:parameterValue> <dev:type> <maml:name>System.TimeSpan</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00:00:00</dev:defaultValue> </command:parameter> <!-- Parameter: Mappings --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Mappings</maml:name> <maml:description> <maml:para>The mapping between trisoftLanguage and worldServerLocaleId.</maml:para> </maml:description> <command:parameterValue required="true">ISHLanguageToWorldServerLocaleIdMapping[]</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.TranslationOrganizer.ISHLanguageToWorldServerLocaleIdMapping[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Credential --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The credential that will be set.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UserName</maml:name> <maml:description> <maml:para>The operation system user's name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserPassword --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UserPassword</maml:name> <maml:description> <maml:para>The operation system user's password.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: UserName/UserPassword --> <command:syntaxItem> <maml:name>Set-ISHIntegrationWorldServer</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name (alias) of WorldServer.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Uri --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Uri</maml:name> <maml:description> <maml:para>The Uri to WorldServer.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MaximumJobSize --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaximumJobSize</maml:name> <maml:description> <maml:para>The max value of total size in bytes of uncompressed external job (externalJobMaxTotalUncompressedSizeBytes).</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>5242880</dev:defaultValue> </command:parameter> <!-- Parameter: RetriesOnTimeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RetriesOnTimeout</maml:name> <maml:description> <maml:para>The number of retries on timeout.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>3</dev:defaultValue> </command:parameter> <!-- Parameter: Timeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>The HTTP timeout (Used for REST client only). Supported since version 13.0.3 of CM</maml:para> </maml:description> <command:parameterValue required="true">TimeSpan</command:parameterValue> <dev:type> <maml:name>System.TimeSpan</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00:00:00</dev:defaultValue> </command:parameter> <!-- Parameter: Mappings --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Mappings</maml:name> <maml:description> <maml:para>The mapping between trisoftLanguage and worldServerLocaleId.</maml:para> </maml:description> <command:parameterValue required="true">ISHLanguageToWorldServerLocaleIdMapping[]</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.TranslationOrganizer.ISHLanguageToWorldServerLocaleIdMapping[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Credential --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The credential that will be set.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>UserName</maml:name> <maml:description> <maml:para>The operation system user's name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserPassword --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>UserPassword</maml:name> <maml:description> <maml:para>The operation system user's password.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name (alias) of WorldServer.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Uri --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Uri</maml:name> <maml:description> <maml:para>The Uri to WorldServer.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MaximumJobSize --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaximumJobSize</maml:name> <maml:description> <maml:para>The max value of total size in bytes of uncompressed external job (externalJobMaxTotalUncompressedSizeBytes).</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>5242880</dev:defaultValue> </command:parameter> <!-- Parameter: RetriesOnTimeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RetriesOnTimeout</maml:name> <maml:description> <maml:para>The number of retries on timeout.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>3</dev:defaultValue> </command:parameter> <!-- Parameter: Timeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>The HTTP timeout (Used for REST client only). Supported since version 13.0.3 of CM</maml:para> </maml:description> <command:parameterValue required="true">TimeSpan</command:parameterValue> <dev:type> <maml:name>System.TimeSpan</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00:00:00</dev:defaultValue> </command:parameter> <!-- Parameter: SOAP --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SOAP</maml:name> <maml:description> <maml:para>The type of the API Protocol. Supported since version 13.0.3 of CM</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Mappings --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Mappings</maml:name> <maml:description> <maml:para>The mapping between trisoftLanguage and worldServerLocaleId.</maml:para> </maml:description> <command:parameterValue required="true">ISHLanguageToWorldServerLocaleIdMapping[]</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.TranslationOrganizer.ISHLanguageToWorldServerLocaleIdMapping[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Credential --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The credential that will be set.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>UserName</maml:name> <maml:description> <maml:para>The operation system user's name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserPassword --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>UserPassword</maml:name> <maml:description> <maml:para>The operation system user's password.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Set-ISHIntegrationWorldServer -ISHDeployment $deployment -Name "ws1" -Uri "https:\\ws1.sd.com" -Credential $credential -MaximumJobSize 5242880 -RetriesOnTimeout 3 -Mapping $mapping </dev:code> <dev:remarks> <maml:para>This command enables the translation organizer windows service. Parameter -MaximumJobSize is the max value of total size in bytes of uncompressed external job. In the WorldServer configuration section, this parameter has name "externalJobMaxTotalUncompressedSizeBytes". Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet. Parameter $credential is a set of security credentials, such as a user name and a password. Parameter $mapping is a object with pair of properties, where ISHLanguage is InfoShare language identifier retrieved from New-ISHIntegrationWorldServerMapping cmdlet.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\>Set-ISHIntegrationWorldServer -ISHDeployment $deployment -Name "ws1" -Uri "https:\\ws1.sd.com" -UserName $userName -UserPassword $userPassword -MaximumJobSize 5242880 -RetriesOnTimeout 3 -Mapping $mapping </dev:code> <dev:remarks> <maml:para>This command enables the translation organizer windows service. Parameter -MaximumJobSize is the max value of total size in bytes of uncompressed external job. In the WorldServer configuration section, this parameter has name "externalJobMaxTotalUncompressedSizeBytes". Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet. Parameter $userName is operation system's user name. Parameter $userPassword is operation system's user password. Parameter $mapping is a object with pair of properties, where ISHLanguage is InfoShare language identifier retrieved from New-ISHIntegrationWorldServerMapping cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-ISHIntegrationWorldServerMapping</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-ISHServiceTranslationOrganizer</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-ISHIntegrationWorldServer</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: New-ISHIntegrationWorldServerMapping --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-ISHIntegrationWorldServerMapping</command:name> <command:verb>New</command:verb> <command:noun>ISHIntegrationWorldServerMapping</command:noun> <maml:description> <maml:para>Creates a new mapping pair ISHLanguage to WSLocaleID.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The New-ISHIntegrationWorldServerMapping cmdlet creates an object with pair of properties, where ISHLanguage is InfoShare language identifier (example: "en") and WSLocaleID is language identifier of WorldServer (example: "1145").</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>New-ISHIntegrationWorldServerMapping</maml:name> <!-- Parameter: ISHLanguage --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHLanguage</maml:name> <maml:description> <maml:para>The trisoft language identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: WSLocaleID --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WSLocaleID</maml:name> <maml:description> <maml:para>The language identifier of WorldServer.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ISHLanguage --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHLanguage</maml:name> <maml:description> <maml:para>The trisoft language identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: WSLocaleID --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WSLocaleID</maml:name> <maml:description> <maml:para>The language identifier of WorldServer.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>New-ISHIntegrationWorldServerMapping -ISHLanguage "en" -WSLocaleID 1145</dev:code> <dev:remarks> <maml:para>This command creates new object for English language where ID of the same language on WorldLocale is 1145.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Set-ISHIntegrationWorldServer </maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Invoke-ISHMaintenance --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Invoke-ISHMaintenance</command:name> <command:verb>Invoke</command:verb> <command:noun>ISHMaintenance</command:noun> <maml:description> <maml:para>Maintenance Crawler or FullTextIndex services.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Invoke-ISHMaintenance cmdlet maintenances Crawler or FullTextIndex services.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Register --> <command:syntaxItem> <maml:name>Invoke-ISHMaintenance</maml:name> <!-- Parameter: Crawler --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Crawler</maml:name> <maml:description> <maml:para>Maintenance the Crawler service. Registering the Crawler for 'TrisoftInfoShareIndex' on 'UADEVVMASKYMENK'.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Register --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Register</maml:name> <maml:description> <maml:para>Register the Crawler.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: UnRegisterAll --> <command:syntaxItem> <maml:name>Invoke-ISHMaintenance</maml:name> <!-- Parameter: Crawler --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Crawler</maml:name> <maml:description> <maml:para>Maintenance the Crawler service. Registering the Crawler for 'TrisoftInfoShareIndex' on 'UADEVVMASKYMENK'.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: UnRegisterAll --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>UnRegisterAll</maml:name> <maml:description> <maml:para>Unregister the Crawler.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ReIndex --> <command:syntaxItem> <maml:name>Invoke-ISHMaintenance</maml:name> <!-- Parameter: Crawler --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Crawler</maml:name> <maml:description> <maml:para>Maintenance the Crawler service. Registering the Crawler for 'TrisoftInfoShareIndex' on 'UADEVVMASKYMENK'.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ReIndex --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ReIndex</maml:name> <maml:description> <maml:para>Reindex the Crawler.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ReIndexCardType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ReIndexCardType</maml:name> <maml:description> <maml:para>The ReIndex card type.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>ISHAll</dev:defaultValue> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: CleanupSolrLucene --> <command:syntaxItem> <maml:name>Invoke-ISHMaintenance</maml:name> <!-- Parameter: FullTextIndex --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>FullTextIndex</maml:name> <maml:description> <maml:para>Cleanup FullTextIndex.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Cleanup --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Cleanup</maml:name> <maml:description> <maml:para>Cleanup FullTextIndex.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Crawler --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Crawler</maml:name> <maml:description> <maml:para>Maintenance the Crawler service. Registering the Crawler for 'TrisoftInfoShareIndex' on 'UADEVVMASKYMENK'.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Register --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Register</maml:name> <maml:description> <maml:para>Register the Crawler.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: UnRegisterAll --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>UnRegisterAll</maml:name> <maml:description> <maml:para>Unregister the Crawler.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ReIndex --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ReIndex</maml:name> <maml:description> <maml:para>Reindex the Crawler.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ReIndexCardType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ReIndexCardType</maml:name> <maml:description> <maml:para>The ReIndex card type.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>ISHAll</dev:defaultValue> </command:parameter> <!-- Parameter: FullTextIndex --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>FullTextIndex</maml:name> <maml:description> <maml:para>Cleanup FullTextIndex.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Cleanup --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Cleanup</maml:name> <maml:description> <maml:para>Cleanup FullTextIndex.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Invoke-ISHMaintenance -ISHDeployment $deployment -Crawler -Register</dev:code> <dev:remarks> <maml:para>This command registers the Crawler for 'TrisoftInfoShareIndex' for specified deployment. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\>Invoke-ISHMaintenance -ISHDeployment $deployment -Crawler -UnRegisterAll</dev:code> <dev:remarks> <maml:para>This command unregisters the Crawler for 'TrisoftInfoShareIndex' for specified deployment. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\>Invoke-ISHMaintenance -ISHDeployment $deployment -Crawler -ReIndex</dev:code> <dev:remarks> <maml:para>This command does reindex of the Crawler for 'TrisoftInfoShareIndex' for specified deployment. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>PS C:\>Invoke-ISHMaintenance -ISHDeployment $deployment -FullTextIndex -Cleanup</dev:code> <dev:remarks> <maml:para>This command cleans up all cache and temporary files of Crawler for specified deployment. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-ISHOSUser --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-ISHOSUser</command:name> <command:verb>Set</command:verb> <command:noun>ISHOSUser</command:noun> <maml:description> <maml:para>Sets OS user credentials.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-ISHOSUser cmdlet sets new security credentials of OS user.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: PSCredential --> <command:syntaxItem> <maml:name>Set-ISHOSUser</maml:name> <!-- Parameter: Credential --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The credential that will be set.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UserName</maml:name> <maml:description> <maml:para>The operation system user's name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserPassword --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UserPassword</maml:name> <maml:description> <maml:para>The operation system user's password.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: UserName/UserPassword --> <command:syntaxItem> <maml:name>Set-ISHOSUser</maml:name> <!-- Parameter: Credential --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The credential that will be set.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>UserName</maml:name> <maml:description> <maml:para>The operation system user's name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserPassword --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>UserPassword</maml:name> <maml:description> <maml:para>The operation system user's password.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Credential --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The credential that will be set.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>UserName</maml:name> <maml:description> <maml:para>The operation system user's name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserPassword --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>UserPassword</maml:name> <maml:description> <maml:para>The operation system user's password.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Set-ISHOSUser -ISHDeployment $deployment -Credential $credential</dev:code> <dev:remarks> <maml:para>This command sets new OS user credentials. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\>Set-ISHOSUser -ISHDeployment $deployment -UserName $userName -UserPassword $userPassword</dev:code> <dev:remarks> <maml:para>This command sets new OS user credentials. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Set-ISHServiceUser</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-ISHActor</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-ISHPackageFolderPath --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-ISHPackageFolderPath</command:name> <command:verb>Get</command:verb> <command:noun>ISHPackageFolderPath</command:noun> <maml:description> <maml:para>Gets the path of a folder where the commandlets output files or packages or use them as input.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-ISHPackageFolderPath cmdlet gets the path of a folder where the commandlets output files or packages or use them as input. This folder is specific per deployment. The folder contains archives or files that were created as output of other cmdlets of the module. The folder contains also archives or files that are used as input to other cmdlets of the module.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-ISHPackageFolderPath</maml:name> <!-- Parameter: UNC --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UNC</maml:name> <maml:description> <maml:para>Return path in UNC format.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: UNC --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UNC</maml:name> <maml:description> <maml:para>Return path in UNC format.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Get-ISHPackageFolderPath -ISHDeployment $deployment -UNC</dev:code> <dev:remarks> <maml:para>This command gets the UNC path to Packages folder for Content Manager deployment. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Set-ISHCMCUILResourceGroup</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Disable-ISHServiceBackgroundTask --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Disable-ISHServiceBackgroundTask</command:name> <command:verb>Disable</command:verb> <command:noun>ISHServiceBackgroundTask</command:noun> <maml:description> <maml:para>Disables BackgroundTask windows service.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Disable-ISHServiceBackgroundTask cmdlet disables BackgroundTask windows service.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Disable-ISHServiceBackgroundTask</maml:name> <!-- Parameter: Role --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Role</maml:name> <maml:description> <maml:para>The role of BackgroundTask services.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Role --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Role</maml:name> <maml:description> <maml:para>The role of BackgroundTask services.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Disable-ISHServiceBackgroundTask -ISHDeployment $deployment</dev:code> <dev:remarks> <maml:para>This command disables BackgroundTask windows service. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Enable-ISHServiceBackgroundTask</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-ISHServiceBackgroundTask</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ISHServiceBackgroundTask</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-ISHServiceBackgroundTask</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Enable-ISHServiceBackgroundTask --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Enable-ISHServiceBackgroundTask</command:name> <command:verb>Enable</command:verb> <command:noun>ISHServiceBackgroundTask</command:noun> <maml:description> <maml:para>Enables BackgroundTask windows service.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Enable-ISHServiceBackgroundTask cmdlet enables BackgroundTask windows service.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Enable-ISHServiceBackgroundTask</maml:name> <!-- Parameter: Role --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Role</maml:name> <maml:description> <maml:para>The role of BackgroundTask services.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Role --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Role</maml:name> <maml:description> <maml:para>The role of BackgroundTask services.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Enable-ISHServiceBackgroundTask -ISHDeployment $deployment</dev:code> <dev:remarks> <maml:para>This command enables the BackgroundTask windows service. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Disable-ISHServiceBackgroundTask</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-ISHServiceBackgroundTask</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ISHServiceBackgroundTask</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-ISHServiceBackgroundTask</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-ISHServiceBackgroundTask --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-ISHServiceBackgroundTask</command:name> <command:verb>Get</command:verb> <command:noun>ISHServiceBackgroundTask</command:noun> <maml:description> <maml:para>Gets list of windows services for BackgroundTask.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-ISHServiceBackgroundTask cmdlet gets list of BackgroundTask windows services.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-ISHServiceBackgroundTask</maml:name> <!-- Parameter: Role --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Role</maml:name> <maml:description> <maml:para>The role of BackgroundTask services.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Role --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Role</maml:name> <maml:description> <maml:para>The role of BackgroundTask services.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Get-ISHServiceBackgroundTask -ISHDeployment $deployment</dev:code> <dev:remarks> <maml:para>This command shows the BackgroundTask windows services. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\>Get-ISHServiceBackgroundTask -ISHDeployment $deployment -Role "PublishOnly"</dev:code> <dev:remarks> <maml:para>This command shows the BackgroundTask windows services with role "PublishOnly". Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Set-ISHServiceBackgroundTask</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-ISHServiceBackgroundTask</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-ISHServiceBackgroundTask</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-ISHServiceBackgroundTask</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Remove-ISHServiceBackgroundTask --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-ISHServiceBackgroundTask</command:name> <command:verb>Remove</command:verb> <command:noun>ISHServiceBackgroundTask</command:noun> <maml:description> <maml:para>Removes BackgroundTask windows service.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Remove-ISHServiceBackgroundTask cmdlet removes all BackgroundTask windows services of specified role.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Remove-ISHServiceBackgroundTask</maml:name> <!-- Parameter: Role --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Role</maml:name> <maml:description> <maml:para>The role of BackgroundTask services.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Role --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Role</maml:name> <maml:description> <maml:para>The role of BackgroundTask services.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Remove-ISHServiceBackgroundTask -ISHDeployment $deployment</dev:code> <dev:remarks> <maml:para>This command removes all instances of BackgroundTask windows services of Default role. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\>Remove-ISHServiceBackgroundTask -ISHDeployment $deployment -Role "PublishOnly"</dev:code> <dev:remarks> <maml:para>This command removes all instances of BackgroundTask windows services with role "PublishOnly". Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Enable-ISHServiceBackgroundTask</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-ISHServiceBackgroundTask</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ISHServiceBackgroundTask</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-ISHServiceBackgroundTask</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Set-ISHServiceBackgroundTask --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-ISHServiceBackgroundTask</command:name> <command:verb>Set</command:verb> <command:noun>ISHServiceBackgroundTask</command:noun> <maml:description> <maml:para>Sets BackgroundTask windows service.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-ISHServiceBackgroundTask cmdlet sets BackgroundTask windows service.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-ISHServiceBackgroundTask</maml:name> <!-- Parameter: Count --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Count</maml:name> <maml:description> <maml:para>The number of BackgroundTask services in the system.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Role --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Role</maml:name> <maml:description> <maml:para>The role of BackgroundTask services.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Count --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Count</maml:name> <maml:description> <maml:para>The number of BackgroundTask services in the system.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Role --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Role</maml:name> <maml:description> <maml:para>The role of BackgroundTask services.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Set-ISHServiceBackgroundTask -ISHDeployment $deployment -Count 2</dev:code> <dev:remarks> <maml:para>This command changes the amount of instances of services. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\>Set-ISHServiceBackgroundTask -ISHDeployment $deployment -Count 2 -Role "PublishOnly"</dev:code> <dev:remarks> <maml:para>This command changes the amount of instances of services with role "PublishOnly". Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Enable-ISHServiceBackgroundTask</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-ISHServiceBackgroundTask</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ISHServiceBackgroundTask</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-ISHServiceBackgroundTask</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Disable-ISHServiceCrawler --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Disable-ISHServiceCrawler</command:name> <command:verb>Disable</command:verb> <command:noun>ISHServiceCrawler</command:noun> <maml:description> <maml:para>Disables Crawler windows service.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Disable-ISHServiceCrawler cmdlet disables Crawler windows service.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Disable-ISHServiceCrawler</maml:name> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Disable-ISHServiceCrawler -ISHDeployment $deployment</dev:code> <dev:remarks> <maml:para>This command disables Crawler windows service. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Enable-ISHServiceCrawler</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-ISHServiceCrawler</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ISHServiceCrawler</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Enable-ISHServiceCrawler --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Enable-ISHServiceCrawler</command:name> <command:verb>Enable</command:verb> <command:noun>ISHServiceCrawler</command:noun> <maml:description> <maml:para>Enables Crawler windows service.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Enable-ISHServiceCrawler cmdlet enables Crawler windows service.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Enable-ISHServiceCrawler</maml:name> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Enable-ISHServiceCrawler -ISHDeployment $deployment</dev:code> <dev:remarks> <maml:para>This command enables the Crawler windows service. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Disable-ISHServiceCrawler</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-ISHServiceCrawler</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ISHServiceCrawler</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-ISHServiceCrawler --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-ISHServiceCrawler</command:name> <command:verb>Get</command:verb> <command:noun>ISHServiceCrawler</command:noun> <maml:description> <maml:para>Gets list of windows services for Crawler.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-ISHServiceCrawler cmdlet gets list of Crawler windows services.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-ISHServiceCrawler</maml:name> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Get-ISHServiceCrawler -ISHDeployment $deployment</dev:code> <dev:remarks> <maml:para>This command shows the Crawler windows services. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Set-ISHServiceCrawler</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-ISHServiceCrawler</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-ISHServiceCrawler</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Set-ISHServiceCrawler --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-ISHServiceCrawler</command:name> <command:verb>Set</command:verb> <command:noun>ISHServiceCrawler</command:noun> <maml:description> <maml:para>Sets settings of Crawler services.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-ISHServiceCrawler cmdlet sets settings of Crawler services.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-ISHServiceCrawler</maml:name> <!-- Parameter: Count --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Count</maml:name> <maml:description> <maml:para>The number of Crawler services in the system.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Hostname --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Hostname</maml:name> <maml:description> <maml:para>The Hostname of Crawler service.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Catalog --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Catalog</maml:name> <maml:description> <maml:para>The Catalog of Crawler service.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Count --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Count</maml:name> <maml:description> <maml:para>The number of Crawler services in the system.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Hostname --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Hostname</maml:name> <maml:description> <maml:para>The Hostname of Crawler service.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Catalog --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Catalog</maml:name> <maml:description> <maml:para>The Catalog of Crawler service.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Set-ISHServiceCrawler -ISHDeployment $deployment -Count 2</dev:code> <dev:remarks> <maml:para>This command changes the amount of instances of Crawler services. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\>Set-ISHServiceCrawler -ISHDeployment $deployment -Hostname "testmachinename"</dev:code> <dev:remarks> <maml:para>This command changes the hostname of instances of Crawler services. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\>Set-ISHServiceCrawler -ISHDeployment $deployment -Catalog "TrisoftInfoShareIndex"</dev:code> <dev:remarks> <maml:para>This command changes the catalog name of instances of Crawler services. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Enable-ISHServiceCrawler</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-ISHServiceCrawler</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ISHServiceCrawler</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Disable-ISHServiceFontoDeltaXml --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Disable-ISHServiceFontoDeltaXml</command:name> <command:verb>Disable</command:verb> <command:noun>ISHServiceFontoDeltaXml</command:noun> <maml:description> <maml:para>Disables Fonto Delta Xml windows service. This cmdlet is only supported on version 14.0.2.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Disable-ISHServiceFontoDeltaXml cmdlet disables Fonto Delta Xml windows service.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Disable-ISHServiceFontoDeltaXml</maml:name> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Disable-ISHServiceFontoDeltaXml -ISHDeployment $deployment</dev:code> <dev:remarks> <maml:para>This command disables the Fonto Delta Xml windows service. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Set-ISHServiceFontoDeltaXml</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ISHServiceFontoDeltaXml</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-ISHServiceFontoDeltaXml</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Enable-ISHServiceFontoDeltaXml --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Enable-ISHServiceFontoDeltaXml</command:name> <command:verb>Enable</command:verb> <command:noun>ISHServiceFontoDeltaXml</command:noun> <maml:description> <maml:para>Enables Fonto Delta Xml windows service. This cmdlet is only supported on version 14.0.2.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Enable-ISHServiceFontoDeltaXml cmdlet enables Fonto Delta Xml windows service.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Enable-ISHServiceFontoDeltaXml</maml:name> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Enable-ISHServiceFontoDeltaXml -ISHDeployment $deployment</dev:code> <dev:remarks> <maml:para>This command enables the Fonto Delta Xml windows service. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Set-ISHServiceFontoDeltaXml</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ISHServiceFontoDeltaXml</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-ISHServiceFontoDeltaXml</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-ISHServiceFontoDeltaXml --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-ISHServiceFontoDeltaXml</command:name> <command:verb>Get</command:verb> <command:noun>ISHServiceFontoDeltaXml</command:noun> <maml:description> <maml:para>Gets list of windows services for Fonto Delta Xml. This cmdlet is only supported on version 14.0.2.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-ISHServiceFontoDeltaXml cmdlet gets list of Fonto Delta Xml windows services.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-ISHServiceFontoDeltaXml</maml:name> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Get-ISHServiceFontoDeltaXml -ISHDeployment $deployment</dev:code> <dev:remarks> <maml:para>This command shows the Fonto Delta Xml windows services. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Set-ISHServiceFontoDeltaXml</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-ISHServiceFontoDeltaXml</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-ISHServiceFontoDeltaXml</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Set-ISHServiceFontoDeltaXml --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-ISHServiceFontoDeltaXml</command:name> <command:verb>Set</command:verb> <command:noun>ISHServiceFontoDeltaXml</command:noun> <maml:description> <maml:para>Sets target port for Fonto Delta Xml. This cmdlet is only supported on version 14.0.2.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-ISHServiceFontoDeltaXml cmdlet sets target port for Fonto Delta Xml.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Service port --> <command:syntaxItem> <maml:name>Set-ISHServiceFontoDeltaXml</maml:name> <!-- Parameter: ServicePort --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ServicePort</maml:name> <maml:description> <maml:para>The target FontoDeltaXml port.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Configuration --> <command:syntaxItem> <maml:name>Set-ISHServiceFontoDeltaXml</maml:name> <!-- Parameter: ServicePort --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ServicePort</maml:name> <maml:description> <maml:para>The target FontoDeltaXml port.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Xmx --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Xmx</maml:name> <maml:description> <maml:para>Maximum heap size of internal java process.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Heap Size --> <command:syntaxItem> <maml:name>Set-ISHServiceFontoDeltaXml</maml:name> <!-- Parameter: Xmx --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Xmx</maml:name> <maml:description> <maml:para>Maximum heap size of internal java process.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ServicePort --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ServicePort</maml:name> <maml:description> <maml:para>The target FontoDeltaXml port.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Xmx --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Xmx</maml:name> <maml:description> <maml:para>Maximum heap size of internal java process.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Set-ISHServiceFontoDeltaXml -ISHDeployment $deployment -ServicePort 8010</dev:code> <dev:remarks> <maml:para>This command sets the Fonto Delta Xml target port. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\>Set-ISHServiceFontoDeltaXml -ISHDeployment $deployment -Xmx 1024k</dev:code> <dev:remarks> <maml:para>This command sets maximum of heap size for internal java process of the Fonto Delta Xml. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\>Set-ISHServiceFontoDeltaXml -ISHDeployment $deployment -Xmx 1024k -ServicePort 8010</dev:code> <dev:remarks> <maml:para>This command sets maximum of heap size for internal java process and target port of the Fonto Delta Xml. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-ISHServiceFontoDeltaXml</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-ISHServiceFontoDeltaXml</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-ISHServiceFontoDeltaXml</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Disable-ISHServiceFontoDocumentHistory --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Disable-ISHServiceFontoDocumentHistory</command:name> <command:verb>Disable</command:verb> <command:noun>ISHServiceFontoDocumentHistory</command:noun> <maml:description> <maml:para>Disables Fonto Document History windows service.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Disable-ISHServiceFontoDocumentHistory cmdlet disables Fonto Document History windows service.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Disable-ISHServiceFontoDocumentHistory</maml:name> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Disable-ISHServiceFontoDocumentHistory -ISHDeployment $deployment</dev:code> <dev:remarks> <maml:para>This command disables the Fonto Document History windows service. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Set-ISHServiceFontoDocumentHistory</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ISHServiceFontoDocumentHistory</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-ISHServiceFontoDocumentHistory</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Enable-ISHServiceFontoDocumentHistory --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Enable-ISHServiceFontoDocumentHistory</command:name> <command:verb>Enable</command:verb> <command:noun>ISHServiceFontoDocumentHistory</command:noun> <maml:description> <maml:para>Enables Fonto Document History windows service.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Enable-ISHServiceFontoDocumentHistory cmdlet enables Fonto Document History windows service.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Enable-ISHServiceFontoDocumentHistory</maml:name> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Enable-ISHServiceFontoDocumentHistory -ISHDeployment $deployment</dev:code> <dev:remarks> <maml:para>This command enables the Fonto Document History windows service. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Set-ISHServiceFontoDocumentHistory</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ISHServiceFontoDocumentHistory</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-ISHServiceFontoDocumentHistory</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-ISHServiceFontoDocumentHistory --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-ISHServiceFontoDocumentHistory</command:name> <command:verb>Get</command:verb> <command:noun>ISHServiceFontoDocumentHistory</command:noun> <maml:description> <maml:para>Gets list of windows services for Fonto Document History.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-ISHServiceFontoDocumentHistory cmdlet gets list of Fonto Document History windows services.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-ISHServiceFontoDocumentHistory</maml:name> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Get-ISHServiceFontoDocumentHistory -ISHDeployment $deployment</dev:code> <dev:remarks> <maml:para>This command shows the Fonto Document History windows services. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Set-ISHServiceFontoDocumentHistory</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-ISHServiceFontoDocumentHistory</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-ISHServiceFontoDocumentHistory</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Set-ISHServiceFontoDocumentHistory --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-ISHServiceFontoDocumentHistory</command:name> <command:verb>Set</command:verb> <command:noun>ISHServiceFontoDocumentHistory</command:noun> <maml:description> <maml:para>Sets service port for Fonto Document History.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-ISHServiceFontoDocumentHistory cmdlet sets service port for Fonto Document History.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-ISHServiceFontoDocumentHistory</maml:name> <!-- Parameter: ServicePort --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ServicePort</maml:name> <maml:description> <maml:para>The target FontoDocumentHistory service port.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ServicePort --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ServicePort</maml:name> <maml:description> <maml:para>The target FontoDocumentHistory service port.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Set-ISHServiceFontoDocumentHistory -ISHDeployment $deployment -ServicePort 8020</dev:code> <dev:remarks> <maml:para>This command sets the Fonto Document History service port. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-ISHServiceFontoDocumentHistory</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-ISHServiceFontoDocumentHistory</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-ISHServiceFontoDocumentHistory</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Disable-ISHServiceFontoReview --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Disable-ISHServiceFontoReview</command:name> <command:verb>Disable</command:verb> <command:noun>ISHServiceFontoReview</command:noun> <maml:description> <maml:para>Disables fonto review windows service.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Disable-ISHServiceFontoReview cmdlet disables fonto review windows service.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Disable-ISHServiceFontoReview</maml:name> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Disable-ISHServiceFontoReview -ISHDeployment $deployment</dev:code> <dev:remarks> <maml:para>This command disables the fonto review windows service. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Set-ISHServiceFontoReview</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ISHServiceFontoReview</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-ISHServiceFontoReview</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Enable-ISHServiceFontoReview --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Enable-ISHServiceFontoReview</command:name> <command:verb>Enable</command:verb> <command:noun>ISHServiceFontoReview</command:noun> <maml:description> <maml:para>Enables fonto review windows service.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Enable-ISHServiceFontoReview cmdlet enables fonto review windows service.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Enable-ISHServiceFontoReview</maml:name> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Enable-ISHServiceFontoReview -ISHDeployment $deployment</dev:code> <dev:remarks> <maml:para>This command enables the fonto review windows service. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Set-ISHServiceFontoReview</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ISHServiceFontoReview</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-ISHServiceFontoReview</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-ISHServiceFontoReview --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-ISHServiceFontoReview</command:name> <command:verb>Get</command:verb> <command:noun>ISHServiceFontoReview</command:noun> <maml:description> <maml:para>Gets list of windows services for Fonto Review.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-ISHServiceFontoReview cmdlet gets list of fonto review windows services.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-ISHServiceFontoReview</maml:name> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Get-ISHServiceFontoReview -ISHDeployment $deployment</dev:code> <dev:remarks> <maml:para>This command shows the fonto review windows services. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Set-ISHServiceFontoReview</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-ISHServiceFontoReview</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-ISHServiceFontoReview</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Set-ISHServiceFontoReview --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-ISHServiceFontoReview</command:name> <command:verb>Set</command:verb> <command:noun>ISHServiceFontoReview</command:noun> <maml:description> <maml:para>Sets target port for Fonto Review.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-ISHServiceFontoReview cmdlet sets target port for Fonto Review..</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-ISHServiceFontoReview</maml:name> <!-- Parameter: ServicePort --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ServicePort</maml:name> <maml:description> <maml:para>The target FontoReview port.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ServicePort --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ServicePort</maml:name> <maml:description> <maml:para>The target FontoReview port.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Set-ISHServiceFontoReview -ISHDeployment $deployment -ServicePort 8081</dev:code> <dev:remarks> <maml:para>This command sets the fonto review target port. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-ISHServiceFontoReview</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-ISHServiceFontoReview</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-ISHServiceFontoReview</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Disable-ISHServiceFullTextIndex --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Disable-ISHServiceFullTextIndex</command:name> <command:verb>Disable</command:verb> <command:noun>ISHServiceFullTextIndex</command:noun> <maml:description> <maml:para>Disables SolrLucene windows service.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Disable-ISHServiceFullTextIndex cmdlet disables SolrLucene windows service.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Disable-ISHServiceFullTextIndex</maml:name> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Disable-ISHServiceFullTextIndex -ISHDeployment $deployment</dev:code> <dev:remarks> <maml:para>This command disables SolrLucene windows service. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Enable-ISHServiceFullTextIndex</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-ISHServiceFullTextIndex</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ISHServiceFullTextIndex</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Enable-ISHServiceFullTextIndex --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Enable-ISHServiceFullTextIndex</command:name> <command:verb>Enable</command:verb> <command:noun>ISHServiceFullTextIndex</command:noun> <maml:description> <maml:para>Enables SolrLucene windows service.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Enable-ISHServiceFullTextIndex cmdlet enables SolrLucene windows service.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Enable-ISHServiceFullTextIndex</maml:name> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Enable-ISHServiceFullTextIndex -ISHDeployment $deployment</dev:code> <dev:remarks> <maml:para>This command enables the SolrLucene windows service. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Disable-ISHServiceFullTextIndex</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-ISHServiceFullTextIndex</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ISHServiceFullTextIndex</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-ISHServiceFullTextIndex --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-ISHServiceFullTextIndex</command:name> <command:verb>Get</command:verb> <command:noun>ISHServiceFullTextIndex</command:noun> <maml:description> <maml:para>Gets list of windows services for SolrLucene.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-ISHServiceFullTextIndex cmdlet gets list of SolrLucene windows services.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-ISHServiceFullTextIndex</maml:name> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Get-ISHServiceFullTextIndex -ISHDeployment $deployment</dev:code> <dev:remarks> <maml:para>This command shows the SolrLucene windows services. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Set-ISHServiceFullTextIndex</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-ISHServiceFullTextIndex</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-ISHServiceFullTextIndex</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Set-ISHServiceFullTextIndex --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-ISHServiceFullTextIndex</command:name> <command:verb>Set</command:verb> <command:noun>ISHServiceFullTextIndex</command:noun> <maml:description> <maml:para>Sets target lucene ServicePort.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-ISHServiceFullTextIndex cmdlet sets target lucene ServicePort.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-ISHServiceFullTextIndex</maml:name> <!-- Parameter: ServicePort --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ServicePort</maml:name> <maml:description> <maml:para>The target lucene ServicePort.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ServicePort --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ServicePort</maml:name> <maml:description> <maml:para>The target lucene ServicePort.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Set-ISHServiceFullTextIndex -ISHDeployment $deployment -ServicePort 8081</dev:code> <dev:remarks> <maml:para>This command changes the target port of instances of SolrLucene services. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Enable-ISHServiceFullTextIndex</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-ISHServiceFullTextIndex</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ISHServiceFullTextIndex</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-ISHIntegrationFullTextIndex</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Disable-ISHServiceTranslationBuilder --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Disable-ISHServiceTranslationBuilder</command:name> <command:verb>Disable</command:verb> <command:noun>ISHServiceTranslationBuilder</command:noun> <maml:description> <maml:para>Disables translation builder windows service.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Disable-ISHServiceTranslationBuilder cmdlet disables translation builder windows service.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Disable-ISHServiceTranslationBuilder</maml:name> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Disable-ISHServiceTranslationBuilder -ISHDeployment $deployment</dev:code> <dev:remarks> <maml:para>This command disables the translation builder windows service. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Set-ISHServiceTranslationBuilder</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ISHServiceTranslationBuilder</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-ISHServiceTranslationBuilder</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-ISHCOMPlus</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-ISHIISAppPool</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-ISHServiceTranslationOrganizer</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Enable-ISHServiceTranslationBuilder --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Enable-ISHServiceTranslationBuilder</command:name> <command:verb>Enable</command:verb> <command:noun>ISHServiceTranslationBuilder</command:noun> <maml:description> <maml:para>Enables translation builder windows service.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Enable-ISHServiceTranslationBuilder cmdlet enables translation builder windows service.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Enable-ISHServiceTranslationBuilder</maml:name> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Enable-ISHServiceTranslationBuilder -ISHDeployment $deployment</dev:code> <dev:remarks> <maml:para>This command enables the translation builder windows service. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Set-ISHServiceTranslationBuilder</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ISHServiceTranslationBuilder</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-ISHServiceTranslationBuilder</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-ISHCOMPlus</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-ISHIISAppPool</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-ISHServiceTranslationOrganizer</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-ISHServiceTranslationBuilder --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-ISHServiceTranslationBuilder</command:name> <command:verb>Get</command:verb> <command:noun>ISHServiceTranslationBuilder</command:noun> <maml:description> <maml:para>Gets list of windows services for Translation Builder.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-ISHServiceTranslationBuilder cmdlet gets list of translation builder windows services.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-ISHServiceTranslationBuilder</maml:name> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Get-ISHServiceTranslationBuilder -ISHDeployment $deployment</dev:code> <dev:remarks> <maml:para>This command shows the translation builder windows services. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Set-ISHServiceTranslationBuilder</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-ISHServiceTranslationBuilder</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-ISHServiceTranslationBuilder</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Set-ISHServiceTranslationBuilder --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-ISHServiceTranslationBuilder</command:name> <command:verb>Set</command:verb> <command:noun>ISHServiceTranslationBuilder</command:noun> <maml:description> <maml:para>Sets translation builder windows service.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-ISHServiceTranslationBuilder cmdlet sets translation builder windows service.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: TranslationBuilderSettings --> <command:syntaxItem> <maml:name>Set-ISHServiceTranslationBuilder</maml:name> <!-- Parameter: MaxObjectsInOnePush --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaxObjectsInOnePush</maml:name> <maml:description> <maml:para>The maximum number of objects in one push.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: MaxJobItemsCreatedInOneCall --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaxJobItemsCreatedInOneCall</maml:name> <maml:description> <maml:para>The maximum number of objects in one push.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: CompletedJobLifeSpan --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CompletedJobLifeSpan</maml:name> <maml:description> <maml:para>The life period of completed job.</maml:para> </maml:description> <command:parameterValue required="true">TimeSpan</command:parameterValue> <dev:type> <maml:name>System.TimeSpan</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00:00:00</dev:defaultValue> </command:parameter> <!-- Parameter: JobProcessingTimeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>JobProcessingTimeout</maml:name> <maml:description> <maml:para>The timeout of processing of job.</maml:para> </maml:description> <command:parameterValue required="true">TimeSpan</command:parameterValue> <dev:type> <maml:name>System.TimeSpan</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00:00:00</dev:defaultValue> </command:parameter> <!-- Parameter: JobPollingInterval --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>JobPollingInterval</maml:name> <maml:description> <maml:para>The interval of polling of job.</maml:para> </maml:description> <command:parameterValue required="true">TimeSpan</command:parameterValue> <dev:type> <maml:name>System.TimeSpan</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00:00:00</dev:defaultValue> </command:parameter> <!-- Parameter: PendingJobPollingInterval --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PendingJobPollingInterval</maml:name> <maml:description> <maml:para>The interval of polling of pending job.</maml:para> </maml:description> <command:parameterValue required="true">TimeSpan</command:parameterValue> <dev:type> <maml:name>System.TimeSpan</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00:00:00</dev:defaultValue> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: TranslationBuilderCount --> <command:syntaxItem> <maml:name>Set-ISHServiceTranslationBuilder</maml:name> <!-- Parameter: Count --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Count</maml:name> <maml:description> <maml:para>The number of TranslationBuilder services in the system.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: MaxObjectsInOnePush --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaxObjectsInOnePush</maml:name> <maml:description> <maml:para>The maximum number of objects in one push.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: MaxJobItemsCreatedInOneCall --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaxJobItemsCreatedInOneCall</maml:name> <maml:description> <maml:para>The maximum number of objects in one push.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: CompletedJobLifeSpan --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CompletedJobLifeSpan</maml:name> <maml:description> <maml:para>The life period of completed job.</maml:para> </maml:description> <command:parameterValue required="true">TimeSpan</command:parameterValue> <dev:type> <maml:name>System.TimeSpan</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00:00:00</dev:defaultValue> </command:parameter> <!-- Parameter: JobProcessingTimeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>JobProcessingTimeout</maml:name> <maml:description> <maml:para>The timeout of processing of job.</maml:para> </maml:description> <command:parameterValue required="true">TimeSpan</command:parameterValue> <dev:type> <maml:name>System.TimeSpan</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00:00:00</dev:defaultValue> </command:parameter> <!-- Parameter: JobPollingInterval --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>JobPollingInterval</maml:name> <maml:description> <maml:para>The interval of polling of job.</maml:para> </maml:description> <command:parameterValue required="true">TimeSpan</command:parameterValue> <dev:type> <maml:name>System.TimeSpan</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00:00:00</dev:defaultValue> </command:parameter> <!-- Parameter: PendingJobPollingInterval --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PendingJobPollingInterval</maml:name> <maml:description> <maml:para>The interval of polling of pending job.</maml:para> </maml:description> <command:parameterValue required="true">TimeSpan</command:parameterValue> <dev:type> <maml:name>System.TimeSpan</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00:00:00</dev:defaultValue> </command:parameter> <!-- Parameter: Count --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Count</maml:name> <maml:description> <maml:para>The number of TranslationBuilder services in the system.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Set-ISHServiceTranslationBuilder -ISHDeployment $deployment -MaxObjectsInOnePush 1000</dev:code> <dev:remarks> <maml:para>This command enables the translation builder windows service. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\>Set-ISHServiceTranslationBuilder -ISHDeployment $deployment -Count 2</dev:code> <dev:remarks> <maml:para>This command changes the amount of instances of services. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Enable-ISHExternalPreview</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Disable-ISHServiceTranslationOrganizer --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Disable-ISHServiceTranslationOrganizer</command:name> <command:verb>Disable</command:verb> <command:noun>ISHServiceTranslationOrganizer</command:noun> <maml:description> <maml:para>Disables translation organizer windows service.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Disable-ISHServiceTranslationOrganizer cmdlet disables translation organizer windows service.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Disable-ISHServiceTranslationOrganizer</maml:name> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Disable-ISHServiceTranslationBuilder -ISHDeployment $deployment</dev:code> <dev:remarks> <maml:para>This command disables the translation organizer windows service. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Set-ISHServiceTranslationOrganizer</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ISHServiceTranslationOrganizer</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-ISHServiceTranslationOrganizer</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-ISHCOMPlus</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-ISHIISAppPool</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-ISHServiceTranslationBuilder</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Enable-ISHServiceTranslationOrganizer --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Enable-ISHServiceTranslationOrganizer</command:name> <command:verb>Enable</command:verb> <command:noun>ISHServiceTranslationOrganizer</command:noun> <maml:description> <maml:para>Enables translation organizer windows service.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Enable-ISHServiceTranslationOrganizer cmdlet enables translation organizer windows service.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Enable-ISHServiceTranslationOrganizer</maml:name> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Enable-ISHServiceTranslationOrganizer -ISHDeployment $deployment</dev:code> <dev:remarks> <maml:para>This command enables the translation organizer windows service. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Set-ISHServiceTranslationOrganizer</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ISHServiceTranslationOrganizer</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-ISHServiceTranslationOrganizer</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-ISHCOMPlus</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-ISHIISAppPool</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-ISHServiceTranslationBuilder</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-ISHServiceTranslationOrganizer --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-ISHServiceTranslationOrganizer</command:name> <command:verb>Get</command:verb> <command:noun>ISHServiceTranslationOrganizer</command:noun> <maml:description> <maml:para>Gets list of windows services for Translation Builder.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-ISHServiceTranslationOrganizer cmdlet gets list of translation builder windows services.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-ISHServiceTranslationOrganizer</maml:name> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Get-ISHServiceTranslationOrganizer -ISHDeployment $deployment</dev:code> <dev:remarks> <maml:para>This command shows the translation builder windows services. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Set-ISHServiceTranslationOrganizer</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-ISHServiceTranslationOrganizer</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-ISHServiceTranslationOrganizer</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Set-ISHServiceTranslationOrganizer --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-ISHServiceTranslationOrganizer</command:name> <command:verb>Set</command:verb> <command:noun>ISHServiceTranslationOrganizer</command:noun> <maml:description> <maml:para>Sets translation organizer windows service.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-ISHServiceTranslationOrganizer cmdlet sets translation organizer windows service.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: TranslationOrganizerSettings --> <command:syntaxItem> <maml:name>Set-ISHServiceTranslationOrganizer</maml:name> <!-- Parameter: DumpFolder --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DumpFolder</maml:name> <maml:description> <maml:para>The path to dump folder.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MaxTranslationJobItemsUpdatedInOneCall --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaxTranslationJobItemsUpdatedInOneCall</maml:name> <maml:description> <maml:para>The maximum number of job items updated in one call.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: JobPollingInterval --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>JobPollingInterval</maml:name> <maml:description> <maml:para>The interval of job polling.</maml:para> </maml:description> <command:parameterValue required="true">TimeSpan</command:parameterValue> <dev:type> <maml:name>System.TimeSpan</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00:00:00</dev:defaultValue> </command:parameter> <!-- Parameter: PendingJobPollingInterval --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PendingJobPollingInterval</maml:name> <maml:description> <maml:para>The interval of polling of pending job.</maml:para> </maml:description> <command:parameterValue required="true">TimeSpan</command:parameterValue> <dev:type> <maml:name>System.TimeSpan</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00:00:00</dev:defaultValue> </command:parameter> <!-- Parameter: SystemTaskInterval --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SystemTaskInterval</maml:name> <maml:description> <maml:para>The interval of system task.</maml:para> </maml:description> <command:parameterValue required="true">TimeSpan</command:parameterValue> <dev:type> <maml:name>System.TimeSpan</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00:00:00</dev:defaultValue> </command:parameter> <!-- Parameter: AttemptsBeforeFailOnRetrieval --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AttemptsBeforeFailOnRetrieval</maml:name> <maml:description> <maml:para>The number of attempts before fail on retrieval.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: UpdateLeasedByPerNumberOfItems --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateLeasedByPerNumberOfItems</maml:name> <maml:description> <maml:para>TUpdate leased by per number of items.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: RetriesOnTimeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RetriesOnTimeout</maml:name> <maml:description> <maml:para>The number of retries on timeout.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: TranslationOrganizerSynchronization --> <command:syntaxItem> <maml:name>Set-ISHServiceTranslationOrganizer</maml:name> <!-- Parameter: SynchronizeTemplates --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SynchronizeTemplates</maml:name> <maml:description> <maml:para>Synchronizing the templates.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: TranslationOrganizerCount --> <command:syntaxItem> <maml:name>Set-ISHServiceTranslationOrganizer</maml:name> <!-- Parameter: Count --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Count</maml:name> <maml:description> <maml:para>The number of TranslationOrganizer services in the system.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ISHWS --> <command:syntaxItem> <maml:name>Set-ISHServiceTranslationOrganizer</maml:name> <!-- Parameter: ISHWS --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHWS</maml:name> <maml:description> <maml:para>The URL to ISHWS.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHWSCertificateValidationMode --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHWSCertificateValidationMode</maml:name> <maml:description> <maml:para>Selected validation mode.</maml:para> <maml:para>Possible values: None, PeerTrust, ChainTrust, PeerOrChainTrust, Custom</maml:para> </maml:description> <command:parameterValue required="true">X509CertificateValidationMode</command:parameterValue> <dev:type> <maml:name>System.ServiceModel.Security.X509CertificateValidationMode</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">PeerTrust</command:parameterValue> <command:parameterValue required="false" variableLength="false">ChainTrust</command:parameterValue> <command:parameterValue required="false" variableLength="false">PeerOrChainTrust</command:parameterValue> <command:parameterValue required="false" variableLength="false">Custom</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: ISHWSDnsIdentity --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHWSDnsIdentity</maml:name> <maml:description> <maml:para>The DNS Endpoint Identity for ISHWS.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IssuerBindingType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IssuerBindingType</maml:name> <maml:description> <maml:para>Type of ISHWS authentication.</maml:para> <maml:para>Possible values: UserNameMixed, WindowsMixed</maml:para> </maml:description> <command:parameterValue required="true">BindingType</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Enums.BindingType</maml:name> <maml:uri /> <maml:description> <maml:para>Enumeration of Binding Types.</maml:para> </maml:description> </dev:type> <dev:defaultValue>UserNameMixed</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">UserNameMixed</command:parameterValue> <command:parameterValue required="false" variableLength="false">WindowsMixed</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: IssuerEndpoint --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IssuerEndpoint</maml:name> <maml:description> <maml:para>The URL to issuer ISHWS endpoint.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Credential --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The credential to get access to ISHWS.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UserName</maml:name> <maml:description> <maml:para>The operation system user's name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserPassword --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UserPassword</maml:name> <maml:description> <maml:para>The operation system user's password.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: DumpFolder --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DumpFolder</maml:name> <maml:description> <maml:para>The path to dump folder.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MaxTranslationJobItemsUpdatedInOneCall --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaxTranslationJobItemsUpdatedInOneCall</maml:name> <maml:description> <maml:para>The maximum number of job items updated in one call.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: JobPollingInterval --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>JobPollingInterval</maml:name> <maml:description> <maml:para>The interval of job polling.</maml:para> </maml:description> <command:parameterValue required="true">TimeSpan</command:parameterValue> <dev:type> <maml:name>System.TimeSpan</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00:00:00</dev:defaultValue> </command:parameter> <!-- Parameter: PendingJobPollingInterval --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PendingJobPollingInterval</maml:name> <maml:description> <maml:para>The interval of polling of pending job.</maml:para> </maml:description> <command:parameterValue required="true">TimeSpan</command:parameterValue> <dev:type> <maml:name>System.TimeSpan</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00:00:00</dev:defaultValue> </command:parameter> <!-- Parameter: SystemTaskInterval --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SystemTaskInterval</maml:name> <maml:description> <maml:para>The interval of system task.</maml:para> </maml:description> <command:parameterValue required="true">TimeSpan</command:parameterValue> <dev:type> <maml:name>System.TimeSpan</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00:00:00</dev:defaultValue> </command:parameter> <!-- Parameter: AttemptsBeforeFailOnRetrieval --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AttemptsBeforeFailOnRetrieval</maml:name> <maml:description> <maml:para>The number of attempts before fail on retrieval.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: UpdateLeasedByPerNumberOfItems --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateLeasedByPerNumberOfItems</maml:name> <maml:description> <maml:para>TUpdate leased by per number of items.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: SynchronizeTemplates --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SynchronizeTemplates</maml:name> <maml:description> <maml:para>Synchronizing the templates.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: RetriesOnTimeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RetriesOnTimeout</maml:name> <maml:description> <maml:para>The number of retries on timeout.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Count --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Count</maml:name> <maml:description> <maml:para>The number of TranslationOrganizer services in the system.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: ISHWS --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHWS</maml:name> <maml:description> <maml:para>The URL to ISHWS.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHWSCertificateValidationMode --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHWSCertificateValidationMode</maml:name> <maml:description> <maml:para>Selected validation mode.</maml:para> <maml:para>Possible values: None, PeerTrust, ChainTrust, PeerOrChainTrust, Custom</maml:para> </maml:description> <command:parameterValue required="true">X509CertificateValidationMode</command:parameterValue> <dev:type> <maml:name>System.ServiceModel.Security.X509CertificateValidationMode</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">PeerTrust</command:parameterValue> <command:parameterValue required="false" variableLength="false">ChainTrust</command:parameterValue> <command:parameterValue required="false" variableLength="false">PeerOrChainTrust</command:parameterValue> <command:parameterValue required="false" variableLength="false">Custom</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: ISHWSDnsIdentity --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHWSDnsIdentity</maml:name> <maml:description> <maml:para>The DNS Endpoint Identity for ISHWS.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IssuerBindingType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IssuerBindingType</maml:name> <maml:description> <maml:para>Type of ISHWS authentication.</maml:para> <maml:para>Possible values: UserNameMixed, WindowsMixed</maml:para> </maml:description> <command:parameterValue required="true">BindingType</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Enums.BindingType</maml:name> <maml:uri /> <maml:description> <maml:para>Enumeration of Binding Types.</maml:para> </maml:description> </dev:type> <dev:defaultValue>UserNameMixed</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">UserNameMixed</command:parameterValue> <command:parameterValue required="false" variableLength="false">WindowsMixed</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: IssuerEndpoint --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IssuerEndpoint</maml:name> <maml:description> <maml:para>The URL to issuer ISHWS endpoint.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Credential --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The credential to get access to ISHWS.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UserName</maml:name> <maml:description> <maml:para>The operation system user's name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserPassword --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UserPassword</maml:name> <maml:description> <maml:para>The operation system user's password.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Set-ISHServiceTranslationOrganizer -ISHDeployment $deployment -MaxTranslationJobItemsUpdatedInOneCall 1000</dev:code> <dev:remarks> <maml:para>This command enables the translation organizer windows service. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\>Set-ISHServiceTranslationOrganizer -ISHDeployment $deployment -SynchronizeTemplates $true</dev:code> <dev:remarks> <maml:para>This command enables synchronizing the templates. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\>Set-ISHServiceTranslationOrganizer -ISHDeployment $deployment -Count 2</dev:code> <dev:remarks> <maml:para>This command changes the amount of instances of services. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>PS C:\>Set-ISHServiceTranslationOrganizer -ISHDeployment $deployment -ISHWS "http://example.com/InfoShareWS/" -IssuerBindingType "WindowsMixed" -IssuerEndpoint "http://example.com/InfoShareSTS/issue/wstrust/mixed/windows"</dev:code> <dev:remarks> <maml:para>This command sets new ISHWS URL, the type of issuer binding, the issuer endpoint. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 5 ----------</maml:title> <dev:code>PS C:\>Set-ISHServiceTranslationOrganizer -ISHDeployment $deployment -ISHWS "http://example.com/InfoShareWS/" -IssuerBindingType "UserNameMixed" -IssuerEndpoint "http://example.com/InfoShareSTS/issue/wstrust/mixed/username" -Credential $credential</dev:code> <dev:remarks> <maml:para>This command sets new ISHWS URL, the type of issuer binding, the issuer endpoint and new credential. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 6 ----------</maml:title> <dev:code>PS C:\>Set-ISHServiceTranslationOrganizer -ISHDeployment $deployment -ISHWS "http://example.com/InfoShareWS/" -IssuerBindingType "UserNameMixed" -IssuerEndpoint "http://example.com/InfoShareSTS/issue/wstrust/mixed/username" -UserName $userName -UserPassword $userPassword</dev:code> <dev:remarks> <maml:para>This command sets new ISHWS URL, the type of issuer binding, the issuer endpoint and new credential. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Enable-ISHExternalPreview</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Set-ISHServiceUser --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-ISHServiceUser</command:name> <command:verb>Set</command:verb> <command:noun>ISHServiceUser</command:noun> <maml:description> <maml:para>Sets Service user credentials.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-ISHServiceUser cmdlet sets new security credentials of Service user. Changes will take effect after the restart of services. Please, see refer cmdlets below</maml:para> </maml:description> <command:syntax> <!-- Parameter set: PSCredential --> <command:syntaxItem> <maml:name>Set-ISHServiceUser</maml:name> <!-- Parameter: Credential --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The credential that will be set.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UserName</maml:name> <maml:description> <maml:para>The operation system user's name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserPassword --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UserPassword</maml:name> <maml:description> <maml:para>The operation system user's password.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: UserName/UserPassword --> <command:syntaxItem> <maml:name>Set-ISHServiceUser</maml:name> <!-- Parameter: Credential --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The credential that will be set.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>UserName</maml:name> <maml:description> <maml:para>The operation system user's name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserPassword --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>UserPassword</maml:name> <maml:description> <maml:para>The operation system user's password.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Credential --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The credential that will be set.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>UserName</maml:name> <maml:description> <maml:para>The operation system user's name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserPassword --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>UserPassword</maml:name> <maml:description> <maml:para>The operation system user's password.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Set-ISHServiceUser -ISHDeployment $deployment -Credential $credential</dev:code> <dev:remarks> <maml:para>This command sets new Service user credentials. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\>Set-ISHServiceUser -ISHDeployment $deployment -UserName $userName -UserPassword $userPassword</dev:code> <dev:remarks> <maml:para>This command sets new Service user credentials. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Disable-ISHServiceTranslationBuilder</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-ISHServiceTranslationOrganizer</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-ISHServiceTranslationBuilder</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-ISHServiceTranslationOrganizer</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-ISHOSUser</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-ISHActor</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Reset-ISHSTS --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Reset-ISHSTS</command:name> <command:verb>Reset</command:verb> <command:noun>ISHSTS</command:noun> <maml:description> <maml:para>Resets STS database.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Reset-ISHSTS cmdlet resets STS database to initial state.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Reset-ISHSTS</maml:name> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Reset-ISHSTS -ISHDeployment $deployment</dev:code> <dev:remarks> <maml:para>This command resets STS database to initial state. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-ISHSTSRelyingParty</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-ISHIntegrationSTSCertificate</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-ISHIntegrationSTSCertificate</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-ISHSTSConfiguration</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-ISHSTSRelyingParty</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Set-ISHSTSConfiguration --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-ISHSTSConfiguration</command:name> <command:verb>Set</command:verb> <command:noun>ISHSTSConfiguration</command:noun> <maml:description> <maml:para>Sets STS token signing certificate and/or type of authentication.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-ISHIntegrationSTSCertificate cmdlet sets STS token signing certificate and/or type of authentication.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-ISHSTSConfiguration</maml:name> <!-- Parameter: TokenSigningCertificateThumbprint --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TokenSigningCertificateThumbprint</maml:name> <maml:description> <maml:para>Token signing certificate Thumbprint.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AuthenticationType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AuthenticationType</maml:name> <maml:description> <maml:para>Selected authentication type.</maml:para> <maml:para>Possible values: UsernamePassword, Windows</maml:para> </maml:description> <command:parameterValue required="true">AuthenticationType</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Enums.AuthenticationType</maml:name> <maml:uri /> <maml:description> <maml:para>Specify the binding type that is required by the end point of the WS-Trust issuer.</maml:para> </maml:description> </dev:type> <dev:defaultValue>UsernamePassword</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">UsernamePassword</command:parameterValue> <command:parameterValue required="false" variableLength="false">Windows</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: TokenSigningCertificateThumbprint --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TokenSigningCertificateThumbprint</maml:name> <maml:description> <maml:para>Token signing certificate Thumbprint.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AuthenticationType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AuthenticationType</maml:name> <maml:description> <maml:para>Selected authentication type.</maml:para> <maml:para>Possible values: UsernamePassword, Windows</maml:para> </maml:description> <command:parameterValue required="true">AuthenticationType</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Enums.AuthenticationType</maml:name> <maml:uri /> <maml:description> <maml:para>Specify the binding type that is required by the end point of the WS-Trust issuer.</maml:para> </maml:description> </dev:type> <dev:defaultValue>UsernamePassword</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">UsernamePassword</command:parameterValue> <command:parameterValue required="false" variableLength="false">Windows</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Set-ISHSTSConfiguration -ISHDeployment $deployment -TokenSigningCertificateThumbprint "t1"</dev:code> <dev:remarks> <maml:para>This command sets STS token signing certificate. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\>Set-ISHSTSConfiguration -ISHDeployment $deployment -AuthenticationType "Windows"</dev:code> <dev:remarks> <maml:para>This command sets Windows Authentication type for STS. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-ISHSTSRelyingParty</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-ISHIntegrationSTSCertificate</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Reset-ISHSTS</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-ISHIntegrationSTSCertificate</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-ISHSTSRelyingParty</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-ISHSTSRelyingParty --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-ISHSTSRelyingParty</command:name> <command:verb>Get</command:verb> <command:noun>ISHSTSRelyingParty</command:noun> <maml:description> <maml:para>Gets all relying parties from the infosharests database. The switches acts as filter based on the RP name.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-ISHSTSRelyingParty cmdlet gets all relying parties from the infosharests database.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-ISHSTSRelyingParty</maml:name> <!-- Parameter: ISH --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISH</maml:name> <maml:description> <maml:para>Flag to return relying parties for InfoShare.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: LC --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LC</maml:name> <maml:description> <maml:para>Flag to return relying parties for LiveContent.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: BL --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BL</maml:name> <maml:description> <maml:para>Flag to return relying parties for BlueLion.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ISH --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISH</maml:name> <maml:description> <maml:para>Flag to return relying parties for InfoShare.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: LC --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LC</maml:name> <maml:description> <maml:para>Flag to return relying parties for LiveContent.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: BL --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BL</maml:name> <maml:description> <maml:para>Flag to return relying parties for BlueLion.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Get-ISHSTSRelyingParty -ISHDeployment $deployment -ISH</dev:code> <dev:remarks> <maml:para>This command gets all relying parties from the infosharests database where name of relying party starts with "ISH".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\>Get-ISHSTSRelyingParty -ISHDeployment $deployment -LC</dev:code> <dev:remarks> <maml:para>This command gets all relying parties from the infosharests database where name of relying party starts with "LC".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\>Get-ISHSTSRelyingParty -ISHDeployment $deployment -BL</dev:code> <dev:remarks> <maml:para>This command gets all relying parties from the infosharests database where name of relying party starts with "BL".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>PS C:\>Get-ISHSTSRelyingParty -ISHDeployment $deployment -ISH -BL -LC #Any combination</dev:code> <dev:remarks> <maml:para>This command gets all relying parties from the infosharests database. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Remove-ISHIntegrationSTSCertificate</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Reset-ISHSTS</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-ISHIntegrationSTSCertificate</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-ISHSTSConfiguration</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-ISHSTSRelyingParty</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Set-ISHSTSRelyingParty --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-ISHSTSRelyingParty</command:name> <command:verb>Set</command:verb> <command:noun>ISHSTSRelyingParty</command:noun> <maml:description> <maml:para>Sets relying party to infosharests database. The switches acts as filter based on the RP name.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-ISHSTSRelyingParty cmdlet sets relying party to from the infosharests database.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: LC --> <command:syntaxItem> <maml:name>Set-ISHSTSRelyingParty</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Relying party name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Realm --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Realm</maml:name> <maml:description> <maml:para>Relying party realm.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LC --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>LC</maml:name> <maml:description> <maml:para>Flag to set relying party for LiveContent.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: BL --> <command:syntaxItem> <maml:name>Set-ISHSTSRelyingParty</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Relying party name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Realm --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Realm</maml:name> <maml:description> <maml:para>Relying party realm.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: BL --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>BL</maml:name> <maml:description> <maml:para>Flag to set relying party for BlueLion.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Active --> <command:syntaxItem> <maml:name>Set-ISHSTSRelyingParty</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Relying party name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Realm --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Realm</maml:name> <maml:description> <maml:para>Relying party realm.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: EncryptingCertificate --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EncryptingCertificate</maml:name> <maml:description> <maml:para>Relying party encryption certificate.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Relying party name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Realm --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Realm</maml:name> <maml:description> <maml:para>Relying party realm.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LC --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>LC</maml:name> <maml:description> <maml:para>Flag to set relying party for LiveContent.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: BL --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>BL</maml:name> <maml:description> <maml:para>Flag to set relying party for BlueLion.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: EncryptingCertificate --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EncryptingCertificate</maml:name> <maml:description> <maml:para>Relying party encryption certificate.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Set-ISHSTSRelyingParty -ISHDeployment $deployment -Name "Content Review" -Realm "https://lc.example.com/" -LC</dev:code> <dev:remarks> <maml:para>This command sets relying parties to infosharests database. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet. As prefixes can be configured for custom handling, it is not possible to change it when updating existing data for relying party.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\>Set-ISHSTSRelyingParty -ISHDeployment $deployment -Name "Quality Assistant" -Realm "https://bl.example.com/" -BL</dev:code> <dev:remarks> <maml:para>This command sets relying parties to infosharests database. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet. As prefixes can be configured for custom handling, it is not possible to change it when updating existing data for relying party.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\>Set-ISHSTSRelyingParty -ISHDeployment $deployment -Name "3rd party" -Realm "https://3rdparty.example.com/"</dev:code> <dev:remarks> <maml:para>This command sets relying parties to infosharests database. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet. As prefixes can be configured for custom handling, it is not possible to change it when updating existing data for relying party.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-ISHSTSRelyingParty</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-ISHIntegrationSTSCertificate</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Reset-ISHSTS</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-ISHIntegrationSTSCertificate</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-ISHSTSConfiguration</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Remove-ISHTranslationFileSystemExport --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-ISHTranslationFileSystemExport</command:name> <command:verb>Remove</command:verb> <command:noun>ISHTranslationFileSystemExport</command:noun> <maml:description> <maml:para>TMS Instance from Translation Organizer.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Remove-ISHTranslationFileSystemExport cmdlet removes TMS Instance from Translation Organizer.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Remove-ISHTranslationFileSystemExport</maml:name> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Remove-ISHTranslationFileSystemExport -ISHDeployment $deployment</dev:code> <dev:remarks> <maml:para>Removes TMS Instance from Translation Organizer. This command removes TMS Instance from Translation Organizer. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Set-ISHTranslationFileSystemExport</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Set-ISHTranslationFileSystemExport --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-ISHTranslationFileSystemExport</command:name> <command:verb>Set</command:verb> <command:noun>ISHTranslationFileSystemExport</command:noun> <maml:description> <maml:para>Sets configuration of FileSystem.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-ISHTranslationFileSystemExport cmdlet sets configuration of FileSystem.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-ISHTranslationFileSystemExport</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name (alias) of FileSystem.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ExportFolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ExportFolderPath</maml:name> <maml:description> <maml:para>The path to export folder.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MaximumJobSize --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaximumJobSize</maml:name> <maml:description> <maml:para>The max value of total size in bytes of uncompressed external job (externalJobMaxTotalUncompressedSizeBytes).</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>5242880</dev:defaultValue> </command:parameter> <!-- Parameter: RequestMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequestMetadata</maml:name> <maml:description> <maml:para>The requested metadata.</maml:para> </maml:description> <command:parameterValue required="true">ISHFieldMetadata[]</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.TranslationOrganizer.ISHFieldMetadata[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name (alias) of FileSystem.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ExportFolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ExportFolderPath</maml:name> <maml:description> <maml:para>The path to export folder.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MaximumJobSize --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaximumJobSize</maml:name> <maml:description> <maml:para>The max value of total size in bytes of uncompressed external job (externalJobMaxTotalUncompressedSizeBytes).</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>5242880</dev:defaultValue> </command:parameter> <!-- Parameter: RequestMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequestMetadata</maml:name> <maml:description> <maml:para>The requested metadata.</maml:para> </maml:description> <command:parameterValue required="true">ISHFieldMetadata[]</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.TranslationOrganizer.ISHFieldMetadata[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Set-ISHTranslationFileSystemExport -ISHDeployment $deployment -Name "FileSystem1" -ExportFolderPath "c:\ExportFolder" -MaximumJobSize 5242880</dev:code> <dev:remarks> <maml:para>This command enables the translation organizer windows service. Parameter -MaximumJobSize is the max value of total size in bytes of uncompressed external job. In the FileSystem configuration section, this parameter has name "externalJobMaxTotalUncompressedSizeBytes". Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Set-ISHServiceTranslationOrganizer</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-ISHTranslationFileSystemExport</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Move-ISHUIButtonBarItem --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Move-ISHUIButtonBarItem</command:name> <command:verb>Move</command:verb> <command:noun>ISHUIButtonBarItem</command:noun> <maml:description> <maml:para>Move main menu item.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Move-ISHUIButtonBarItem cmdlet remove exist menu item.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Logical After --> <command:syntaxItem> <maml:name>Move-ISHUIButtonBarItem</maml:name> <!-- Parameter: After --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>After</maml:name> <maml:description> <maml:para>Menu item move position.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Logical --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Logical</maml:name> <maml:description> <maml:para>Type "Logical" especially for FolderButtonbar.xml.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of Button Bar.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Version After --> <command:syntaxItem> <maml:name>Move-ISHUIButtonBarItem</maml:name> <!-- Parameter: After --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>After</maml:name> <maml:description> <maml:para>Menu item move position.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Version --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Version</maml:name> <maml:description> <maml:para>Type "Version" especially for LanguageDocumentButtonbar.xml.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of Button Bar.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Language After --> <command:syntaxItem> <maml:name>Move-ISHUIButtonBarItem</maml:name> <!-- Parameter: After --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>After</maml:name> <maml:description> <maml:para>Menu item move position.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Language --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Language</maml:name> <maml:description> <maml:para>Type "Language" especially for TopDocumentButtonbar.xml.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of Button Bar.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Logical First --> <command:syntaxItem> <maml:name>Move-ISHUIButtonBarItem</maml:name> <!-- Parameter: First --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>First</maml:name> <maml:description> <maml:para>Menu item move to the first position.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Logical --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Logical</maml:name> <maml:description> <maml:para>Type "Logical" especially for FolderButtonbar.xml.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of Button Bar.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Version First --> <command:syntaxItem> <maml:name>Move-ISHUIButtonBarItem</maml:name> <!-- Parameter: First --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>First</maml:name> <maml:description> <maml:para>Menu item move to the first position.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Version --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Version</maml:name> <maml:description> <maml:para>Type "Version" especially for LanguageDocumentButtonbar.xml.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of Button Bar.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Language First --> <command:syntaxItem> <maml:name>Move-ISHUIButtonBarItem</maml:name> <!-- Parameter: First --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>First</maml:name> <maml:description> <maml:para>Menu item move to the first position.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Language --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Language</maml:name> <maml:description> <maml:para>Type "Language" especially for TopDocumentButtonbar.xml.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of Button Bar.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Logical Last --> <command:syntaxItem> <maml:name>Move-ISHUIButtonBarItem</maml:name> <!-- Parameter: Last --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Last</maml:name> <maml:description> <maml:para>Menu item move to the last position.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Logical --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Logical</maml:name> <maml:description> <maml:para>Type "Logical" especially for FolderButtonbar.xml.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of Button Bar.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Version Last --> <command:syntaxItem> <maml:name>Move-ISHUIButtonBarItem</maml:name> <!-- Parameter: Last --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Last</maml:name> <maml:description> <maml:para>Menu item move to the last position.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Version --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Version</maml:name> <maml:description> <maml:para>Type "Version" especially for LanguageDocumentButtonbar.xml.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of Button Bar.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Language Last --> <command:syntaxItem> <maml:name>Move-ISHUIButtonBarItem</maml:name> <!-- Parameter: Last --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Last</maml:name> <maml:description> <maml:para>Menu item move to the last position.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Language --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Language</maml:name> <maml:description> <maml:para>Type "Language" especially for TopDocumentButtonbar.xml.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of Button Bar.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: After --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>After</maml:name> <maml:description> <maml:para>Menu item move position.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: First --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>First</maml:name> <maml:description> <maml:para>Menu item move to the first position.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Last --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Last</maml:name> <maml:description> <maml:para>Menu item move to the last position.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Logical --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Logical</maml:name> <maml:description> <maml:para>Type "Logical" especially for FolderButtonbar.xml.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Version --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Version</maml:name> <maml:description> <maml:para>Type "Version" especially for LanguageDocumentButtonbar.xml.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Language --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Language</maml:name> <maml:description> <maml:para>Type "Language" especially for TopDocumentButtonbar.xml.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of Button Bar.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Move-ISHUIButtonBarItem -ISHDeployment $deployment -Logical -First -Name "test"</dev:code> <dev:remarks> <maml:para>This command move main menu item. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Remove-ISHUIButtonBarItem</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-ISHUIButtonBarItem</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Remove-ISHUIButtonBarItem --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-ISHUIButtonBarItem</command:name> <command:verb>Remove</command:verb> <command:noun>ISHUIButtonBarItem</command:noun> <maml:description> <maml:para>Remove main menu item.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Remove-ISHUIButtonBarItem cmdlet remove exist menu item.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Logical --> <command:syntaxItem> <maml:name>Remove-ISHUIButtonBarItem</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of Button Bar.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Logical --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Logical</maml:name> <maml:description> <maml:para>Type "Logical" especially for FolderButtonbar.xml.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Version --> <command:syntaxItem> <maml:name>Remove-ISHUIButtonBarItem</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of Button Bar.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Version --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Version</maml:name> <maml:description> <maml:para>Type "Version" especially for LanguageDocumentButtonbar.xml.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Language --> <command:syntaxItem> <maml:name>Remove-ISHUIButtonBarItem</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of Button Bar.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Language --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Language</maml:name> <maml:description> <maml:para>Type "Language" especially for TopDocumentButtonbar.xml.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of Button Bar.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Logical --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Logical</maml:name> <maml:description> <maml:para>Type "Logical" especially for FolderButtonbar.xml.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Version --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Version</maml:name> <maml:description> <maml:para>Type "Version" especially for LanguageDocumentButtonbar.xml.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Language --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Language</maml:name> <maml:description> <maml:para>Type "Language" especially for TopDocumentButtonbar.xml.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Remove-ISHUIButtonBarItem -ISHDeployment $deployment -Logical -Name "Test"</dev:code> <dev:remarks> <maml:para>This command remove main menu item. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Move-ISHUIButtonBarItem</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-ISHUIButtonBarItem</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Set-ISHUIButtonBarItem --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-ISHUIButtonBarItem</command:name> <command:verb>Set</command:verb> <command:noun>ISHUIButtonBarItem</command:noun> <maml:description> <maml:para>Create/Update button bar item.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-ISHUIButtonBarItem cmdlet add or update button bar item.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Logical --> <command:syntaxItem> <maml:name>Set-ISHUIButtonBarItem</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the button.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Icon --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Icon</maml:name> <maml:description> <maml:para>Icon for the button.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: JSFunction --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>JSFunction</maml:name> <maml:description> <maml:para>Javascript or asp page need to be invoken after click.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: CheckAccess --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CheckAccess</maml:name> <maml:description> <maml:para>Check access.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: HideText --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>HideText</maml:name> <maml:description> <maml:para>Hide text.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Logical --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Logical</maml:name> <maml:description> <maml:para>Type "Logical" especially for FolderButtonbar.xml.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ISHType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHType</maml:name> <maml:description> <maml:para>ISHType is a list of names for correspond card type.</maml:para> </maml:description> <command:parameterValue required="true">CardType[]</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Enums.CardType[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: JSArgumentsList --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>JSArgumentsList</maml:name> <maml:description> <maml:para>JSArgumentsList is a Javascript argument list.</maml:para> </maml:description> <command:parameterValue required="true">object[]</command:parameterValue> <dev:type> <maml:name>System.Object[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Version --> <command:syntaxItem> <maml:name>Set-ISHUIButtonBarItem</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the button.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Icon --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Icon</maml:name> <maml:description> <maml:para>Icon for the button.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: JSFunction --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>JSFunction</maml:name> <maml:description> <maml:para>Javascript or asp page need to be invoken after click.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: CheckAccess --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CheckAccess</maml:name> <maml:description> <maml:para>Check access.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: HideText --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>HideText</maml:name> <maml:description> <maml:para>Hide text.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Version --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Version</maml:name> <maml:description> <maml:para>Type "Version" especially for LanguageDocumentButtonbar.xml.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ISHType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHType</maml:name> <maml:description> <maml:para>ISHType is a list of names for correspond card type.</maml:para> </maml:description> <command:parameterValue required="true">CardType[]</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Enums.CardType[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: JSArgumentsList --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>JSArgumentsList</maml:name> <maml:description> <maml:para>JSArgumentsList is a Javascript argument list.</maml:para> </maml:description> <command:parameterValue required="true">object[]</command:parameterValue> <dev:type> <maml:name>System.Object[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Language --> <command:syntaxItem> <maml:name>Set-ISHUIButtonBarItem</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the button.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Icon --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Icon</maml:name> <maml:description> <maml:para>Icon for the button.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: JSFunction --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>JSFunction</maml:name> <maml:description> <maml:para>Javascript or asp page need to be invoken after click.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: CheckAccess --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CheckAccess</maml:name> <maml:description> <maml:para>Check access.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: HideText --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>HideText</maml:name> <maml:description> <maml:para>Hide text.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Language --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Language</maml:name> <maml:description> <maml:para>Type "Language" especially for TopDocumentButtonbar.xml.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ISHType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHType</maml:name> <maml:description> <maml:para>ISHType is a list of names for correspond card type.</maml:para> </maml:description> <command:parameterValue required="true">CardType[]</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Enums.CardType[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: JSArgumentsList --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>JSArgumentsList</maml:name> <maml:description> <maml:para>JSArgumentsList is a Javascript argument list.</maml:para> </maml:description> <command:parameterValue required="true">object[]</command:parameterValue> <dev:type> <maml:name>System.Object[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the button.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Icon --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Icon</maml:name> <maml:description> <maml:para>Icon for the button.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: JSFunction --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>JSFunction</maml:name> <maml:description> <maml:para>Javascript or asp page need to be invoken after click.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: CheckAccess --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CheckAccess</maml:name> <maml:description> <maml:para>Check access.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: HideText --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>HideText</maml:name> <maml:description> <maml:para>Hide text.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Logical --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Logical</maml:name> <maml:description> <maml:para>Type "Logical" especially for FolderButtonbar.xml.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Version --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Version</maml:name> <maml:description> <maml:para>Type "Version" especially for LanguageDocumentButtonbar.xml.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Language --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Language</maml:name> <maml:description> <maml:para>Type "Language" especially for TopDocumentButtonbar.xml.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ISHType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHType</maml:name> <maml:description> <maml:para>ISHType is a list of names for correspond card type.</maml:para> </maml:description> <command:parameterValue required="true">CardType[]</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Enums.CardType[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: JSArgumentsList --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>JSArgumentsList</maml:name> <maml:description> <maml:para>JSArgumentsList is a Javascript argument list.</maml:para> </maml:description> <command:parameterValue required="true">object[]</command:parameterValue> <dev:type> <maml:name>System.Object[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Set-ISHUIButtonBarItem -ISHDeployment $deployment -Logical -ISHType ISHIllustration, ISHMasterDoc -Name "test" -Action "refresh();" -Icon "~/Custom/Images/Custom.png"</dev:code> <dev:remarks> <maml:para>This command add/update main menu item. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Move-ISHUIButtonBarItem</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-ISHUIButtonBarItem</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Disable-ISHUICollectiveSpaces --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Disable-ISHUICollectiveSpaces</command:name> <command:verb>Disable</command:verb> <command:noun>ISHUICollectiveSpaces</command:noun> <maml:description> <maml:para>Disables Collective Spaces for Content Manager deployment.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Disable-ISHUICollectiveSpaces cmdlet disables Collective Spaces for Content Manager deployment.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: DraftSpace --> <command:syntaxItem> <maml:name>Disable-ISHUICollectiveSpaces</maml:name> <!-- Parameter: DraftSpace --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>DraftSpace</maml:name> <maml:description> <maml:para>Switch parameter to disable Draft Space for Content Manager deployment</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: DraftSpaceAndReviewSpace --> <command:syntaxItem> <maml:name>Disable-ISHUICollectiveSpaces</maml:name> <!-- Parameter: DraftSpace --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>DraftSpace</maml:name> <maml:description> <maml:para>Switch parameter to disable Draft Space for Content Manager deployment</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ReviewSpace --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ReviewSpace</maml:name> <maml:description> <maml:para>Switch parameter to disable Review Space for Content Manager deployment</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: DraftSpaceAndDocumentHistoryForDraftSpace --> <command:syntaxItem> <maml:name>Disable-ISHUICollectiveSpaces</maml:name> <!-- Parameter: DraftSpace --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>DraftSpace</maml:name> <maml:description> <maml:para>Switch parameter to disable Draft Space for Content Manager deployment</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: DocumentHistoryForDraftSpace --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>DocumentHistoryForDraftSpace</maml:name> <maml:description> <maml:para>Switch parameter to disable Document History for Content Manager deployment</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: All --> <command:syntaxItem> <maml:name>Disable-ISHUICollectiveSpaces</maml:name> <!-- Parameter: DraftSpace --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>DraftSpace</maml:name> <maml:description> <maml:para>Switch parameter to disable Draft Space for Content Manager deployment</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ReviewSpace --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ReviewSpace</maml:name> <maml:description> <maml:para>Switch parameter to disable Review Space for Content Manager deployment</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: DocumentHistoryForDraftSpace --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>DocumentHistoryForDraftSpace</maml:name> <maml:description> <maml:para>Switch parameter to disable Document History for Content Manager deployment</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ReviewSpace --> <command:syntaxItem> <maml:name>Disable-ISHUICollectiveSpaces</maml:name> <!-- Parameter: ReviewSpace --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ReviewSpace</maml:name> <maml:description> <maml:para>Switch parameter to disable Review Space for Content Manager deployment</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ReviewSpaceAndDocumentHistoryForDraftSpace --> <command:syntaxItem> <maml:name>Disable-ISHUICollectiveSpaces</maml:name> <!-- Parameter: ReviewSpace --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ReviewSpace</maml:name> <maml:description> <maml:para>Switch parameter to disable Review Space for Content Manager deployment</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: DocumentHistoryForDraftSpace --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>DocumentHistoryForDraftSpace</maml:name> <maml:description> <maml:para>Switch parameter to disable Document History for Content Manager deployment</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: DocumentHistoryForDraftSpace --> <command:syntaxItem> <maml:name>Disable-ISHUICollectiveSpaces</maml:name> <!-- Parameter: DocumentHistoryForDraftSpace --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>DocumentHistoryForDraftSpace</maml:name> <maml:description> <maml:para>Switch parameter to disable Document History for Content Manager deployment</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: DraftSpace --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>DraftSpace</maml:name> <maml:description> <maml:para>Switch parameter to disable Draft Space for Content Manager deployment</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ReviewSpace --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ReviewSpace</maml:name> <maml:description> <maml:para>Switch parameter to disable Review Space for Content Manager deployment</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: DocumentHistoryForDraftSpace --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>DocumentHistoryForDraftSpace</maml:name> <maml:description> <maml:para>Switch parameter to disable Document History for Content Manager deployment</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Disable-ISHUICollectiveSpaces -ISHDeployment $deployment -DraftSpace</dev:code> <dev:remarks> <maml:para>This command disables Draft Space. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\>Disable-ISHUICollectiveSpaces -ISHDeployment $deployment -ReviewSpace</dev:code> <dev:remarks> <maml:para>This command disables Review Space. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\>Disable-ISHUICollectiveSpaces -ISHDeployment $deployment -DocumentHistoryForDraftSpace</dev:code> <dev:remarks> <maml:para>This command disables Document History. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>PS C:\>Disable-ISHUICollectiveSpaces -ISHDeployment $deployment -DraftSpace -ReviewSpace</dev:code> <dev:remarks> <maml:para>This command disables Collective Spaces (both Review and Draft features). Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 5 ----------</maml:title> <dev:code>PS C:\>Disable-ISHUICollectiveSpaces -ISHDeployment $deployment -DraftSpace -DocumentHistoryForDraftSpace</dev:code> <dev:remarks> <maml:para>This command disables Draft Space and Document History. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 6 ----------</maml:title> <dev:code>PS C:\>Disable-ISHUICollectiveSpaces -ISHDeployment $deployment -DraftSpace -ReviewSpace -DocumentHistoryForDraftSpace</dev:code> <dev:remarks> <maml:para>This command disables Collective Spaces (both Review and Draft features) and Document History. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Enable-ISHUICollectiveSpaces</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Enable-ISHUICollectiveSpaces --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Enable-ISHUICollectiveSpaces</command:name> <command:verb>Enable</command:verb> <command:noun>ISHUICollectiveSpaces</command:noun> <maml:description> <maml:para>Enables Collective Spaces for Content Manager deployment.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Enable-ISHUICollectiveSpaces cmdlet enables Collective Spaces for Content Manager deployment.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: DraftSpace --> <command:syntaxItem> <maml:name>Enable-ISHUICollectiveSpaces</maml:name> <!-- Parameter: DraftSpace --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>DraftSpace</maml:name> <maml:description> <maml:para>Switch parameter to enable Draft Space for Content Manager deployment</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: DraftSpaceAndReviewSpace --> <command:syntaxItem> <maml:name>Enable-ISHUICollectiveSpaces</maml:name> <!-- Parameter: DraftSpace --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>DraftSpace</maml:name> <maml:description> <maml:para>Switch parameter to enable Draft Space for Content Manager deployment</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ReviewSpace --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ReviewSpace</maml:name> <maml:description> <maml:para>Switch parameter to enable Review Space for Content Manager deployment</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: DraftSpaceAndDocumentHistoryForDraftSpace --> <command:syntaxItem> <maml:name>Enable-ISHUICollectiveSpaces</maml:name> <!-- Parameter: DraftSpace --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>DraftSpace</maml:name> <maml:description> <maml:para>Switch parameter to enable Draft Space for Content Manager deployment</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: DocumentHistoryForDraftSpace --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>DocumentHistoryForDraftSpace</maml:name> <maml:description> <maml:para>Switch parameter to enable Document History for Content Manager deployment</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: All --> <command:syntaxItem> <maml:name>Enable-ISHUICollectiveSpaces</maml:name> <!-- Parameter: DraftSpace --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>DraftSpace</maml:name> <maml:description> <maml:para>Switch parameter to enable Draft Space for Content Manager deployment</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ReviewSpace --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ReviewSpace</maml:name> <maml:description> <maml:para>Switch parameter to enable Review Space for Content Manager deployment</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: DocumentHistoryForDraftSpace --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>DocumentHistoryForDraftSpace</maml:name> <maml:description> <maml:para>Switch parameter to enable Document History for Content Manager deployment</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ReviewSpace --> <command:syntaxItem> <maml:name>Enable-ISHUICollectiveSpaces</maml:name> <!-- Parameter: ReviewSpace --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ReviewSpace</maml:name> <maml:description> <maml:para>Switch parameter to enable Review Space for Content Manager deployment</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ReviewSpaceAndDocumentHistoryForDraftSpace --> <command:syntaxItem> <maml:name>Enable-ISHUICollectiveSpaces</maml:name> <!-- Parameter: ReviewSpace --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ReviewSpace</maml:name> <maml:description> <maml:para>Switch parameter to enable Review Space for Content Manager deployment</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: DocumentHistoryForDraftSpace --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>DocumentHistoryForDraftSpace</maml:name> <maml:description> <maml:para>Switch parameter to enable Document History for Content Manager deployment</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: DocumentHistoryForDraftSpace --> <command:syntaxItem> <maml:name>Enable-ISHUICollectiveSpaces</maml:name> <!-- Parameter: DocumentHistoryForDraftSpace --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>DocumentHistoryForDraftSpace</maml:name> <maml:description> <maml:para>Switch parameter to enable Document History for Content Manager deployment</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: DraftSpace --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>DraftSpace</maml:name> <maml:description> <maml:para>Switch parameter to enable Draft Space for Content Manager deployment</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ReviewSpace --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ReviewSpace</maml:name> <maml:description> <maml:para>Switch parameter to enable Review Space for Content Manager deployment</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: DocumentHistoryForDraftSpace --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>DocumentHistoryForDraftSpace</maml:name> <maml:description> <maml:para>Switch parameter to enable Document History for Content Manager deployment</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Enable-ISHUICollectiveSpaces -ISHDeployment $deployment -DraftSpace</dev:code> <dev:remarks> <maml:para>This command enables Draft Space. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\>Enable-ISHUICollectiveSpaces -ISHDeployment $deployment -ReviewSpace</dev:code> <dev:remarks> <maml:para>This command enables Review Space. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\>Enable-ISHUICollectiveSpaces -ISHDeployment $deployment -DocumentHistoryForDraftSpace</dev:code> <dev:remarks> <maml:para>This command enables Document History. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>PS C:\>Enable-ISHUICollectiveSpaces -ISHDeployment $deployment -DraftSpace -ReviewSpace</dev:code> <dev:remarks> <maml:para>This command enables Collective Spaces (both Review and Draft features). Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 5 ----------</maml:title> <dev:code>PS C:\>Enable-ISHUICollectiveSpaces -ISHDeployment $deployment -DraftSpace -DocumentHistoryForDraftSpace</dev:code> <dev:remarks> <maml:para>This command enables Draft Space and Document History. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 6 ----------</maml:title> <dev:code>PS C:\>Enable-ISHUICollectiveSpaces -ISHDeployment $deployment -DraftSpace -ReviewSpace -DocumentHistoryForDraftSpace</dev:code> <dev:remarks> <maml:para>This command enables Collective Spaces (both Review and Draft features) and Document History. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Disable-ISHUICollectiveSpaces</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Disable-ISHUIContentEditor --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Disable-ISHUIContentEditor</command:name> <command:verb>Disable</command:verb> <command:noun>ISHUIContentEditor</command:noun> <maml:description> <maml:para>Disables Content Editor for Content Manager deployment.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Disable-ISHUIContentEditor cmdlet disables Content Editor for Content Manager deployment.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Disable-ISHUIContentEditor</maml:name> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Disable-ISHUIContentEditor -ISHDeployment $deployment</dev:code> <dev:remarks> <maml:para>This command disables Content Editor. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Enable-ISHUIContentEditor</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Enable-ISHUIContentEditor --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Enable-ISHUIContentEditor</command:name> <command:verb>Enable</command:verb> <command:noun>ISHUIContentEditor</command:noun> <maml:description> <maml:para>Enables Content Editor for Content Manager deployment.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Enable-ISHUIContentEditor cmdlet enables Content Editor for Content Manager deployment.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Enable-ISHUIContentEditor</maml:name> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Enable-ISHUIContentEditor -ISHDeployment $deployment</dev:code> <dev:remarks> <maml:para>This command enables Content Editor. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Disable-ISHUIContentEditor</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Move-ISHUIEventMonitorMenuBarItem --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Move-ISHUIEventMonitorMenuBarItem</command:name> <command:verb>Move</command:verb> <command:noun>ISHUIEventMonitorMenuBarItem</command:noun> <maml:description> <maml:para>Manipulates with definitions in EventMonitorTab.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Move-ISHUIEventMonitorMenuBarItem cmdlet moves Tabs definitions in Content Manager deployment.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Last --> <command:syntaxItem> <maml:name>Move-ISHUIEventMonitorMenuBarItem</maml:name> <!-- Parameter: Label --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Label</maml:name> <maml:description> <maml:para>Label of menu item.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Last --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Last</maml:name> <maml:description> <maml:para>Menu item move to the last position.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: First --> <command:syntaxItem> <maml:name>Move-ISHUIEventMonitorMenuBarItem</maml:name> <!-- Parameter: Label --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Label</maml:name> <maml:description> <maml:para>Label of menu item.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: First --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>First</maml:name> <maml:description> <maml:para>Menu item move to the first position.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: After --> <command:syntaxItem> <maml:name>Move-ISHUIEventMonitorMenuBarItem</maml:name> <!-- Parameter: Label --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Label</maml:name> <maml:description> <maml:para>Label of menu item.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: After --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>After</maml:name> <maml:description> <maml:para>Menu item move position.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Label --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Label</maml:name> <maml:description> <maml:para>Label of menu item.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Last --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Last</maml:name> <maml:description> <maml:para>Menu item move to the last position.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: First --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>First</maml:name> <maml:description> <maml:para>Menu item move to the first position.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: After --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>After</maml:name> <maml:description> <maml:para>Menu item move position.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Move-ISHUIEventMonitorMenuBarItem -ISHDeployment $deployment -Label "Publish" -First</dev:code> <dev:remarks> <maml:para>Moves definition of the "Publish" to the top.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\>Move-ISHUIEventMonitorMenuBarItem -ISHDeployment $deployment -Label "Publish" -Last</dev:code> <dev:remarks> <maml:para>Moves definition of the "Publish" to the bottom.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\>Move-ISHUIEventMonitorMenuBarItem -ISHDeployment $deployment -Label "Translation" -After "Publish"</dev:code> <dev:remarks> <maml:para>Moves definition of the "Translation" after "Publish".</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Set-ISHUIEventMonitorMenuBarItem</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-ISHUIEventMonitorMenuBarItem</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Remove-ISHUIEventMonitorMenuBarItem --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-ISHUIEventMonitorMenuBarItem</command:name> <command:verb>Remove</command:verb> <command:noun>ISHUIEventMonitorMenuBarItem</command:noun> <maml:description> <maml:para>Removes tab from EventMonitorTab.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Removes-ISHUIEventMonitorMenuBarItem cmdlet removes Tabs definitions from Content Manager deployment.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Remove-ISHUIEventMonitorMenuBarItem</maml:name> <!-- Parameter: Label --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Label</maml:name> <maml:description> <maml:para>Label of menu item.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Label --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Label</maml:name> <maml:description> <maml:para>Label of menu item.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Remove-ISHUIEventMonitorMenuBarItem -ISHDeployment $deployment -Label "Translation"</dev:code> <dev:remarks> <maml:para>Removes definition of the tab with label "Translation". This command removes XML definitions from EventMonitor. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Set-ISHUIEventMonitorMenuBarItem</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Move-ISHUIEventMonitorMenuBarItem</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Set-ISHUIEventMonitorMenuBarItem --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-ISHUIEventMonitorMenuBarItem</command:name> <command:verb>Set</command:verb> <command:noun>ISHUIEventMonitorMenuBarItem</command:noun> <maml:description> <maml:para>Update or add a new EventMonitor tab.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-ISHUIEventMonitorMenuBarItem cmdlet updates or adds new Tab definitions to Content Manager deployment.</maml:para> <maml:para>If Icon is not specified, the default value '~/UIFramework/events.32x32.png' is taken.</maml:para> <maml:para>If UserRole is not specified, the default value 'Administrator' is taken.</maml:para> <maml:para>If ModifiedSinceMinutesFilter is not specified, the default value '1440' is taken.</maml:para> <maml:para>If SelectedStatusFilter is not specified, the default value 'Recent' is taken.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-ISHUIEventMonitorMenuBarItem</maml:name> <!-- Parameter: Label --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Label</maml:name> <maml:description> <maml:para>Label of menu item.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Icon --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Icon</maml:name> <maml:description> <maml:para>Menu item icon representation. Default value is '~/UIFramework/events.32x32.png'.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>~/UIFramework/events.32x32.png</dev:defaultValue> </command:parameter> <!-- Parameter: EventTypesFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EventTypesFilter</maml:name> <maml:description> <maml:para>Status filter. Null by default</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SelectedStatusFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SelectedStatusFilter</maml:name> <maml:description> <maml:para>Selected Status filter. Default value is 'Recent'.</maml:para> <maml:para>Possible values: Busy, Recent, Warning, Failed, All</maml:para> </maml:description> <command:parameterValue required="true">StatusFilter</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Cmdlets.ISHUIEventMonitorMenuBarItem.SetISHUIEventMonitorMenuBarItemCmdlet+StatusFilter</maml:name> <maml:uri /> <maml:description> <maml:para>Enumeration of status filters.</maml:para> </maml:description> </dev:type> <dev:defaultValue>Recent</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Busy</command:parameterValue> <command:parameterValue required="false" variableLength="false">Recent</command:parameterValue> <command:parameterValue required="false" variableLength="false">Warning</command:parameterValue> <command:parameterValue required="false" variableLength="false">Failed</command:parameterValue> <command:parameterValue required="false" variableLength="false">All</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: ModifiedSinceMinutesFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ModifiedSinceMinutesFilter</maml:name> <maml:description> <maml:para>Modified since minutes filter value. Default value is '1440'.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1440</dev:defaultValue> </command:parameter> <!-- Parameter: UserRole --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>UserRole</maml:name> <maml:description> <maml:para>Can be applied for roles.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>User role description.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Label --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Label</maml:name> <maml:description> <maml:para>Label of menu item.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Icon --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Icon</maml:name> <maml:description> <maml:para>Menu item icon representation. Default value is '~/UIFramework/events.32x32.png'.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>~/UIFramework/events.32x32.png</dev:defaultValue> </command:parameter> <!-- Parameter: EventTypesFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EventTypesFilter</maml:name> <maml:description> <maml:para>Status filter. Null by default</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SelectedStatusFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SelectedStatusFilter</maml:name> <maml:description> <maml:para>Selected Status filter. Default value is 'Recent'.</maml:para> <maml:para>Possible values: Busy, Recent, Warning, Failed, All</maml:para> </maml:description> <command:parameterValue required="true">StatusFilter</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Cmdlets.ISHUIEventMonitorMenuBarItem.SetISHUIEventMonitorMenuBarItemCmdlet+StatusFilter</maml:name> <maml:uri /> <maml:description> <maml:para>Enumeration of status filters.</maml:para> </maml:description> </dev:type> <dev:defaultValue>Recent</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Busy</command:parameterValue> <command:parameterValue required="false" variableLength="false">Recent</command:parameterValue> <command:parameterValue required="false" variableLength="false">Warning</command:parameterValue> <command:parameterValue required="false" variableLength="false">Failed</command:parameterValue> <command:parameterValue required="false" variableLength="false">All</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: ModifiedSinceMinutesFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ModifiedSinceMinutesFilter</maml:name> <maml:description> <maml:para>Modified since minutes filter value. Default value is '1440'.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1440</dev:defaultValue> </command:parameter> <!-- Parameter: UserRole --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>UserRole</maml:name> <maml:description> <maml:para>Can be applied for roles.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>User role description.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Set-ISHUIEventMonitorMenuBarItem -ISHDeployment $deployment -Label "All Parameters" -Icon "~/Custom/Images/Custom.png" -EventTypesFilter @("EXPORTFORPUBLICATION", "EXPORTFORPUBLICATIONPDF", "EXPORTFORPUBLICATIONZIP") -SelectedStatusFilter "All" -ModifiedSinceMinutesFilter "3600" -UserRole @("Administrator","Author") -Description "Tab using all available parameters"</dev:code> <dev:remarks> <maml:para>Sets new tab with all sets of available and provided parameters.</maml:para> <maml:para>This command sets XML definitions to EventMonitor. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\>Set-ISHUIEventMonitorMenuBarItem -ISHDeployment $deployment -Label "Defaults" -Description "Using default parameters" -UserRole @("Administrator","Author")</dev:code> <dev:remarks> <maml:para>Sets new tab with default set of provided parameters.</maml:para> <maml:para>This command sets XML definitions to EventMonitor. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Move-ISHUIEventMonitorMenuBarItem</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-ISHUIEventMonitorMenuBarItem</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Move-ISHUIMainMenuBarItem --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Move-ISHUIMainMenuBarItem</command:name> <command:verb>Move</command:verb> <command:noun>ISHUIMainMenuBarItem</command:noun> <maml:description> <maml:para>Manipulates with definitions in MainMenuBar.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Move-ISHUIMainMenuBarItem cmdlet moves Buttons definitions in Content Manager deployment.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Last --> <command:syntaxItem> <maml:name>Move-ISHUIMainMenuBarItem</maml:name> <!-- Parameter: Label --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Label</maml:name> <maml:description> <maml:para>Label of menu item.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Last --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Last</maml:name> <maml:description> <maml:para>Menu item move to the last position.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: First --> <command:syntaxItem> <maml:name>Move-ISHUIMainMenuBarItem</maml:name> <!-- Parameter: Label --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Label</maml:name> <maml:description> <maml:para>Label of menu item.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: First --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>First</maml:name> <maml:description> <maml:para>Menu item move to the first position.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: After --> <command:syntaxItem> <maml:name>Move-ISHUIMainMenuBarItem</maml:name> <!-- Parameter: Label --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Label</maml:name> <maml:description> <maml:para>Label of menu item.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: After --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>After</maml:name> <maml:description> <maml:para>Menu item move position.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Label --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Label</maml:name> <maml:description> <maml:para>Label of menu item.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Last --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Last</maml:name> <maml:description> <maml:para>Menu item move to the last position.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: First --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>First</maml:name> <maml:description> <maml:para>Menu item move to the first position.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: After --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>After</maml:name> <maml:description> <maml:para>Menu item move position.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Move-ISHUIMainMenuBarItem -ISHDeployment $deployment -Label "Publish" -First</dev:code> <dev:remarks> <maml:para>Moves definition of the "Publish" to the top.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\>Move-ISHUIMainMenuBarItem -ISHDeployment $deployment -Label "Publish" -Last</dev:code> <dev:remarks> <maml:para>Moves definition of the "Publish" to the bottom.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\>Move-ISHUIMainMenuBarItem -ISHDeployment $deployment -Label "Translation" -After "Publish"</dev:code> <dev:remarks> <maml:para>Moves definition of the "Translation" after "Publish".</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Set-ISHUIMainMenuBarItem</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-ISHUIMainMenuBarItem</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Remove-ISHUIMainMenuBarItem --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-ISHUIMainMenuBarItem</command:name> <command:verb>Remove</command:verb> <command:noun>ISHUIMainMenuBarItem</command:noun> <maml:description> <maml:para>Removes button from MainMenuBar.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Removes-ISHUIMainMenuBarItem cmdlet removes Buttons definitions from Content Manager deployment.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Remove-ISHUIMainMenuBarItem</maml:name> <!-- Parameter: Label --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Label</maml:name> <maml:description> <maml:para>Label of menu item.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Label --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Label</maml:name> <maml:description> <maml:para>Label of menu item.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Remove-ISHUIMainMenuBarItem -ISHDeployment $deployment -Label "Translation"</dev:code> <dev:remarks> <maml:para>Removes definition of the button with label "Translation". This command removes XML definitions from EventMonitor. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Set-ISHUIMainMenuBarItem</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Move-ISHUIMainMenuBarItem</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Set-ISHUIMainMenuBarItem --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-ISHUIMainMenuBarItem</command:name> <command:verb>Set</command:verb> <command:noun>ISHUIMainMenuBarItem</command:noun> <maml:description> <maml:para>Update or add a new MainMenuBar button.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-ISHUIMainMenuBarItem cmdlet updates or adds new Button definitions to Content Manager deployment.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-ISHUIMainMenuBarItem</maml:name> <!-- Parameter: Label --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Label</maml:name> <maml:description> <maml:para>Label of menu item.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserRole --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>UserRole</maml:name> <maml:description> <maml:para>The list of users for whom the menu item is available.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Action --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Action</maml:name> <maml:description> <maml:para>The action which occurs on click on the menu item.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ID --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ID</maml:name> <maml:description> <maml:para>The menu item identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Label --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Label</maml:name> <maml:description> <maml:para>Label of menu item.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserRole --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>UserRole</maml:name> <maml:description> <maml:para>The list of users for whom the menu item is available.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Action --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Action</maml:name> <maml:description> <maml:para>The action which occurs on click on the menu item.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ID --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ID</maml:name> <maml:description> <maml:para>The menu item identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Set-ISHUIMainMenuBarItem -ISHDeployment $deployment -Label "Inbox" -Action "ShowSubMenu.asp?Menu=2" -UserRole Author, Reviewer</dev:code> <dev:remarks> <maml:para>This command add/update main menu item.</maml:para> <maml:para>This command sets XML definitions to MainMenuBar. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Move-ISHUIMainMenuBarItem</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-ISHUIMainMenuBarItem</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Disable-ISHUIQualityAssistant --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Disable-ISHUIQualityAssistant</command:name> <command:verb>Disable</command:verb> <command:noun>ISHUIQualityAssistant</command:noun> <maml:description> <maml:para>Disables Quality Assistant for Content Manager deployment.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Disable-ISHUIQualityAssistant cmdlet disables Quality Assistant for Content Manager deployment.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Disable-ISHUIQualityAssistant</maml:name> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Disable-ISHUIQualityAssistant -ISHDeployment $deployment</dev:code> <dev:remarks> <maml:para>This command disables Quality Assistant. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Enable-ISHUIQualityAssistant</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Enable-ISHUIQualityAssistant --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Enable-ISHUIQualityAssistant</command:name> <command:verb>Enable</command:verb> <command:noun>ISHUIQualityAssistant</command:noun> <maml:description> <maml:para>Enables Quality Assistant for Content Manager deployment.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Enable-ISHUIQualityAssistant cmdlet enables Quality Assistant for Content Manager deployment.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Enable-ISHUIQualityAssistant</maml:name> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Enable-ISHUIQualityAssistant -ISHDeployment $deployment</dev:code> <dev:remarks> <maml:para>This command enables Quality Assistant. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Disable-ISHUIQualityAssistant</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Move-ISHUISearchMenuBarItem --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Move-ISHUISearchMenuBarItem</command:name> <command:verb>Move</command:verb> <command:noun>ISHUISearchMenuBarItem</command:noun> <maml:description> <maml:para>Manipulates with definitions in SearchMenuBar.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Move-ISHUISearchMenuBarItem cmdlet moves Buttons definitions in Content Manager deployment.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Last --> <command:syntaxItem> <maml:name>Move-ISHUISearchMenuBarItem</maml:name> <!-- Parameter: Label --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Label</maml:name> <maml:description> <maml:para>Label of menu item.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Last --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Last</maml:name> <maml:description> <maml:para>Menu item move to the last position.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: First --> <command:syntaxItem> <maml:name>Move-ISHUISearchMenuBarItem</maml:name> <!-- Parameter: Label --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Label</maml:name> <maml:description> <maml:para>Label of menu item.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: First --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>First</maml:name> <maml:description> <maml:para>Menu item move to the first position.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: After --> <command:syntaxItem> <maml:name>Move-ISHUISearchMenuBarItem</maml:name> <!-- Parameter: Label --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Label</maml:name> <maml:description> <maml:para>Label of menu item.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: After --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>After</maml:name> <maml:description> <maml:para>Menu item move position.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Label --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Label</maml:name> <maml:description> <maml:para>Label of menu item.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Last --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Last</maml:name> <maml:description> <maml:para>Menu item move to the last position.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: First --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>First</maml:name> <maml:description> <maml:para>Menu item move to the first position.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: After --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>After</maml:name> <maml:description> <maml:para>Menu item move position.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Move-ISHUISearchMenuBarItem -ISHDeployment $deployment -Label "Publish" -First</dev:code> <dev:remarks> <maml:para>Moves definition of the "Publish" to the top.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\>Move-ISHUISearchMenuBarItem -ISHDeployment $deployment -Label "Publish" -Last</dev:code> <dev:remarks> <maml:para>Moves definition of the "Publish" to the bottom.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\>Move-ISHUISearchMenuBarItem -ISHDeployment $deployment -Label "Translation" -After "Publish"</dev:code> <dev:remarks> <maml:para>Moves definition of the "Translation" after "Publish".</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Set-ISHUISearchMenuBarItem</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-ISHUISearchMenuBarItem</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Remove-ISHUISearchMenuBarItem --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-ISHUISearchMenuBarItem</command:name> <command:verb>Remove</command:verb> <command:noun>ISHUISearchMenuBarItem</command:noun> <maml:description> <maml:para>Removes button from SearchMenuBar.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Removes-ISHUISearchMenuBarItem cmdlet removes Buttons definitions from Content Manager deployment.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Remove-ISHUISearchMenuBarItem</maml:name> <!-- Parameter: Label --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Label</maml:name> <maml:description> <maml:para>Label of menu item.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Label --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Label</maml:name> <maml:description> <maml:para>Label of menu item.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Remove-ISHUISearchMenuBarItem -ISHDeployment $deployment -Label "Translation"</dev:code> <dev:remarks> <maml:para>Removes definition of the button with label "Translation". This command removes XML definitions from EventMonitor. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Set-ISHUISearchMenuBarItem</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Move-ISHUISearchMenuBarItem</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Set-ISHUISearchMenuBarItem --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-ISHUISearchMenuBarItem</command:name> <command:verb>Set</command:verb> <command:noun>ISHUISearchMenuBarItem</command:noun> <maml:description> <maml:para>Create/Update search menu item.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-ISHUISearchMenuBarItem cmdlet add or update search menu item.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-ISHUISearchMenuBarItem</maml:name> <!-- Parameter: Label --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Label</maml:name> <maml:description> <maml:para>Label of menu item.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserRole --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>UserRole</maml:name> <maml:description> <maml:para>The list of users for whom the menu item is available.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Type --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Type</maml:name> <maml:description> <maml:para>Search type will choose asp page SearchFrame.asp or SearchNewPublications.asp.</maml:para> <maml:para>Possible values: Publication, Default</maml:para> </maml:description> <command:parameterValue required="true">UISearchMenuSearchType</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Enums.UISearchMenuSearchType</maml:name> <maml:uri /> <maml:description> <maml:para>Enumeration of search type to choose asp page SearchFrame.asp or SearchNewPublications.asp.</maml:para> </maml:description> </dev:type> <dev:defaultValue>Publication</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Publication</command:parameterValue> <command:parameterValue required="false" variableLength="false">Default</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Icon --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Icon</maml:name> <maml:description> <maml:para>Icon for a menu.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SearchXML --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SearchXML</maml:name> <maml:description> <maml:para>SearchXML parameter in action. By default is the same as SearchType.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Label --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Label</maml:name> <maml:description> <maml:para>Label of menu item.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserRole --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>UserRole</maml:name> <maml:description> <maml:para>The list of users for whom the menu item is available.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Type --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Type</maml:name> <maml:description> <maml:para>Search type will choose asp page SearchFrame.asp or SearchNewPublications.asp.</maml:para> <maml:para>Possible values: Publication, Default</maml:para> </maml:description> <command:parameterValue required="true">UISearchMenuSearchType</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Enums.UISearchMenuSearchType</maml:name> <maml:uri /> <maml:description> <maml:para>Enumeration of search type to choose asp page SearchFrame.asp or SearchNewPublications.asp.</maml:para> </maml:description> </dev:type> <dev:defaultValue>Publication</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Publication</command:parameterValue> <command:parameterValue required="false" variableLength="false">Default</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Icon --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Icon</maml:name> <maml:description> <maml:para>Icon for a menu.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SearchXML --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SearchXML</maml:name> <maml:description> <maml:para>SearchXML parameter in action. By default is the same as SearchType.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Set-ISHUISearchMenuBarItem -ISHDeployment $deployment -Label "Search" -SearchXML "SearchNewGeneral" -Type Publication -UserRole Author, Reviewer</dev:code> <dev:remarks> <maml:para>This command add/update search menu item. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Move-ISHUISearchMenuBarItem</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-ISHUISearchMenuBarItem</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Disable-ISHUITranslationJob --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Disable-ISHUITranslationJob</command:name> <command:verb>Disable</command:verb> <command:noun>ISHUITranslationJob</command:noun> <maml:description> <maml:para>Disables translation job for Content Manager deployment.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Disable-ISHUITranslationJob cmdlet disables translation job for Content Manager deployment.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Disable-ISHUITranslationJob</maml:name> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Disable-ISHUITranslationJob -ISHDeployment $deployment</dev:code> <dev:remarks> <maml:para>This command disables translation job. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Enable-ISHUITranslationJob</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Enable-ISHUITranslationJob --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Enable-ISHUITranslationJob</command:name> <command:verb>Enable</command:verb> <command:noun>ISHUITranslationJob</command:noun> <maml:description> <maml:para>Enable translation job for Content Manager deployment.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Enable-ISHUITranslationJob cmdlet enables translation job for Content Manager deployment.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Enable-ISHUITranslationJob</maml:name> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ISHDeployment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the name or instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Common.Models.ISHDeployment</maml:name> <maml:uri /> <maml:description> <maml:para>Represents the installed Content Manager deployment.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>Enable-ISHUITranslationJob -ISHDeployment $deployment</dev:code> <dev:remarks> <maml:para>This command enables translation job. Parameter $deployment is a deployment name or an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Disable-ISHUITranslationJob</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> </helpItems> |