< Back
Get-MCMListDocumentation
Post
NAME
Get-MCMListDocumentation
SYNOPSIS
Documents the resident lists for McMurdo station
SYNTAX
Get-MCMListDocumentation -Path <System.IO.FileInfo> [-Show <switch>] [<CommonParameters>]
Get-MCMListDocumentation -Path <System.IO.FileInfo> [-Show <switch>] [-Logding <switch>] [<CommonParameters>]
Get-MCMListDocumentation -Path <System.IO.FileInfo> [-Show <switch>] [-Operations <switch>] [<CommonParameters>]
Get-MCMListDocumentation -Path <System.IO.FileInfo> [-Show <switch>] [-WorkPhone <switch>] [<CommonParameters>]
Get-MCMListDocumentation -Path <System.IO.FileInfo> [-Show <switch>] [-Pager <switch>] [<CommonParameters>]
DESCRIPTION
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
PARAMETERS
-Path <System.IO.FileInfo>
File path to where to output .xlsx file
Required? true
Position? Named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SaveTo <System.IO.FileInfo>
Required? true
Position? Named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Show [<switch>]
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.
Required? false
Position? Named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Logding [<switch>]
Hides the Excel columns bot related to Housing.
Required? false
Position? Named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Operations [<switch>]
Hides the Excel columns not related to Operations.
Required? false
Position? Named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-WorkPhone [<switch>]
Hides the Excel columns not related to work phones.
Required? false
Position? Named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Pager [<switch>]
Hides the Excel columns not related to pagers.
Required? false
Position? Named
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
System.IO.File
NOTES
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
===========================================================================
-------------------------- EXAMPLE 1 --------------------------
PS C:\> Get-MCMDormDocumentation -Path "C:\Temp\List.xlsx"
Documents the residents of McMurdo showing all information, saves to C:\Temp\List.xlsx
-------------------------- EXAMPLE 2 --------------------------
PS C:\> Get-MCMDormDocumentation -Path "C:\Temp\List.xlsx" -Show
Documents the residents of McMurdo showing all information, saves to C:\Temp\List.xlsx then open the file when complete
-------------------------- EXAMPLE 3 --------------------------
PS C:\> Get-MCMDormDocumentation -Path "C:\Temp\List.xlsx" -Lodging -Show
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
-------------------------- EXAMPLE 4 --------------------------
PS C:\> Get-MCMDormDocumentation -Path "C:\Temp\List.xlsx" -Operations -Show
Documents the residents of McMurdo ,showing Operations information, saves to C:\Temp\List.xlsx then open the file when complete
RELATED LINKS
Get-MCMListDocumentation
SYNOPSIS
Documents the resident lists for McMurdo station
SYNTAX
Get-MCMListDocumentation -Path <System.IO.FileInfo> [-Show <switch>] [<CommonParameters>]
Get-MCMListDocumentation -Path <System.IO.FileInfo> [-Show <switch>] [-Logding <switch>] [<CommonParameters>]
Get-MCMListDocumentation -Path <System.IO.FileInfo> [-Show <switch>] [-Operations <switch>] [<CommonParameters>]
Get-MCMListDocumentation -Path <System.IO.FileInfo> [-Show <switch>] [-WorkPhone <switch>] [<CommonParameters>]
Get-MCMListDocumentation -Path <System.IO.FileInfo> [-Show <switch>] [-Pager <switch>] [<CommonParameters>]
DESCRIPTION
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
PARAMETERS
-Path <System.IO.FileInfo>
File path to where to output .xlsx file
Required? true
Position? Named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SaveTo <System.IO.FileInfo>
Required? true
Position? Named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Show [<switch>]
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.
Required? false
Position? Named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Logding [<switch>]
Hides the Excel columns bot related to Housing.
Required? false
Position? Named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Operations [<switch>]
Hides the Excel columns not related to Operations.
Required? false
Position? Named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-WorkPhone [<switch>]
Hides the Excel columns not related to work phones.
Required? false
Position? Named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Pager [<switch>]
Hides the Excel columns not related to pagers.
Required? false
Position? Named
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
System.IO.File
NOTES
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
===========================================================================
-------------------------- EXAMPLE 1 --------------------------
PS C:\> Get-MCMDormDocumentation -Path "C:\Temp\List.xlsx"
Documents the residents of McMurdo showing all information, saves to C:\Temp\List.xlsx
-------------------------- EXAMPLE 2 --------------------------
PS C:\> Get-MCMDormDocumentation -Path "C:\Temp\List.xlsx" -Show
Documents the residents of McMurdo showing all information, saves to C:\Temp\List.xlsx then open the file when complete
-------------------------- EXAMPLE 3 --------------------------
PS C:\> Get-MCMDormDocumentation -Path "C:\Temp\List.xlsx" -Lodging -Show
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
-------------------------- EXAMPLE 4 --------------------------
PS C:\> Get-MCMDormDocumentation -Path "C:\Temp\List.xlsx" -Operations -Show
Documents the residents of McMurdo ,showing Operations information, saves to C:\Temp\List.xlsx then open the file when complete
RELATED LINKS