ContactExpertRemoteManagement.dll-Help.xml
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <!-- Cmdlet: Get-CEDomains --> <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-CEDomains</command:name> <command:verb>Get</command:verb> <command:noun>CEDomains</command:noun> <maml:description> <maml:para>Gets available domains from the connected Contact Expert.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieves domains from the connected Contact Expert what the connected user has access to.</maml:para> <maml:para>To use this command, need opened Management Service connection. Use Get-CEManagementServiceConnection command to check connection state. Use Connect-CEManagementService command to connect.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-CEDomains</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues> <!-- OutputType: List`1 --> <command:returnValue> <dev:type> <maml:name>System.Collections.Generic.List`1[[ContactExpertRemoteManagement.Models.Domain, ContactExpertRemoteManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Get-CEDomains</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Connect-CEManagementService --> <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>Connect-CEManagementService</command:name> <command:verb>Connect</command:verb> <command:noun>CEManagementService</command:noun> <maml:description> <maml:para>Opens connection to Contact Expert Management Service.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Login with the specified user on Contact Expert Management Service and stores information for further requests.</maml:para> <maml:para>To check connection state use Get-CEManagementServiceConnection command.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Connect-CEManagementService</maml:name> <!-- Parameter: ManagementServiceUrl --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>ManagementServiceUrl</maml:name> <maml:description> <maml:para>URL for Contact Expert Management Service. (e.g. http://domainname.net/CEManagementSvc)</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Credential --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Credential</maml:name> <maml:description> <maml:para>"User credential for Contact Expert Management Service authentication.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UseWinAuth --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="2"> <maml:name>UseWinAuth</maml:name> <maml:description> <maml:para>Use this switch when the Contact Expert Management Service is configured for Windows Authentication.</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> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ManagementServiceUrl --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>ManagementServiceUrl</maml:name> <maml:description> <maml:para>URL for Contact Expert Management Service. (e.g. http://domainname.net/CEManagementSvc)</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Credential --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Credential</maml:name> <maml:description> <maml:para>"User credential for Contact Expert Management Service authentication.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UseWinAuth --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="2"> <maml:name>UseWinAuth</maml:name> <maml:description> <maml:para>Use this switch when the Contact Expert Management Service is configured for Windows Authentication.</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> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>URL for Contact Expert Management Service. (e.g. http://domainname.net/CEManagementSvc)</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>"User credential for Contact Expert Management Service authentication.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Use this switch when the Contact Expert Management Service is configured for Windows Authentication.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: ManagementServiceConnectionState --> <command:returnValue> <dev:type> <maml:name>ContactExpertRemoteManagement.Models.ManagementServiceConnectionState</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Represents the state of the connection to Management Service.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Connect-CEManagementService -ManagementServiceUrl "http://domainname.net/CEManagementSvc"</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>Connect-CEManagementService -ManagementServiceUrl "http://domainname.net/CEManagementSvc" -Credential $credential</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>Connect-CEManagementService -ManagementServiceUrl "http://domainname.net/CEManagementSvc" -Credential $credential -UseWinAuth</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Disconnect-CEManagementService --> <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>Disconnect-CEManagementService</command:name> <command:verb>Disconnect</command:verb> <command:noun>CEManagementService</command:noun> <maml:description> <maml:para>Closes connection to Contact Expert Management Service.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Removes connection information.</maml:para> <maml:para>To check connection state use Get-CEManagementServiceConnection command.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Disconnect-CEManagementService</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues> <!-- OutputType: ManagementServiceConnectionState --> <command:returnValue> <dev:type> <maml:name>ContactExpertRemoteManagement.Models.ManagementServiceConnectionState</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Represents the state of the connection to Management Service.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Disconnect-CEManagementService</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-CEManagementServiceConnection --> <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-CEManagementServiceConnection</command:name> <command:verb>Get</command:verb> <command:noun>CEManagementServiceConnection</command:noun> <maml:description> <maml:para>Gets the state of connection to Contact Expert Management Service.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns state of the connection, Management Service URL and user name used for connection.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-CEManagementServiceConnection</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues> <!-- OutputType: ManagementServiceConnectionState --> <command:returnValue> <dev:type> <maml:name>ContactExpertRemoteManagement.Models.ManagementServiceConnectionState</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Represents the state of the connection to Management Service.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Get-CEManagementServiceConnection</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Start-CEServers --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Start-CEServers</command:name> <command:verb>Start</command:verb> <command:noun>CEServers</command:noun> <maml:description> <maml:para>Starts Contact Expert server componens in the given domain on the selected servers.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This function is available only when all components stopped on the selected servers. To check the components on servers, use Get-CEServerStates command.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Start-CEServers</maml:name> <!-- Parameter: DomainId --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>DomainId</maml:name> <maml:description> <maml:para>Id of the domain which servers want to manage.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: ManageDomainServer --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>ManageDomainServer</maml:name> <maml:description> <maml:para>Select to which Contact Expert server start the server components on.</maml:para> <maml:para>Possible values: Primary, Secondary, PrimaryAndSecondary</maml:para> </maml:description> <command:parameterValue required="true">ManageDomainServerSelector</command:parameterValue> <dev:type> <maml:name>ContactExpertRemoteManagement.Models.ManageDomainServerSelector</maml:name> <maml:uri /> <maml:description> <maml:para>Selector to be able to define in Powershell which servers needs to be managed.</maml:para> </maml:description> </dev:type> <dev:defaultValue>Primary</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Primary</command:parameterValue> <command:parameterValue required="false" variableLength="false">Secondary</command:parameterValue> <command:parameterValue required="false" variableLength="false">PrimaryAndSecondary</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: DomainId --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>DomainId</maml:name> <maml:description> <maml:para>Id of the domain which servers want to manage.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: ManageDomainServer --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>ManageDomainServer</maml:name> <maml:description> <maml:para>Select to which Contact Expert server start the server components on.</maml:para> <maml:para>Possible values: Primary, Secondary, PrimaryAndSecondary</maml:para> </maml:description> <command:parameterValue required="true">ManageDomainServerSelector</command:parameterValue> <dev:type> <maml:name>ContactExpertRemoteManagement.Models.ManageDomainServerSelector</maml:name> <maml:uri /> <maml:description> <maml:para>Selector to be able to define in Powershell which servers needs to be managed.</maml:para> </maml:description> </dev:type> <dev:defaultValue>Primary</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Primary</command:parameterValue> <command:parameterValue required="false" variableLength="false">Secondary</command:parameterValue> <command:parameterValue required="false" variableLength="false">PrimaryAndSecondary</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Id of the domain which servers want to manage.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>ContactExpertRemoteManagement.Models.ManageDomainServerSelector</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Select to which Contact Expert server start the server components on.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Start-CEServers -DomainId 1 -ManageDomainServer Primary</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Stop-CEServers --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Stop-CEServers</command:name> <command:verb>Stop</command:verb> <command:noun>CEServers</command:noun> <maml:description> <maml:para>Stops Contact Expert server componens in the given domain on the selected servers.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>To check the components on servers, use Get-CEServerStates command.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Stop-CEServers</maml:name> <!-- Parameter: DomainId --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>DomainId</maml:name> <maml:description> <maml:para>Id of the domain which servers want to manage.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: ManageDomainServer --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>ManageDomainServer</maml:name> <maml:description> <maml:para>Select to which Contact Expert server stop the server components on.</maml:para> <maml:para>Possible values: Primary, Secondary, PrimaryAndSecondary</maml:para> </maml:description> <command:parameterValue required="true">ManageDomainServerSelector</command:parameterValue> <dev:type> <maml:name>ContactExpertRemoteManagement.Models.ManageDomainServerSelector</maml:name> <maml:uri /> <maml:description> <maml:para>Selector to be able to define in Powershell which servers needs to be managed.</maml:para> </maml:description> </dev:type> <dev:defaultValue>Primary</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Primary</command:parameterValue> <command:parameterValue required="false" variableLength="false">Secondary</command:parameterValue> <command:parameterValue required="false" variableLength="false">PrimaryAndSecondary</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: DomainId --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>DomainId</maml:name> <maml:description> <maml:para>Id of the domain which servers want to manage.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: ManageDomainServer --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>ManageDomainServer</maml:name> <maml:description> <maml:para>Select to which Contact Expert server stop the server components on.</maml:para> <maml:para>Possible values: Primary, Secondary, PrimaryAndSecondary</maml:para> </maml:description> <command:parameterValue required="true">ManageDomainServerSelector</command:parameterValue> <dev:type> <maml:name>ContactExpertRemoteManagement.Models.ManageDomainServerSelector</maml:name> <maml:uri /> <maml:description> <maml:para>Selector to be able to define in Powershell which servers needs to be managed.</maml:para> </maml:description> </dev:type> <dev:defaultValue>Primary</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Primary</command:parameterValue> <command:parameterValue required="false" variableLength="false">Secondary</command:parameterValue> <command:parameterValue required="false" variableLength="false">PrimaryAndSecondary</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Id of the domain which servers want to manage.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>ContactExpertRemoteManagement.Models.ManageDomainServerSelector</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Select to which Contact Expert server stop the server components on.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Stop-CEServers -DomainId 1 -ManageDomainServer Primary</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-CEServerStates --> <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-CEServerStates</command:name> <command:verb>Get</command:verb> <command:noun>CEServerStates</command:noun> <maml:description> <maml:para>Retrieves Contact Expert server states in the given domain.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns DomainState object which contanins servers state information. Use ToString() method on the result or call the command with Continue InformationAction to display the result.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-CEServerStates</maml:name> <!-- Parameter: DomainId --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>DomainId</maml:name> <maml:description> <maml:para>Id of the domain which servers want to retrieve the states for.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: DomainId --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>DomainId</maml:name> <maml:description> <maml:para>Id of the domain which servers want to retrieve the states for.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Id of the domain which servers want to retrieve the states for.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: DomainState --> <command:returnValue> <dev:type> <maml:name>ContactExpertRemoteManagement.Models.DomainState</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Represents the state of a domain.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Get-CEServerStates -DomainId 1</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>Get-CEServerStates -DomainId 1 -InformationAction Continue</dev:code> </command:example> </command:examples> </command:command> </helpItems> |