Comandos e funcionalidades básicos da ferramenta OpenBMC

A ferramenta OpenBMC fornece suporte para trabalhar com logs de eventos do sistema, atualizando o firmware do sistema, identificando o sistema, desligando o sistema e outras funções relacionadas ao serviço.

Opções de nível superior da ferramenta OpenBMC

Saiba mais sobre as opções de nível superior para os comandos da ferramenta OpenBMC.

Sobre esta Tarefa

  • -H: nome do host ou endereço IP do BMC.
  • -U: nome do usuário para efetuar login.
  • -A: fornece um prompt para pedir a senha.
  • -P: senha para o nome do usuário.
  • -j: mudar formato de saída para JSON.
  • -t: localização da tabela de política a ser usada.
  • -T: fornece estatísticas de tempo para efetuar login, executar o comando e efetuar logout.
  • -V: exibe a versão atual da ferramenta OpenBMC.

Comandos de log de eventos do sistema

Saiba mais sobre os comandos de log de eventos do sistema para a ferramenta OpenBMC.

Procedimento

  • Para imprimir uma lista dos logs de eventos do sistema em um formato legível, use o comando a seguir:
    openbmctool -U <username> -P <password> -H <BMC IP address or BMC host name> sel print
  • Para listar os logs de eventos do sistema em dados brutos, use o comando a seguir:
    openbmctool -U <username> -P <password> -H <BMC IP address or BMC host name> sel list
  • Para mudar o status de um log de eventos do sistema para resolvido, use o comando a seguir:
    openbmctool -U <username> -P <password> -H <BMC IP address or BMC host name> sel resolve -n x, em que x é o número do log de eventos do sistema
  • Para coletar todos os dados de serviço, incluindo logs de eventos do sistema, use o comando a seguir:

    openbmctool -U <username> -P <password> -H <BMC IP address or BMC host name> collect_service_data.

  • Para limpar registros de gard para desativar o hardware, use o comando a seguir:
    openbmctool -U <username> -P <password> -H <BMC IP address or BMC host name> gardclear
  • Para limpar os logs de alerta de entradas, use o comando a seguir:
    openbmctool -U <username> -P <password> -H <BMC IP address or BMC host name> sel clear

Comando de atualização de firmware do sistema

Saiba mais sobre o comando de atualização de firmware do sistema.

Procedimento

  • Para atualizar o firmware do sistema, use o comando a seguir:
    openbmctool -U <username> -P <password> -H <BMC IP address or BMC host name> firmware flash <bmc or pnor> -f xxx.tar, em que bmc ou pnor é o tipo de imagem que você deseja atualizar no sistema.
    Nota: Se você não estiver na mesma pasta que o arquivo TAR, deverá incluir o caminho completo para a pasta na qual o arquivo reside.
  • Para ativar uma imagem de firmware que está disponível no BMC, use o comando a seguir:

    openbmctool -U <username> -P <password> -H <BMC IP address or BMC host name> firmware activate <firmware image ID>

Comandos de identificação do sistema

Saiba mais sobre os comandos de identificação do sistema.

Procedimento

  • Para ativar o LED azul de identificação do sistema, use o comando a seguir:

    openbmctool -U <username> -P <password> -H <BMC IP address or BMC host name> chassis identify on

  • Para desligar o LED azul de identificação do sistema, use o comando a seguir:

    openbmctool -U <username> -P <password> -H <BMC IP address or BMC host name> chassis identify off

  • Para verificar o status do LED azul de identificação do sistema, use o comando a seguir:

    openbmctool -U <username> -P <password> -H <BMC IP address or BMC host name> chassis identify status

Comandos de ligamento e desligamento do sistema

Saiba mais sobre os comandos de ligamento e desligamento do sistema.

