Skip to content

Commit

Permalink
Code Cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
@rebelinux
rebelinux committed Feb 1, 2024
1 parent f151936 commit 7da8765
Show file tree
Hide file tree
Showing 43 changed files with 1,603 additions and 1,792 deletions.
180 changes: 90 additions & 90 deletions AsBuiltReport.Microsoft.AD.psd1
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,133 +8,133 @@

@{

# Script module or binary module file associated with this manifest.
RootModule = 'AsBuiltReport.Microsoft.AD.psm1'
# Script module or binary module file associated with this manifest.
RootModule = 'AsBuiltReport.Microsoft.AD.psm1'

# Version number of this module.
ModuleVersion = '0.8.1'
# Version number of this module.
ModuleVersion = '0.8.1'

# Supported PSEditions
# CompatiblePSEditions = @()
# Supported PSEditions
# CompatiblePSEditions = @()

# ID used to uniquely identify this module
GUID = '0a3e1c04-13b8-418f-89bc-a5a18da07394'
# ID used to uniquely identify this module
GUID = '0a3e1c04-13b8-418f-89bc-a5a18da07394'

# Author of this module
Author = 'Jonathan Colon'
# Author of this module
Author = 'Jonathan Colon'

# Company or vendor of this module
# CompanyName = 'Unknown'
# Company or vendor of this module
# CompanyName = 'Unknown'

# Copyright statement for this module
Copyright = '(c) 2024 Jonathan Colon. All rights reserved.'
# Copyright statement for this module
Copyright = '(c) 2024 Jonathan Colon. All rights reserved.'

# Description of the functionality provided by this module
Description = 'A PowerShell module to generate an as built report on the configuration of Microsoft AD.'
# Description of the functionality provided by this module
Description = 'A PowerShell module to generate an as built report on the configuration of Microsoft AD.'

# Minimum version of the Windows PowerShell engine required by this module
# PowerShellVersion = '5.1'
# Minimum version of the Windows PowerShell engine required by this module
# PowerShellVersion = '5.1'

# Name of the Windows PowerShell host required by this module
# PowerShellHostName = ''
# Name of the Windows PowerShell host required by this module
# PowerShellHostName = ''

# Minimum version of the Windows PowerShell host required by this module
# PowerShellHostVersion = ''
# Minimum version of the Windows PowerShell host required by this module
# PowerShellHostVersion = ''

# Minimum version of Microsoft .NET Framework required by this module. This prerequisite is valid for the PowerShell Desktop edition only.
# DotNetFrameworkVersion = ''
# Minimum version of Microsoft .NET Framework required by this module. This prerequisite is valid for the PowerShell Desktop edition only.
# DotNetFrameworkVersion = ''

# Minimum version of the common language runtime (CLR) required by this module. This prerequisite is valid for the PowerShell Desktop edition only.
# CLRVersion = ''
# Minimum version of the common language runtime (CLR) required by this module. This prerequisite is valid for the PowerShell Desktop edition only.
# CLRVersion = ''

# Processor architecture (None, X86, Amd64) required by this module
# ProcessorArchitecture = ''
# Processor architecture (None, X86, Amd64) required by this module
# ProcessorArchitecture = ''

# Modules that must be imported into the global environment prior to importing this module
RequiredModules = @(
@{
ModuleName = 'AsBuiltReport.Core';
ModuleVersion = '1.3.0'
},
@{
ModuleName = 'PSPKI';
ModuleVersion = '3.7.2'
},
@{
ModuleName = 'PScriboCharts';
ModuleVersion = '0.9.0'
},
@{
ModuleName = 'Diagrammer.Microsoft.AD';
ModuleVersion = '0.1.5'
}
)
# Modules that must be imported into the global environment prior to importing this module
RequiredModules = @(
@{
ModuleName = 'AsBuiltReport.Core';
ModuleVersion = '1.3.0'
},
@{
ModuleName = 'PSPKI';
ModuleVersion = '3.7.2'
},
@{
ModuleName = 'PScriboCharts';
ModuleVersion = '0.9.0'
},
@{
ModuleName = 'Diagrammer.Microsoft.AD';
ModuleVersion = '0.1.5'
}
)

# Assemblies that must be loaded prior to importing this module
# RequiredAssemblies = @()
# Assemblies that must be loaded prior to importing this module
# RequiredAssemblies = @()

# Script files (.ps1) that are run in the caller's environment prior to importing this module.
# ScriptsToProcess = @()
# Script files (.ps1) that are run in the caller's environment prior to importing this module.
# ScriptsToProcess = @()

# Type files (.ps1xml) to be loaded when importing this module
# TypesToProcess = @()
# Type files (.ps1xml) to be loaded when importing this module
# TypesToProcess = @()

# Format files (.ps1xml) to be loaded when importing this module
# FormatsToProcess = @()
# Format files (.ps1xml) to be loaded when importing this module
# FormatsToProcess = @()

# Modules to import as nested modules of the module specified in RootModule/ModuleToProcess
# NestedModules = @()
# Modules to import as nested modules of the module specified in RootModule/ModuleToProcess
# NestedModules = @()

# Functions to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no functions to export.
FunctionsToExport = @('Invoke-AsBuiltReport.Microsoft.AD')
# Functions to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no functions to export.
FunctionsToExport = @('Invoke-AsBuiltReport.Microsoft.AD')

# Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export.
# CmdletsToExport = '*'
# Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export.
# CmdletsToExport = '*'

# Variables to export from this module
# VariablesToExport = '*'
# Variables to export from this module
# VariablesToExport = '*'

# Aliases to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no aliases to export.
# AliasesToExport = '*'
# Aliases to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no aliases to export.
# AliasesToExport = '*'

# DSC resources to export from this module
# DscResourcesToExport = @()
# DSC resources to export from this module
# DscResourcesToExport = @()

# List of all modules packaged with this module
# ModuleList = @()
# List of all modules packaged with this module
# ModuleList = @()

# List of all files packaged with this module
# FileList = @()
# List of all files packaged with this module
# FileList = @()

# Private data to pass to the module specified in RootModule/ModuleToProcess. This may also contain a PSData hashtable with additional module metadata used by PowerShell.
PrivateData = @{
# Private data to pass to the module specified in RootModule/ModuleToProcess. This may also contain a PSData hashtable with additional module metadata used by PowerShell.
PrivateData = @{

PSData = @{
PSData = @{

# Tags applied to this module. These help with module discovery in online galleries.
Tags = 'AsBuiltReport', 'Report', 'Microsoft', 'AD', 'Active-Directory', 'Documentation', 'PScribo', 'PSEdition_Desktop', 'PSEdition_Core', 'Windows'
# Tags applied to this module. These help with module discovery in online galleries.
Tags = 'AsBuiltReport', 'Report', 'Microsoft', 'AD', 'Active-Directory', 'Documentation', 'PScribo', 'PSEdition_Desktop', 'PSEdition_Core', 'Windows'

# A URL to the license for this module.
LicenseUri = 'https://raw.githubusercontent.com/AsBuiltReport/AsBuiltReport.Microsoft.AD/master/LICENSE'
# A URL to the license for this module.
LicenseUri = 'https://raw.githubusercontent.com/AsBuiltReport/AsBuiltReport.Microsoft.AD/master/LICENSE'

# A URL to the main website for this project.
ProjectUri = 'https://github.com/AsBuiltReport/AsBuiltReport.Microsoft.AD'
# A URL to the main website for this project.
ProjectUri = 'https://github.com/AsBuiltReport/AsBuiltReport.Microsoft.AD'

# A URL to an icon representing this module.
IconUri = 'https://github.com/AsBuiltReport.png'
# A URL to an icon representing this module.
IconUri = 'https://github.com/AsBuiltReport.png'

# ReleaseNotes of this module
ReleaseNotes = 'https://raw.githubusercontent.com/AsBuiltReport/AsBuiltReport.Microsoft.AD/master/CHANGELOG.md'
# ReleaseNotes of this module
ReleaseNotes = 'https://raw.githubusercontent.com/AsBuiltReport/AsBuiltReport.Microsoft.AD/master/CHANGELOG.md'

} # End of PSData hashtable
} # End of PSData hashtable

} # End of PrivateData hashtable
} # End of PrivateData hashtable

# HelpInfo URI of this module
# HelpInfoURI = ''
# HelpInfo URI of this module
# HelpInfoURI = ''

# Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix.
# DefaultCommandPrefix = ''
# Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix.
# DefaultCommandPrefix = ''

}

