en-US/MCMItPhoneLists.psm1-Help.xml

<?xml version="1.0" encoding="utf-8"?>
<helpItems xmlns="http://msh" schema="maml">
    <!--Edited with: SAPIEN PowerShell HelpWriter 2019 v2.3.45-->
    <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-ItPhoneList</command:name>
            <maml:description>
                <maml:para>Creates a reference phone list from active directory attributes.</maml:para>
            </maml:description>
            <maml:copyright>
                <maml:para></maml:para>
            </maml:copyright>
            <command:verb>Get</command:verb>
            <command:noun>ItPhoneList</command:noun>
            <dev:version />
        </command:details>
        <maml:description>
            <maml:para>Creates an IT Phone for each station. Information to generate the list is retrieved from attributes in active directory.</maml:para>
        </maml:description>
        <command:syntax>
            <command:syntaxItem parametersetname="__AllParameterSets">
                <maml:name>Get-ItPhoneList</maml:name>
                <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0">
                    <maml:name>Path</maml:name>
                    <maml:description>
                        <maml:para>Path to where the output Excel file will reside. Must have the .xlsx file extension.</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>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="true" variableLength="false" globbing="false" pipelineInput="false" position="0">
                <maml:name>Path</maml:name>
                <maml:description>
                    <maml:para>Path to where the output Excel file will reside. Must have the .xlsx file extension.</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>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>Requires the module ImportExcel (By Douglas Finke) and Active Directory
Install-Module -Name ImportExcel</maml:para>
                <maml:para>===========================================================================
Created on: 5/28/2019 4:07 PM
Created by: Craig Moore (McMurdo Sr Systems Administrator)
Organization: United States Antarctic Program
Filename: Get-ITPhoneList.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-ItPhoneList -Path \\FileServer\IT\Reference\Local_IT.xlsx -Show
</dev:code>
                <dev:remarks>
                    <maml:para>Creates the phone list, saves it to the location given, and opens the file at the completion.</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-McmItPhoneListDesktopReference</command:name>
            <maml:description>
                <maml:para>IT Phone list generator. Small enough to be printed and kept at your desk.</maml:para>
            </maml:description>
            <maml:copyright>
                <maml:para></maml:para>
            </maml:copyright>
            <command:verb>Get</command:verb>
            <command:noun>McmItPhoneListDesktopReference</command:noun>
            <dev:version />
        </command:details>
        <maml:description>
            <maml:para>Creates a phone list for the McMurdo IT department.</maml:para>
        </maml:description>
        <command:syntax>
            <command:syntaxItem parametersetname="__AllParameterSets">
                <maml:name>Get-McmItPhoneListDesktopReference</maml:name>
                <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0">
                    <maml:name>Path</maml:name>
                    <maml:description>
                        <maml:para>Path to where the output Excel file will reside. Must have the .xlsx file extension.</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>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="true" variableLength="false" globbing="false" pipelineInput="false" position="0">
                <maml:name>Path</maml:name>
                <maml:description>
                    <maml:para>Path to where the output Excel file will reside. Must have the .xlsx file extension.</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>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>Requires the module ImportExcel (By Douglas Finke) and Active Directory
Install-Module -Name ImportExcel</maml:para>
                <maml:para>===========================================================================
Created on: 8/24/2019 12:15 PM
Created by: Craig Moore (McMurdo Sr Systems Administrator)
Organization: United States Antarctic Program
Filename: Get-McmItPhoneListDesktopReference.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-McmItPhoneListDesktopReference -Path \\FileServer\IT\Reference\Local_IT.xlsx -Show
</dev:code>
                <dev:remarks>
                    <maml:para>Creates the phone list, saves it to the location given, and opens the file at the completion.</maml:para>
                </dev:remarks>
            </command:example>
        </command:examples>
    </command:command>
    <!--Edited with: SAPIEN PowerShell HelpWriter 2019 v2.3.45-->
</helpItems>