Procedimento

  • Para verificar o status de energia do sistema, use o comando a seguir:

    openbmctool -U <username> -P <password> -H <BMC IP address or BMC host name> chassis power status

  • Para ligar o sistema, use o comando a seguir:

    openbmctool -U <username> -P <password> -H <BMC IP address or BMC host name> chassis power on

  • Para desligar o sistema normalmente, use o comando a seguir:

    openbmctool -U <username> -P <password> -H <BMC IP address or BMC host name> chassis power softoff

  • Para desligar o sistema imediatamente, use o comando a seguir:

    openbmctool -U <username> -P <password> -H <BMC IP address or BMC host name> chassis power hardoff

Comandos do sensor do sistema

Saiba mais sobre os comandos do sensor do sistema.

Procedimento

Para exibir uma lista de todos os sensores de monitoramento, use o comando a seguir:

openbmctool -U <username> -P <password> -H <BMC IP address or BMC host name> sensors print

ou

openbmctool -U <username> -P <password> -H <BMC IP address or BMC host name> sensors list

Comandos de FRU do sistema

Saiba mais sobre os comandos de FRU do sistema.

Procedimento

  • Para exibir uma lista de todos os itens de inventário, use o comando a seguir:

    openbmctool -U <username> -P <password> -H <BMC IP address or BMC host name> fru print

    ou

    openbmctool -U <username> -P <password> -H <BMC IP address or BMC host name> fru list

  • Para exibir o status conhecido de todos os itens de FRU, use o comando a seguir:

    openbmctool -U <username> -P <password> -H <BMC IP address or BMC host name> fru status

    Nota: o item FRU deve ser designado como uma FRU substituível pelo BMC.
  • Para automatizar a revisão dos comandos de status de FRU e para determinar se há um impacto de desempenho no sistema, use o comando a seguir:

    openbmctool -U <username> -P <password> -H <BMC IP address or BMC host name> health_check

    Nota: Este comando não garante um sistema funcional, pois pode haver entradas de logs de eventos do sistema que não estão associados aos itens de inventário...

Comandos de reconfiguração do BMC do sistema

Saiba mais sobre os comandos de reconfiguração do BMC do sistema.

Procedimento

  • Para fazer uma reconfiguração a quente do BMC de maneira remota e sem um ciclo de CA, use o comando a seguir:

    openbmctool -U <username> -P <password> -H <BMC IP address or BMC host name> bmc reset warm

  • Para fazer uma reconfiguração a frio do BMC de maneira remota e sem um ciclo de CA, use o comando a seguir:

    openbmctool -U <username> -P <password> -H <BMC IP address or BMC host name> bmc reset cold

Comandos de dump do sistema

Saiba mais sobre os comandos de dump do sistema.

Procedimento

  • Para criar um novo arquivo dump, use o comando a seguir:

    openbmctool -U <username> -P <password> -H <BMC IP address or BMC host name> dump create

  • Para listar todos os arquivos dump no sistema, use o comando a seguir:

    openbmctool -U <username> -P <password> -H <BMC IP address or BMC host name> dump list

  • Para excluir um arquivo dump específico do sistema, use o comando a seguir:

    openbmctool -U <username> -P <password> -H <BMC IP address or BMC host name> dump delete -n <dump file entry>

  • Para excluir todos os arquivos dump do sistema, use o comando a seguir:

    openbmctool -U <username> -P <password> -H <BMC IP address or BMC host name> dump delete all

  • Para recuperar um arquivo dump específico, use o comando a seguir:

    openbmctool -U <username> -P <password> -H <BMC IP address or BMC host name> dump retrieve -n <dump file entry>

  • Para recuperar um arquivo dump e salvá-lo em um diretório específico, use o comando a seguir:
    openbmctool -U <username> -P <password> -H <BMC IP address or BMC host name> dump retrieve -s <location to save dump file>
    Nota: se você não especificar um local, o arquivo será salvo no S.O. em que o comando é executado no diretório temporário..

Ativando e desativando contas de usuário do BMC local

Saiba mais sobre os comandos local_users.

Sobre esta Tarefa