Expand Down
3 changes: 2 additions & 1 deletion CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,12 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [0.8.1] - 2024-01-25
## [0.8.1] - 2024-01-31

### Changed

- Removed Graphviz install check code.
- Code cleanup

### Fixed

Expand Down
2 changes: 1 addition & 1 deletion LICENSE
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2021 AsBuiltReport
Copyright (c) 2024 AsBuiltReport

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
64 changes: 32 additions & 32 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -59,9 +59,9 @@ The Microsoft AD As Built Report supports the following Active Directory version
This report is compatible with the following PowerShell versions;

<!-- ********** Update supported PowerShell versions ********** -->
| Windows PowerShell 5.1 | PowerShell 7 |
|:----------------------:|:--------------------:|
| :white_check_mark: | :x: |
| Windows PowerShell 5.1 | PowerShell 7 |
| :--------------------: | :----------: |
| :white_check_mark: | :x: |

## :wrench: System Requirements
<!-- ********** Update system requirements ********** -->
Expand Down Expand Up @@ -151,29 +151,29 @@ The following provides information of how to configure each schema within the re

The **Report** schema provides configuration of the Microsoft AD report information.

| Sub-Schema | Setting | Default | Description |
|---------------------|--------------|--------------------------------|--------------------------------------------------------------|
| Sub-Schema | Setting | Default | Description |
| ------------------- | ------------ | ---------------------------- | ------------------------------------------------------------ |
| Name | User defined | Microsoft AD As Built Report | The name of the As Built Report |
| Version | User defined | 1.0 | The report version |
| Status | User defined | Released | The report release status |
| ShowCoverPageImage | true / false | true | Toggle to enable/disable the display of the cover page image |
| ShowTableOfContents | true / false | true | Toggle to enable/disable table of contents |
| ShowHeaderFooter | true / false | true | Toggle to enable/disable document headers & footers |
| ShowTableCaptions | true / false | true | Toggle to enable/disable table captions/numbering |
| Version | User defined | 1.0 | The report version |
| Status | User defined | Released | The report release status |
| ShowCoverPageImage | true / false | true | Toggle to enable/disable the display of the cover page image |
| ShowTableOfContents | true / false | true | Toggle to enable/disable table of contents |
| ShowHeaderFooter | true / false | true | Toggle to enable/disable document headers & footers |
| ShowTableCaptions | true / false | true | Toggle to enable/disable table captions/numbering |

