en-US/MondayUpdates.psm1-Help.xml

<?xml version="1.0" encoding="utf-8"?>
<helpItems xmlns="http://msh" schema="maml">
    <!--Edited with: SAPIEN PowerShell HelpWriter 2019 v2.3.44-->
    <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-PendingReboot</command:name>
            <maml:description>
                <maml:para>Tests McMurdo systems from the Windows Updates Checklist to see if they require reboot</maml:para>
            </maml:description>
            <maml:copyright>
                <maml:para></maml:para>
            </maml:copyright>
            <command:verb>Get</command:verb>
            <command:noun>PendingReboot</command:noun>
            <dev:version />
        </command:details>
        <maml:description>
            <maml:para>Will look into the Windows Updates Checklist.xlsx and check all servers if they need to be rebooted for updates. Then marks those systems with an X on the checklist before saving a copy to the archive location.</maml:para>
        </maml:description>
        <command:syntax>
            <command:syntaxItem parametersetname="__AllParameterSets">
                <maml:name>Get-PendingReboot</maml:name>
                <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0">
                    <maml:name>Path</maml:name>
                    <maml:description>
                        <maml:para>Archive ile location for the Windows Updates Checklist.xlsx - Once done the curent date will be added to the end</maml:para>
                    </maml:description>
                    <command:parameterValue required="true" variableLength="false">System.IO.FileInfo</command:parameterValue>
                </command:parameter>
                <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1">
                    <maml:name>UpdateChecklist</maml:name>
                    <maml:description>
                        <maml:para>Path to the Windows Updates Checklist.xlsx</maml:para>
                    </maml:description>
                    <command:parameterValue required="true" variableLength="false">System.IO.FileInfo</command:parameterValue>
                </command:parameter>
                <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2">
                    <maml:name>Show</maml:name>
                    <maml:description>
                        <maml:para>Opens the Excel file immediately after creation. Convenient for viewing the results instantly without having to search for the file first.</maml:para>
                    </maml:description>
                    <command:parameterValue required="false" variableLength="false">switch</command:parameterValue>
                </command:parameter>
            </command:syntaxItem>
        </command:syntax>
        <command:parameters>
            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0">
                <maml:name>Path</maml:name>
                <maml:description>
                    <maml:para>Archive ile location for the Windows Updates Checklist.xlsx - Once done the curent date will be added to the end</maml:para>
                </maml:description>
                <command:parameterValue required="true" variableLength="false">System.IO.FileInfo</command:parameterValue>
                <dev:type>
                    <maml:name>System.IO.FileInfo</maml:name>
                    <maml:uri />
                </dev:type>
                <dev:defaultValue></dev:defaultValue>
            </command:parameter>
            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1">
                <maml:name>UpdateChecklist</maml:name>
                <maml:description>
                    <maml:para>Path to the Windows Updates Checklist.xlsx</maml:para>
                </maml:description>
                <command:parameterValue required="true" variableLength="false">System.IO.FileInfo</command:parameterValue>
                <dev:type>
                    <maml:name>System.IO.FileInfo</maml:name>
                    <maml:uri />
                </dev:type>
                <dev:defaultValue></dev:defaultValue>
            </command:parameter>
            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2">
                <maml:name>Show</maml:name>
                <maml:description>
                    <maml:para>Opens the Excel file immediately after creation. Convenient for viewing the results instantly without having to search for the file first.</maml:para>
                </maml:description>
                <command:parameterValue required="false" variableLength="false">switch</command:parameterValue>
                <dev:type>
                    <maml:name>switch</maml:name>
                    <maml:uri />
                </dev:type>
                <dev:defaultValue></dev:defaultValue>
            </command:parameter>
        </command:parameters>
        <maml:alertSet>
            <maml:title></maml:title>
            <maml:alert>
                <maml:para>===========================================================================
Created on: 8/6/2019 12:19 PM
Created by: Craig Moore (McMurdo Sr Systems Administrator)
Organization: United States Antarctic Program
Filename: Set-MCMSharedMailbox.ps1
===========================================================================</maml:para>
            </maml:alert>
        </maml:alertSet>
        <command:examples>
            <command:example>
                <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title>
                <maml:introduction>
                    <maml:para />
                </maml:introduction>
                <dev:code>PS C:\&gt; Get-PendingReboot -Path '\\FileServer\J$\ArchiveLocation\' -UpdateChecklist '\\FileServer\J$\Windows Updates Checklist.xlsx'
</dev:code>
                <dev:remarks>
                    <maml:para>Updates checklist located '\\FileServer\J$\Windows Updates Checklist.xlsx' and saves in the archive located '\\FileServer\J$\ArchiveLocation\Windows Updates Checklist yyy-mm-dd.xlsx'</maml:para>
                </dev:remarks>
            </command:example>
            <command:example>
                <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title>
                <maml:introduction>
                    <maml:para />
                </maml:introduction>
                <dev:code>PS C:\&gt; Get-PendingReboot -Path '\\FileServer\J$\ArchiveLocation\' -UpdateChecklist '\\FileServer\J$\Windows Updates Checklist.xlsx' -Show
</dev:code>
                <dev:remarks>
                    <maml:para>Does the same as Example 1 but opens the Excel file when complete.</maml:para>
                </dev:remarks>
            </command:example>
        </command:examples>
    </command:command>
    <!--Edited with: SAPIEN PowerShell HelpWriter 2019 v2.3.44-->
</helpItems>