As contas do usuário local no BMC, como raiz, podem ser desativadas, consultadas e reativadas com o sub-comando local_users.
Nota: depois de desativar usuários locais, o usuário LDAP precisa estar disponível para interação adicional com o BMC, incluindo a ativação de usuários locais usando a ferramenta OpenBMC .

Procedimento

  • Para visualizar o status da conta do usuário local atual, use o comando a seguir:

    openbmctool <connection options> local_users queryenabled

  • Para desativar todas as contas do usuário local, use o comando a seguir:

    openbmctool <connection options> local_users disableall

  • Para ativar todas as contas do usuário local, use o comando a seguir:

    openbmctool <connection options> local_users enableall

Criação de log remoto usando rsyslog

Saiba mais sobre os comandos de criação de log remoto.

Sobre esta Tarefa

O BMC pode transmitir logs locais (que vão para o diário systemd) usando RSYSLOG. O BMC envia tudo nos logs. Qualquer tipo de filtragem e armazenamento apropriado tem que ser gerenciado no servidor rsyslog.

Procedimento

  • Para configurar o servidor rsyslog para criação de log remoto, use o comando a seguir:

    openbmctool <connection options> logging remote_logging_config -a <IP address> -p <port>

    Nota: o endereço IP e a porta são para o servidor rsyslog remoto. Após o comando ser executado, o servidor rsyslog remoto começará a receber logs do BMC.
  • Para desativar a criação de log remoto, use o comando a seguir:

    openbmctool <connection options> logging remote_logging disable

    Nota: Desative a criação de log remota antes de alternar a criação de log remota de um servidor remoto existente para um novo.
  • Para visualizar a configuração de criação de log remoto, use o comando a seguir:

    openbmctool <connection options> logging remote_logging view

    Nota: esse comando imprime o endereço IP e a porta do servidor rsyslog remoto no formato JavaScript Object Notation (JSON).
  • Para ativar a criação de log da API de REST, use o comando a seguir:

    openbmctool <connection options> logging rest_api on

  • Para desativar a criação de log da API de REST, use o comando a seguir:

    openbmctool <connection options> logging rest_api off

    Nota: a criação de log da API REST é desativada por padrão.

Gerenciamento de certificados

Saiba mais sobre os comandos de gerenciamento de certificado.

Sobre esta Tarefa

É possível substituir o certificado existente e o arquivo de chave privado por outro certificado (possivelmente assinado por CA) e pelo arquivo de chave privado. É possível instalar certificados de servidor, cliente e raiz.

Procedimento

  • Para atualizar o certificado do servidor HTTPS, use o comando a seguir:

    openbmctool <connection options> certificate update server https -f <File>

    Nota: o <File> é o arquivo privacy-enhanced mail (PEM) que contém o certificado e a chave privada.
  • Para atualizar o certificado do cliente LDAP, use o comando a seguir:

    openbmctool <connection options> certificate update client ldap -f <File>

    Nota: o <File> é o arquivo PEM que contém o certificado e a chave privada.
  • Para atualizar o certificado raiz LDAP, use o comando a seguir:

    openbmctool <connection options> certificate update authority ldap -f <File>

    Nota: o <File> é o arquivo PEM que contém apenas o certificado.
  • Para excluir o certificado do servidor HTTPS, use o comando a seguir:

    openbmctool <connection options> certificate delete server https

    Nota: excluir um certificado cria e instala um novo certificado autoassinado.
  • Para excluir o certificado de cliente LDAP, use o comando a seguir:

    openbmctool <connection options> certificate delete client ldap

  • Para excluir o certificado raiz LDAP, use o comando a seguir:

    openbmctool <connection options> certificate delete authority ldap

    Nota: a exclusão do certificado raiz pode causar uma indisponibilidade de serviço LDAP

Configuração de LDAP

Saiba mais sobre os comandos de configuração LDAP.

Sobre esta Tarefa

No BMC, o LDAP é usado para autenticação remota. O BMC não suporta a funcionalidade remota de gerenciamento de usuários. O BMC suporta a configuração LDAP segura e não segura.

