AsBuiltReport.VMware.ESXi
v1.1.3
VMware Esxi As As Buld Report - это модуль PowerShell, который работает в сочетании с asbuiltreport.core.
Asbuiltreport-это проект сообщества с открытым исходным кодом, который использует PowerShell для создания AS-построенной документации в нескольких форматах документов для нескольких поставщиков и технологий.
VMware ESXI в качестве встроенного отчетного модуля используется для генерации встроенной документации для автономных VMware ESXI -серверов.
Пожалуйста, обратитесь к VMware vsphere asbuiltreport для сообщения о средах VMware vSphere / vCenter.
Пожалуйста, обратитесь к веб -сайту AsbuiltReport для получения более подробной информации об этом проекте.
Ниже приведены инструкции о том, как установить, настроить и генерировать VMware ESXI в качестве встроенного отчета.
VMware ESXI в качестве встроенного отчета поддерживает следующие версии ESXI;
Следующие версии VMware ESXI больше не тестируются и/или поддерживаются;
Этот отчет совместим со следующими версиями PowerShell;
| Windows PowerShell 5.1 | PowerShell 7 |
|---|---|
| ✅ | ✅ |
PowerShell 5.1 или PowerShell 7 и следующие модули PowerShell необходимы для создания VMware ESXI в качестве встроенного отчета.
❗ Если вы не можете установить Core .net Core, необходимо установить ShowCoverPageImage в False в файле конфигурации отчета JSON.
Пользователь с корневыми привилегиями на хосте 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 отчета.
Схема отчета обеспечивает конфигурацию информации отчета ESXI
| Суб-схема | Параметр | По умолчанию | Описание |
|---|---|---|---|
| Имя | Пользователь определен | VMware Esxi в качестве встроенного отчета | Название отчета AS AS |
| Версия | Пользователь определен | 1.0 | Версия отчета |
| Статус | Пользователь определен | Выпущенный | Статус выпуска отчета |
| ShowCoverPageImage | Верно / Неверно | истинный | Переключить, чтобы включить/отключить отображение изображения страницы обложки |
| Showheaderfooter | Верно / Неверно | истинный | Переключить, чтобы включить/отключить заголовки и нижние колонтитулы документов |
| ShowtableCaptions | Верно / Неверно | истинный | Переключить, чтобы включить/отключить подписи/нумерацию таблиц |
Схема опций позволяет включать или выключить определенные варианты в отчете
| Суб-схема | Параметр | По умолчанию | Описание |
|---|---|---|---|
| Showlicensekeys | Верно / Неверно | ЛОЖЬ | Переключить, чтобы маска/разоблачить лицензионные ключи ESXI Маскированный лицензионный ключ *****-*****-*****-56YDM-AS12K Разоблаченный лицензионный ключ AKLU4-PFG8M-W2D8J-56YDM-AS12K |
| ShowVMSNAPSHOTS | Верно / Неверно | истинный | Переключить, чтобы включить/отключить отчет о снимках виртуальной машины |
Схема Infolevel позволяет конфигурации каждого раздела отчета на гранулярном уровне. Следующие разделы могут быть установлены
Существует 6 уровней (0-5) детализации гранулярности для каждого раздела следующим образом;
| Параметр | Недостаток | Описание |
|---|---|---|
| 0 | Неполноценный | Не собирает и не отображает никакой информации |
| 1 | Включено / резюме | Предоставляет суммированную информацию для сбора объектов |
| 2 | ADV Резюме | Предоставляет конденсированную подробную информацию для сбора объектов |
| 3 | Подробный | Предоставляет подробную информацию для отдельных объектов |
| 4 | Adv подробно | Предоставляет подробную информацию для отдельных объектов, а также информацию для ассоциированных объектов (хосты, кластеры, данные на данные, виртуальные машины и т. Д.) |
| 5 | Всесторонний | Предоставляет комплексную информацию для отдельных объектов, таких как настройки расширенных настройки конфигурации |
В таблице ниже изложены настройки по умолчанию и максимальные настройки недостатка для каждого раздела.
| Суб-схема | Настройка по умолчанию | Максимальная настройка |
|---|---|---|
| Vmhost | 3 | 5 |
| Сеть | 3 | 4 |
| Хранилище | 3 | 4 |
| Виртуальная машина | 3 | 4 |
Схема HealthCheck используется для включения или выключения проверки здоровья.
Схема VMHOST используется для настройки проверки здоровья для VMHOSTS.
| Суб-схема | Параметр | По умолчанию | Описание | Выделять |
|---|---|---|---|---|
| Соединение | Верно / Неверно | истинный | Проверяет состояние соединения vmhosts | Обслуживание Отключен |
| Гиперподботка | Верно / Неверно | истинный | Выделяет VMHOOST, которые отключены гиперподвор. | Гиперподром отключен |
| Царапина | Верно / Неверно | истинный | Выдеживает VMHOSTS, которые настроены с местоположением царапины по умолчанию | Расположение царапин /TMP /Scratch |
| IPv6 | Верно / Неверно | истинный | Выдеживает VMHOSTS, которые не включены IPv6 | IPv6 отключен |
| Uptimedays | Верно / Неверно | истинный | Основные виртуальные знаки с дни работы с развыканием более 9 месяцев | 9 - 12 месяцев > 12 месяцев |
| Лицензирование | Верно / Неверно | истинный | Выделывает VMHOOST, которые используют лицензии на оценку производства | Лицензия на оценку продукта используется |
| SSH | Верно / Неверно | истинный | Выделитесь, если служба SSH включена | Сервис TSM / TSM-SSH включена |
| Esxishell | Верно / Неверно | истинный | Подчеркивает, включена ли служба Shell Esxi | Сервис TSM / TSM-ESXISHELL включен |
| Ntp | Верно / Неверно | истинный | Основные моменты, если служба NTP остановилась или отключена на VMHOST | Сервис NTP остановлена / отключен |
| Storageadapter | Верно / Неверно | истинный | Основные адаптеры хранения, которые не являются «онлайн» | Состояние адаптера хранения «неизвестно» Состояние адаптера хранения «офлайн» |
| NetworkAdapter | Верно / Неверно | истинный | Выделяет физические сетевые адаптеры, которые не «подключены» Выделяет физические сетевые адаптеры, которые «вниз» | Сетевой адаптер «отключен» Сетевой адаптер «вниз» |
| LockDownMode | Верно / Неверно | истинный | Выдеживает VMHOSTS, которые не включены режима блокировки | Режим блокировки отключен |
Схема хранилища данных используется для настройки проверки здоровья для данных.
| Суб-схема | Параметр | По умолчанию | Описание | Выделять |
|---|---|---|---|---|
| Емкость | Верно / Неверно | истинный | Выделяет данные данных с использованием емкости хранения более 75% | 75 - 90% использовали > 90% использовали |
Схема VM используется для настройки проверки здоровья на виртуальные машины.
| Суб-схема | Параметр | По умолчанию | Описание | Выделять |
|---|---|---|---|---|
| Powerstate | Верно / Неверно | истинный | Выделит виртуальные машины, которые отключены | VM отключена |
| Соединение | Верно / Неверно | истинный | Выделит виртуальные машины, которые являются осиротевшими или недоступными | ВМ -осирота |
| ЦПУХОТАДД | Верно / Неверно | истинный | Выделит виртуальные машины, которые включены | Горячий добавление процессора включено |
| ЦПУХОТРЕМОВ | Верно / Неверно | истинный | Выделит виртуальные машины, которые включены | ЦП ОТВЕТ |
| MemoryHotadd | Верно / Неверно | истинный | Выделите виртуальные машины, которые имеют Hot Hot Hot Add Add | Hot Hot Add Add Added |
| ChangeBlockTracking | Верно / Неверно | истинный | Выделите виртуальные машины, которые не включены в изменение отслеживания блоков | Изменить отслеживание блоков отключено |
| Spbmpolicycompliance | Верно / Неверно | истинный | Выделит виртуальные машины, которые не соответствуют политикам на основе хранения | Соблюдение политики на основе хранения виртуальной машины неизвестно VM не соответствует политике на основе хранения |
| Vmtoolsstatus | Верно / Неверно | истинный | Основные виртуальные машины, на которых не установлены инструменты виртуальной машины, устарели или не работают | Инструменты виртуальной машины не установлены, не устарели или не работают |
| Vmsnapshots | Верно / Неверно | истинный | Выделите виртуальные машины, у которых есть снимки старше 7 дней | VM Snapshot Age> = 7 дней VM Snapshot Age> = 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
