Skip to content

Commit 7ed67a4

Browse files
DrIOSXDrIOSX
authored
Merge pull request #37 from CriticalSolutionsNetwork/36-docs-add-comment-help-block-to-adhostaudit
fix: Issue #36
2 parents 1d5e80c + 48d6bfd commit 7ed67a4

10 files changed

+274
-183
lines changed

‎CHANGELOG.md

+6
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
55

66
## [Unreleased]
77

8+
### Fixed
9+
10+
- Fixed missing comment help block in `Get-ADHostAudit`
11+
12+
## [0.3.3] - 2023-03-15
13+
814
### Added
915

1016
- Added private function `Build-DirectoryPath`.

‎buildpak.ps1

+19-11
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,17 @@
1-
Remove-Module ADAuditTasks
2-
Remove-Item .\output\ADAuditTasks -Recurse
3-
Remove-Item ".\output\ADAuditTasks.*.nupkg"
4-
Remove-Item .\output\ReleaseNotes.md
5-
Remove-Item .\output\CHANGELOG.md
6-
.\build.ps1 -tasks build -CodeCoverageThreshold 0
1+
function Build-TestBuildFunc {
2+
Remove-Module ADAuditTasks
3+
Remove-Item .\output\ADAuditTasks -Recurse
4+
Remove-Item ".\output\ADAuditTasks.*.nupkg"
5+
Remove-Item .\output\ReleaseNotes.md
6+
Remove-Item .\output\CHANGELOG.md
7+
.\build.ps1 -tasks build -CodeCoverageThreshold 0
8+
}
9+
function Build-Docs {
10+
Import-Module .\output\ADAuditTasks\*\*.psd1
11+
.\ModdedModules\psDoc-master\src\psDoc.ps1 -moduleName ADAuditTasks -outputDir docs -template ".\ModdedModules\psDoc-master\src\out-html-template.ps1"
12+
}
13+
Build-TestBuildFunc
14+
Build-Docs
715
#Remove-Item C:\temp\ADDS* -Recurse
816

917
#.\build.ps1 -ResolveDependency -tasks noop
@@ -18,11 +26,11 @@ Remove-Item .\output\CHANGELOG.md
1826
7. Run the build using the pack task to create the NuGet package: `.\build.ps1 -tasks pack -CodeCoverageThreshold 0`.
1927
8. Upload the NuGet package to the PowerShell Gallery using the publish task: `.\build.ps1 -tasks publish -CodeCoverageThreshold 0`.
2028
#>
21-
$ver = "v0.3.2"
29+
$ver = "v0.3.4"
2230
git checkout main
2331
git pull origin main
2432
git tag -a $ver -m "Release version $ver Fix"
25-
"Fix: Issues #28 #30 #32"
33+
"Fix: PR #35 Issue #34"
2634
git push origin $ver
2735
# git tag -d $ver
2836

@@ -33,7 +41,7 @@ $activeUsers = Get-ADActiveUserAudit -Report -Verbose
3341
$privilegedUsers = Get-ADUserPrivilegeAudit -Report -Verbose
3442
$wildcardUsers = Get-ADUserWildCardAudit -WildCardIdentifier "svc" -Report -Verbose
3543
$netaudit = Get-NetworkAudit -LocalSubnets -Report -Verbose
36-
Merge-ADAuditZip -FilePaths $workstations, $servers, $nonWindows, $activeUsers, $privilegedUsers, $wildcardUsers,$netaudit -OpenDirectory
44+
Merge-ADAuditZip -FilePaths $workstations, $servers, $nonWindows, $activeUsers, $privilegedUsers, $wildcardUsers, $netaudit -OpenDirectory
3745

3846
Get-HostTag -PhysicalOrVirtual Physical -Prefix "CSN" -SystemOS 'Windows Server' -DeviceFunction 'Application Server' -HostCount 5
3947
Get-ADUserLogonAudit -SamAccountName "<USERNAME>" -Verbose
@@ -48,6 +56,6 @@ Get-NetworkAudit -LocalSubnets -Report -Verbose
4856
# Add Api Variables to session.
4957
# Build / Publish
5058

