ExchangeNodeMaintenanceMode

1.0.0.1

en-US/ExchangeNodeMaintenanceMode.psm1-Help.xml

<?xml version="1.0" encoding="utf-8"?>
<helpItems xmlns="http://msh" schema="maml">
    <!--Edited with: SAPIEN PowerShell HelpWriter 2017 v2.1.34-->
    <!--Generated by: SAPIEN PowerShell HelpWriter 2017 v2.1.34-->
    <!--
        Module: ExchangeNodeMaintenanceMode
        Version: 1.0.0.0
    -->
    <!--All Commands-->
    <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-->
        <command:details>
            <command:name>Invoke-Exchange2016Workaround</command:name>
            <maml:description>
                <maml:para>Workaround for Exchange 2016 on Windows Server 2016</maml:para>
            </maml:description>
            <maml:copyright>
                <maml:para></maml:para>
            </maml:copyright>
            <command:verb>Invoke</command:verb>
            <command:noun>Exchange2016Workaround</command:noun>
            <dev:version />
        </command:details>
        <maml:description>
            <maml:para>Workaround for Exchange 2016 on Windows Server 2016</maml:para>
        </maml:description>
        <command:syntax>
            <!--Parameter Sets-->
            <command:syntaxItem parametersetname="__AllParameterSets">
                <!--NAME: __AllParameterSets-->
                <maml:name>Invoke-Exchange2016Workaround</maml:name>
            </command:syntaxItem>
        </command:syntax>
        <command:parameters>
            <!--All Parameters-->
        </command:parameters>
        <maml:alertSet>
            <!--Notes-->
            <maml:title></maml:title>
            <maml:alert>
                <maml:para>This is a quick an dirty one :)
 
. LINK
Set-ExchangeNodeMaintenanceModeOn
Set-ExchangeNodeMaintenanceModeOff
Test-ExchangeNodeMaintenanceMode</maml:para>
            </maml:alert>
        </maml:alertSet>
        <command:examples>
            <!--Examples-->
            <command:example>
                <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title>
                <maml:introduction>
                    <maml:para>PS C:\&gt;</maml:para>
                </maml:introduction>
                <dev:code>Invoke-Exchange2016Workaround</dev:code>
                <dev:remarks>
                    <maml:para></maml:para>
                </dev:remarks>
            </command:example>
        </command:examples>
    </command:command>
    <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">
        <!--TAG: HASCOMMONPARAMETERS-->
        <!--Command-->
        <command:details>
            <command:name>Set-ExchangeNodeMaintenanceModeOff</command:name>
            <maml:description>
                <maml:para>Return Exchange Node to normal operation</maml:para>
            </maml:description>
            <maml:copyright>
                <maml:para></maml:para>
            </maml:copyright>
            <command:verb>Set</command:verb>
            <command:noun>ExchangeNodeMaintenanceModeOff</command:noun>
            <dev:version />
        </command:details>
        <maml:description>
            <maml:para>Return Exchange Node to normal operation</maml:para>
        </maml:description>
        <command:syntax>
            <!--Parameter Sets-->
            <command:syntaxItem parametersetname="__AllParameterSets">
                <!--NAME: __AllParameterSets-->
                <maml:name>Set-ExchangeNodeMaintenanceModeOff</maml:name>
                <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1">
                    <maml:name>ComputerName</maml:name>
                    <maml:description>
                        <maml:para>Name of the Exchange Node, default is local system</maml:para>
                    </maml:description>
                    <command:parameterValue required="false" variableLength="false">String</command:parameterValue>
                    <dev:type>
                        <maml:name>String</maml:name>
                        <maml:uri />
                    </dev:type>
                    <dev:defaultValue>$env:COMPUTERNAME</dev:defaultValue>
                </command:parameter>
            </command:syntaxItem>
        </command:syntax>
        <command:parameters>
            <!--All Parameters-->
            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1">
                <maml:name>ComputerName</maml:name>
                <maml:description>
                    <maml:para>Name of the Exchange Node, default is local system</maml:para>
                </maml:description>
                <command:parameterValue required="false" variableLength="false">String</command:parameterValue>
                <dev:type>
                    <maml:name>String</maml:name>
                    <maml:uri />
                </dev:type>
                <dev:defaultValue>$env:COMPUTERNAME</dev:defaultValue>
            </command:parameter>
        </command:parameters>
        <command:inputTypes>
            <!--Inputs-->
            <command:inputType>
                <dev:type>
                    <maml:name>System.String</maml:name>
                    <maml:uri></maml:uri>
                </dev:type>
                <maml:description>
                    <maml:para></maml:para>
                </maml:description>
            </command:inputType>
        </command:inputTypes>
        <command:returnValues>
            <!--Outputs-->
            <command:returnValue>
                <dev:type>
                    <maml:name>System.Boolean</maml:name>
                    <maml:uri></maml:uri>
                </dev:type>
                <maml:description>
                    <maml:para></maml:para>
                </maml:description>
            </command:returnValue>
        </command:returnValues>
        <maml:alertSet>
            <!--Notes-->
            <maml:title></maml:title>
            <maml:alert>
                <maml:para>. LINK
