OpenBMC ツールの基本コマンドおよび機能

OpenBMC ツールでは、システム・イベント・ログの処理、システム・ファームウェアの更新、システムの識別、システムの電源オフ、およびその他のサービス関連機能がサポートされます。

OpenBMC ツールのトップレベル・オプション

OpenBMC ツール・コマンドのトップレベル・オプションについて説明します。

本タスクについて

  • -H: BMC のホスト名または IP アドレス。
  • -U: ログインに使用するユーザー名。
  • -A: パスワードを要求するプロンプトを表示。
  • -P: ユーザー名に対するパスワード。
  • -j: 出力形式を JSON に変更。
  • -t: 使用するポリシー・テーブルのロケーション。
  • -T: ログイン、コマンドの実行、およびログアウトに関する時間統計を提供。
  • -V: OpenBMC ツールの現行バージョンを表示。

システム・イベント・ログ・コマンド

OpenBMC ツールのシステム・イベント・ログ・コマンドについて説明します。

手順

  • 読み取り可能な形式でシステム・イベント・ログのリストを出力するには、次のコマンドを使用します。
    openbmctool -U <username> -P <password> -H <BMC IP address or BMC host name> sel print
  • システム・イベント・ログを生データでリストするには、次のコマンドを使用します。
    openbmctool -U <username> -P <password> -H <BMC IP address or BMC host name> sel list
  • システム・イベント・ログの状況を解決済みに変更するには、次のコマンドを使用します。
    openbmctool -U <username> -P <password> -H <BMC IP address or BMC host name> sel resolve -n x。ここで、 x はシステム・イベント・ログ番号です。
  • すべてのサービス・データ (システム・イベント・ログを含む) を収集するには、次のコマンドを使用します。

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

  • 使用不可のハードウェアのガード・レコードを消去するには、次のコマンドを使用します。
    openbmctool -U <username> -P <password> -H <BMC IP address or BMC host name> gardclear
  • エントリーのアラート・ログを消去するには、次のコマンドを使用します。
    openbmctool -U <username> -P <password> -H <BMC IP address or BMC host name> sel clear

システム・ファームウェア更新コマンド

システム・ファームウェア更新コマンドについて説明します。

手順

  • システム・ファームウェアを更新するには、次のコマンドを使用します。
    openbmctool -U <username> -P <password> -H <BMC IP address or BMC host name> firmware flash <bmc or pnor> -f xxx.tar。ここで、 bmc または por は、システムにフラッシュするイメージのタイプです。
    注: TAR ファイルと同じフォルダーにいない場合は、ファイルが存在するフォルダーへの絶対パスを含める必要があります。
  • BMC で使用可能なファームウェア・イメージを活動化するには、次のコマンドを使用します。

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

システム識別コマンド

システム識別コマンドについて説明します。

手順

  • 青色のシステム識別 LED を活動化するには、次のコマンドを使用します。

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

  • 青色のシステム識別 LED をオフにするには、次のコマンドを使用します。

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

  • 青色のシステム識別 LED の状況を確認するには、次のコマンドを使用します。

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

システム電源オン/オフ・コマンド

システム電源オン/オフ・コマンドについて説明します。

手順

  • システムの電源状況を確認するには、次のコマンドを使用します。

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

  • システムの電源をオンにするには、次のコマンドを使用します。

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

  • システムの電源を通常の方法でオフにするには、次のコマンドを使用します。

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

  • システムの電源を即時にオフにするには、次のコマンドを使用します。

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

システム・センサー・コマンド

システム・センサー・コマンドについて説明します。

手順

すべてのモニター・センサーのリストを表示するには、次のコマンドを使用します。

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

または

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

システム FRU コマンド

システム FRU コマンドについて説明します。

手順

  • すべてのインベントリー・アイテムのリストを表示するには、次のコマンドを使用します。

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

    または

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

  • すべての FRU アイテムの既知の状況を表示するには、次のコマンドを使用します。

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

    注: FRU 項目は、BMC によって交換可能 FRU として指定されている必要があります。
  • FRU 状況コマンドのレビューを自動化し、システムにパフォーマンスの影響があるかどうかを判別するには、次のコマンドを使用します。

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

    注: このコマンドは、インベントリー項目に関連付けられていないシステム・イベント・ログ項目が存在する可能性があるため、正常なシステムを保証するものではありません。

システム BMC リセット・コマンド

システム BMC リセット・コマンドについて説明します。

手順

  • AC サイクルを行わずに、BMC のウォーム・リセットをリモートから実行するには、次のコマンドを使用します。

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

  • AC サイクルを行わずに、BMC のコールド・リセットをリモートから実行するには、次のコマンドを使用します。

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

システム・ダンプ・コマンド

システム・ダンプ・コマンドについて説明します。

