Skip to content

Commit 6f5f865

Browse files
committed
Update README & CHANGELOG
Minor amendments to `README.md` & `CHANGELOG.md`
1 parent 05f8521 commit 6f5f865

File tree

2 files changed

+19
-11
lines changed

2 files changed

+19
-11
lines changed

CHANGELOG.md

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,22 +6,20 @@
66
- VMHost network adapter LLDP reporting
77

88
## [[1.3.0](https://github.com/AsBuiltReport/AsBuiltReport.VMware.vSphere/releases/tag/v1.3.0)] - 2021-08-29
9-
### Fixed
10-
- Incorrect section reporting with certain InfoLevels
11-
- Datastore table now sorts by Datastore Name
12-
- vSAN advanced detailed reporting
13-
- VMkernel Adpater reporting
14-
- Distributed vSwitch advanced detailed reporting
15-
- Display issues with highlights in [README.md](https://github.com/AsBuiltReport/AsBuiltReport.VMware.vSphere/blob/master/README.md)
16-
179
### Added
1810
- PowerShell 7 compatibility
1911
- PSScriptAnalyzer & PublishPSModule GitHub Action workflows
2012
- Advanced detailed reporting for VI roles
2113
- Advanced detailed reporting for vSAN disks
2214
- Support for VMware Cloud environments (VCF, VMC, AVS, GVE) ([Fix #87](https://github.com/AsBuiltReport/AsBuiltReport.VMware.vSphere/issues/87))
23-
- Include release and issue links in [README.md](https://github.com/AsBuiltReport/AsBuiltReport.VMware.vSphere/blob/master/README.md)
24-
15+
- NSX TCP/IP stacks for VMkernel Adpater reporting
16+
- Include release and issue links in `CHANGELOG.md`
17+
### Fixed
18+
- Incorrect section reporting with certain InfoLevels
19+
- Datastore table now sorts by Datastore Name
20+
- vSAN advanced detailed reporting
21+
- Distributed vSwitch advanced detailed reporting
22+
- Display issues with highlights in `README.md`
2523

2624
## [[1.2.1](https://github.com/AsBuiltReport/AsBuiltReport.VMware.vSphere/releases/tag/v1.2.1)] - 2020-09-29
2725
### Fixed

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,16 @@
2525

2626
# VMware vSphere As Built Report
2727

28+
VMware vSphere As Built Report is a PowerShell module which works in conjunction with [AsBuiltReport.Core](https://github.com/AsBuiltReport/AsBuiltReport.Core).
29+
30+
[AsBuiltReport](https://github.com/AsBuiltReport/AsBuiltReport) is an open-sourced community project which utilises PowerShell to produce as-built documentation in multiple document formats for multiple vendors and technologies.
31+
32+
The VMware vSphere As Built Report module is used to generate as built documentation for VMware vSphere / vCenter Server environments.
33+
34+
Please refer to the [VMware ESXi AsBuiltReport](https://github.com/AsBuiltReport/AsBuiltReport.VMware.ESXi) for reporting of standalone VMware ESXi servers.
35+
36+
Please refer to the AsBuiltReport [website](https://www.asbuiltreport.com) for more detailed information about this project.
37+
2838
## :books: Sample Reports
2939
### Sample Report 1 - Default Style
3040
Sample vSphere As Built report with health checks, using default report style.
@@ -264,7 +274,7 @@ The **VM** schema is used to configure health checks for virtual machines.
264274
PS C:\> New-AsBuiltReport -Report VMware.vSphere -Target 'vcenter-01.corp.local' -Username '[email protected]' -Password 'VMware1!' -Format Html,Word -OutputFolderPath 'C:\Users\Tim\Documents' -Timestamp
265275
266276
# Generate a vSphere As Built Report for vCenter Server 'vcenter-01.corp.local' using specified credentials and report configuration file. Export report to Text, HTML & DOCX formats. Use default report style. Save reports to 'C:\Users\Tim\Documents'. Display verbose messages to the console.
267-
PS C:\> New-AsBuiltReport -Report VMware.vSphere -Target 'vcenter-01.corp.local' -Username '[email protected]' -Password 'VMware1!' -Format Text,Html,Word -OutputFolderPath 'C:\Users\Tim\Documents' -Verbose
277+
PS C:\> New-AsBuiltReport -Report VMware.vSphere -Target 'vcenter-01.corp.local' -Username '[email protected]' -Password 'VMware1!' -Format Text,Html,Word -OutputFolderPath 'C:\Users\Tim\Documents' -ReportConfigFilePath 'C:\Users\Tim\AsBuiltReport\AsBuiltReport.VMware.vSphere.json' -Verbose
268278
269279
# Generate a vSphere As Built Report for vCenter Server 'vcenter-01.corp.local' using stored credentials. Export report to HTML & Text formats. Use default report style. Highlight environment issues within the report. Save reports to 'C:\Users\Tim\Documents'.
270280
PS C:\> $Creds = Get-Credential

0 commit comments

Comments
 (0)