Invoke-Exchange2016Workaround
Set-ExchangeNodeMaintenanceModeOn
Test-ExchangeNodeMaintenanceMode</maml:para>
            </maml:alert>
        </maml:alertSet>
        <command:examples>
            <!--Examples-->
            <command:example>
                <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title>
                <maml:introduction>
                    <maml:para>PS C:\&gt;</maml:para>
                </maml:introduction>
                <dev:code># Enable normal operations</dev:code>
                <dev:remarks>
                    <maml:para>PS C:\&gt; Set-ExchangeNodeMaintenanceModeOff
$true</maml:para>
                </dev:remarks>
            </command:example>
            <command:example>
                <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title>
                <maml:introduction>
                    <maml:para>PS C:\&gt;</maml:para>
                </maml:introduction>
                <dev:code># Fails to enable noprmal operations</dev:code>
                <dev:remarks>
                    <maml:para>PS C:\&gt; Set-ExchangeNodeMaintenanceModeOff
$false</maml:para>
                </dev:remarks>
            </command:example>
        </command:examples>
    </command:command>
    <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">
        <!--TAG: HASCOMMONPARAMETERS-->
        <!--Command-->
        <command:details>
            <command:name>Set-ExchangeNodeMaintenanceModeOn</command:name>
            <maml:description>
                <maml:para>Set the Exchange Node to Service</maml:para>
            </maml:description>
            <maml:copyright>
                <maml:para></maml:para>
            </maml:copyright>
            <command:verb>Set</command:verb>
            <command:noun>ExchangeNodeMaintenanceModeOn</command:noun>
            <dev:version />
        </command:details>
        <maml:description>
            <maml:para>Set the Exchange Node to Service</maml:para>
        </maml:description>
        <command:syntax>
            <!--Parameter Sets-->
            <command:syntaxItem parametersetname="__AllParameterSets">
                <!--NAME: __AllParameterSets-->
                <maml:name>Set-ExchangeNodeMaintenanceModeOn</maml:name>
                <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1">
                    <maml:name>ComputerName</maml:name>
                    <maml:description>
                        <maml:para>Name of the Exchange Node, default is local system</maml:para>
                    </maml:description>
                    <command:parameterValue required="false" variableLength="false">String</command:parameterValue>
                    <dev:type>
                        <maml:name>String</maml:name>
                        <maml:uri />
                    </dev:type>
                    <dev:defaultValue>$env:COMPUTERNAME</dev:defaultValue>
                </command:parameter>
            </command:syntaxItem>
        </command:syntax>
        <command:parameters>
            <!--All Parameters-->
            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1">
                <maml:name>ComputerName</maml:name>
                <maml:description>
                    <maml:para>Name of the Exchange Node, default is local system</maml:para>
                </maml:description>
                <command:parameterValue required="false" variableLength="false">String</command:parameterValue>
                <dev:type>
                    <maml:name>String</maml:name>
                    <maml:uri />
                </dev:type>
                <dev:defaultValue>$env:COMPUTERNAME</dev:defaultValue>
            </command:parameter>
        </command:parameters>
        <command:inputTypes>
            <!--Inputs-->
            <command:inputType>
                <dev:type>
                    <maml:name>System.String</maml:name>
                    <maml:uri></maml:uri>
                </dev:type>
                <maml:description>
                    <maml:para></maml:para>
                </maml:description>
            </command:inputType>
        </command:inputTypes>
        <maml:alertSet>
            <!--Notes-->
            <maml:title></maml:title>
            <maml:alert>
                <maml:para>TODO: Find a detection for the Workaround
TODO: Find a better solution for the certificate check issue
 
. LINK
Invoke-Exchange2016Workaround
Set-ExchangeNodeMaintenanceModeOff
Test-ExchangeNodeMaintenanceMode</maml:para>
            </maml:alert>
        </maml:alertSet>
        <command:examples>
            <!--Examples-->
            <command:example>
                <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title>
                <maml:introduction>
                    <maml:para>PS C:\&gt;</maml:para>
                </maml:introduction>
                <dev:code># Node is in Maintenance Mode</dev:code>
                <dev:remarks>
                    <maml:para>PS C:\&gt; Set-ExchangeNodeMaintenanceModeOn