Procedimento

  • Para criar a configuração LDAP (não segura), use o comando a seguir:

    openbmctool.py <connection options> ldap enable --uri="ldap://<ldap server IP/hostname>" --bindDN=<bindDN> --baseDN=<basDN> --bindPassword=<bindPassword> --scope="sub/one/base" --serverType="OpenLDAP/ActiveDirectory"

    Nota: a configuração de um nome completo do domínio ou nome do host no parâmetro uri requer que o servidor DNS (Domain Name System) seja configurado no BMC.
  • Para criar a configuração LDAP (segura), use o comando a seguir:

    openbmctool.py <connection options> ldap enable --uri="ldaps://<ldap server IP/hostname>" --bindDN=<bindDN> --baseDN=<basDN> --bindPassword=<bindPassword> --scope="sub/one/base" --serverType="OpenLDAP/ActiveDirectory"

    Notas:
    1. É comum encontrar o seguinte erro ao executar a sequência de caracteres de comando openbmctool.py acima:

      xyz.openbmc_project.Common.Error.NoCACertificate

      Esse erro significa que o cliente BMC precisa verificar se o certificado do servidor LDAP está assinado por uma autoridade de certificação (AC) conhecida. Um administrador precisa fazer upload do certificado de autoridade de certificação para o BMC para resolver esse erro.

    2. A ferramenta OpenBMC não suporta atualizações individuais de propriedade de configuração LDAP. Para atualizar uma única propriedade, o administrador deve recriar a configuração LDAP com os valores mudados.
  • Para excluir a configuração LDAP, use o comando a seguir:

    openbmctool.py <connection options> ldap disable

    Nota: o usuário raiz deve ser ativado antes da execução do comando, caso contrário, o BMC não estará acessível. Para ativar todas as contas do usuário local, consulte Ativando e Desativando as Contas do Usuário Local
  • Para incluir o mapeamento de privilégios, use o comando a seguir:

    openbmctool.py <connection options> ldap privilege-mapper create --groupName=<groupName> --privilege="priv-admin/priv-user"

  • Para excluir o mapeamento de privilégios, use o comando a seguir:

    openbmctool.py <connection options> ldap privilege-mapper delete --groupName=<groupName>

  • Para listar o mapeamento de privilégios, use o comando a seguir:

    openbmctool.py <connection options> ldap privilege-mapper list

    O fluxo de trabalho normal para a configuração LDAP está na seguinte ordem:
    1. Configure o servidor DNS.
    2. Configure o LDAP.
      1. Configure o certificado de autoridade de certificação para a configuração LDAP segura.
      2. Crie a configuração LDAP com o usuário local.
    3. Configure o privilégio de usuário.
    Notas:
    1. Se você efetuar login com credenciais LDAP e não tiver incluído o mapeamento de privilégios para as credenciais LDAP, então você obterá a mensagem de erro a seguir:

      403: 'O mapeamento de privilégios do grupo LDAP não existe'.

      É possível evitar esse erro incluindo o mapeamento de privilégios

    2. A mensagem de erro a seguir pode significar que o usuário não tem privilégios suficientes no BMC:

      Privilégios insuficientes

      É possível evitar esse erro incluindo o mapeamento de privilégios

    3. Depois de configurar o LDAP, as opções de conexão da ferramenta OpenBMC funcionam com os usuários locais e LDAP.

Configuração da rede

Saiba mais sobre os comandos de configuração de rede.

