AQtools

1.0.1.1

en-US/AQTools.psm1-Help.xml

<?xml version="1.0" encoding="utf-8" ?>
<helpItems xmlns="http://msh" schema="maml">
    <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-MCMListDocumentation</command:name>
            <maml:description>
                <maml:para>Documents the resident lists for McMurdo station</maml:para>
 
            </maml:description>
            <maml:copyright>
                <maml:para></maml:para>
            </maml:copyright>
            <command:verb>Get</command:verb>
            <command:noun>MCMListDocumentation</command:noun>
            <dev:version/>
        </command:details>
        <maml:description>
                <maml:para>Produces an excel document.
Without switches - Overview of all McMurdo residents in one tab listing all information.
Operations switch - Overview of all McMurdo residents in one tab listing
Lodging switch - The first tab is an overview of all McMurdo residents. Subsequent tabs show the residents of specific dorms.
Information is broken down by resident name, dorm, room, room Phone, day sleeper status, and job title.
Default Dorms audited are 155, 166, 188, 201, 202, 203A, 203B, 203C, 206, 207, 208, 209, 210, 211</maml:para>
 
        </maml:description>
        <command:syntax>
            <command:syntaxItem parametersetname="None">
                <maml:name>Get-MCMListDocumentation</maml:name>
                <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named">
                    <maml:name>Path</maml:name>
                    <maml:description>
                        <maml:para>File path to where to output .xlsx file</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="Named">
                    <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. Excel must be installed on the system opening the document.</maml:para>
                    </maml:description>
                    <command:parameterValue required="false" variableLength="false">switch</command:parameterValue>
                </command:parameter>
            </command:syntaxItem>
            <command:syntaxItem parametersetname="Logding">
                <maml:name>Get-MCMListDocumentation</maml:name>
                <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named">
                    <maml:name>Path</maml:name>
                    <maml:description>
                        <maml:para>File path to where to output .xlsx file</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="Named">
                    <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. Excel must be installed on the system opening the document.</maml:para>
                    </maml:description>
                    <command:parameterValue required="false" variableLength="false">switch</command:parameterValue>
                </command:parameter>
                <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named">
                    <maml:name>Logding</maml:name>
                    <maml:description>
                        <maml:para>Hides the Excel columns bot related to Housing.</maml:para>
                    </maml:description>
                    <command:parameterValue required="false" variableLength="false">switch</command:parameterValue>
                </command:parameter>
            </command:syntaxItem>
            <command:syntaxItem parametersetname="Operations">
                <maml:name>Get-MCMListDocumentation</maml:name>
                <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named">
                    <maml:name>Path</maml:name>
                    <maml:description>
                        <maml:para>File path to where to output .xlsx file</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="Named">
                    <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. Excel must be installed on the system opening the document.</maml:para>
                    </maml:description>
                    <command:parameterValue required="false" variableLength="false">switch</command:parameterValue>
                </command:parameter>
                <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named">
                    <maml:name>Operations</maml:name>
                    <maml:description>
                        <maml:para>Hides the Excel columns not related to Operations.</maml:para>
                    </maml:description>
                    <command:parameterValue required="false" variableLength="false">switch</command:parameterValue>
                </command:parameter>
            </command:syntaxItem>
            <command:syntaxItem parametersetname="WorkPhone">
                <maml:name>Get-MCMListDocumentation</maml:name>
                <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named">
                    <maml:name>Path</maml:name>
                    <maml:description>
                        <maml:para>File path to where to output .xlsx file</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="Named">
                    <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. Excel must be installed on the system opening the document.</maml:para>
                    </maml:description>
                    <command:parameterValue required="false" variableLength="false">switch</command:parameterValue>
                </command:parameter>
                <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named">
                    <maml:name>WorkPhone</maml:name>
                    <maml:description>
                        <maml:para>Hides the Excel columns not related to work phones.</maml:para>
                    </maml:description>
                    <command:parameterValue required="false" variableLength="false">switch</command:parameterValue>
                </command:parameter>
            </command:syntaxItem>
            <command:syntaxItem parametersetname="Pager">
                <maml:name>Get-MCMListDocumentation</maml:name>
                <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named">
                    <maml:name>Path</maml:name>
                    <maml:description>
                        <maml:para>File path to where to output .xlsx file</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="Named">
                    <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. Excel must be installed on the system opening the document.</maml:para>
                    </maml:description>
                    <command:parameterValue required="false" variableLength="false">switch</command:parameterValue>
                </command:parameter>
                <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named">
                    <maml:name>Pager</maml:name>
                    <maml:description>
                        <maml:para>Hides the Excel columns not related to pagers.</maml:para>
                    </maml:description>
                    <command:parameterValue required="false" variableLength="false">switch</command:parameterValue>
                </command:parameter>
            </command:syntaxItem>
        </command:syntax>
        <command:parameters>
            <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named">
                <maml:name>Path</maml:name>
                <maml:description>
                    <maml:para>File path to where to output .xlsx file</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="true" variableLength="false" globbing="false" pipelineInput="false" position="Named">
                <maml:name>SaveTo</maml:name>
                <maml:description>
                    <maml:para></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="Named">
                <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. Excel must be installed on the system opening the document.</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:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named">
                <maml:name>Logding</maml:name>
                <maml:description>
                    <maml:para>Hides the Excel columns bot related to Housing.</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:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named">
                <maml:name>Operations</maml:name>
                <maml:description>
                    <maml:para>Hides the Excel columns not related to Operations.</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:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named">
                <maml:name>WorkPhone</maml:name>
                <maml:description>
                    <maml:para>Hides the Excel columns not related to work phones.</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:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named">
                <maml:name>Pager</maml:name>
                <maml:description>
                    <maml:para>Hides the Excel columns not related to pagers.</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>
        <command:returnValues>
            <command:returnValue>
                <dev:type>
