Skip to content

Commit

Permalink
Merge pull request #96 from AsBuiltReport/dev
Browse files Browse the repository at this point in the history
v0.7.12 public release
  • Loading branch information
rebelinux committed May 23, 2023
2 parents 15f0a7c + 098ff94 commit 5258beb
Show file tree
Hide file tree
Showing 28 changed files with 2,306 additions and 2,545 deletions.
6 changes: 5 additions & 1 deletion .github/workflows/Release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,10 @@ jobs:
shell: pwsh
run: |
Install-Module -Name AsBuiltReport.Core -Repository PSGallery -Force
- name: Install AsBuiltReport.Microsoft.DHCP module
shell: pwsh
run: |
Install-Module -Name AsBuiltReport.Microsoft.DHCP -Repository PSGallery -Force
- name: Install PSPKI module
shell: pwsh
run: |
Expand All @@ -43,7 +47,7 @@ jobs:
with:
# GitHub event payload
# https://docs.github.com/en/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#release
tweet-message: "[New Release] ${{ github.event.repository.name }} ${{ github.event.release.tag_name }}! Check out what's new! ${{ github.event.release.html_url }} #Microsoft #ActiveDirectory #AsBuiltReport #PowerShell #MVPBuzz #cybersecurity #infosec"
tweet-message: "[New Release] ${{ github.event.repository.name }} ${{ github.event.release.tag_name }}! Check out what's new! ${{ github.event.release.html_url }} #Microsoft #ActiveDirectory #AsBuiltReport #PowerShell #MicrosoftMVP #MVPBuzz #cybersecurity #infosec"
env:
TWITTER_CONSUMER_API_KEY: ${{ secrets.TWITTER_CONSUMER_API_KEY }}
TWITTER_CONSUMER_API_SECRET: ${{ secrets.TWITTER_CONSUMER_API_SECRET }}
Expand Down
4 changes: 2 additions & 2 deletions AsBuiltReport.Microsoft.AD.Style.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -65,10 +65,10 @@ if (!($ReportConfig.Report.ShowCoverPageImage)) {
}
if ($Orientation -eq 'Portrait') {
BlankLine -Count 11
$LineCount = 32 + $LineCount
$LineCount = 23 + $LineCount
} else {
BlankLine -Count 7
$LineCount = 15 + $LineCount
$LineCount = 9 + $LineCount
}

