ISHDeploy.12.0.0.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <!-- 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. Default value is 'ChainTrust'.</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>ChainTrust</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: ISHDeployment --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Models.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. Default value is 'ChainTrust'.</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>ChainTrust</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: ISHDeployment --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Models.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 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 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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Models.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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Models.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> <maml:introduction> <maml:para></maml:para> </maml:introduction> <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 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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Models.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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Models.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 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: 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:relatedLinks> </command:command> <!-- Cmdlet: Undo-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>Undo-ISHDeployment</command:name> <command:verb>Undo</command:verb> <command:noun>ISHDeployment</command:noun> <maml:description> <maml:para>Reverts all customization done by cmdlets back to original state for specific Content Manager deployment.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Undo-ISHDeployment cmdlet reverts all customization done by cmdlets back to original state for specific Content Manager deployment.</maml:para> <maml:para>Original state means the state of the system when it was installed and no customization was made.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Undo-ISHDeployment</maml:name> <!-- Parameter: ISHDeployment --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Models.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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Models.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-ISHDeployment -ISHDeployment $deployment</dev:code> <dev:remarks> <maml:para>This command reverts Content Manager to original state. 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>Clear-ISHDeploymentHistory</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ISHDeployment</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ISHDeploymentHistory</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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Models.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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Models.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 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: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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Models.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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Models.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 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: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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Models.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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Models.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 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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Models.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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Models.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 -ExternalId 'user1'</dev:code> <dev:remarks> <maml:para>This command enables the external preview for user 'user1'. 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>Disable-ISHExternalPreview</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </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.Business.Operations.ISHIntegrationDB.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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Models.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.Business.Operations.ISHIntegrationDB.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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Models.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 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 an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> </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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Models.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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Models.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 an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> </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. Default value is 'ChainTrust'.</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>ChainTrust</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: ISHDeployment --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Models.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. Default value is 'ChainTrust'.</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>ChainTrust</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: ISHDeployment --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Models.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 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 an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> </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-ISHIntegrationSTSConfigurationPackageCmdlet 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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Models.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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Models.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-ISHIntegrationSTSConfigurationPackageCmdlet -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 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-ISHIntegrationSTSConfigurationPackageCmdlet -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 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-ISHIntegrationSTSWSTrustCmdlet</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 to issuer 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: ISHDeployment --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Models.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 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: ISHDeployment --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Models.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.com/adfs/ls/"</dev:code> <dev:remarks> <maml:para>This command configure WS Federation to use specified Endpoint of STS server. 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-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.Business.Operations.ISHIntegrationSTSWS.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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Models.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.Business.Operations.ISHIntegrationSTSWS.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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Models.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 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 an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> </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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Models.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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Models.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 an instance of the Content Manager deployment retrieved from Get-ISHDeployment cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> </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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Models.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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Models.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 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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Models.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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Models.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 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-ISHUIEventMonitorTab --> <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-ISHUIEventMonitorTab</command:name> <command:verb>Move</command:verb> <command:noun>ISHUIEventMonitorTab</command:noun> <maml:description> <maml:para>Manipulates with definitions in EventMonitorTab.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Move-ISHUIEventMonitorTab cmdlet moves Tabs definitions in Content Manager deployment.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Last --> <command:syntaxItem> <maml:name>Move-ISHUIEventMonitorTab</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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Models.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-ISHUIEventMonitorTab</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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Models.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-ISHUIEventMonitorTab</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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Models.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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Models.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-ISHUIEventMonitorTab -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-ISHUIEventMonitorTab -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-ISHUIEventMonitorTab -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-ISHUIEventMonitorTab</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-ISHUIEventMonitorTab</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Remove-ISHUIEventMonitorTab --> <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-ISHUIEventMonitorTab</command:name> <command:verb>Remove</command:verb> <command:noun>ISHUIEventMonitorTab</command:noun> <maml:description> <maml:para>Removes tab from EventMonitorTab.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Removes-ISHUIEventMonitorTab cmdlet removes Tabs definitions from Content Manager deployment.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Remove-ISHUIEventMonitorTab</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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Models.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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Models.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-ISHUIEventMonitorTab -ISHDeployment $deployment -Label "Translation"</dev:code> <dev:remarks> <maml:para>Removes definition of the tab with label "Translation".</maml:para> <maml:para>This command removes XML definitions from EventMonitor. 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>Set-ISHUIEventMonitorTab</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Move-ISHUIEventMonitorTab</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Set-ISHUIEventMonitorTab --> <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-ISHUIEventMonitorTab</command:name> <command:verb>Set</command:verb> <command:noun>ISHUIEventMonitorTab</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-ISHUIEventMonitorTab 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-ISHUIEventMonitorTab</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.ISHUIEventMonitorTab.SetISHUIEventMonitorTabCmdlet+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="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UserRole</maml:name> <maml:description> <maml:para>Action of menu item. Default value is 'Administrator'.</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>Administrator</dev:defaultValue> </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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Models.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.ISHUIEventMonitorTab.SetISHUIEventMonitorTabCmdlet+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="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UserRole</maml:name> <maml:description> <maml:para>Action of menu item. Default value is 'Administrator'.</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>Administrator</dev:defaultValue> </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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Models.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-ISHUIEventMonitorTab -ISHDeployment $deployment -Label "All Parameters" -Icon "~/UIFramework/new-tab.job.32x32.png" -EventTypesFilter @("EXPORTFORPUBLICATION", "EXPORTFORPUBLICATIONPDF", "EXPORTFORPUBLICATIONZIP") -SelectedStatusFilter "All" -ModifiedSinceMinutesFilter "3600" -UserRole "Administrator" -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 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-ISHUIEventMonitorTab -ISHDeployment $deployment -Label "Defaults" -Description "Using default parameters"</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 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-ISHUIEventMonitorTab</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-ISHUIEventMonitorTab</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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Models.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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Models.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 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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Models.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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Models.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 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: 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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Models.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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Models.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 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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Models.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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ISHDeployment</maml:name> <maml:description> <maml:para>Specifies the instance of the Content Manager deployment.</maml:para> </maml:description> <command:parameterValue required="true">ISHDeployment</command:parameterValue> <dev:type> <maml:name>ISHDeploy.Models.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 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> |