AsBuiltReport.VMware.ESXi
v1.1.3
ビルドレポートとしてのVMware ESXiは、asbuiltreport.coreと連携して動作するPowerShellモジュールです。
Asbuiltreportは、PowerShellを利用して、複数のベンダーとテクノロジー向けの複数のドキュメント形式で構築されたドキュメントを作成するオープンソースのコミュニティプロジェクトです。
構築されたレポートモジュールとしてのVMware ESXiは、スタンドアロンVMware ESXiサーバーのビルドドキュメントとして生成されるために使用されます。
VMware vsphere / vcenterサーバー環境のレポートについては、VMware vsphere asbuiltreportを参照してください。
このプロジェクトの詳細については、Asbuiltreport Webサイトを参照してください。
以下は、ビルドレポートとしてVMware ESXiをインストール、構成、および生成する方法の指示です。
構築されたレポートとしてのVMware ESXiは、次のESXIバージョンをサポートしています。
次のVMware ESXiバージョンは、テストおよび/またはサポートされなくなりました。
このレポートは、次のPowerShellバージョンと互換性があります。
| Windows PowerShell 5.1 | PowerShell 7 |
|---|---|
| ✅ | ✅ |
PowerShell 5.1またはPowerShell 7、および構築されたレポートとしてVMware ESXiを生成するには、次のPowerShellモジュールが必要です。
core .NETコアをインストールできない場合は、レポートJSON構成ファイルでShowCoverPageImage Falseに設定する必要があります。
ESXIホストにルート権限を持つユーザーは、ビルドレポートとしてVMware ESXIを生成するために必要です。
PowerShell端子ウィンドウを開き、必要な各モジュールをインストールします。
install-module VMware.PowerCLI - MinimumVersion 12.3 - AllowClobber
install-module AsBuiltReport.VMware.ESXi構築されたレポートとしてのESXIは、JSONファイルを利用して、レポート情報、オプション、詳細、およびヘルスチェックの構成を許可します。
ESXIレポート構成ファイルは、次のコマンドを実行して生成できます。
New-AsBuiltReportConfig - Report VMware.ESXi - Path < User specified folder > - Name < Optional >このコマンドを実行すると、デフォルトのESXIレポートJSON構成をユーザー指定フォルダーにコピーします。
すべてのレポート設定は、JSONファイルを介して構成できます。
以下は、レポートのJSONファイル内の各スキーマを構成する方法の情報を提供します。
レポートスキーマはESXIレポート情報の構成を提供します
| サブスキーマ | 設定 | デフォルト | 説明 |
|---|---|---|---|
| 名前 | ユーザー定義 | ビルドレポートとしてのVMware ESXi | ASビルドレポートの名前 |
| バージョン | ユーザー定義 | 1.0 | レポートバージョン |
| 状態 | ユーザー定義 | リリース | レポートのリリースステータス |
| showcoverpageimage | true / false | 真実 | カバーページ画像の表示を有効/無効にするためにトグル |
| showheaderfooter | true / false | 真実 | ドキュメントヘッダーとフッターを有効/無効にするためにトグル |
| ShowTableCaptions | true / false | 真実 | トグルテーブルキャプション/番号付けを有効/無効にします |
オプションスキーマを使用すると、レポート内の特定のオプションをオンまたはオフに切り替えることができます
| サブスキーマ | 設定 | デフォルト | 説明 |
|---|---|---|---|
| showlicensekeys | true / false | 間違い | ESXIライセンスキーをマスク/マスクに切り替えます マスクされたライセンスキー ***** - ***** - ***** -56ydm-as12k マスクされていないライセンスキー AKLU4-PFG8M-W2D8J-56YDM-AS12K |
| showvmsnapshots | true / false | 真実 | トグルVMスナップショットのレポートを有効/無効にします |
InfoleVelスキーマにより、レポートの各セクションの構成が粒状レベルで構成されます。次のセクションを設定できます
次のように、各セクションには詳細な粒度の6つのレベル（0-5）があります。
| 設定 | infolevel | 説明 |
|---|---|---|
| 0 | 無効 | 情報を収集または表示しません |
| 1 | 有効 /要約 | オブジェクトのコレクションの要約情報を提供します |
| 2 | 概要 | オブジェクトのコレクションの凝縮された詳細情報を提供します |
| 3 | 詳細 | 個々のオブジェクトの詳細情報を提供します |
| 4 | ADV詳細 | 個々のオブジェクトの詳細情報、および関連するオブジェクト（ホスト、クラスター、データストア、VMなど）の情報を提供します |
| 5 | 包括的な | 高度な構成設定など、個々のオブジェクトに包括的な情報を提供する |
以下の表には、各セクションのデフォルトおよび最大インフォレベル設定の概要を示しています。
| サブスキーマ | デフォルト設定 | 最大設定 |
|---|---|---|
| vmhost | 3 | 5 |
| ネットワーク | 3 | 4 |
| ストレージ | 3 | 4 |
| VM | 3 | 4 |
HealthCheckスキーマは、ヘルスチェックのオンまたはオフを切り替えるために使用されます。
VMHOSTスキーマは、VMHOSTの健康チェックを構成するために使用されます。
| サブスキーマ | 設定 | デフォルト | 説明 | ハイライト |
|---|---|---|---|---|
| ConnectionState | true / false | 真実 | vmhosts接続状態をチェックします | メンテナンス 切断された |
| ハイパーレディング | true / false | 真実 | ハイパースレッドが無効になっているVMHOSTSを強調します | ハイパーレディングは無効です |
| スクラッチロケーション | true / false | 真実 | デフォルトのスクラッチの場所で構成されているvmhostsを強調表示します | スクラッチの場所は /TMP /スクラッチです |
| IPv6 | true / false | 真実 | IPv6が有効になっていないVMHostsを強調します | IPv6が無効になっています |
| Uptimedays | true / false | 真実 | 9か月を超える稼働時間のvmhostsを強調します | 9-12か月 > 12か月 |
| ライセンス | true / false | 真実 | 生産評価ライセンスを使用しているVMHOSTSを強調します | 使用中の製品評価ライセンス |
| SSH | true / false | 真実 | SSHサービスが有効になっているかどうかを強調表示します | TSM / TSM-SSHサービスが有効になっています |
| Esxishell | true / false | 真実 | ESXiシェルサービスが有効になっているかどうかを強調表示します | TSM / TSM-ESXISHELLサービスが有効になっています |
| NTP | true / false | 真実 | NTPサービスが停止したか、VMHOSTで無効になっているかどうかを強調表示します | NTPサービスが停止 /無効になっています |
| Storageadapter | true / false | 真実 | 「オンライン」ではないストレージアダプターを強調表示します | ストレージアダプターのステータスは「不明」です ストレージアダプターのステータスは「オフライン」です |
| ネットワークアダプター | true / false | 真実 | 「接続」されていない物理ネットワークアダプターを強調します 「ダウン」されている物理ネットワークアダプターを強調します | ネットワークアダプターは「切断されています」 ネットワークアダプターは「ダウン」です |
| lockdownMode | true / false | 真実 | ロックダウンモードが有効になっていないVMHostsを強調表示します | ロックダウンモードが無効になっています |
データストアスキーマは、データストアの健康チェックの構成に使用されます。
| サブスキーマ | 設定 | デフォルト | 説明 | ハイライト |
|---|---|---|---|---|
| 容量化 | true / false | 真実 | 75％を超えるストレージ容量の利用を備えたデータストアを強調表示します | 75-90％が利用されています > 90％が利用されています |
VMスキーマは、仮想マシンの健康チェックの構成に使用されます。
| サブスキーマ | 設定 | デフォルト | 説明 | ハイライト |
|---|---|---|---|---|
| PowerState | true / false | 真実 | 電源を切るVMを強調します | VMは電源が切れています |
| ConnectionState | true / false | 真実 | 孤児またはアクセスできないVMを強調します | VMは孤児またはアクセスできません |
| cpuhotadd | true / false | 真実 | CPU Hot Addが有効になっている仮想マシンを強調表示します | CPU Hot Add Enabled |
| cpuhotremove | true / false | 真実 | CPUホット削除を有効にしている仮想マシンを強調表示します | CPU Hot removeが有効になっています |
| MemoryHotadd | true / false | 真実 | メモリホット追加が有効になっているVMを強調表示します | メモリホット追加が有効になっています |
| ChangeBlockTracking | true / false | 真実 | 変更ブロック追跡を有効にしないVMSを強調表示します | ブロック追跡が無効になる変更 |
| spbmpolicycompliance | true / false | 真実 | ストレージベースのポリシーに準拠していないVMSを強調表示します | VMストレージベースのポリシーコンプライアンスは不明です VMは、ストレージベースのポリシーに準拠していません |
| vmtoolsstatus | true / false | 真実 | VMツールがインストールされていない、古くなっていない、または実行されていない仮想マシンを強調表示 | VMツールはインストールされていない、古くなっていない、または実行されていない |
| vmsnapshots | true / false | 真実 | 7日以上のスナップショットがある仮想マシンを強調表示します | VMスナップショット年齢> = 7日 VMスナップショット年齢> = 14日 |
# Generate an ESXi As Built Report for ESXi server 'esxi-01.corp.local' using specified credentials. Export report to HTML & DOCX formats. Use default report style. Append timestamp to report filename. Save reports to 'C:UsersTimDocuments'
PS C: > New-AsBuiltReport - Report VMware.ESXi - Target ' esxi-01.corp.local ' - Username ' root ' - Password ' VMware1! ' - Format Html , Word - OutputFolderPath ' C:UsersTimDocuments ' - Timestamp
# Generate an ESXi As Built Report for ESXi server 'esxi-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:UsersTimDocuments'. Display verbose messages to the console.
PS C: > New-AsBuiltReport - Report VMware.ESXi - Target ' esxi-01.corp.local ' - Username ' root ' - Password ' VMware1! ' - Format Text , Html , Word - OutputFolderPath ' C:UsersTimDocuments ' - ReportConfigFilePath ' C:UsersTimAsBuiltReportAsBuiltReport.VMware.ESXi.json ' - Verbose
# Generate an ESXi As Built Report for ESXi server 'esxi-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:UsersTimDocuments'.
PS C: > $Creds = Get-Credential
PS C: > New-AsBuiltReport - Report VMware.ESXi - Target ' esxi-01.corp.local ' - Credential $Creds - Format Html , Text - OutputFolderPath ' C:UsersTimDocuments ' - EnableHealthCheck
# Generate a single ESXi As Built Report for ESXi servers 'esxi-01.corp.local' and 'esxi-02.corp.local' using specified credentials. Report exports to Word format by default. Apply custom style to the report. Reports are saved to the user profile folder by default.
PS C: > New-AsBuiltReport - Report VMware.ESXi - Target ' esxi-01.corp.local ' , ' esxi-02.corp.local ' - Username ' root ' - Password ' VMware1! ' - StylePath ' C:ScriptsStylesMyCustomStyle.ps1 '
# Generate an ESXi As Built Report for ESXi server 'esxi-01.corp.local' using specified credentials. 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 VMware.ESXi - Target ' esxi-01.corp.local ' - Username ' root ' - Password ' VMware1! ' - Format Html , Word - OutputFolderPath ' C:UsersTimDocuments ' - SendEmail
