asbuiltreport / asbuiltreport.kaminario.k2

Kaminario K2 Storage AsBuiltReport

Kaminario K2 AsBuiltReport is a module of the parent "AsBuiltReport" project. AsBuiltReport is a PowerShell module which generates As-Built documentation for many common datacentre infrastructure systems. Reports can be generated in Text, XML, HTML and MS Word formats and can be presented with custom styling to align with your company/customer's brand.

For detailed documentation around the whole project, please refer to the README.md file in the parent AsBuiltReport repository (linked to above). This README is specific only to the Kaminario K2 repository.

Sample Reports

Getting Started

Below are the instructions on how to install, configure and generate a Kaminario K2 Array As Built Report

Pre-requisites

The following PowerShell modules are required for generating a Kaminario K2 Array As Built report.

Each of these modules can be easily downloaded and installed via the PowerShell Gallery

• Kaminario K2 Powershell
• AsBuiltReport Module

Module Installation

Open a Windows PowerShell terminal window and install each of the required modules as follows;

Install-Module -Name K2.Powershell
Install-Module AsBuiltReport

Required Privileges

To generate a Kaminario K2 report, a user account with the readonly role or higher on the Array(s) is required.

Configuration

The Kaminario K2 Array As Built Report utilises a JSON file to allow configuration of report information, options, detail and healthchecks.

A Kaminario K2 Array report configuration file can be generated by executing the following command;

New-AsBuiltReportConfig -Report Kaminario.K2 -Path <User specified folder> -Name <Optional> -Credential (Get-Credential)

Examples

There is one example listed below on running the AsBuiltReport script against a Kaminario K2 target. Refer to the README.md file in the main AsBuiltReport project repository for more examples.

• The following creates a Kaminario K2 As-Built report in HTML & Word formats in the folder C:\scripts.

PS C:\>New-AsBuiltReport -Report Kaminario.K2 -Target 192.168.1.100 -Credential (Get-Credential) -Format HTML,Word -OutputPath C:\scripts\

Known Issues