Skip to content

Commit 5eb0c5f

Browse files
tpcarmantpcarman
authored
Merge pull request #2 from AsBuiltReport/dev
v1.0.0 release
2 parents d359bcd + f905bfa commit 5eb0c5f

12 files changed

+2430
-1
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
5+
---
6+
7+
**Describe the bug**
8+
A clear and concise description of what the bug is.
9+
10+
**To Reproduce**
11+
Steps to reproduce the behavior:
12+
1. Go to '...'
13+
2. Click on '....'
14+
3. Scroll down to '....'
15+
4. See error
16+
17+
**Expected behavior**
18+
A clear and concise description of what you expected to happen.
19+
20+
**Screenshots**
21+
If applicable, add screenshots to help explain your problem.
22+
23+
**System (please provide the following information about the system from which you are trying to generate a report):**
24+
- OS: [e.g. Windows 10]
25+
- Windows PowerShell version [Provide output from the following command: `$PSVersionTable.PSVersion`]
26+
- 3rd party PowerShell module name and version [e.g. VMware PowerCLI 11.2]
27+
- AsBuiltReport Core module version [e.g. 1.0.0]
28+
- AsBuiltReport Report module name and version [e.g. AsBuiltReport.VMware.vSphere 1.0.0]
29+
30+
**Additional context**
31+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
5+
---
6+
7+
**Is your feature request related to a problem? Please describe.**
8+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
9+
10+
**Describe the solution you'd like**
11+
A clear and concise description of what you want to happen.
12+
13+
**Describe alternatives you've considered**
14+
A clear and concise description of any alternative solutions or features you've considered.
15+
16+
**Additional context**
17+
Add any other context or screenshots about the feature request here.

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
<!--- Provide a general summary of your changes in the Title above -->
2+
3+
## Description
4+
<!--- Describe your changes in detail -->
5+
6+
## Related Issue
7+
<!--- This project only accepts pull requests related to open issues -->
8+
<!--- If suggesting a new feature or change, please discuss it in an issue first -->
9+
<!--- If fixing a bug, there should be an issue describing it with steps to reproduce -->
10+
<!--- Please link to the issue here: -->
11+
12+
## Motivation and Context
13+
<!--- Why is this change required? What problem does it solve? -->
14+
15+
## How Has This Been Tested?
16+
<!--- Please describe in detail how you tested your changes. -->
17+
<!--- Include details of your testing environment, and the tests you ran to -->
18+
<!--- see how your change affects other areas of the code, etc. -->
19+
20+
## Screenshots (if appropriate):
21+
22+
## Types of changes
23+
<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
24+
- [ ] Bug fix (non-breaking change which fixes an issue)
25+
- [ ] New feature (non-breaking change which adds functionality)
26+
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
27+
28+
## Checklist:
29+
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
30+
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
31+
- [ ] My code follows the code style of this project.
32+
- [ ] My change requires a change to the documentation.
33+
- [ ] I have updated the documentation accordingly.
34+
- [ ] I have read the [**CONTRIBUTING**](/CONTRIBUTING.md) document.

‎.vscode/launch.json‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
{
2+
// Use IntelliSense to learn about possible attributes.
3+
// Hover to view descriptions of existing attributes.
4+
// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
5+
"version": "0.2.0",
6+
"configurations": [
7+
{
8+
"name": "PowerShell Attach Interactive Session Runspace",
9+
"type": "PowerShell",
10+
"request": "attach",
11+
"processId": "current"
12+
},
13+
{
14+
"name": "PowerShell Interactive Session",
15+
"type": "PowerShell",
16+
"request": "launch",
17+
"cwd": ""
18+
},
19+
{
20+
"name": "PowerShell: Launch Script",
21+
"type": "PowerShell",
22+
"request": "launch",
23+
"script": "enter path or command to execute e.g.: ${workspaceFolder}/src/foo.ps1 or Invoke-Pester",
24+
"cwd": "${workspaceFolder}"
25+
}
26+
]
27+
}

‎.vscode/settings.json‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
{
2+
"powershell.codeFormatting.preset": "Custom",
3+
"powershell.codeFormatting.whitespaceBeforeOpenBrace": true,
4+
"powershell.codeFormatting.whitespaceBeforeOpenParen": true,
5+
"powershell.codeFormatting.whitespaceAroundOperator": true,
6+
"powershell.codeFormatting.whitespaceAfterSeparator": true,
7+
"powershell.codeFormatting.ignoreOneLineBlock": true,
8+
"powershell.codeFormatting.newLineAfterCloseBrace": false,
9+
"powershell.codeFormatting.newLineAfterOpenBrace": true,
10+
"powershell.codeFormatting.openBraceOnSameLine": true,
11+
"powershell.codeFolding.enable": true,
12+
"powershell.codeFormatting.alignPropertyValuePairs": false,
13+
"powershell.bugReporting.project": "https://github.com/AsBuiltReport/AsBuiltReport.VMware.vSphere/",
14+
"editor.tabSize": 4,
15+
"editor.insertSpaces": true,
16+
"editor.detectIndentation": false,
17+
"editor.rulers": [
18+
115
19+
]
20+
}

