ContactExpertRemoteManagement

1.0.0

ContactExpertRemoteManagement.xml

                                <?xml version="1.0"?>

<doc>

    <assembly>

        <name>ContactExpertRemoteManagement</name>

    </assembly>

    <members>

        <member name="T:ContactExpertRemoteManagement.Cmdlets.CECmdletWithConnection">

            <summary>

            Base class for cmdlet which needs for a connected Management Service wrapper.

            </summary>

        </member>

        <member name="T:ContactExpertRemoteManagement.Cmdlets.ConnectCEManagementService">

            <summary>

                <para type="synopsis">Opens connection to Contact Expert Management Service.</para>

                <para type="description">Login with the specified user on Contact Expert Management Service and stores information for further requests.</para>

                <para type="description">To check connection state use Get-CEManagementServiceConnection command.</para>

            </summary>

            <example>

                <code>Connect-CEManagementService -ManagementServiceUrl "http://domainname.net/CEManagementSvc"</code>

            </example>

            <example>

                <code>Connect-CEManagementService -ManagementServiceUrl "http://domainname.net/CEManagementSvc" -Credential $credential</code>

            </example>

            <example>

                <code>Connect-CEManagementService -ManagementServiceUrl "http://domainname.net/CEManagementSvc" -Credential $credential -UseWinAuth</code>

            </example>

        </member>

        <member name="P:ContactExpertRemoteManagement.Cmdlets.ConnectCEManagementService.ManagementServiceUrl">

            <summary>

                <para type="description">URL for Contact Expert Management Service. (e.g. http://domainname.net/CEManagementSvc)</para>

            </summary>

        </member>

        <member name="P:ContactExpertRemoteManagement.Cmdlets.ConnectCEManagementService.Credential">

            <summary>

                <para type="description">"User credential for Contact Expert Management Service authentication.</para>

            </summary>

        </member>

        <member name="P:ContactExpertRemoteManagement.Cmdlets.ConnectCEManagementService.UseWinAuth">

            <summary>

                <para type="description">Use this switch when the Contact Expert Management Service is configured for Windows Authentication.</para>

            </summary>

        </member>

        <member name="T:ContactExpertRemoteManagement.Cmdlets.DisconnectCEManagementService">

            <summary>

                <para type="synopsis">Closes connection to Contact Expert Management Service.</para>

                <para type="description">Removes connection information.</para>

                <para type="description">To check connection state use Get-CEManagementServiceConnection command.</para>

            </summary>

            <example>

                <code>Disconnect-CEManagementService</code>

            </example>

        </member>

        <member name="T:ContactExpertRemoteManagement.Cmdlets.GetCEDomains">

            <summary>

                <para type="synopsis">Gets available domains from the connected Contact Expert.</para>

                <para type="description">Retrieves domains from the connected Contact Expert what the connected user has access to.</para>

                <para type="description">

                    To use this command, need opened Management Service connection.

                    Use Get-CEManagementServiceConnection command to check connection state. 

                    Use Connect-CEManagementService command to connect.

                </para>

            </summary>

            <example>

                <code>Get-CEDomains</code>

            </example>

        </member>

        <member name="T:ContactExpertRemoteManagement.Cmdlets.GetCEManagementServiceConnection">

            <summary>

                <para type="synopsis">Gets the state of connection to Contact Expert Management Service.</para>

                <para type="description">Returns state of the connection, Management Service URL and user name used for connection.</para>

            </summary>

            <example>

                <code>Get-CEManagementServiceConnection</code>

            </example>

        </member>

        <member name="T:ContactExpertRemoteManagement.Cmdlets.GetCEServerStates">

            <summary>

                <para type="synopsis">Retrieves Contact Expert server states in the given domain.</para>

                <para type="description">

                    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.

                </para>

            </summary>

            <example>

                <code>Get-CEServerStates -DomainId 1</code>

            </example>

            <example>

                <code>Get-CEServerStates -DomainId 1 -InformationAction Continue</code>

            </example>

        </member>

        <member name="P:ContactExpertRemoteManagement.Cmdlets.GetCEServerStates.DomainId">

            <summary>

                <para type="description">Id of the domain which servers want to retrieve the states for.</para>

            </summary>

        </member>

        <member name="T:ContactExpertRemoteManagement.Cmdlets.StartCEServers">

            <summary>

                <para type="synopsis">Starts Contact Expert server componens in the given domain on the selected servers.</para>

                <para type="description">

                    This function is available only when all components stopped on the selected servers.

                    To check the components on servers, use Get-CEServerStates command.

                </para>

            </summary>

            <example>

                <code>Start-CEServers -DomainId 1 -ManageDomainServer Primary</code>

            </example>

        </member>

        <member name="P:ContactExpertRemoteManagement.Cmdlets.StartCEServers.DomainId">

            <summary>

                <para type="description">Id of the domain which servers want to manage.</para>

            </summary>

        </member>

        <member name="P:ContactExpertRemoteManagement.Cmdlets.StartCEServers.ManageDomainServer">

            <summary>

                <para type="description">Select to which Contact Expert server start the server components on.</para>

            </summary>

        </member>

        <member name="T:ContactExpertRemoteManagement.Cmdlets.StopCEServers">

            <summary>

            Stops Contact Expert server componens in the given domain on the selected servers.

            </summary>

            <summary>

                <para type="synopsis">Stops Contact Expert server componens in the given domain on the selected servers.</para>

                <para type="description">

                    To check the components on servers, use Get-CEServerStates command.

                </para>

            </summary>

            <example>

                <code>Stop-CEServers -DomainId 1 -ManageDomainServer Primary</code>

            </example>

        </member>

        <member name="P:ContactExpertRemoteManagement.Cmdlets.StopCEServers.DomainId">

            <summary>

                <para type="description">Id of the domain which servers want to manage.</para>

            </summary>

        </member>

        <member name="P:ContactExpertRemoteManagement.Cmdlets.StopCEServers.ManageDomainServer">

            <summary>

                <para type="description">Select to which Contact Expert server stop the server components on.</para>

            </summary>

        </member>

        <member name="T:ContactExpertRemoteManagement.ManagementServiceConnectionStore">

            <summary>

            Singleton class which handles and holds the connection state for Management Service.

            </summary>

        </member>

        <member name="F:ContactExpertRemoteManagement.ManagementServiceConnectionStore.DOMAINS_RESOURCE_NAME">

            <summary>

            Name of the Domains resource in Management Service (Login reponse).

            </summary>

        </member>

        <member name="F:ContactExpertRemoteManagement.ManagementServiceConnectionStore.token">

            <summary>

            Management Service authentication token.

            </summary>

        </member>

        <member name="F:ContactExpertRemoteManagement.ManagementServiceConnectionStore.tokenExpires">

            <summary>

            Time until the token is valid.

            </summary>

        </member>

        <member name="P:ContactExpertRemoteManagement.ManagementServiceConnectionStore.Instance">

            <summary>

            Returns the singleton instance.

            </summary>

        </member>

        <member name="P:ContactExpertRemoteManagement.ManagementServiceConnectionStore.DomainsHref">

            <summary>

            Href for Domains controller on Management Service API.

            </summary>

        </member>

        <member name="P:ContactExpertRemoteManagement.ManagementServiceConnectionStore.ManagementServiceBaseUrl">

            <summary>

            URL of Management Service.

            Only has valid value when connection is opened.

            </summary>

        </member>

        <member name="P:ContactExpertRemoteManagement.ManagementServiceConnectionStore.UseWinAuth">

            <summary>

            True when Windows Authentication was used to connect to Management Service.

            When true, use Windows Authentication for further request to Management Service.

            Only has valid value when connection is opened.

            </summary>

        </member>

        <member name="P:ContactExpertRemoteManagement.ManagementServiceConnectionStore.Credential">

            <summary>

            User credential which was used to connect to Management Service.

            Only has valid value when connection is opened.

            </summary>

        </member>

        <member name="M:ContactExpertRemoteManagement.ManagementServiceConnectionStore.UpdateProperties(ManagementService.Models.LoginModel,System.String,System.Management.Automation.PSCredential,System.Boolean)">

            <summary>

            Updates connection properties based on successful login response.

            </summary>

            <param name="loginResponse">Login response received from Management Service</param>

            <param name="managementServiceBaseUrl">Management Service URL used for login</param>

            <param name="credential">User credentials used for login</param>

            <param name="useWinAuth">Flag to indicate if Windows Authentication was used</param>

        </member>

        <member name="M:ContactExpertRemoteManagement.ManagementServiceConnectionStore.RemoveProperties">

            <summary>

            Removed connection properties.

            </summary>

        </member>

        <member name="P:ContactExpertRemoteManagement.ManagementServiceConnectionStore.IsConnected">

            <summary>

            True when Management Service URL is stored and token is valid.

            </summary>

        </member>

        <member name="P:ContactExpertRemoteManagement.ManagementServiceConnectionStore.Token">

            <summary>

            Authentication token or null when there is no valid token.

            </summary>

        </member>

        <member name="M:ContactExpertRemoteManagement.ManagementServiceConnectionStore.GetConnectionState">

            <summary>

            Returns the actual state of the connection.

            </summary>

            <returns></returns>

        </member>

        <member name="M:ContactExpertRemoteManagement.ManagementServiceConnectionStore.IsTokenValid">

            <summary>

            Check if the token is specified and not expired.

            </summary>

        </member>

        <member name="T:ContactExpertRemoteManagement.ManagementServiceHttpClient">

            <summary>

            Helper class to generate HTTP Client for Management Service connection.

            </summary>

        </member>

        <member name="M:ContactExpertRemoteManagement.ManagementServiceHttpClient.GetHttpClientForLogin(System.String,System.Management.Automation.PSCredential)">

            <summary>

            Returns HTTP Client for login process.

            </summary>

            <param name="managementServiceUrl">URL for Management Service</param>

            <param name="credentialForWinAuth">User credentials when Windows Authentication needs to be used. Otherwise use null value.</param>

        </member>

        <member name="M:ContactExpertRemoteManagement.ManagementServiceHttpClient.GetHttpClient(ContactExpertRemoteManagement.ManagementServiceConnectionStore)">

            <summary>

            Returns HTTP Client for requests after successful login.

            </summary>

            <param name="connectionStore">Management Service connection store</param>

        </member>

        <member name="T:ContactExpertRemoteManagement.ManagementServiceWrapper">

            <summary>

            Wraps the communication with Management Service.

            </summary>

        </member>

        <member name="F:ContactExpertRemoteManagement.ManagementServiceWrapper.LOGIN_URL">

            <summary>

            Href for login controller.

            </summary>

        </member>

        <member name="F:ContactExpertRemoteManagement.ManagementServiceWrapper.connectionStore">

            <summary>

            Reference to connection store.

            </summary>

        </member>

        <member name="F:ContactExpertRemoteManagement.ManagementServiceWrapper.httpClient">

            <summary>

            Reference to HTTP Client.

            </summary>

        </member>

        <member name="M:ContactExpertRemoteManagement.ManagementServiceWrapper.#ctor(ContactExpertRemoteManagement.ManagementServiceConnectionStore,System.Net.Http.HttpClient)">

            <summary>

            Creates a new instance with the given dependencies.

            </summary>

            <param name="connectionStore">Connection store which stores/saves the required parameters for connection</param>

            <param name="httpClient">HTTP client which is configured for communication with the Management Service. (Token and/or credentials set)</param>

        </member>

        <member name="M:ContactExpertRemoteManagement.ManagementServiceWrapper.Login(System.Management.Automation.PSCredential,System.Boolean)">

            <summary>

            Calls login on Management Service and saves the result into the connection store.

            </summary>

            <param name="credential">User credential needs to be used in login request. (Not required in case of Windows Authentication)</param>

            <param name="useWinAuth">Flag to indicate when to use Windows Authentication. In this case the Credentials needs to be set in the HTTP client.</param>

            <returns>True when login was successful</returns>

        </member>

        <member name="M:ContactExpertRemoteManagement.ManagementServiceWrapper.GetDomains">

            <summary>

            Retrieves domains for the connected user.

            </summary>

            <returns>List of domains or null when failed to retrieve domains</returns>

        </member>

        <member name="M:ContactExpertRemoteManagement.ManagementServiceWrapper.GetServerStates(System.Int32)">

            <summary>

            Retrieves server states in the given domain.

            </summary>

            <param name="domainId">Id of the domain</param>

            <returns>DomainState object. Null when failed to retrieve state with unknown reason.</returns>

        </member>

        <member name="M:ContactExpertRemoteManagement.ManagementServiceWrapper.StartServers(System.Int32,ContactExpertRemoteManagement.Models.ManageDomainServerSelector)">

            <summary>

            Calls start server method on Management Service.

            </summary>

            <param name="domainId">Id of the domain where the server is</param>

            <param name="manageDomainServer">Selector to select primary and/or secondary servers</param>

            <returns>True when starting servers started successfully</returns>

        </member>

        <member name="M:ContactExpertRemoteManagement.ManagementServiceWrapper.StopServers(System.Int32,ContactExpertRemoteManagement.Models.ManageDomainServerSelector)">

            <summary>

            Calls start server method on Management Service.

            </summary>

            <param name="domainId">Id of the domain where the server is</param>

            <param name="manageDomainServer">Selector to select primary and/or secondary servers</param>

            <returns>True when stopping servers started successfully</returns>

        </member>

        <member name="M:ContactExpertRemoteManagement.ManagementServiceWrapper.GetPlainText(System.Security.SecureString)">

            <summary>

            Retrieve plain text from SecureString

            Caller has the responsibility for keeping this data secure.

            </summary>

        </member>

        <member name="T:ContactExpertRemoteManagement.Models.Domain">

            <summary>

            Represents a Contact Expert domain.

            </summary>

        </member>

        <member name="M:ContactExpertRemoteManagement.Models.Domain.#ctor(ManagementService.Models.DomainListModel)">

            <summary>

            Create new instance from object retrieved from Managment Service API.

            </summary>

            <param name="model">Domain retrieved from Management Service API</param>

        </member>

        <member name="P:ContactExpertRemoteManagement.Models.Domain.Id">

            <summary>

            Id of the domain.

            </summary>

        </member>

        <member name="P:ContactExpertRemoteManagement.Models.Domain.Name">

            <summary>

            Display name of the domain.

            </summary>

        </member>

        <member name="T:ContactExpertRemoteManagement.Models.DomainServerState">

            <summary>

            Represents the state of a server within a domain.

            </summary>

        </member>

        <member name="M:ContactExpertRemoteManagement.Models.DomainServerState.#ctor(ManagementService.Models.DomainServerStateModel)">

            <summary>

            Creates new instance from object retrieved from Management Service API.

            </summary>

            <param name="model">Domain server state retrieved from Management Service API</param>

        </member>

        <member name="P:ContactExpertRemoteManagement.Models.DomainServerState.Host">

            <summary>

            Address or FQDN of the host.

            </summary>

        </member>

        <member name="P:ContactExpertRemoteManagement.Models.DomainServerState.IsPrimary">

            <summary>

            True if this is the primary server in the domain.

            </summary>

        </member>

        <member name="P:ContactExpertRemoteManagement.Models.DomainServerState.IsActive">

            <summary>

            True if this is the active server in the domain.

            </summary>

        </member>

        <member name="P:ContactExpertRemoteManagement.Models.DomainServerState.Components">

            <summary>

            List of server component info objects.

            </summary>

        </member>

        <member name="M:ContactExpertRemoteManagement.Models.DomainServerState.ToString">

            <summary>

            Creates string representing the object.

            </summary>

        </member>

        <member name="T:ContactExpertRemoteManagement.Models.DomainState">

            <summary>

                <para type="description">Represents the state of a domain.</para>

            </summary>

        </member>

        <member name="M:ContactExpertRemoteManagement.Models.DomainState.#ctor(ManagementService.Models.DomainStateModel)">

            <summary>

            Creates new instance from object retrieved from Management Service API.

            </summary>

            <param name="model">Domain state retrieved from Management Service API</param>

        </member>

        <member name="P:ContactExpertRemoteManagement.Models.DomainState.DomainId">

            <summary>

            Id of the domain.

            </summary>

        </member>

        <member name="P:ContactExpertRemoteManagement.Models.DomainState.Servers">

            <summary>

            List of server state objects.

            </summary>

        </member>

        <member name="M:ContactExpertRemoteManagement.Models.DomainState.ToString">

            <summary>

            Creates string representing the object.

            </summary>

        </member>

        <member name="T:ContactExpertRemoteManagement.Models.ManageDomainServerSelector">

            <summary>

                <para type="description">Selector to be able to define in Powershell which servers needs to be managed.</para>

            </summary>

        </member>

        <member name="F:ContactExpertRemoteManagement.Models.ManageDomainServerSelector.Primary">

            <summary>

            Manage primary server only.

            </summary>

        </member>

        <member name="F:ContactExpertRemoteManagement.Models.ManageDomainServerSelector.Secondary">

            <summary>

            Manage secondary server only.

            </summary>

        </member>

        <member name="F:ContactExpertRemoteManagement.Models.ManageDomainServerSelector.PrimaryAndSecondary">

            <summary>

            Manage both primary and secondary servers.

            </summary>

        </member>

        <member name="T:ContactExpertRemoteManagement.Models.ManagementServiceConnectionState">

            <summary>

                <para type="description">Represents the state of the connection to Management Service.</para>

            </summary>

        </member>

        <member name="P:ContactExpertRemoteManagement.Models.ManagementServiceConnectionState.IsConnected">

            <summary>

            True when URL for Management Service is stored and a valid authentication token is available.

            </summary>

        </member>

        <member name="P:ContactExpertRemoteManagement.Models.ManagementServiceConnectionState.ManagementServiceUrl">

            <summary>

            URL for Management Service.

            </summary>

        </member>

        <member name="P:ContactExpertRemoteManagement.Models.ManagementServiceConnectionState.UserName">

            <summary>

            User name which the token is generated for.

            </summary>

        </member>

        <member name="T:ContactExpertRemoteManagement.Models.ServerComponentInfo">

            <summary>

            Represents the state of a server component.

            </summary>

        </member>

        <member name="M:ContactExpertRemoteManagement.Models.ServerComponentInfo.#ctor(ManagementService.Models.ServerComponentInfoModel)">

            <summary>

            Creates new instance from object retrieved from Management Service API.

            </summary>

            <param name="model">Server component info retrieved from Management Service API</param>

        </member>

        <member name="P:ContactExpertRemoteManagement.Models.ServerComponentInfo.Name">

            <summary>

            Display name of the server component.

            Concatenation of the server component name and its id.

            </summary>

        </member>

        <member name="P:ContactExpertRemoteManagement.Models.ServerComponentInfo.State">

            <summary>

            State of the server component.

            </summary>

        </member>

        <member name="M:ContactExpertRemoteManagement.Models.ServerComponentInfo.ToString">

            <summary>

            Creates string representing the object.

            </summary>

        </member>

    </members>

</doc>