Skip to content

Commit 3afc463

Browse files
tpcarmantpcarman
committed
Update help
1 parent 9182b7b commit 3afc463

File tree

1 file changed

+55
-15
lines changed

1 file changed

+55
-15
lines changed

‎Src/Public/New-AsBuiltReport.ps1‎

Lines changed: 55 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -54,38 +54,78 @@ function New-AsBuiltReport {
5454
If this parameter is not specified, a default report configuration JSON is copied to the specifed user folder.
5555
If this parameter is specified and the path to a JSON file is invalid, the script will terminate.
5656
.EXAMPLE
57-
New-AsBuiltReport -Report VMware.vSphere -Target 192.168.1.100 -Username admin -Password admin -Format HTML,Word -EnableHealthCheck -OutputFolderPath 'c:\scripts\'
57+
New-AsBuiltReport -Report VMware.vSphere -Target 192.168.1.100 -Username admin -Password admin -Format HTML,Word -EnableHealthCheck -OutputFolderPath 'C:\Reports'
5858
5959
Creates a VMware vSphere As Built Report in HTML & Word formats. The document will highlight particular issues which exist within the environment.
60-
The report will be saved to c:\scripts.
60+
The report will be saved to C:\Reports.
6161
.EXAMPLE
6262
$Creds = Get-Credential
63-
New-AsBuiltReport -Report PureStorage.FlashArray -Target 192.168.1.100 -Credential $Creds -Format Text -Timestamp -OutputFolderPath 'c:\scripts\'
63+
New-AsBuiltReport -Report PureStorage.FlashArray -Target 192.168.1.100 -Credential $Creds -Format Text -Timestamp -OutputFolderPath 'C:\Reports'
6464
6565
Creates a Pure Storage FlashArray As Built Report in Text format and appends a timestamp to the filename.
6666
Stored credentials are used to connect to the system.
67-
The report will be saved to c:\scripts.
67+
The report will be saved to C:\Reports.
6868
.EXAMPLE
69-
New-AsBuiltReport -Report Rubrik.CDM -Target 192.168.1.100 -Token '123456789abcdefg' -Format HTML -OutputFolderPath 'c:\scripts\'
69+
New-AsBuiltReport -Report Veeam.VBR -Target veeam01.corp.local -Username admin -Password admin -Format HTML -Filename 'Veeam-Backup-Report' -OutputFolderPath 'C:\Reports'
70+
71+
Creates a Veeam Backup & Replication As Built Report in HTML format with a custom filename.
72+
The report will be saved as 'Veeam-Backup-Report.html' in C:\Reports.
73+
.EXAMPLE
74+
New-AsBuiltReport -Report Rubrik.CDM -Target 192.168.1.100 -Token 'eyJ0eXAiOiJKV1QiLCJhbGc...' -Format HTML -OutputFolderPath 'C:\Reports'
7075
7176
Creates a Rubrik CDM As Built Report in HTML format.
7277
An API token is used to connect to the system.
73-
The report will be saved to c:\scripts.
78+
The report will be saved to C:\Reports.
79+
.EXAMPLE
80+
New-AsBuiltReport -Report Microsoft.Azure -Target 'tenant.onmicrosoft.com' -UseInteractiveAuth -Format Word -OutputFolderPath 'C:\Reports'
81+
82+
Creates a Microsoft Azure As Built Report in Word format.
83+
Interactive authentication (via web browser) is used to authenticate to Azure.
84+
The report will be saved to C:\Reports.
85+
.EXAMPLE
86+
New-AsBuiltReport -Report NetApp.ONTAP -Target ontap.corp.local -Username admin -Password admin -Format HTML -Orientation Landscape -OutputFolderPath 'C:\Reports'
87+
88+
Creates a NetApp ONTAP As Built Report in HTML format with Landscape page orientation.
89+
The report will be saved to C:\Reports.
90+
.EXAMPLE
91+
New-AsBuiltReport -Report VMware.vSphere -Target vcenter.corp.local -Username admin -Password admin -Format Word -StyleFilePath 'C:\Styles\Corporate-Style.ps1' -OutputFolderPath 'C:\Reports'
92+
93+
Creates a VMware vSphere As Built Report in Word format using a custom corporate style.
94+
The report will be saved to C:\Reports.
95+
.EXAMPLE
96+
New-AsBuiltReport -Report Nutanix.PrismElement -Target 192.168.1.100 -Username admin -Password admin -Format Word -SendEmail -OutputFolderPath 'C:\Reports'
97+
98+
Creates a Nutanix Prism Element As Built Report in Word format. Report will be attached and sent via email.
99+
Email settings must be configured using New-AsBuiltConfig or -AsBuiltConfigFilePath parameter.
100+
The report will be saved to C:\Reports.
101+
.EXAMPLE
102+
New-AsBuiltReport -Report VMware.vSphere -Target vcenter01.corp.local,vcenter02.corp.local -Username admin -Password admin -Format HTML -OutputFolderPath 'C:\Reports'
103+
104+
Creates VMware vSphere As Built Reports in HTML format for multiple vCenter servers.
105+
Separate reports will be generated for each target.
106+
The reports will be saved to C:\Reports.
107+
.EXAMPLE
108+
New-AsBuiltReport -Report Microsoft.AD -Target dc01.corp.local -Username 'CORP\admin' -Password admin -Format HTML -ReportLanguage 'es-ES' -OutputFolderPath 'C:\Reports'
109+
110+
Creates a Microsoft Active Directory As Built Report in HTML format with Spanish language content.
111+
The report will be saved to C:\Reports.
74112
.EXAMPLE
75-
New-AsBuiltReport -Report Cisco.UCSManager -Target '192.168.1.100' -Username admin -Password admin -StyleFilePath '/Users/Tim/AsBuiltReport/Styles/ACME.ps1' -OutputFolderPath '/Users/Tim/scripts'
113+
New-AsBuiltReport -Report DellEMC.VxRail -Target vxrail-mgr.corp.local -Username admin -Password admin -Format Word -AsBuiltConfigFilePath 'C:\Config\asbuiltreport.json' -OutputFolderPath 'C:\Reports'
76114
77-
Creates a Cisco UCS Manager As Built Report in default format (Word), using a custom style.
78-
The report will be saved to '/Users/Tim/scripts'.
115+
Creates a Dell EMC VxRail As Built Report in Word format, using the configuration in the asbuiltreport.json file.
116+
The report will be saved to C:\Reports.
79117
.EXAMPLE
80-
New-AsBuiltReport -Report Nutanix.PrismElement -Target 192.168.1.100 -Username admin -Password admin -SendEmail -OutputFolderPath c:\scripts\
118+
New-AsBuiltReport -Report VMware.Horizon -Target horizon-cs.corp.local -Username admin -Password admin -Format HTML -ReportConfigFilePath 'C:\Config\VMware.Horizon.json' -OutputFolderPath 'C:\Reports'
81119
82-
Creates a Nutanix Prism Element As Built Report in default format (Word). Report will be attached and sent via email.
83-
The report will be saved to c:\scripts.
120+
Creates a VMware Horizon As Built Report in HTML format, using a custom report configuration file.
121+
The custom configuration allows you to control report depth and detail levels.
122+
The report will be saved to C:\Reports.
84123
.EXAMPLE
85-
New-AsBuiltReport -Report VMware.vSphere -Target 192.168.1.100 -Username admin -Password admin -Format HTML-AsBuiltConfigFilePath C:\scripts\asbuiltreport.json -OutputFolderPath c:\scripts\
124+
New-AsBuiltReport -Report Aruba.ClearPass -Target aruba.corp.local -Username admin -Password admin -Format HTML,Word,Text -Timestamp -EnableHealthCheck -OutputFolderPath 'C:\Reports'
86125
87-
Creates a VMware vSphere As Built Report in HTML format, using the configuration in the asbuiltreport.json file located in the C:\scripts\ folder.
88-
The report will be saved to c:\scripts.
126+
Creates an Aruba ClearPass As Built Report in HTML, Word, and Text formats with timestamp appended to the filename.
127+
Health checks are enabled to highlight any configuration issues.
128+
The reports will be saved to C:\Reports.
89129
.LINK
90130
https://github.com/AsBuiltReport/AsBuiltReport.Core
91131
.LINK

0 commit comments

Comments
 (0)