<maml:name>System.IO.File</maml:name>
                <maml:uri/>
                </dev:type>
                <maml:description>
                    <maml:para></maml:para>
                </maml:description>
            </command:returnValue>
        </command:returnValues>
        <maml:alertSet>
            <maml:title></maml:title>
            <maml:alert>
                <maml:para>Requires the module ImportExcel (By Douglas Finke) and Active Directory
Install-Module -Name ImportExcel
 
===========================================================================
Created on: 8/19/2019 2:27 PM
Created by: Craig Moore (McMurdo Sr Systems Administrator)
Organization: United States Antarctic Program
Filename: Get-MCMListDocumentation.ps1
===========================================================================</maml:para>
            </maml:alert>
        </maml:alertSet>
        <command:examples>
            <command:example>
                <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title>
                <maml:introduction>
                    <maml:para></maml:para>
                </maml:introduction>
                <dev:code>PS C:\&gt; Get-MCMDormDocumentation -Path &quot;C:\Temp\List.xlsx&quot; </dev:code>
                <dev:remarks>
                    <maml:para>Documents the residents of McMurdo showing all information, saves to C:\Temp\List.xlsx</maml:para>
 
                </dev:remarks>
            </command:example>
            <command:example>
                <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title>
                <maml:introduction>
                    <maml:para></maml:para>
                </maml:introduction>
                <dev:code>PS C:\&gt; Get-MCMDormDocumentation -Path &quot;C:\Temp\List.xlsx&quot; -Show </dev:code>
                <dev:remarks>
                    <maml:para>Documents the residents of McMurdo showing all information, saves to C:\Temp\List.xlsx then open the file when complete</maml:para>
 
                </dev:remarks>
            </command:example>
            <command:example>
                <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title>
                <maml:introduction>
                    <maml:para></maml:para>
                </maml:introduction>
                <dev:code>PS C:\&gt; Get-MCMDormDocumentation -Path &quot;C:\Temp\List.xlsx&quot; -Lodging -Show </dev:code>
                <dev:remarks>
                    <maml:para>Documents the residents of McMurdo ,showing Lodging information, also breaks down each dorm into individule dorms. Saves to C:\Temp\List.xlsx then open the file when complete</maml:para>
 
                </dev:remarks>
            </command:example>
            <command:example>
                <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title>
                <maml:introduction>
                    <maml:para></maml:para>
                </maml:introduction>
                <dev:code>PS C:\&gt; Get-MCMDormDocumentation -Path &quot;C:\Temp\List.xlsx&quot; -Operations -Show </dev:code>
                <dev:remarks>
                    <maml:para>Documents the residents of McMurdo ,showing Operations information, saves to C:\Temp\List.xlsx then open the file when complete</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">
        <command:details>
            <command:name>Get-FutureList</command:name>
            <maml:description>
                <maml:para>Finds all users with extensionAttribute4 (flight) set for a selection of OUs, and exports that data to an Excel document</maml:para>
 
            </maml:description>
            <maml:copyright>
                <maml:para></maml:para>
            </maml:copyright>
            <command:verb>Get</command:verb>
            <command:noun>FutureList</command:noun>
            <dev:version/>
        </command:details>
        <maml:description>
                <maml:para>Searches secected OUs for users with extensionAttribute4 (flight) set, then exports the SamAccountName, Name, Flight, Dorm, Room, Phone, DaySleeper, Pager, WorkPhone, and Title into an Excel document. This allows assigned administrators to update the users AD information using the Set-FutureRoom function.