$false</maml:para>
                </dev:remarks>
            </command:example>
            <command:example>
                <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title>
                <maml:introduction>
                    <maml:para>PS C:\&gt;</maml:para>
                </maml:introduction>
                <dev:code># Node is not in Maintenance Mode</dev:code>
                <dev:remarks>
                    <maml:para>PS C:\&gt; Set-ExchangeNodeMaintenanceModeOn
$true</maml:para>
                </dev:remarks>
            </command:example>
        </command:examples>
    </command:command>
    <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">
        <!--TAG: HASCOMMONPARAMETERS-->
        <!--Command-->
        <command:details>
            <command:name>Test-ExchangeNodeMaintenanceMode</command:name>
            <maml:description>
                <maml:para>Check if the exchange node is in maintenance mode</maml:para>
            </maml:description>
            <maml:copyright>
                <maml:para></maml:para>
            </maml:copyright>
            <command:verb>Test</command:verb>
            <command:noun>ExchangeNodeMaintenanceMode</command:noun>
            <dev:version />
        </command:details>
        <maml:description>
            <maml:para>Check if the exchange node is in maintenance mode</maml:para>
        </maml:description>
        <command:syntax>
            <!--Parameter Sets-->
            <command:syntaxItem parametersetname="__AllParameterSets">
                <!--NAME: __AllParameterSets-->
                <maml:name>Test-ExchangeNodeMaintenanceMode</maml:name>
                <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1">
                    <maml:name>ComputerName</maml:name>
                    <maml:description>
                        <maml:para>Name of the Exchange Node, default is local system</maml:para>
                    </maml:description>
                    <command:parameterValue required="false" variableLength="false">String</command:parameterValue>
                    <dev:type>
                        <maml:name>String</maml:name>
                        <maml:uri />
                    </dev:type>
                    <dev:defaultValue>$env:COMPUTERNAME</dev:defaultValue>
                </command:parameter>
            </command:syntaxItem>
        </command:syntax>
        <command:parameters>
            <!--All Parameters-->
            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1">
                <maml:name>ComputerName</maml:name>
                <maml:description>
                    <maml:para>Name of the Exchange Node, default is local system</maml:para>
                </maml:description>
                <command:parameterValue required="false" variableLength="false">String</command:parameterValue>
                <dev:type>
                    <maml:name>String</maml:name>
                    <maml:uri />
                </dev:type>
                <dev:defaultValue>$env:COMPUTERNAME</dev:defaultValue>
            </command:parameter>
        </command:parameters>
        <command:inputTypes>
            <!--Inputs-->
            <command:inputType>
                <dev:type>
                    <maml:name>System.String</maml:name>
                    <maml:uri></maml:uri>
                </dev:type>
                <maml:description>
                    <maml:para></maml:para>
                </maml:description>
            </command:inputType>
        </command:inputTypes>
        <command:returnValues>
            <!--Outputs-->
            <command:returnValue>
                <dev:type>
                    <maml:name>System.Boolean</maml:name>
                    <maml:uri></maml:uri>
                </dev:type>
                <maml:description>
                    <maml:para></maml:para>
                </maml:description>
            </command:returnValue>
        </command:returnValues>
        <maml:alertSet>
            <!--Notes-->
            <maml:title></maml:title>
            <maml:alert>
                <maml:para>Additional information about the function.</maml:para>
            </maml:alert>
        </maml:alertSet>
        <command:examples>
            <!--Examples-->
            <command:example>
                <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title>
                <maml:introduction>
                    <maml:para>PS C:\&gt;</maml:para>
                </maml:introduction>
                <dev:code># Given node is in normal operation mode</dev:code>
                <dev:remarks>
                    <maml:para>PS C:\&gt; Test-ExchangeNodeMaintenanceMode
$false</maml:para>
                </dev:remarks>
            </command:example>
            <command:example>
                <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title>
                <maml:introduction>
                    <maml:para>PS C:\&gt;</maml:para>
                </maml:introduction>
                <dev:code># Given node is in maintenance mode</dev:code>
                <dev:remarks>
                    <maml:para>PS C:\&gt; Test-ExchangeNodeMaintenanceMode
$true</maml:para>
                </dev:remarks>
            </command:example>
        </command:examples>
    </command:command>
    <!--Generated by: SAPIEN PowerShell HelpWriter 2017 v2.1.34-->
</helpItems>