Aruba ClearPass As Built Report is a PowerShell module which works in conjunction with AsBuiltReport.Core.
AsBuiltReport is an open-sourced community project which utilises PowerShell to produce as-built documentation in multiple document formats for multiple vendors and technologies.
Please refer to the AsBuiltReport website for more detailed information about this project.
Sample Aruba ClearPass As Built report HTML file: Sample Aruba ClearPass As-Built Report.html
Sample Aruba ClearPass As Built report Word file: Sample Aruba ClearPass As-Built Report.docx
Below are the instructions on how to install, configure and generate a Aruba ClearPass As Built report.
The Aruba ClearPass As Built Report supports the following ClearPass versions 6.10.x, 6.11.x, 6.12.x
This report is compatible with the following PowerShell versions;
| Windows PowerShell 5.1 | PowerShell 7 |
|---|---|
| ✅ | ✅ |
PowerShell 5.1 or PowerShell 7, and the following PowerShell modules are required for generating a Aruba ClearPass As Built Report.
You need to have an API Token (can be Read Only)
Go on WebGUI of your ClearPass, on Guest Modules generate a API Client but you don't need to store the Client Secret
On API Clients List, select the your client
Click on Generate Access Token
And kept the token (for example : 70680f1d19f86110800d5d5cb4414fbde7be12ae)
Install-Module PowerArubaCP
Install-Module AsBuiltReport.Aruba.ClearPassIf you are unable to use the PowerShell Gallery, you can still install the module manually. Ensure you repeat the following steps for the system requirements also.
- Download the code package / latest release zip from GitHub
- Extract the zip file
- Copy the folder
AsBuiltReport.Aruba.ClearPassto a path that is set in$env:PSModulePath. - Open a PowerShell terminal window and unblock the downloaded files with
$path = (Get-Module -Name AsBuiltReport.Aruba.ClearPass -ListAvailable).ModuleBase; Unblock-File -Path $path\*.psd1; Unblock-File -Path $path\Src\Public\*.ps1; Unblock-File -Path $path\Src\Private\*.ps1
- Close and reopen the PowerShell terminal window.
Note: You are not limited to installing the module to those example paths, you can add a new entry to the environment variable PSModulePath if you want to use another path.
The Aruba ClearPass As Built Report utilises a JSON file to allow configuration of report information, options, detail and healthchecks.
A Aruba ClearPass report configuration file can be generated by executing the following command;
New-AsBuiltReportConfig -Report Aruba.ClearPass -FolderPath <User specified folder> -Filename <Optional>Executing this command will copy the default Aruba ClearPass report JSON configuration to a user specified folder.
All report settings can then be configured via the JSON file.
The following provides information of how to configure each schema within the report's JSON file.
The Report schema provides configuration of the Aruba ClearPass report information.
| Sub-Schema | Setting | Default | Description |
|---|---|---|---|
| Name | User defined | Aruba ClearPass 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 |
The Options schema allows certain options within the report to be toggled on or off.
| Sub-Schema | Setting | Default | Description |
|---|---|---|---|
| HideLicenseKey | Licence Key | false | Hide License key value on report |
| HidePassword | Hide Password | false | Hide Password on Authentication chapiter (bind...) |
The InfoLevel schema allows configuration of each section of the report at a granular level. The following sections can be set.
There are 3 levels (0-2) of detail granularity for each section as follows;
| Setting | InfoLevel | Description |
|---|---|---|
| 0 | Disabled | Does not collect or display any information |
| 1 | Enabled / Summary | Provides summarised information for a collection of objects |
| 2 | Adv Summary | Provides condensed, detailed information for a collection of objects |
The table below outlines the default and maximum InfoLevel settings for each ClearPass section.
| Sub-Schema | Default Settings | Maximum Settings |
|---|---|---|
| System | 1 | 1 |
| Licence | 2 | 2 |
| Authentication | 2 | 2 |
| Certificate | 1 | 1 |
| Service | 2 | 2 |
| NetworkDevice | 1 | 1 |
The Healthcheck schema is used to toggle health checks on or off.
Health checks are yet to be developed.
There are a few examples listed below on running the AsBuiltReport script against a ClearPass. Refer to the README.md file in the main AsBuiltReport project repository for more examples.
# Generate a Aruba ClearPass As Built Report for ClearPass clearpass.arubademo.net using specified token. Export report to HTML & DOCX formats. Use default report style. Append timestamp to report filename. Save reports to 'C:\Users\PowerArubaCP\Documents'
PS C:\> New-AsBuiltReport -Report Aruba.ClearPass -Target clearpass.arubademo.net -token XXXXXXX -Format Html,Word -OutputFolderPath 'C:\Users\PowerArubaCP\Documents' -Timestamp
# Generate a Aruba ClearPass As Built Report for ClearPass clearpass.arubademo.net using specified token and report configuration file. Export report to Text, HTML & DOCX formats. Use default report style. Save reports to 'C:\Users\PowerArubaCP\Documents'. Display verbose messages to the console.
PS C:\> New-AsBuiltReport -Report Aruba.ClearPass -Target clearpass.arubademo.net -token XXXXXXX -Format Text,Html,Word -OutputFolderPath 'C:\Users\PowerArubaCP\Documents' -ReportConfigFilePath 'C:\Users\Jon\AsBuiltReport\AsBuiltReport.Aruba.ClearPass.json' -Verbose
# Generate a Aruba ClearPass As Built Report for ClearPass clearpass.arubademo.net using specified token. Export report to HTML & Text formats. Use default report style. Highlight environment issues within the report. Save reports to 'C:\Users\PowerArubaCP\Documents'.
PS C:\> $Creds = Get-Credential
PS C:\> New-AsBuiltReport -Report Aruba.ClearPass -Target clearpass.arubademo.net -token XXXXXXX -Format Html,Text -OutputFolderPath 'C:\Users\PowerArubaCP\Documents' -EnableHealthCheck
# Generate a Aruba ClearPass As Built Report for ClearPass clearpass.arubademo.net using specified token. Export report to HTML & DOCX formats. Use default report style. Reports are saved to the user profile folder by default. Attach and send reports via e-mail.
PS C:\> New-AsBuiltReport -Report Aruba.ClearPass -Target clearpass.arubademo.net -token XXXXXXX -Format Html,Word -OutputFolderPath 'C:\Users\PowerArubaCP\Documents' -SendEmail