手順

  • 新規のダンプ・ファイルを作成するには、次のコマンドを使用します。

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

  • システム内のすべてのダンプ・ファイルをリストするには、次のコマンドを使用します。

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

  • 特定のダンプ・ファイルをシステムから削除するには、次のコマンドを使用します。

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

  • すべてのダンプ・ファイルをシステムから削除するには、次のコマンドを使用します。

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

  • 特定のダンプ・ファイルを取得するには、次のコマンドを使用します。

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

  • ダンプ・ファイルを取得して特定のディレクトリーに保存するには、次のコマンドを使用します。
    openbmctool -U <username> -P <password> -H <BMC IP address or BMC host name> dump retrieve -s <location to save dump file>
    注: 場所を指定しない場合、ファイルは、コマンドが実行される OS の temp ディレクトリーに保存されます。

ローカル BMC ユーザー・アカウントの有効化および無効化

local_users コマンドについてさらに詳しく説明します。

本タスクについて

BMC でのローカル・ユーザー・アカウント (例えば、root) は、local_users サブコマンドを使用して、無効化、照会、および再有効化することができます。
注: ローカル・ユーザーを使用不可にした後は、 OpenBMC ツールを使用してローカル・ユーザーを使用可能にするなど、BMC とさらに対話するために LDAP ユーザーが使用可能になっている必要があります。

手順

  • 現在のローカル・ユーザー・アカウント状況を確認するには、次のコマンドを使用します。

    openbmctool <connection options> local_users queryenabled

  • すべてのローカル・ユーザー・アカウントを無効化するには、次のコマンドを使用します。

    openbmctool <connection options> local_users disableall

  • すべてのローカル・ユーザー・アカウントを有効化するには、次のコマンドを使用します。

    openbmctool <connection options> local_users enableall

rsyslog を使用したリモート・ロギング

リモート・ロギング・コマンドについてさらに詳しく説明します。

本タスクについて

BMC は、 RSYSLOGを使用して、ローカル・ログ (systemd ジャーナルに送られる) をストリーム出力できます。 BMC は、すべてをログに入れて送信します。 あらゆる種類のフィルタリング、および適切なストレージは、rsyslog サーバーで管理する必要があります。

手順

  • rsyslog サーバーをリモート・ロギング用に構成するには、次のコマンドを使用します。

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

    注: IP アドレスとポートはリモート rsyslog サーバー用です。 コマンドを実行すると、リモート rsyslog サーバーは BMC からログを受信し始めます。
  • リモート・ロギングを無効にするには、次のコマンドを使用します。

    openbmctool <connection options> logging remote_logging disable

    注: リモート・ロギングを既存のリモート・サーバーから新しいリモート・サーバーに切り替える前に、リモート・ロギングを無効にしてください。
  • リモート・ロギング構成を表示するには、次のコマンドを使用します。

    openbmctool <connection options> logging remote_logging view

    注: このコマンドは、リモート rsyslog サーバーの IP アドレスとポートを JavaScript Object Notation (JSON) 形式で出力します。
  • REST API ロギングをオンにするには、次のコマンドを使用します。

    openbmctool <connection options> logging rest_api on

  • REST API ロギングをオフにするには、次のコマンドを使用します。

    openbmctool <connection options> logging rest_api off

    注: REST API ロギングは、デフォルトではオフになっています。

証明書管理

証明書管理コマンドについてさらに詳しく説明します。

本タスクについて

既存の証明書および秘密鍵ファイルを、別の (CA 署名付きの場合があります) 証明書および秘密鍵ファイルに交換できます。 サーバー証明書、クライアント証明書、およびルート証明書をインストールできます。

手順

  • HTTPS サーバー証明書を更新するには、次のコマンドを使用します。

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

    注: <File> は、証明書と秘密鍵の両方を含む Privacy Enhanced Mail (PEM) ファイルです。
  • LDAP クライアント証明書を更新するには、次のコマンドを使用します。

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

    注: <File> は、証明書と秘密鍵の両方を含む PEM ファイルです。
  • LDAP ルート証明書を更新するには、次のコマンドを使用します。

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

    注: <File> は、証明書のみを含む PEM ファイルです。
  • HTTPS サーバー証明書を削除するには、次のコマンドを使用します。

    openbmctool <connection options> certificate delete server https

    注: 証明書を削除すると、新しい自己署名証明書が作成され、インストールされます。
  • LDAP クライアント証明書を削除するには、次のコマンドを使用します。

    openbmctool <connection options> certificate delete client ldap

  • LDAP ルート証明書を削除するには、次のコマンドを使用します。

    openbmctool <connection options> certificate delete authority ldap

    注: ルート証明書を削除すると、LDAP サービスが停止する可能性があります。

LDAP 構成

LDAP 構成コマンドについてさらに詳しく説明します。

本タスクについて

BMC では、LDAP はリモート認証に使用されます。 BMC は、リモートのユーザー管理機能をサポートしません。 BMC は、保護 LDAP 構成と無保護 LDAP 構成の両方をサポートします。