51-
.\build.ps1 -tasks build,pack,publish -CodeCoverageThreshold 0
59+
.\build.ps1 -tasks build, pack, publish -CodeCoverageThreshold 0
5260

53-
.\build.ps1 -tasks Build,Test -CodeCoverageThreshold 0
61+
.\build.ps1 -tasks Build, Test -CodeCoverageThreshold 0

‎docs/index.html

+77-33
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<!--
33
<auto-generated>
44
<synopsis>
5-
This code was generated by a tool. on: 03/14/2023 22:12:13
5+
This code was generated by a tool. on: 03/15/2023 12:52:15
66
</synopsis>
77
<description>
88
If you'd like to regenerate the documentation, please open up powershell and run
@@ -209,7 +209,19 @@ <h3> Examples </h3>
209209
<div id="Get-ADHostAudit" class="toggle_container">
210210
<div class="page-header">
211211
<h2> Get-ADHostAudit </h2>
212+
<p>Active Directory Server and Workstation Audit with Report export option (Can also be piped to CSV if Report isn't specified).</p>
213+
<p>Audit's Active Directory taking "days" as the input for how far back to check for a device's last sign in.<br>Output can be piped to a csv manually, or automatically to C:\temp\ADHostAudit or a specified path in<br>"AttachmentFolderPath" using the -Report Switch.<br><br>Use the Tab key to cycle through the -HostType Parameter.</p>
212214
</div>
215+
<div>
216+
<h3> Syntax </h3>
217+
</div>
218+
<div class="panel panel-default">
219+
<div class='panel-body'>
220+
<pre class="brush: ps">Get-ADHostAudit [-HostType] &lt;String&gt; [[-DaystoConsiderAHostInactive] &lt;Int32&gt;] [[-Report]] [[-AttachmentFolderPath] &lt;String&gt;] [-Enabled &lt;Boolean&gt;] [&lt;CommonParameters&gt;]
221+
222+
Get-ADHostAudit [-OSType] &lt;String&gt; [[-DaystoConsiderAHostInactive] &lt;Int32&gt;] [[-Report]] [[-AttachmentFolderPath] &lt;String&gt;] [-Enabled &lt;Boolean&gt;] [&lt;CommonParameters&gt;]</pre>
223+
</div>
224+
</div>
213225
<div>
214226
<h3> Parameters </h3>
215227
<table class="table table-striped table-bordered table-condensed visible-on">
@@ -225,56 +237,88 @@ <h3> Parameters </h3>
225237
</thead>
226238
<tbody>
227239
<tr>
228-
<td><nobr>-AttachmentFolderPath</nobr></td>
229-
<td class="visible-lg visible-md">None</td>
230-
<td>Enter the working directory you wish the report to save to. Default creates C:\temp</td>
231-
<td class="visible-lg visible-md">false</td>
232-
<td class="visible-lg">false</td>
240+
<td><nobr>-HostType</nobr></td>
241+
<td class="visible-lg visible-md"></td>
242+
<td>Select from WindowsServers, WindowsWorkstations or Non-Windows.</td>
243+
<td class="visible-lg visible-md">true</td>
244+
<td class="visible-lg">true (ByValue)</td>
233245
<td class="visible-lg"></td>
234246
</tr>
235247
<tr>
236-
<td><nobr>-DaystoConsiderAHostInactive</nobr></td>
237-
<td class="visible-lg visible-md">None</td>
238-
<td>How many days back to consider an AD Computer last sign in as active</td>
239-
<td class="visible-lg visible-md">false</td>
240-
<td class="visible-lg">true (ByPropertyName)</td>
248+
<td><nobr>-OSType</nobr></td>
249+
<td class="visible-lg visible-md"></td>
250+
<td>Search an OS String. There is no need to add wildcards.</td>
251+
<td class="visible-lg visible-md">true</td>
252+
<td class="visible-lg">true (ByValue)</td>
241253
<td class="visible-lg"></td>
242254
</tr>
243255
<tr>
244-
<td><nobr>-Enabled</nobr></td>
245-
<td class="visible-lg visible-md">None</td>
246-
<td>Search for Enabled or Disabled hosts</td>
256+
<td><nobr>-DaystoConsiderAHostInactive</nobr></td>
257+
<td class="visible-lg visible-md"></td>
258+
<td>How far back in days to look for sign ins. Outside of this window, hosts are considered "Inactive"</td>
247259
<td class="visible-lg visible-md">false</td>
248260
<td class="visible-lg">true (ByPropertyName)</td>
249-
<td class="visible-lg"></td>
261+
<td class="visible-lg">90</td>
250262
</tr>
251263
<tr>
252-
<td><nobr>-HostType</nobr></td>
253-
<td class="visible-lg visible-md">None</td>
254-
<td>Name filter attached to users.</td>
255-
<td class="visible-lg visible-md">true</td>
256-
<td class="visible-lg">true (ByValue)</td>
257-
<td class="visible-lg"></td>
264+
<td><nobr>-Report</nobr></td>
265+
<td class="visible-lg visible-md"></td>
266+
<td>Add report output as csv to DirPath directory.</td>
267+
<td class="visible-lg visible-md">false</td>
268+
<td class="visible-lg">true (ByPropertyName)</td>
269+
<td class="visible-lg">False</td>
258270
</tr>
259271
<tr>
260-
<td><nobr>-OSType</nobr></td>
261-
<td class="visible-lg visible-md">None</td>
262-
<td>Enter a Specific OS Name or first few letters of the OS to Search for in ActiveDirectory</td>
263-
<td class="visible-lg visible-md">true</td>
264-
<td class="visible-lg">true (ByValue)</td>
265-
<td class="visible-lg"></td>
272+
<td><nobr>-AttachmentFolderPath</nobr></td>
273+
<td class="visible-lg visible-md"></td>
274+
<td>Default path is C:\temp\ADHostAudit.<br>This is the folder where attachments are going to be saved.</td>
275+
<td class="visible-lg visible-md">false</td>
276+
<td class="visible-lg">false</td>
277+
<td class="visible-lg">C:\temp\ADHostAudit</td>
266278
</tr>
267279
<tr>
268-
<td><nobr>-Report</nobr></td>
269-
<td class="visible-lg visible-md">None</td>
270-
<td>Switch to output to directory specified in DirPath parameter</td>
280+
<td><nobr>-Enabled</nobr></td>
281+
<td class="visible-lg visible-md"></td>
282+
<td>If "$false", will also search disabled computers.</td>
271283
<td class="visible-lg visible-md">false</td>
272284
<td class="visible-lg">true (ByPropertyName)</td>
273-
<td class="visible-lg"></td>
285+
<td class="visible-lg">True</td>
274286
</tr>
275287
</tbody>
276288
</table>
277289
</div>
290+
<div>
291+
<h3> Outputs </h3>
292+
<p>The output type is the type of the objects that the cmdlet emits.</p>
293+
<ul><li>System.Management.Automation.PSObject</li></ul>
294+
</div>
295+
<div class='panel panel-default'>
296+
<div class='panel-heading'>
297+
<h3 class='panel-title'> Note </h3>
298+
</div>
299+
<div class='panel-body'>Outputs to C:\temp\ADHostAudit by default.
300+
For help type: help Get-ADHostAudit -ShowWindow</div>
301+
</div>
302+
<div>
303+
<h3> Examples </h3>
304+
</div>
305+
<div class='panel panel-default'>
306+
<div class='panel-body'>
307+
<strong>EXAMPLE 1</strong>
308+
<pre class="brush: ps">Get-ADHostAudit -HostType WindowsServers -Report -Verbose</pre>
309+
<div></div>
310+
<strong>EXAMPLE 2</strong>
311+
<pre class="brush: ps">Get-ADHostAudit -HostType WindowsWorkstations -Report -Verbose</pre>
312+
<div></div>
313+
<strong>EXAMPLE 3</strong>
314+
<pre class="brush: ps">Get-ADHostAudit -HostType "Non-Windows" -Report -Verbose</pre>
315+
<div></div>
316+
<strong>EXAMPLE 4</strong>
317+
<pre class="brush: ps">Get-ADHostAudit -OSType "2008" -DirPath "C:\Temp\" -Report -Verbose</pre>
318+
<div></div>
319+
</div>
320+
</div>
321+
<p class='pull-right'><a onclick='document.body.scrollTop = document.documentElement.scrollTop = 0;' style='cursor: pointer;'>Top of page</a>
278322
</div>
279323
<div id="Get-ADUserLogonAudit" class="toggle_container">
280324
<div class="page-header">
@@ -942,13 +986,13 @@ <h3> Examples </h3>
942986
<pre class="brush: ps">Send-AuditEmail -SMTPServer "smtp.office365.com" -Port 587 -UserName "[email protected]" `
943987
-From "[email protected]" -To "[email protected]" -Pass (Read-Host -AsSecureString) -AttachmentFiles "$(Get-ADActiveUserAudit -Report)" -SSL</pre>
944988
<div>This will automatically send the report zip via email to the parameters specified.
945-
There is no cleanup of files. Please cleanup the directory of zip's if neccessary.</div>
989+
There is no cleanup of files. Please cleanup the directory of zip's if neccessary.</div>
946990
<strong>EXAMPLE 2</strong>
947991
<pre class="brush: ps">Send-AuditEmail -SMTPServer "smtp.office365.com" -Port 587 -UserName "[email protected]" `
948992
-From "[email protected]" -To "[email protected]" -AttachmentFiles "$(Get-ADActiveUserAudit -Report)" -FunctionApp "MyVaultFunctionApp" `
949993
-Function "MyClientSpecificFunction" -Token "ABCDEF123456" -SSL</pre>
950994
<div>This will automatically send the report zip via email to the parameters specified.
951-
There is no cleanup of files. Please cleanup the directory of zip's if neccessary.</div>
995+
There is no cleanup of files. Please cleanup the directory of zip's if neccessary.</div>
952996
</div>
953997
</div>
954998
<p class='pull-right'><a onclick='document.body.scrollTop = document.documentElement.scrollTop = 0;' style='cursor: pointer;'>Top of page</a>

‎source/Public/Get-ADHostAudit.ps1

+33
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,38 @@
11
function Get-ADHostAudit {
2+
<#
3+
.SYNOPSIS
4+
Active Directory Server and Workstation Audit with Report export option (Can also be piped to CSV if Report isn't specified).
5+
.DESCRIPTION
6+
Audit's Active Directory taking "days" as the input for how far back to check for a device's last sign in.
7+
Output can be piped to a csv manually, or automatically to C:\temp\ADHostAudit or a specified path in
8+
"AttachmentFolderPath" using the -Report Switch.
29
10+
Use the Tab key to cycle through the -HostType Parameter.
11+
.EXAMPLE
12+
PS C:\> Get-ADHostAudit -HostType WindowsServers -Report -Verbose
13+
.EXAMPLE
14+
PS C:\> Get-ADHostAudit -HostType WindowsWorkstations -Report -Verbose
15+
.EXAMPLE
16+
PS C:\> Get-ADHostAudit -HostType "Non-Windows" -Report -Verbose
17+
.EXAMPLE
18+
PS C:\> Get-ADHostAudit -OSType "2008" -DirPath "C:\Temp\" -Report -Verbose
19+
.PARAMETER HostType
20+
Select from WindowsServers, WindowsWorkstations or Non-Windows.
21+
.PARAMETER OSType
22+
Search an OS String. There is no need to add wildcards.
23+
.PARAMETER DaystoConsiderAHostInactive
24+
How far back in days to look for sign ins. Outside of this window, hosts are considered "Inactive"
25+
.PARAMETER Report
26+
Add report output as csv to DirPath directory.
27+
.PARAMETER AttachmentFolderPath
28+
Default path is C:\temp\ADHostAudit.
29+
This is the folder where attachments are going to be saved.
30+
.PARAMETER Enabled
31+
If "$false", will also search disabled computers.
32+
.NOTES
33+
Outputs to C:\temp\ADHostAudit by default.
34+
For help type: help Get-ADHostAudit -ShowWindow
35+
#>
336
[OutputType([pscustomobject])]
437
[CmdletBinding(DefaultParameterSetName = 'HostType')]
538
param (

‎source/Public/Get-ADUserLogonAudit.ps1

+24-24
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,29 @@
11
function Get-ADUserLogonAudit {
22
<#
3-
.SYNOPSIS
4-
Retrieves the most recent LastLogon timestamp for a specified Active Directory user account from all domain controllers and outputs it as a DateTime object.
5-
.DESCRIPTION
6-
This function takes a SamAccountName input parameter for a specific user account and retrieves the most recent
7-
LastLogon timestamp for that user from all domain controllers in the Active Directory environment.
8-
It then returns the LastLogon timestamp as a DateTime object. The function also checks the availability
9-
of each domain controller before querying it, and writes an audit log with a list of available and
10-
unavailable domain controllers.
11-
.PARAMETER SamAccountName
12-
Specifies the SamAccountName of the user account to be checked for the most recent LastLogon timestamp.
13-
.INPUTS
14-
A SamAccountName string representing the user account to be checked.
15-
.OUTPUTS
16-
A DateTime object representing the most recent LastLogon timestamp for the specified user account.
17-
.EXAMPLE
18-
Get-ADUserLogonAudit -SamAccountName "jdoe"
19-
Retrieves the most recent LastLogon timestamp for the user account with the SamAccountName "jdoe" from all
20-
domain controllers in the Active Directory environment.
21-
.NOTES
22-
This function is designed to be run on the primary domain controller, but it can be run on any domain
23-
controller in the environment.
24-
It requires the Active Directory PowerShell module and appropriate permissions to read user account data.
25-
The function may take some time to complete if the Active Directory environment is large or the domain
26-
controllers are geographically distributed.
3+
.SYNOPSIS
4+
Retrieves the most recent LastLogon timestamp for a specified Active Directory user account from all domain controllers and outputs it as a DateTime object.
5+
.DESCRIPTION
6+
This function takes a SamAccountName input parameter for a specific user account and retrieves the most recent
7+
LastLogon timestamp for that user from all domain controllers in the Active Directory environment.
8+
It then returns the LastLogon timestamp as a DateTime object. The function also checks the availability
9+
of each domain controller before querying it, and writes an audit log with a list of available and
10+
unavailable domain controllers.
11+
.PARAMETER SamAccountName
12+
Specifies the SamAccountName of the user account to be checked for the most recent LastLogon timestamp.
13+
.INPUTS
14+
A SamAccountName string representing the user account to be checked.
15+
.OUTPUTS
16+
A DateTime object representing the most recent LastLogon timestamp for the specified user account.
17+
.EXAMPLE
18+
Get-ADUserLogonAudit -SamAccountName "jdoe"
19+
Retrieves the most recent LastLogon timestamp for the user account with the SamAccountName "jdoe" from all
20+
domain controllers in the Active Directory environment.
21+
.NOTES
22+
This function is designed to be run on the primary domain controller, but it can be run on any domain
23+
controller in the environment.
24+
It requires the Active Directory PowerShell module and appropriate permissions to read user account data.
25+
The function may take some time to complete if the Active Directory environment is large or the domain
26+
controllers are geographically distributed.
2727
#>
2828
[CmdletBinding()]
2929
[OutputType([datetime])]

0 commit comments

Comments
 (0)