restclient

構文

restclient -uri URI [options]

restclient -type TYPE [options]

restclient -t restclient -time

説明

ローカルのRESTful APIサービスと対話します。restcliコマンドは、このコマンドの内部エイリアスです。

リソースの選択オプション

-uri URI

特定のURIのリソースを要求します。

-type TYPE

特定のベースタイプに一致するリソースを返します（存在する場合）。

アクション

-m METHOD

指定されたメソッドを使用してHTTP要求を送信します。次の値が有効です。POST、GET、PUT、PATCH、またはDELETE

-g [PROPERTY...]

リソース全体を取得するか、またはリソース内の特定のプロパティを取得します。このオプションで-m GETが暗黙指定されます。

-s PROPERTY=VALUE

リソースプロパティの値を指定します。このオプションで-m PATCHが暗黙指定され、要求内容が自動的に生成されます。

-t

すべてのリソースタイプを一覧表示します。

-time

ISO 8601 UTC形式で、RESTful時間を表示します。

一般的なオプション

-i FILE

要求内容にある特定ファイルの内容を送信します。

-o FILE

ASCIIエンコーディングを使用して、JSON応答本体を指定したファイルに書き込みます。リソース全体のGET（-gまたは-m GET）のみ有効であり、それ以外の場合は無視されます。リソースが16 Kbを超える場合は、この引数を使用します。

-c

使用可能な場合、キャッシュされた内容をGET要求に使用します。このオプションにより、パフォーマンスは向上しますが、古いデータが返される可能性があります。

使用法

URIは、先頭にスラッシュを付けずにルートリソースから始める必要があります。たとえば、rest/v1/Systemsです。

TYPEは、TypeName.X.Y.Zという形式の文字列です。ここでX、Y、Zは、それぞれメジャー、マイナー、およびErrataのタイプのバージョンです。一部（またはすべて）のバージョン指定子が省略されると、ワイルドカードによるマッチングが代わりに使用されます。また、マイナーとErrataのバージョンを指定するTYPEは、下位互換性があるため、値がより大きいリソースにも一致します。

PROPERTYでは大文字と小文字が区別され、区切り記号「/」を追加することでネストされたプロパティを選択できます。-sオプションでは、ネストされたプロパティを指定できません。

VALUEは、JSON（オブジェクト、アレイ、nullなど）を表すことができます。空白を保持する場合を除いて、文字列値に引用符は必要ありません。

FILEの内容は、有効なJSONである必要があります。

例

ルートリソースを取得するには、次のように入力します。

Shell> restclient -uri redfish/v1 -g
      

BIOSリソースからAdminNameプロパティを取得するには、次のように入力します。

Shell> restclient -uri redfish/v1/Systems/1/Bios -g Attributes/AdminName
      

iScsiリソースからiSCSIInitiatorNameプロパティを取得するには、次のように入力します。

Shell> restclient -uri redfish/v1/Systems/1/Bios/iScsi -g iSCSIInitiatorName
      

ComputerSystemリソースからシステムROMのバージョンを取得するには、次のように入力します。

Shell> restclient -type ComputerSystem -g Oem/Hpe/Bios/Current
      

BIOSリソースのAdminNameプロパティを設定するには、次のように入力します。

Shell> restclient -uri redfish/v1/Systems/1/Bios/Settings
-s Attributes/AdminName=\"First Last\"
      

iScsiリソースのiSCSIInitiatorNameプロパティを設定するには、次のように入力します。

Shell> restclient -uri redfish/v1/Systems/1/Bios/Settings
-s iSCSIInitiatorName=\"InitiatorName\"
      

POST要求を送信するには、次のように入力します。

Shell> restclient -uri redfish/v1/Systems/1 -m POST -i PostData.json

restclient -uri redfish/v1/Managers/1 -m GET -o Managers1.json