‎AsBuiltReport.VMware.ESXi.Style.ps1‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
# VMware Default Document Style
2+
3+
# Configure document options
4+
DocumentOption -EnableSectionNumbering -PageSize A4 -DefaultFont 'Arial' -MarginLeftAndRight 71 -MarginTopAndBottom 71 -Orientation $Orientation
5+
6+
# Configure Heading and Font Styles
7+
Style -Name 'Title' -Size 24 -Color '485969' -Align Center
8+
Style -Name 'Title 2' -Size 18 -Color '006A91' -Align Center
9+
Style -Name 'Title 3' -Size 12 -Color '006A91' -Align Left
10+
Style -Name 'Heading 1' -Size 16 -Color '006A91'
11+
Style -Name 'Heading 2' -Size 14 -Color '006A91'
12+
Style -Name 'Heading 3' -Size 12 -Color '006A91'
13+
Style -Name 'Heading 4' -Size 11 -Color '006A91'
14+
Style -Name 'Heading 5' -Size 10 -Color '006A91'
15+
Style -Name 'Normal' -Size 10 -Color '565656' -Default
16+
Style -Name 'TOC' -Size 16 -Color '006A91'
17+
Style -Name 'TableDefaultHeading' -Size 10 -Color 'FAFAFA' -BackgroundColor '485969'
18+
Style -Name 'TableDefaultRow' -Size 10 -Color '565656'
19+
Style -Name 'Critical' -Size 10 -BackgroundColor 'F5DBD9'
20+
Style -Name 'Warning' -Size 10 -BackgroundColor 'FEF3B5'
21+
Style -Name 'Info' -Size 10 -BackgroundColor 'E1F1F6'
22+
Style -Name 'OK' -Size 10 -BackgroundColor 'DFF0D0'
23+
24+
# Configure Table Styles
25+
$TableDefaultProperties = @{
26+
Id = 'TableDefault'
27+
HeaderStyle = 'TableDefaultHeading'
28+
RowStyle = 'TableDefaultRow'
29+
BorderColor = '485969'
30+
Align = 'Left'
31+
BorderWidth = 0.25
32+
PaddingTop = 1
33+
PaddingBottom = 1.5
34+
PaddingLeft = 2
35+
PaddingRight = 2
36+
}
37+
38+
TableStyle @TableDefaultProperties -Default
39+
TableStyle -Id 'Borderless' -BorderWidth 0
40+
41+
# VMware Cover Page Layout
42+
# Set position of report titles and information based on page orientation
43+
if ($Orientation -eq 'Portrait') {
44+
BlankLine -Count 11
45+
$LineCount = 30
46+
} else {
47+
BlankLine -Count 7
48+
$LineCount = 20
49+
}
50+
51+
# Add Report Name
52+
Paragraph -Style Title $ReportConfig.Report.Name
53+
54+
if ($AsBuiltConfig.Company.FullName) {
55+
# Add Company Name if specified
56+
Paragraph -Style Title2 $AsBuiltConfig.Company.FullName
57+
BlankLine -Count $LineCount
58+
} else {
59+
BlankLine -Count ($LineCount + 1)
60+
}
61+
Table -Name 'Cover Page' -List -Style Borderless -Width 0 -Hashtable ([Ordered] @{
62+
'Author:' = $AsBuiltConfig.Report.Author
63+
'Date:' = (Get-Date).ToLongDateString()
64+
'Version:' = $ReportConfig.Report.Version
65+
})
66+
PageBreak
67+
68+
# Add Table of Contents
69+
TOC -Name 'Table of Contents'
70+
PageBreak

‎AsBuiltReport.VMware.ESXi.json‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
{
2+
"Report": {
3+
"Name": "VMware ESXi As Built Report",
4+
"Version": "1.0",
5+
"Status": "Released"
6+
},
7+
"Options": {
8+
"ShowLicenseKeys": false,
9+
"ShowVMSnapshots": true
10+
},
11+
"InfoLevel": {
12+
"_comment_": "0 = Disabled, 1 = Summary, 2 = Informative, 3 = Detailed, 4 = Adv Detailed, 5 = Comprehensive",
13+
"VMHost": 3,
14+
"Network": 3,
15+
"Datastore": 3,
16+
"VM": 3
17+
},
18+
"HealthCheck": {
19+
"VMHost": {
20+
"ConnectionState": true,
21+
"HyperThreading": true,
22+
"ScratchLocation": true,
23+
"IPv6": true,
24+
"UpTimeDays": true,
25+
"Licensing": true,
26+
"SSH": true,
27+
"ESXiShell": true,
28+
"NTP": true,
29+
"StorageAdapter": true,
30+
"NetworkAdapter": true,
31+
"LockdownMode": true
32+
},
33+
"Datastore": {
34+
"CapacityUtilization": true
35+
},
36+
"VM": {
37+
"PowerState": true,
38+
"ConnectionState": true,
39+
"CpuHotAdd": true,
40+
"CpuHotRemove": true,
41+
"MemoryHotAdd": true,
42+
"ChangeBlockTracking": true,
43+
"VMToolsStatus": true,
44+
"VMSnapshots": true
45+
}
46+
}
47+
}

‎AsBuiltReport.VMware.ESXi.psd1‎

10 KB
Binary file not shown.

‎AsBuiltReport.VMware.ESXi.psm1‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Get public function definition files and dot source them
2+
$Public = @(Get-ChildItem -Path $PSScriptRoot\Src\Public\*.ps1)
3+
4+
foreach ($Module in $Public) {
5+
try {
6+
. $Module.FullName
7+
} catch {
8+
Write-Error -Message "Failed to import function $($Module.FullName): $_"
9+
}
10+
}
11+
12+
Export-ModuleMember -Function $Public.BaseName

‎CHANGELOG.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# AsBuiltReport.VMware.ESXi Changelog
2+
3+
## [1.0.0] 2020-04-02
4+
### Added
5+
- Initial release of VMware ESXi As Built Report
6+
7+
### Fixed
8+
- Created new VMware ESXi As Built Report (Fix #1)

0 commit comments

Comments
 (0)