AD attribute employeeType = DaySleeper
AD attribute extensionAttribute10 = Dorm
AD attribute extensionAttribute11 = Room
AD attribute extensionAttribute12 = Phone
AD attribute extensionAttribute4 = Flight
AD attribute facsimileTelephoneNumber = WorkPhone
AD attribute Name = Name
AD attribute pager = Pager
AD attribute SamAccountName = SamAccountName
AD attribute title = Title</maml:para>
 
        </maml:description>
        <command:syntax>
            <command:syntaxItem parametersetname="None">
                <maml:name>Get-FutureList</maml:name>
                <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named">
                    <maml:name>Path</maml:name>
                    <maml:description>
                        <maml:para>Path and name of where to save the Excel document. Later use this same path in the function Set-FutureRoom to update the users active directory attributes.</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="Named">
                    <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. Excel must be installed on the system opening the document.</maml:para>
                    </maml:description>
                    <command:parameterValue required="false" variableLength="false">switch</command:parameterValue>
                </command:parameter>
                <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named">
                    <maml:name>OU</maml:name>
                    <maml:description>
                        <maml:para>Specifies an Active Directory path to search. (DistinguishedName)</maml:para>
                    </maml:description>
                    <command:parameterValue required="true" variableLength="false">array</command:parameterValue>
                </command:parameter>
                <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named">
                    <maml:name>Logding</maml:name>
                    <maml:description>
                        <maml:para>Hides the Excel columns not related to Lodging.</maml:para>
                    </maml:description>
                    <command:parameterValue required="false" variableLength="false">switch</command:parameterValue>
                </command:parameter>
            </command:syntaxItem>
            <command:syntaxItem parametersetname="Operations">
                <maml:name>Get-FutureList</maml:name>
                <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named">
                    <maml:name>Path</maml:name>
                    <maml:description>
                        <maml:para>Path and name of where to save the Excel document. Later use this same path in the function Set-FutureRoom to update the users active directory attributes.</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="Named">
                    <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. Excel must be installed on the system opening the document.</maml:para>
                    </maml:description>
                    <command:parameterValue required="false" variableLength="false">switch</command:parameterValue>
                </command:parameter>
                <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named">
                    <maml:name>OU</maml:name>
                    <maml:description>
                        <maml:para>Specifies an Active Directory path to search. (DistinguishedName)</maml:para>
                    </maml:description>
                    <command:parameterValue required="true" variableLength="false">array</command:parameterValue>
                </command:parameter>
                <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named">
                    <maml:name>Logding</maml:name>
                    <maml:description>
                        <maml:para>Hides the Excel columns not related to Lodging.</maml:para>
                    </maml:description>
                    <command:parameterValue required="false" variableLength="false">switch</command:parameterValue>
                </command:parameter>
                <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named">
                    <maml:name>Operations</maml:name>
                    <maml:description>
                        <maml:para>Hides the Excel columns not related to Operations.</maml:para>
                    </maml:description>
                    <command:parameterValue required="false" variableLength="false">switch</command:parameterValue>
                </command:parameter>
            </command:syntaxItem>
            <command:syntaxItem parametersetname="WorkPhone">
                <maml:name>Get-FutureList</maml:name>
                <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named">
                    <maml:name>Path</maml:name>
                    <maml:description>
                        <maml:para>Path and name of where to save the Excel document. Later use this same path in the function Set-FutureRoom to update the users active directory attributes.</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="Named">
                    <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. Excel must be installed on the system opening the document.</maml:para>
                    </maml:description>
                    <command:parameterValue required="false" variableLength="false">switch</command:parameterValue>
                </command:parameter>
                <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named">
                    <maml:name>OU</maml:name>
                    <maml:description>
                        <maml:para>Specifies an Active Directory path to search. (DistinguishedName)</maml:para>
                    </maml:description>
                    <command:parameterValue required="true" variableLength="false">array</command:parameterValue>
                </command:parameter>
                <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named">
                    <maml:name>Logding</maml:name>
                    <maml:description>
                        <maml:para>Hides the Excel columns not related to Lodging.</maml:para>
                    </maml:description>
                    <command:parameterValue required="false" variableLength="false">switch</command:parameterValue>
                </command:parameter>
                <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named">
                    <maml:name>WorkPhone</maml:name>
                    <maml:description>
                        <maml:para>Hides the Excel columns not related to work phones.</maml:para>
                    </maml:description>
                    <command:parameterValue required="false" variableLength="false">switch</command:parameterValue>
                </command:parameter>
            </command:syntaxItem>
            <command:syntaxItem parametersetname="Pager">
                <maml:name>Get-FutureList</maml:name>
                <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named">
                    <maml:name>Path</maml:name>
                    <maml:description>
                        <maml:para>Path and name of where to save the Excel document. Later use this same path in the function Set-FutureRoom to update the users active directory attributes.</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="Named">
                    <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. Excel must be installed on the system opening the document.</maml:para>
                    </maml:description>
                    <command:parameterValue required="false" variableLength="false">switch</command:parameterValue>
                </command:parameter>
                <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named">
                    <maml:name>OU</maml:name>
                    <maml:description>
                        <maml:para>Specifies an Active Directory path to search. (DistinguishedName)</maml:para>
                    </maml:description>
                    <command:parameterValue required="true" variableLength="false">array</command:parameterValue>
                </command:parameter>
                <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named">
                    <maml:name>Logding</maml:name>
                    <maml:description>
                        <maml:para>Hides the Excel columns not related to Lodging.</maml:para>
                    </maml:description>
                    <command:parameterValue required="false" variableLength="false">switch</command:parameterValue>
                </command:parameter>
                <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named">
                    <maml:name>Pager</maml:name>
                    <maml:description>
                        <maml:para>Hides the Excel columns not related to pagers.</maml:para>
                    </maml:description>
                    <command:parameterValue required="false" variableLength="false">switch</command:parameterValue>
                </command:parameter>
            </command:syntaxItem>
        </command:syntax>
        <command:parameters>
            <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named">
                <maml:name>Path</maml:name>
                <maml:description>
                    <maml:para>Path and name of where to save the Excel document. Later use this same path in the function Set-FutureRoom to update the users active directory attributes.</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="Named">
                <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. Excel must be installed on the system opening the document.</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:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named">
                <maml:name>OU</maml:name>
                <maml:description>
                    <maml:para>Specifies an Active Directory path to search. (DistinguishedName)</maml:para>
                </maml:description>
                    <command:parameterValue required="true" variableLength="false">array</command:parameterValue>
                <dev:type>
                    <maml:name>array</maml:name>
                    <maml:uri/>
                </dev:type>
                <dev:defaultValue></dev:defaultValue>
            </command:parameter>
            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named">
                <maml:name>Logding</maml:name>
                <maml:description>
                    <maml:para>Hides the Excel columns not related to Lodging.</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:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named">
                <maml:name>Operations</maml:name>
                <maml:description>
                    <maml:para>Hides the Excel columns not related to Operations.</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:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named">
                <maml:name>WorkPhone</maml:name>
                <maml:description>
                    <maml:para>Hides the Excel columns not related to work phones.</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:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named">
                <maml:name>Pager</maml:name>
                <maml:description>
                    <maml:para>Hides the Excel columns not related to pagers.</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>
        <command:returnValues>
            <command:returnValue>
                <dev:type>