# Cover Page Image
Expand Down
11 changes: 2 additions & 9 deletions AsBuiltReport.Microsoft.AD.json
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,8 @@
"_comment_": "0 = Disabled, 1 = Enabled, 2 = Adv Summary, 3 = Detailed",
"Forest": 1,
"Domain": 1,
"DHCP": 1,
"DNS": 1,
"CA": 2
"DNS": 0,
"CA": 0
},
"HealthCheck": {
"Domain": {
Expand All @@ -48,12 +47,6 @@
"DP": true,
"Zones": true
},
"DHCP": {
"Summary": true,
"Credential": true,
"Statistics": true,
"BP": true
},
"CA": {
"Status": true,
"Statistics": true
Expand Down
6 changes: 5 additions & 1 deletion AsBuiltReport.Microsoft.AD.psd1
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
RootModule = 'AsBuiltReport.Microsoft.AD.psm1'

# Version number of this module.
ModuleVersion = '0.7.11'
ModuleVersion = '0.7.12'

# Supported PSEditions
# CompatiblePSEditions = @()
Expand Down Expand Up @@ -63,6 +63,10 @@ RequiredModules = @(
@{
ModuleName = 'PScriboCharts';
ModuleVersion = '0.9.0'
},
@{
ModuleName = 'AsBuiltReport.Microsoft.DHCP';
ModuleVersion = '0.1.0'
}
)

Expand Down
27 changes: 27 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
# :arrows_clockwise: Microsoft AD As Built Report Changelog

## [0.7.12] - 2023-05-23

### Changed

- Removed DHCP section (migrated to AsBuiltReport.Microsoft.DHCP)
- Disabled DNS & CA section by default

## [0.7.11] - 2023-03-09

### Added
Expand All @@ -21,6 +28,26 @@

### Fixed

- [#81](https://github.com/AsBuiltReport/AsBuiltReport.Microsoft.AD/issues/81)
### Added

- Added section for Local Administrator Password Solution.

### Changed

- Improved bug and feature request templates
- Changed default logo from Microsoft to the AsBuiltReport logo due to licensing requirements
- Changed default report style font to 'Segoe Ui' to align with Microsoft guidelines
- Changed Required Modules to AsBuiltReport.Core v1.3.0
- Changed Infolevel 1 table structure on the following section:
- Hardware Inventory
- Fined Grained Password Policies
- Group Managed Service Accounts (GMSA)
- Sites Replication Connection
- Domain and Trusts

### Fixed

- [#81](https://github.com/AsBuiltReport/AsBuiltReport.Microsoft.AD/issues/81)

## [0.7.10] - 2022-10-28
Expand Down
16 changes: 5 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,15 +65,14 @@ This report is compatible with the following PowerShell versions;

## :wrench: System Requirements
<!-- ********** Update system requirements ********** -->
PowerShell 5.1 or PowerShell 7, and the following PowerShell modules are required for generating a Microsoft AD As Built report.
PowerShell 5.1, and the following PowerShell modules are required for generating a Microsoft AD As Built report.

- [AsBuiltReport.Microsoft.AD Module](https://www.powershellgallery.com/packages/AsBuiltReport.Microsoft.AD/)
- [PScriboCharts Module](https://github.com/iainbrighton/PScriboCharts)
- [ActiveDirectory Module](https://docs.microsoft.com/en-us/powershell/module/activedirectory/?view=windowsserver2019-ps)
- [ADCSAdministration Module](https://learn.microsoft.com/en-us/powershell/module/adcsadministration/?view=windowsserver2019-ps)
- [PSPKI Module](https://www.powershellgallery.com/packages/PSPKI/3.7.2)
- [GroupPolicy Module](https://docs.microsoft.com/en-us/powershell/module/grouppolicy/?view=windowsserver2019-ps)
- [DhcpServer Module](https://docs.microsoft.com/en-us/powershell/module/dhcpserver/?view=windowsserver2019-ps)
- [DnsServer Module](https://docs.microsoft.com/en-us/powershell/module/dnsserver/?view=windowsserver2019-ps)

### Linux & macOS
Expand All @@ -93,26 +92,22 @@ Due to a limitation of the WinRM component, a domain-joined machine is needed, a
<!-- ********** Add installation for any additional PowerShell module(s) ********** -->
```powershell
Install-Module -Name PSPKI
Install-Module -Name PScriboCharts
Install-Module -Name AsBuiltReport.Microsoft.AD
Install-WindowsFeature -Name RSAT-AD-PowerShell
Install-WindowsFeature -Name RSAT-ADCS,RSAT-ADCS-mgmt
Install-WindowsFeature -Name RSAT-DNS-Server
Install-WindowsFeature -Name RSAT-DHCP
Install-WindowsFeature -Name GPMC
```

### PowerShell v5.x running on Windows 10 client computer
<!-- ********** Add installation for any additional PowerShell module(s) ********** -->
```powershell
Install-Module -Name PSPKI
Install-Module -Name PScriboCharts
Install-Module -Name AsBuiltReport.Microsoft.AD
Add-WindowsCapability -online -Name 'Rsat.ActiveDirectory.DS-LDS.Tools~~~~0.0.1.0'
Add-WindowsCapability -Online -Name 'Rsat.CertificateServices.Tools~~~~0.0.1.0'
Add-WindowsCapability -online -Name 'Rsat.GroupPolicy.Management.Tools~~~~0.0.1.0'
Add-WindowsCapability –online –Name 'Rsat.Dns.Tools~~~~0.0.1.0'
Add-WindowsCapability -Online -Name 'Rsat.DHCP.Tools~~~~0.0.1.0'
```

### GitHub
Expand Down Expand Up @@ -182,7 +177,7 @@ There are 4 levels (0-3) of detail granularity for each section as follows;
| Setting | InfoLevel | Description |
|:-------:|-------------------|--------------------------------------------------------------------------------------------------------------------------------------------|
| 0 | Disabled | Does not collect or display any information |
| 1 | Enabled | Provides summarised information for a collection of objects |
| 1 | Enabled | Provides summarised information for a collection of objects |
| 2 | Adv Summary | Provides condensed, detailed information for a collection of objects |
| 3 | Detailed | Provides detailed information for individual objects |

Expand All @@ -192,9 +187,8 @@ The table below outlines the default and maximum **InfoLevel** settings for each
|--------------|:---------------:|:---------------:|
| Forest | 1 | 1 |
| Domain | 1 | 3 |
| DNS | 1 | 2 |
| DHCP | 1 | 2 |
| CA | 2 | 3 |
| DNS | 0 | 2 |
| CA | 0 | 3 |

### Healthcheck

Expand Down Expand Up @@ -224,5 +218,5 @@ PS C:\> New-AsBuiltReport -Report Microsoft.AD -Target 'admin-dc-01v.contoso.loc

- Issues with WinRM when using the IP address instead of the "Fully Qualified Domain Name".
- This project relies heavily on the remote connection function through WinRM. For this reason the use of a Windows 10 client is specifically used as a jumpbox.
- The report provides the ability to extract the configuration of the DHCP/DNS services. In order to obtain this information it is required that the servers running these services have powershell modules installed for each service (RSAT-DHCP, RSAT-DNS-Server, RSAT-AD-PowerShell).
- The report provides the ability to extract the configuration of the DHCP/DNS services. In order to obtain this information it is required that the servers running these services have powershell modules installed for each service (RSAT-DNS-Server & RSAT-AD-PowerShell).
- This report assumes that the DNS Server service is running on the same server where Domain Controller is running (Cohost).
3,478 changes: 2,210 additions & 1,268 deletions Samples/Sample Microsoft AD As Built Report.html

Large diffs are not rendered by default.

Binary file modified Samples/Sample Microsoft AD As Built Report.pdf
Binary file not shown.
4 changes: 2 additions & 2 deletions Src/Private/Get-AbrADDFSHealth.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -96,9 +96,9 @@ function Get-AbrADDFSHealth {
Paragraph "The following section details domain $($Domain.ToString().ToUpper()) sysvol health status."
BlankLine
$OutObj = @()
Write-PscriboMessage "Collecting Sysvol information from $($Domain)."
foreach ($Extension in $SYSVOLFolder) {
try {
Write-PscriboMessage "Collecting Sysvol information from $($Domain)."
$inObj = [ordered] @{
'Extension' = $Extension.Extension
'File Count' = $Extension.Count
Expand Down Expand Up @@ -151,9 +151,9 @@ function Get-AbrADDFSHealth {
Paragraph "The following section details domain $($Domain.ToString().ToUpper()) netlogon health status."
BlankLine
$OutObj = @()
Write-PscriboMessage "Collecting Netlogon information from $($Domain)."
foreach ($Extension in $NetlogonFolder) {
try {
Write-PscriboMessage "Collecting Netlogon information from $($Domain)."
$inObj = [ordered] @{
'Extension' = $Extension.Extension
'File Count' = $Extension.Count
Expand Down
171 changes: 0 additions & 171 deletions Src/Private/Get-AbrADDHCPInfrastructure.ps1

This file was deleted.

Loading

0 comments on commit 5258beb

Please sign in to comment.