### Options

The **Options** schema allows certain options within the report to be toggled on or off.

| Sub-Schema | Setting | Default | Description |
|-----------------|--------------|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ShowDefinitionInfo | true/false | false | Toggle to enable/disable Microsoft AD term explanations
| PSDefaultAuthentication | Negotiate/Kerberos | Negotiate | Allow to set the value of the PSRemoting authentication method. For Workgroup authentication Negotiate value is required. |
| Exclude.Domains | Array List | Empty | Allow to filter on AD Domain FQDN |
| Exclude.DCs | Array List | Empty | Allow to filter on AD Domain Controller Server FQDN. |
| Include.Domains | Array List | Empty | Allow only a list of Active Directory Domain Controller FQDN to document. |
| Include.DCs | Array List | Empty | Allow only a list of Active Directory Domain FQDN to document. |
| EnableDiagrams | true / false | true | Toggle to enable/disable of Infrastructure Diagrams|
| Sub-Schema | Setting | Default | Description |
| ----------------------- | ------------------ | --------- | ------------------------------------------------------------------------------------------------------------------------- |
| ShowDefinitionInfo | true/false | false | Toggle to enable/disable Microsoft AD term explanations |
| PSDefaultAuthentication | Negotiate/Kerberos | Negotiate | Allow to set the value of the PSRemoting authentication method. For Workgroup authentication Negotiate value is required. |
| Exclude.Domains | Array List | Empty | Allow to filter on AD Domain FQDN |
| Exclude.DCs | Array List | Empty | Allow to filter on AD Domain Controller Server FQDN. |
| Include.Domains | Array List | Empty | Allow only a list of Active Directory Domain Controller FQDN to document. |
| Include.DCs | Array List | Empty | Allow only a list of Active Directory Domain FQDN to document. |
| EnableDiagrams | true / false | true | Toggle to enable/disable of Infrastructure Diagrams |


### InfoLevel
Expand All @@ -182,21 +182,21 @@ The **InfoLevel** schema allows configuration of each section of the report at a

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 |
| 2 | Adv Summary | Provides condensed, detailed information for a collection of objects |
| 3 | Detailed | Provides detailed information for individual objects |
| Setting | InfoLevel | Description |
| :-----: | ----------- | -------------------------------------------------------------------- |
| 0 | Disabled | Does not collect or display any information |
| 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 |

The table below outlines the default and maximum **InfoLevel** settings for each section.

| Sub-Schema | Default Setting | Maximum Setting |
|--------------|:---------------:|:---------------:|
| Forest | 1 | 1 |
| Domain | 1 | 3 |
| DNS | 0 | 2 |
| CA | 0 | 3 |
| Sub-Schema | Default Setting | Maximum Setting |
| ---------- | :-------------: | :-------------: |
| Forest | 1 | 1 |
| Domain | 1 | 3 |
| DNS | 0 | 2 |
| CA | 0 | 3 |

### Healthcheck

Expand Down
Loading

0 comments on commit 7da8765

Please sign in to comment.