<maml:name>System.IO.File</maml:name>
                <maml:uri/>
                </dev:type>
                <maml:description>
                    <maml:para></maml:para>
                </maml:description>
            </command:returnValue>
        </command:returnValues>
        <maml:alertSet>
            <maml:title></maml:title>
            <maml:alert>
                <maml:para>Requires the module ImportExcel (By Douglas Finke) and Active Directory
Install-Module -Name ImportExcel
 
===========================================================================
Created on: 8/16/2019 4:55 PM
Created by: Craig Moore (McMurdo Sr Systems Administrator)
Organization: United States Antarctic Program
Filename: Get-FutureList.ps1
===========================================================================</maml:para>
            </maml:alert>
        </maml:alertSet>
        <command:examples>
            <command:example>
                <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title>
                <maml:introduction>
                    <maml:para></maml:para>
                </maml:introduction>
                <dev:code>PS C:\&gt; Get-FutureList -Path &quot;C:\Temp\List.xlsx&quot; -OU &quot;DC=FABRIKAM,DC=COM&quot; </dev:code>
                <dev:remarks>
                    <maml:para>Finds all users with extensionAttribute4 -like &quot;*&quot; within the given OU and records all identified information. Saves Excel document to C:\Temp\List.xlsx</maml:para>
 
                </dev:remarks>
            </command:example>
            <command:example>
                <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title>
                <maml:introduction>
                    <maml:para></maml:para>
                </maml:introduction>
                <dev:code>PS C:\&gt; Get-FutureList -Path &quot;C:\Temp\List.xlsx&quot; -OU &quot;DC=FABRIKAM,DC=COM&quot; -Show </dev:code>
                <dev:remarks>
                    <maml:para>Finds all users with extensionAttribute4 -like &quot;*&quot; within the given OU and records all identified information. Saves Excel document to C:\Temp\List.xlsx and opens the Excel file.</maml:para>
 
                </dev:remarks>
            </command:example>
            <command:example>
                <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title>
                <maml:introduction>
                    <maml:para></maml:para>
                </maml:introduction>
                <dev:code>PS C:\&gt; Get-FutureList -Path &quot;C:\Temp\List.xlsx&quot; -OU &quot;DC=FABRIKAM,DC=COM&quot; -Logding -Show </dev:code>
                <dev:remarks>
                    <maml:para>Finds all users with extensionAttribute4 -like &quot;*&quot; within the given OU and records all Lodging information. Saves Excel document to C:\Temp\List.xlsx and opens the Excel file.</maml:para>
 
                </dev:remarks>
            </command:example>
            <command:example>
                <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title>
                <maml:introduction>
                    <maml:para></maml:para>
                </maml:introduction>
                <dev:code>PS C:\&gt; Get-FutureList -Path &quot;C:\Temp\List.xlsx&quot; -OU &quot;DC=FABRIKAM,DC=COM&quot; -Operations -Show </dev:code>
                <dev:remarks>
                    <maml:para>Finds all users with extensionAttribute4 -like &quot;*&quot; within the given OU and records all Operations information. Saves Excel document to C:\Temp\List.xlsx and opens the Excel file.</maml:para>
 
                </dev:remarks>
            </command:example>
            <command:example>
                <maml:title>-------------------------- EXAMPLE 5 --------------------------</maml:title>
                <maml:introduction>
                    <maml:para></maml:para>
                </maml:introduction>
                <dev:code>PS C:\&gt; $OU = &quot;OU=Finance,OU=UserAccounts,DC=FABRIKAM,DC=COM&quot;,&quot;OU=Marketing,OU=UserAccounts,DC=FABRIKAM,DC=COM&quot; </dev:code>
                <dev:remarks>
                    <maml:para>$Path = &quot;\\File-Server\Update\List.xlsx&quot;
