O Relatório VMware Esxi como Built é um módulo PowerShell que funciona em conjunto com o AsbuilTreport.core.
Asbuiltreport é um projeto comunitário de código aberto que utiliza o PowerShell para produzir documentação como construída em vários formatos de documentos para vários fornecedores e tecnologias.
O módulo de relatório VMware ESXi é usado para gerar como documentação construída para servidores esxi vmware independentes.
Consulte o VMware vSphere AsbuilTreport para relatar os ambientes VMware vSphere / vCenter Server.
Consulte o site do Asbuiltreport para obter informações mais detalhadas sobre este projeto.
Abaixo estão as instruções sobre como instalar, configurar e gerar um vmware ESXi como relatório construído.
O relatório VMware ESXi como construído suporta as seguintes versões ESXi;
As seguintes versões VMware ESXi não estão mais sendo testadas e/ou suportadas;
Este relatório é compatível com as seguintes versões PowerShell;
Windows PowerShell 5.1 | PowerShell 7 |
---|---|
✅ | ✅ |
PowerShell 5.1 ou PowerShell 7, e os seguintes módulos PowerShell são necessários para gerar um Relatório VMware ESXi como construído.
❗ Se você não puder instalar o .NET Core, definirá ShowCoverPageImage
como False
no arquivo de configuração JSON do relatório.
Um usuário com privilégios root no host ESXi é necessário para gerar um Relatório VMware ESXi como Built.
Abra uma janela do terminal PowerShell e instale cada um dos módulos necessários.
install-module VMware.PowerCLI - MinimumVersion 12.3 - AllowClobber
install-module AsBuiltReport.VMware.ESXi
O Relatório Esxi AS Built utiliza um arquivo JSON para permitir a configuração das informações do relatório, opções, detalhes e checks de saúde.
Um arquivo de configuração do relatório ESXi pode ser gerado executando o seguinte comando;
New-AsBuiltReportConfig - Report VMware.ESXi - Path < User specified folder > - Name < Optional >
A execução deste comando copiará a configuração padrão do Relatório ESXI para uma pasta especificada pelo usuário.
Todas as configurações de relatório podem ser configuradas através do arquivo JSON.
A seguir, fornece informações sobre como configurar cada esquema dentro do arquivo JSON do relatório.
O esquema do relatório fornece configuração das informações do relatório ESXi
Sub-esquema | Contexto | Padrão | Descrição |
---|---|---|---|
Nome | Usuário definido | Vmware esxi como relatório construído | O nome do relatório construído |
Versão | Usuário definido | 1.0 | A versão do relatório |
Status | Usuário definido | Lançado | O status de liberação do relatório |
ShowCoverPageImage | verdadeiro / falso | verdadeiro | Alternar para ativar/desativar a exibição da imagem da página |
Showheaderfooter | verdadeiro / falso | verdadeiro | Alternar para ativar/desativar cabeçalhos e rodapés de documentos |
ShowTableCaptions | verdadeiro / falso | verdadeiro | Alternar para ativar/desativar as legendas/numeração da tabela |
O esquema de opções permite que certas opções dentro do relatório sejam ativadas ou desativadas
Sub-esquema | Contexto | Padrão | Descrição |
---|---|---|---|
ShowlicenseKeys | verdadeiro / falso | falso | Alternar para mascarar/desmascarar as chaves de licença ESXi Chave de licença mascarada *****-*****-*****-56YDM-AS12K Chave de licença desmascarada AKLU4-PFG8M-W2D8J-56YDM-AS12K |
ShowVmsnaPShots | verdadeiro / falso | verdadeiro | Alternar para ativar/desativar os relatórios de instantâneos de VM |
O esquema de níveis infele permite a configuração de cada seção do relatório em nível granular. As seções a seguir podem ser definidas
Existem 6 níveis (0-5) de granularidade detalhada para cada seção da seguinte forma;
Contexto | Nível de Nível | Descrição |
---|---|---|
0 | Desabilitado | Não coleta ou exibe nenhuma informação |
1 | Ativado / resumo | Fornece informações resumidas para uma coleção de objetos |
2 | Resumo do ADV | Fornece informações detalhadas e condensadas para uma coleção de objetos |
3 | Detalhado | Fornece informações detalhadas para objetos individuais |
4 | Aviso detalhado | Fornece informações detalhadas para objetos individuais, bem como informações para objetos associados (hosts, clusters, dados de dados, VMs etc.) |
5 | Abrangente | Fornece informações abrangentes para objetos individuais, como configurações avançadas de configuração |
A tabela abaixo descreve as configurações de nível inacessível e máximo para cada seção.
Sub-esquema | Configuração padrão | Configuração máxima |
---|---|---|
Vmhost | 3 | 5 |
Rede | 3 | 4 |
Armazenar | 3 | 4 |
Vm | 3 | 4 |
O esquema HealthCheck é usado para ativar ou desativar as verificações de saúde.
O esquema VMHost é usado para configurar verificações de saúde para o VMHOSTS.
Sub-esquema | Contexto | Padrão | Descrição | Destaque |
---|---|---|---|---|
ConnectionState | verdadeiro / falso | verdadeiro | Verifica o estado de conexão VMHosts | Manutenção Desconectado |
Hyperthreading | verdadeiro / falso | verdadeiro | Destaca os vmhosts que têm hiperthreading desativados | Hyperthreading desativado |
ScratchLocation | verdadeiro / falso | verdadeiro | Destaca os vmhosts que são configurados com o local de arranhão padrão | Localização de arranhões é /tmp /scratch |
IPv6 | verdadeiro / falso | verdadeiro | Destaca os vmhosts que não têm IPv6 ativados | IPv6 desativado |
UpTimeDays | verdadeiro / falso | verdadeiro | Destaca os vmhosts com dias de atividade maiores que 9 meses | 9 - 12 meses > 12 meses |
Licenciamento | verdadeiro / falso | verdadeiro | Destaca os vmhosts que estão usando licenças de avaliação de produção | Licença de avaliação de produtos em uso |
Ssh | verdadeiro / falso | verdadeiro | Destaque se o serviço SSH estiver ativado | Serviço TSM / TSM-SSH ativado |
Esxishell | verdadeiro / falso | verdadeiro | Destaque se o serviço de shell esxi estiver ativado | Serviço TSM / TSM-ESXishell habilitado |
Ntp | verdadeiro / falso | verdadeiro | Destaques se o serviço NTP parou ou estiver desativado em um VMHost | Serviço NTP parou / desativado |
StorrageAdapter | verdadeiro / falso | verdadeiro | Destaca adaptadores de armazenamento que não estão 'online' | O status do adaptador de armazenamento é 'desconhecido' O status do adaptador de armazenamento está 'offline' |
NetworkAdapter | verdadeiro / falso | verdadeiro | Destaca os adaptadores de rede física que não estão 'conectados' Destaca os adaptadores de rede física que estão 'abaixo' | O adaptador de rede está 'desconectado' O adaptador de rede está 'Down' |
LockdownMode | verdadeiro / falso | verdadeiro | Destaca os vmhosts que não têm o modo de bloqueio ativado | Modo de bloqueio desativado |
O esquema de dados de dados é usado para configurar verificações de saúde para dados de dados.
Sub-esquema | Contexto | Padrão | Descrição | Destaque |
---|---|---|---|---|
Capactação | verdadeiro / falso | verdadeiro | Destaques DataStors com a utilização da capacidade de armazenamento acima de 75% | 75 - 90% utilizado > 90% utilizado |
O esquema VM é usado para configurar verificações de saúde para máquinas virtuais.
Sub-esquema | Contexto | Padrão | Descrição | Destaque |
---|---|---|---|---|
Powerstate | verdadeiro / falso | verdadeiro | Destaca as VMs que são desligadas | VM está desligado |
ConnectionState | verdadeiro / falso | verdadeiro | Destaca VMs que são órfãs ou inacessíveis | VM é órfão ou inacessível |
Cpuhotadd | verdadeiro / falso | verdadeiro | Destaca máquinas virtuais que possuem a CPU Hot Add ativado | CPU Hot Add habilitado |
CpuhotRemove | verdadeiro / falso | verdadeiro | Destaca as máquinas virtuais que têm a CPU a quente habilitada | CPU Hot Remover habilitado |
MemoryHotadd | verdadeiro / falso | verdadeiro | Destaques VMs que possuem memória quente ADD ativado | Memory Hot Add habilitado |
ChangeBlockTracking | verdadeiro / falso | verdadeiro | Destaques VMs que não têm rastreamento de bloco de alteração ativado | Alterar o rastreamento do bloco desativado |
Spbmpolicycompliance | verdadeiro / falso | verdadeiro | Destaca as VMs que não cumprem as políticas baseadas em armazenamento | A conformidade com a política baseada em armazenamento da VM é desconhecida A VM não está em conformidade com as políticas baseadas em armazenamento |
Vmtoolsstatus | verdadeiro / falso | verdadeiro | Destaca as máquinas virtuais que não possuem ferramentas de VM instaladas, estão desatualizadas ou não estão em execução | Ferramentas VM não instaladas, desatualizadas ou não em execução |
Vmsnapshots | verdadeiro / falso | verdadeiro | Destaca máquinas virtuais com instantâneos com mais de 7 dias | Idade do instantâneo da VM> = 7 dias Idade do instantâneo da VM> = 14 dias |
# 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