Procedimento

  • Para ativar o DHCP, use o comando a seguir:

    openbmctool.py -H <BMC_IP> -U root -P <root password> network enableDHCP -I <Interface name>

  • Para desativar o DHCP, use o comando a seguir:

    openbmctool.py -H <BMC_IP> -U root -P <root password> network disableDHCP -I <Interface name>

  • Para obter o nome do host, use o comando a seguir:

    openbmctool.py -H <BMC_IP> -U root -P <root password> network getHostName

  • Para configurar o nome do host, use o comando a seguir:

    openbmctool.py -H <BMC_IP> -U root -P <root password> network setHostName -H <host name>

  • Para obter o nome de domínio, use o comando a seguir:

    openbmctool.py -H <BMC_IP> -U root -P <root password> network getDomainName -I <Interface name>

  • Para configurar o nome de domínio, use o comando a seguir:

    openbmctool.py -H <BMC_IP> -U root -P <root password> network setDomainName -I <Interface name> -D DomainName1,DomainName2,..

  • Para obter o endereço de Controle de Acesso à Mídia (MAC), use o comando a seguir:

    openbmctool.py -H <BMC_IP> -U root -P <root password> network getMACAddress -I <Interface name>

  • Para configurar o endereço de Controle de Acesso à Mídia, use o comando a seguir:

    openbmctool.py -H <BMC_IP> -U root -P <root password> network setMACAddress -I <Interface name> -MA xx:xx:xx:xx:xx

  • Para obter o gateway-padrão, use o comando a seguir:

    openbmctool.py -H <BMC_IP> -U root -P <root password> network getDefaultGW

  • Para configurar o gateway-padrão, use o comando a seguir:

    openbmctool.py -H <BMC_IP> -U root -P <root password> network setDefaultGW -GW <default gw>

  • Para visualizar a configuração de rede atual, use o comando a seguir:

    openbmctool.py -H <BMC_IP> -U root -P <root password> network view-config

  • Para obter o Network Time Protocol (NTP), use o comando a seguir:

    openbmctool.py -H <BMC_IP> -U root -P <root password> network getNTP -I <Interface name>

  • Para configurar o NTP, use o comando a seguir:

    openbmctool.py -H <BMC_IP> -U root -P <root password> network setNTP -I <Interface name> -N NTP1,NTP2,...

  • Para obter o Sistema de Nomes de Domínio (DNS), use o comando a seguir:

    openbmctool.py -H <BMC_IP> -U root -P <root password> network getDNS -I <Interface name>

  • Para configurar o DNS, use o comando a seguir:

    openbmctool.py -H <BMC_IP> -U root -P <root password> network setDNS -I <Interface name> -d DNS1,DNS2,...

  • Para obter o endereço IP, use o comando a seguir:

    openbmctool.py -H <BMC_IP> -U root -P <root password> network getIP -I <Interface name>

  • Para configurar o endereço IP, use o comando a seguir:

    openbmctool.py -H <BMC_IP> -U root -P <root password> network addIP -a <ADDRESS> \-gw <GATEWAY> -l <PREFIXLENGTH> -p <protocol type> -I <Interface name>

  • Para excluir o endereço IP, use o comando a seguir:

    openbmctool.py -H <BMC_IP> -U root -P <root password> network rmIP -I <Interface name> -a <ADDRESS>

  • Para ativar uma rede local virtual (VLAN), use o comando a seguir:

    openbmctool.py <connection options> network addVLAN -I <Interface name> -n <IDENTIFIER>

  • Para desativar uma rede local virtual (VLAN), use o comando a seguir:

    openbmctool.py <connection options> network deleteVLAN -I <Interface name>

  • Para visualizar as propriedades de configuração DHCP, use o comando a seguir:

    openbmctool.py <connection options> network viewDHCPConfig

  • Para configurar as propriedades DHCP, use o comando a seguir:

    openbmctool.py <connection options> network configureDHCP -d <DNSENABLED> -n <HOSTNAMEENABLED> -t <NTPENABLED> -s <SENDHOSTNAMEENABLED>

    Nota: DNSENABLED, HOSTNAMEENABLED, NTPENABLEDe SENDHOSTNAMEENABLED são valores booleanos (true ou false).
  • Para reconfigurar as configurações de rede para os padrões de fábrica, use o comando a seguir:

    openbmctool.py <connection options> network nwReset

    Nota: as configurações de Reconfiguração são aplicadas após a reinicialização do BMC.