Get-FutureList -Path $Path -OU $OU -Operations
Finds all users with extensionAttribute4 -like &quot;*&quot; within the given two given OUs set bey $OU and records all Operations information. Saves Excel document to $Path</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">
        <command:details>
            <command:name>Set-FutureList</command:name>
            <maml:description>
                <maml:para>Sets the Active Directory attributes for lodging.</maml:para>
 
            </maml:description>
            <maml:copyright>
                <maml:para></maml:para>
            </maml:copyright>
            <command:verb>Set</command:verb>
            <command:noun>FutureList</command:noun>
            <dev:version/>
        </command:details>
        <maml:description>
                <maml:para>This function references a Excel document generated by Get-FutureRoom and updates Active Directory attributes that are listed in that document.</maml:para>
 
        </maml:description>
        <command:syntax>
            <command:syntaxItem parametersetname="None">
                <maml:name>Set-FutureList</maml:name>
                <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named">
                    <maml:name>Path</maml:name>
                    <maml:description>
                        <maml:para>Path to the Excel document created by Get-FutureRoom.</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="Named">
                    <maml:name>Force</maml:name>
                    <maml:description>
                        <maml:para>Force</maml:para>
                    </maml:description>
                    <command:parameterValue required="false" variableLength="false">switch</command:parameterValue>
                </command:parameter>
            </command:syntaxItem>
            <command:syntaxItem parametersetname="Logding">
                <maml:name>Set-FutureList</maml:name>
                <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named">
                    <maml:name>Path</maml:name>
                    <maml:description>
                        <maml:para>Path to the Excel document created by Get-FutureRoom.</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="Named">
                    <maml:name>Logding</maml:name>
                    <maml:description>
                        <maml:para>Set the attributes for Lodging.</maml:para>
                    </maml:description>
                    <command:parameterValue required="false" variableLength="false">switch</command:parameterValue>
                </command:parameter>
                <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named">
                    <maml:name>Force</maml:name>
                    <maml:description>
                        <maml:para>Force</maml:para>
                    </maml:description>
                    <command:parameterValue required="false" variableLength="false">switch</command:parameterValue>
                </command:parameter>
            </command:syntaxItem>
            <command:syntaxItem parametersetname="Operations">
                <maml:name>Set-FutureList</maml:name>
                <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named">
                    <maml:name>Path</maml:name>
                    <maml:description>
                        <maml:para>Path to the Excel document created by Get-FutureRoom.</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="Named">
                    <maml:name>Operations</maml:name>
                    <maml:description>
                        <maml:para>Set the attributes for Operations.</maml:para>
                    </maml:description>
                    <command:parameterValue required="false" variableLength="false">switch</command:parameterValue>
                </command:parameter>
                <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named">
                    <maml:name>Force</maml:name>
                    <maml:description>
                        <maml:para>Force</maml:para>
                    </maml:description>
                    <command:parameterValue required="false" variableLength="false">switch</command:parameterValue>
                </command:parameter>
            </command:syntaxItem>
            <command:syntaxItem parametersetname="WorkPhone">
                <maml:name>Set-FutureList</maml:name>
                <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named">
                    <maml:name>Path</maml:name>
                    <maml:description>
                        <maml:para>Path to the Excel document created by Get-FutureRoom.</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="Named">
                    <maml:name>WorkPhone</maml:name>
                    <maml:description>
                        <maml:para>Set the attributes for work phones.</maml:para>
                    </maml:description>
                    <command:parameterValue required="false" variableLength="false">switch</command:parameterValue>
                </command:parameter>
                <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named">
                    <maml:name>Force</maml:name>
                    <maml:description>
                        <maml:para>Force</maml:para>
                    </maml:description>
                    <command:parameterValue required="false" variableLength="false">switch</command:parameterValue>
                </command:parameter>
            </command:syntaxItem>
            <command:syntaxItem parametersetname="Pager">
                <maml:name>Set-FutureList</maml:name>
                <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named">
                    <maml:name>Path</maml:name>
                    <maml:description>
                        <maml:para>Path to the Excel document created by Get-FutureRoom.</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="Named">
                    <maml:name>Pager</maml:name>
                    <maml:description>
                        <maml:para>Set the attributes for pagers.</maml:para>
                    </maml:description>
                    <command:parameterValue required="false" variableLength="false">switch</command:parameterValue>
                </command:parameter>
                <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named">
                    <maml:name>Force</maml:name>
                    <maml:description>
                        <maml:para>Force</maml:para>
                    </maml:description>
                    <command:parameterValue required="false" variableLength="false">switch</command:parameterValue>
                </command:parameter>
            </command:syntaxItem>
        </command:syntax>
        <command:parameters>
            <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named">
                <maml:name>Path</maml:name>
                <maml:description>
                    <maml:para>Path to the Excel document created by Get-FutureRoom.</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="Named">
                <maml:name>Logding</maml:name>
                <maml:description>
                    <maml:para>Set the attributes for Lodging.</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:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named">
                <maml:name>Operations</maml:name>
                <maml:description>
                    <maml:para>Set the attributes for Operations.</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:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named">
                <maml:name>WorkPhone</maml:name>
                <maml:description>
                    <maml:para>Set the attributes for work phones.</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:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named">
                <maml:name>Pager</maml:name>
                <maml:description>
                    <maml:para>Set the attributes for pagers.</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:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named">
                <maml:name>Force</maml:name>
                <maml:description>
                    <maml:para>Force</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>Requires the module ImportExcel (By Douglas Finke) and Active Directory
Install-Module -Name ImportExcel
 
===========================================================================
Created on: 8/16/2019 4:57 PM
Created by: Craig Moore (McMurdo Sr Systems Administrator)
Organization: United States Antarctic Program
Filename: Set-FutureList.ps1
===========================================================================</maml:para>
            </maml:alert>
        </maml:alertSet>
        <command:examples>
            <command:example>
                <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title>
                <maml:introduction>
                    <maml:para></maml:para>
                </maml:introduction>
                <dev:code>PS C:\&gt; Set-FutureList -Path &#39;C:\Temp\List.xlsx&#39; </dev:code>
                <dev:remarks>
                    <maml:para>Updates the Active Directory attributes defined in C:\Temp\List.xlsx</maml:para>
 
                </dev:remarks>
            </command:example>
        </command:examples>
    </command:command>
</helpItems>