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.
若要清除 gard 記錄以停用硬體，請使用下列指令：
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 或 pnor 是您要向系統閃動的映像檔類型。
附註: 如果您與 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

附註: BMC 必須將 FRU 項目指定為可更換的 FRU。
如果要自動檢閱 FRU 狀態指令，並判斷系統是否受到效能影響，請使用下列指令：

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

附註: 此指令不保證健全的系統，因為可能有與庫存項目無關的系統事件日誌項目。

系統 BMC 重設指令

進一步瞭解系統 BMC 重設指令。

程序

若要從遠端進行 BMC 的暖重設，且沒有 AC 循環，請使用下列指令：

openbmctool -U <username> -P <password> -H <BMC IP address or BMC host name> bmc reset warm
若要從遠端執行 BMC 冷重設，且沒有 AC 循環，請使用下列指令：

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 中。

啟用及停用本端 BMC 使用者帳戶

進一步瞭解 local_users 指令。

關於此作業

可以使用 local_users 次指令來停用、查詢及重新啟用 BMC 上的本端使用者帳戶（例如 root）。

附註: 停用本端使用者之後， LDAP 使用者需要可供與 BMC 進一步互動，包括使用 OpenBMC 工具來啟用本端使用者。

程序

若要檢視現行本端使用者帳戶狀態，請使用下列指令：

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

附註: 這個指令會以 JavaScript Object Notation (JSON) 格式印出遠端 rsyslog 伺服器的 IP 位址和埠。
若要開啟 REST API 記載，請使用下列指令：

openbmctool <connection options> logging rest_api on
若要關閉 REST API 記載，請使用下列指令：

openbmctool <connection options> logging rest_api off

附註: 依預設會關閉 REST API 記載。

憑證管理

進一步瞭解憑證管理指令。

關於此作業

可以將現有的憑證和私密金鑰檔取代為另一個（可能是 CA 簽署）憑證和私密金鑰檔。可以安裝伺服器、用戶端及 root 憑證。

程序

若要更新 HTTP 伺服器憑證，請使用下列指令：

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

附註: <File> 是同時包含憑證及私密金鑰的隱私權加強型郵件 (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 檔案。
若要刪除 HTTP 伺服器憑證，請使用下列指令：

openbmctool <connection options> certificate delete server https

附註: 刪除憑證會建立並安裝新的自簽憑證。
若要刪除 LDAP 用戶端憑證，請使用下列指令：

openbmctool <connection options> certificate delete client ldap
若要刪除 LDAP root 憑證，請使用下列指令：

openbmctool <connection options> certificate delete authority ldap

附註: 刪除主要憑證可能會導致 LDAP 服務中斷。

LDAP 配置

進一步瞭解 LDAP 配置指令。

關於此作業

在 BMC 中，LDAP 用於遠端鑑別。 BMC 不支援遠端使用者管理功能。 BMC 同時支援安全及非安全 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 配置內容更新。若要更新個別內容，管理者必須使用已變更的值重建 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. 配置 CA 憑證以進行安全 LDAP 配置。
  2. 使用本端使用者建立 LDAP 配置。
3. 配置使用者專用權。
附註：
1. 如果使用 LDAP 認證登入，且尚未新增 LDAP 認證的專用權對映，則會收到下列錯誤訊息：
  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>

附註: DNSENABLED、 HOSTNAMEENABLED、 NTPENABLED和 SENDHOSTNAMEENABLED 是布林值 (true 或 false)。
若要將網路設定重設為原廠預設值，請使用下列指令：

openbmctool.py <connection options> network nwReset

附註: 在 BMC 重新開機之後套用重設設定。