手順

  • LDAP 構成 (無保護) を作成するには、次のコマンドを使用します。

    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"

    注: uri パラメーターで完全修飾ドメイン・ネームまたはホスト名を構成するには、BMC でドメイン・ネーム・システム (DNS) サーバーを構成する必要があります。
  • LDAP 構成 (保護) を作成するには、次のコマンドを使用します。

    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"

    注:
    1. 上記の openbmctool.py コマンド・ストリングを実行する際に、以下のエラーが発生することがよくあります。

      xyz.openbmc_project.Common.Error.NoCACertificate

      このエラーは、BMC クライアントが、LDAP サーバー証明書が既知の認証局 (CA) によって署名されていることを確認する必要があることを意味しています。 このエラーを解決するために、管理者が CA 証明書を BMC にアップロードする必要があります。

    2. OpenBMC ツールでは、個々の LDAP 構成プロパティーのアップデートをサポートしません。 1 つのプロパティーを更新するために、管理者が、変更された値で LDAP 構成を再作成する必要があります。
  • LDAP 構成を削除するには、次のコマンドを使用します。

    openbmctool.py <connection options> ldap disable

    注: root ユーザーは、コマンドを実行する前に有効にする必要があります。有効にしないと、BMC にアクセスできません。 すべてのローカル・ユーザー・アカウントを有効にするには、 ローカル・ユーザー・アカウントの有効化と無効化を参照してください。
  • 特権マッピングを追加するには、次のコマンドを使用します。

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

  • 特権マッピングを削除するには、次のコマンドを使用します。

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

  • 特権マッピングをリストするには、次のコマンドを使用します。

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

    LDAP 構成の正常なワークフローは、次の順序です。
    1. DNS サーバーを構成する。
    2. LDAP を構成する。
      1. セキュア LDAP 構成用の CA 証明書を構成する。
      2. ローカル・ユーザーを使用して LDAP 構成を作成する。
    3. ユーザー特権を構成する。
    注:
    1. LDAP 資格情報を使用してログインして、LDAP 資格情報用に特権マッピングを追加していない場合には、以下のエラー・メッセージが表示されます。

      403, 'LDAP group privilege mapping does not exist'. (403: LDAP グループ特権マッピングは存在しません)

      このエラーは、 特権マッピングを追加することによって回避できます。

    2. 以下のエラー・メッセージは、ユーザーが BMC に対して十分な特権を持っていないことを示している可能性があります。

      十分な特権がありません

      このエラーは、 特権マッピングを追加することによって回避できます。

    3. LDAP をセットアップすると、OpenBMC ツール接続のオプションは、LDAP ユーザーとローカル・ユーザーの両方で有効になります。

ネットワーク構成

ネットワーク構成コマンドについてさらに詳しく説明します。

手順

  • DHCP を有効にするには、次のコマンドを使用します。

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

  • DHCP を無効にするには、次のコマンドを使用します。

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

  • ホスト名を取得するには、次のコマンドを使用します。

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

  • ホスト名を設定するには、次のコマンドを使用します。

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

  • ドメイン名を取得するには、次のコマンドを使用します。

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

  • ドメイン名を設定するには、次のコマンドを使用します。

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

  • メディア・アクセス制御 (MAC) アドレスを取得するには、以下のコマンドを使用します。

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

  • MAC アドレスを設定するには、次のコマンドを使用します。

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

  • デフォルト・ゲートウェイを取得するには、次のコマンドを使用します。

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

  • デフォルト・ゲートウェイを設定するには、次のコマンドを使用します。

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

  • 現行のネットワーク構成を表示するには、次のコマンドを使用します。

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

  • ネットワーク時間プロトコル (NTP) を取得するには、次のコマンドを使用します。

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

  • NTP を設定するには、次のコマンドを使用します。

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

  • ドメイン・ネーム・システム (DNS) を取得するには、次のコマンドを使用します。

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

  • DNS を設定するには、次のコマンドを使用します。

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

  • IP アドレスを取得するには、次のコマンドを使用します。

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

  • IP アドレスを設定するには、次のコマンドを使用します。

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

  • IP アドレスを削除するには、次のコマンドを使用します。

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

  • 仮想ローカル・エリア・ネットワーク (VLAN) を有効にするには、次のコマンドを使用します。

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

  • 仮想ローカル・エリア・ネットワーク (VLAN) を無効にするには、次のコマンドを使用します。

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

  • DHCP 構成プロパティーを表示するには、次のコマンドを使用します。

    openbmctool.py <connection options> network viewDHCPConfig

  • DHCP プロパティーを構成するには、次のコマンドを使用します。

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

    注: DNSENABLEDHOSTNAMEENABLEDNTPENABLED、および SENDHOSTNAMEENABLED はブール値 (true または false) です。
  • ネットワーク設定を出荷時のデフォルト値にリセットするには、次のコマンドを使用します。

    openbmctool.py <connection options> network nwReset

    注: リセット設定は、BMC のリブート後に適用されます。