Hitachi Command Suite

Compute Systems Manager
REST API リファレンスガイド

3021-9-101

目次

前書き

はじめに

対象読者

マニュアルの構成

マイクロソフト製品の表記について

このマニュアルで使用している記号

1. Compute Systems ManagerのAPIの概要

1.1 Compute Systems ManagerのAPIとは

1.2 Compute Systems ManagerのAPIを使用する前に必要な作業

1.3 Compute Systems ManagerのAPIで操作できるオブジェクト

1.4 URIを使用してオブジェクトを特定する

1.5 サポートするHTTPメソッド

1.6 セキュリティと認証

1.7 HTTPヘッダーの形式

1.8 HTTPボディーの形式

1.9 Compute Systems ManagerのAPIを使って発行できるリクエスト

1.10 URIリクエストエラーへの応答形式

2. ブレードサーバ

2.1 すべてのブレードサーバの情報を取得する

2.2 特定のブレードサーバの情報を取得する

2.3 NICのポート情報を取得する

2.4 HBAのポート情報を取得する

2.5 HVMの物理プロセッサの情報を取得する

2.6 HVMのプロセッサグループの情報を取得する

2.7 HVMのNICポートの情報を取得する

2.8 HVMのFCポートの情報を取得する

2.9 HVMのUSBの情報を取得する

2.10 LPARの情報を取得する

2.11 ブレードサーバの電源をONにする

2.12 ブレードサーバの電源をOFFにする

2.13 ブレードサーバの電源をリセットする

2.14 ブレードサーバのLIDを点灯する

2.15 ブレードサーバのLIDを消灯する

2.16 ブレードサーバの情報を更新する

3. シャーシ

3.1 すべてのシャーシの情報を取得する

3.2 特定のシャーシの情報を取得する

3.3 シャーシを管理対象から外す

3.4 シャーシに搭載されたブレードサーバの情報を取得する

3.5 マネジメントモジュールの情報を取得する

3.6 スイッチモジュールの情報を取得する

3.7 ファンモジュールの情報を取得する

3.8 電源モジュールの情報を取得する

3.9 マネジメントLANモジュールの情報を取得する

3.10 I/Oボードモジュールの情報を取得する

3.11 シャーシのLIDを点灯する

3.12 シャーシのLIDを消灯する

3.13 シャーシの情報を更新する

4. LPAR

4.1 すべてのLPARの情報を取得する

4.2 特定のLPARの情報を取得する

4.3 論理プロセッサの情報を取得する

4.4 仮想NICポートの情報を取得する

4.5 占有NICポートの情報を取得する

4.6 共有FCポートの情報を取得する

4.7 占有FCポートの情報を取得する

4.8 USBの情報を取得する

5. ホスト

5.1 すべてのホストの情報を取得する

5.2 特定のホストの情報を取得する

5.3 ホストを管理対象から外す

5.4 CPUの情報を取得する

5.5 FCネットワークの情報を取得する

5.6 ファイルシステムの情報を取得する

5.7 IPネットワークの情報を取得する

5.8 メモリーの情報を取得する

5.9 BMC設定情報を取得する

5.10 OSの情報を取得する

5.11 PCIスロットの情報を取得する

5.12 ホストの電源をONにする

5.13 OSをシャットダウンしないでホストの電源をOFFにする

5.14 ホストをリブートする

5.15 ホストをシャットダウンする

6. タスク

6.1 タスクの情報を取得する

6.2 特定のタスクの情報を取得する

6.3 サブタスクの情報を取得する

7. 認証情報

7.1 認証情報を取得する

7.2 認証情報を作成する

7.3 特定の認証情報を取得する

7.4 認証情報を編集する

7.5 認証情報を削除する

8. IPアドレス範囲

8.1 すべてのIPアドレス範囲を取得する

8.2 IPアドレス範囲を作成する

8.3 特定のIPアドレス範囲を取得する

8.4 IPアドレス範囲を編集する

8.5 IPアドレス範囲を削除する

8.6 リソースを探索する

9. ユーザー管理

9.1 Compute Systems Managerにログインする

9.2 Compute Systems Managerからログアウトする

10. 管理対象リソース

10.1 複数のIPアドレス範囲を使用して管理対象を探索する

11. バージョン情報

11.1 Compute Systems Managerのバージョン情報を取得する

付録A. Compute Systems ManagerのAPIの使用例

A.1 ブレードサーバの一覧を取得するAPIの使用例

A.2 ブレードサーバの電源をONにするAPIの使用例

付録B. このマニュアルの参考情報

B.1 関連マニュアル

B.2 このマニュアルでの表記

B.3 英略語

B.4 KB（キロバイト）などの単位表記について

All Rights Reserved. Copyright© 2016, Hitachi, Ltd.

前書き

対象製品

Hitachi Compute Systems Manager 8.4.1

適用OSの詳細については「ソフトウェア添付資料」でご確認ください。

輸出時の注意

本製品を輸出される場合には、外国為替及び外国貿易法の規制並びに米国輸出管理規則など外国の輸出関連法規をご確認の上、必要な手続きをお取りください。

なお、不明な場合は、弊社担当営業にお問い合わせください。

商標類

HITACHI，BladeSymphonyは，株式会社 日立製作所の商標または登録商標です。

Internet Explorerは，米国Microsoft Corporationの米国およびその他の国における登録商標または商標です。

Linuxは，Linus Torvalds氏の日本およびその他の国における登録商標または商標です。

MicrosoftおよびHyper-Vは，米国Microsoft Corporationの米国およびその他の国における登録商標または商標です。

OracleとJavaは，Oracle Corporation 及びその子会社，関連会社の米国及びその他の国における登録商標です。

This product includes software developed by the Apache Software Foundation (http://www.apache.org/).

This product includes software developed by IAIK of Graz University of Technology.

RSAおよびBSAFEは，米国EMC コーポレーションの米国およびその他の国における商標または登録商標です。

SUSEは，米国およびその他の国におけるSUSE LLCの登録商標または商標です。

Windowsは，米国Microsoft Corporationの米国およびその他の国における登録商標または商標です。

その他記載の会社名，製品名などは，それぞれの会社の商標もしくは登録商標です。

Hitachi Compute Systems Managerには，日本電気株式会社が著作権を有している部分が含まれています。

Hitachi Compute Systems Managerは，米国EMC コーポレーションのRSA BSAFE®ソフトウェアを搭載しています。

This product includes software developed by Ben Laurie for use in the Apache-SSL HTTP server project.

Portions of this software were developed at the National Center for Supercomputing Applications (NCSA) at the University of Illinois at Urbana-Champaign.

This product includes software developed by the University of California, Berkeley and its contributors.

This software contains code derived from the RSA Data Security Inc. MD5 Message-Digest Algorithm, including various modifications by Spyglass Inc., Carnegie Mellon University, and Bell Communications Research, Inc (Bellcore).

Regular expression support is provided by the PCRE library package, which is open source software, written by Philip Hazel, and copyright by the University of Cambridge, England. The original software is available from ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/

This product includes software developed by Ralf S. Engelschall <rse@engelschall.com> for use in the mod_ssl project (http://www.modssl.org/).

This product includes software developed by Daisuke Okajima and Kohsuke Kawaguchi (http://relaxngcc.sf.net/).

This product includes software developed by the Java Apache Project for use in the Apache JServ servlet engine project (http://java.apache.org/).

This product includes software developed by Andy Clark.

Java is a registered trademark of Oracle and/or its affiliates.

発行

2016年5月 3021-9-101

著作権

All Rights Reserved. Copyright© 2016, Hitachi, Ltd.

はじめに

このマニュアルは，Hitachi Compute Systems ManagerのREST APIの使用方法について説明したものです。

以降，このマニュアルでは，Hitachi Compute Systems ManagerをCompute Systems Managerと呼びます。また，REST APIをAPIと省略して表記することがあります。

はじめにの構成

対象読者

マニュアルの構成

マイクロソフト製品の表記について

このマニュアルで使用している記号

対象読者

このマニュアルは，次の方を対象としています。

Compute Systems ManagerのREST（Representational State Transfer）APIを使用してサーバリソースを操作する方

既存の管理システムやアプリケーションにREST APIを使用した機能を組み込みたい方

また，次のことについて理解していることを前提としています。

Compute Systems Managerを使用したサーバの運用および管理に関する知識

Webサービス，JSON，REST，およびHTTPに関する基本的な知識

ご使用になるプログラミング言語

マニュアルの構成

このマニュアルは，次に示す章と付録から構成されています。

第1章　Compute Systems ManagerのAPIの概要

Compute Systems ManagerのAPIの概要について説明しています。

第2章　ブレードサーバ

ブレードサーバの情報取得・操作に関するAPIについて説明しています。

第3章　シャーシ

シャーシの情報取得・操作に関するAPIについて説明しています。

第4章　LPAR

LPARの情報取得に関するAPIについて説明しています。

第5章　ホスト

ホストの情報取得に関するAPIについて説明しています。

第6章　タスク

タスクの情報取得に関するAPIについて説明しています。

第7章　認証情報

認証情報の取得・更新に関するAPIについて説明しています。

第8章　IPアドレス範囲

IPアドレス範囲の情報取得・操作に関するAPIについて説明しています。

第9章　ユーザー管理

ユーザーのログインに関するAPIについて説明しています。

第10章　管理対象リソース

管理対象の探索に関するAPIについて説明しています。

第11章　バージョン情報

バージョン情報の取得に関するAPIについて説明しています。

付録A　Compute Systems ManagerのAPIの使用例

Compute Systems ManagerのAPIの使用例として，JavaScriptで記述されたサンプルコードについて説明しています。

付録B　このマニュアルの参考情報

このマニュアルを読むに当たっての参考情報について説明しています。

マイクロソフト製品の表記について

このマニュアルでは，マイクロソフト製品の名称を次のように表記しています。

表記
製品名

Hyper-V
Microsoft® Hyper-V®

Internet Explorer
Windows® Internet Explorer®

Windows
次の製品を区別する必要がない場合の表記です。

Microsoft® Windows®7

Windows® 8

Windows® 8.1

Windows® 10

Microsoft® Windows Server® 2008

Microsoft® Windows Server® 2008 R2

Microsoft® Windows Server® 2012

Microsoft® Windows Server® 2012 R2

Microsoft® Windows Vista®

このマニュアルで使用している記号

このマニュアルでは，次に示す記号を使用しています。

記号
意味と例

＜ ＞
（山括弧）
可変値であることを示します。

文法の説明では，次に示す記号を使用します。

記号
意味と例

|
（ストローク）
複数の項目に対して項目間の区切りを示し，「または」の意味を示します。
（例）
「A|B|C」は，「A，B，またはC」を示します。

{ }
（波括弧）
この記号で囲まれている複数の項目の中から，必ず一組の項目を選択します。項目と項目の区切りは「|」で示します。
（例）
「{A|B|C}」は，「A，B，またはC のどれかを必ず指定する」ことを示します。

[ ]
（角括弧）
この記号で囲まれている項目は，任意に指定できます（省略できます）。
（例）
「[A]」は，「必要に応じてA を指定する」ことを示します（必要でない場合は，A を省略できます）。
「[B|C]」は，「必要に応じてB，またはC を指定する」ことを示します（必要でない場合は，B およびC を省略できます）。

...点線
（リーダー）
記述が省略されていることを示します。

1. Compute Systems ManagerのAPIの概要

この章では，Compute Systems Manager のAPIの概要について説明します。

Compute Systems Managerが提供するAPI は，REST（Representational State Transfer）アーキテクチャスタイルに従います。

この章の構成

1.1 Compute Systems ManagerのAPIとは

1.2 Compute Systems ManagerのAPIを使用する前に必要な作業

1.3 Compute Systems ManagerのAPIで操作できるオブジェクト

1.4 URIを使用してオブジェクトを特定する

1.5 サポートするHTTPメソッド

1.6 セキュリティと認証

1.7 HTTPヘッダーの形式

1.8 HTTPボディーの形式

1.9 Compute Systems ManagerのAPIを使って発行できるリクエスト

1.10 URIリクエストエラーへの応答形式

1.1 Compute Systems ManagerのAPIとは

Compute Systems ManagerのAPIを使用すると，ブレードサーバ，シャーシ，LPAR，ホストなどの管理対象リソースの情報取得や変更，操作を実行できます。

Compute Systems ManagerのAPIは，Compute Systems Managerで提供する機能の一部をサポートします。機能ごとのAPIのサポート状況を次の表に示します。APIの機能の詳細については，各APIのトピックを参照してください。

機能
APIのサポート状況
説明

Compute Systems Managerのインストールと設定
×
Compute Systems Managerのインストールおよび管理サーバの設定を行います。

リソースの探索
○
管理対象に追加したいリソース群の認証情報およびIP アドレス を指定することで，条件に合ったリソースを探索します。また，不要になった管理対象リソースを管理対象から外します。
注
管理対象の追加・除外，リソースの削除はAPIではサポートしていません。

管理対象リソースの情報の取得
○
管理対象リソースの情報を取得します。
注
管理対象リソースの情報をCSVファイルに出力する機能は，APIではサポートしていません。

管理対象リソースの電源管理，ランプ操作
○
管理対象リソースの電源ON，電源OFFおよびリセットを行います。また，ブレードやシャーシのLIDを点灯または消灯させます。

ファームウェアの更新
×
シャーシのマネジメントモジュール，またはブレードのファームウェアを更新します。

アラート管理
×
管理対象リソースから受信したアラートを表示します。また，アラートの状態を変更します。

ライセンス管理
×
Compute Systems Managerのライセンスを登録します。

ユーザーグループ，ユーザーの管理
×
Compute Systems Managerのユーザーアカウントを作成・削除します。
また，ユーザーグループへユーザーを登録および削除します。

リソースグループの管理
×
リソースグループへ管理対象リソースを追加・削除します。また，ユーザーグループにリソースグループとロールを割り当てます。

仮想リソースの管理
○
管理対象サーバ上のLPARを認識し，HVMと連携して操作します。

性能監視
×
プロセッサ，メモリー，ネットワーク，およびディスクの使用状況を監視します。

電力監視
×
電力キャッピングの設定および電力量の監視を行います。

N+Mコールドスタンバイ
×
N+Mコールドスタンバイグループの設定，切り替え，および切り戻しを実行します。

デプロイメントマネージャー
×
バックアップしたイメージファイルを使用して，管理対象リソースの環境をほかの管理対象リソースに複製します。また，管理対象リソースのディスクのデータのバックアップとリストアを実行します。

（凡例）

○：サポート

×：非サポート

1.2 Compute Systems ManagerのAPIを使用する前に必要な作業

Compute Systems ManagerのAPIを使用する前の確認事項や，完了しておく作業を説明します。

Compute Systems ManagerのAPIは，Compute Systems Managerをインストールすれば使用できます。APIの使用を開始する前に，次の作業を実施してください。

管理サーバへのアクセス確認
Web ブラウザーから，Compute Systems Managerをインストールしたマシン（管理サーバ）にアクセスしてログインできることを確認してください。

ユーザーおよびユーザーグループの作成，ならびにロールの割り当て（必要に応じて）
Compute Systems ManagerのGUIでユーザーアカウントとユーザーグループを作成してください。 また，ユーザーが属するユーザーグループに，APIで操作する管理対象リソースが属するリソースグループと必要なロールを割り当ててください。必要なロールについては，各APIのトピックを参照してください。

Compute Systems Manager のインストールおよび環境設定については，マニュアル 「Hitachi Command Suite Compute Systems Manager 導入・設定ガイド」を参照してください。ユーザーアカウントやユーザーグループの作成，ロールの割り当てについては，マニュアル「Hitachi Command Suite Compute Systems Manager ユーザーズガイド」を参照してください。

1.3 Compute Systems ManagerのAPIで操作できるオブジェクト

Compute Systems ManagerのAPIを使って操作できるオブジェクトの一覧を次に示します。

オブジェクトタイプ | ドメイン | 説明
Blades | objects | ブレードサーバを対象にしたオブジェクトの情報を取得・管理します。
Chassis | objects | シャーシを対象にしたオブジェクトの情報を取得・管理します。
Lpars | objects | LPARを対象にしたオブジェクトの情報を取得します。
Hosts | objects | ホストを対象にしたオブジェクトの情報を取得・管理します。
Tasks | objects | タスクを対象にしたオブジェクトの情報を取得・管理します。
Credentials | objects | 認証情報を対象にしたオブジェクトの情報を取得・管理します。
IPAddressRanges | objects | IPアドレス範囲を対象にしたオブジェクトの情報を取得・管理します。
User | services | Compute Systems Managerにログインします。または，Compute Systems Managerからログアウトします。
ManagedResource | services | 管理対象を探索し，管理対象リソースとして登録します。
- | version | Compute Systems Managerのバージョン情報を取得します。

1.4 URIを使用してオブジェクトを特定する

Compute Systems ManagerのAPIでは，操作対象のオブジェクトをURIを使用して特定します。

URIの形式

＜protocol＞://＜host＞:＜port＞/ComputeSystemsManager/＜version＞/＜domain＞/＜object-type＞[/＜instanceID＞[/collections/＜collection＞]]

または

＜protocol＞://＜host＞:＜port＞/ComputeSystemsManager/＜version＞/＜domain＞/＜object-type＞[/＜instanceID＞[/actions/＜actionID＞]]

＜protocol＞には，http（非SSL通信の場合）またはhttps（SSL通信の場合）を指定します。

＜host＞には，管理サーバのIPアドレスまたはホスト名 を指定します。

＜port＞には，管理サーバのポート番号を指定します。デフォルトのポート番号は22015（非SSL通信の場合）または22016（SSL通信の場合）です。

ComputeSystemsManagerはCompute Systems ManagerのAPIを表す固定値です。

＜version＞には，Compute Systems ManagerのAPIのバージョンを指定します。指定できる値はv1です。

＜domain＞には，操作対象のオブジェクトが属するドメインを指定します。指定できる値はobjects，services， またはversionです。

＜object-type＞には，操作対象のオブジェクトのオブジェクトタイプを指定します。＜domain＞にversionを指定する場合，この項目は指定不要です。

＜instanceID＞は，操作対象のオブジェクトの識別子です。URIに含められない文字をエスケープするため，エンコードされた値を指定します。エンコードの形式やプレフィクスの規則については各APIのトピックのinstanceIDの説明を参照してください。＜domain＞にservicesまたはversionを指定する場合，この項目は指定不要です。

＜collection＞には，オブジェクトの集合を指定します。

＜action ID＞には，＜instanceID＞で指定したオブジェクトに対する操作を指定します。

指定例

base64urlでエンコードされたinstanceIDを使用してブレードサーバを指定するURIの例を次に示します。

https://172.17.35.70:22016/ComputeSystemsManager/v1/objects/Blades/SGl0YWNoaV8wXzAwMTIzNDU_Nzg-QUJDREVGR0hJSktMTU5PUA==

1.5 サポートするHTTPメソッド

HTTPでは，オブジェクトに対して実行できる操作がメソッドとして定義されています。

Compute Systems ManagerのAPIがサポートするHTTPメソッドを次に示します。

HTTP メソッド
説明

GET
オブジェクトの一覧や情報を取得します。

POST
オブジェクトを新規に作成してコレクションに追加します（例：認証情報の作成）。
次の場合，リクエストボディーでオブジェクトの属性に必要な値を設定する必要があります。

オブジェクトの属性にデフォルト値が設定されていない場合

オブジェクトの属性にデフォルト値が設定されている場合で，値をデフォルト値から変更したいとき

PUT
オブジェクトの属性を変更します。
変更する属性の値はリクエストボディーで指定します。指定を省略した場合，デフォルト値，またはすでに設定されている値が引き継がれて設定されます。詳しくは各APIのトピックを参照して確認してください。

DELETE
オブジェクトを削除します。

非同期処理のAPIとタスクの状態確認について

GET，POST，および DELETEの処理は同期的に実行されます。PUTの処理は，APIによっては非同期に実行されます。非同期処理の APIの場合，処理対象のオブジェクトとは別に，非同期タスクが自動で生成されます。非同期タスクの終了を通知するイベントは発生しないため，次のとおり，タスクの状態をポーリングして確認する必要があります。

管理サーバに対してPUTメソッドを発行します。
同期処理のAPIの場合，処理の実行結果がレスポンスとして返却されます。
非同期処理のAPIの場合，非同期タスクの生成の成否とタスクIDがレスポンスとして返却されます。次の手順を実施してください。

手順1で生成されたタスクのタスクIDを使用して，タスクの情報を取得するためのGETメソッドを発行します。

取得したタスクの状態がCanceled，Completed，SkippedまたはFailedになるまで手順2を定期的に実行します。

1.6 セキュリティと認証

APIを実行するには，ユーザー認証が必要です。Compute Systems Managerは，Basic認証およびHSSOセッションIDによる認証をサポートします。

通信プロトコルはhttpとhttpsをサポートします。セキュリティを向上する場合はhttpsを使用してください。

Basic認証

Basic認証を使用する場合，HTTPリクエストのAuthorizationヘッダーに次の形式でユーザーIDとパスワードを設定します。

Authorization: Basic ＜base64-id-password＞

＜base64-id-password＞には，ユーザーIDとパスワードを半角コロン（:）でつないだ文字列をbase64でエンコードして設定します。

HSSOセッションIDによる認証

HSSOセッションIDによる認証は，シングルサインオンに必要な認証方式です。HSSOセッションIDは，Basic認証を使用して管理サーバにログインすると発行されます。ログイン用のAPIを実行すると，次のとおり，HTTPレスポンスヘッダーとしてHSSOセッションIDが返却されます。

WWW-Authenticate: HSSO ＜セッションID＞

発行されたHSSOセッションIDはクライアントのプログラムで変数に保存してください。

ログインした後に発行するリクエストでは，HTTPクエストのAuthorizationヘッダーに次の形式でHSSOセッ ションIDを設定します。

Authorization: HSSO ＜セッションID＞

HSSOセッションの有効期限と期限の更新

HSSOセッションIDの有効期限は1,000秒です。期限が切れる前に同じセッションIDを使用してリクエストを発行すると，期限は更新されます。期限が切れた場合，管理サーバはセッション情報を破棄します。以降，同じセッションIDを使用して リクエストを発行してもエラー（HTTPステータスコード：401，結果コード：1002）が返ります。 セッションを再度確立するには，ログイン用のAPIを実行してください。

HSSOセッションIDの期限が切れる前に同じクライアントから別のセッションを確立してセッションを更新することもできますが，この方法は推奨しません。セッションが有効な間は同じHSSOセッションIDを使用し，APIのリクエストが期限切れのエラーになった場合だけ新たなHSSOセッションIDの発行を要求するようにしてください。

1.7 HTTPヘッダーの形式

リクエストとレスポンスの送受信時に使用するHTTPヘッダーについて説明します。

Compute Systems ManagerのAPIがサポートするHTTPヘッダーを次に示します。

HTTPリクエストヘッダー

HTTPヘッダー
指定できる値
説明

Accept
application/json
Compute Systems ManagerのAPIでサポートするデータ形式はJSONだけです。

Content-Type
application/json; charset=UTF-8
Compute Systems ManagerのAPIでサポートするデータ形式はJSONだけです。使用できる文字コードはUTF-8だけです。

Authorization
Basic認証の場合：
Basic ＜base64-id-password＞
HSSOセッション認証の場合：
HSSO ＜セッションID＞
ログイン用のAPIではBasic認証だけを使用できます。
ログアウト用のAPIではHSSOセッション認証だけを使用できます。

HTTPレスポンスヘッダー

HTTPヘッダー | 出力される値 | 説明
Content-Type | application/json; charset=UTF-8 | Compute Systems ManagerのAPIでサポートするデータ形式はJSONだけです。レスポンスボディーにデータがない場合，このヘッダーは出力されません。
WWW-Authenticate | HSSO ＜ セッションID＞ | このヘッダーは，ログイン用のAPIのレスポンスだけに含まれます。

1.8 HTTPボディーの形式

リクエストとレスポンスの送受信時に使用するHTTPボディーについて説明します。

HTTPボディーは，JSONの形式で送受信されます。POSTメソッドやPUTメソッドを発行してオブジェクトを作成・変更する際は，JSON の形式でオブジェクトの属性を指定してください。また，GETメソッド，POSTメソッド，PUTメソッドおよびDELETEメソッドを発行した結果のレスポンスもJSONの形式で返却されます。

レスポンスはすべてUTF-8でエンコードされます。また，リクエストもすべてUTF-8でエンコードされている必要があります。入出力データのフォーマットの詳細については，各APIのトピックを参照して ください。

重要

入力データのJSONのオブジェクト内に同じ名称の属性が重複する場合，最後に指定した項目が使用され，重複したほかの項目は無視されます。

1.9 Compute Systems ManagerのAPIを使って発行できるリクエスト

Compute Systems ManagerのAPIを使って発行できるリクエストの一覧をオブジェクトごとに示します。

Blades

リクエスト | メソッド | URI | ロール
すべてのブレードサーバの情報を取得する | GET | /objects/Blades | Admin/Modify/View
特定のブレードサーバの情報を取得する | GET | /objects/Blades/＜instanceID＞ | Admin/Modify/View
NICのポート情報を取得する | GET | /objects/Blades/＜instanceID＞/collections/Nicport | Admin/Modify/View
HBAのポート情報を取得する | GET | /objects/Blades/＜instanceID＞/collections/Hbaport | Admin/Modify/View
HVMの物理プロセッサの情報を取得する | GET | /objects/Blades/＜instanceID＞/collections/LpPhysicalcpu | Admin/Modify/View
HVMのプロセッサグループの情報を取得する | GET | /objects/Blades/＜instanceID＞/collections/LpCpugroup | Admin/Modify/View
HVMのNICポートの情報を取得する | GET | /objects/Blades/＜instanceID＞/collections/LpNicport | Admin/Modify/View
HVMのFCポートの情報を取得する | GET | /objects/Blades/＜instanceID＞/collections/LpFcport | Admin/Modify/View
HVMのUSBの情報を取得する | GET | /objects/Blades/＜instanceID＞/collections/LpUsb | Admin/Modify/View
LPARの情報を取得する | GET | /objects/Blades/＜instanceID＞/collections/Lpar | Admin/Modify/View
ブレードサーバの電源をONにする | PUT | /objects/Blades/＜instanceID＞/actions/Poweron/invoke | Admin/Modify
ブレードサーバの電源をOFFにする | PUT | /objects/Blades/＜instanceID＞/actions/Poweroff/invoke | Admin/Modify
ブレードサーバの電源をリセットする | PUT | /objects/Blades/＜instanceID＞/actions/Reset/invoke | Admin/Modify
ブレードサーバのLIDを点灯する | PUT | /objects/Blades/＜instanceID＞/actions/Lidon/invoke | Admin/Modify
ブレードサーバのLIDを消灯する | PUT | /objects/Blades/＜instanceID＞/actions/Lidoff/invoke | Admin/Modify
ブレードサーバの情報を更新する | PUT | /objects/Blades/＜instanceID＞/actions/Refresh/invoke | Admin/Modify

Chassis

リクエスト | メソッド | URI | ロール
すべてのシャーシの情報を取得する | GET | /objects/Chassis | Admin/Modify/View
特定のシャーシの情報を取得する | GET | /objects/Chassis/＜instanceID＞ | Admin/Modify/View
シャーシを管理対象から外す | DELETE | /objects/Chassis/＜instanceID＞ | All-Resources-Admin
シャーシに搭載されたブレードサーバの情報を取得する | GET | /objects/Chassis/＜instanceID＞/collections/Blade | Admin/Modify/View
マネジメントモジュールの情報を取得する | GET | /objects/Chassis/＜instanceID＞/collections/Managementmodule | Admin/Modify/View
スイッチモジュールの情報を取得する | GET | /objects/Chassis/＜instanceID＞/collections/Switchmodule | Admin/Modify/View
ファンモジュールの情報を取得する | GET | /objects/Chassis/＜instanceID＞/collections/Fanmodule | Admin/Modify/View
電源モジュールの情報を取得する | GET | /objects/Chassis/＜instanceID＞/collections/Powersupplymodule | Admin/Modify/View
マネジメントLANモジュールの情報を取得する | GET | /objects/Chassis/＜instanceID＞/collections/Managementlanmodule | Admin/Modify/View
I/Oボードモジュールの情報を取得する | GET | /objects/Chassis/＜instanceID＞/collections/Iobdmodules | Admin/Modify/View
シャーシのLIDを点灯する | PUT | /objects/Chassis/＜instanceID＞/actions/Lidon/invoke | Admin/Modify
シャーシのLIDを消灯する | PUT | /objects/Chassis/＜instanceID＞/actions/Lidoff/invoke | Admin/Modify
シャーシの情報を更新する | PUT | /objects/Chassis/＜instanceID＞/actions/Refresh/invoke | Admin/Modify

Lpars

リクエスト | メソッド | URI | ロール
すべてのLPARの情報を取得する | GET | /objects/Lpars | Admin/Modify/View
特定のLPARの情報を取得する | GET | /objects/Lpars/＜instanceID＞ | Admin/Modify/View
論理プロセッサの情報を取得する | GET | /objects/Lpars/＜instanceID＞/collections/Logicalcpu | Admin/Modify/View
仮想NICポートの情報を取得する | GET | /objects/Lpars/＜instanceID＞/collections/Virtualnicport | Admin/Modify/View
占有NICポートの情報を取得する | GET | /objects/Lpars/＜instanceID＞/collections/Dedicatednicport | Admin/Modify/View
共有FCポートの情報を取得する | GET | /objects/Lpars/＜instanceID＞/collections/Sharedfcport | Admin/Modify/View
占有FCポートの情報を取得する | GET | /objects/Lpars/＜instanceID＞/collections/Dedicatedfcport | Admin/Modify/View
USBの情報を取得する | GET | /objects/Lpars/＜instanceID＞/collections/Usb | Admin/Modify/View

Hosts

リクエスト | メソッド | URI | ロール
すべてのホストの情報を取得する | GET | /objects/Hosts | Admin/Modify/View
特定のホストの情報を取得する | GET | /objects/Hosts/＜instanceID＞ | Admin/Modify/View
ホストを管理対象から外す | DELETE | /objects/Hosts/＜instanceID＞ | All-Resources-Admin
CPUの情報を取得する | GET | /objects/Hosts/＜instanceID＞/collections/Cpu | Admin/Modify/View
FCネットワークの情報を取得する | GET | /objects/Hosts/＜instanceID＞/collections/Fcnetwork | Admin/Modify/View
ファイルシステムの情報を取得する | GET | /objects/Hosts/＜instanceID＞/collections/Filesystem | Admin/Modify/View
IPネットワークの情報を取得する | GET | /objects/Hosts/＜instanceID＞/collections/Ipnetwork | Admin/Modify/View
メモリーの情報を取得する | GET | /objects/Hosts/＜instanceID＞/collections/Memory | Admin/Modify/View
BMC設定情報を取得する | GET | /objects/Hosts/＜instanceID＞/collections/Miscdevice | Admin/Modify/View
OSの情報を取得する | GET | /objects/Hosts/＜instanceID＞/collections/Os | Admin/Modify/View
PCIスロットの情報を取得する | GET | /objects/Hosts/＜instanceID＞/collections/Pcislot | Admin/Modify/View
ホストの電源をONにする | PUT | /objects/Hosts/＜instanceID＞/actions/Poweron/invoke | Admin/Modify
OSをシャットダウンしないでホストの電源をOFFにする | PUT | /objects/Hosts/＜instanceID＞/actions/Poweroff/invoke | Admin/Modify
ホストをリブートする | PUT | /objects/Hosts/＜instanceID＞/actions/Reboot/invoke | Admin/Modify
ホストをシャットダウンする | PUT | /objects/Hosts/＜instanceID＞/actions/Shutdown/invoke | Admin/Modify

Tasks

リクエスト | メソッド | URI | ロール
タスクの情報を取得する | GET | /objects/Tasks | Admin/Modify/View
特定のタスクの情報を取得する | GET | /objects/Tasks/＜taskID＞ | Admin/Modify/View
サブタスクの情報を取得する | GET | /objects/Tasks/＜taskID＞/collections/Subtask | Admin/Modify/View

Credentials

リクエスト | メソッド | URI | ロール
認証情報を取得する | GET | /objects/Credentials | All-Resources-Admin
認証情報を作成する | POST | /objects/Credentials | All-Resources-Admin
特定の認証情報を取得する | GET | /objects/Credentials/＜instanceID＞ | All-Resources-Admin
認証情報を編集する | PUT | /objects/Credentials/＜instanceID＞ | All-Resources-Admin
認証情報を削除する | DELETE | /objects/Credentials/＜instanceID＞ | All-Resources-Admin

IPAddressRanges

リクエスト | メソッド | URI | ロール
すべてのIPアドレス範囲を取得する | GET | /objects/IPAddressRanges | All-Resources-Admin
IPアドレス範囲を作成する | POST | /objects/IPAddressRanges | All-Resources-Admin
特定のIPアドレス範囲を取得する | GET | /objects/IPAddressRanges/＜instanceID＞ | All-Resources-Admin
IPアドレス範囲を編集する | PUT | /objects/IPAddressRanges/＜instanceID＞ | All-Resources-Admin
IPアドレス範囲を削除する | DELETE | /objects/IPAddressRanges/＜instanceID＞ | All-Resources-Admin
リソースを探索する | PUT | /objects/IPAddressRanges/＜instanceID＞/actions/Discovery/invoke | All-Resources-Admin

User

リクエスト | メソッド | URI | ロール
Compute Systems Managerにログインする | GET | /services/User/actions/login/invoke | Admin/Modify/View/User-Management
Compute Systems Managerからログアウトする | GET | /services/User/actions/logout/invoke | Admin/Modify/View/User-Management

ManagedResource

リクエスト | メソッド | URI | ロール
複数のIPアドレス範囲を使用して管理対象を探索する | PUT | /services/ManagedResource/actions/Discovery/invoke | All-Resources-Admin

version

リクエスト | メソッド | URI | ロール
Compute Systems Managerのバージョン情報を取得する | GET | /version | Admin/Modify/View/User-Management

1.10 URIリクエストエラーへの応答形式

APIのリクエストがエラーになった場合の出力形式について説明します。

リクエストの結果は，HTTPレスポンスヘッダーにHTTPステータスコードとして返却されます。リクエストがエラーとなった場合は，レスポンスボディーに次のエラー情報が返却されます。エラーコードの詳細については，各APIのトピックを参照して ください。

エラー時の出力項目 | 内容
message | エラーメッセージ
resultCode | エラーの結果コード
detailCode | エラーの詳細コード

2. ブレードサーバ

この章では，ブレードサーバの情報取得・操作に関するAPIについて説明します。

この章の構成

2.1 すべてのブレードサーバの情報を取得する

2.2 特定のブレードサーバの情報を取得する

2.3 NICのポート情報を取得する

2.4 HBAのポート情報を取得する

2.5 HVMの物理プロセッサの情報を取得する

2.6 HVMのプロセッサグループの情報を取得する

2.7 HVMのNICポートの情報を取得する

2.8 HVMのFCポートの情報を取得する

2.9 HVMのUSBの情報を取得する

2.10 LPARの情報を取得する

2.11 ブレードサーバの電源をONにする

2.12 ブレードサーバの電源をOFFにする

2.13 ブレードサーバの電源をリセットする

2.14 ブレードサーバのLIDを点灯する

2.15 ブレードサーバのLIDを消灯する

2.16 ブレードサーバの情報を更新する

2.1 すべてのブレードサーバの情報を取得する

APIを実行するユーザの権限で参照できるすべてのブレードサーバの情報を取得します。

ロール

Admin/Modify/View

リクエストライン

GET http://＜host＞:＜port＞/ComputeSystemsManager/v1/objects/Blades

リクエストボディー

リクエストボディーには何も設定しません。

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。

Server

{
   "Server":[{
       "instanceId":"...",
       "chassisUniqueKey":"...",
       "serverUniqueKey":"...",
       "serverSerialNumber":"...",
       "serverProductName":"...",
       "manufacturer":"...",
       "serverProductNumber":"...",
       "serverUuid":"...",
       "partitionNo":...,
       "primarySlot":...,
       "partitionWidth":...,
       "slotWidth":...,
       "bladeNumber":"...",
       "slotNumber":"...",
       "partitionValid":"...",
       "healthStatus":"...",
       "maintenanceMode":"...",
       "serverStatus":"...",
       "lastRefreshed":"...",
       "error":...,
       "warning":...,
       "information":...,
       "cpuName":"...",
       "cpuFrequencyInMHz":...,
       "numberOfCpus":...,
       "numberOfCores":...,
       "cpuCacheSizeInKB":...,
       "memorySizeInMB":...,
       "lidStatus":"...",
       "lidColor":"...",
       "lomDhcpEnable":"...",
       "lomIpAddress":"...",
       "lomSubnetMask":"...",
       "lomDefaultGateway":"...",
       "lomIpAddressV6":"...",
       "lomPrefixLengthV6":"...",
       "lomDefaultGatewayV6":"...",
       "currentFWVersion":"...",
       "currentLOMVersion":"...",
       "currentEFIVersion":"...",
       "updatingFWVersion":"...",
       "updatingLOMVersion":"...",
       "updatingEFIVersion":"...",
       "remoteConsoleUrl":"...",
       "wwnType":"...",
       "macType":"...",
       "osMode":"...",
       "firmwareRestartRequired":"...",
       "nmColdStandby":"...",
       "lpVersion":"...",
       "lpID":"...",
       "lpStatus":"...",
       "lpIpAddress":"...",
       "lpSubnetMask":"...",
       "lpDefaultGateway":"...",
       "lpVNICSystemNo":...,
       "lpSaveChangedConfig":"...",
       "lpVCPort":"...",
       "lpTimeZone":"...",
       "lpTimeSync":"...",
       "lpNTPServer1":"...",
       "lpNTPServer2":"...",
       "lpPreStateAutoAct":"...",
       "lpAutoShutdown":"...",
       "lpErrWatching":"...",
       "lpPhyCpuState":"...",
       "lpMaxSupportedNumOfLPARs":...,
       "lpMaxNumOfRunningLPARs":...,
       "lpAvailableMemoryNode":"...",
       "lpLPARMaxMemorySize":...,
       "lpLPARMemoryStep":...,
       "lpGuestNuma":"...",
       "lpPreBootFirmware":"...",
       "lpSolarisBoot":"...",
       "lpGuestIdleMode":"...",
       "lpLowLatency":"...",
       "lpLicenseHana":"...",
       "lpEpt1GB":"...",
       "lpPerformanceTuningOptions":"...",
       "lpMaxNumOfLogicalCpu":...
   },
   :
   ]
}

属性
データ型
数
説明

instanceId
string
1
URIでブレードサーバを特定する際に使用する識別子。serverUniqueKeyをbase64urlでエンコードした文字列。

chassisUniqueKey
string
1
ブレードサーバが搭載されているシャーシを特定する識別子。

serverUniqueKey
string
1
ブレードサーバを特定する識別子。

serverSerialNumber
string
1
サーバシリアル番号。ブレードサーバを特定するシリアル番号。

serverProductName
string
1
プロダクト名称。

manufacturer
string
1
メーカー名。

serverProductNumber
string
1
製品番号。

serverUuid
string
1
UUID。

partitionNo
integer
1
ブレードが挿入されているスロット番号。フルワイドブレードの場合は占有するスロットのうち小さい番号。SMP構成の場合は，プライマリサーバブレードが挿入されているスロット番号。

primarySlot
integer
1
ブレードが挿入されているスロット番号。フルワイドブレードの場合は占有するスロットのうち小さい番号。SMP構成の場合は，プライマリサーバブレードが挿入されているスロット番号。

partitionWidth
integer
1
ブレードサーバを構成するブレードの数。

slotWidth
integer
0～1
シャーシ内のスロットの数。

bladeNumber
string
0～1
ブレード番号。ブレードサーバを構成するブレードのブレード番号がコンマ区切りで列挙されます。

slotNumber
string
0～1
スロット番号。ブレードサーバを構成するブレードが挿入されているすべてのスロット番号がコンマ区切りで列挙されます。

partitionValid
string
1
ブレードサーバが使用できる状態かどうか。

TRUE：ブレードサーバは使用できます。

FALSE：ブレードサーバは使用できません。

healthStatus
string
1
ブレードサーバの稼働状態。

NORMAL：正常

WARNING：警告

FAIL：障害

UNKNOWN：不明

maintenanceMode
string
1
ブレードサーバの保守モードの設定。

TRUE：保守モードに設定されています。

FALSE：保守モードに設定されていません。

serverStatus
string
1
電源状態。

Running：起動

Stopped：停止。

Unknown：マネジメントモジュールとの通信失敗のため，状態不明。

lastRefreshed
dateTime
1
情報最終更新日時。

error
integer
1
解決していない障害レベルのアラート数。

warning
integer
1
解決していない警告レベルのアラート数。

information
integer
1
解決していない情報レベルのアラート数。

cpuName
string
1
CPU名称。

cpuFrequencyInMHz
float
1
CPUの動作周波数（MHz）。

numberOfCpus
integer
1
CPUの数。

numberOfCores
integer
1
CPUごとのコア数。

cpuCacheSizeInKB
double
1
CPUキャッシュサイズ（KB）。

memorySizeInMB
float
1
メモリーサイズ（MB）。

lidStatus
string
1
LID状態。

ON

OFF

BLINKING

SLOW_BLINKING

FAST_BLINKING

UNKNOWN

lidColor
string
1
LIDの表示色。

BLUE

GREEN

RED

ORANGE

UNKNOWN

lomDhcpEnable
string
1
BMCがDHCPを使用するかどうか。

TRUE

FALSE

lomIpAddress
string
1
BMCのIPアドレス（IPv4）。設定されていない場合，この値は空文字列です。

lomSubnetMask
string
1
BMCのサブネットマスク（IPv4）。設定されていない場合，この値は空文字列です。

lomDefaultGateway
string
1
BMCのデフォルトゲートウェイのIPアドレス（IPv4）。設定されていない場合，この値は空文字列です。

lomIpAddressV6
string
0～1
BMCのIPアドレス（IPv6）。設定されていない場合，この値は空文字列です。

lomPrefixLengthV6
string
0～1
BMCのプレフィックス長（IPv6）。設定されていない場合，この値は空文字列です。

lomDefaultGatewayV6
string
0～1
BMCのデフォルトゲートウェイのIPアドレス（IPv6）。設定されていない場合，この値は空文字列です。

currentFWVersion
string
1
現在動作中のファームウェアのバージョン。

currentLOMVersion
string
1
現在動作中のBMCのバージョン。

currentEFIVersion
string
1
現在動作中のEFIのバージョン。

updatingFWVersion
string
1
ブレードサーバを再起動したあとに動作するファームウェアのバージョン。

updatingLOMVersion
string
1
ブレードサーバを再起動したあとに動作するBMCのバージョン。

updatingEFIVersion
string
1
ブレードサーバを再起動したあとに動作するEFIのバージョン。

remoteConsoleUrl
string
1
リモートコンソールのURL。

wwnType
string
1
WWNの種類。

Original

Additional

Unknown

macType
string
1
MACアドレスの種類。

Original

Additional

Unknown

osMode
string
1
動作モード。

Basic

HVM

Unknown

firmwareRestartRequired
string
1
ファームウェアを更新したあと，反映するためにブレードサーバを再起動する必要があるかどうか。

TRUE：更新したファームウェアを反映させるために，ブレードサーバを再起動する必要があります。

FALSE：更新したファームウェアはすでに反映されています。

nmColdStandby
string
0～1
N+Mコールドスタンバイグループの現用ブレードまたは予備ブレードとして使用できるかどうか。

TRUE：N+Mコールドスタンバイグループの現用ブレードまたは予備ブレードとして使用できます。

FALSE：N+Mコールドスタンバイグループの現用ブレードまたは予備ブレードとして使用できません。

lpVersion
string
0～1
HVMのファームウェアバージョン。

lpID
string
0～1
HVMの識別子。

lpStatus
string
0～1
HVMの状態。

Running

Stopped

Unknown

lpIpAddress
string
0～1
HVMのIPアドレス。

lpSubnetMask
string
0～1
HVMのサブネットマスク。

lpDefaultGateway
string
0～1
HVMのデフォルトゲートウェイIPアドレス。

lpVNICSystemNo
integer
0～1
HVMのVNICシステム番号。論理分割の機能を使用するためのプラグインライセンスが未登録または無効の場合，この属性は生成されません。osModeが'HVM'以外の場合，または，ブレードサーバが論理分割の対象に追加されていない場合，この値は'-1'になります。

lpSaveChangedConfig
string
0～1
HVM起動時の構成情報フォーマットの変換後に，構成情報を自動保存するかどうか。論理分割の機能を使用するためのプラグインライセンスが未登録または無効の場合，この属性は生成されません。osModeが'HVM'以外か，または，ブレードサーバが論理分割の対象に追加されていない場合，この値は空文字列です。

Disable

Enable

lpVCPort
string
0～1
仮想COMコンソールポートのTCPポート番号（1024～65520）。論理分割の機能を使用するためのプラグインライセンスが未登録または無効の場合，この属性は生成されません。osModeが'HVM'以外の場合，または，ブレードサーバが論理分割の対象に追加されていない場合，この値は空文字列です。

lpTimeZone
string
0～1
HVMシステム時刻のタイムゾーン（書式：[+|-]hh:mm）。論理分割の機能を使用するためのプラグインライセンスが未登録または無効の場合，生成されません。osModeが'HVM'以外の場合，または，ブレードサーバが論理分割の対象に追加されていない場合，この値は空文字列です。

lpTimeSync
string
0～1
時刻同期の設定。論理分割の機能を使用するためのプラグインライセンスが未登録または無効の場合，この属性は生成されません。osModeが'HVM'以外の場合，または，ブレードサーバが論理分割の対象に追加されていない場合，この値は空文字列です。

Svp：マネジメントモジュールと時刻同期する

NTP：NTPサーバと時刻同期する

Disable：時刻同期しない

lpNTPServer1
string
0～1
NTPサーバ1のIPアドレス。論理分割の機能を使用するためのプラグインライセンスが未登録または無効の場合，この属性は生成されません。osModeが'HVM'以外の場合，または，ブレードサーバが論理分割の対象に追加されていない場合，この値は空文字列です。

lpNTPServer2
string
0～1
NTPサーバ2のIPアドレス。論理分割の機能を使用するためのプラグインライセンスが未登録または無効の場合，この属性は生成されません。osModeが'HVM'以外の場合，または，ブレードサーバが論理分割の対象に追加されていない場合，この値は空文字列です。

lpPreStateAutoAct
string
0～1
Pre-State Auto Activationの設定。論理分割の機能を使用するためのプラグインライセンスが未登録または無効の場合，この属性は生成されません。osModeが'HVM'以外の場合，または，ブレードサーバが論理分割の対象に追加されていない場合，この値は空文字列です。

Yes

No

lpAutoShutdown
string
0～1
HVM自動シャットダウンの設定。論理分割の機能を使用するためのプラグインライセンスが未登録または無効の場合，この属性は生成されません。osModeが'HVM'以外の場合，または，ブレードサーバが論理分割の対象に追加されていない場合，この値は空文字列です。

Yes

No

lpErrWatching
string
0～1
エラー監視の設定。論理分割の機能を使用するためのプラグインライセンスが未登録または無効の場合，この属性は生成されません。osModeが'HVM'以外の場合，または，ブレードサーバが論理分割の対象に追加されていない場合，この値は空文字列です。

Yes

No

lpPhyCpuState
string
0～1
省電力機能が有効か無効か。論理分割の機能を使用するためのプラグインライセンスが未登録または無効の場合，この属性は生成されません。osModeが'HVM'以外の場合，または，ブレードサーバが論理分割の対象に追加されていない場合，この値は空文字列です。

Enable

Disable

lpMaxSupportedNumOfLPARs
integer
0～1
作成できるLPARの最大数。論理分割の機能を使用するためのプラグインライセンスが未登録または無効の場合，この属性は生成されません。osModeが'HVM'以外の場合，または，ブレードサーバが論理分割の対象に追加されていない場合，この値は空文字列です。

lpMaxNumOfRunningLPARs
integer
0～1
同時に動作できるLPARの最大数。論理分割の機能を使用するためのプラグインライセンスが未登録または無効の場合，この属性は生成されません。osModeが'HVM'以外の場合，または，ブレードサーバが論理分割の対象に追加されていない場合，この値は空文字列です。

lpAvailableMemoryNode
string
0～1
有効なメモリーノード。NUMA設定が有効な場合，有効なメモリーノードをコンマでつないだ文字列（例：0,2,4,8）。論理分割の機能を使用するためのプラグインライセンスが未登録または無効の場合，この属性は生成されません。osModeが'HVM'以外の場合，または，ブレードサーバが論理分割の対象に追加されていない場合，この値は空文字列です。

lpLPARMaxMemorySize
float
0～1
LPARに設定できる最大メモリサイズ

lpLPARMemoryStep
float
0～1
LPARに設定できるメモリ・ステップサイズ

lpGuestNuma
string
0～1
HVMのゲストNUMA設定が有効か無効か。ブレードサーバがBasicモードの場合，またはゲストNUMAが有効か無効かを識別できない場合，この値は空文字列です。

Enable：ゲストNUMA機能が有効。

Disable：ゲストNUMA機能が無効。

lpPreBootFirmware
string
0～1
Pre-bootファームウェアとして64UEFIをサポートしているかどうか。論理分割の機能を使用するためのプラグインライセンスが未登録または無効の場合，この属性は生成されません。osModeが'HVM'以外の場合，または，ブレードサーバが論理分割の対象に追加されていない場合，この値は空文字列です。

Disable

Enable

lpSolarisBoot
string
0～1
OSタイプがSolaris設定をサポートしているかどうか。論理分割の機能を使用するためのプラグインライセンスが未登録または無効の場合，この属性は生成されません。osModeが'HVM'以外の場合，または，ブレードサーバが論理分割の対象に追加されていない場合，この値は空文字列です。

Disable

Enable

lpGuestIdleMode
string
0～1
HVMのゲストアイドルモードの設定が有効か無効か。論理分割の機能を使用するためのプラグインライセンスが未登録または無効の場合，この属性は生成されません。osModeが'HVM'以外の場合，または，ブレードサーバが論理分割の対象に追加されていない場合，この値は空文字列です。

Enable

Disable

lpLowLatency
string
0～1
HVMのLow Latency設定が有効か無効か。論理分割の機能を使用するためのプラグインライセンスが未登録または無効の場合，この属性は生成されません。osModeが'HVM'以外の場合，または，ブレードサーバが論理分割の対象に追加されていない場合，この値は空文字列です。

Enable

Disable

lpLicenseHana
string
0～1
HVMの追加ライセンスが有効か無効か。論理分割の機能を使用するためのプラグインライセンスが未登録または無効の場合，この属性は生成されません。osModeが'HVM'以外の場合，または，ブレードサーバが論理分割の対象に追加されていない場合，この値は空文字列です。

Enable

Disable

lpEpt1GB
string
0～1
HVMのEPT1GB機能が有効か無効か。論理分割の機能を使用するためのプラグインライセンスが未登録または無効の場合，この属性は生成されません。osModeが'HVM'以外の場合，または，ブレードサーバが論理分割の対象に追加されていない場合，この値は空文字列です。

Disable

Enable

lpPerformanceTuningOptions
string
0～1
この属性は未サポートのため，値は参照しないでください。

Disable

Enable

lpMaxNumOfLogicalCpu
integer
0～1
LPARに設定できる論理CPUの最大数。論理分割の機能を使用するためのプラグインライセンスが未登録または無効の場合，この属性は生成されません。osModeが'HVM'以外の場合，または，ブレードサーバが論理分割の対象に追加されていない場合，この値は空文字列です。

リターンコード

HTTPステータスコード | 結果コード | 詳細コード | 説明
200 | - | - | 正常終了。
401 | 1000 | 1 | HTTPヘッダーのAuthorizationが指定されていません。
401 | 1000 | 2 | HTTPヘッダーのAuthorizationの値が不正です（Basic認証，HSSOセッション認証のどちらでもありません）。
401 | 1000 | 3 | HTTPヘッダーのAuthorizationのBasic認証の値が不正です（認証情報のフォーマットが不正です）。
401 | 1000 | 4 | ログインに失敗しました。
401 | 1002 | 1 | ログインセッションが切断されました。または，不正なHSSOトークンが指定されました。
403 | 1003 | 1 | 基本ライセンスが登録されていない，または有効期限を過ぎています。
403 | 2017 | 1 | 管理対象を参照または操作する権限がありません。
405 | - | - | サポートされていないメソッドです。
406 | 2010 | 1 | HTTPヘッダーのAcceptの値が不正です。
415 | - | - | HTTPヘッダーのContent-Typeにサポートされていない形式が指定されています。
500 | - | - | HTTPヘッダーのContent-Typeに不正な値が指定されている，またはそれ以外の内部エラーです。
500 | 1000 | 1 | ログインに失敗しました（内部エラー）。
500 | 3000 | 100 | 内部エラーが発生しました。
503 | 2020 | 1 | 要求の数がAPIの同時最大接続数を超えました。

2.2 特定のブレードサーバの情報を取得する

instanceIDに指定したブレードサーバの情報を取得します。

ロール

Admin/Modify/View

リクエストライン

GET http://＜host＞:＜port＞/ComputeSystemsManager/v1/objects/Blades/＜instanceID＞

instanceID:

serverUniqueKeyをbase64urlでエンコードした文字列。

リクエストボディー

リクエストボディーには何も設定しません。

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。

Server

{
   "Server":[{
       "instanceId":"...",
       "chassisUniqueKey":"...",
       "serverUniqueKey":"...",
       "serverSerialNumber":"...",
       "serverProductName":"...",
       "manufacturer":"...",
       "serverProductNumber":"...",
       "serverUuid":"...",
       "partitionNo":...,
       "primarySlot":...,
       "partitionWidth":...,
       "slotWidth":...,
       "bladeNumber":"...",
       "slotNumber":"...",
       "partitionValid":"...",
       "healthStatus":"...",
       "maintenanceMode":"...",
       "serverStatus":"...",
       "lastRefreshed":"...",
       "error":...,
       "warning":...,
       "information":...,
       "cpuName":"...",
       "cpuFrequencyInMHz":...,
       "numberOfCpus":...,
       "numberOfCores":...,
       "cpuCacheSizeInKB":...,
       "memorySizeInMB":...,
       "lidStatus":"...",
       "lidColor":"...",
       "lomDhcpEnable":"...",
       "lomIpAddress":"...",
       "lomSubnetMask":"...",
       "lomDefaultGateway":"...",
       "lomIpAddressV6":"...",
       "lomPrefixLengthV6":"...",
       "lomDefaultGatewayV6":"...",
       "currentFWVersion":"...",
       "currentLOMVersion":"...",
       "currentEFIVersion":"...",
       "updatingFWVersion":"...",
       "updatingLOMVersion":"...",
       "updatingEFIVersion":"...",
       "remoteConsoleUrl":"...",
       "wwnType":"...",
       "macType":"...",
       "osMode":"...",
       "firmwareRestartRequired":"...",
       "nmColdStandby":"...",
       "lpVersion":"...",
       "lpID":"...",
       "lpStatus":"...",
       "lpIpAddress":"...",
       "lpSubnetMask":"...",
       "lpDefaultGateway":"...",
       "lpVNICSystemNo":...,
       "lpSaveChangedConfig":"...",
       "lpVCPort":"...",
       "lpTimeZone":"...",
       "lpTimeSync":"...",
       "lpNTPServer1":"...",
       "lpNTPServer2":"...",
       "lpPreStateAutoAct":"...",
       "lpAutoShutdown":"...",
       "lpErrWatching":"...",
       "lpPhyCpuState":"...",
       "lpMaxSupportedNumOfLPARs":...,
       "lpMaxNumOfRunningLPARs":...,
       "lpAvailableMemoryNode":"...",
       "lpLPARMaxMemorySize":...,
       "lpLPARMemoryStep":...,
       "lpGuestNuma":"...",
       "lpPreBootFirmware":"...",
       "lpSolarisBoot":"...",
       "lpGuestIdleMode":"...",
       "lpLowLatency":"...",
       "lpLicenseHana":"...",
       "lpEpt1GB":"...",
       "lpPerformanceTuningOptions":"...",
       "lpMaxNumOfLogicalCpu":...
   }]
}

属性
データ型
数
説明

instanceId
string
1
URIでブレードサーバを特定する際に使用する識別子。serverUniqueKeyをbase64urlでエンコードした文字列。

chassisUniqueKey
string
1
ブレードサーバが搭載されているシャーシを特定する識別子。

serverUniqueKey
string
1
ブレードサーバを特定する識別子。

serverSerialNumber
string
1
サーバシリアル番号。ブレードサーバを特定するシリアル番号。

serverProductName
string
1
プロダクト名称。

manufacturer
string
1
メーカー名。

serverProductNumber
string
1
製品番号。

serverUuid
string
1
UUID。

partitionNo
integer
1
ブレードが挿入されているスロット番号。フルワイドブレードの場合は占有するスロットのうち小さい番号。SMP構成の場合は，プライマリサーバブレードが挿入されているスロット番号。

primarySlot
integer
1
ブレードが挿入されているスロット番号。フルワイドブレードの場合は占有するスロットのうち小さい番号。SMP構成の場合は，プライマリサーバブレードが挿入されているスロット番号。

partitionWidth
integer
1
ブレードサーバを構成するブレードの数。

slotWidth
integer
0～1
シャーシ内のスロットの数。

bladeNumber
string
0～1
ブレード番号。ブレードサーバを構成するブレードのブレード番号がコンマ区切りで列挙されます。

slotNumber
string
0～1
スロット番号。ブレードサーバを構成するブレードが挿入されているすべてのスロット番号がコンマ区切りで列挙されます。

partitionValid
string
1
ブレードサーバが使用できる状態かどうか。

TRUE：ブレードサーバは使用できます。

FALSE：ブレードサーバは使用できません。

healthStatus
string
1
ブレードサーバの稼働状態。

NORMAL：正常

WARNING：警告

FAIL：障害

UNKNOWN：不明

maintenanceMode
string
1
ブレードサーバの保守モードの設定。

TRUE：保守モードに設定されています。

FALSE：保守モードに設定されていません。

serverStatus
string
1
電源状態。

Running：起動

Stopped：停止。

Unknown：マネジメントモジュールとの通信失敗のため，状態不明。

lastRefreshed
dateTime
1
情報最終更新日時。

error
integer
1
解決していない障害レベルのアラート数。

warning
integer
1
解決していない警告レベルのアラート数。

information
integer
1
解決していない情報レベルのアラート数。

cpuName
string
1
CPU名称。

cpuFrequencyInMHz
float
1
CPUの動作周波数（MHz）。

numberOfCpus
integer
1
CPUの数。

numberOfCores
integer
1
CPUごとのコア数。

cpuCacheSizeInKB
double
1
CPUキャッシュサイズ（KB）。

memorySizeInMB
float
1
メモリーサイズ（MB）。

lidStatus
string
1
LID状態。

ON

OFF

BLINKING

SLOW_BLINKING

FAST_BLINKING

UNKNOWN

lidColor
string
1
LIDの表示色。

BLUE

GREEN

RED

ORANGE

UNKNOWN

lomDhcpEnable
string
1
BMCがDHCPを使用するかどうか。

TRUE

FALSE

lomIpAddress
string
1
BMCのIPアドレス（IPv4）。設定されていない場合，この値は空文字列です。

lomSubnetMask
string
1
BMCのサブネットマスク（IPv4）。設定されていない場合，この値は空文字列です。

lomDefaultGateway
string
1
BMCのデフォルトゲートウェイのIPアドレス（IPv4）。設定されていない場合，この値は空文字列です。

lomIpAddressV6
string
0～1
BMCのIPアドレス（IPv6）。設定されていない場合，この値は空文字列です。

lomPrefixLengthV6
string
0～1
BMCのプレフィックス長（IPv6）。設定されていない場合，この値は空文字列です。

lomDefaultGatewayV6
string
0～1
BMCのデフォルトゲートウェイのIPアドレス（IPv6）。設定されていない場合，この値は空文字列です。

currentFWVersion
string
1
現在動作中のファームウェアのバージョン。

currentLOMVersion
string
1
現在動作中のBMCのバージョン。

currentEFIVersion
string
1
現在動作中のEFIのバージョン。

updatingFWVersion
string
1
ブレードサーバを再起動したあとに動作するファームウェアのバージョン。

updatingLOMVersion
string
1
ブレードサーバを再起動したあとに動作するBMCのバージョン。

updatingEFIVersion
string
1
ブレードサーバを再起動したあとに動作するEFIのバージョン。

remoteConsoleUrl
string
1
リモートコンソールのURL。

wwnType
string
1
WWNの種類。

Original

Additional

Unknown

macType
string
1
MACアドレスの種類。

Original

Additional

Unknown

osMode
string
1
動作モード。

Basic

HVM

Unknown

firmwareRestartRequired
string
1
ファームウェアを更新したあと，反映するためにブレードサーバを再起動する必要があるかどうか。

TRUE：更新したファームウェアを反映させるために，ブレードサーバを再起動する必要があります。

FALSE：更新したファームウェアはすでに反映されています。

nmColdStandby
string
0～1
N+Mコールドスタンバイグループの現用ブレードまたは予備ブレードとして使用できるかどうか。

TRUE：N+Mコールドスタンバイグループの現用ブレードまたは予備ブレードとして使用できます。

FALSE：N+Mコールドスタンバイグループの現用ブレードまたは予備ブレードとして使用できません。

lpVersion
string
0～1
HVMのファームウェアバージョン。

lpID
string
0～1
HVMの識別子。

lpStatus
string
0～1
HVMの状態。

Running

Stopped

Unknown

lpIpAddress
string
0～1
HVMのIPアドレス。

lpSubnetMask
string
0～1
HVMのサブネットマスク。

lpDefaultGateway
string
0～1
HVMのデフォルトゲートウェイIPアドレス。

lpVNICSystemNo
integer
0～1
HVMのVNICシステム番号。論理分割の機能を使用するためのプラグインライセンスが未登録または無効の場合，この属性は生成されません。osModeが'HVM'以外の場合，または，ブレードサーバが論理分割の対象に追加されていない場合，この値は'-1'になります。

lpSaveChangedConfig
string
0～1
HVM起動時の構成情報フォーマットの変換後に，構成情報を自動保存するかどうか。論理分割の機能を使用するためのプラグインライセンスが未登録または無効の場合，この属性は生成されません。osModeが'HVM'以外か，または，ブレードサーバが論理分割の対象に追加されていない場合，この値は空文字列です。

Disable

Enable

lpVCPort
string
0～1
仮想COMコンソールポートのTCPポート番号（1024～65520）。論理分割の機能を使用するためのプラグインライセンスが未登録または無効の場合，この属性は生成されません。osModeが'HVM'以外の場合，または，ブレードサーバが論理分割の対象に追加されていない場合，この値は空文字列です。

lpTimeZone
string
0～1
HVMシステム時刻のタイムゾーン（書式：[+|-]hh:mm）。論理分割の機能を使用するためのプラグインライセンスが未登録または無効の場合，生成されません。osModeが'HVM'以外の場合，または，ブレードサーバが論理分割の対象に追加されていない場合，この値は空文字列です。

lpTimeSync
string
0～1
時刻同期の設定。論理分割の機能を使用するためのプラグインライセンスが未登録または無効の場合，この属性は生成されません。osModeが'HVM'以外の場合，または，ブレードサーバが論理分割の対象に追加されていない場合，この値は空文字列です。

Svp：マネジメントモジュールと時刻同期する

NTP：NTPサーバと時刻同期する

Disable：時刻同期しない

lpNTPServer1
string
0～1
NTPサーバ1のIPアドレス。論理分割の機能を使用するためのプラグインライセンスが未登録または無効の場合，この属性は生成されません。osModeが'HVM'以外の場合，または，ブレードサーバが論理分割の対象に追加されていない場合，この値は空文字列です。

lpNTPServer2
string
0～1
NTPサーバ2のIPアドレス。論理分割の機能を使用するためのプラグインライセンスが未登録または無効の場合，この属性は生成されません。osModeが'HVM'以外の場合，または，ブレードサーバが論理分割の対象に追加されていない場合，この値は空文字列です。

lpPreStateAutoAct
string
0～1
Pre-State Auto Activationの設定。論理分割の機能を使用するためのプラグインライセンスが未登録または無効の場合，この属性は生成されません。osModeが'HVM'以外の場合，または，ブレードサーバが論理分割の対象に追加されていない場合，この値は空文字列です。

Yes

No

lpAutoShutdown
string
0～1
HVM自動シャットダウンの設定。論理分割の機能を使用するためのプラグインライセンスが未登録または無効の場合，この属性は生成されません。osModeが'HVM'以外の場合，または，ブレードサーバが論理分割の対象に追加されていない場合，この値は空文字列です。

Yes

No

lpErrWatching
string
0～1
エラー監視の設定。論理分割の機能を使用するためのプラグインライセンスが未登録または無効の場合，この属性は生成されません。osModeが'HVM'以外の場合，または，ブレードサーバが論理分割の対象に追加されていない場合，この値は空文字列です。

Yes

No

lpPhyCpuState
string
0～1
省電力機能が有効か無効か。論理分割の機能を使用するためのプラグインライセンスが未登録または無効の場合，この属性は生成されません。osModeが'HVM'以外の場合，または，ブレードサーバが論理分割の対象に追加されていない場合，この値は空文字列です。

Enable

Disable

lpMaxSupportedNumOfLPARs
integer
0～1
作成できるLPARの最大数。論理分割の機能を使用するためのプラグインライセンスが未登録または無効の場合，この属性は生成されません。osModeが'HVM'以外の場合，または，ブレードサーバが論理分割の対象に追加されていない場合，この値は空文字列です。

lpMaxNumOfRunningLPARs
integer
0～1
同時に動作できるLPARの最大数。論理分割の機能を使用するためのプラグインライセンスが未登録または無効の場合，この属性は生成されません。osModeが'HVM'以外の場合，または，ブレードサーバが論理分割の対象に追加されていない場合，この値は空文字列です。

lpAvailableMemoryNode
string
0～1
有効なメモリーノード。NUMA設定が有効な場合，有効なメモリーノードをコンマでつないだ文字列（例：0,2,4,8）。論理分割の機能を使用するためのプラグインライセンスが未登録または無効の場合，この属性は生成されません。osModeが'HVM'以外の場合，または，ブレードサーバが論理分割の対象に追加されていない場合，この値は空文字列です。

lpLPARMaxMemorySize
float
0～1
LPARに設定できる最大メモリサイズ

lpLPARMemoryStep
float
0～1
LPARに設定できるメモリ・ステップサイズ

lpGuestNuma
string
0～1
HVMのゲストNUMA設定が有効か無効か。ブレードサーバがBasicモードの場合，またはゲストNUMAが有効か無効かを識別できない場合，この値は空文字列です。

Enable：ゲストNUMA機能が有効。

Disable：ゲストNUMA機能が無効。

lpPreBootFirmware
string
0～1
Pre-bootファームウェアとして64UEFIをサポートしているかどうか。論理分割の機能を使用するためのプラグインライセンスが未登録または無効の場合，この属性は生成されません。osModeが'HVM'以外の場合，または，ブレードサーバが論理分割の対象に追加されていない場合，この値は空文字列です。

Disable

Enable

lpSolarisBoot
string
0～1
OSタイプがSolaris設定をサポートしているかどうか。論理分割の機能を使用するためのプラグインライセンスが未登録または無効の場合，この属性は生成されません。osModeが'HVM'以外の場合，または，ブレードサーバが論理分割の対象に追加されていない場合，この値は空文字列です。

Disable

Enable

lpGuestIdleMode
string
0～1
HVMのゲストアイドルモードの設定が有効か無効か。論理分割の機能を使用するためのプラグインライセンスが未登録または無効の場合，この属性は生成されません。osModeが'HVM'以外の場合，または，ブレードサーバが論理分割の対象に追加されていない場合，この値は空文字列です。

Enable

Disable

lpLowLatency
string
0～1
HVMのLow Latency設定が有効か無効か。論理分割の機能を使用するためのプラグインライセンスが未登録または無効の場合，この属性は生成されません。osModeが'HVM'以外の場合，または，ブレードサーバが論理分割の対象に追加されていない場合，この値は空文字列です。

Enable

Disable

lpLicenseHana
string
0～1
HVMの追加ライセンスが有効か無効か。論理分割の機能を使用するためのプラグインライセンスが未登録または無効の場合，この属性は生成されません。osModeが'HVM'以外の場合，または，ブレードサーバが論理分割の対象に追加されていない場合，この値は空文字列です。

Enable

Disable

lpEpt1GB
string
0～1
HVMのEPT1GB機能が有効か無効か。論理分割の機能を使用するためのプラグインライセンスが未登録または無効の場合，この属性は生成されません。osModeが'HVM'以外の場合，または，ブレードサーバが論理分割の対象に追加されていない場合，この値は空文字列です。

Disable

Enable

lpPerformanceTuningOptions
string
0～1
この属性は未サポートのため，値は参照しないでください。

Disable

Enable

lpMaxNumOfLogicalCpu
integer
0～1
LPARに設定できる論理CPUの最大数。論理分割の機能を使用するためのプラグインライセンスが未登録または無効の場合，この属性は生成されません。osModeが'HVM'以外の場合，または，ブレードサーバが論理分割の対象に追加されていない場合，この値は空文字列です。

リターンコード

HTTPステータスコード | 結果コード | 詳細コード | 説明
200 | - | - | 正常終了。
204 | - | - | 指定したinstanceIDまたはcollectionはありません。
401 | 1000 | 1 | HTTPヘッダーのAuthorizationが指定されていません。
401 | 1000 | 2 | HTTPヘッダーのAuthorizationの値が不正です（Basic認証，HSSOセッション認証のどちらでもありません）。
401 | 1000 | 3 | HTTPヘッダーのAuthorizationのBasic認証の値が不正です（認証情報のフォーマットが不正です）。
401 | 1000 | 4 | ログインに失敗しました。
401 | 1002 | 1 | ログインセッションが切断されました。または，不正なHSSOトークンが指定されました。
403 | 1003 | 1 | 基本ライセンスが登録されていない，または有効期限を過ぎています。
403 | 2017 | 1 | 管理対象を参照または操作する権限がありません。
405 | - | - | サポートされていないメソッドです。
406 | 2010 | 1 | HTTPヘッダーのAcceptの値が不正です。
415 | - | - | HTTPヘッダーのContent-Typeにサポートされていない形式が指定されています。
500 | - | - | HTTPヘッダーのContent-Typeに不正な値が指定されている，またはそれ以外の内部エラーです。
500 | 1000 | 1 | ログインに失敗しました（内部エラー）。
500 | 3000 | 100 | 内部エラーが発生しました。
503 | 2020 | 1 | 要求の数がAPIの同時最大接続数を超えました。

2.3 NICのポート情報を取得する

instanceIDに指定したブレードサーバのNICのポート情報を取得します。

ロール

Admin/Modify/View

リクエストライン

GET http://＜host＞:＜port＞/ComputeSystemsManager/v1/objects/Blades/＜instanceID＞/collections/Nicport

instanceID:

serverUniqueKeyをbase64urlでエンコードした文字列。

リクエストボディー

リクエストボディーには何も設定しません。

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。

ServerNicPort

{
   "ServerNicPort":[{
       "serverUniqueKey":"...",
       "serverBladeNumber":...,
       "cardSlotNumber":...,
       "cardType":"...",
       "cardName":"...",
       "busNumber":...,
       "deviceNumber":...,
       "functionNumber":...,
       "controllerNumber":...,
       "portNumber":...,
       "macAddress":"...",
       "duplication":"...",
       "changeFromDefault":"..."
   },
   :
   ]
}

属性
データ型
数
説明

serverUniqueKey
string
1
NICポートが搭載されているブレードサーバを特定する識別子。

serverBladeNumber
integer
1
NIC ポートが搭載されているブレードの番号。

cardSlotNumber
integer
1
カードのスロット番号。

cardType
string
1
カード種別。

MEZZANINE

PCI

ONBOARD

PCI_IOEU

PCI_IOBD

PCI_EXPANSION_BLADE

cardName
string
1
カードの名前。
例：'Emulex 10Gb 4-port converged network mezzanine card'

busNumber
integer
1
バス番号。

deviceNumber
integer
1
デバイス番号。

functionNumber
integer
1
ファンクション番号。

controllerNumber
integer
1
コントローラー番号。

portNumber
integer
1
ポート番号。

macAddress
string
1
MACアドレス（書式：XX:XX:XX:XX:XX:XX）。

duplication
string
1
MACアドレスが重複しているかどうか

TRUE

FALSE

changeFromDefault
string
1
MACアドレスが初期値から変更されたかどうか。

TRUE

FALSE

リターンコード

HTTPステータスコード | 結果コード | 詳細コード | 説明
200 | - | - | 正常終了。
204 | - | - | 指定したinstanceIDまたはcollectionはありません。
401 | 1000 | 1 | HTTPヘッダーのAuthorizationが指定されていません。
401 | 1000 | 2 | HTTPヘッダーのAuthorizationの値が不正です（Basic認証，HSSOセッション認証のどちらでもありません）。
401 | 1000 | 3 | HTTPヘッダーのAuthorizationのBasic認証の値が不正です（認証情報のフォーマットが不正です）。
401 | 1000 | 4 | ログインに失敗しました。
401 | 1002 | 1 | ログインセッションが切断されました。または，不正なHSSOトークンが指定されました。
403 | 1003 | 1 | 基本ライセンスが登録されていない，または有効期限を過ぎています。
403 | 2017 | 1 | 管理対象を参照または操作する権限がありません。
405 | - | - | サポートされていないメソッドです。
406 | 2010 | 1 | HTTPヘッダーのAcceptの値が不正です。
415 | - | - | HTTPヘッダーのContent-Typeにサポートされていない形式が指定されています。
500 | - | - | HTTPヘッダーのContent-Typeに不正な値が指定されている，またはそれ以外の内部エラーです。
500 | 1000 | 1 | ログインに失敗しました（内部エラー）。
500 | 3000 | 100 | 内部エラーが発生しました。
503 | 2020 | 1 | 要求の数がAPIの同時最大接続数を超えました。

2.4 HBAのポート情報を取得する

instanceIDに指定したブレードサーバのHBAのポート情報を取得します。

ロール

Admin/Modify/View

リクエストライン

GET http://＜host＞:＜port＞/ComputeSystemsManager/v1/objects/Blades/＜instanceID＞/collections/Hbaport

instanceID:

serverUniqueKeyをbase64urlでエンコードした文字列。

リクエストボディー

リクエストボディーには何も設定しません。

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。

ServerHbaPort

{
   "ServerHbaPort":[{
       "serverUniqueKey":"...",
       "serverBladeNumber":...,
       "cardSlotNumber":...,
       "cardType":"...",
       "cardName":"...",
       "busNumber":...,
       "deviceNumber":...,
       "functionNumber":...,
       "portNumber":...,
       "wwpn":"...",
       "wwpnDuplication":"...",
       "wwpnChangeFromDefault":"...",
       "wwnn":"...",
       "wwnnDuplication":"...",
       "wwnnChangeFromDefault":"..."
   },
   :
   ]
}

属性
データ型
数
説明

serverUniqueKey
string
1
HBAポートが搭載されているブレードサーバを特定する識別子。

serverBladeNumber
integer
1
HBA ポートが搭載されているブレードの番号。

cardSlotNumber
integer
1
カードのスロット番号。

cardType
string
1
カードの種類。

MEZZANINE

PCI

ONBOARD

PCI_IOEU

PCI_IOBD

PCI_EXPANSION_BLADE

cardName
string
1
カードの名前。

busNumber
integer
1
バス番号。

deviceNumber
integer
1
デバイス番号。

functionNumber
integer
1
ファンクション番号。

portNumber
integer
1
ポート番号。

wwpn
string
1
WWPN。

wwpnDuplication
string
1
WWPNが重複しているかどうか。

TRUE

FALSE

wwpnChangeFromDefault
string
1
WWPNが初期値から変更されているかどうか。

TRUE

FALSE

wwnn
string
1
WWNN。

wwnnDuplication
string
1
WWNNが重複しているかどうかを示します。

TRUE

FALSE

wwnnChangeFromDefault
string
1
WWNNが初期値から変更されているかどうかを示します。

TRUE

FALSE

リターンコード

HTTPステータスコード | 結果コード | 詳細コード | 説明
200 | - | - | 正常終了。
204 | - | - | 指定したinstanceIDまたはcollectionはありません。
401 | 1000 | 1 | HTTPヘッダーのAuthorizationが指定されていません。
401 | 1000 | 2 | HTTPヘッダーのAuthorizationの値が不正です（Basic認証，HSSOセッション認証のどちらでもありません）。
401 | 1000 | 3 | HTTPヘッダーのAuthorizationのBasic認証の値が不正です（認証情報のフォーマットが不正です）。
401 | 1000 | 4 | ログインに失敗しました。
401 | 1002 | 1 | ログインセッションが切断されました。または，不正なHSSOトークンが指定されました。
403 | 1003 | 1 | 基本ライセンスが登録されていない，または有効期限を過ぎています。
403 | 2017 | 1 | 管理対象を参照または操作する権限がありません。
405 | - | - | サポートされていないメソッドです。
406 | 2010 | 1 | HTTPヘッダーのAcceptの値が不正です。
415 | - | - | HTTPヘッダーのContent-Typeにサポートされていない形式が指定されています。
500 | - | - | HTTPヘッダーのContent-Typeに不正な値が指定されている，またはそれ以外の内部エラーです。
500 | 1000 | 1 | ログインに失敗しました（内部エラー）。
500 | 3000 | 100 | 内部エラーが発生しました。
503 | 2020 | 1 | 要求の数がAPIの同時最大接続数を超えました。

2.5 HVMの物理プロセッサの情報を取得する

instanceIDに指定したブレードサーバ上のHVMの，物理プロセッサの情報を取得します。

ロール

Admin/Modify/View

リクエストライン

GET http://＜host＞:＜port＞/ComputeSystemsManager/v1/objects/Blades/＜instanceID＞/collections/LpPhysicalcpu

instanceID:

serverUniqueKeyをbase64urlでエンコードした文字列。

リクエストボディー

リクエストボディーには何も設定しません。

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。

ServerLpPhysicalCpu

{
   "ServerLpPhysicalCpu":[{
       "serverUniqueKey":"...",
       "serverBladeNumber":...,
       "cpuNo":...,
       "socketNo":...,
       "coreNo":...,
       "threadNo":...,
       "coreStatus":"...",
       "cpuStatus":"...",
       "cpuGroupNo":...,
       "allocation":"...",
       "nodeNo":"..."
   },
   :
   ]
}

属性
データ型
数
説明

serverUniqueKey
string
1
物理プロセッサが搭載されているブレードサーバを特定する識別子。

serverBladeNumber
integer
1
物理プロセッサが搭載されているブレードの番号。ブレードサーバとして使用していない場合は'-1'。

cpuNo
integer
1
CPU番号。

socketNo
integer
1
ソケット番号。

coreNo
integer
1
コア番号。

threadNo
integer
1
スレッド番号。

coreStatus
string
1
プロセッサコアの状態。

Activated：通常動作状態。

Deactivated：キャパシティオンデマンド用の予備状態。

Warning：回復可能障害回数がしきい値を超えた状態。

cpuStatus
string
1
物理プロセッサの状態。

High：最高速度で動作できる状態。

MXX：中間速度で動作できる状態。M01，M02，M03，...の順に速度が遅くなります。

Low：最低速度で動作できる状態。

Failure：FAULT状態。

Error：ERROR状態。

Offline：OFFLINE状態。

cpuGroupNo
integer
1
プロセッサグループ番号。

allocation
string
1
CPUコアの割り当てモード。

Share：共有モード。

Dedicate：占有モード。

nodeNo
string
1
物理プロセッサが属するNUMAノードの番号。NUMAノードをサポートしていない場合，空文字列。

リターンコード

HTTPステータスコード | 結果コード | 詳細コード | 説明
200 | - | - | 正常終了。
204 | - | - | 指定したinstanceIDまたはcollectionはありません。
401 | 1000 | 1 | HTTPヘッダーのAuthorizationが指定されていません。
401 | 1000 | 2 | HTTPヘッダーのAuthorizationの値が不正です（Basic認証，HSSOセッション認証のどちらでもありません）。
401 | 1000 | 3 | HTTPヘッダーのAuthorizationのBasic認証の値が不正です（認証情報のフォーマットが不正です）。
401 | 1000 | 4 | ログインに失敗しました。
401 | 1002 | 1 | ログインセッションが切断されました。または，不正なHSSOトークンが指定されました。
403 | 1003 | 1 | 基本ライセンスが登録されていない，または有効期限を過ぎています。
403 | 2017 | 1 | 管理対象を参照または操作する権限がありません。
405 | - | - | サポートされていないメソッドです。
406 | 2010 | 1 | HTTPヘッダーのAcceptの値が不正です。
415 | - | - | HTTPヘッダーのContent-Typeにサポートされていない形式が指定されています。
500 | - | - | HTTPヘッダーのContent-Typeに不正な値が指定されている，またはそれ以外の内部エラーです。
500 | 1000 | 1 | ログインに失敗しました（内部エラー）。
500 | 3000 | 100 | 内部エラーが発生しました。
503 | 2020 | 1 | 要求の数がAPIの同時最大接続数を超えました。

2.6 HVMのプロセッサグループの情報を取得する

instanceIDに指定したブレードサーバ上のHVMの，プロセッサグループの情報を取得します。

ロール

Admin/Modify/View

リクエストライン

GET http://＜host＞:＜port＞/ComputeSystemsManager/v1/objects/Blades/＜instanceID＞/collections/LpCpugroup

instanceID:

serverUniqueKeyをbase64urlでエンコードした文字列。

リクエストボディー

リクエストボディーには何も設定しません。

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。

ServerLpCpuGroup

{
   "ServerLpCpuGroup":[{
       "serverUniqueKey":"...",
       "groupNo":...,
       "groupName":"...",
       "sharedCores":...,
       "dedicatedCores":...,
       "numberOfThreads":...
   },
   :
   ]
}

属性 | データ型 | 数 | 説明
serverUniqueKey | string | 1 | プロセッサグループが搭載されているブレードサーバを特定する識別子。
groupNo | integer | 1 | グループ番号。
groupName | string | 1 | グループ名。
sharedCores | integer | 1 | 共有コア数。
dedicatedCores | integer | 1 | 占有コア数。
numberOfThreads | integer | 1 | スレッド数。

リターンコード

HTTPステータスコード | 結果コード | 詳細コード | 説明
200 | - | - | 正常終了。
204 | - | - | 指定したinstanceIDまたはcollectionはありません。
401 | 1000 | 1 | HTTPヘッダーのAuthorizationが指定されていません。
401 | 1000 | 2 | HTTPヘッダーのAuthorizationの値が不正です（Basic認証，HSSOセッション認証のどちらでもありません）。
401 | 1000 | 3 | HTTPヘッダーのAuthorizationのBasic認証の値が不正です（認証情報のフォーマットが不正です）。
401 | 1000 | 4 | ログインに失敗しました。
401 | 1002 | 1 | ログインセッションが切断されました。または，不正なHSSOトークンが指定されました。
403 | 1003 | 1 | 基本ライセンスが登録されていない，または有効期限を過ぎています。
403 | 1003 | 100 | 論理分割の機能を使用するためのプラグインライセンスがありません。
403 | 2017 | 1 | 管理対象を参照または操作する権限がありません。
405 | - | - | サポートされていないメソッドです。
406 | 2010 | 1 | HTTPヘッダーのAcceptの値が不正です。
415 | - | - | HTTPヘッダーのContent-Typeにサポートされていない形式が指定されています。
500 | - | - | HTTPヘッダーのContent-Typeに不正な値が指定されている，またはそれ以外の内部エラーです。
500 | 1000 | 1 | ログインに失敗しました（内部エラー）。
500 | 3000 | 100 | 内部エラーが発生しました。
503 | 2020 | 1 | 要求の数がAPIの同時最大接続数を超えました。

2.7 HVMのNICポートの情報を取得する

instanceIDに指定したブレードサーバ上のHVMの，NICポートの情報を取得します。

ロール

Admin/Modify/View

リクエストライン

GET http://＜host＞:＜port＞/ComputeSystemsManager/v1/objects/Blades/＜instanceID＞/collections/LpNicport

instanceID:

serverUniqueKeyをbase64urlでエンコードした文字列。

リクエストボディー

リクエストボディーには何も設定しません。

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。

ServerLpNICPort

{
   "ServerLpNICPort":[{
       "serverUniqueKey":"...",
       "pciDeviceNo":...,
       "vendor":"...",
       "deviceName":"...",
       "formattedSlotNo":"...",
       "slotNo":"...",
       "portNo":"...",
       "busNo":"...",
       "devNo":"...",
       "funcNo":...,
       "personality":"...",
       "allocation":"...",
       "status":"...",
       "assignedLparNo":...,
       "sharedNicNo":...,
       "sharedNicSegment":"...",
       "portStatus":"...",
       "packetFilter":"...",
       "srIovSupport":"...",
       "vfMacAddressEditable":"...",
       "vfVlanUndeffEditable":"...",
       "vfVlanTagEditable":"...",
       "vfVlanUntagEditable":"...",
       "vfPrmThroughEditable":"...",
       "vfPrmRestrictEditable":"...",
       "vfTxRateEditable":"...",
       "vfTxRateMax":...,
       "vfTxRateMin":...,
       "vfTxRateStep":...
   },
   :
   ]
}

属性
データ型
数
説明

serverUniqueKey
string
1
LPARが搭載されているブレードサーバを特定する識別子。

pciDeviceNo
integer
1
PCI番号。

vendor
string
1
PCIデバイスのベンダー名。

deviceName
string
1
デバイス名。

formattedSlotNo
string
1
スロット番号を整形した文字列。
例：'Mezzanine:X (Server Blade:XX)'

slotNo
string
1
スロット番号。
例：'EXX'

portNo
string
1
ポート番号。

busNo
string
1
バス番号。

devNo
string
1
デバイス番号。

funcNo
integer
1
ファンクション番号。

personality
string
1
Personality

*：BE3/Skyhawkデバイス以外。FCoE非対応のファームウェアを使用した場合。

NIC：PeronaliryがNIC

FCoE：PeronaliryがFCoE

iSCSI：PeronaliryがiSCSI（not support）

OTHER：その他（Custum, etc. not support）

allocation
string
1
NICの割り当てモード。

Share：共有モード。

Dedicate：占有モード。

status
string
1
PCIデバイスの状態。空の場合は正常。

Removed：削除された。

Error：障害閉塞。

assignedLparNo
integer
1
割り当てられたLPAR番号。ポートがどのLPARにも割り当てられていない場合は'-1'。

sharedNicNo
integer
1
共有NIC番号。

sharedNicSegment
string
1
共有NICセグメント。

portStatus
string
1
ポートの状態。

U：Link Up状態。

D：Link Down状態。

-：未定義状態。

E：障害。

*：状態が不明。

packetFilter
string
1
共有NICの通信パケットフィルタ情報。このNICが無効の場合，値は空文字列です。

Disable：通信量は内部LPARネットワークで制限されます。

Disable(ALL)：通信量のフィルタリングは無効です。

Enable：通信量は外部LPARネットワークで制限されます。

srIovSupport
string
1
SR-IOVサポート有無。

Disable

Enable

vfMacAddressEditable
string
1
VF NICのMACアドレスを編集できるかどうか。

Disable：VF NICはMACアドレスを編集できません。

Enable：VF NICはMACアドレスを編集できます。

vfVlanUndeffEditable
string
1
VF NICのVLANモードをUndefに設定できるかどうか。

Disable：VF NICはUndefに設定できません。

Enable：VF NICはUndefに設定できます。

vfVlanTagEditable
string
1
VF NICのVLANモードをTaggedに設定できるかどうか。

Disable：VF NICはTaggedに設定できません。

Enable：VF NICはTaggedに設定できます。

vfVlanUntagEditable
string
1
VF NICのVLANモードをUntaggedに設定できるかどうか。

Disable：VF NICはUntaggedに設定できません。

Enable：VF NICはUntaggedに設定できます。

vfPrmThroughEditable
string
1
VF NICのプロミスキャスモードをThroughに設定できるかどうか。

Disable：VF NICはプロミスキャスモードをThroughに設定できません。

Enable：VF NICはプロミスキャスモードをThroughに設定できます。

vfPrmRestrictEditable
string
1
VF NICのプロミスキャスモードをRestrictedに設定できるかどうか。

Disable：VF NICはプロミスキャスモードをRestrictedに設定できません。

Enable：VF NICはプロミスキャスモードをRestrictedに設定できます。

vfTxRateEditable
string
1
VF NICで最大転送速度（TXRATE）を設定できるかどうか。

Disable：VF NICは最大転送速度（TXRATE）を設定できません。

Enable：VF NICは最大転送速度（TXRATE）を設定できます。

vfTxRateMax
integer
1
最大転送速度（TXRATE）の最大値。srIovSupportが'Disable'の場合は'-1'。

vfTxRateMin
integer
1
最大転送速度（TXRATE）の最小値。srIovSupportが'Disable'の場合は'-1'。

vfTxRateStep
integer
1
最大転送速度（TXRATE）の間隔。srIovSupportが'Disable'の場合は'-1'。

リターンコード

HTTPステータスコード | 結果コード | 詳細コード | 説明
200 | - | - | 正常終了。
204 | - | - | 指定したinstanceIDまたはcollectionはありません。
401 | 1000 | 1 | HTTPヘッダーのAuthorizationが指定されていません。
401 | 1000 | 2 | HTTPヘッダーのAuthorizationの値が不正です（Basic認証，HSSOセッション認証のどちらでもありません）。
401 | 1000 | 3 | HTTPヘッダーのAuthorizationのBasic認証の値が不正です（認証情報のフォーマットが不正です）。
401 | 1000 | 4 | ログインに失敗しました。
401 | 1002 | 1 | ログインセッションが切断されました。または，不正なHSSOトークンが指定されました。
403 | 1003 | 1 | 基本ライセンスが登録されていない，または有効期限を過ぎています。
403 | 1003 | 100 | 論理分割の機能を使用するためのプラグインライセンスがありません。
403 | 2017 | 1 | 管理対象を参照または操作する権限がありません。
405 | - | - | サポートされていないメソッドです。
406 | 2010 | 1 | HTTPヘッダーのAcceptの値が不正です。
415 | - | - | HTTPヘッダーのContent-Typeにサポートされていない形式が指定されています。
500 | - | - | HTTPヘッダーのContent-Typeに不正な値が指定されている，またはそれ以外の内部エラーです。
500 | 1000 | 1 | ログインに失敗しました（内部エラー）。
500 | 3000 | 100 | 内部エラーが発生しました。
503 | 2020 | 1 | 要求の数がAPIの同時最大接続数を超えました。

2.8 HVMのFCポートの情報を取得する

instanceIDで指定したブレードサーバ上のHVMの，FCポートの情報を取得します。

ロール

Admin/Modify/View

リクエストライン

GET http://＜host＞:＜port＞/ComputeSystemsManager/v1/objects/Blades/＜instanceID＞/collections/LpFcport

instanceID:

serverUniqueKeyをbase64urlでエンコードした文字列。

リクエストボディー

リクエストボディーには何も設定しません。

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。

ServerLpFCPort

{
   "ServerLpFCPort":[{
       "serverUniqueKey":"...",
       "pciDeviceNo":...,
       "vendor":"...",
       "deviceName":"...",
       "formattedSlotNo":"...",
       "slotNo":"...",
       "portNo":...,
       "vfcId":"...",
       "status":"...",
       "portStatus":"...",
       "wwpn":"...",
       "wwnn":"...",
       "migrationWwpn":"...",
       "migrationWwnn":"...",
       "busNo":"...",
       "devNo":"...",
       "funcNo":...,
       "personality":"...",
       "allocation":"...",
       "coreDedicateSupport":"...",
       "coreNum":"...",
       "coreDedicate":"...",
       "assignedLparNo":...
   },
   :
   ]
}

属性
データ型
数
説明

serverUniqueKey
string
1
LPARが搭載されているブレードサーバを特定する識別子。

pciDeviceNo
integer
1
PCI番号。

vendor
string
1
PCIデバイスのベンダー名。

deviceName
string
1
デバイス名。

formattedSlotNo
string
1
スロット番号を整形した文字列。
例：'Mezzanine:X (Server Blade:XX)'

slotNo
string
1
スロット番号。
例：'EXX'

portNo
integer
1
ポート番号。

vfcId
string
1
vfcID。

status
string
1
PCIデバイスの状態。空の場合は正常。

Removed：削除された。

Error：障害閉塞。

portStatus
string
1
ポートの状態。

Available：正常に利用できます。

ConfigCheck：構成上の問題で利用できません。

LinkDown：ケーブルが接続されていないため利用できません。

ErrorCheck：回復不能な障害状態であるため利用できません。

-：占有モードではありません。

*：状態が不明です。

wwpn
string
1
FCのWWPN。

wwnn
string
1
FCのWWNN。

migrationWwpn
string
1
マイグレーションWWPN。

migrationWwnn
string
1
マイグレーションWWNN。

busNo
string
1
バス番号。

devNo
string
1
デバイス番号。

funcNo
integer
1
ファンクション番号。

personality
string
1
Personality

*：BE3/Skyhawkデバイス以外

FCoE：PeronaliryがFCoE

iSCSI：PeronaliryがiSCSI（not support）

OTHER：その他（Custum, etc. not support）

allocation
string
1
HBAの割り当てモード。

Share：共有モード。

Dedicate：占有モード。

coreDedicateSupport
string
1
コア占有モードのサポート状態。共有モードのときに有効です。共有モード以外の場合は空になります。

Enable：サポート。

Disable：非サポート。

coreNum
string
1
コア数。コア占有モードがサポートのときに有効です。サポート以外の場合は"*"になります。

coreDedicate
string
1
コア占有モードの有効／無効状態。コア占有モードが非サポートの場合は，非該当"-"になります。

Enable：有効。

Disable：無効。

-：非該当。

assignedLparNo
integer
1
割り当てられたLPAR番号。ポートがどのLPARにも割り当てられていない場合は'-1'。

リターンコード

HTTPステータスコード | 結果コード | 詳細コード | 説明
200 | - | - | 正常終了。
204 | - | - | 指定したinstanceIDまたはcollectionはありません。
401 | 1000 | 1 | HTTPヘッダーのAuthorizationが指定されていません。
401 | 1000 | 2 | HTTPヘッダーのAuthorizationの値が不正です（Basic認証，HSSOセッション認証のどちらでもありません）。
401 | 1000 | 3 | HTTPヘッダーのAuthorizationのBasic認証の値が不正です（認証情報のフォーマットが不正です）。
401 | 1000 | 4 | ログインに失敗しました。
401 | 1002 | 1 | ログインセッションが切断されました。または，不正なHSSOトークンが指定されました。
403 | 1003 | 1 | 基本ライセンスが登録されていない，または有効期限を過ぎています。
403 | 1003 | 100 | 論理分割の機能を使用するためのプラグインライセンスがありません。
403 | 2017 | 1 | 管理対象を参照または操作する権限がありません。
405 | - | - | サポートされていないメソッドです。
406 | 2010 | 1 | HTTPヘッダーのAcceptの値が不正です。
415 | - | - | HTTPヘッダーのContent-Typeにサポートされていない形式が指定されています。
500 | - | - | HTTPヘッダーのContent-Typeに不正な値が指定されている，またはそれ以外の内部エラーです。
500 | 1000 | 1 | ログインに失敗しました（内部エラー）。
500 | 3000 | 100 | 内部エラーが発生しました。
503 | 2020 | 1 | 要求の数がAPIの同時最大接続数を超えました。

2.9 HVMのUSBの情報を取得する

instanceIDに指定したブレードサーバ上のHVMの，USBの情報を取得します。

ロール

Admin/Modify/View

リクエストライン

GET http://＜host＞:＜port＞/ComputeSystemsManager/v1/objects/Blades/＜instanceID＞/collections/LpUsb

instanceID:

serverUniqueKeyをbase64urlでエンコードした文字列。

リクエストボディー

リクエストボディーには何も設定しません。

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。

ServerLpUSB

{
   "ServerLpUSB":[{
       "serverUniqueKey":"...",
       "pciDeviceNo":...,
       "vendor":"...",
       "deviceName":"...",
       "portNo":"...",
       "busNo":"...",
       "devNo":"...",
       "funcNo":...,
       "assignedLparNo":...,
       "usbAutoAssignment":"..."
   },
   :
   ]
}

属性
データ型
数
説明

serverUniqueKey
string
1
LPARが搭載されているブレードサーバを特定する識別子。

pciDeviceNo
integer
1
PCI番号。

vendor
string
1
PCIデバイスのベンダー名。

deviceName
string
1
デバイス名。

portNo
string
1
ポート番号。

busNo
string
1
バス番号。

devNo
string
1
デバイス番号。

funcNo
integer
1
ファンクション番号。

assignedLparNo
integer
1
割り当てられたLPAR番号。USBがどのLPARにも割り当てられていない場合には'-1'。

usbAutoAssignment
string
1
USBの自動アタッチ機能の設定。

整数値：USBがアタッチされているLPAR番号を示します。

AnyLPAR：LPARのActivate時にUSBを自動的にアタッチします。

None：設定したLPARにだけ，USBを自動的にアタッチします。

リターンコード

HTTPステータスコード | 結果コード | 詳細コード | 説明
200 | - | - | 正常終了。
204 | - | - | 指定したinstanceIDまたはcollectionはありません。
401 | 1000 | 1 | HTTPヘッダーのAuthorizationが指定されていません。
401 | 1000 | 2 | HTTPヘッダーのAuthorizationの値が不正です（Basic認証，HSSOセッション認証のどちらでもありません）。
401 | 1000 | 3 | HTTPヘッダーのAuthorizationのBasic認証の値が不正です（認証情報のフォーマットが不正です）。
401 | 1000 | 4 | ログインに失敗しました。
401 | 1002 | 1 | ログインセッションが切断されました。または，不正なHSSOトークンが指定されました。
403 | 1003 | 1 | 基本ライセンスが登録されていない，または有効期限を過ぎています。
403 | 1003 | 100 | 論理分割の機能を使用するためのプラグインライセンスがありません。
403 | 2017 | 1 | 管理対象を参照または操作する権限がありません。
405 | - | - | サポートされていないメソッドです。
406 | 2010 | 1 | HTTPヘッダーのAcceptの値が不正です。
415 | - | - | HTTPヘッダーのContent-Typeにサポートされていない形式が指定されています。
500 | - | - | HTTPヘッダーのContent-Typeに不正な値が指定されている，またはそれ以外の内部エラーです。
500 | 1000 | 1 | ログインに失敗しました（内部エラー）。
500 | 3000 | 100 | 内部エラーが発生しました。
503 | 2020 | 1 | 要求の数がAPIの同時最大接続数を超えました。

2.10 LPARの情報を取得する

instanceIDに指定したブレードサーバ上のLPARのうち，APIを実行するユーザの権限で参照できるすべてのLPARの情報を取得します。

ロール

Admin/Modify/View

リクエストライン

GET http://＜host＞:＜port＞/ComputeSystemsManager/v1/objects/Blades/＜instanceID＞/collections/Lpar

instanceID:

serverUniqueKeyをbase64urlでエンコードした文字列。

リクエストボディー

リクエストボディーには何も設定しません。

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。

Lpar

{
   "Lpar":[{
       "instanceId":"...",
       "serverUniqueKey":"...",
       "lparNo":...,
       "lparName":"...",
       "lparManagerId":"...",
       "lparStatus":"...",
       "migrationStatus":"...",
       "lastRefreshed":"...",
       "error":...,
       "warning":...,
       "information":...,
       "activationOrder":"...",
       "autoClearSystemEventLog":"...",
       "virtualConsole":"...",
       "cpuAllocation":"...",
       "numberOfLogicalCpus":...,
       "cpuGroup":...,
       "cpuAllocationRatio":...,
       "cpuIdleDetection":"...",
       "cpuPerformanceCapping":"...",
       "memorySizeInMB":...,
       "memoryNode":"...",
       "guestNUMA":"...",
       "preBootFirmware":"...",
       "guestOs":"...",
       "guestIdleMode":"...",
       "lowLatency":"..."
   },
   :
   ]
}

属性
データ型
数
説明

instanceId
string
1
URIでLPARを特定する際に使用する識別子。serverUniqueKey＋"_"＋LPAR番号をbase64urlでエンコードした文字列。

serverUniqueKey
string
1
LPARが搭載されているブレードサーバを特定する識別子。

lparNo
integer
1
LPAR番号。

lparName
string
1
LPAR名。

lparManagerId
string
1
HVM ID。

lparStatus
string
1
LPARの稼働状態。

ACT：作動中

DEACT：停止中

UNKNOWN

migrationStatus
string
1
マイグレーションの実行状態。

NONE：なし。マイグレーションしていません。

NEED：マイグレーション失敗。要回復。

FAILURE：マイグレーション失敗。回復不可能。

INPROGRESS：マイグレーション実行中。

RECOVERING：回復中。

UNKNOWN：不明。

lastRefreshed
dateTime
1
最終更新日時。

error
integer
1
解決していない障害レベルのアラート数。

warning
integer
1
解決していない警告レベルのアラート数。

information
integer
1
解決していない情報レベルのアラート数。

activationOrder
string
1
LPARが自動起動する際の起動順序（1～99）。HVM起動時に，数値の昇順にLPARを自動起動します。

*：自動起動しません。

autoClearSystemEventLog
string
1
システムイベントログの自動削除の設定。

Disable

Enable

virtualConsole
string
1
仮想COMコンソール機能の有効/無効の設定。仮想COMコンソール機能が有効な場合は，仮想COM番号（整数）。無効な場合は'*'。

cpuAllocation
string
1
CPUの割り当てモード。

Share：共有モード。

Dedicate：占有モード。

numberOfLogicalCpus
integer
1
論理プロセッサの数。

cpuGroup
integer
1
プロセッサグループ。

cpuAllocationRatio
integer
1
プロセッサのサービス率（1～999）。cpuAllocationの値がShareの場合に有効な情報です。

cpuIdleDetection
string
1
アイドル検出機能の設定。

Disable

Enable

cpuPerformanceCapping
string
1
プロセッサキャッピング機能の設定。

Disable

Enable

memorySizeInMB
integer
1
メモリーサイズ（MB）。

memoryNode
string
1
メモリーノード。

メモリーノード番号（整数値）：割り当てるメモリーノードを設定した場合。

Automatically：自動的に割り当てられる場合。

Automatically(Multiple)：複数のノードが割り当てられている場合。

GuestNUMA：ゲストNUMAが有効な場合。

guestNUMA
string
0～1
ゲストNUMA機能の設定。

Disable

Enable

preBootFirmware
string
1
Pre-bootファームウェアの種別。

BIOS

64UEFI

guestOs
string
1
OS種別。

Default

Solaris

guestIdleMode
string
0～1
ゲストアイドルモードの種別。アイドル検出機能の設定がEnableの場合，またはゲストアイドルモードがサポートされていない場合，空文字列です。

Halt

Poll

Mwait

lowLatency
string
0～1
Low Latency機能の設定。HVMがLow Latency機能をサポートしていない場合，空文字列です。

Disable

Enable

リターンコード

HTTPステータスコード | 結果コード | 詳細コード | 説明
200 | - | - | 正常終了。
204 | - | - | 指定したinstanceIDまたはcollectionはありません。
401 | 1000 | 1 | HTTPヘッダーのAuthorizationが指定されていません。
401 | 1000 | 2 | HTTPヘッダーのAuthorizationの値が不正です（Basic認証，HSSOセッション認証のどちらでもありません）。
401 | 1000 | 3 | HTTPヘッダーのAuthorizationのBasic認証の値が不正です（認証情報のフォーマットが不正です）。
401 | 1000 | 4 | ログインに失敗しました。
401 | 1002 | 1 | ログインセッションが切断されました。または，不正なHSSOトークンが指定されました。
403 | 1003 | 1 | 基本ライセンスが登録されていない，または有効期限を過ぎています。
403 | 1003 | 100 | 論理分割の機能を使用するためのプラグインライセンスがありません。
403 | 2017 | 1 | 管理対象を参照または操作する権限がありません。
405 | - | - | サポートされていないメソッドです。
406 | 2010 | 1 | HTTPヘッダーのAcceptの値が不正です。
415 | - | - | HTTPヘッダーのContent-Typeにサポートされていない形式が指定されています。
500 | - | - | HTTPヘッダーのContent-Typeに不正な値が指定されている，またはそれ以外の内部エラーです。
500 | 1000 | 1 | ログインに失敗しました（内部エラー）。
500 | 3000 | 100 | 内部エラーが発生しました。
503 | 2020 | 1 | 要求の数がAPIの同時最大接続数を超えました。

2.11 ブレードサーバの電源をONにする

instanceIDに指定したブレードサーバの電源をONにするタスクを登録します。

ロール

Admin/Modify

リクエストライン

PUT http://＜host＞:＜port＞/ComputeSystemsManager/v1/objects/Blades/＜instanceID＞/actions/Poweron/invoke

instanceID:

serverUniqueKeyをbase64urlでエンコードした文字列。

リクエストボディー

リクエストボディーの構造とオブジェクトの属性を次に示します。

ServerPowerOn

{
       "schedule":"...",
       "time":"...",
       "elapseTime":...,
       "emailNotificationType":"...",
       "verifyLpm":"...",
       "lpmElapseTime":...
}

属性
データ型
数
説明

schedule
string
0～1
ブレードサーバ電源をON にするスケジュールを指定します。

NOW：即時開始

LATER：timeで指定した日時に開始。LATER を指定する場合は，timeも合わせて指定してください。

デフォルトの値はNOWです。

time
string
0～1
ブレードサーバの電源をONにする日付と時刻をYYYY/MM/DD HH:MM:SS の形式で指定します。過去の時刻は指定できません。scheduleが'LATER'のときに有効です。

elapseTime
integer
0～1
ブレードサーバの電源がONになるまでのタイムアウト時間を指定します。0から9999（単位：秒）の値を指定できます。
0を指定した場合，または省略した場合は，デフォルトの値が設定されます。デフォルトの値はGUIで設定されたタイムアウト時間です。

emailNotificationType
string
0～1
Eメール通知の方法を指定します。

SEND：Eメールを送信します。

SEND_ONLY_TASK_FAILED：タスクが失敗したときだけEメールを送信します。

NOT_SEND：Eメールを送信しません。

デフォルトの値はNOT_SENDです。

verifyLpm
string
0～1
HVMの起動を確認するかどうかを指定します。

YES：起動を確認します。

NO：起動を確認しません。

デフォルトの値はYESです。

lpmElapseTime
integer
0～1
HVMが起動するまでのタイムアウト時間を指定します。0から9999（単位：秒）の値を指定できます。verifyLpmが'YES'の場合だけ有効です。
0を指定した場合，または省略した場合は，デフォルトの値が設定されます。デフォルトの値はGUIで設定されたタイムアウト時間です。

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。

ApiResult

{
       "id":...
}

属性 | データ型 | 数 | 説明
id | integer | 1 | ブレードサーバの電源をONにするために登録されたタスクのタスクIDが返ります。

リターンコード

HTTPステータスコード | 結果コード | 詳細コード | 説明
200 | - | - | 正常終了。
400 | 2010 | 101 | リクエストボディーの書式が無効です。JSONの書式で記述してください。
400 | 2010 | 102 | elapseTimeに指定した値が範囲外です。
400 | 2010 | 103 | scheduleに無効な値を指定しました。
400 | 2010 | 104 | timeに無効な値を指定しました。
400 | 2010 | 105 | emailNotificationTypeに無効な値を指定しました。
400 | 2010 | 107 | scheduleに'LATER'を指定する場合は，timeも指定する必要があります。
400 | 2010 | 108 | 指定した日付は2100年12月31日以降です。
400 | 2010 | 109 | verifyLpmに指定した値が不正です。
400 | 2010 | 110 | lpmElapseTimeに指定した値が範囲外です。
401 | 1000 | 1 | HTTPヘッダーのAuthorizationが指定されていません。
401 | 1000 | 2 | HTTPヘッダーのAuthorizationの値が不正です（Basic認証，HSSOセッション認証のどちらでもありません）。
401 | 1000 | 3 | HTTPヘッダーのAuthorizationのBasic認証の値が不正です（認証情報のフォーマットが不正です）。
401 | 1000 | 4 | ログインに失敗しました。
401 | 1002 | 1 | ログインセッションが切断されました。または，不正なHSSOトークンが指定されました。
403 | 1003 | 1 | 基本ライセンスが登録されていない，または有効期限を過ぎています。
403 | 2017 | 1 | 管理対象を参照または操作する権限がありません。
404 | - | - | 指定したinstanceIDまたはcollectionはありません。
405 | - | - | サポートされていないメソッドです。
406 | 2010 | 1 | HTTPヘッダーのAcceptの値が不正です。
412 | 2018 | 106 | timeに過去の時刻を指定しました。
415 | - | - | HTTPヘッダーのContent-Typeにサポートされていない形式が指定されています。
500 | - | - | HTTPヘッダーのContent-Typeに不正な値が指定されている，またはそれ以外の内部エラーです。
500 | 1000 | 1 | ログインに失敗しました（内部エラー）。
500 | 3000 | 100 | 内部エラーが発生しました。
503 | 2020 | 1 | 要求の数がAPIの同時最大接続数を超えました。
503 | 2020 | 2 | タスク登録に失敗しました。しばらくしてから，再度実行してください。

2.12 ブレードサーバの電源をOFFにする

instanceIDに指定したブレードサーバの電源を強制的にOFFにするタスクを登録します。

ロール

Admin/Modify

リクエストライン

PUT http://＜host＞:＜port＞/ComputeSystemsManager/v1/objects/Blades/＜instanceID＞/actions/Poweroff/invoke

instanceID:

serverUniqueKeyをbase64urlでエンコードした文字列。

リクエストボディー

リクエストボディーの構造とオブジェクトの属性を次に示します。

ServerPowerOff

{
       "schedule":"...",
       "time":"...",
       "elapseTime":...,
       "emailNotificationType":"..."
}

属性
データ型
数
説明

schedule
string
0～1
ブレードサーバの電源を強制的にOFFにするスケジュールを指定します。

NOW：即時開始

LATER：timeで指定した日時に開始。LATER を指定する場合は，timeも合わせて指定してください。

デフォルトの値はNOWです。

time
string
0～1
ブレードサーバの電源を強制的にOFFにする日付と時刻をYYYY/MM/DD HH:MM:SS の形式で指定します。過去の時刻は指定できません。scheduleが'LATER'のときに有効です。

elapseTime
integer
0～1
ブレードサーバの電源がOFFになるまでのタイムアウト時間を指定します。0から9999（単位：秒）の値を指定できます。
0を指定した場合，または省略した場合は，デフォルトの値が設定されます。デフォルトの値はGUIで設定されたタイムアウト時間です。

emailNotificationType
string
0～1
Eメール通知の方法を指定します。

SEND：Eメールを送信します。

SEND_ONLY_TASK_FAILED：タスクが失敗したときだけEメールを送信します。

NOT_SEND：Eメールを送信しません。

デフォルトの値はNOT_SENDです。

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。

ApiResult

{
       "id":...
}

属性 | データ型 | 数 | 説明
id | integer | 1 | ブレードサーバの電源をOFFにするために登録されたタスクのタスクIDが返ります。

リターンコード

HTTPステータスコード | 結果コード | 詳細コード | 説明
200 | - | - | 正常終了。
400 | 2010 | 101 | リクエストボディーの書式が無効です。JSONの書式で記述してください。
400 | 2010 | 102 | elapseTimeに指定した値が範囲外です。
400 | 2010 | 103 | scheduleに無効な値を指定しました。
400 | 2010 | 104 | timeに無効な値を指定しました。
400 | 2010 | 105 | emailNotificationTypeに無効な値を指定しました。
400 | 2010 | 107 | scheduleに'LATER'を指定する場合は，timeも指定する必要があります。
400 | 2010 | 108 | 指定した日付は2100年12月31日以降です。
401 | 1000 | 1 | HTTPヘッダーのAuthorizationが指定されていません。
401 | 1000 | 2 | HTTPヘッダーのAuthorizationの値が不正です（Basic認証，HSSOセッション認証のどちらでもありません）。
401 | 1000 | 3 | HTTPヘッダーのAuthorizationのBasic認証の値が不正です（認証情報のフォーマットが不正です）。
401 | 1000 | 4 | ログインに失敗しました。
401 | 1002 | 1 | ログインセッションが切断されました。または，不正なHSSOトークンが指定されました。
403 | 1003 | 1 | 基本ライセンスが登録されていない，または有効期限を過ぎています。
403 | 2017 | 1 | 管理対象を参照または操作する権限がありません。
404 | - | - | 指定したinstanceIDまたはcollectionはありません。
405 | - | - | サポートされていないメソッドです。
406 | 2010 | 1 | HTTPヘッダーのAcceptの値が不正です。
412 | 2018 | 106 | timeに過去の時刻を指定しました。
415 | - | - | HTTPヘッダーのContent-Typeにサポートされていない形式が指定されています。
500 | - | - | HTTPヘッダーのContent-Typeに不正な値が指定されている，またはそれ以外の内部エラーです。
500 | 1000 | 1 | ログインに失敗しました（内部エラー）。
500 | 3000 | 100 | 内部エラーが発生しました。
503 | 2020 | 1 | 要求の数がAPIの同時最大接続数を超えました。
503 | 2020 | 2 | タスク登録に失敗しました。しばらくしてから，再度実行してください。

2.13 ブレードサーバの電源をリセットする

instanceIDに指定したブレードサーバの電源をリセットするタスクを登録します。

ロール

Admin/Modify

リクエストライン

PUT http://＜host＞:＜port＞/ComputeSystemsManager/v1/objects/Blades/＜instanceID＞/actions/Reset/invoke

instanceID:

serverUniqueKeyをbase64urlでエンコードした文字列。

リクエストボディー

リクエストボディーの構造とオブジェクトの属性を次に示します。

ServerPowerReset

{
       "schedule":"...",
       "time":"...",
       "elapseTime":...,
       "emailNotificationType":"..."
}

属性
データ型
数
説明

schedule
string
0～1
ブレードサーバの電源をリセットするスケジュールを指定します。

NOW：即時開始

LATER：timeで指定した日時に開始。LATER を指定する場合は，timeも合わせて指定してください。

デフォルトの値はNOWです。

time
string
0～1
ブレードサーバの電源をリセットする日付と時刻をYYYY/MM/DD HH:MM:SS の形式で指定します。過去の時刻は指定できません。scheduleが'LATER'のときに有効です。

elapseTime
integer
0～1
ブレードサーバの電源がリセットされるまでのタイムアウト時間を指定します。0から9999（単位：秒）の値を指定できます。
0を指定した場合，または省略した場合は，デフォルトの値が設定されます。デフォルトの値はGUIで設定されたタイムアウト時間です。

emailNotificationType
string
0～1
Eメール通知の方法を指定します。

SEND：Eメールを送信します。

SEND_ONLY_TASK_FAILED：タスクが失敗したときだけEメールを送信します。

NOT_SEND：Eメールを送信しません。

デフォルトの値はNOT_SENDです。

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。

ApiResult

{
       "id":...
}

属性 | データ型 | 数 | 説明
id | integer | 1 | ブレードサーバの電源をリセットするために登録されたタスクのタスクIDが返ります。

リターンコード

HTTPステータスコード | 結果コード | 詳細コード | 説明
200 | - | - | 正常終了。
400 | 2010 | 101 | リクエストボディーの書式が無効です。JSONの書式で記述してください。
400 | 2010 | 102 | elapseTimeに指定した値が範囲外です。
400 | 2010 | 103 | scheduleに無効な値を指定しました。
400 | 2010 | 104 | timeに無効な値を指定しました。
400 | 2010 | 105 | emailNotificationTypeに無効な値を指定しました。
400 | 2010 | 107 | scheduleに'LATER'を指定する場合は，timeも指定する必要があります。
400 | 2010 | 108 | 指定した日付は2100年12月31日以降です。
401 | 1000 | 1 | HTTPヘッダーのAuthorizationが指定されていません。
401 | 1000 | 2 | HTTPヘッダーのAuthorizationの値が不正です（Basic認証，HSSOセッション認証のどちらでもありません）。
401 | 1000 | 3 | HTTPヘッダーのAuthorizationのBasic認証の値が不正です（認証情報のフォーマットが不正です）。
401 | 1000 | 4 | ログインに失敗しました。
401 | 1002 | 1 | ログインセッションが切断されました。または，不正なHSSOトークンが指定されました。
403 | 1003 | 1 | 基本ライセンスが登録されていない，または有効期限を過ぎています。
403 | 2017 | 1 | 管理対象を参照または操作する権限がありません。
404 | - | - | 指定したinstanceIDまたはcollectionはありません。
405 | - | - | サポートされていないメソッドです。
406 | 2010 | 1 | HTTPヘッダーのAcceptの値が不正です。
412 | 2018 | 106 | timeに過去の時刻を指定しました。
415 | - | - | HTTPヘッダーのContent-Typeにサポートされていない形式が指定されています。
500 | - | - | HTTPヘッダーのContent-Typeに不正な値が指定されている，またはそれ以外の内部エラーです。
500 | 1000 | 1 | ログインに失敗しました（内部エラー）。
500 | 3000 | 100 | 内部エラーが発生しました。
503 | 2020 | 1 | 要求の数がAPIの同時最大接続数を超えました。
503 | 2020 | 2 | タスク登録に失敗しました。しばらくしてから，再度実行してください。

2.14 ブレードサーバのLIDを点灯する

instanceIDに指定したブレードサーバのLIDを点灯します。

ロール

Admin/Modify

リクエストライン

PUT http://＜host＞:＜port＞/ComputeSystemsManager/v1/objects/Blades/＜instanceID＞/actions/Lidon/invoke

instanceID:

serverUniqueKeyをbase64urlでエンコードした文字列。

リクエストボディー

リクエストボディーには何も設定しません。

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。

ApiResult

{
       "id":...
}

属性 | データ型 | 数 | 説明
id | integer | 1 | ブレードサーバのLIDを点灯するために登録されたタスクのタスクIDが返ります。

リターンコード

HTTPステータスコード | 結果コード | 詳細コード | 説明
200 | - | - | 正常終了。
401 | 1000 | 1 | HTTPヘッダーのAuthorizationが指定されていません。
401 | 1000 | 2 | HTTPヘッダーのAuthorizationの値が不正です（Basic認証，HSSOセッション認証のどちらでもありません）。
401 | 1000 | 3 | HTTPヘッダーのAuthorizationのBasic認証の値が不正です（認証情報のフォーマットが不正です）。
401 | 1000 | 4 | ログインに失敗しました。
401 | 1002 | 1 | ログインセッションが切断されました。または，不正なHSSOトークンが指定されました。
403 | 1003 | 1 | 基本ライセンスが登録されていない，または有効期限を過ぎています。
403 | 2017 | 1 | 管理対象を参照または操作する権限がありません。
404 | - | - | 指定したinstanceIDまたはcollectionはありません。
405 | - | - | サポートされていないメソッドです。
406 | 2010 | 1 | HTTPヘッダーのAcceptの値が不正です。
415 | - | - | HTTPヘッダーのContent-Typeにサポートされていない形式が指定されています。
500 | - | - | HTTPヘッダーのContent-Typeに不正な値が指定されている，またはそれ以外の内部エラーです。
500 | 1000 | 1 | ログインに失敗しました（内部エラー）。
500 | 3000 | 100 | 内部エラーが発生しました。
503 | 2020 | 1 | 要求の数がAPIの同時最大接続数を超えました。
503 | 2020 | 2 | タスク登録に失敗しました。しばらくしてから，再度実行してください。

2.15 ブレードサーバのLIDを消灯する

instanceIDに指定したブレードサーバのLIDを消灯します。

ロール

Admin/Modify

リクエストライン

PUT http://＜host＞:＜port＞/ComputeSystemsManager/v1/objects/Blades/＜instanceID＞/actions/Lidoff/invoke

instanceID:

serverUniqueKeyをbase64urlでエンコードした文字列。

リクエストボディー

リクエストボディーには何も設定しません。

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。

ApiResult

{
       "id":...
}

属性 | データ型 | 数 | 説明
id | integer | 1 | ブレードサーバのLIDを消灯するために登録されたタスクのタスクIDが返ります。

リターンコード

HTTPステータスコード | 結果コード | 詳細コード | 説明
200 | - | - | 正常終了。
401 | 1000 | 1 | HTTPヘッダーのAuthorizationが指定されていません。
401 | 1000 | 2 | HTTPヘッダーのAuthorizationの値が不正です（Basic認証，HSSOセッション認証のどちらでもありません）。
401 | 1000 | 3 | HTTPヘッダーのAuthorizationのBasic認証の値が不正です（認証情報のフォーマットが不正です）。
401 | 1000 | 4 | ログインに失敗しました。
401 | 1002 | 1 | ログインセッションが切断されました。または，不正なHSSOトークンが指定されました。
403 | 1003 | 1 | 基本ライセンスが登録されていない，または有効期限を過ぎています。
403 | 2017 | 1 | 管理対象を参照または操作する権限がありません。
404 | - | - | 指定したinstanceIDまたはcollectionはありません。
405 | - | - | サポートされていないメソッドです。
406 | 2010 | 1 | HTTPヘッダーのAcceptの値が不正です。
415 | - | - | HTTPヘッダーのContent-Typeにサポートされていない形式が指定されています。
500 | - | - | HTTPヘッダーのContent-Typeに不正な値が指定されている，またはそれ以外の内部エラーです。
500 | 1000 | 1 | ログインに失敗しました（内部エラー）。
500 | 3000 | 100 | 内部エラーが発生しました。
503 | 2020 | 1 | 要求の数がAPIの同時最大接続数を超えました。
503 | 2020 | 2 | タスク登録に失敗しました。しばらくしてから，再度実行してください。

2.16 ブレードサーバの情報を更新する

instanceIDに指定したブレードサーバの情報を更新します。

ロール

Admin/Modify

リクエストライン

PUT http://＜host＞:＜port＞/ComputeSystemsManager/v1/objects/Blades/＜instanceID＞/actions/Refresh/invoke

instanceID:

serverUniqueKeyをbase64urlでエンコードした文字列。

リクエストボディー

リクエストボディーには何も設定しません。

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。

ApiResult

{
       "id":...
}

属性 | データ型 | 数 | 説明
id | integer | 1 | ブレードサーバの情報を更新するために登録されたタスクのタスクIDが返ります。

リターンコード

HTTPステータスコード | 結果コード | 詳細コード | 説明
200 | - | - | 正常終了。
401 | 1000 | 1 | HTTPヘッダーのAuthorizationが指定されていません。
401 | 1000 | 2 | HTTPヘッダーのAuthorizationの値が不正です（Basic認証，HSSOセッション認証のどちらでもありません）。
401 | 1000 | 3 | HTTPヘッダーのAuthorizationのBasic認証の値が不正です（認証情報のフォーマットが不正です）。
401 | 1000 | 4 | ログインに失敗しました。
401 | 1002 | 1 | ログインセッションが切断されました。または，不正なHSSOトークンが指定されました。
403 | 1003 | 1 | 基本ライセンスが登録されていない，または有効期限を過ぎています。
403 | 2017 | 1 | 管理対象を参照または操作する権限がありません。
404 | - | - | 指定したinstanceIDまたはcollectionはありません。
405 | - | - | サポートされていないメソッドです。
406 | 2010 | 1 | HTTPヘッダーのAcceptの値が不正です。
415 | - | - | HTTPヘッダーのContent-Typeにサポートされていない形式が指定されています。
500 | - | - | HTTPヘッダーのContent-Typeに不正な値が指定されている，またはそれ以外の内部エラーです。
500 | 1000 | 1 | ログインに失敗しました（内部エラー）。
500 | 3000 | 100 | 内部エラーが発生しました。
503 | 2020 | 1 | 要求の数がAPIの同時最大接続数を超えました。
503 | 2020 | 2 | タスク登録に失敗しました。しばらくしてから，再度実行してください。

3. シャーシ

この章では，シャーシの情報取得・操作に関するAPIについて説明します。

この章の構成

3.1 すべてのシャーシの情報を取得する

3.2 特定のシャーシの情報を取得する

3.3 シャーシを管理対象から外す

3.4 シャーシに搭載されたブレードサーバの情報を取得する

3.5 マネジメントモジュールの情報を取得する

3.6 スイッチモジュールの情報を取得する

3.7 ファンモジュールの情報を取得する

3.8 電源モジュールの情報を取得する

3.9 マネジメントLANモジュールの情報を取得する

3.10 I/Oボードモジュールの情報を取得する

3.11 シャーシのLIDを点灯する

3.12 シャーシのLIDを消灯する

3.13 シャーシの情報を更新する

3.1 すべてのシャーシの情報を取得する

APIを実行するユーザの権限で参照できるすべてのシャーシの情報を取得します。

ロール

Admin/Modify/View

リクエストライン

GET http://＜host＞:＜port＞/ComputeSystemsManager/v1/objects/Chassis

リクエストボディー

リクエストボディーには何も設定しません。

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。

Chassis

{
   "Chassis":[{
       "instanceId":"...",
       "chassisUniqueKey":"...",
       "chassisSerialNumber":"...",
       "chassisModelNumber":"...",
       "chassisModelName":"...",
       "chassisName":"...",
       "chassisType":"...",
       "chassisSystem":"...",
       "chassisStatus":"...",
       "healthStatus":"...",
       "maintenanceMode":"...",
       "lastRefreshed":"...",
       "error":...,
       "warning":...,
       "information":...,
       "lidStatus":"...",
       "lidColor":"...",
       "svpIpAddress":"...",
       "svpSubnetMask":"...",
       "svpPrefixLength":"...",
       "svpDefaultGateway":"...",
       "webConsoleUrl":"..."
   },
   :
   ]
}

属性
データ型
数
説明

instanceId
string
1
URIでシャーシを特定する際に使用する識別子。chassisUniqueKeyをbase64urlでエンコードした文字列。

chassisUniqueKey
string
1
このシャーシを特定する識別子。

chassisSerialNumber
string
1
シリアル番号。シャーシを特定するシリアル番号。

chassisModelNumber
string
1
モデル番号。

chassisModelName
string
1
プロダクト名またはモデル名。

chassisName
string
1
ユーザーが定義したシャーシの名前。

chassisType
string
1
シャーシ種別。

chassisSystem
string
0～1
システム種別。

chassisStatus
string
1
マネジメントモジュール経由で確認したシャーシの状態。

Running：シャーシ動作中。

Unknown：マネジメントモジュールとの通信に失敗したため，確認できません。

healthStatus
string
1
シャーシの稼働状態。

NORMAL：正常

WARNING：警告

FAIL：障害

UNKNOWN：不明

maintenanceMode
string
1
シャーシの保守モードの設定。

TRUE：保守モードに設定されています。

FALSE：保守モードに設定されていません。

lastRefreshed
dateTime
1
最終更新日時。

error
integer
1
解決していない障害レベルのアラート数。

warning
integer
1
解決していない警告レベルのアラート数。

information
integer
1
解決していない情報レベルのアラート数。

lidStatus
string
1
LID状態。

ON

OFF

BLINKING

SLOW_BLINKING

FAST_BLINKING

UNKNOWN

lidColor
string
1
LIDの表示色。

BLUE

GREEN

RED

ORANGE

UNKNOWN

svpIpAddress
string
1
SVPのIPアドレス（IPv4またはIPv6形式）。

svpSubnetMask
string
1
SVPのサブネットマスク（IPv4形式）。IPアドレスがIPv6の場合，空文字列です。

svpPrefixLength
string
1
SVPのプレフィックス長（IPv6形式）。IPアドレスがIPv4の場合，プレフィックス長は空文字列。

svpDefaultGateway
string
1
SVPのデフォルトゲートウェイIPアドレス（IPv4またはIPv6形式）。

webConsoleUrl
string
1
WebコンソールのURL。ブラウザーからWebコンソールにアクセスするためのURL。https://xxxxx:port/... のように整形された文字列。

リターンコード

HTTPステータスコード | 結果コード | 詳細コード | 説明
200 | - | - | 正常終了。
401 | 1000 | 1 | HTTPヘッダーのAuthorizationが指定されていません。
401 | 1000 | 2 | HTTPヘッダーのAuthorizationの値が不正です（Basic認証，HSSOセッション認証のどちらでもありません）。
401 | 1000 | 3 | HTTPヘッダーのAuthorizationのBasic認証の値が不正です（認証情報のフォーマットが不正です）。
401 | 1000 | 4 | ログインに失敗しました。
401 | 1002 | 1 | ログインセッションが切断されました。または，不正なHSSOトークンが指定されました。
403 | 1003 | 1 | 基本ライセンスが登録されていない，または有効期限を過ぎています。
403 | 2017 | 1 | 管理対象を参照または操作する権限がありません。
405 | - | - | サポートされていないメソッドです。
406 | 2010 | 1 | HTTPヘッダーのAcceptの値が不正です。
415 | - | - | HTTPヘッダーのContent-Typeにサポートされていない形式が指定されています。
500 | - | - | HTTPヘッダーのContent-Typeに不正な値が指定されている，またはそれ以外の内部エラーです。
500 | 1000 | 1 | ログインに失敗しました（内部エラー）。
500 | 3000 | 100 | 内部エラーが発生しました。
503 | 2020 | 1 | 要求の数がAPIの同時最大接続数を超えました。

3.2 特定のシャーシの情報を取得する

instanceIDに指定したシャーシの情報を取得します。

ロール

Admin/Modify/View

リクエストライン

GET http://＜host＞:＜port＞/ComputeSystemsManager/v1/objects/Chassis/＜instanceID＞

instanceID:

chassisUniqueKeyをbase64urlでエンコードした文字列。

リクエストボディー

リクエストボディーには何も設定しません。

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。

Chassis

{
   "Chassis":[{
       "instanceId":"...",
       "chassisUniqueKey":"...",
       "chassisSerialNumber":"...",
       "chassisModelNumber":"...",
       "chassisModelName":"...",
       "chassisName":"...",
       "chassisType":"...",
       "chassisSystem":"...",
       "chassisStatus":"...",
       "healthStatus":"...",
       "maintenanceMode":"...",
       "lastRefreshed":"...",
       "error":...,
       "warning":...,
       "information":...,
       "lidStatus":"...",
       "lidColor":"...",
       "svpIpAddress":"...",
       "svpSubnetMask":"...",
       "svpPrefixLength":"...",
       "svpDefaultGateway":"...",
       "webConsoleUrl":"..."
   }]
}

属性
データ型
数
説明

instanceId
string
1
URIでシャーシを特定する際に使用する識別子。chassisUniqueKeyをbase64urlでエンコードした文字列。

chassisUniqueKey
string
1
このシャーシを特定する識別子。

chassisSerialNumber
string
1
シリアル番号。シャーシを特定するシリアル番号。

chassisModelNumber
string
1
モデル番号。

chassisModelName
string
1
プロダクト名またはモデル名。

chassisName
string
1
ユーザーが定義したシャーシの名前。

chassisType
string
1
シャーシ種別。

chassisSystem
string
0～1
システム種別。

chassisStatus
string
1
マネジメントモジュール経由で確認したシャーシの状態。

Running：シャーシ動作中。

Unknown：マネジメントモジュールとの通信に失敗したため，確認できません。

healthStatus
string
1
シャーシの稼働状態。

NORMAL：正常

WARNING：警告

FAIL：障害

UNKNOWN：不明

maintenanceMode
string
1
シャーシの保守モードの設定。

TRUE：保守モードに設定されています。

FALSE：保守モードに設定されていません。

lastRefreshed
dateTime
1
最終更新日時。

error
integer
1
解決していない障害レベルのアラート数。

warning
integer
1
解決していない警告レベルのアラート数。

information
integer
1
解決していない情報レベルのアラート数。

lidStatus
string
1
LID状態。

ON

OFF

BLINKING

SLOW_BLINKING

FAST_BLINKING

UNKNOWN

lidColor
string
1
LIDの表示色。

BLUE

GREEN

RED

ORANGE

UNKNOWN

svpIpAddress
string
1
SVPのIPアドレス（IPv4またはIPv6形式）。

svpSubnetMask
string
1
SVPのサブネットマスク（IPv4形式）。IPアドレスがIPv6の場合，空文字列です。

svpPrefixLength
string
1
SVPのプレフィックス長（IPv6形式）。IPアドレスがIPv4の場合，プレフィックス長は空文字列。

svpDefaultGateway
string
1
SVPのデフォルトゲートウェイIPアドレス（IPv4またはIPv6形式）。

webConsoleUrl
string
1
WebコンソールのURL。ブラウザーからWebコンソールにアクセスするためのURL。https://xxxxx:port/... のように整形された文字列。

リターンコード

HTTPステータスコード | 結果コード | 詳細コード | 説明
200 | - | - | 正常終了。
204 | - | - | 指定したinstanceIDまたはcollectionはありません。
401 | 1000 | 1 | HTTPヘッダーのAuthorizationが指定されていません。
401 | 1000 | 2 | HTTPヘッダーのAuthorizationの値が不正です（Basic認証，HSSOセッション認証のどちらでもありません）。
401 | 1000 | 3 | HTTPヘッダーのAuthorizationのBasic認証の値が不正です（認証情報のフォーマットが不正です）。
401 | 1000 | 4 | ログインに失敗しました。
401 | 1002 | 1 | ログインセッションが切断されました。または，不正なHSSOトークンが指定されました。
403 | 1003 | 1 | 基本ライセンスが登録されていない，または有効期限を過ぎています。
403 | 2017 | 1 | 管理対象を参照または操作する権限がありません。
405 | - | - | サポートされていないメソッドです。
406 | 2010 | 1 | HTTPヘッダーのAcceptの値が不正です。
415 | - | - | HTTPヘッダーのContent-Typeにサポートされていない形式が指定されています。
500 | - | - | HTTPヘッダーのContent-Typeに不正な値が指定されている，またはそれ以外の内部エラーです。
500 | 1000 | 1 | ログインに失敗しました（内部エラー）。
500 | 3000 | 100 | 内部エラーが発生しました。
503 | 2020 | 1 | 要求の数がAPIの同時最大接続数を超えました。

3.3 シャーシを管理対象から外す

instanceIDに指定したシャーシをCompute Systems Managerの管理対象から外します。

ロール

All-Resources-Admin

リクエストライン

DELETE http://＜host＞:＜port＞/ComputeSystemsManager/v1/objects/Chassis/＜instanceID＞

instanceID:

chassisUniqueKeyをbase64urlでエンコードした文字列。

リクエストボディー

リクエストボディーには何も設定しません。

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。

ApiResult

{
       "id":...
}

属性 | データ型 | 数 | 説明
id | integer | 1 | 0が返ります。

リターンコード

HTTPステータスコード | 結果コード | 詳細コード | 説明
200 | - | - | 正常終了。
401 | 1000 | 1 | HTTPヘッダーのAuthorizationが指定されていません。
401 | 1000 | 2 | HTTPヘッダーのAuthorizationの値が不正です（Basic認証，HSSOセッション認証のどちらでもありません）。
401 | 1000 | 3 | HTTPヘッダーのAuthorizationのBasic認証の値が不正です（認証情報のフォーマットが不正です）。
401 | 1000 | 4 | ログインに失敗しました。
401 | 1002 | 1 | ログインセッションが切断されました。または，不正なHSSOトークンが指定されました。
403 | 1003 | 1 | 基本ライセンスが登録されていない，または有効期限を過ぎています。
403 | 2017 | 1 | 管理対象を参照または操作する権限がありません。
404 | - | - | 指定したinstanceIDまたはcollectionはありません。
405 | - | - | サポートされていないメソッドです。
406 | 2010 | 1 | HTTPヘッダーのAcceptの値が不正です。
412 | 2150 | 1 | 指定されたシャーシは幾つかのタスクで使用されているため，管理対象から外せません。
412 | 2150 | 2 | 指定されたシャーシに搭載されたブレードサーバがN+Mコールドスタンバイグループに登録されているため，管理対象から外せません。
412 | 2150 | 3 | 指定されたシャーシに搭載されたブレードサーバ，VM，またはLPARがデプロイメントマネージャーの対象として登録されているため，管理対象から外せません。
415 | - | - | HTTPヘッダーのContent-Typeにサポートされていない形式が指定されています。
500 | - | - | HTTPヘッダーのContent-Typeに不正な値が指定されている，またはそれ以外の内部エラーです。
500 | 1000 | 1 | ログインに失敗しました（内部エラー）。
500 | 3000 | 100 | 内部エラーが発生しました。
503 | 2020 | 1 | 要求の数がAPIの同時最大接続数を超えました。

3.4 シャーシに搭載されたブレードサーバの情報を取得する

instanceIDに指定したシャーシに搭載されているブレードサーバのうち，APIを実行するユーザの権限で参照できるブレードサーバの情報を取得します。

ロール

Admin/Modify/View

リクエストライン

GET http://＜host＞:＜port＞/ComputeSystemsManager/v1/objects/Chassis/＜instanceID＞/collections/Blade

instanceID:

chassisUniqueKeyをbase64urlでエンコードした文字列。

リクエストボディー

リクエストボディーには何も設定しません。

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。

Server

{
   "Server":[{
       "instanceId":"...",
       "chassisUniqueKey":"...",
       "serverUniqueKey":"...",
       "serverSerialNumber":"...",
       "serverProductName":"...",
       "manufacturer":"...",
       "serverProductNumber":"...",
       "serverUuid":"...",
       "partitionNo":...,
       "primarySlot":...,
       "partitionWidth":...,
       "slotWidth":...,
       "bladeNumber":"...",
       "slotNumber":"...",
       "partitionValid":"...",
       "healthStatus":"...",
       "maintenanceMode":"...",
       "serverStatus":"...",
       "lastRefreshed":"...",
       "error":...,
       "warning":...,
       "information":...,
       "cpuName":"...",
       "cpuFrequencyInMHz":...,
       "numberOfCpus":...,
       "numberOfCores":...,
       "cpuCacheSizeInKB":...,
       "memorySizeInMB":...,
       "lidStatus":"...",
       "lidColor":"...",
       "lomDhcpEnable":"...",
       "lomIpAddress":"...",
       "lomSubnetMask":"...",
       "lomDefaultGateway":"...",
       "lomIpAddressV6":"...",
       "lomPrefixLengthV6":"...",
       "lomDefaultGatewayV6":"...",
       "currentFWVersion":"...",
       "currentLOMVersion":"...",
       "currentEFIVersion":"...",
       "updatingFWVersion":"...",
       "updatingLOMVersion":"...",
       "updatingEFIVersion":"...",
       "remoteConsoleUrl":"...",
       "wwnType":"...",
       "macType":"...",
       "osMode":"...",
       "firmwareRestartRequired":"...",
       "nmColdStandby":"...",
       "lpVersion":"...",
       "lpID":"...",
       "lpStatus":"...",
       "lpIpAddress":"...",
       "lpSubnetMask":"...",
       "lpDefaultGateway":"...",
       "lpVNICSystemNo":...,
       "lpSaveChangedConfig":"...",
       "lpVCPort":"...",
       "lpTimeZone":"...",
       "lpTimeSync":"...",
       "lpNTPServer1":"...",
       "lpNTPServer2":"...",
       "lpPreStateAutoAct":"...",
       "lpAutoShutdown":"...",
       "lpErrWatching":"...",
       "lpPhyCpuState":"...",
       "lpMaxSupportedNumOfLPARs":...,
       "lpMaxNumOfRunningLPARs":...,
       "lpAvailableMemoryNode":"...",
       "lpLPARMaxMemorySize":...,
       "lpLPARMemoryStep":...,
       "lpGuestNuma":"...",
       "lpPreBootFirmware":"...",
       "lpSolarisBoot":"...",
       "lpGuestIdleMode":"...",
       "lpLowLatency":"...",
       "lpLicenseHana":"...",
       "lpEpt1GB":"...",
       "lpPerformanceTuningOptions":"...",
       "lpMaxNumOfLogicalCpu":...
   },
   :
   ]
}

属性
データ型
数
説明

instanceId
string
1
URIでブレードサーバを特定する際に使用する識別子。serverUniqueKeyをbase64urlでエンコードした文字列。

chassisUniqueKey
string
1
ブレードサーバが搭載されているシャーシを特定する識別子。

serverUniqueKey
string
1
ブレードサーバを特定する識別子。

serverSerialNumber
string
1
サーバシリアル番号。ブレードサーバを特定するシリアル番号。

serverProductName
string
1
プロダクト名称。

manufacturer
string
1
メーカー名。

serverProductNumber
string
1
製品番号。

serverUuid
string
1
UUID。

partitionNo
integer
1
ブレードが挿入されているスロット番号。フルワイドブレードの場合は占有するスロットのうち小さい番号。SMP構成の場合は，プライマリサーバブレードが挿入されているスロット番号。

primarySlot
integer
1
ブレードが挿入されているスロット番号。フルワイドブレードの場合は占有するスロットのうち小さい番号。SMP構成の場合は，プライマリサーバブレードが挿入されているスロット番号。

partitionWidth
integer
1
ブレードサーバを構成するブレードの数。

slotWidth
integer
0～1
シャーシ内のスロットの数。

bladeNumber
string
0～1
ブレード番号。ブレードサーバを構成するブレードのブレード番号がコンマ区切りで列挙されます。

slotNumber
string
0～1
スロット番号。ブレードサーバを構成するブレードが挿入されているすべてのスロット番号がコンマ区切りで列挙されます。

partitionValid
string
1
ブレードサーバが使用できる状態かどうか。

TRUE：ブレードサーバは使用できます。

FALSE：ブレードサーバは使用できません。

healthStatus
string
1
ブレードサーバの稼働状態。

NORMAL：正常

WARNING：警告

FAIL：障害

UNKNOWN：不明

maintenanceMode
string
1
ブレードサーバの保守モードの設定。

TRUE：保守モードに設定されています。

FALSE：保守モードに設定されていません。

serverStatus
string
1
電源状態。

Running：起動

Stopped：停止。

Unknown：マネジメントモジュールとの通信失敗のため，状態不明。

lastRefreshed
dateTime
1
情報最終更新日時。

error
integer
1
解決していない障害レベルのアラート数。

warning
integer
1
解決していない警告レベルのアラート数。

information
integer
1
解決していない情報レベルのアラート数。

cpuName
string
1
CPU名称。

cpuFrequencyInMHz
float
1
CPUの動作周波数（MHz）。

numberOfCpus
integer
1
CPUの数。

numberOfCores
integer
1
CPUごとのコア数。

cpuCacheSizeInKB
double
1
CPUキャッシュサイズ（KB）。

memorySizeInMB
float
1
メモリーサイズ（MB）。

lidStatus
string
1
LID状態。

ON

OFF

BLINKING

SLOW_BLINKING

FAST_BLINKING

UNKNOWN

lidColor
string
1
LIDの表示色。

BLUE

GREEN

RED

ORANGE

UNKNOWN

lomDhcpEnable
string
1
BMCがDHCPを使用するかどうか。

TRUE

FALSE

lomIpAddress
string
1
BMCのIPアドレス（IPv4）。設定されていない場合，この値は空文字列です。

lomSubnetMask
string
1
BMCのサブネットマスク（IPv4）。設定されていない場合，この値は空文字列です。

lomDefaultGateway
string
1
BMCのデフォルトゲートウェイのIPアドレス（IPv4）。設定されていない場合，この値は空文字列です。

lomIpAddressV6
string
0～1
BMCのIPアドレス（IPv6）。設定されていない場合，この値は空文字列です。

lomPrefixLengthV6
string
0～1
BMCのプレフィックス長（IPv6）。設定されていない場合，この値は空文字列です。

lomDefaultGatewayV6
string
0～1
BMCのデフォルトゲートウェイのIPアドレス（IPv6）。設定されていない場合，この値は空文字列です。

currentFWVersion
string
1
現在動作中のファームウェアのバージョン。

currentLOMVersion
string
1
現在動作中のBMCのバージョン。

currentEFIVersion
string
1
現在動作中のEFIのバージョン。

updatingFWVersion
string
1
ブレードサーバを再起動したあとに動作するファームウェアのバージョン。

updatingLOMVersion
string
1
ブレードサーバを再起動したあとに動作するBMCのバージョン。

updatingEFIVersion
string
1
ブレードサーバを再起動したあとに動作するEFIのバージョン。

remoteConsoleUrl
string
1
リモートコンソールのURL。

wwnType
string
1
WWNの種類。

Original

Additional

Unknown

macType
string
1
MACアドレスの種類。

Original

Additional

Unknown

osMode
string
1
動作モード。

Basic

HVM

Unknown

firmwareRestartRequired
string
1
ファームウェアを更新したあと，反映するためにブレードサーバを再起動する必要があるかどうか。

TRUE：更新したファームウェアを反映させるために，ブレードサーバを再起動する必要があります。

FALSE：更新したファームウェアはすでに反映されています。

nmColdStandby
string
0～1
N+Mコールドスタンバイグループの現用ブレードまたは予備ブレードとして使用できるかどうか。

TRUE：N+Mコールドスタンバイグループの現用ブレードまたは予備ブレードとして使用できます。

FALSE：N+Mコールドスタンバイグループの現用ブレードまたは予備ブレードとして使用できません。

lpVersion
string
0～1
HVMのファームウェアバージョン。

lpID
string
0～1
HVMの識別子。

lpStatus
string
0～1
HVMの状態。

Running

Stopped

Unknown

lpIpAddress
string
0～1
HVMのIPアドレス。

lpSubnetMask
string
0～1
HVMのサブネットマスク。

lpDefaultGateway
string
0～1
HVMのデフォルトゲートウェイIPアドレス。

lpVNICSystemNo
integer
0～1
HVMのVNICシステム番号。論理分割の機能を使用するためのプラグインライセンスが未登録または無効の場合，この属性は生成されません。osModeが'HVM'以外の場合，または，ブレードサーバが論理分割の対象に追加されていない場合，この値は'-1'になります。

lpSaveChangedConfig
string
0～1
HVM起動時の構成情報フォーマットの変換後に，構成情報を自動保存するかどうか。論理分割の機能を使用するためのプラグインライセンスが未登録または無効の場合，この属性は生成されません。osModeが'HVM'以外か，または，ブレードサーバが論理分割の対象に追加されていない場合，この値は空文字列です。

Disable

Enable

lpVCPort
string
0～1
仮想COMコンソールポートのTCPポート番号（1024～65520）。論理分割の機能を使用するためのプラグインライセンスが未登録または無効の場合，この属性は生成されません。osModeが'HVM'以外の場合，または，ブレードサーバが論理分割の対象に追加されていない場合，この値は空文字列です。

lpTimeZone
string
0～1
HVMシステム時刻のタイムゾーン（書式：[+|-]hh:mm）。論理分割の機能を使用するためのプラグインライセンスが未登録または無効の場合，生成されません。osModeが'HVM'以外の場合，または，ブレードサーバが論理分割の対象に追加されていない場合，この値は空文字列です。

lpTimeSync
string
0～1
時刻同期の設定。論理分割の機能を使用するためのプラグインライセンスが未登録または無効の場合，この属性は生成されません。osModeが'HVM'以外の場合，または，ブレードサーバが論理分割の対象に追加されていない場合，この値は空文字列です。

Svp：マネジメントモジュールと時刻同期する

NTP：NTPサーバと時刻同期する

Disable：時刻同期しない

lpNTPServer1
string
0～1
NTPサーバ1のIPアドレス。論理分割の機能を使用するためのプラグインライセンスが未登録または無効の場合，この属性は生成されません。osModeが'HVM'以外の場合，または，ブレードサーバが論理分割の対象に追加されていない場合，この値は空文字列です。

lpNTPServer2
string
0～1
NTPサーバ2のIPアドレス。論理分割の機能を使用するためのプラグインライセンスが未登録または無効の場合，この属性は生成されません。osModeが'HVM'以外の場合，または，ブレードサーバが論理分割の対象に追加されていない場合，この値は空文字列です。

lpPreStateAutoAct
string
0～1
Pre-State Auto Activationの設定。論理分割の機能を使用するためのプラグインライセンスが未登録または無効の場合，この属性は生成されません。osModeが'HVM'以外の場合，または，ブレードサーバが論理分割の対象に追加されていない場合，この値は空文字列です。

Yes

No

lpAutoShutdown
string
0～1
HVM自動シャットダウンの設定。論理分割の機能を使用するためのプラグインライセンスが未登録または無効の場合，この属性は生成されません。osModeが'HVM'以外の場合，または，ブレードサーバが論理分割の対象に追加されていない場合，この値は空文字列です。

Yes

No

lpErrWatching
string
0～1
エラー監視の設定。論理分割の機能を使用するためのプラグインライセンスが未登録または無効の場合，この属性は生成されません。osModeが'HVM'以外の場合，または，ブレードサーバが論理分割の対象に追加されていない場合，この値は空文字列です。

Yes

No

lpPhyCpuState
string
0～1
省電力機能が有効か無効か。論理分割の機能を使用するためのプラグインライセンスが未登録または無効の場合，この属性は生成されません。osModeが'HVM'以外の場合，または，ブレードサーバが論理分割の対象に追加されていない場合，この値は空文字列です。

Enable

Disable

lpMaxSupportedNumOfLPARs
integer
0～1
作成できるLPARの最大数。論理分割の機能を使用するためのプラグインライセンスが未登録または無効の場合，この属性は生成されません。osModeが'HVM'以外の場合，または，ブレードサーバが論理分割の対象に追加されていない場合，この値は空文字列です。

lpMaxNumOfRunningLPARs
integer
0～1
同時に動作できるLPARの最大数。論理分割の機能を使用するためのプラグインライセンスが未登録または無効の場合，この属性は生成されません。osModeが'HVM'以外の場合，または，ブレードサーバが論理分割の対象に追加されていない場合，この値は空文字列です。

lpAvailableMemoryNode
string
0～1
有効なメモリーノード。NUMA設定が有効な場合，有効なメモリーノードをコンマでつないだ文字列（例：0,2,4,8）。論理分割の機能を使用するためのプラグインライセンスが未登録または無効の場合，この属性は生成されません。osModeが'HVM'以外の場合，または，ブレードサーバが論理分割の対象に追加されていない場合，この値は空文字列です。

lpLPARMaxMemorySize
float
0～1
LPARに設定できる最大メモリサイズ

lpLPARMemoryStep
float
0～1
LPARに設定できるメモリ・ステップサイズ

lpGuestNuma
string
0～1
HVMのゲストNUMA設定が有効か無効か。ブレードサーバがBasicモードの場合，またはゲストNUMAが有効か無効かを識別できない場合，この値は空文字列です。

Enable：ゲストNUMA機能が有効。

Disable：ゲストNUMA機能が無効。

lpPreBootFirmware
string
0～1
Pre-bootファームウェアとして64UEFIをサポートしているかどうか。論理分割の機能を使用するためのプラグインライセンスが未登録または無効の場合，この属性は生成されません。osModeが'HVM'以外の場合，または，ブレードサーバが論理分割の対象に追加されていない場合，この値は空文字列です。

Disable

Enable

lpSolarisBoot
string
0～1
OSタイプがSolaris設定をサポートしているかどうか。論理分割の機能を使用するためのプラグインライセンスが未登録または無効の場合，この属性は生成されません。osModeが'HVM'以外の場合，または，ブレードサーバが論理分割の対象に追加されていない場合，この値は空文字列です。

Disable

Enable

lpGuestIdleMode
string
0～1
HVMのゲストアイドルモードの設定が有効か無効か。論理分割の機能を使用するためのプラグインライセンスが未登録または無効の場合，この属性は生成されません。osModeが'HVM'以外の場合，または，ブレードサーバが論理分割の対象に追加されていない場合，この値は空文字列です。

Enable

Disable

lpLowLatency
string
0～1
HVMのLow Latency設定が有効か無効か。論理分割の機能を使用するためのプラグインライセンスが未登録または無効の場合，この属性は生成されません。osModeが'HVM'以外の場合，または，ブレードサーバが論理分割の対象に追加されていない場合，この値は空文字列です。

Enable

Disable

lpLicenseHana
string
0～1
HVMの追加ライセンスが有効か無効か。論理分割の機能を使用するためのプラグインライセンスが未登録または無効の場合，この属性は生成されません。osModeが'HVM'以外の場合，または，ブレードサーバが論理分割の対象に追加されていない場合，この値は空文字列です。

Enable

Disable

lpEpt1GB
string
0～1
HVMのEPT1GB機能が有効か無効か。論理分割の機能を使用するためのプラグインライセンスが未登録または無効の場合，この属性は生成されません。osModeが'HVM'以外の場合，または，ブレードサーバが論理分割の対象に追加されていない場合，この値は空文字列です。

Disable

Enable

lpPerformanceTuningOptions
string
0～1
この属性は未サポートのため，値は参照しないでください。

Disable

Enable

lpMaxNumOfLogicalCpu
integer
0～1
LPARに設定できる論理CPUの最大数。論理分割の機能を使用するためのプラグインライセンスが未登録または無効の場合，この属性は生成されません。osModeが'HVM'以外の場合，または，ブレードサーバが論理分割の対象に追加されていない場合，この値は空文字列です。

リターンコード

HTTPステータスコード | 結果コード | 詳細コード | 説明
200 | - | - | 正常終了。
204 | - | - | 指定したinstanceIDまたはcollectionはありません。
401 | 1000 | 1 | HTTPヘッダーのAuthorizationが指定されていません。
401 | 1000 | 2 | HTTPヘッダーのAuthorizationの値が不正です（Basic認証，HSSOセッション認証のどちらでもありません）。
401 | 1000 | 3 | HTTPヘッダーのAuthorizationのBasic認証の値が不正です（認証情報のフォーマットが不正です）。
401 | 1000 | 4 | ログインに失敗しました。
401 | 1002 | 1 | ログインセッションが切断されました。または，不正なHSSOトークンが指定されました。
403 | 1003 | 1 | 基本ライセンスが登録されていない，または有効期限を過ぎています。
403 | 2017 | 1 | 管理対象を参照または操作する権限がありません。
405 | - | - | サポートされていないメソッドです。
406 | 2010 | 1 | HTTPヘッダーのAcceptの値が不正です。
415 | - | - | HTTPヘッダーのContent-Typeにサポートされていない形式が指定されています。
500 | - | - | HTTPヘッダーのContent-Typeに不正な値が指定されている，またはそれ以外の内部エラーです。
500 | 1000 | 1 | ログインに失敗しました（内部エラー）。
500 | 3000 | 100 | 内部エラーが発生しました。
503 | 2020 | 1 | 要求の数がAPIの同時最大接続数を超えました。

3.5 マネジメントモジュールの情報を取得する

instanceIDに指定したシャーシに搭載されているすべてのマネジメントモジュールの情報を取得します。

ロール

Admin/Modify/View

リクエストライン

GET http://＜host＞:＜port＞/ComputeSystemsManager/v1/objects/Chassis/＜instanceID＞/collections/Managementmodule

instanceID:

chassisUniqueKeyをbase64urlでエンコードした文字列。

リクエストボディー

リクエストボディーには何も設定しません。

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。

ManagementModule

{
   "ManagementModule":[{
       "chassisUniqueKey":"...",
       "slotNo":...,
       "serialNumber":"...",
       "installStatus":"...",
       "active":"...",
       "powerStatus":"...",
       "healthStatus":"...",
       "maintenanceMode":"...",
       "modelNumber":"...",
       "lidStatus":"...",
       "lidColor":"...",
       "firmwareVersion":"...",
       "dictionaryVersion":"...",
       "parameterVersion":"...",
       "svpIpAddress":"...",
       "svpSubnetMask":"...",
       "svpDefaultGateway":"...",
       "svpIpAddressV6":"...",
       "svpPrefixLengthV6":"...",
       "svpDefaultGatewayV6":"...",
       "maintenanceIpAddress":"...",
       "maintenanceSubnetMask":"...",
       "maintenanceDefaultGateway":"..."
   },
   :
   ]
}

属性
データ型
数
説明

chassisUniqueKey
string
1
マネジメントモジュールが搭載されているシャーシを特定する識別子。

slotNo
integer
1
スロット番号。

serialNumber
string
0～1
シリアル番号。

installStatus
string
1
搭載状態。

INSTALL

NOT_INSTALL

NA

active
string
1
実行状態。

ACTIVE：主系。

NON_ACTIVE：待機系。

UNKNOWN：不明。

powerStatus
string
1
電源状態。

OFF

ON

UNKNOWN

healthStatus
string
1
マネジメントモジュールの稼働状態。

NORMAL：正常

WARNING：警告

FAIL：障害

UNKNOWN：不明

maintenanceMode
string
1
マネジメントモジュールの保守モードの設定。

TRUE：保守モードに設定されています。

FALSE：保守モードに設定されていません。

modelNumber
string
1
モデル番号。

lidStatus
string
1
LID状態。

ON

OFF

BLINKING

SLOW_BLINKING

FAST_BLINKING

UNKNOWN

lidColor
string
1
LIDの表示色。

BLUE

GREEN

RED

ORANGE

UNKNOWN

firmwareVersion
string
1
ファームウェアのバージョン。

dictionaryVersion
string
1
アラートの辞書バージョン。

parameterVersion
string
1
パラメーターバージョン。

svpIpAddress
string
1
SVP IPアドレス（IPv4）。値が設定されていない場合，空文字列です。

svpSubnetMask
string
1
SVPサブネットマスク（IPv4）。値が設定されていない場合，空文字列です。

svpDefaultGateway
string
1
SVPデフォルトゲートウェイアドレス（IPv4）。値が設定されていない場合，空文字列です。

svpIpAddressV6
string
0～1
SVP IPアドレス（IPv6）。値が設定されていない場合，空文字列です。

svpPrefixLengthV6
string
0～1
SVPプリフィックスマスク（IPv6）。値が設定されていない場合，空文字列です。

svpDefaultGatewayV6
string
0～1
SVPデフォルトゲートウェイアドレス（IPv6）。値が設定されていない場合，空文字列です。

maintenanceIpAddress
string
1
保守LAN設定のIPアドレス。値が設定されていない場合，空文字列です。

maintenanceSubnetMask
string
1
保守LAN設定のサブネットマスク。値が設定されていない場合，空文字列です。

maintenanceDefaultGateway
string
1
保守LAN設定のデフォルトゲートウェイアドレス。値が設定されていない場合，空文字列です。

リターンコード

HTTPステータスコード | 結果コード | 詳細コード | 説明
200 | - | - | 正常終了。
204 | - | - | 指定したinstanceIDまたはcollectionはありません。
401 | 1000 | 1 | HTTPヘッダーのAuthorizationが指定されていません。
401 | 1000 | 2 | HTTPヘッダーのAuthorizationの値が不正です（Basic認証，HSSOセッション認証のどちらでもありません）。
401 | 1000 | 3 | HTTPヘッダーのAuthorizationのBasic認証の値が不正です（認証情報のフォーマットが不正です）。
401 | 1000 | 4 | ログインに失敗しました。
401 | 1002 | 1 | ログインセッションが切断されました。または，不正なHSSOトークンが指定されました。
403 | 1003 | 1 | 基本ライセンスが登録されていない，または有効期限を過ぎています。
403 | 2017 | 1 | 管理対象を参照または操作する権限がありません。
405 | - | - | サポートされていないメソッドです。
406 | 2010 | 1 | HTTPヘッダーのAcceptの値が不正です。
415 | - | - | HTTPヘッダーのContent-Typeにサポートされていない形式が指定されています。
500 | - | - | HTTPヘッダーのContent-Typeに不正な値が指定されている，またはそれ以外の内部エラーです。
500 | 1000 | 1 | ログインに失敗しました（内部エラー）。
500 | 3000 | 100 | 内部エラーが発生しました。
503 | 2020 | 1 | 要求の数がAPIの同時最大接続数を超えました。

3.6 スイッチモジュールの情報を取得する

instanceIDに指定したシャーシに搭載されているすべてのスイッチモジュールの情報を取得します。

ロール

Admin/Modify/View

リクエストライン

GET http://＜host＞:＜port＞/ComputeSystemsManager/v1/objects/Chassis/＜instanceID＞/collections/Switchmodule

instanceID:

chassisUniqueKeyをbase64urlでエンコードした文字列。

リクエストボディー

リクエストボディーには何も設定しません。

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。

SwitchModule

{
   "SwitchModule":[{
       "chassisUniqueKey":"...",
       "switchUniqueKey":"...",
       "serialNumber":"...",
       "slotNo":...,
       "installStatus":"...",
       "powerStatus":"...",
       "healthStatus":"...",
       "maintenanceMode":"...",
       "switchType":"...",
       "modelNumber":"...",
       "lidStatus":"...",
       "lidColor":"...",
       "firmwareVersion":"...",
       "ipAddress":"...",
       "subnetMask":"...",
       "defaultGateway":"..."
   },
   :
   ]
}

属性
データ型
数
説明

chassisUniqueKey
string
1
スイッチモジュールが搭載されているシャーシを特定する識別子。

switchUniqueKey
string
1
スイッチユニークキー。スイッチモジュールを特定する識別子。

serialNumber
string
1
シリアル番号。

slotNo
integer
1
スロット番号。

installStatus
string
1
搭載状態。

INSTALL

NOT_INSTALL

NA

powerStatus
string
1
電源状態。

OFF

ON

UNKNOWN

healthStatus
string
1
スイッチモジュールの稼働状態。

NORMAL：正常

WARNING：警告

FAIL：障害

UNKNOWN：不明

maintenanceMode
string
1
スイッチモジュールの保守モードの設定。

TRUE：保守モードに設定されています。

FALSE：保守モードに設定されていません。

switchType
string
1
スイッチモジュールの種類。
例：
'1Gb LAN SW'
'1/10Gb LAN SW'
'8Gb FC SW'
'10Gb DCB Switch Module'
'LAN pass through'
'1Gb 40 ports LAN SW'
'JIG SW'
'Unknown'

modelNumber
string
1
モデル番号。

lidStatus
string
1
LID状態。

ON

OFF

BLINKING

SLOW_BLINKING

FAST_BLINKING

UNKNOWN

lidColor
string
1
LIDの表示色。

BLUE

GREEN

RED

ORANGE

UNKNOWN

firmwareVersion
string
1
ファームウェアバージョン。

ipAddress
string
1
IPアドレス。値が設定されていない場合，空文字列です。

subnetMask
string
1
サブネットマスク。値が設定されていない場合，空文字列です。

defaultGateway
string
1
デフォルトゲートウェイIPアドレス。値が設定されていない場合，空文字列です。

リターンコード

HTTPステータスコード | 結果コード | 詳細コード | 説明
200 | - | - | 正常終了。
204 | - | - | 指定したinstanceIDまたはcollectionはありません。
401 | 1000 | 1 | HTTPヘッダーのAuthorizationが指定されていません。
401 | 1000 | 2 | HTTPヘッダーのAuthorizationの値が不正です（Basic認証，HSSOセッション認証のどちらでもありません）。
401 | 1000 | 3 | HTTPヘッダーのAuthorizationのBasic認証の値が不正です（認証情報のフォーマットが不正です）。
401 | 1000 | 4 | ログインに失敗しました。
401 | 1002 | 1 | ログインセッションが切断されました。または，不正なHSSOトークンが指定されました。
403 | 1003 | 1 | 基本ライセンスが登録されていない，または有効期限を過ぎています。
403 | 2017 | 1 | 管理対象を参照または操作する権限がありません。
405 | - | - | サポートされていないメソッドです。
406 | 2010 | 1 | HTTPヘッダーのAcceptの値が不正です。
415 | - | - | HTTPヘッダーのContent-Typeにサポートされていない形式が指定されています。
500 | - | - | HTTPヘッダーのContent-Typeに不正な値が指定されている，またはそれ以外の内部エラーです。
500 | 1000 | 1 | ログインに失敗しました（内部エラー）。
500 | 3000 | 100 | 内部エラーが発生しました。
503 | 2020 | 1 | 要求の数がAPIの同時最大接続数を超えました。

3.7 ファンモジュールの情報を取得する

instanceIDに指定したシャーシに搭載されているすべてのファンモジュールの情報を取得します。

ロール

Admin/Modify/View

リクエストライン

GET http://＜host＞:＜port＞/ComputeSystemsManager/v1/objects/Chassis/＜instanceID＞/collections/Fanmodule

instanceID:

chassisUniqueKeyをbase64urlでエンコードした文字列。

リクエストボディー

リクエストボディーには何も設定しません。

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。

FANModule

{
   "FANModule":[{
       "chassisUniqueKey":"...",
       "slotNo":...,
       "location":"...",
       "installStatus":"...",
       "powerStatus":"...",
       "healthStatus":"..."
   },
   :
   ]
}

属性
データ型
数
説明

chassisUniqueKey
string
1
ファンモジュールが搭載されているシャーシを特定する識別子。

slotNo
integer
1
スロット番号。

location
string
0～1
ブレードサーバの場合，値は空文字になります。

installStatus
string
1
搭載状態。

INSTALL

NOT_INSTALL

NA

powerStatus
string
1
電源状態。

OFF

ON

UNKNOWN

healthStatus
string
1
ファンモジュールの稼働状態。

NORMAL：正常

WARNING：警告

FAIL：障害

UNKNOWN：不明

リターンコード

HTTPステータスコード | 結果コード | 詳細コード | 説明
200 | - | - | 正常終了。
204 | - | - | 指定したinstanceIDまたはcollectionはありません。
401 | 1000 | 1 | HTTPヘッダーのAuthorizationが指定されていません。
401 | 1000 | 2 | HTTPヘッダーのAuthorizationの値が不正です（Basic認証，HSSOセッション認証のどちらでもありません）。
401 | 1000 | 3 | HTTPヘッダーのAuthorizationのBasic認証の値が不正です（認証情報のフォーマットが不正です）。
401 | 1000 | 4 | ログインに失敗しました。
401 | 1002 | 1 | ログインセッションが切断されました。または，不正なHSSOトークンが指定されました。
403 | 1003 | 1 | 基本ライセンスが登録されていない，または有効期限を過ぎています。
403 | 2017 | 1 | 管理対象を参照または操作する権限がありません。
405 | - | - | サポートされていないメソッドです。
406 | 2010 | 1 | HTTPヘッダーのAcceptの値が不正です。
415 | - | - | HTTPヘッダーのContent-Typeにサポートされていない形式が指定されています。
500 | - | - | HTTPヘッダーのContent-Typeに不正な値が指定されている，またはそれ以外の内部エラーです。
500 | 1000 | 1 | ログインに失敗しました（内部エラー）。
500 | 3000 | 100 | 内部エラーが発生しました。
503 | 2020 | 1 | 要求の数がAPIの同時最大接続数を超えました。

3.8 電源モジュールの情報を取得する

instanceIDに指定したシャーシに搭載されているすべての電源モジュールの情報を取得します。

ロール

Admin/Modify/View

リクエストライン

GET http://＜host＞:＜port＞/ComputeSystemsManager/v1/objects/Chassis/＜instanceID＞/collections/Powersupplymodule

instanceID:

chassisUniqueKeyをbase64urlでエンコードした文字列。

リクエストボディー

リクエストボディーには何も設定しません。

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。

PowerSupplyModule

{
   "PowerSupplyModule":[{
       "chassisUniqueKey":"...",
       "slotNo":...,
       "location":"...",
       "installStatus":"...",
       "productName":"...",
       "modelNumber":"...",
       "serialNumber":"...",
       "powerStatus":"...",
       "healthStatus":"..."
   },
   :
   ]
}

属性
データ型
数
説明

chassisUniqueKey
string
1
電源モジュールが搭載されているシャーシを特定する識別子。

slotNo
integer
1
スロット番号。

location
string
0～1
ブレードサーバの場合，値は空文字になります。

installStatus
string
1
搭載状態。

INSTALL

NOT_INSTALL

NA

productName
string
1
プロダクト名称。

modelNumber
string
1
モデル番号。

serialNumber
string
1
シリアル番号。

powerStatus
string
1
電源状態。

OFF

ON

UNKNOWN

healthStatus
string
1
電源モジュールの稼働状態。

NORMAL：正常

WARNING：警告

FAIL：障害

UNKNOWN：不明

リターンコード

HTTPステータスコード | 結果コード | 詳細コード | 説明
200 | - | - | 正常終了。
204 | - | - | 指定したinstanceIDまたはcollectionはありません。
401 | 1000 | 1 | HTTPヘッダーのAuthorizationが指定されていません。
401 | 1000 | 2 | HTTPヘッダーのAuthorizationの値が不正です（Basic認証，HSSOセッション認証のどちらでもありません）。
401 | 1000 | 3 | HTTPヘッダーのAuthorizationのBasic認証の値が不正です（認証情報のフォーマットが不正です）。
401 | 1000 | 4 | ログインに失敗しました。
401 | 1002 | 1 | ログインセッションが切断されました。または，不正なHSSOトークンが指定されました。
403 | 1003 | 1 | 基本ライセンスが登録されていない，または有効期限を過ぎています。
403 | 2017 | 1 | 管理対象を参照または操作する権限がありません。
405 | - | - | サポートされていないメソッドです。
406 | 2010 | 1 | HTTPヘッダーのAcceptの値が不正です。
415 | - | - | HTTPヘッダーのContent-Typeにサポートされていない形式が指定されています。
500 | - | - | HTTPヘッダーのContent-Typeに不正な値が指定されている，またはそれ以外の内部エラーです。
500 | 1000 | 1 | ログインに失敗しました（内部エラー）。
500 | 3000 | 100 | 内部エラーが発生しました。
503 | 2020 | 1 | 要求の数がAPIの同時最大接続数を超えました。

3.9 マネジメントLANモジュールの情報を取得する

instanceIDに指定したシャーシに搭載されているすべてのマネジメントLANモジュールの情報を取得します。

ロール

Admin/Modify/View

リクエストライン

GET http://＜host＞:＜port＞/ComputeSystemsManager/v1/objects/Chassis/＜instanceID＞/collections/Managementlanmodule

instanceID:

chassisUniqueKeyをbase64urlでエンコードした文字列。

リクエストボディー

リクエストボディーには何も設定しません。

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。

ManagementLanModule

{
   "ManagementLanModule":[{
       "chassisUniqueKey":"...",
       "slotNo":...,
       "installStatus":"...",
       "powerStatus":"...",
       "healthStatus":"...",
       "lidStatus":"...",
       "lidColor":"..."
   },
   :
   ]
}

属性
データ型
数
説明

chassisUniqueKey
string
1
管理LANモジュールが搭載されているシャーシを特定する識別子。

slotNo
integer
1
スロット番号。

installStatus
string
1
搭載状態。

INSTALL

NOT_INSTALL

NA

powerStatus
string
1
電源状態。

OFF

ON

UNKNOWN

healthStatus
string
1
マネジメントLANモジュールの稼働状態。

NORMAL：正常

WARNING：警告

FAIL：障害

UNKNOWN：不明

lidStatus
string
1
LID状態。

ON

OFF

BLINKING

SLOW_BLINKING

FAST_BLINKING

UNKNOWN

lidColor
string
1
LIDの表示色。

BLUE

GREEN

RED

ORANGE

UNKNOWN

リターンコード

HTTPステータスコード | 結果コード | 詳細コード | 説明
200 | - | - | 正常終了。
204 | - | - | 指定したinstanceIDまたはcollectionはありません。
401 | 1000 | 1 | HTTPヘッダーのAuthorizationが指定されていません。
401 | 1000 | 2 | HTTPヘッダーのAuthorizationの値が不正です（Basic認証，HSSOセッション認証のどちらでもありません）。
401 | 1000 | 3 | HTTPヘッダーのAuthorizationのBasic認証の値が不正です（認証情報のフォーマットが不正です）。
401 | 1000 | 4 | ログインに失敗しました。
401 | 1002 | 1 | ログインセッションが切断されました。または，不正なHSSOトークンが指定されました。
403 | 1003 | 1 | 基本ライセンスが登録されていない，または有効期限を過ぎています。
403 | 2017 | 1 | 管理対象を参照または操作する権限がありません。
405 | - | - | サポートされていないメソッドです。
406 | 2010 | 1 | HTTPヘッダーのAcceptの値が不正です。
415 | - | - | HTTPヘッダーのContent-Typeにサポートされていない形式が指定されています。
500 | - | - | HTTPヘッダーのContent-Typeに不正な値が指定されている，またはそれ以外の内部エラーです。
500 | 1000 | 1 | ログインに失敗しました（内部エラー）。
500 | 3000 | 100 | 内部エラーが発生しました。
503 | 2020 | 1 | 要求の数がAPIの同時最大接続数を超えました。

3.10 I/Oボードモジュールの情報を取得する

instanceIDに指定したシャーシに搭載されているすべてのI/Oボードモジュールの情報を取得します。

ロール

Admin/Modify/View

リクエストライン

GET http://＜host＞:＜port＞/ComputeSystemsManager/v1/objects/Chassis/＜instanceID＞/collections/Iobdmodules

instanceID:

chassisUniqueKeyをbase64urlでエンコードした文字列。

リクエストボディー

リクエストボディーには何も設定しません。

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。

IOBDModule

{
   "IOBDModule":[{
       "chassisUniqueKey":"...",
       "serverUniqueKey":"...",
       "serverBladeNumber":...,
       "cardSlotName":"...",
       "cardSlotNumber":...,
       "cardInstallStatus":"...",
       "powerStatus":"...",
       "healthStatus":"...",
       "lidStatus":"...",
       "lidColor":"...",
       "cardType":"...",
       "cardName":"..."
   },
   :
   ]
}

属性
データ型
数
説明

chassisUniqueKey
string
1
I/Oボードモジュールが搭載されているシャーシを特定する識別子。

serverUniqueKey
string
1
I/Oボードモジュールが搭載されているブレードサーバを特定する識別子。

serverBladeNumber
integer
1
I/O ボードモジュールが搭載されているブレードの番号。ブレードサーバとして使用していない場合は'-1'。

cardSlotName
string
1
カードスロット名。

cardSlotNumber
integer
1
カードスロット番号。不明の場合は'-1'。

cardInstallStatus
string
1
カード搭載状態。

INSTALL

NOT_INSTALL

NA

powerStatus
string
1
電源状態。

OFF

ON

UNKNOWN

healthStatus
string
1
IO ボードモジュールの稼働状態。

NORMAL：正常

WARNING：警告

FAIL：障害

UNKNOWN：不明

lidStatus
string
1
LID状態。

ON

OFF

BLINKING

SLOW_BLINKING

FAST_BLINKING

UNKNOWN

lidColor
string
1
LIDの表示色。

BLUE

GREEN

RED

ORANGE

UNKNOWN

cardType
string
1
カード種別。カードが搭載されていない場合，空文字列。

MEZZANINE

PCI

ONBOARD

PCI_IOEU

PCI_IOBD

cardName
string
1
カードの名前。カードが搭載されていない場合，空文字列。
例：'Emulex 10Gb 4-port converged network mezzanine card'

リターンコード

HTTPステータスコード | 結果コード | 詳細コード | 説明
200 | - | - | 正常終了。
204 | - | - | 指定したinstanceIDまたはcollectionはありません。
401 | 1000 | 1 | HTTPヘッダーのAuthorizationが指定されていません。
401 | 1000 | 2 | HTTPヘッダーのAuthorizationの値が不正です（Basic認証，HSSOセッション認証のどちらでもありません）。
401 | 1000 | 3 | HTTPヘッダーのAuthorizationのBasic認証の値が不正です（認証情報のフォーマットが不正です）。
401 | 1000 | 4 | ログインに失敗しました。
401 | 1002 | 1 | ログインセッションが切断されました。または，不正なHSSOトークンが指定されました。
403 | 1003 | 1 | 基本ライセンスが登録されていない，または有効期限を過ぎています。
403 | 2017 | 1 | 管理対象を参照または操作する権限がありません。
405 | - | - | サポートされていないメソッドです。
406 | 2010 | 1 | HTTPヘッダーのAcceptの値が不正です。
415 | - | - | HTTPヘッダーのContent-Typeにサポートされていない形式が指定されています。
500 | - | - | HTTPヘッダーのContent-Typeに不正な値が指定されている，またはそれ以外の内部エラーです。
500 | 1000 | 1 | ログインに失敗しました（内部エラー）。
500 | 3000 | 100 | 内部エラーが発生しました。
503 | 2020 | 1 | 要求の数がAPIの同時最大接続数を超えました。

3.11 シャーシのLIDを点灯する

instanceIDに指定したシャーシのLIDを点灯します。

ロール

Admin/Modify

リクエストライン

PUT http://＜host＞:＜port＞/ComputeSystemsManager/v1/objects/Chassis/＜instanceID＞/actions/Lidon/invoke

instanceID:

chassisUniqueKeyをbase64urlでエンコードした文字列。

リクエストボディー

リクエストボディーには何も設定しません。

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。

ApiResult

{
       "id":...
}

属性 | データ型 | 数 | 説明
id | integer | 1 | シャーシのLIDを点灯するために登録されたタスクのタスクIDが返ります。

リターンコード

HTTPステータスコード | 結果コード | 詳細コード | 説明
200 | - | - | 正常終了。
401 | 1000 | 1 | HTTPヘッダーのAuthorizationが指定されていません。
401 | 1000 | 2 | HTTPヘッダーのAuthorizationの値が不正です（Basic認証，HSSOセッション認証のどちらでもありません）。
401 | 1000 | 3 | HTTPヘッダーのAuthorizationのBasic認証の値が不正です（認証情報のフォーマットが不正です）。
401 | 1000 | 4 | ログインに失敗しました。
401 | 1002 | 1 | ログインセッションが切断されました。または，不正なHSSOトークンが指定されました。
403 | 1003 | 1 | 基本ライセンスが登録されていない，または有効期限を過ぎています。
403 | 2017 | 1 | 管理対象を参照または操作する権限がありません。
404 | - | - | 指定したinstanceIDまたはcollectionはありません。
405 | - | - | サポートされていないメソッドです。
406 | 2010 | 1 | HTTPヘッダーのAcceptの値が不正です。
412 | 2012 | 100 | 指定されたシャーシはLID操作をサポートしていません。
415 | - | - | HTTPヘッダーのContent-Typeにサポートされていない形式が指定されています。
500 | - | - | HTTPヘッダーのContent-Typeに不正な値が指定されている，またはそれ以外の内部エラーです。
500 | 1000 | 1 | ログインに失敗しました（内部エラー）。
500 | 3000 | 100 | 内部エラーが発生しました。
503 | 2020 | 1 | 要求の数がAPIの同時最大接続数を超えました。
503 | 2020 | 2 | タスク登録に失敗しました。しばらくしてから，再度実行してください。

3.12 シャーシのLIDを消灯する

instanceIDに指定したシャーシのLIDを消灯します。

ロール

Admin/Modify

リクエストライン

PUT http://＜host＞:＜port＞/ComputeSystemsManager/v1/objects/Chassis/＜instanceID＞/actions/Lidoff/invoke

instanceID:

chassisUniqueKeyをbase64urlでエンコードした文字列。

リクエストボディー

リクエストボディーには何も設定しません。

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。

ApiResult

{
       "id":...
}

属性 | データ型 | 数 | 説明
id | integer | 1 | シャーシのLIDを消灯するために登録されたタスクのタスクIDが返ります。

リターンコード

HTTPステータスコード | 結果コード | 詳細コード | 説明
200 | - | - | 正常終了。
401 | 1000 | 1 | HTTPヘッダーのAuthorizationが指定されていません。
401 | 1000 | 2 | HTTPヘッダーのAuthorizationの値が不正です（Basic認証，HSSOセッション認証のどちらでもありません）。
401 | 1000 | 3 | HTTPヘッダーのAuthorizationのBasic認証の値が不正です（認証情報のフォーマットが不正です）。
401 | 1000 | 4 | ログインに失敗しました。
401 | 1002 | 1 | ログインセッションが切断されました。または，不正なHSSOトークンが指定されました。
403 | 1003 | 1 | 基本ライセンスが登録されていない，または有効期限を過ぎています。
403 | 2017 | 1 | 管理対象を参照または操作する権限がありません。
404 | - | - | 指定したinstanceIDまたはcollectionはありません。
405 | - | - | サポートされていないメソッドです。
406 | 2010 | 1 | HTTPヘッダーのAcceptの値が不正です。
412 | 2012 | 100 | 指定されたシャーシはLID操作をサポートしていません。
415 | - | - | HTTPヘッダーのContent-Typeにサポートされていない形式が指定されています。
500 | - | - | HTTPヘッダーのContent-Typeに不正な値が指定されている，またはそれ以外の内部エラーです。
500 | 1000 | 1 | ログインに失敗しました（内部エラー）。
500 | 3000 | 100 | 内部エラーが発生しました。
503 | 2020 | 1 | 要求の数がAPIの同時最大接続数を超えました。
503 | 2020 | 2 | タスク登録に失敗しました。しばらくしてから，再度実行してください。

3.13 シャーシの情報を更新する

instanceIDに指定したシャーシの情報を更新します。

ロール

Admin/Modify

リクエストライン

PUT http://＜host＞:＜port＞/ComputeSystemsManager/v1/objects/Chassis/＜instanceID＞/actions/Refresh/invoke

instanceID:

chassisUniqueKeyをbase64urlでエンコードした文字列。

リクエストボディー

リクエストボディーには何も設定しません。

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。

ApiResult

{
       "id":...
}

属性 | データ型 | 数 | 説明
id | integer | 1 | シャーシの情報を更新するために登録されたタスクのタスクIDが返ります。

リターンコード

HTTPステータスコード | 結果コード | 詳細コード | 説明
200 | - | - | 正常終了。
401 | 1000 | 1 | HTTPヘッダーのAuthorizationが指定されていません。
401 | 1000 | 2 | HTTPヘッダーのAuthorizationの値が不正です（Basic認証，HSSOセッション認証のどちらでもありません）。
401 | 1000 | 3 | HTTPヘッダーのAuthorizationのBasic認証の値が不正です（認証情報のフォーマットが不正です）。
401 | 1000 | 4 | ログインに失敗しました。
401 | 1002 | 1 | ログインセッションが切断されました。または，不正なHSSOトークンが指定されました。
403 | 1003 | 1 | 基本ライセンスが登録されていない，または有効期限を過ぎています。
403 | 2017 | 1 | 管理対象を参照または操作する権限がありません。
404 | - | - | 指定したinstanceIDまたはcollectionはありません。
405 | - | - | サポートされていないメソッドです。
406 | 2010 | 1 | HTTPヘッダーのAcceptの値が不正です。
415 | - | - | HTTPヘッダーのContent-Typeにサポートされていない形式が指定されています。
500 | - | - | HTTPヘッダーのContent-Typeに不正な値が指定されている，またはそれ以外の内部エラーです。
500 | 1000 | 1 | ログインに失敗しました（内部エラー）。
500 | 3000 | 100 | 内部エラーが発生しました。
503 | 2020 | 1 | 要求の数がAPIの同時最大接続数を超えました。
503 | 2020 | 2 | タスク登録に失敗しました。しばらくしてから，再度実行してください。

4. LPAR

この章では，LPARの情報取得に関するAPIについて説明します。

この章の構成

4.1 すべてのLPARの情報を取得する

4.2 特定のLPARの情報を取得する

4.3 論理プロセッサの情報を取得する

4.4 仮想NICポートの情報を取得する

4.5 占有NICポートの情報を取得する

4.6 共有FCポートの情報を取得する

4.7 占有FCポートの情報を取得する

4.8 USBの情報を取得する

4.1 すべてのLPARの情報を取得する

APIを実行するユーザーの権限で参照できるすべてのLPARの情報を取得します。

ロール

Admin/Modify/View

リクエストライン

GET http://＜host＞:＜port＞/ComputeSystemsManager/v1/objects/Lpars

リクエストボディー

リクエストボディーには何も設定しません。

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。

Lpar

{
   "Lpar":[{
       "instanceId":"...",
       "serverUniqueKey":"...",
       "lparNo":...,
       "lparName":"...",
       "lparManagerId":"...",
       "lparStatus":"...",
       "migrationStatus":"...",
       "lastRefreshed":"...",
       "error":...,
       "warning":...,
       "information":...,
       "activationOrder":"...",
       "autoClearSystemEventLog":"...",
       "virtualConsole":"...",
       "cpuAllocation":"...",
       "numberOfLogicalCpus":...,
       "cpuGroup":...,
       "cpuAllocationRatio":...,
       "cpuIdleDetection":"...",
       "cpuPerformanceCapping":"...",
       "memorySizeInMB":...,
       "memoryNode":"...",
       "guestNUMA":"...",
       "preBootFirmware":"...",
       "guestOs":"...",
       "guestIdleMode":"...",
       "lowLatency":"..."
   },
   :
   ]
}

属性
データ型
数
説明

instanceId
string
1
URIでLPARを特定する際に使用する識別子。serverUniqueKey＋"_"＋LPAR番号をbase64urlでエンコードした文字列。

serverUniqueKey
string
1
LPARが搭載されているブレードサーバを特定する識別子。

lparNo
integer
1
LPAR番号。

lparName
string
1
LPAR名。

lparManagerId
string
1
HVM ID。

lparStatus
string
1
LPARの稼働状態。

ACT：作動中

DEACT：停止中

UNKNOWN

migrationStatus
string
1
マイグレーションの実行状態。

NONE：なし。マイグレーションしていません。

NEED：マイグレーション失敗。要回復。

FAILURE：マイグレーション失敗。回復不可能。

INPROGRESS：マイグレーション実行中。

RECOVERING：回復中。

UNKNOWN：不明。

lastRefreshed
dateTime
1
最終更新日時。

error
integer
1
解決していない障害レベルのアラート数。

warning
integer
1
解決していない警告レベルのアラート数。

information
integer
1
解決していない情報レベルのアラート数。

activationOrder
string
1
LPARが自動起動する際の起動順序（1～99）。HVM起動時に，数値の昇順にLPARを自動起動します。

*：自動起動しません。

autoClearSystemEventLog
string
1
システムイベントログの自動削除の設定。

Disable

Enable

virtualConsole
string
1
仮想COMコンソール機能の有効/無効の設定。仮想COMコンソール機能が有効な場合は，仮想COM番号（整数）。無効な場合は'*'。

cpuAllocation
string
1
CPUの割り当てモード。

Share：共有モード。

Dedicate：占有モード。

numberOfLogicalCpus
integer
1
論理プロセッサの数。

cpuGroup
integer
1
プロセッサグループ。

cpuAllocationRatio
integer
1
プロセッサのサービス率（1～999）。cpuAllocationの値がShareの場合に有効な情報です。

cpuIdleDetection
string
1
アイドル検出機能の設定。

Disable

Enable

cpuPerformanceCapping
string
1
プロセッサキャッピング機能の設定。

Disable

Enable

memorySizeInMB
integer
1
メモリーサイズ（MB）。

memoryNode
string
1
メモリーノード。

メモリーノード番号（整数値）：割り当てるメモリーノードを設定した場合。

Automatically：自動的に割り当てられる場合。

Automatically(Multiple)：複数のノードが割り当てられている場合。

GuestNUMA：ゲストNUMAが有効な場合。

guestNUMA
string
0～1
ゲストNUMA機能の設定。

Disable

Enable

preBootFirmware
string
1
Pre-bootファームウェアの種別。

BIOS

64UEFI

guestOs
string
1
OS種別。

Default

Solaris

guestIdleMode
string
0～1
ゲストアイドルモードの種別。アイドル検出機能の設定がEnableの場合，またはゲストアイドルモードがサポートされていない場合，空文字列です。

Halt

Poll

Mwait

lowLatency
string
0～1
Low Latency機能の設定。HVMがLow Latency機能をサポートしていない場合，空文字列です。

Disable

Enable

リターンコード

HTTPステータスコード | 結果コード | 詳細コード | 説明
200 | - | - | 正常終了。
401 | 1000 | 1 | HTTPヘッダーのAuthorizationが指定されていません。
401 | 1000 | 2 | HTTPヘッダーのAuthorizationの値が不正です（Basic認証，HSSOセッション認証のどちらでもありません）。
401 | 1000 | 3 | HTTPヘッダーのAuthorizationのBasic認証の値が不正です（認証情報のフォーマットが不正です）。
401 | 1000 | 4 | ログインに失敗しました。
401 | 1002 | 1 | ログインセッションが切断されました。または，不正なHSSOトークンが指定されました。
403 | 1003 | 1 | 基本ライセンスが登録されていない，または有効期限を過ぎています。
403 | 1003 | 100 | 論理分割の機能を使用するためのプラグインライセンスがありません。
403 | 2017 | 1 | 管理対象を参照する権限がありません。
405 | - | - | サポートされていないメソッドです。
406 | 2010 | 1 | HTTPヘッダーのAcceptの値が不正です。
415 | - | - | HTTPヘッダーのContent-Typeにサポートされていない形式が指定されています。
500 | - | - | HTTPヘッダーのContent-Typeに不正な値が指定されている，またはそれ以外の内部エラーです。
500 | 1000 | 1 | ログインに失敗しました（内部エラー）。
500 | 3000 | 100 | 内部エラーが発生しました。
503 | 2020 | 1 | 要求の数がAPIの同時最大接続数を超えました。

4.2 特定のLPARの情報を取得する

instanceIDに指定したLPARの情報を取得します。

ロール

Admin/Modify/View

リクエストライン

GET http://＜host＞:＜port＞/ComputeSystemsManager/v1/objects/Lpars/＜instanceID＞

instanceID:

serverUniqueKey＋"_"＋LPAR番号をbase64urlでエンコードした文字列。

リクエストボディー

リクエストボディーには何も設定しません。

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。

Lpar

{
   "Lpar":[{
       "instanceId":"...",
       "serverUniqueKey":"...",
       "lparNo":...,
       "lparName":"...",
       "lparManagerId":"...",
       "lparStatus":"...",
       "migrationStatus":"...",
       "lastRefreshed":"...",
       "error":...,
       "warning":...,
       "information":...,
       "activationOrder":"...",
       "autoClearSystemEventLog":"...",
       "virtualConsole":"...",
       "cpuAllocation":"...",
       "numberOfLogicalCpus":...,
       "cpuGroup":...,
       "cpuAllocationRatio":...,
       "cpuIdleDetection":"...",
       "cpuPerformanceCapping":"...",
       "memorySizeInMB":...,
       "memoryNode":"...",
       "guestNUMA":"...",
       "preBootFirmware":"...",
       "guestOs":"...",
       "guestIdleMode":"...",
       "lowLatency":"..."
   }]
}

属性
データ型
数
説明

instanceId
string
1
URIでLPARを特定する際に使用する識別子。serverUniqueKey＋"_"＋LPAR番号をbase64urlでエンコードした文字列。

serverUniqueKey
string
1
LPARが搭載されているブレードサーバを特定する識別子。

lparNo
integer
1
LPAR番号。

lparName
string
1
LPAR名。

lparManagerId
string
1
HVM ID。

lparStatus
string
1
LPARの稼働状態。

ACT：作動中

DEACT：停止中

UNKNOWN

migrationStatus
string
1
マイグレーションの実行状態。

NONE：なし。マイグレーションしていません。

NEED：マイグレーション失敗。要回復。

FAILURE：マイグレーション失敗。回復不可能。

INPROGRESS：マイグレーション実行中。

RECOVERING：回復中。

UNKNOWN：不明。

lastRefreshed
dateTime
1
最終更新日時。

error
integer
1
解決していない障害レベルのアラート数。

warning
integer
1
解決していない警告レベルのアラート数。

information
integer
1
解決していない情報レベルのアラート数。

activationOrder
string
1
LPARが自動起動する際の起動順序（1～99）。HVM起動時に，数値の昇順にLPARを自動起動します。

*：自動起動しません。

autoClearSystemEventLog
string
1
システムイベントログの自動削除の設定。

Disable

Enable

virtualConsole
string
1
仮想COMコンソール機能の有効/無効の設定。仮想COMコンソール機能が有効な場合は，仮想COM番号（整数）。無効な場合は'*'。

cpuAllocation
string
1
CPUの割り当てモード。

Share：共有モード。

Dedicate：占有モード。

numberOfLogicalCpus
integer
1
論理プロセッサの数。

cpuGroup
integer
1
プロセッサグループ。

cpuAllocationRatio
integer
1
プロセッサのサービス率（1～999）。cpuAllocationの値がShareの場合に有効な情報です。

cpuIdleDetection
string
1
アイドル検出機能の設定。

Disable

Enable

cpuPerformanceCapping
string
1
プロセッサキャッピング機能の設定。

Disable

Enable

memorySizeInMB
integer
1
メモリーサイズ（MB）。

memoryNode
string
1
メモリーノード。

メモリーノード番号（整数値）：割り当てるメモリーノードを設定した場合。

Automatically：自動的に割り当てられる場合。

Automatically(Multiple)：複数のノードが割り当てられている場合。

GuestNUMA：ゲストNUMAが有効な場合。

guestNUMA
string
0～1
ゲストNUMA機能の設定。

Disable

Enable

preBootFirmware
string
1
Pre-bootファームウェアの種別。

BIOS

64UEFI

guestOs
string
1
OS種別。

Default

Solaris

guestIdleMode
string
0～1
ゲストアイドルモードの種別。アイドル検出機能の設定がEnableの場合，またはゲストアイドルモードがサポートされていない場合，空文字列です。

Halt

Poll

Mwait

lowLatency
string
0～1
Low Latency機能の設定。HVMがLow Latency機能をサポートしていない場合，空文字列です。

Disable

Enable

リターンコード

HTTPステータスコード | 結果コード | 詳細コード | 説明
200 | - | - | 正常終了。
204 | - | - | 指定したinstanceIDまたはcollectionはありません。
401 | 1000 | 1 | HTTPヘッダーのAuthorizationが指定されていません。
401 | 1000 | 2 | HTTPヘッダーのAuthorizationの値が不正です（Basic認証，HSSOセッション認証のどちらでもありません）。
401 | 1000 | 3 | HTTPヘッダーのAuthorizationのBasic認証の値が不正です（認証情報のフォーマットが不正です）。
401 | 1000 | 4 | ログインに失敗しました。
401 | 1002 | 1 | ログインセッションが切断されました。または，不正なHSSOトークンが指定されました。
403 | 1003 | 1 | 基本ライセンスが登録されていない，または有効期限を過ぎています。
403 | 1003 | 100 | 論理分割の機能を使用するためのプラグインライセンスがありません。
403 | 2017 | 1 | 管理対象を参照する権限がありません。
405 | - | - | サポートされていないメソッドです。
406 | 2010 | 1 | HTTPヘッダーのAcceptの値が不正です。
415 | - | - | HTTPヘッダーのContent-Typeにサポートされていない形式が指定されています。
500 | - | - | HTTPヘッダーのContent-Typeに不正な値が指定されている，またはそれ以外の内部エラーです。
500 | 1000 | 1 | ログインに失敗しました（内部エラー）。
500 | 3000 | 100 | 内部エラーが発生しました。
503 | 2020 | 1 | 要求の数がAPIの同時最大接続数を超えました。

4.3 論理プロセッサの情報を取得する

instanceIDに指定したLPARの論理プロセッサの情報を取得します。

ロール

Admin/Modify/View

リクエストライン

GET http://＜host＞:＜port＞/ComputeSystemsManager/v1/objects/Lpars/＜instanceID＞/collections/Logicalcpu

instanceID:

serverUniqueKey＋"_"＋LPAR番号をbase64urlでエンコードした文字列。

リクエストボディー

リクエストボディーには何も設定しません。

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。

LparLogicalCpu

{
   "LparLogicalCpu":[{
       "serverUniqueKey":"...",
       "lparNo":...,
       "lparName":"...",
       "logicalCpuNo":...,
       "assignedPhysicalCpuNo":"..."
   },
   :
   ]
}

属性
データ型
数
説明

serverUniqueKey
string
1
LPARが搭載されているブレードサーバを特定する識別子。

lparNo
integer
1
LPAR番号。

lparName
string
1
LPAR名。

logicalCpuNo
integer
1
論理プロセッサ番号。

assignedPhysicalCpuNo
string
1
論理プロセッサに割り当てた物理プロセッサの番号（整数）。

Automatically：論理プロセッサに物理プロセッサを自動で割り当てる。

リターンコード

HTTPステータスコード | 結果コード | 詳細コード | 説明
200 | - | - | 正常終了。
204 | - | - | 指定したinstanceIDまたはcollectionはありません。
401 | 1000 | 1 | HTTPヘッダーのAuthorizationが指定されていません。
401 | 1000 | 2 | HTTPヘッダーのAuthorizationの値が不正です（Basic認証，HSSOセッション認証のどちらでもありません）。
401 | 1000 | 3 | HTTPヘッダーのAuthorizationのBasic認証の値が不正です（認証情報のフォーマットが不正です）。
401 | 1000 | 4 | ログインに失敗しました。
401 | 1002 | 1 | ログインセッションが切断されました。または，不正なHSSOトークンが指定されました。
403 | 1003 | 1 | 基本ライセンスが登録されていない，または有効期限を過ぎています。
403 | 1003 | 100 | 論理分割の機能を使用するためのプラグインライセンスがありません。
403 | 2017 | 1 | 管理対象を参照する権限がありません。
405 | - | - | サポートされていないメソッドです。
406 | 2010 | 1 | HTTPヘッダーのAcceptの値が不正です。
415 | - | - | HTTPヘッダーのContent-Typeにサポートされていない形式が指定されています。
500 | - | - | HTTPヘッダーのContent-Typeに不正な値が指定されている，またはそれ以外の内部エラーです。
500 | 1000 | 1 | ログインに失敗しました（内部エラー）。
500 | 3000 | 100 | 内部エラーが発生しました。
503 | 2020 | 1 | 要求の数がAPIの同時最大接続数を超えました。

4.4 仮想NICポートの情報を取得する

instanceIDに指定したLPARの仮想NICポートの情報を取得します。

ロール

Admin/Modify/View

リクエストライン

GET http://＜host＞:＜port＞/ComputeSystemsManager/v1/objects/Lpars/＜instanceID＞/collections/Virtualnicport

instanceID:

serverUniqueKey＋"_"＋LPAR番号をbase64urlでエンコードした文字列。

リクエストボディー

リクエストボディーには何も設定しません。

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。

LparVirtualNICPort

{
   "LparVirtualNICPort":[{
       "serverUniqueKey":"...",
       "lparNo":...,
       "lparName":"...",
       "vnicNo":...,
       "macAddress":"...",
       "segment":"...",
       "formattedSlotNo":"...",
       "slotNo":"...",
       "pciDeviceNo":"...",
       "portNo":"...",
       "vlanTagType":"...",
       "vlanId":"...",
       "promiscuousMode":"...",
       "txRate":...
   },
   :
   ]
}

属性
データ型
数
説明

serverUniqueKey
string
1
LPARが搭載されているブレードサーバを特定する識別子。

lparNo
integer
1
LPAR番号。

lparName
string
1
LPAR名。

vnicNo
integer
1
仮想NIC番号。

macAddress
string
1
MACアドレス（書式： XX:XX:XX:XX:XX:XX）。

segment
string
1
セグメント。

formattedSlotNo
string
1
スロット番号を整形した文字列。
例： 'Mezzanine:X (Server Blade:XX)'

slotNo
string
1
スロット番号。
例：'EXX'

pciDeviceNo
string
1
PCIデバイス番号。仮想NICのネットワークセグメント識別子が'Vx'（例：'Va'）の場合，空文字列。

portNo
string
1
ポート番号。

vlanTagType
string
1
VLANモード。VLANを使用しない場合OFFになります。

Tagged

Untagged

vlanId
string
1
VLAN ID。複数のVLAN IDが設定されている場合，コンマで区切ってすべての値が列挙されます（書式：vlanId0[,vlanId1...]）。
例：'1001,2003,3004,4007,4016'

promiscuousMode
string
1
プロミスキャスモード。

Through

Restricted

txRate
integer
1
最大転送速度。セグメントがVF NICでない場合は'-1'。

リターンコード

HTTPステータスコード | 結果コード | 詳細コード | 説明
200 | - | - | 正常終了。
204 | - | - | 指定したinstanceIDまたはcollectionはありません。
401 | 1000 | 1 | HTTPヘッダーのAuthorizationが指定されていません。
401 | 1000 | 2 | HTTPヘッダーのAuthorizationの値が不正です（Basic認証，HSSOセッション認証のどちらでもありません）。
401 | 1000 | 3 | HTTPヘッダーのAuthorizationのBasic認証の値が不正です（認証情報のフォーマットが不正です）。
401 | 1000 | 4 | ログインに失敗しました。
401 | 1002 | 1 | ログインセッションが切断されました。または，不正なHSSOトークンが指定されました。
403 | 1003 | 1 | 基本ライセンスが登録されていない，または有効期限を過ぎています。
403 | 1003 | 100 | 論理分割の機能を使用するためのプラグインライセンスがありません。
403 | 2017 | 1 | 管理対象を参照する権限がありません。
405 | - | - | サポートされていないメソッドです。
406 | 2010 | 1 | HTTPヘッダーのAcceptの値が不正です。
415 | - | - | HTTPヘッダーのContent-Typeにサポートされていない形式が指定されています。
500 | - | - | HTTPヘッダーのContent-Typeに不正な値が指定されている，またはそれ以外の内部エラーです。
500 | 1000 | 1 | ログインに失敗しました（内部エラー）。
500 | 3000 | 100 | 内部エラーが発生しました。
503 | 2020 | 1 | 要求の数がAPIの同時最大接続数を超えました。

4.5 占有NICポートの情報を取得する

instanceIDに指定したLPARの占有NICポートの情報を取得します。

ロール

Admin/Modify/View

リクエストライン

GET http://＜host＞:＜port＞/ComputeSystemsManager/v1/objects/Lpars/＜instanceID＞/collections/Dedicatednicport

instanceID:

serverUniqueKey＋"_"＋LPAR番号をbase64urlでエンコードした文字列。

リクエストボディー

リクエストボディーには何も設定しません。

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。

LparDedicatedNICPort

{
   "LparDedicatedNICPort":[{
       "serverUniqueKey":"...",
       "lparNo":...,
       "lparName":"...",
       "formattedSlotNo":"...",
       "slotNo":"...",
       "pciDeviceNo":...,
       "portNo":"..."
   },
   :
   ]
}

属性
データ型
数
説明

serverUniqueKey
string
1
LPARが搭載されているブレードサーバを特定する識別子。

lparNo
integer
1
LPAR番号。

lparName
string
1
LPAR名。

formattedSlotNo
string
1
スロット番号を整形した文字列。
例：'Mezzanine:X (Server Blade:XX)'

slotNo
string
1
スロット番号。
例：'EXX'

pciDeviceNo
integer
1
PCI番号。

portNo
string
1
ポート番号。

リターンコード

HTTPステータスコード | 結果コード | 詳細コード | 説明
200 | - | - | 正常終了。
204 | - | - | 指定したinstanceIDまたはcollectionはありません。
401 | 1000 | 1 | HTTPヘッダーのAuthorizationが指定されていません。
401 | 1000 | 2 | HTTPヘッダーのAuthorizationの値が不正です（Basic認証，HSSOセッション認証のどちらでもありません）。
401 | 1000 | 3 | HTTPヘッダーのAuthorizationのBasic認証の値が不正です（認証情報のフォーマットが不正です）。
401 | 1000 | 4 | ログインに失敗しました。
401 | 1002 | 1 | ログインセッションが切断されました。または，不正なHSSOトークンが指定されました。
403 | 1003 | 1 | 基本ライセンスが登録されていない，または有効期限を過ぎています。
403 | 1003 | 100 | 論理分割の機能を使用するためのプラグインライセンスがありません。
403 | 2017 | 1 | 管理対象を参照する権限がありません。
405 | - | - | サポートされていないメソッドです。
406 | 2010 | 1 | HTTPヘッダーのAcceptの値が不正です。
415 | - | - | HTTPヘッダーのContent-Typeにサポートされていない形式が指定されています。
500 | - | - | HTTPヘッダーのContent-Typeに不正な値が指定されている，またはそれ以外の内部エラーです。
500 | 1000 | 1 | ログインに失敗しました（内部エラー）。
500 | 3000 | 100 | 内部エラーが発生しました。
503 | 2020 | 1 | 要求の数がAPIの同時最大接続数を超えました。

4.6 共有FCポートの情報を取得する

instanceIDに指定したLPARの共有FCポートの情報を取得します。

ロール

Admin/Modify/View

リクエストライン

GET http://＜host＞:＜port＞/ComputeSystemsManager/v1/objects/Lpars/＜instanceID＞/collections/Sharedfcport

instanceID:

serverUniqueKey＋"_"＋LPAR番号をbase64urlでエンコードした文字列。

リクエストボディー

リクエストボディーには何も設定しません。

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。

LparSharedFCPort

{
   "LparSharedFCPort":[{
       "serverUniqueKey":"...",
       "lparNo":...,
       "lparName":"...",
       "formattedSlotNo":"...",
       "slotNo":"...",
       "pciDeviceNo":...,
       "portNo":...,
       "portStatus":"...",
       "vfcId":"...",
       "wwpn":"...",
       "wwnn":"...",
       "migrationWwpn":"...",
       "migrationWwnn":"...",
       "busNo":"...",
       "devNo":"...",
       "funcNo":...,
       "coreDedicate":"...",
       "bootAvailability":"..."
   },
   :
   ]
}

属性
データ型
数
説明

serverUniqueKey
string
1
LPARが搭載されているブレードサーバを特定する識別子。

lparNo
integer
1
LPAR番号。

lparName
string
1
LPAR名。

formattedSlotNo
string
1
スロット番号を整形した文字列。
例：'Mezzanine:X (Server Blade:XX)'

slotNo
string
1
スロット番号。
例：'EXX'

pciDeviceNo
integer
1
PCI番号。

portNo
integer
1
ポート番号。

portStatus
string
1
ポートの状態。

Available

Unvailable

Unknown

vfcId
string
1
vfcID。

wwpn
string
1
FCのWWPN。

wwnn
string
1
FCのWWNN。

migrationWwpn
string
1
マイグレーションWWPN。

migrationWwnn
string
1
マイグレーションWWNN。

busNo
string
1
バス番号。

devNo
string
1
デバイス番号。

funcNo
integer
1
ファンクション番号。

coreDedicate
string
1
コア占有モードの有効／無効状態。

Enable：有効。

Disable：無効。

bootAvailability
string
1
ブート機能を利用できるかどうか。

Available

Notavailable

Unknown

リターンコード

HTTPステータスコード | 結果コード | 詳細コード | 説明
200 | - | - | 正常終了。
204 | - | - | 指定したinstanceIDまたはcollectionはありません。
401 | 1000 | 1 | HTTPヘッダーのAuthorizationが指定されていません。
401 | 1000 | 2 | HTTPヘッダーのAuthorizationの値が不正です（Basic認証，HSSOセッション認証のどちらでもありません）。
401 | 1000 | 3 | HTTPヘッダーのAuthorizationのBasic認証の値が不正です（認証情報のフォーマットが不正です）。
401 | 1000 | 4 | ログインに失敗しました。
401 | 1002 | 1 | ログインセッションが切断されました。または，不正なHSSOトークンが指定されました。
403 | 1003 | 1 | 基本ライセンスが登録されていない，または有効期限を過ぎています。
403 | 1003 | 100 | 論理分割の機能を使用するためのプラグインライセンスがありません。
403 | 2017 | 1 | 管理対象を参照する権限がありません。
405 | - | - | サポートされていないメソッドです。
406 | 2010 | 1 | HTTPヘッダーのAcceptの値が不正です。
415 | - | - | HTTPヘッダーのContent-Typeにサポートされていない形式が指定されています。
500 | - | - | HTTPヘッダーのContent-Typeに不正な値が指定されている，またはそれ以外の内部エラーです。
500 | 1000 | 1 | ログインに失敗しました（内部エラー）。
500 | 3000 | 100 | 内部エラーが発生しました。
503 | 2020 | 1 | 要求の数がAPIの同時最大接続数を超えました。

4.7 占有FCポートの情報を取得する

instanceIDに指定したLPARの占有FCポートの情報を取得します。

ロール

Admin/Modify/View

リクエストライン

GET http://＜host＞:＜port＞/ComputeSystemsManager/v1/objects/Lpars/＜instanceID＞/collections/Dedicatedfcport

instanceID:

serverUniqueKey＋"_"＋LPAR番号をbase64urlでエンコードした文字列。

リクエストボディー

リクエストボディーには何も設定しません。

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。

LparDedicatedFCPort

{
   "LparDedicatedFCPort":[{
       "serverUniqueKey":"...",
       "lparNo":...,
       "lparName":"...",
       "formattedSlotNo":"...",
       "slotNo":"...",
       "pciDeviceNo":...,
       "portNo":...,
       "wwpn":"...",
       "wwnn":"...",
       "bootAvailability":"..."
   },
   :
   ]
}

属性
データ型
数
説明

serverUniqueKey
string
1
LPARが搭載されているブレードサーバを特定する識別子。

lparNo
integer
1
LPAR番号。

lparName
string
1
LPAR名。

formattedSlotNo
string
1
スロット番号を整形した文字列。
例：'Mezzanine:X (Server Blade:XX)'

slotNo
string
1
スロット番号。
例：'EXX'

pciDeviceNo
integer
1
PCI番号。

portNo
integer
1
ポート番号。

wwpn
string
1
FCのWWPN。

wwnn
string
1
FCのWWNN。

bootAvailability
string
1
ブート機能を利用できるかどうか。

Available

Notavailable

Unknown

リターンコード

HTTPステータスコード | 結果コード | 詳細コード | 説明
200 | - | - | 正常終了。
204 | - | - | 指定したinstanceIDまたはcollectionはありません。
401 | 1000 | 1 | HTTPヘッダーのAuthorizationが指定されていません。
401 | 1000 | 2 | HTTPヘッダーのAuthorizationの値が不正です（Basic認証，HSSOセッション認証のどちらでもありません）。
401 | 1000 | 3 | HTTPヘッダーのAuthorizationのBasic認証の値が不正です（認証情報のフォーマットが不正です）。
401 | 1000 | 4 | ログインに失敗しました。
401 | 1002 | 1 | ログインセッションが切断されました。または，不正なHSSOトークンが指定されました。
403 | 1003 | 1 | 基本ライセンスが登録されていない，または有効期限を過ぎています。
403 | 1003 | 100 | 論理分割の機能を使用するためのプラグインライセンスがありません。
403 | 2017 | 1 | 管理対象を参照する権限がありません。
405 | - | - | サポートされていないメソッドです。
406 | 2010 | 1 | HTTPヘッダーのAcceptの値が不正です。
415 | - | - | HTTPヘッダーのContent-Typeにサポートされていない形式が指定されています。
500 | - | - | HTTPヘッダーのContent-Typeに不正な値が指定されている，またはそれ以外の内部エラーです。
500 | 1000 | 1 | ログインに失敗しました（内部エラー）。
500 | 3000 | 100 | 内部エラーが発生しました。
503 | 2020 | 1 | 要求の数がAPIの同時最大接続数を超えました。

4.8 USBの情報を取得する

instanceIDに指定したLPARのUSBの情報を取得します。

ロール

Admin/Modify/View

リクエストライン

GET http://＜host＞:＜port＞/ComputeSystemsManager/v1/objects/Lpars/＜instanceID＞/collections/Usb

instanceID:

serverUniqueKey＋"_"＋LPAR番号をbase64urlでエンコードした文字列。

リクエストボディー

リクエストボディーには何も設定しません。

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。

LparUSB

{
   "LparUSB":[{
       "serverUniqueKey":"...",
       "lparNo":...,
       "lparName":"...",
       "pciDeviceNo":...,
       "portNo":"...",
       "assignmentStatus":"..."
   },
   :
   ]
}

属性
データ型
数
説明

serverUniqueKey
string
1
LPARが搭載されているブレードサーバを特定する識別子。

lparNo
integer
1
LPAR番号。

lparName
string
1
LPAR名。

pciDeviceNo
integer
1
PCI番号。

portNo
string
1
ポート番号。

assignmentStatus
string
1
USBの割り当て状態。割り当てられていない場合，空文字列です。

Assign：割り当て（使用中）。

Reserve：割り当て（未使用）。

リターンコード

HTTPステータスコード | 結果コード | 詳細コード | 説明
200 | - | - | 正常終了。
204 | - | - | 指定したinstanceIDまたはcollectionはありません。
401 | 1000 | 1 | HTTPヘッダーのAuthorizationが指定されていません。
401 | 1000 | 2 | HTTPヘッダーのAuthorizationの値が不正です（Basic認証，HSSOセッション認証のどちらでもありません）。
401 | 1000 | 3 | HTTPヘッダーのAuthorizationのBasic認証の値が不正です（認証情報のフォーマットが不正です）。
401 | 1000 | 4 | ログインに失敗しました。
401 | 1002 | 1 | ログインセッションが切断されました。または，不正なHSSOトークンが指定されました。
403 | 1003 | 1 | 基本ライセンスが登録されていない，または有効期限を過ぎています。
403 | 1003 | 100 | 論理分割の機能を使用するためのプラグインライセンスがありません。
403 | 2017 | 1 | 管理対象を参照する権限がありません。
405 | - | - | サポートされていないメソッドです。
406 | 2010 | 1 | HTTPヘッダーのAcceptの値が不正です。
415 | - | - | HTTPヘッダーのContent-Typeにサポートされていない形式が指定されています。
500 | - | - | HTTPヘッダーのContent-Typeに不正な値が指定されている，またはそれ以外の内部エラーです。
500 | 1000 | 1 | ログインに失敗しました（内部エラー）。
500 | 3000 | 100 | 内部エラーが発生しました。
503 | 2020 | 1 | 要求の数がAPIの同時最大接続数を超えました。

5. ホスト

この章では，ホストの情報取得に関するAPIについて説明します。

この章の構成

5.1 すべてのホストの情報を取得する

5.2 特定のホストの情報を取得する

5.3 ホストを管理対象から外す

5.4 CPUの情報を取得する

5.5 FCネットワークの情報を取得する

5.6 ファイルシステムの情報を取得する

5.7 IPネットワークの情報を取得する

5.8 メモリーの情報を取得する

5.9 BMC設定情報を取得する

5.10 OSの情報を取得する

5.11 PCIスロットの情報を取得する

5.12 ホストの電源をONにする

5.13 OSをシャットダウンしないでホストの電源をOFFにする

5.14 ホストをリブートする

5.15 ホストをシャットダウンする

5.1 すべてのホストの情報を取得する

APIを実行するユーザーの権限で参照できるすべてのホストの情報を取得します。

ロール

Admin/Modify/View

リクエストライン

GET http://＜host＞:＜port＞/ComputeSystemsManager/v1/objects/Hosts

リクエストボディー

リクエストボディーには何も設定しません。

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。

Host

{
   "Host":[{
       "instanceId":"...",
       "hostName":"...",
       "osName":"...",
       "manufacturer":"...",
       "ipAddress":"...",
       "productName":"...",
       "hostStatus":"...",
       "serialNumber":"...",
       "lastRefreshed":"...",
       "error":...,
       "warning":...,
       "information":...
   },
   :
   ]
}

属性
データ型
数
説明

instanceId
string
1
URIでホストを特定する際に使用する識別子。IPアドレスをbase64urlでエンコードした文字列。

hostName
string
1
ホスト名。

osName
string
1
OS名。

manufacturer
string
1
ベンダー名。

ipAddress
string
1
ホストのIPアドレス。

productName
string
1
プロダクト名称。ホストの搭載されているサーバの名称。

hostStatus
string
1
ホストの稼働状態。

Running

Stopped

Unknown

serialNumber
string
1
シリアル番号。

lastRefreshed
dateTime
1
最終更新日時。

error
integer
1
解決していない障害レベルのアラート数。

warning
integer
1
解決していない警告レベルのアラート数。

information
integer
1
解決していない情報レベルのアラート数。

リターンコード

HTTPステータスコード | 結果コード | 詳細コード | 説明
200 | - | - | 正常終了。
401 | 1000 | 1 | HTTPヘッダーのAuthorizationが指定されていません。
401 | 1000 | 2 | HTTPヘッダーのAuthorizationの値が不正です（Basic認証，HSSOセッション認証のどちらでもありません）。
401 | 1000 | 3 | HTTPヘッダーのAuthorizationのBasic認証の値が不正です（認証情報のフォーマットが不正です）。
401 | 1000 | 4 | ログインに失敗しました。
401 | 1002 | 1 | ログインセッションが切断されました。または，不正なHSSOトークンが指定されました。
403 | 1003 | 1 | 基本ライセンスが登録されていない，または有効期限を過ぎています。
403 | 2017 | 1 | 管理対象を参照または操作する権限がありません。
405 | - | - | サポートされていないメソッドです。
406 | 2010 | 1 | HTTPヘッダーのAcceptの値が不正です。
415 | - | - | HTTPヘッダーのContent-Typeにサポートされていない形式が指定されています。
500 | - | - | HTTPヘッダーのContent-Typeに不正な値が指定されている，またはそれ以外の内部エラーです。
500 | 1000 | 1 | ログインに失敗しました（内部エラー）。
500 | 3000 | 100 | 内部エラーが発生しました。
503 | 2020 | 1 | 要求の数がAPIの同時最大接続数を超えました。

5.2 特定のホストの情報を取得する

instanceIDに指定したホストの情報を取得します。

ロール

Admin/Modify/View

リクエストライン

GET http://＜host＞:＜port＞/ComputeSystemsManager/v1/objects/Hosts/＜instanceID＞

instanceID:

IPアドレスをbase64urlでエンコードした文字列。

リクエストボディー

リクエストボディーには何も設定しません。

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。

Host

{
   "Host":[{
       "instanceId":"...",
       "hostName":"...",
       "osName":"...",
       "manufacturer":"...",
       "ipAddress":"...",
       "productName":"...",
       "hostStatus":"...",
       "serialNumber":"...",
       "lastRefreshed":"...",
       "error":...,
       "warning":...,
       "information":...
   }]
}

属性
データ型
数
説明

instanceId
string
1
URIでホストを特定する際に使用する識別子。IPアドレスをbase64urlでエンコードした文字列。

hostName
string
1
ホスト名。

osName
string
1
OS名。

manufacturer
string
1
ベンダー名。

ipAddress
string
1
ホストのIPアドレス。

productName
string
1
プロダクト名称。ホストの搭載されているサーバの名称。

hostStatus
string
1
ホストの稼働状態。

Running

Stopped

Unknown

serialNumber
string
1
シリアル番号。

lastRefreshed
dateTime
1
最終更新日時。

error
integer
1
解決していない障害レベルのアラート数。

warning
integer
1
解決していない警告レベルのアラート数。

information
integer
1
解決していない情報レベルのアラート数。

リターンコード

HTTPステータスコード | 結果コード | 詳細コード | 説明
200 | - | - | 正常終了。
204 | - | - | 指定したinstanceIDまたはcollectionはありません。
401 | 1000 | 1 | HTTPヘッダーのAuthorizationが指定されていません。
401 | 1000 | 2 | HTTPヘッダーのAuthorizationの値が不正です（Basic認証，HSSOセッション認証のどちらでもありません）。
401 | 1000 | 3 | HTTPヘッダーのAuthorizationのBasic認証の値が不正です（認証情報のフォーマットが不正です）。
401 | 1000 | 4 | ログインに失敗しました。
401 | 1002 | 1 | ログインセッションが切断されました。または，不正なHSSOトークンが指定されました。
403 | 1003 | 1 | 基本ライセンスが登録されていない，または有効期限を過ぎています。
403 | 2017 | 1 | 管理対象を参照または操作する権限がありません。
405 | - | - | サポートされていないメソッドです。
406 | 2010 | 1 | HTTPヘッダーのAcceptの値が不正です。
415 | - | - | HTTPヘッダーのContent-Typeにサポートされていない形式が指定されています。
500 | - | - | HTTPヘッダーのContent-Typeに不正な値が指定されている，またはそれ以外の内部エラーです。
500 | 1000 | 1 | ログインに失敗しました（内部エラー）。
500 | 3000 | 100 | 内部エラーが発生しました。
503 | 2020 | 1 | 要求の数がAPIの同時最大接続数を超えました。

5.3 ホストを管理対象から外す

instanceIDに指定したホストをCompute Systems Managerの管理対象から外します。

ロール

All-Resources-Admin

リクエストライン

DELETE http://＜host＞:＜port＞/ComputeSystemsManager/v1/objects/Hosts/＜instanceID＞

instanceID:

IPアドレスをbase64urlでエンコードした文字列。

リクエストボディー

リクエストボディーには何も設定しません。

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。

ApiResult

{
       "id":...
}

属性 | データ型 | 数 | 説明
id | integer | 1 | 0が返ります。

リターンコード

HTTPステータスコード | 結果コード | 詳細コード | 説明
200 | - | - | 正常終了。
401 | 1000 | 1 | HTTPヘッダーのAuthorizationが指定されていません。
401 | 1000 | 2 | HTTPヘッダーのAuthorizationの値が不正です（Basic認証，HSSOセッション認証のどちらでもありません）。
401 | 1000 | 3 | HTTPヘッダーのAuthorizationのBasic認証の値が不正です（認証情報のフォーマットが不正です）。
401 | 1000 | 4 | ログインに失敗しました。
401 | 1002 | 1 | ログインセッションが切断されました。または，不正なHSSOトークンが指定されました。
403 | 1003 | 1 | 基本ライセンスが登録されていない，または有効期限を過ぎています。
403 | 2017 | 1 | 管理対象を参照または操作する権限がありません。
404 | - | - | 指定したinstanceIDまたはcollectionはありません。
405 | - | - | サポートされていないメソッドです。
406 | 2010 | 1 | HTTPヘッダーのAcceptの値が不正です。
412 | 2150 | 1 | 指定したホストは幾つかのタスクで使用されているため，管理対象から外せません。
412 | 2150 | 2 | 指定したホストはデプロイメントマネージャーの対象として登録されているため，管理対象から外せません。
415 | - | - | HTTPヘッダーのContent-Typeにサポートされていない形式が指定されています。
500 | - | - | HTTPヘッダーのContent-Typeに不正な値が指定されている，またはそれ以外の内部エラーです。
500 | 1000 | 1 | ログインに失敗しました（内部エラー）。
500 | 3000 | 100 | 内部エラーが発生しました。
503 | 2020 | 1 | 要求の数がAPIの同時最大接続数を超えました。

5.4 CPUの情報を取得する

instanceIDに指定したホストのCPUの情報を取得します。

ロール

Admin/Modify/View

リクエストライン

GET http://＜host＞:＜port＞/ComputeSystemsManager/v1/objects/Hosts/＜instanceID＞/collections/Cpu

instanceID:

IPアドレスをbase64urlでエンコードした文字列。

リクエストボディー

リクエストボディーには何も設定しません。

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。

Cpu

{
   "Cpu":[{
       "hostName":"...",
       "cpuName":"...",
       "frequencyInMhz":...,
       "numberOfCpus":...,
       "numberOfCores":...,
       "l2CacheSizeInKB":...,
       "l3CacheSizeInKB":...
   }]
}

属性 | データ型 | 数 | 説明
hostName | string | 1 | ホスト名。
cpuName | string | 1 | CPU名。
frequencyInMhz | float | 1 | 動作周波数（MHz）。取得できなかった場合はnullになります。
numberOfCpus | integer | 1 | CPUの数。取得できなかった場合はnullになります。
numberOfCores | integer | 1 | コア数。取得できなかった場合はnullになります。
l2CacheSizeInKB | float | 1 | L2キャッシュのサイズ（KB）。取得できなかった場合はnullになります。
l3CacheSizeInKB | float | 1 | L3キャッシュのサイズ（KB）。取得できなかった場合はnullになります。

リターンコード

HTTPステータスコード | 結果コード | 詳細コード | 説明
200 | - | - | 正常終了。
204 | - | - | 指定したinstanceIDまたはcollectionはありません。
401 | 1000 | 1 | HTTPヘッダーのAuthorizationが指定されていません。
401 | 1000 | 2 | HTTPヘッダーのAuthorizationの値が不正です（Basic認証，HSSOセッション認証のどちらでもありません）。
401 | 1000 | 3 | HTTPヘッダーのAuthorizationのBasic認証の値が不正です（認証情報のフォーマットが不正です）。
401 | 1000 | 4 | ログインに失敗しました。
401 | 1002 | 1 | ログインセッションが切断されました。または，不正なHSSOトークンが指定されました。
403 | 1003 | 1 | 基本ライセンスが登録されていない，または有効期限を過ぎています。
403 | 2017 | 1 | 管理対象を参照または操作する権限がありません。
405 | - | - | サポートされていないメソッドです。
406 | 2010 | 1 | HTTPヘッダーのAcceptの値が不正です。
415 | - | - | HTTPヘッダーのContent-Typeにサポートされていない形式が指定されています。
500 | - | - | HTTPヘッダーのContent-Typeに不正な値が指定されている，またはそれ以外の内部エラーです。
500 | 1000 | 1 | ログインに失敗しました（内部エラー）。
500 | 3000 | 100 | 内部エラーが発生しました。
503 | 2020 | 1 | 要求の数がAPIの同時最大接続数を超えました。

5.5 FCネットワークの情報を取得する

instanceIDに指定したホストのFCネットワークの情報を取得します。

ロール

Admin/Modify/View

リクエストライン

GET http://＜host＞:＜port＞/ComputeSystemsManager/v1/objects/Hosts/＜instanceID＞/collections/Fcnetwork

instanceID:

IPアドレスをbase64urlでエンコードした文字列。

リクエストボディー

リクエストボディーには何も設定しません。

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。

FcNetwork

{
   "FcNetwork":[{
       "hostName":"...",
       "adapterName":"...",
       "wwpn":"...",
       "wwnn":"..."
   },
   :
   ]
}

属性 | データ型 | 数 | 説明
hostName | string | 1 | ホスト名。
adapterName | string | 1 | アダプター名。
wwpn | string | 1 | WWPN。
wwnn | string | 1 | WWNN。

リターンコード

HTTPステータスコード | 結果コード | 詳細コード | 説明
200 | - | - | 正常終了。
204 | - | - | 指定したinstanceIDまたはcollectionはありません。
401 | 1000 | 1 | HTTPヘッダーのAuthorizationが指定されていません。
401 | 1000 | 2 | HTTPヘッダーのAuthorizationの値が不正です（Basic認証，HSSOセッション認証のどちらでもありません）。
401 | 1000 | 3 | HTTPヘッダーのAuthorizationのBasic認証の値が不正です（認証情報のフォーマットが不正です）。
401 | 1000 | 4 | ログインに失敗しました。
401 | 1002 | 1 | ログインセッションが切断されました。または，不正なHSSOトークンが指定されました。
403 | 1003 | 1 | 基本ライセンスが登録されていない，または有効期限を過ぎています。
403 | 2017 | 1 | 管理対象を参照または操作する権限がありません。
405 | - | - | サポートされていないメソッドです。
406 | 2010 | 1 | HTTPヘッダーのAcceptの値が不正です。
415 | - | - | HTTPヘッダーのContent-Typeにサポートされていない形式が指定されています。
500 | - | - | HTTPヘッダーのContent-Typeに不正な値が指定されている，またはそれ以外の内部エラーです。
500 | 1000 | 1 | ログインに失敗しました（内部エラー）。
500 | 3000 | 100 | 内部エラーが発生しました。
503 | 2020 | 1 | 要求の数がAPIの同時最大接続数を超えました。

5.6 ファイルシステムの情報を取得する

instanceIDに指定したホストのファイルシステムの情報を取得します。

ロール

Admin/Modify/View

リクエストライン

GET http://＜host＞:＜port＞/ComputeSystemsManager/v1/objects/Hosts/＜instanceID＞/collections/Filesystem

instanceID:

IPアドレスをbase64urlでエンコードした文字列。

リクエストボディー

リクエストボディーには何も設定しません。

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。

FileSystem

{
   "FileSystem":[{
       "hostName":"...",
       "driveName":"...",
       "driveType":"...",
       "fileSystemType":"...",
       "totalSizeInMB":...,
       "usedSizeInMB":...,
       "freeSizeInMB":...
   },
   :
   ]
}

属性 | データ型 | 数 | 説明
hostName | string | 1 | ホスト名。
driveName | string | 1 | ドライブ名。
driveType | string | 1 | ドライブ種別。
fileSystemType | string | 1 | フォーマット種別。
totalSizeInMB | float | 1 | 総容量（MB）。取得できなかった場合はnullになります。
usedSizeInMB | float | 1 | 使用領域（MB）。取得できなかった場合はnullになります。
freeSizeInMB | float | 1 | 空き領域（MB）。取得できなかった場合はnullになります。

リターンコード

HTTPステータスコード | 結果コード | 詳細コード | 説明
200 | - | - | 正常終了。
204 | - | - | 指定したinstanceIDまたはcollectionはありません。
401 | 1000 | 1 | HTTPヘッダーのAuthorizationが指定されていません。
401 | 1000 | 2 | HTTPヘッダーのAuthorizationの値が不正です（Basic認証，HSSOセッション認証のどちらでもありません）。
401 | 1000 | 3 | HTTPヘッダーのAuthorizationのBasic認証の値が不正です（認証情報のフォーマットが不正です）。
401 | 1000 | 4 | ログインに失敗しました。
401 | 1002 | 1 | ログインセッションが切断されました。または，不正なHSSOトークンが指定されました。
403 | 1003 | 1 | 基本ライセンスが登録されていない，または有効期限を過ぎています。
403 | 2017 | 1 | 管理対象を参照または操作する権限がありません。
405 | - | - | サポートされていないメソッドです。
406 | 2010 | 1 | HTTPヘッダーのAcceptの値が不正です。
415 | - | - | HTTPヘッダーのContent-Typeにサポートされていない形式が指定されています。
500 | - | - | HTTPヘッダーのContent-Typeに不正な値が指定されている，またはそれ以外の内部エラーです。
500 | 1000 | 1 | ログインに失敗しました（内部エラー）。
500 | 3000 | 100 | 内部エラーが発生しました。
503 | 2020 | 1 | 要求の数がAPIの同時最大接続数を超えました。

5.7 IPネットワークの情報を取得する

instanceIDに指定したホストのIPネットワークの情報を取得します。

ロール

Admin/Modify/View

リクエストライン

GET http://＜host＞:＜port＞/ComputeSystemsManager/v1/objects/Hosts/＜instanceID＞/collections/Ipnetwork

instanceID:

IPアドレスをbase64urlでエンコードした文字列。

リクエストボディー

リクエストボディーには何も設定しません。

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。

IpAddress

{
   "IpAddress":[{
       "hostName":"...",
       "adapterName":"...",
       "adapterType":"...",
       "ipAddress":"...",
       "subnetMask":"...",
       "networkAddress":"...",
       "macAddress":"..."
   },
   :
   ]
}

属性 | データ型 | 数 | 説明
hostName | string | 1 | ホスト名。
adapterName | string | 1 | アダプター名。
adapterType | string | 1 | アダプター種別。
ipAddress | string | 1 | IPアドレス。
subnetMask | string | 1 | サブネットマスク。
networkAddress | string | 1 | ネットワークアドレス。
macAddress | string | 1 | MACアドレス。

リターンコード

HTTPステータスコード | 結果コード | 詳細コード | 説明
200 | - | - | 正常終了。
204 | - | - | 指定したinstanceIDまたはcollectionはありません。
401 | 1000 | 1 | HTTPヘッダーのAuthorizationが指定されていません。
401 | 1000 | 2 | HTTPヘッダーのAuthorizationの値が不正です（Basic認証，HSSOセッション認証のどちらでもありません）。
401 | 1000 | 3 | HTTPヘッダーのAuthorizationのBasic認証の値が不正です（認証情報のフォーマットが不正です）。
401 | 1000 | 4 | ログインに失敗しました。
401 | 1002 | 1 | ログインセッションが切断されました。または，不正なHSSOトークンが指定されました。
403 | 1003 | 1 | 基本ライセンスが登録されていない，または有効期限を過ぎています。
403 | 2017 | 1 | 管理対象を参照または操作する権限がありません。
405 | - | - | サポートされていないメソッドです。
406 | 2010 | 1 | HTTPヘッダーのAcceptの値が不正です。
415 | - | - | HTTPヘッダーのContent-Typeにサポートされていない形式が指定されています。
500 | - | - | HTTPヘッダーのContent-Typeに不正な値が指定されている，またはそれ以外の内部エラーです。
500 | 1000 | 1 | ログインに失敗しました（内部エラー）。
500 | 3000 | 100 | 内部エラーが発生しました。
503 | 2020 | 1 | 要求の数がAPIの同時最大接続数を超えました。

5.8 メモリーの情報を取得する

instanceIDに指定したホストのメモリーの情報を取得します。

ロール

Admin/Modify/View

リクエストライン

GET http://＜host＞:＜port＞/ComputeSystemsManager/v1/objects/Hosts/＜instanceID＞/collections/Memory

instanceID:

IPアドレスをbase64urlでエンコードした文字列。

リクエストボディー

リクエストボディーには何も設定しません。

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。

Memory

{
   "Memory":[{
       "hostName":"...",
       "totalSizeInMB":...,
       "maxPageFileSizeInMB":...
   }]
}

属性 | データ型 | 数 | 説明
hostName | string | 1 | ホスト名。
totalSizeInMB | float | 1 | 総容量（MB）。取得できなかった場合はnullになります。
maxPageFileSizeInMB | float | 1 | ページングファイルサイズ（MB）。取得できなかった場合はnullになります。

リターンコード

HTTPステータスコード | 結果コード | 詳細コード | 説明
200 | - | - | 正常終了。
204 | - | - | 指定したinstanceIDまたはcollectionはありません。
401 | 1000 | 1 | HTTPヘッダーのAuthorizationが指定されていません。
401 | 1000 | 2 | HTTPヘッダーのAuthorizationの値が不正です（Basic認証，HSSOセッション認証のどちらでもありません）。
401 | 1000 | 3 | HTTPヘッダーのAuthorizationのBasic認証の値が不正です（認証情報のフォーマットが不正です）。
401 | 1000 | 4 | ログインに失敗しました。
401 | 1002 | 1 | ログインセッションが切断されました。または，不正なHSSOトークンが指定されました。
403 | 1003 | 1 | 基本ライセンスが登録されていない，または有効期限を過ぎています。
403 | 2017 | 1 | 管理対象を参照または操作する権限がありません。
405 | - | - | サポートされていないメソッドです。
406 | 2010 | 1 | HTTPヘッダーのAcceptの値が不正です。
415 | - | - | HTTPヘッダーのContent-Typeにサポートされていない形式が指定されています。
500 | - | - | HTTPヘッダーのContent-Typeに不正な値が指定されている，またはそれ以外の内部エラーです。
500 | 1000 | 1 | ログインに失敗しました（内部エラー）。
500 | 3000 | 100 | 内部エラーが発生しました。
503 | 2020 | 1 | 要求の数がAPIの同時最大接続数を超えました。

5.9 BMC設定情報を取得する

instanceIDに指定したホストのBMC設定情報を取得します。

ロール

Admin/Modify/View

リクエストライン

GET http://＜host＞:＜port＞/ComputeSystemsManager/v1/objects/Hosts/＜instanceID＞/collections/Miscdevice

instanceID:

IPアドレスをbase64urlでエンコードした文字列。

リクエストボディー

リクエストボディーには何も設定しません。

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。

LOMSetting

{
   "LOMSetting":[{
       "hostName":"...",
       "ipAddress":"...",
       "credentialName":"..."
   },
   :
   ]
}

属性 | データ型 | 数 | 説明
hostName | string | 1 | ホスト名。
ipAddress | string | 1 | IPアドレス。
credentialName | string | 1 | デバイスにアクセスするための認証情報名。

リターンコード

HTTPステータスコード | 結果コード | 詳細コード | 説明
200 | - | - | 正常終了。
204 | - | - | 指定したinstanceIDまたはcollectionはありません。
401 | 1000 | 1 | HTTPヘッダーのAuthorizationが指定されていません。
401 | 1000 | 2 | HTTPヘッダーのAuthorizationの値が不正です（Basic認証，HSSOセッション認証のどちらでもありません）。
401 | 1000 | 3 | HTTPヘッダーのAuthorizationのBasic認証の値が不正です（認証情報のフォーマットが不正です）。
401 | 1000 | 4 | ログインに失敗しました。
401 | 1002 | 1 | ログインセッションが切断されました。または，不正なHSSOトークンが指定されました。
403 | 1003 | 1 | 基本ライセンスが登録されていない，または有効期限を過ぎています。
403 | 2017 | 1 | 管理対象を参照または操作する権限がありません。
405 | - | - | サポートされていないメソッドです。
406 | 2010 | 1 | HTTPヘッダーのAcceptの値が不正です。
415 | - | - | HTTPヘッダーのContent-Typeにサポートされていない形式が指定されています。
500 | - | - | HTTPヘッダーのContent-Typeに不正な値が指定されている，またはそれ以外の内部エラーです。
500 | 1000 | 1 | ログインに失敗しました（内部エラー）。
500 | 3000 | 100 | 内部エラーが発生しました。
503 | 2020 | 1 | 要求の数がAPIの同時最大接続数を超えました。

5.10 OSの情報を取得する

instanceIDに指定したホストのOSの情報を取得します。

ロール

Admin/Modify/View

リクエストライン

GET http://＜host＞:＜port＞/ComputeSystemsManager/v1/objects/Hosts/＜instanceID＞/collections/Os

instanceID:

IPアドレスをbase64urlでエンコードした文字列。

リクエストボディー

リクエストボディーには何も設定しません。

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。

OS

{
   "OS":[{
       "hostName":"...",
       "uuid":"...",
       "osName":"...",
       "servicePackVersion":"...",
       "osVersion":"...",
       "domainName":"...",
       "description":"...",
       "lastReboot":"...",
       "smt":"..."
   }]
}

属性
データ型
数
説明

hostName
string
1
ホスト名。

uuid
string
1
UUID。

osName
string
1
OS名。

servicePackVersion
string
1
サービスパックのバージョン。

osVersion
string
1
OSバージョン。

domainName
string
1
ドメイン名。

description
string
1
OSの説明。

lastReboot
dateTime
1
最終ブート日時。

smt
string
1
SMTの使用可否。

Disable：SMTを使用できません。

Enable：SMTを使用できます。

リターンコード

HTTPステータスコード | 結果コード | 詳細コード | 説明
200 | - | - | 正常終了。
204 | - | - | 指定したinstanceIDまたはcollectionはありません。
401 | 1000 | 1 | HTTPヘッダーのAuthorizationが指定されていません。
401 | 1000 | 2 | HTTPヘッダーのAuthorizationの値が不正です（Basic認証，HSSOセッション認証のどちらでもありません）。
401 | 1000 | 3 | HTTPヘッダーのAuthorizationのBasic認証の値が不正です（認証情報のフォーマットが不正です）。
401 | 1000 | 4 | ログインに失敗しました。
401 | 1002 | 1 | ログインセッションが切断されました。または，不正なHSSOトークンが指定されました。
403 | 1003 | 1 | 基本ライセンスが登録されていない，または有効期限を過ぎています。
403 | 2017 | 1 | 管理対象を参照または操作する権限がありません。
405 | - | - | サポートされていないメソッドです。
406 | 2010 | 1 | HTTPヘッダーのAcceptの値が不正です。
415 | - | - | HTTPヘッダーのContent-Typeにサポートされていない形式が指定されています。
500 | - | - | HTTPヘッダーのContent-Typeに不正な値が指定されている，またはそれ以外の内部エラーです。
500 | 1000 | 1 | ログインに失敗しました（内部エラー）。
500 | 3000 | 100 | 内部エラーが発生しました。
503 | 2020 | 1 | 要求の数がAPIの同時最大接続数を超えました。

5.11 PCIスロットの情報を取得する

instanceIDに指定したホストのPCIスロットの情報を取得します。

ロール

Admin/Modify/View

リクエストライン

GET http://＜host＞:＜port＞/ComputeSystemsManager/v1/objects/Hosts/＜instanceID＞/collections/Pcislot

instanceID:

IPアドレスをbase64urlでエンコードした文字列。

リクエストボディー

リクエストボディーには何も設定しません。

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。

PCI

{
   "PCI":[{
       "hostName":"...",
       "deviceID":"...",
       "deviceName":"...",
       "manufacturer":"..."
   },
   :
   ]
}

属性 | データ型 | 数 | 説明
hostName | string | 1 | ホスト名。
deviceID | string | 1 | デバイスID。
deviceName | string | 1 | デバイス名。
manufacturer | string | 1 | PCIデバイスのベンダー名。

リターンコード

HTTPステータスコード | 結果コード | 詳細コード | 説明
200 | - | - | 正常終了。
204 | - | - | 指定したinstanceIDまたはcollectionはありません。
401 | 1000 | 1 | HTTPヘッダーのAuthorizationが指定されていません。
401 | 1000 | 2 | HTTPヘッダーのAuthorizationの値が不正です（Basic認証，HSSOセッション認証のどちらでもありません）。
401 | 1000 | 3 | HTTPヘッダーのAuthorizationのBasic認証の値が不正です（認証情報のフォーマットが不正です）。
401 | 1000 | 4 | ログインに失敗しました。
401 | 1002 | 1 | ログインセッションが切断されました。または，不正なHSSOトークンが指定されました。
403 | 1003 | 1 | 基本ライセンスが登録されていない，または有効期限を過ぎています。
403 | 2017 | 1 | 管理対象を参照または操作する権限がありません。
405 | - | - | サポートされていないメソッドです。
406 | 2010 | 1 | HTTPヘッダーのAcceptの値が不正です。
415 | - | - | HTTPヘッダーのContent-Typeにサポートされていない形式が指定されています。
500 | - | - | HTTPヘッダーのContent-Typeに不正な値が指定されている，またはそれ以外の内部エラーです。
500 | 1000 | 1 | ログインに失敗しました（内部エラー）。
500 | 3000 | 100 | 内部エラーが発生しました。
503 | 2020 | 1 | 要求の数がAPIの同時最大接続数を超えました。

5.12 ホストの電源をONにする

instanceIDに指定したホストの電源をONにします。

ロール

Admin/Modify

リクエストライン

PUT http://＜host＞:＜port＞/ComputeSystemsManager/v1/objects/Hosts/＜instanceID＞/actions/Poweron/invoke

instanceID:

IPアドレスをbase64urlでエンコードした文字列。

リクエストボディー

リクエストボディーの構造とオブジェクトの属性を次に示します。

HostPowerOn

{
       "schedule":"...",
       "time":"...",
       "elapseTime":...,
       "emailNotificationType":"..."
}

属性
データ型
数
説明

schedule
string
0～1
ホストの電源をONにするスケジュールを指定します。

NOW：即時開始

LATER：timeで指定した日時に開始。LATER を指定する場合は，timeも合わせて指定してください。

デフォルトの値はNOWです。

time
string
0～1
ホストの電源をONにする日付と時刻をYYYY/MM/DD HH:MM:SS の形式で指定します。過去の時刻は指定できません。scheduleが'LATER'のときに有効です。

elapseTime
integer
0～1
ホストの電源がONになるまでのタイムアウト時間を指定します。0から9999（単位：秒）の値を指定できます。
0を指定した場合，または省略した場合は，デフォルトの値が設定されます。デフォルトの値はGUIで設定されたタイムアウト時間です。

emailNotificationType
string
0～1
Eメール通知の方法を指定します。

SEND：Eメールを送信します。

SEND_ONLY_TASK_FAILED：タスクが失敗したときだけEメールを送信します。

NOT_SEND：Eメールを送信しません。

デフォルトの値はNOT_SENDです。

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。

ApiResult

{
       "id":...
}

属性 | データ型 | 数 | 説明
id | integer | 1 | ホストの電源をONにするために登録されたタスクのタスクIDが返ります。

リターンコード

HTTPステータスコード | 結果コード | 詳細コード | 説明
200 | - | - | 正常終了。
400 | 2010 | 101 | リクエストボディーの書式が無効です。JSONの書式で記述してください。
400 | 2010 | 102 | elapseTimeに指定した値が範囲外です。
400 | 2010 | 103 | scheduleに無効な値を指定しました。
400 | 2010 | 104 | timeに無効な値を指定しました。
400 | 2010 | 105 | emailNotificationTypeに無効な値を指定しました。
400 | 2010 | 107 | scheduleに'LATER'を指定する場合は，timeも指定する必要があります。
400 | 2010 | 108 | 指定した日付は2100年12月31日以降です。
401 | 1000 | 1 | HTTPヘッダーのAuthorizationが指定されていません。
401 | 1000 | 2 | HTTPヘッダーのAuthorizationの値が不正です（Basic認証，HSSOセッション認証のどちらでもありません）。
401 | 1000 | 3 | HTTPヘッダーのAuthorizationのBasic認証の値が不正です（認証情報のフォーマットが不正です）。
401 | 1000 | 4 | ログインに失敗しました。
401 | 1002 | 1 | ログインセッションが切断されました。または，不正なHSSOトークンが指定されました。
403 | 1003 | 1 | 基本ライセンスが登録されていない，または有効期限を過ぎています。
403 | 2017 | 1 | 管理対象を参照または操作する権限がありません。
404 | - | - | 指定したinstanceIDまたはcollectionはありません。
405 | - | - | サポートされていないメソッドです。
406 | 2010 | 1 | HTTPヘッダーのAcceptの値が不正です。
412 | 2018 | 106 | timeに過去の時刻を指定しました。
415 | - | - | HTTPヘッダーのContent-Typeにサポートされていない形式が指定されています。
500 | - | - | HTTPヘッダーのContent-Typeに不正な値が指定されている，またはそれ以外の内部エラーです。
500 | 1000 | 1 | ログインに失敗しました（内部エラー）。
500 | 3000 | 100 | 内部エラーが発生しました。
503 | 2020 | 1 | 要求の数がAPIの同時最大接続数を超えました。
503 | 2020 | 2 | タスク登録に失敗しました。しばらくしてから，再度実行してください。

5.13 OSをシャットダウンしないでホストの電源をOFFにする

instanceIDに指定したホストのOSをシャットダウンしないで電源をOFFにします。

ロール

Admin/Modify

リクエストライン

PUT http://＜host＞:＜port＞/ComputeSystemsManager/v1/objects/Hosts/＜instanceID＞/actions/Poweroff/invoke

instanceID:

IPアドレスをbase64urlでエンコードした文字列。

リクエストボディー

リクエストボディーの構造とオブジェクトの属性を次に示します。

HostPowerOff

{
       "schedule":"...",
       "time":"...",
       "elapseTime":...,
       "emailNotificationType":"..."
}

属性
データ型
数
説明

schedule
string
0～1
ホストの電源を強制的にOFFにするスケジュールを指定します。

NOW：即時開始

LATER：timeで指定した日時に開始。LATER を指定する場合は，timeも合わせて指定してください。

デフォルトの値はNOWです。

time
string
0～1
ホストの電源を強制的にOFFにする日付と時刻をYYYY/MM/DD HH:MM:SS の形式で指定します。過去の時刻は指定できません。scheduleが'LATER'のときに有効です。

elapseTime
integer
0～1
ホストの電源がOFFになるまでのタイムアウト時間を指定します。0から9999(単位：秒）の値を指定できます。
0を指定した場合，または省略した場合は，デフォルトの値が設定されます。デフォルトの値はGUIで設定されたタイムアウト時間です。

emailNotificationType
string
0～1
Eメール通知の方法を指定します。

SEND：Eメールを送信します。

SEND_ONLY_TASK_FAILED：タスクが失敗したときだけEメールを送信します。

NOT_SEND：Eメールを送信しません。

デフォルトの値はNOT_SENDです。

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。

ApiResult

{
       "id":...
}

属性 | データ型 | 数 | 説明
id | integer | 1 | ホストの電源を強制的にOFFにするために登録されたタスクのタスクIDが返ります。

リターンコード

HTTPステータスコード | 結果コード | 詳細コード | 説明
200 | - | - | 正常終了。
400 | 2010 | 101 | リクエストボディーの書式が無効です。JSONの書式で記述してください。
400 | 2010 | 102 | elapseTimeに指定した値が範囲外です。
400 | 2010 | 103 | scheduleに無効な値を指定しました。
400 | 2010 | 104 | timeに無効な値を指定しました。
400 | 2010 | 105 | emailNotificationTypeに無効な値を指定しました。
400 | 2010 | 107 | scheduleに'LATER'を指定する場合は，timeも指定する必要があります。
400 | 2010 | 108 | 指定した日付は2100年12月31日以降です。
401 | 1000 | 1 | HTTPヘッダーのAuthorizationが指定されていません。
401 | 1000 | 2 | HTTPヘッダーのAuthorizationの値が不正です（Basic認証，HSSOセッション認証のどちらでもありません）。
401 | 1000 | 3 | HTTPヘッダーのAuthorizationのBasic認証の値が不正です（認証情報のフォーマットが不正です）。
401 | 1000 | 4 | ログインに失敗しました。
401 | 1002 | 1 | ログインセッションが切断されました。または，不正なHSSOトークンが指定されました。
403 | 1003 | 1 | 基本ライセンスが登録されていない，または有効期限を過ぎています。
403 | 2017 | 1 | 管理対象を参照または操作する権限がありません。
404 | - | - | 指定したinstanceIDまたはcollectionはありません。
405 | - | - | サポートされていないメソッドです。
406 | 2010 | 1 | HTTPヘッダーのAcceptの値が不正です。
412 | 2018 | 106 | timeに過去の時刻を指定しました。
415 | - | - | HTTPヘッダーのContent-Typeにサポートされていない形式が指定されています。
500 | - | - | HTTPヘッダーのContent-Typeに不正な値が指定されている，またはそれ以外の内部エラーです。
500 | 1000 | 1 | ログインに失敗しました（内部エラー）。
500 | 3000 | 100 | 内部エラーが発生しました。
503 | 2020 | 1 | 要求の数がAPIの同時最大接続数を超えました。
503 | 2020 | 2 | タスク登録に失敗しました。しばらくしてから，再度実行してください。

5.14 ホストをリブートする

instanceIDに指定したホストをリブートします。

ロール

Admin/Modify

リクエストライン

PUT http://＜host＞:＜port＞/ComputeSystemsManager/v1/objects/Hosts/＜instanceID＞/actions/Reboot/invoke

instanceID:

IPアドレスをbase64urlでエンコードした文字列。

リクエストボディー

リクエストボディーの構造とオブジェクトの属性を次に示します。

HostReboot

{
       "schedule":"...",
       "time":"...",
       "elapseTime":...,
       "hypElapseTime":...,
       "emailNotificationType":"..."
}

属性
データ型
数
説明

schedule
string
0～1
ホストをリブートするスケジュールを指定します。

NOW：即時開始

LATER：timeで指定した日時に開始。LATER を指定する場合は，timeも合わせて指定してください。

デフォルトの値はNOWです。

time
string
0～1
ホストをリブートする日付と時刻をYYYY/MM/DD HH:MM:SS の形式で指定します。過去の時刻は指定できません。scheduleが'LATER'のときに有効です。

elapseTime
integer
0～1
ホストのリブートが完了するまでのタイムアウト時間を指定します。0から9999（単位：秒）の値を指定できます。
0を指定した場合，または省略した場合は，デフォルトの値が設定されます。デフォルトの値はGUIで設定されたタイムアウト時間です。

hypElapseTime
integer
0～1
ハイパーバイザーとゲストOSのリブートが完了するまでのタイムアウト時間を指定します。0から9999（単位：秒）の値を指定できます。
0を指定した場合，または省略した場合は，デフォルトの値が設定されます。デフォルトの値はGUIで設定されたタイムアウト時間です。

emailNotificationType
string
0～1
Eメール通知の方法を指定します。

SEND：Eメールを送信します。

SEND_ONLY_TASK_FAILED：タスクが失敗したときだけEメールを送信します。

NOT_SEND：Eメールを送信しません。

デフォルトの値はNOT_SENDです。

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。

ApiResult

{
       "id":...
}

属性 | データ型 | 数 | 説明
id | integer | 1 | ホストをリブートするために登録されたタスクのタスクIDが返ります。

リターンコード

HTTPステータスコード | 結果コード | 詳細コード | 説明
200 | - | - | 正常終了。
400 | 2010 | 101 | リクエストボディーの書式が無効です。JSONの書式で記述してください。
400 | 2010 | 102 | elapseTimeに指定した値が範囲外です。
400 | 2010 | 103 | scheduleに無効な値を指定しました。
400 | 2010 | 104 | timeに無効な値を指定しました。
400 | 2010 | 105 | emailNotificationTypeに無効な値を指定しました。
400 | 2010 | 107 | scheduleに'LATER'を指定する場合は，timeも指定する必要があります。
400 | 2010 | 108 | 指定した日付は2100年12月31日以降です。
400 | 2010 | 109 | hypElapseTimeに指定した値が範囲外です。
401 | 1000 | 1 | HTTPヘッダーのAuthorizationが指定されていません。
401 | 1000 | 2 | HTTPヘッダーのAuthorizationの値が不正です（Basic認証，HSSOセッション認証のどちらでもありません）。
401 | 1000 | 3 | HTTPヘッダーのAuthorizationのBasic認証の値が不正です（認証情報のフォーマットが不正です）。
401 | 1000 | 4 | ログインに失敗しました。
401 | 1002 | 1 | ログインセッションが切断されました。または，不正なHSSOトークンが指定されました。
403 | 1003 | 1 | 基本ライセンスが登録されていない，または有効期限を過ぎています。
403 | 2017 | 1 | 管理対象を参照または操作する権限がありません。
404 | - | - | 指定したinstanceIDまたはcollectionはありません。
405 | - | - | サポートされていないメソッドです。
406 | 2010 | 1 | HTTPヘッダーのAcceptの値が不正です。
412 | 2018 | 106 | timeに過去の時刻を指定しました。
415 | - | - | HTTPヘッダーのContent-Typeにサポートされていない形式が指定されています。
500 | - | - | HTTPヘッダーのContent-Typeに不正な値が指定されている，またはそれ以外の内部エラーです。
500 | 1000 | 1 | ログインに失敗しました（内部エラー）。
500 | 3000 | 100 | 内部エラーが発生しました。
503 | 2020 | 1 | 要求の数がAPIの同時最大接続数を超えました。
503 | 2020 | 2 | タスク登録に失敗しました。しばらくしてから，再度実行してください。

5.15 ホストをシャットダウンする

instanceIDに指定したホストをシャットダウンします。

ロール

Admin/Modify

リクエストライン

PUT http://＜host＞:＜port＞/ComputeSystemsManager/v1/objects/Hosts/＜instanceID＞/actions/Shutdown/invoke

instanceID:

IPアドレスをbase64urlでエンコードした文字列。

リクエストボディー

リクエストボディーの構造とオブジェクトの属性を次に示します。

HostShutdown

{
       "schedule":"...",
       "time":"...",
       "elapseTime":...,
       "hypElapseTime":...,
       "emailNotificationType":"..."
}

属性
データ型
数
説明

schedule
string
0～1
ホストをシャットダウンするスケジュールを指定します。

NOW：即時開始

LATER：timeで指定した日時に開始。LATER を指定する場合は，timeも合わせて指定してください。

デフォルトの値はNOWです。

time
string
0～1
ホストをシャットダウンする日付と時刻をYYYY/MM/DD HH:MM:SS の形式で指定します。過去の時刻は指定できません。scheduleが'LATER'のときに有効です。

elapseTime
integer
0～1
ホストのシャットダウンが完了するまでのタイムアウト時間を指定します。0から9999（単位：秒）の値を指定できます。
0を指定した場合，または省略した場合は，デフォルトの値が設定されます。デフォルトの値はGUIで設定されたタイムアウト時間です。

hypElapseTime
integer
0～1
ハイパーバイザーとゲストOSのシャットダウンが完了するまでのタイムアウト時間を指定します。0から9999（単位：秒）の値を指定できます。
0を指定した場合，または省略した場合は，デフォルトの値が設定されます。デフォルトの値はGUIで設定されたタイムアウト時間です。

emailNotificationType
string
0～1
Eメール通知の方法を指定します。

SEND：Eメールを送信します。

SEND_ONLY_TASK_FAILED：タスクが失敗したときだけEメールを送信します。

NOT_SEND：Eメールを送信しません。

デフォルトの値はNOT_SENDです。

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。

ApiResult

{
       "id":...
}

属性 | データ型 | 数 | 説明
id | integer | 1 | ホストをシャットダウンするために登録されたタスクのタスクIDが返ります。

リターンコード

HTTPステータスコード | 結果コード | 詳細コード | 説明
200 | - | - | 正常終了。
400 | 2010 | 101 | リクエストボディーの書式が無効です。JSONの書式で記述してください。
400 | 2010 | 102 | elapseTimeに指定した値が範囲外です。
400 | 2010 | 103 | scheduleに無効な値を指定しました。
400 | 2010 | 104 | timeに無効な値を指定しました。
400 | 2010 | 105 | emailNotificationTypeに無効な値を指定しました。
400 | 2010 | 107 | scheduleに'LATER'を指定する場合は，timeも指定する必要があります。
400 | 2010 | 108 | 指定した日付は2100年12月31日以降です。
400 | 2010 | 109 | hypElapseTimeに指定した値が範囲外です。
401 | 1000 | 1 | HTTPヘッダーのAuthorizationが指定されていません。
401 | 1000 | 2 | HTTPヘッダーのAuthorizationの値が不正です（Basic認証，HSSOセッション認証のどちらでもありません）。
401 | 1000 | 3 | HTTPヘッダーのAuthorizationのBasic認証の値が不正です（認証情報のフォーマットが不正です）。
401 | 1000 | 4 | ログインに失敗しました。
401 | 1002 | 1 | ログインセッションが切断されました。または，不正なHSSOトークンが指定されました。
403 | 1003 | 1 | 基本ライセンスが登録されていない，または有効期限を過ぎています。
403 | 2017 | 1 | 管理対象を参照または操作する権限がありません。
404 | - | - | 指定したinstanceIDまたはcollectionはありません。
405 | - | - | サポートされていないメソッドです。
406 | 2010 | 1 | HTTPヘッダーのAcceptの値が不正です。
412 | 2018 | 106 | timeに過去の時刻を指定しました。
415 | - | - | HTTPヘッダーのContent-Typeにサポートされていない形式が指定されています。
500 | - | - | HTTPヘッダーのContent-Typeに不正な値が指定されている，またはそれ以外の内部エラーです。
500 | 1000 | 1 | ログインに失敗しました（内部エラー）。
500 | 3000 | 100 | 内部エラーが発生しました。
503 | 2020 | 1 | 要求の数がAPIの同時最大接続数を超えました。
503 | 2020 | 2 | タスク登録に失敗しました。しばらくしてから，再度実行してください。

6. タスク

この章では，タスクの情報取得に関するAPIについて説明します。

この章の構成

6.1 タスクの情報を取得する

6.2 特定のタスクの情報を取得する

6.3 サブタスクの情報を取得する

6.1 タスクの情報を取得する

指定された状態または種別のタスクを取得します。

ロール

Admin/Modify/View

リクエストライン

GET http://＜host＞:＜port＞/ComputeSystemsManager/v1/objects/Tasks?status=タスクステータス&type=タスクタイプ

クエリーパラメーターに指定できる値を次の表に示します。

パラメーター
説明

status
タスクの状態を指定します。指定を省略した場合は、デフォルトで実行されます。

All（デフォルト）

Waiting

InProgress：'In%20Progress'でも可。（クォーテーションはつけない）

Canceled

Completed

Failed

type
タスクを登録した管理クライアントの種別を指定します。指定を省略した場合は、デフォルトで実行されます

GUI

CLI（デフォルト）

リクエストボディー

リクエストボディーには何も設定しません。

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。

TaskExecutionInfo

{
   "TaskExecutionInfo":[{
       "taskID":"...",
       "taskName":"...",
       "status":"...",
       "taskType":"..."
   },
   :
   ]
}

属性
データ型
数
説明

taskID
string
1
タスクユニークキー。タスクを特定する識別子。

taskName
string
1
ユーザーが付けたタスクの名前。

status
string
1
タスクの状態。

Waiting

In Progress

Canceled

Completed

Failed

taskType
string
1
タスクの種類。

Unknown

Discovery

Host Refresh

Host Import

Shutdown OS

Reboot OS

Power On

Force Power Off

Power Reset

VM Power On

VM Force Power Off

VM Power Reset

Server Power On

Server Force Power Off

Server Power Reset

LID On

LID Off

Start Power Capping

Stop Power Capping

Start Power Capping Rack

Stop Power Capping Rack

Failover To Standby Blade(Auto)

Failover To Standby Blade

Failback To Active Blade

Test N+M Cold Standby

Reassignment Of Standby Blade

Blade Health Check

Automated Blade Health Check

Assignment Restoration

Synchronize Status For Failover

Synchronize Status For Failback

Deployment - Back up

Deployment - Snapshot

Deployment - Restore

Deployment - Check Disk Configuration

Delete Image File

Deployment - Deploy

Deployment - Remove Resource

Deployment - Add Resource

Deployment - Edit Settings

Resource Refresh

Resource Auto Refresh

Resource Status Refresh

Virtualization Refresh

Blade Refresh

Chassis Refresh

Rack Refresh

Server Refresh

Chassis Power Refresh

Server Power Refresh

Host Performance Refresh

Rack Power Refresh

Hypervisor Refresh

Update Firmware

HVM Shutdown

HVM Restart

LPAR Activate

LPAR Deactivate

LPAR Reactivate

USB Unassign from LPAR

USB Assign to LPAR

Create LPAR

Edit LPAR

Delete LPARs

Quick Create Multiple LPARs

Edit LPAR Shared FC Settings

Edit LPAR Dedicated FC Settings

Edit LPAR Dedicated NIC Settings

Edit LPAR Virtual NIC Settings

Edit LPAR Settings

Configure HVM

Specify LPAR USB Auto Assignment

Edit LPAR USB Settings

Edit LPAR Memory Settings

Edit LPAR CPU Settings

Save HVM Configuration

Edit HVM Advanced Settings

Migrate LPAR - Verify Compatibility

Migrate LPAR

Cold Migrate LPAR - Verify Compatibility

Cold Migrate LPAR

Recover From Failed Migration

VM Refresh

LPAR Refresh

Edit LPAR Boot Order Settings

リターンコード

HTTPステータスコード | 結果コード | 詳細コード | 説明
200 | - | - | 正常終了。
204 | - | - | 未定義のstatusが指定されました。
400 | 2010 | 100 | クエリーパラメーターのtypeに指定した値が不正です。
401 | 1000 | 1 | HTTPヘッダーのAuthorizationが指定されていません。
401 | 1000 | 2 | HTTPヘッダーのAuthorizationの値が不正です（Basic認証，HSSOセッション認証のどちらでもありません）。
401 | 1000 | 3 | HTTPヘッダーのAuthorizationのBasic認証の値が不正です（認証情報のフォーマットが不正です）。
401 | 1000 | 4 | ログインに失敗しました。
401 | 1002 | 1 | ログインセッションが切断されました。または，不正なHSSOトークンが指定されました。
403 | 1003 | 1 | 基本ライセンスが登録されていない，または有効期限を過ぎています。
403 | 2017 | 1 | 管理対象を参照する権限がありません。
405 | - | - | サポートされていないメソッドです。
406 | 2010 | 1 | HTTPヘッダーのAcceptの値が不正です。
415 | - | - | HTTPヘッダーのContent-Typeにサポートされていない形式が指定されています。
500 | - | - | HTTPヘッダーのContent-Typeに不正な値が指定されている，またはそれ以外の内部エラーです。
500 | 1000 | 1 | ログインに失敗しました（内部エラー）。
500 | 3000 | 103 | 内部エラーが発生しました。
503 | 2020 | 1 | 要求の数がAPIの同時最大接続数を超えました。

6.2 特定のタスクの情報を取得する

taskIDで指定されたタスクの情報を取得します。

ロール

Admin/Modify/View

リクエストライン

GET http://＜host＞:＜port＞/ComputeSystemsManager/v1/objects/Tasks/＜taskID＞

taskID:

タスクユニークキー。タスクを特定する識別子。

リクエストボディー

リクエストボディーには何も設定しません。

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。

TaskExecutionInfo

{
   "TaskExecutionInfo":[{
       "taskID":"...",
       "taskName":"...",
       "status":"...",
       "taskType":"..."
   }]
}

属性
データ型
数
説明

taskID
string
1
タスクユニークキー。タスクを特定する識別子。

taskName
string
1
ユーザーが付けたタスクの名前。

status
string
1
タスクの状態。

Waiting

In Progress

Canceled

Completed

Failed

taskType
string
1
タスクの種類。

Unknown

Discovery

Host Refresh

Host Import

Shutdown OS

Reboot OS

Power On

Force Power Off

Power Reset

VM Power On

VM Force Power Off

VM Power Reset

Server Power On

Server Force Power Off

Server Power Reset

LID On

LID Off

Start Power Capping

Stop Power Capping

Start Power Capping Rack

Stop Power Capping Rack

Failover To Standby Blade(Auto)

Failover To Standby Blade

Failback To Active Blade

Test N+M Cold Standby

Reassignment Of Standby Blade

Blade Health Check

Automated Blade Health Check

Assignment Restoration

Synchronize Status For Failover

Synchronize Status For Failback

Deployment - Back up

Deployment - Snapshot

Deployment - Restore

Deployment - Check Disk Configuration

Delete Image File

Deployment - Deploy

Deployment - Remove Resource

Deployment - Add Resource

Deployment - Edit Settings

Resource Refresh

Resource Auto Refresh

Resource Status Refresh

Virtualization Refresh

Blade Refresh

Chassis Refresh

Rack Refresh

Server Refresh

Chassis Power Refresh

Server Power Refresh

Host Performance Refresh

Rack Power Refresh

Hypervisor Refresh

Update Firmware

HVM Shutdown

HVM Restart

LPAR Activate

LPAR Deactivate

LPAR Reactivate

USB Unassign from LPAR

USB Assign to LPAR

Create LPAR

Edit LPAR

Delete LPARs

Quick Create Multiple LPARs

Edit LPAR Shared FC Settings

Edit LPAR Dedicated FC Settings

Edit LPAR Dedicated NIC Settings

Edit LPAR Virtual NIC Settings

Edit LPAR Settings

Configure HVM

Specify LPAR USB Auto Assignment

Edit LPAR USB Settings

Edit LPAR Memory Settings

Edit LPAR CPU Settings

Save HVM Configuration

Edit HVM Advanced Settings

Migrate LPAR - Verify Compatibility

Migrate LPAR

Cold Migrate LPAR - Verify Compatibility

Cold Migrate LPAR

Recover From Failed Migration

VM Refresh

LPAR Refresh

Edit LPAR Boot Order Settings

リターンコード

HTTPステータスコード | 結果コード | 詳細コード | 説明
200 | - | - | 正常終了。
204 | - | - | 指定したtaskIDはありません。
401 | 1000 | 1 | HTTPヘッダーのAuthorizationが指定されていません。
401 | 1000 | 2 | HTTPヘッダーのAuthorizationの値が不正です（Basic認証，HSSOセッション認証のどちらでもありません）。
401 | 1000 | 3 | HTTPヘッダーのAuthorizationのBasic認証の値が不正です（認証情報のフォーマットが不正です）。
401 | 1000 | 4 | ログインに失敗しました。
401 | 1002 | 1 | ログインセッションが切断されました。または，不正なHSSOトークンが指定されました。
403 | 1003 | 1 | 基本ライセンスが登録されていない，または有効期限を過ぎています。
403 | 2017 | 1 | 管理対象を参照する権限がありません。
405 | - | - | サポートされていないメソッドです。
406 | 2010 | 1 | HTTPヘッダーのAcceptの値が不正です。
415 | - | - | HTTPヘッダーのContent-Typeにサポートされていない形式が指定されています。
500 | - | - | HTTPヘッダーのContent-Typeに不正な値が指定されている，またはそれ以外の内部エラーです。
500 | 1000 | 1 | ログインに失敗しました（内部エラー）。
500 | 3000 | 103 | 内部エラーが発生しました。
503 | 2020 | 1 | 要求の数がAPIの同時最大接続数を超えました。

6.3 サブタスクの情報を取得する

taskIDで指定したタスクのサブタスクの情報を取得します。

ロール

Admin/Modify/View

リクエストライン

GET http://＜host＞:＜port＞/ComputeSystemsManager/v1/objects/Tasks/＜taskID＞/collections/Subtask

taskID:

タスクユニークキー。タスクを特定する識別子。

リクエストボディー

リクエストボディーには何も設定しません。

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。

SubTaskExecutionInfo

{
   "SubTaskExecutionInfo":[{
       "status":"...",
       "progress":...,
       "errorMessageId":"...",
       "errorMessage":"..."
   },
   :
   ]
}

属性
データ型
数
説明

status
string
1
タスク状態。

Waiting

In Progress

Canceled

Completed

Failed

Skipped

progress
integer
1
サブタスク進捗状況（0～100%）。

errorMessageId
string
1
Compute Systems Managerで定義しているメッセージID。statusが'Failed'でなければ，空文字列です。
例：'KASV31448'

errorMessage
string
1
Compute Systems Managerで定義しているメッセージの説明。statusが'Failed'でなければ，空文字列です。
例：'Firmware Update failed due to network error.'

リターンコード

HTTPステータスコード | 結果コード | 詳細コード | 説明
200 | - | - | 正常終了。
204 | - | - | 指定したtaskIDはありません。
401 | 1000 | 1 | HTTPヘッダーのAuthorizationが指定されていません。
401 | 1000 | 2 | HTTPヘッダーのAuthorizationの値が不正です（Basic認証，HSSOセッション認証のどちらでもありません）。
401 | 1000 | 3 | HTTPヘッダーのAuthorizationのBasic認証の値が不正です（認証情報のフォーマットが不正です）。
401 | 1000 | 4 | ログインに失敗しました。
401 | 1002 | 1 | ログインセッションが切断されました。または，不正なHSSOトークンが指定されました。
403 | 1003 | 1 | 基本ライセンスが登録されていない，または有効期限を過ぎています。
403 | 2017 | 1 | 管理対象を参照する権限がありません。
405 | - | - | サポートされていないメソッドです。
406 | 2010 | 1 | HTTPヘッダーのAcceptの値が不正です。
415 | - | - | HTTPヘッダーのContent-Typeにサポートされていない形式が指定されています。
500 | - | - | HTTPヘッダーのContent-Typeに不正な値が指定されている，またはそれ以外の内部エラーです。
500 | 1000 | 1 | ログインに失敗しました（内部エラー）。
500 | 3000 | 103 | 内部エラーが発生しました。
503 | 2020 | 1 | 要求の数がAPIの同時最大接続数を超えました。

7. 認証情報

この章では，認証情報の取得・更新に関するAPIについて説明します。

この章の構成

7.1 認証情報を取得する

7.2 認証情報を作成する

7.3 特定の認証情報を取得する

7.4 認証情報を編集する

7.5 認証情報を削除する

7.1 認証情報を取得する

特定のプロトコルタイプ，またはすべての認証情報を取得します。

ロール

All-Resources-Admin

リクエストライン

GET http://＜host＞:＜port＞/ComputeSystemsManager/v1/objects/Credentials?protocolType=プロトコルタイプ

クエリーパラメーターに指定できる値を次の表に示します。

パラメーター
説明

protocolType
取得する認証情報のプロトコルタイプを指定します。指定しない場合はすべての認証情報を取得します。

WMI

SSH

VMWARE

SVP

リクエストボディー

リクエストボディーには何も設定しません。

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。

Credential

{
   "Credential":[{
       "instanceID":"...",
       "protocolType":"...",
       "credentialName":"...",
       "description":"...",
       "userID":"...",
       "emptyPassword":"...",
       "password":"...",
       "portNo":...,
       "userPassword":"...",
       "suPassword":"...",
       "domainName":"...",
       "defaultAuthorization":"...",
       "defaultPort":"...",
       "discoverHyperV":"..."
   },
   :
   ]
}

属性
データ型
数
説明

instanceID
string
1
Compute Systems Managerによって割り当てられた識別キー。

protocolType
string
1
管理対象に対応した値。

WMI：Windowsホストを管理する場合に使用する認証情報。

SSH：Linuxホストを管理する場合に使用する認証情報。

VMWARE：VMware ESXiを管理する場合に使用する認証情報。

SVP：ブレードサーバまたはラックマウントサーバを管理する場合に使用する認証情報。

credentialName
string
1
認証情報名（1～32バイト）。

description
string
1
認証情報の説明（0～500バイト）。

userID
string
1
探索するリソースにアクセスするためのユーザーID。

emptyPassword
string
1
パスワードを指定するかどうか。protocolTypeが'WMI'以外の場合は空文字列。

Disable：パスワードを指定します。

Enable：パスワードを指定しません。

password
string
1
パスワードの文字列をbase64でエンコードした文字列。protocolTypeが'SVP'以外の場合は空文字列。

portNo
integer
1
ポート番号。

userPassword
string
1
パスワードの文字列をbase64でエンコードした文字列（エンコードの文字列は1～256バイト）。protocolTypeが'SVP'の場合は空文字列。

suPassword
string
1
rootユーザーのパスワードの文字列をbase64でエンコードした文字列（エンコードの文字列は1～256バイト）。protocolTypeが'SSH'以外の場合は空文字列。

domainName
string
1
ドメイン名。protocolTypeが'WMI'以外の場合は空文字列。

defaultAuthorization
string
1
ブレードサーバまたはラックマウントサーバへの接続にデフォルトのユーザーIDとパスワードを使用するかどうか。resourceTypeが'SVP'以外の場合は空文字列。

Disable：指定したユーザーIDとパスワードを使用します。

Enable：デフォルトのユーザーIDとパスワードを使用します。

defaultPort
string
1
ブレードサーバまたはラックマウントサーバへの接続にデフォルトポートを使用するかどうか。resourceTypeが'SVP'以外の場合は空文字列。

Disable：指定したポートを使用します。

Enable：デフォルトポートを使用します。

discoverHyperV
string
1
Hyper-Vを探索対象にするかどうか。resourceTypeが'WMI'以外の場合は空文字列。

Disable：Hyper-Vを探索対象にしません。

Enable：Hyper-Vを探索対象にします。

リターンコード

HTTPステータスコード | 結果コード | 詳細コード | 説明
200 | - | - | 正常終了。
401 | 1000 | 1 | HTTPヘッダーのAuthorizationが指定されていません。
401 | 1000 | 2 | HTTPヘッダーのAuthorizationの値が不正です（Basic認証，HSSOセッション認証のどちらでもありません）。
401 | 1000 | 3 | HTTPヘッダーのAuthorizationのBasic認証の値が不正です（認証情報のフォーマットが不正です）。
401 | 1000 | 4 | ログインに失敗しました。
401 | 1002 | 1 | ログインセッションが切断されました。または，不正なHSSOトークンが指定されました。
403 | 1003 | 1 | 基本ライセンスが登録されていない，または有効期限を過ぎています。
403 | 2017 | 1 | 管理対象を参照する権限がありません。
405 | - | - | サポートされていないメソッドです。
406 | 2010 | 1 | HTTPヘッダーのAcceptの値が不正です。
415 | - | - | HTTPヘッダーのContent-Typeにサポートされていない形式が指定されています。
500 | - | - | HTTPヘッダーのContent-Typeに不正な値が指定されている，またはそれ以外の内部エラーです。
500 | 1000 | 1 | ログインに失敗しました（内部エラー）。
503 | 2020 | 1 | 要求の数がAPIの同時最大接続数を超えました。

7.2 認証情報を作成する

新しい認証情報を作成します。

ロール

All-Resources-Admin

リクエストライン

POST http://＜host＞:＜port＞/ComputeSystemsManager/v1/objects/Credentials

リクエストボディー

リクエストボディーの構造とオブジェクトの属性を次に示します。

Credential

{
       "protocolType":"...",
       "credentialName":"...",
       "description":"...",
       "wmiCredential":{
           "emptyPassword":"...",
           "userID":"...",
           "userPassword":"...",
           "domainName":"...",
           "discoverHyperV":"...",
           "portNo":...
       },
       "sshCredential":{
           "userID":"...",
           "userPassword":"...",
           "suPassword":"...",
           "portNo":...
       },
       "vmwareCredential":{
           "userID":"...",
           "userPassword":"..."
       },
       "svpCredential":{
           "defaultAuthorization":"...",
           "userID":"...",
           "password":"...",
           "defaultPort":"...",
           "portNo":...
       }
}

属性
データ型
数
説明

protocolType
string
1
管理対象に対応した値。

WMI：Windowsホストを管理する場合に使用する認証情報。

SSH：Linuxホストを管理する場合に使用する認証情報。

VMWARE：VMware ESXiを管理する場合に使用する認証情報。

SVP：ブレードサーバまたはラックマウントサーバを管理する場合に使用する認証情報。

credentialName
string
0～1
認証情報名（1～32バイト）。

description
string
0～1
認証情報の説明（0～500バイト）。

wmiCredential
WmiCredential
0～1
Windowsホストへの接続に使用する認証情報。protocolTypeが'WMI'の場合に必要。それ以外の場合は無効。

sshCredential
SshCredential
0～1
Linuxホストへの接続に使用する認証情報。protocolTypeが'SSH'の場合に必要。それ以外の場合は無効。

vmwareCredential
VmWareCredential
0～1
VMWare ESXiへの接続に使用する認証情報。protocolTypeが'VMWARE'の場合に必要。それ以外の場合は無効。

svpCredential
SvpCredential
0～1
ブレードサーバまたはラックマウントサーバへの接続に使用する認証情報。protocolTypeが'SVP'の場合に必要。それ以外の場合は無効。

wmiCredential

属性
データ型
数
説明

emptyPassword
string
1
パスワードを指定するかどうか。

Disable：パスワードを指定します。

Enable：パスワードを指定しません。

userID
string
1
探索するリソースにアクセスするためのユーザーID（1～32バイト）。

userPassword
string
0～1
パスワードの文字列をbase64でエンコードした文字列（エンコードする前の文字列は1～256バイト）。emptyPasswordが'Disable'の場合に必要です。

domainName
string
0～1
ドメイン名（1～255バイト）。

discoverHyperV
string
0～1
Hyper-Vを探索対象にするかどうか。

Disable：Hyper-Vを探索対象にしません。（デフォルト）

Enable：Hyper-Vを探索対象にします。

portNo
integer
0～1
ポート番号（1～65535）。Compute Systems ManagerがLinux版の場合に有効。そうでなければ無効。
デフォルトの値は5985です。

sshCredential

属性 | データ型 | 数 | 説明
userID | string | 1 | 探索するリソースにアクセスするためのユーザーID（1～32バイト）。
userPassword | string | 1 | パスワードの文字列をbase64でエンコードした文字列（エンコードする前の文字列は1～256バイト）。
suPassword | string | 0～1 | rootユーザーのパスワードの文字列をbase64でエンコードした文字列（エンコードする前の文字列は1～256バイト）。
portNo | integer | 1 | SSHプロトコルで使用するポート番号（0～65535）。

vmwareCredential

属性 | データ型 | 数 | 説明
userID | string | 1 | 探索するリソースにアクセスするためのユーザーID（1～32バイト）。
userPassword | string | 1 | パスワードの文字列をbase64でエンコードした文字列（エンコードする前の文字列は1～256バイト）。

svpCredential

属性
データ型
数
説明

defaultAuthorization
string
1
接続に，デフォルトのユーザーIDとパスワードを使用するかどうか。

Disable：指定したユーザーIDとパスワードを使用します。

Enable：デフォルトのユーザーIDとパスワードを使用します。

userID
string
0～1
探索するリソースにアクセスするためのユーザーID（1～32バイト）。defultAuthorizationが'Disable'の場合に必要。

password
string
0～1
パスワードをbase64でエンコードした文字列（エンコードする前の文字列は1～256バイト）。defultAuthorizationが'Disable'の場合に必要。

defaultPort
string
1
接続にデフォルトポートを使用するかどうか。

Disable：指定したポートを使用します。

Enable：デフォルトポートを使用します。

portNo
integer
0～1
ポート番号（0～35535）。defultPortが'Disable'の場合に示します。

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。

ApiResult

{
       "id":...
}

属性 | データ型 | 数 | 説明
id | integer | 1 | 作成した認証情報のinstanceIDが返ります。

リターンコード

HTTPステータスコード | 結果コード | 詳細コード | 説明
201 | 0 | 0 | 正常終了。
400 | 2010 | 1 | credentialNameに無効な値を指定しました。
400 | 2010 | 2 | descriptionに無効な値を指定しました。
400 | 2010 | 3 | protocolTypeを指定していません。
400 | 2010 | 4 | protocolTypeに無効な値を指定しました。
400 | 2010 | 5 | protocolTypeに対応した認証情報は指定されません。
400 | 2010 | 10 | protocolTypeに'SVP'を指定する場合は，defultAuthorizationも指定する必要があります。
400 | 2010 | 11 | defultAuthorizationに無効な値を指定しました。
400 | 2010 | 12 | protocolTypeに'WMI'または'SSH'または'VMWARE'を指定する場合は，userIDも指定する必要があります。protocolTypeに'SVP'，defaultAuthorizationに'Disable'を指定する場合は，userIDも指定する必要があります。
400 | 2010 | 13 | userIDに無効な値を指定しました。
400 | 2010 | 14 | protocolTypeに'SVP'，defaultAuthorizationに'Disable'を指定する場合は，passwordも指定する必要があります。
400 | 2010 | 15 | passwordに無効な値を指定しました。
400 | 2010 | 16 | protocolTypeに'WMI'を指定する場合は，emptyPasswordも指定する必要があります。
400 | 2010 | 17 | emptyPasswordに無効な値を指定しました。
400 | 2010 | 18 | protocolTypeに'WMI'，emptyPasswordに'Disable'を指定する場合は，userPasswordも指定する必要があります。protocolTypeに'SSH'または'VMWARE'を指定する場合は，userPasswordも指定する必要があります。
400 | 2010 | 19 | userPasswordに無効な値を指定しました。
400 | 2010 | 20 | protocolTypeに'SVP'を指定する場合は，defaultPortも指定する必要があります。
400 | 2010 | 21 | defaultPortに無効な値を指定しました。
400 | 2010 | 22 | protocolTypeに'SSH'を指定する場合は，portNoも指定する必要があります。protocolTypeに'SVP'，defaultPortに'Disable'を指定する場合は，portNoも指定する必要があります。
400 | 2010 | 23 | portNoに無効な値を指定しました。
400 | 2010 | 24 | domainNameに無効な値を指定しました。
400 | 2010 | 25 | discoverHyperVに無効な値を指定しました。
400 | 2010 | 26 | suPasswordに無効な値を指定しました。
400 | 2010 | 100 | リクエストボディーが指定されていません。
400 | 2010 | 101 | リクエストボディーの書式が無効です。JSONの書式で記述してください。
401 | 1000 | 1 | HTTPヘッダーのAuthorizationが指定されていません。
401 | 1000 | 2 | HTTPヘッダーのAuthorizationの値が不正です（Basic認証，HSSOセッション認証のどちらでもありません）。
401 | 1000 | 3 | HTTPヘッダーのAuthorizationのBasic認証の値が不正です（認証情報のフォーマットが不正です）。
401 | 1000 | 4 | ログインに失敗しました。
401 | 1002 | 1 | ログインセッションが切断されました。または，不正なHSSOトークンが指定されました。
403 | 1003 | 1 | 基本ライセンスが登録されていない，または有効期限を過ぎています。
403 | 1003 | 2 | 論理分割の機能を使用するためのプラグインライセンスがありません。または，ライセンスが無効です。日本語バージョンの場合，vmwareCredentialを追加するかdiscoverHyperVを'Enable'にして再実行してください。
403 | 2017 | 1 | 管理対象を参照する権限がありません。
405 | - | - | サポートされていないメソッドです。
406 | 2010 | 1 | HTTPヘッダーのAcceptの値が不正です。
412 | 2013 | 1 | 指定したcredentialNameはCompute Systems Managerですでに使用済みです。
415 | - | - | HTTPヘッダーのContent-Typeにサポートされていない形式が指定されています。
500 | - | - | HTTPヘッダーのContent-Typeに不正な値が指定されている，またはそれ以外の内部エラーです。
500 | 1000 | 1 | ログインに失敗しました（内部エラー）。
503 | 2020 | 1 | 要求の数がAPIの同時最大接続数を超えました。

7.3 特定の認証情報を取得する

instanceIDに指定した認証情報を取得します。

ロール

All-Resources-Admin

リクエストライン

GET http://＜host＞:＜port＞/ComputeSystemsManager/v1/objects/Credentials/＜instanceID＞

instanceID:

Compute Systems Managerによって割り当てられた識別キー。

リクエストボディー

リクエストボディーには何も設定しません。

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。

Credential

{
   "Credential":[{
       "instanceID":"...",
       "protocolType":"...",
       "credentialName":"...",
       "description":"...",
       "userID":"...",
       "emptyPassword":"...",
       "password":"...",
       "portNo":...,
       "userPassword":"...",
       "suPassword":"...",
       "domainName":"...",
       "defaultAuthorization":"...",
       "defaultPort":"...",
       "discoverHyperV":"..."
   }]
}

属性
データ型
数
説明

instanceID
string
1
Compute Systems Managerによって割り当てられた識別キー。

protocolType
string
1
管理対象に対応した値。

WMI：Windowsホストを管理する場合に使用する認証情報。

SSH：Linuxホストを管理する場合に使用する認証情報。

VMWARE：VMware ESXiを管理する場合に使用する認証情報。

SVP：ブレードサーバまたはラックマウントサーバを管理する場合に使用する認証情報。

credentialName
string
1
認証情報名（1～32バイト）。

description
string
1
認証情報の説明（0～500バイト）。

userID
string
1
探索するリソースにアクセスするためのユーザーID。

emptyPassword
string
1
パスワードを指定するかどうか。protocolTypeが'WMI'以外の場合は空文字列。

Disable：パスワードを指定します。

Enable：パスワードを指定しません。

password
string
1
パスワードの文字列をbase64でエンコードした文字列。protocolTypeが'SVP'以外の場合は空文字列。

portNo
integer
1
ポート番号。

userPassword
string
1
パスワードの文字列をbase64でエンコードした文字列（エンコードの文字列は1～256バイト）。protocolTypeが'SVP'の場合は空文字列。

suPassword
string
1
rootユーザーのパスワードの文字列をbase64でエンコードした文字列（エンコードの文字列は1～256バイト）。protocolTypeが'SSH'以外の場合は空文字列。

domainName
string
1
ドメイン名。protocolTypeが'WMI'以外の場合は空文字列。

defaultAuthorization
string
1
ブレードサーバまたはラックマウントサーバへの接続にデフォルトのユーザーIDとパスワードを使用するかどうか。resourceTypeが'SVP'以外の場合は空文字列。

Disable：指定したユーザーIDとパスワードを使用します。

Enable：デフォルトのユーザーIDとパスワードを使用します。

defaultPort
string
1
ブレードサーバまたはラックマウントサーバへの接続にデフォルトポートを使用するかどうか。resourceTypeが'SVP'以外の場合は空文字列。

Disable：指定したポートを使用します。

Enable：デフォルトポートを使用します。

discoverHyperV
string
1
Hyper-Vを探索対象にするかどうか。resourceTypeが'WMI'以外の場合は空文字列。

Disable：Hyper-Vを探索対象にしません。

Enable：Hyper-Vを探索対象にします。

リターンコード

HTTPステータスコード | 結果コード | 詳細コード | 説明
200 | - | - | 正常終了。
204 | - | - | 指定したinstanceIDまたはcollectionはありません。
401 | 1000 | 1 | HTTPヘッダーのAuthorizationが指定されていません。
401 | 1000 | 2 | HTTPヘッダーのAuthorizationの値が不正です（Basic認証，HSSOセッション認証のどちらでもありません）。
401 | 1000 | 3 | HTTPヘッダーのAuthorizationのBasic認証の値が不正です（認証情報のフォーマットが不正です）。
401 | 1000 | 4 | ログインに失敗しました。
401 | 1002 | 1 | ログインセッションが切断されました。または，不正なHSSOトークンが指定されました。
403 | 1003 | 1 | 基本ライセンスが登録されていない，または有効期限を過ぎています。
403 | 2017 | 1 | 管理対象を参照する権限がありません。
405 | - | - | サポートされていないメソッドです。
406 | 2010 | 1 | HTTPヘッダーのAcceptの値が不正です。
415 | - | - | HTTPヘッダーのContent-Typeにサポートされていない形式が指定されています。
500 | - | - | HTTPヘッダーのContent-Typeに不正な値が指定されている，またはそれ以外の内部エラーです。
500 | 1000 | 1 | ログインに失敗しました（内部エラー）。
503 | 2020 | 1 | 要求の数がAPIの同時最大接続数を超えました。

7.4 認証情報を編集する

instanceIDに指定した認証情報を編集します。

ロール

All-Resources-Admin

リクエストライン

PUT http://＜host＞:＜port＞/ComputeSystemsManager/v1/objects/Credentials/＜instanceID＞

instanceID:

Compute Systems Managerによって割り当てられた識別キー。

リクエストボディー

リクエストボディーの構造とオブジェクトの属性を次に示します。

Credential

{
       "credentialName":"...",
       "description":"...",
       "forceChange":"...",
       "wmiCredential":{
           "emptyPassword":"...",
           "userID":"...",
           "userPassword":"...",
           "domainName":"...",
           "discoverHyperV":"...",
           "portNo":...
       },
       "sshCredential":{
           "userID":"...",
           "userPassword":"...",
           "suPassword":"...",
           "portNo":...
       },
       "vmwareCredential":{
           "userID":"...",
           "userPassword":"..."
       },
       "svpCredential":{
           "defaultAuthorization":"...",
           "userID":"...",
           "password":"...",
           "defaultPort":"...",
           "portNo":...
       }
}

属性
データ型
数
説明

credentialName
string
0～1
認証情報名（1～32バイト）。

description
string
0～1
認証情報の説明（0～500バイト）。

forceChange
string
0～1
対象の認証情報が管理対象リソースと関連を持つ場合に，強制的に編集するかどうか。

Disable：認証情報が管理対象リソースと関連づいている場合は編集しません。（デフォルト）

Enable：認証情報が管理対象リソースと関連づていていも強制的に編集します。

wmiCredential
WmiCredential
0～1
Windowsホストへの接続に使用する認証情報。protocolTypeが'WMI'の場合に必要。それ以外の場合は無効。

sshCredential
SshCredential
0～1
Linuxホストへの接続に使用する認証情報。protocolTypeが'SSH'の場合に必要。それ以外の場合は無効。

vmwareCredential
VmWareCredential
0～1
VMWare ESXiへの接続に使用する認証情報。protocolTypeが'VMWARE'の場合に必要。それ以外の場合は無効。

svpCredential
SvpCredential
0～1
ブレードサーバまたはラックマウントサーバへの接続に使用する認証情報。protocolTypeが'SVP'の場合に必要。それ以外の場合は無効。

wmiCredential

属性
データ型
数
説明

emptyPassword
string
1
パスワードを指定するかどうか。

Disable：パスワードを指定します。

Enable：パスワードを指定しません。

userID
string
1
探索するリソースにアクセスするためのユーザーID（1～32バイト）。

userPassword
string
0～1
パスワードの文字列をbase64でエンコードした文字列（エンコードする前の文字列は1～256バイト）。emptyPasswordが'Disable'の場合に必要です。

domainName
string
0～1
ドメイン名（1～255バイト）。

discoverHyperV
string
0～1
Hyper-Vを探索対象にするかどうか。

Disable：Hyper-Vを探索対象にしません。（デフォルト）

Enable：Hyper-Vを探索対象にします。

portNo
integer
0～1
ポート番号（1～65535）。Compute Systems ManagerがLinux版の場合に有効。そうでなければ無効。
デフォルトの値は5985です。

sshCredential

属性 | データ型 | 数 | 説明
userID | string | 1 | 探索するリソースにアクセスするためのユーザーID（1～32バイト）。
userPassword | string | 1 | パスワードの文字列をbase64でエンコードした文字列（エンコードする前の文字列は1～256バイト）。
suPassword | string | 0～1 | rootユーザーのパスワードの文字列をbase64でエンコードした文字列（エンコードする前の文字列は1～256バイト）。
portNo | integer | 1 | SSHプロトコルで使用するポート番号（0～65535）。

vmwareCredential

属性 | データ型 | 数 | 説明
userID | string | 1 | 探索するリソースにアクセスするためのユーザーID（1～32バイト）。
userPassword | string | 1 | パスワードの文字列をbase64でエンコードした文字列（エンコードする前の文字列は1～256バイト）。

svpCredential

属性
データ型
数
説明

defaultAuthorization
string
1
接続に，デフォルトのユーザーIDとパスワードを使用するかどうか。

Disable：指定したユーザーIDとパスワードを使用します。

Enable：デフォルトのユーザーIDとパスワードを使用します。

userID
string
0～1
探索するリソースにアクセスするためのユーザーID（1～32バイト）。defultAuthorizationが'Disable'の場合に必要。

password
string
0～1
パスワードをbase64でエンコードした文字列（エンコードする前の文字列は1～256バイト）。defultAuthorizationが'Disable'の場合に必要。

defaultPort
string
1
接続にデフォルトポートを使用するかどうか。

Disable：指定したポートを使用します。

Enable：デフォルトポートを使用します。

portNo
integer
0～1
ポート番号（0～35535）。defultPortが'Disable'の場合に示します。

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。

ApiResult

{
       "id":...
}

属性 | データ型 | 数 | 説明
id | integer | 1 | 編集した認証情報のinstanceIDが返ります。

リターンコード

HTTPステータスコード | 結果コード | 詳細コード | 説明
200 | 0 | 0 | 正常終了。
400 | 2010 | 1 | credentialNameに無効な値を指定しました。
400 | 2010 | 2 | descriptionに無効な値を指定しました。
400 | 2010 | 3 | 指定された認証情報は，対象の認証情報と違います。
400 | 2010 | 4 | 指定した認証情報と同時に指定が必要な属性が指定されていません。
400 | 2010 | 10 | defultAuthorizationに無効な値を指定しました。
400 | 2010 | 11 | protocolTypeに'SVP'，defaultAuthorizationに'Disable'を指定する場合は，userIDも指定する必要があります。
400 | 2010 | 12 | userIDに無効な値を指定しました。
400 | 2010 | 13 | protocolTypeに'SVP'，defaultAuthorizationに'Disable'を指定する場合は，passwordも指定する必要があります。
400 | 2010 | 14 | passwordに無効な値を指定しました。
400 | 2010 | 15 | emptyPasswordに無効な値を指定しました。
400 | 2010 | 16 | protocolTypeに'WMI'，emptyPasswordに'Disable'を指定する場合は，userPasswordも指定する必要があります。
400 | 2010 | 17 | userPasswordに無効な値を指定しました。
400 | 2010 | 18 | defaultPortに無効な値を指定しました。
400 | 2010 | 19 | protocolTypeに'SVP'，defaultPortに'Disable'を指定する場合は，portNoも指定する必要があります。
400 | 2010 | 20 | portNoに無効な値を指定しました。
400 | 2010 | 21 | domainNameに無効な値を指定しました。
400 | 2010 | 22 | discoverHyperVに無効な値を指定しました。
400 | 2010 | 23 | suPasswordに無効な値を指定しました。
400 | 2010 | 24 | forceChangeに無効な値を指定しました。
400 | 2010 | 100 | リクエストボディーが指定されていません。
400 | 2010 | 101 | リクエストボディーの書式が無効です。JSONの書式で記述してください。
401 | 1000 | 1 | HTTPヘッダーのAuthorizationが指定されていません。
401 | 1000 | 2 | HTTPヘッダーのAuthorizationの値が不正です（Basic認証，HSSOセッション認証のどちらでもありません）。
401 | 1000 | 3 | HTTPヘッダーのAuthorizationのBasic認証の値が不正です（認証情報のフォーマットが不正です）。
401 | 1000 | 4 | ログインに失敗しました。
401 | 1002 | 1 | ログインセッションが切断されました。または，不正なHSSOトークンが指定されました。
403 | 1003 | 1 | 基本ライセンスが登録されていない，または有効期限を過ぎています。
403 | 1003 | 2 | 論理分割の機能を使用するためのプラグインライセンスがありません。または，ライセンスが無効です。日本語バージョンの場合，vmwareCredentialを編集するかdiscoverHyperVを'Enable'にして再実行してください。
403 | 2017 | 1 | 管理対象を参照する権限がありません。
404 | - | - | 指定したinstanceIDまたはcollectionはありません。
405 | - | - | サポートされていないメソッドです。
406 | 2010 | 1 | HTTPヘッダーのAcceptの値が不正です。
412 | 2013 | 1 | 指定したcredentialNameはCompute Systems Managerですでに使用済みです。
412 | 2150 | 20 | 指定された認証情報は幾つかのタスクで使用されているため，編集できません。
412 | 2150 | 21 | 指定された認証情報は幾つかの管理対象に関連づけられていますが，forceChangeに'Enable'が指定されていないため，編集できません。
415 | - | - | HTTPヘッダーのContent-Typeにサポートされていない形式が指定されています。
500 | - | - | HTTPヘッダーのContent-Typeに不正な値が指定されている，またはそれ以外の内部エラーです。
500 | 1000 | 1 | ログインに失敗しました（内部エラー）。
503 | 2020 | 1 | 要求の数がAPIの同時最大接続数を超えました。

7.5 認証情報を削除する

instanceIDで指定した認証情報を削除します。

ロール

All-Resources-Admin

リクエストライン

DELETE http://＜host＞:＜port＞/ComputeSystemsManager/v1/objects/Credentials/＜instanceID＞

instanceID:

Compute Systems Managerによって割り当てられた識別キー。

リクエストボディー

リクエストボディーには何も設定しません。

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。

ApiResult

{
       "id":...
}

属性 | データ型 | 数 | 説明
id | integer | 1 | 0が返ります。

リターンコード

HTTPステータスコード | 結果コード | 詳細コード | 説明
200 | 0 | 0 | 正常終了。
401 | 1000 | 1 | HTTPヘッダーのAuthorizationが指定されていません。
401 | 1000 | 2 | HTTPヘッダーのAuthorizationの値が不正です（Basic認証，HSSOセッション認証のどちらでもありません）。
401 | 1000 | 3 | HTTPヘッダーのAuthorizationのBasic認証の値が不正です（認証情報のフォーマットが不正です）。
401 | 1000 | 4 | ログインに失敗しました。
401 | 1002 | 1 | ログインセッションが切断されました。または，不正なHSSOトークンが指定されました。
403 | 1003 | 1 | 基本ライセンスが登録されていない，または有効期限を過ぎています。
403 | 2017 | 1 | 管理対象を参照する権限がありません。
404 | - | - | 指定したinstanceIDまたはcollectionはありません。
405 | - | - | サポートされていないメソッドです。
406 | 2010 | 1 | HTTPヘッダーのAcceptの値が不正です。
412 | 2150 | 1 | 指定された認証情報は幾つかのタスクで使用されているか，幾つかのリソースに関連づけられているため，削除できません。
415 | - | - | HTTPヘッダーのContent-Typeにサポートされていない形式が指定されています。
500 | - | - | HTTPヘッダーのContent-Typeに不正な値が指定されている，またはそれ以外の内部エラーです。
500 | 1000 | 1 | ログインに失敗しました（内部エラー）。
503 | 2020 | 1 | 要求の数がAPIの同時最大接続数を超えました。

8. IPアドレス範囲

この章では，IPアドレス範囲の情報取得・操作に関するAPIについて説明します。

この章の構成

8.1 すべてのIPアドレス範囲を取得する

8.2 IPアドレス範囲を作成する

8.3 特定のIPアドレス範囲を取得する

8.4 IPアドレス範囲を編集する

8.5 IPアドレス範囲を削除する

8.6 リソースを探索する

8.1 すべてのIPアドレス範囲を取得する

指定したIPアドレスバージョン，またはすべてのIPアドレス範囲を取得します。

ロール

All-Resources-Admin

リクエストライン

GET http://＜host＞:＜port＞/ComputeSystemsManager/v1/objects/IPAddressRanges?ipVersion=バージョン

クエリーパラメーターに指定できる値を次の表に示します。

パラメーター
説明

ipVersion
取得するIPアドレス範囲のIPアドレスバージョンを指定します。指定しない場合はすべてのIPアドレス範囲を取得します。

v4

v6

リクエストボディー

リクエストボディーには何も設定しません。

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。

IPAddressRange

{
   "IPAddressRange":[{
       "instanceID":"...",
       "ipAddressRangeName":"...",
       "description":"...",
       "ipVersion":"...",
       "startIPaddress":"...",
       "endIPaddress":"...",
       "ipv6Specifiers":{
           "ipAddress":["...", ...]
       },
       "usePing":"...",
       "credential":[{
           "instanceID":"..."
       },
       :
       ]
   },
   :
   ]
}

属性
データ型
数
説明

instanceID
string
1
Compute Systems Managerによって割り当てられた識別キー。

ipAddressRangeName
string
1
IPアドレス範囲の名前（1～32バイト）。

description
string
1
IPアドレス範囲の説明。

0-500 byte String

ipVersion
string
1
IPアドレスバージョン。

v4

v6

startIPaddress
string
1
探索開始IPアドレス（書式：IPv4形式）。ipVersionが'v4'の場合に使用します。ipVersionが'v6'の場合は空文字列です。

endIPaddress
string
1
探索終了IPアドレス（書式：IPv4 形式）。ipVersionが'v4'の場合に使用します。ipVersionが'v6'の場合は空文字列です。

ipv6Specifiers
IPv6Specifier
1
探索対象IPアドレス。ipVersionが'v6'の場合に使用します。ipVersionが'v4'の場合はnullです。

usePing
string
1
PINGを使用するかどうか。

Disable

Enable

credential
CredentialSpecifier
1～10
認証情報のリスト。

ipv6Specifiers

属性 | データ型 | 数 | 説明
ipAddress | string | 0～1024 | 探索対象のIPアドレス（書式：IPv6形式）。

credential

属性 | データ型 | 数 | 説明
instanceID | string | 1 | 関連する認証情報のinstanceID。

リターンコード

HTTPステータスコード | 結果コード | 詳細コード | 説明
200 | - | - | 正常終了。
401 | 1000 | 1 | HTTPヘッダーのAuthorizationが指定されていません。
401 | 1000 | 2 | HTTPヘッダーのAuthorizationの値が不正です（Basic認証，HSSOセッション認証のどちらでもありません）。
401 | 1000 | 3 | HTTPヘッダーのAuthorizationのBasic認証の値が不正です（認証情報のフォーマットが不正です）。
401 | 1000 | 4 | ログインに失敗しました。
401 | 1002 | 1 | ログインセッションが切断されました。または，不正なHSSOトークンが指定されました。
403 | 1003 | 1 | 基本ライセンスが登録されていない，または有効期限を過ぎています。
403 | 2017 | 1 | 管理対象を参照する権限がありません。
405 | - | - | サポートされていないメソッドです。
406 | 2010 | 1 | HTTPヘッダーのAcceptの値が不正です。
415 | - | - | HTTPヘッダーのContent-Typeにサポートされていない形式が指定されています。
500 | - | - | HTTPヘッダーのContent-Typeに不正な値が指定されている，またはそれ以外の内部エラーです。
500 | 1000 | 1 | ログインに失敗しました（内部エラー）。
503 | 2020 | 1 | 要求の数がAPIの同時最大接続数を超えました。

8.2 IPアドレス範囲を作成する

新しいIPアドレス範囲を作成します。

ロール

All-Resources-Admin

リクエストライン

POST http://＜host＞:＜port＞/ComputeSystemsManager/v1/objects/IPAddressRanges

リクエストボディー

リクエストボディーの構造とオブジェクトの属性を次に示します。

IPAddressRange

{
       "ipAddressRangeName":"...",
       "description":"...",
       "ipVersion":"...",
       "startIPaddress":"...",
       "endIPaddress":"...",
       "ipv6Specifiers":{
           "ipAddress":["...", ...]
       },
       "usePing":"...",
       "credential":[{
           "instanceID":"..."
       },
       :
       ]
}

属性
データ型
数
説明

ipAddressRangeName
string
0～1
IPアドレス範囲の名前（1～32バイト）。

description
string
0～1
IPアドレス範囲の説明。

0-500 byte String

ipVersion
string
1
IPアドレスバージョン。

v4

v6

startIPaddress
string
0～1
探索開始IPアドレス（書式：IPv4形式）。ipVersionが'v4'の場合に使用します。ipVersionが'v6'の場合は空文字列です。

endIPaddress
string
0～1
探索終了IPアドレス（書式：IPv4 形式）。ipVersionが'v4'の場合に使用します。ipVersionが'v6'の場合は空文字列です。

ipv6Specifiers
IPv6Specifier
0～1
探索対象IPアドレス。ipVersionが'v6'の場合に使用します。ipVersionが'v4'の場合はnullです。

usePing
string
0～1
PINGを使用するかどうか。

Disable

Enable

credential
CredentialSpecifier
0～10
認証情報のリスト。

ipv6Specifiers

属性 | データ型 | 数 | 説明
ipAddress | string | 0～1024 | 探索対象のIPアドレス（書式：IPv6形式）。

credential

属性 | データ型 | 数 | 説明
instanceID | string | 0～1 | 関連する認証情報のinstanceID。

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。

ApiResult

{
       "id":...
}

属性 | データ型 | 数 | 説明
id | integer | 1 | 作成したIPアドレス範囲のinstanceIDが返ります。

リターンコード

HTTPステータスコード | 結果コード | 詳細コード | 説明
201 | 0 | 0 | 正常終了。
400 | 2010 | 1 | ipAddressRangeNameに無効な値を指定しました。
400 | 2010 | 2 | descriptionに無効な値を指定しました。
400 | 2010 | 10 | ipVersionを指定していません。
400 | 2010 | 11 | ipVersionに無効な値を指定しました。
400 | 2010 | 12 | ipVersionに'v4'を指定する場合は，startIPaddressも指定する必要があります。
400 | 2010 | 13 | startIPaddressに無効な値を指定しました。
400 | 2010 | 14 | ipVersionに'v4'を指定する場合は，endIPaddressも指定する必要があります。
400 | 2010 | 15 | endIPaddressに無効な値を指定しました。
400 | 2010 | 16 | startIPaddressとendIPaddressの間に1024個を超えるIPアドレスが含まれています。または，startIPaddressがendIPaddressよりも小さくなっています。
400 | 2010 | 20 | ipVersionに'v6'を指定する場合は，ipv6Specifiersも指定する必要があります。
400 | 2010 | 22 | ipVersionに'v6'を指定したのにipAddressを指定していないか，ipAddressに1024個を超えるIPアドレスが含まれています。
400 | 2010 | 23 | ipAddressに無効な値を指定しました。
400 | 2010 | 30 | usePingに無効な値を指定しました。
400 | 2010 | 31 | credentialを指定していません。
400 | 2010 | 33 | credentialのinstanceIDを指定していません。credentialのinstanceIDは10個以内で指定してください。
400 | 2010 | 34 | credentialのinstanceIDに無効な値を指定しました（指定された認証情報がありません）。
400 | 2010 | 35 | ipVersionに'v6'を指定する場合は，credencialのinstanceIDにはsvpCredentialの認証情報だけを指定します。
400 | 2010 | 100 | リクエストボディーが指定されていません。
400 | 2010 | 101 | リクエストボディーの書式が無効です。JSONの書式で記述してください。
401 | 1000 | 1 | HTTPヘッダーのAuthorizationが指定されていません。
401 | 1000 | 2 | HTTPヘッダーのAuthorizationの値が不正です（Basic認証，HSSOセッション認証のどちらでもありません）。
401 | 1000 | 3 | HTTPヘッダーのAuthorizationのBasic認証の値が不正です（認証情報のフォーマットが不正です）。
401 | 1000 | 4 | ログインに失敗しました。
401 | 1002 | 1 | ログインセッションが切断されました。または，不正なHSSOトークンが指定されました。
403 | 1003 | 1 | 基本ライセンスが登録されていない，または有効期限を過ぎています。
403 | 2017 | 1 | 管理対象を参照する権限がありません。
405 | - | - | サポートされていないメソッドです。
406 | 2010 | 1 | HTTPヘッダーのAcceptの値が不正です。
412 | 2013 | 1 | 指定したipAddressRangeNameはCompute Systems Managerですでに使用済みです。
415 | - | - | HTTPヘッダーのContent-Typeにサポートされていない形式が指定されています。
500 | - | - | HTTPヘッダーのContent-Typeに不正な値が指定されている，またはそれ以外の内部エラーです。
500 | 1000 | 1 | ログインに失敗しました（内部エラー）。
503 | 2020 | 1 | 要求の数がAPIの同時最大接続数を超えました。

8.3 特定のIPアドレス範囲を取得する

instanceIDに指定したIPアドレス範囲を取得します。

ロール

All-Resources-Admin

リクエストライン

GET http://＜host＞:＜port＞/ComputeSystemsManager/v1/objects/IPAddressRanges/＜instanceID＞

instanceID:

Compute Systems Managerによって割り当てられた識別キー。

リクエストボディー

リクエストボディーには何も設定しません。

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。

IPAddressRange

{
   "IPAddressRange":[{
       "instanceID":"...",
       "ipAddressRangeName":"...",
       "description":"...",
       "ipVersion":"...",
       "startIPaddress":"...",
       "endIPaddress":"...",
       "ipv6Specifiers":{
           "ipAddress":["...", ...]
       },
       "usePing":"...",
       "credential":[{
           "instanceID":"..."
       },
       :
       ]
   }]
}

属性
データ型
数
説明

instanceID
string
1
Compute Systems Managerによって割り当てられた識別キー。

ipAddressRangeName
string
1
IPアドレス範囲の名前（1～32バイト）。

description
string
1
IPアドレス範囲の説明。

0-500 byte String

ipVersion
string
1
IPアドレスバージョン。

v4

v6

startIPaddress
string
1
探索開始IPアドレス（書式：IPv4形式）。ipVersionが'v4'の場合に使用します。ipVersionが'v6'の場合は空文字列です。

endIPaddress
string
1
探索終了IPアドレス（書式：IPv4 形式）。ipVersionが'v4'の場合に使用します。ipVersionが'v6'の場合は空文字列です。

ipv6Specifiers
IPv6Specifier
1
探索対象IPアドレス。ipVersionが'v6'の場合に使用します。ipVersionが'v4'の場合はnullです。

usePing
string
1
PINGを使用するかどうか。

Disable

Enable

credential
CredentialSpecifier
1～10
認証情報のリスト。

ipv6Specifiers

属性 | データ型 | 数 | 説明
ipAddress | string | 0～1024 | 探索対象のIPアドレス（書式：IPv6形式）。

credential

属性 | データ型 | 数 | 説明
instanceID | string | 1 | 関連する認証情報のinstanceID。

リターンコード

HTTPステータスコード | 結果コード | 詳細コード | 説明
200 | - | - | 正常終了。
204 | - | - | 指定したinstanceIDまたはcollectionはありません。
401 | 1000 | 1 | HTTPヘッダーのAuthorizationが指定されていません。
401 | 1000 | 2 | HTTPヘッダーのAuthorizationの値が不正です（Basic認証，HSSOセッション認証のどちらでもありません）。
401 | 1000 | 3 | HTTPヘッダーのAuthorizationのBasic認証の値が不正です（認証情報のフォーマットが不正です）。
401 | 1000 | 4 | ログインに失敗しました。
401 | 1002 | 1 | ログインセッションが切断されました。または，不正なHSSOトークンが指定されました。
403 | 1003 | 1 | 基本ライセンスが登録されていない，または有効期限を過ぎています。
403 | 2017 | 1 | 管理対象を参照する権限がありません。
405 | - | - | サポートされていないメソッドです。
406 | 2010 | 1 | HTTPヘッダーのAcceptの値が不正です。
415 | - | - | HTTPヘッダーのContent-Typeにサポートされていない形式が指定されています。
500 | - | - | HTTPヘッダーのContent-Typeに不正な値が指定されている，またはそれ以外の内部エラーです。
500 | 1000 | 1 | ログインに失敗しました（内部エラー）。
503 | 2020 | 1 | 要求の数がAPIの同時最大接続数を超えました。

8.4 IPアドレス範囲を編集する

instanceIDに指定したIPアドレス範囲を編集します。

ロール

All-Resources-Admin

リクエストライン

PUT http://＜host＞:＜port＞/ComputeSystemsManager/v1/objects/IPAddressRanges/＜instanceID＞

instanceID:

Compute Systems Managerによって割り当てられた識別キー。

リクエストボディー

リクエストボディーの構造とオブジェクトの属性を次に示します。

IPAddressRange

{
       "ipAddressRangeName":"...",
       "description":"...",
       "startIPaddress":"...",
       "endIPaddress":"...",
       "ipv6Specifiers":{
           "ipAddress":["...", ...]
       },
       "usePing":"...",
       "credential":[{
           "instanceID":"..."
       },
       :
       ]
}

属性
データ型
数
説明

ipAddressRangeName
string
0～1
IPアドレス範囲の名前（1～32バイト）。

description
string
0～1
IPアドレス範囲の説明。

0-500 byte String

startIPaddress
string
0～1
探索開始IPアドレス（書式：IPv4形式）。ipVersionが'v4'の場合に使用します。ipVersionが'v6'の場合は空文字列です。

endIPaddress
string
0～1
探索終了IPアドレス（書式：IPv4 形式）。ipVersionが'v4'の場合に使用します。ipVersionが'v6'の場合は空文字列です。

ipv6Specifiers
IPv6Specifier
0～1
探索対象IPアドレス。ipVersionが'v6'の場合に使用します。ipVersionが'v4'の場合はnullです。

usePing
string
0～1
PINGを使用するかどうか。

Disable

Enable

credential
CredentialSpecifier
0～10
認証情報のリスト。

ipv6Specifiers

属性 | データ型 | 数 | 説明
ipAddress | string | 0～1024 | 探索対象のIPアドレス（書式：IPv6形式）。

credential

属性 | データ型 | 数 | 説明
instanceID | string | 0～1 | 関連する認証情報のinstanceID。

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。

ApiResult

{
       "id":...
}

属性 | データ型 | 数 | 説明
id | integer | 1 | 編集したIPアドレス範囲のinstanceIDが返ります。

リターンコード

HTTPステータスコード | 結果コード | 詳細コード | 説明
200 | - | - | 正常終了。
400 | 2010 | 1 | ipAddressRangeNameに無効な値を指定しました。
400 | 2010 | 2 | descriptionに無効な値を指定しました。
400 | 2010 | 10 | endIPaddressを指定する場合は，startIPaddressも指定する必要があります。
400 | 2010 | 11 | startIPaddressを指定する場合は，endIPaddressも指定する必要があります。
400 | 2010 | 12 | startIPaddressに無効な値を指定しました。
400 | 2010 | 13 | endIPaddressに無効な値を指定しました。
400 | 2010 | 14 | startIPaddressとendIPaddressの間に1024個を超えるIPアドレスが含まれています。または，startIPaddressがendIPaddressよりも小さくなっています。
400 | 2010 | 21 | ipv6Specifiersを指定する場合は，ipAddressも指定する必要があります。ipAddressを1024個以内で指定してください。
400 | 2010 | 22 | ipAddressに無効な値を指定しました。
400 | 2010 | 30 | usePingに無効な値を指定しました。
400 | 2010 | 32 | credentialを指定する場合は，credentialのinstanceIDも指定する必要があります。
400 | 2010 | 33 | credentialのinstanceIDに無効な値を指定しました（指定された認証情報がありません）。
400 | 2010 | 34 | ipVersionに'v6'を指定する場合は，credencialのinstanceIDにはsvpCredentialの認証情報だけを指定します。
400 | 2010 | 35 | credentialのinstanceIDは10個以内です。
400 | 2010 | 100 | リクエストボディーが指定されていません。
400 | 2010 | 101 | リクエストボディーの書式が無効です。JSONの書式で記述してください。
401 | 1000 | 1 | HTTPヘッダーのAuthorizationが指定されていません。
401 | 1000 | 2 | HTTPヘッダーのAuthorizationの値が不正です（Basic認証，HSSOセッション認証のどちらでもありません）。
401 | 1000 | 3 | HTTPヘッダーのAuthorizationのBasic認証の値が不正です（認証情報のフォーマットが不正です）。
401 | 1000 | 4 | ログインに失敗しました。
401 | 1002 | 1 | ログインセッションが切断されました。または，不正なHSSOトークンが指定されました。
403 | 1003 | 1 | 基本ライセンスが登録されていない，または有効期限を過ぎています。
403 | 2017 | 1 | 管理対象を参照する権限がありません。
404 | - | - | 指定したinstanceIDまたはcollectionはありません。
405 | - | - | サポートされていないメソッドです。
406 | 2010 | 1 | HTTPヘッダーのAcceptの値が不正です。
412 | 2013 | 1 | 指定したipAddressRangeNameはCompute Systems Managerですでに使用済みです。
412 | 2150 | 21 | 指定されたIPアドレス範囲は探索タスクで使用されているため，編集できません。
415 | - | - | HTTPヘッダーのContent-Typeにサポートされていない形式が指定されています。
500 | - | - | HTTPヘッダーのContent-Typeに不正な値が指定されている，またはそれ以外の内部エラーです。
500 | 1000 | 1 | ログインに失敗しました（内部エラー）。
503 | 2020 | 1 | 要求の数がAPIの同時最大接続数を超えました。

8.5 IPアドレス範囲を削除する

instanceIDで指定したIPアドレス範囲を削除します。

ロール

All-Resources-Admin

リクエストライン

DELETE http://＜host＞:＜port＞/ComputeSystemsManager/v1/objects/IPAddressRanges/＜instanceID＞

instanceID:

Compute Systems Managerによって割り当てられた識別キー。

リクエストボディー

リクエストボディーには何も設定しません。

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。

ApiResult

{
       "id":...
}

属性 | データ型 | 数 | 説明
id | integer | 1 | 0が返ります。

リターンコード

HTTPステータスコード | 結果コード | 詳細コード | 説明
200 | - | - | 正常終了。
401 | 1000 | 1 | HTTPヘッダーのAuthorizationが指定されていません。
401 | 1000 | 2 | HTTPヘッダーのAuthorizationの値が不正です（Basic認証，HSSOセッション認証のどちらでもありません）。
401 | 1000 | 3 | HTTPヘッダーのAuthorizationのBasic認証の値が不正です（認証情報のフォーマットが不正です）。
401 | 1000 | 4 | ログインに失敗しました。
401 | 1002 | 1 | ログインセッションが切断されました。または，不正なHSSOトークンが指定されました。
403 | 1003 | 1 | 基本ライセンスが登録されていない，または有効期限を過ぎています。
403 | 2017 | 1 | 管理対象を参照する権限がありません。
404 | - | - | 指定したinstanceIDまたはcollectionはありません。
405 | - | - | サポートされていないメソッドです。
406 | 2010 | 1 | HTTPヘッダーのAcceptの値が不正です。
412 | 2150 | 1 | 指定されたIPアドレス範囲は探索タスクで使用されているため，削除できません。
415 | - | - | HTTPヘッダーのContent-Typeにサポートされていない形式が指定されています。
500 | - | - | HTTPヘッダーのContent-Typeに不正な値が指定されている，またはそれ以外の内部エラーです。
500 | 1000 | 1 | ログインに失敗しました（内部エラー）。
503 | 2020 | 1 | 要求の数がAPIの同時最大接続数を超えました。

8.6 リソースを探索する

instanceIDで指定したIPアドレス範囲の情報を使用してネットワーク内のリソースを探索し，管理対象に追加します。

ロール

All-Resources-Admin

リクエストライン

PUT http://＜host＞:＜port＞/ComputeSystemsManager/v1/objects/IPAddressRanges/＜instanceID＞/actions/Discovery/invoke

instanceID:

Compute Systems Managerによって割り当てられた識別キー。

リクエストボディー

リクエストボディーの構造とオブジェクトの属性を次に示します。

IPAddressRanges

{
       "discoveryType":"...",
       "first":"...",
       "unresponsive":"...",
       "failed":"...",
       "emailNotificationType":"...",
       "schedule":"...",
       "time":"..."
}

属性
データ型
数
説明

discoveryType
string
0～1
探索種別。

All：ipAddressRangeに指定されたすべてのリソースを探索します。

Undiscovery：ipAddressRangeに指定されたリソースのうち，前回探索していないリソースを探索します。（デフォルト）

first
string
0～1
以前に探索していないリソースを探索します。discoveryTypeに'Undiscovery'を指定した場合に有効。

Disable

Enable（デフォルト）

unresponsive
string
0～1
前回の探索で応答のなかったリソースを探索します。discoveryTypeに'Undiscovery'を指定した場合に有効。

Disable

Enable（デフォルト）

failed
string
0～1
前回の探索で失敗したリソースを探索します。discoveryTypeに'Undiscovery'を指定した場合に有効。

Disable

Enable（デフォルト）

emailNotificationType
string
0～1
Eメール送信モード。

SEND：Eメールを送信します。

SEND_ONLY_DISCOVERED_RESOURCES：新たにリソースが探索されたときだけEメールを送信します。

NOT_SEND：Eメールを送信しません。（デフォルト）

schedule
string
1
探索を実行するタイミング。

NOW：すぐに実行します。

LATER：timeで指定した時間に実行します。

time
string
0～1
探索を実行する管理サーバの時刻（書式：YYYY/MM/DD HH:MM:SS）。過去の時刻は指定できません。scheduleが'LATER'のときに有効です。

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。

ApiResult

{
       "id":...
}

属性 | データ型 | 数 | 説明
id | integer | 1 | 管理対象リソース探索のために登録されたタスクのタスクIDが返ります。

リターンコード

HTTPステータスコード | 結果コード | 詳細コード | 説明
202 | 0 | 0 | 正常終了。
400 | 2010 | 1 | discoveryTypeに無効な値を指定しました。
400 | 2010 | 2 | firstに無効な値を指定しました。
400 | 2010 | 3 | unresponsiveに無効な値を指定しました。
400 | 2010 | 4 | failedに無効な値を指定しました。
400 | 2010 | 5 | emailNotificationTypeに無効な値を指定しました。
400 | 2010 | 6 | scheduleを指定していません。
400 | 2010 | 7 | scheduleに無効な値を指定しました。
400 | 2010 | 8 | scheduleに'LATER'を指定する場合は，timeも指定する必要があります。
400 | 2010 | 9 | timeに無効な値を指定しました。
400 | 2010 | 10 | 指定した日付は2100年12月31日以降です。
400 | 2010 | 11 | discoveryTypeに'Undiscovery'を指定したにも関わらず，first，unresponsiveおよびfailedのすべてに'Disable'が指定されています。
400 | 2010 | 100 | リクエストボディーが指定されていません。
400 | 2010 | 101 | リクエストボディーの書式が無効です。JSONの書式で記述してください。
401 | 1000 | 1 | HTTPヘッダーのAuthorizationが指定されていません。
401 | 1000 | 2 | HTTPヘッダーのAuthorizationの値が不正です（Basic認証，HSSOセッション認証のどちらでもありません）。
401 | 1000 | 3 | HTTPヘッダーのAuthorizationのBasic認証の値が不正です（認証情報のフォーマットが不正です）。
401 | 1000 | 4 | ログインに失敗しました。
401 | 1002 | 1 | ログインセッションが切断されました。または，不正なHSSOトークンが指定されました。
403 | 1003 | 1 | 基本ライセンスが登録されていない，または有効期限を過ぎています。
403 | 2017 | 1 | 管理対象を参照する権限がありません。
404 | - | - | 指定したinstanceIDまたはcollectionはありません。
405 | - | - | サポートされていないメソッドです。
406 | 2010 | 1 | HTTPヘッダーのAcceptの値が不正です。
412 | 2018 | 1 | timeに過去の時刻を指定しました。
415 | - | - | HTTPヘッダーのContent-Typeにサポートされていない形式が指定されています。
500 | - | - | HTTPヘッダーのContent-Typeに不正な値が指定されている，またはそれ以外の内部エラーです。
500 | 1000 | 1 | ログインに失敗しました（内部エラー）。
503 | 2020 | 1 | 要求の数がAPIの同時最大接続数を超えました。

9. ユーザー管理

この章では，ユーザーのログインに関するAPIについて説明します。

この章の構成

9.1 Compute Systems Managerにログインする

9.2 Compute Systems Managerからログアウトする

9.1 Compute Systems Managerにログインする

HTTPヘッダーに登録されているユーザーIDとパスワードでCompute Systems Managerにログインします。

ロール

Admin/Modify/View/User-Management

リクエストライン

GET http://＜host＞:＜port＞/ComputeSystemsManager/v1/services/User/actions/login/invoke

リクエストボディー

リクエストボディーには何も設定しません。

レスポンスボディー

レスポンスボディーは出力されません。

リターンコード

HTTPステータスコード | 結果コード | 詳細コード | 説明
204 | - | - | 正常終了。
401 | 1000 | 1 | HTTPヘッダーのAuthorizationが指定されていません。
401 | 1000 | 2 | HTTPヘッダーのAuthorizationの値が不正です（Basic認証，HSSOセッション認証のどちらでもありません）。
401 | 1000 | 3 | HTTPヘッダーのAuthorizationのBasic認証の値が不正です（認証情報のフォーマットが不正です）。
401 | 1000 | 4 | ログインに失敗しました。
401 | 1000 | 100 | Basic認証が指定されていません。
401 | 1002 | 1 | ログインセッションが切断されました。または，不正なHSSOトークンが指定されました。
403 | 1003 | 1 | 基本ライセンスが登録されていない，または有効期限を過ぎています。
405 | - | - | サポートされていないメソッドです。
406 | 2010 | 1 | HTTPヘッダーのAcceptの値が不正です。
415 | - | - | HTTPヘッダーのContent-Typeにサポートされていない形式が指定されています。
500 | - | - | HTTPヘッダーのContent-Typeに不正な値が指定されている，またはそれ以外の内部エラーです。
500 | 1000 | 1 | ログインに失敗しました（内部エラー）。
503 | 2020 | 1 | 要求の数がAPIの同時最大接続数を超えました。

9.2 Compute Systems Managerからログアウトする

HTTPヘッダーに登録されているセッションIDでログアウトします。

ロール

Admin/Modify/View/User-Management

リクエストライン

GET http://＜host＞:＜port＞/ComputeSystemsManager/v1/services/User/actions/logout/invoke

リクエストボディー

リクエストボディーには何も設定しません。

レスポンスボディー

レスポンスボディーは出力されません。

リターンコード

HTTPステータスコード | 結果コード | 詳細コード | 説明
204 | - | - | 正常終了。
401 | 1000 | 1 | HTTPヘッダーのAuthorizationが指定されていません。
401 | 1000 | 2 | HTTPヘッダーのAuthorizationの値が不正です（Basic認証，HSSOセッション認証のどちらでもありません）。
401 | 1000 | 3 | HTTPヘッダーのAuthorizationのBasic認証の値が不正です（認証情報のフォーマットが不正です）。
401 | 1000 | 4 | ログインに失敗しました。
401 | 1000 | 101 | HSSOセッションIDが指定されていません。
401 | 1002 | 1 | ログインセッションが切断されました。または，不正なHSSOトークンが指定されました。
403 | 1003 | 1 | 基本ライセンスが登録されていない，または有効期限を過ぎています。
405 | - | - | サポートされていないメソッドです。
406 | 2010 | 1 | HTTPヘッダーのAcceptの値が不正です。
415 | - | - | HTTPヘッダーのContent-Typeにサポートされていない形式が指定されています。
500 | - | - | HTTPヘッダーのContent-Typeに不正な値が指定されている，またはそれ以外の内部エラーです。
500 | 1000 | 1 | ログインに失敗しました（内部エラー）。
503 | 2020 | 1 | 要求の数がAPIの同時最大接続数を超えました。

10. 管理対象リソース

この章では，管理対象の探索に関するAPIについて説明します。

この章の構成

10.1 複数のIPアドレス範囲を使用して管理対象を探索する

10.1 複数のIPアドレス範囲を使用して管理対象を探索する

複数のIPアドレス範囲を使用して管理対象を探索します。

ロール

All-Resources-Admin

リクエストライン

PUT http://＜host＞:＜port＞/ComputeSystemsManager/v1/services/ManagedResource/actions/Discovery/invoke

リクエストボディー

リクエストボディーの構造とオブジェクトの属性を次に示します。

IPAddressRanges

{
       "ipAddressRange":[{
           "instanceID":"..."
       },
       :
       ],
       "discoveryType":"...",
       "first":"...",
       "unresponsive":"...",
       "failed":"...",
       "emailNotificationType":"...",
       "schedule":"...",
       "time":"..."
}

属性
データ型
数
説明

ipAddressRange
InstanceIDList
1～10
使用するIPアドレス範囲のインスタンスID。

discoveryType
string
0～1
探索種別。

All：ipAddressRangeに指定されたすべてのリソースを探索します。

Undiscovery：ipAddressRangeに指定されたリソースのうち，前回探索していないリソースを探索します。（デフォルト）

first
string
0～1
以前に探索していないリソースを探索します。discoveryTypeに'Undiscovery'を指定した場合に有効。

Disable

Enable（デフォルト）

unresponsive
string
0～1
前回の探索で応答のなかったリソースを探索します。discoveryTypeに'Undiscovery'を指定した場合に有効。

Disable

Enable（デフォルト）

failed
string
0～1
前回の探索で失敗したリソースを探索します。discoveryTypeに'Undiscovery'を指定した場合に有効。

Disable

Enable（デフォルト）

emailNotificationType
string
0～1
Eメール送信モード。

SEND：Eメールを送信します。

SEND_ONLY_DISCOVERED_RESOURCES：新たにリソースが探索されたときだけEメールを送信します。

NOT_SEND：Eメールを送信しません。（デフォルト）

schedule
string
1
探索を実行するタイミング。

NOW：すぐに実行します。

LATER：timeで指定した時間に実行します。

time
string
0～1
探索を実行する管理サーバの時刻（書式：YYYY/MM/DD HH:MM:SS）。過去の時刻は指定できません。scheduleが'LATER'のときに有効です。

ipAddressRange

属性 | データ型 | 数 | 説明
instanceID | string | 1 | Compute Systems Managerで管理している識別キー。

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。

ApiResult

{
       "id":...
}

属性 | データ型 | 数 | 説明
id | integer | 1 | 管理対象リソース探索のために登録されたタスクのタスクIDが返ります。

リターンコード

HTTPステータスコード | 結果コード | 詳細コード | 説明
202 | 0 | 0 | 正常終了。
400 | 2010 | 1 | ipAddressRangeを指定していません。
400 | 2010 | 2 | ipAddressRangeのinstanceIDに不正な値を指定しました。
400 | 2010 | 3 | ipAddressRangeのinstanceIDを指定していないか，ipAddressRangeのinstanceIDを10個より多く指定しています。
400 | 2010 | 4 | ipAddressRangeのinstanceIDに指定した値が不正です（指定されたIPアドレス範囲が見つかりません）。
400 | 2010 | 5 | discoveryTypeに無効な値を指定しました。
400 | 2010 | 6 | firstに無効な値を指定しました。
400 | 2010 | 7 | unresponsiveに無効な値を指定しました。
400 | 2010 | 8 | failedに無効な値を指定しました。
400 | 2010 | 9 | emailNotificationTypeに無効な値を指定しました。
400 | 2010 | 10 | scheduleを指定していません。
400 | 2010 | 11 | scheduleに無効な値を指定しました。
400 | 2010 | 12 | scheduleに'LATER'を指定する場合は，timeも指定する必要があります。
400 | 2010 | 13 | timeに無効な値を指定しました。
400 | 2010 | 14 | 指定した日付は2100年12月31日以降です。
400 | 2010 | 15 | discoveryTypeに'Undiscovery'を指定したにも関わらず，first，unresponsiveおよびfailedのすべてに'Disable'が指定されています。
400 | 2010 | 100 | リクエストボディーが指定されていません。
400 | 2010 | 101 | リクエストボディーの書式が無効です。JSONの書式で記述してください。
401 | 1000 | 1 | HTTPヘッダーのAuthorizationが指定されていません。
401 | 1000 | 2 | HTTPヘッダーのAuthorizationの値が不正です（Basic認証，HSSOセッション認証のどちらでもありません）。
401 | 1000 | 3 | HTTPヘッダーのAuthorizationのBasic認証の値が不正です（認証情報のフォーマットが不正です）。
401 | 1000 | 4 | ログインに失敗しました。
401 | 1002 | 1 | ログインセッションが切断されました。または，不正なHSSOトークンが指定されました。
403 | 1003 | 1 | 基本ライセンスが登録されていない，または有効期限を過ぎています。
403 | 2017 | 1 | 管理対象を参照する権限がありません。
405 | - | - | サポートされていないメソッドです。
406 | 2010 | 1 | HTTPヘッダーのAcceptの値が不正です。
412 | 2018 | 1 | timeに過去の時刻を指定しました。
415 | - | - | HTTPヘッダーのContent-Typeにサポートされていない形式が指定されています。
500 | - | - | HTTPヘッダーのContent-Typeに不正な値が指定されている，またはそれ以外の内部エラーです。
500 | 1000 | 1 | ログインに失敗しました（内部エラー）。
503 | 2020 | 1 | 要求の数がAPIの同時最大接続数を超えました。

11. バージョン情報

この章では，バージョン情報の取得に関するAPIについて説明します。

この章の構成

11.1 Compute Systems Managerのバージョン情報を取得する

11.1 Compute Systems Managerのバージョン情報を取得する

Compute Systems ManagerのAPIのバージョン情報を取得します。

ロール

Admin/Modify/View/User-Management

リクエストライン

GET http://＜host＞:＜port＞/ComputeSystemsManager/v1/version

リクエストボディー

リクエストボディーには何も設定しません。

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。

GetVersionResponse

{
       "apiVersion":"...",
       "productVersion":"...",
       "minSupportedProtocolVersion":...,
       "maxSupportedProtocolVersion":...,
       "deprecatedProtocolVersion":...,
       "timeStamp":"..."
}

属性 | データ型 | 数 | 説明
apiVersion | string | 1 | APIのバージョン。
productVersion | string | 1 | Compute Systems Managerのバージョン。
minSupportedProtocolVersion | integer | 1 | サポートしているAPIバージョンの最小値。
maxSupportedProtocolVersion | integer | 1 | サポートしているAPIバージョンの最大値。
deprecatedProtocolVersion | integer | 1 | 非推奨のAPIバージョン。
timeStamp | string | 1 | バージョン情報を取得した時間。

リターンコード

HTTPステータスコード | 結果コード | 詳細コード | 説明
200 | - | - | 正常終了。
401 | 1000 | 1 | HTTPヘッダーのAuthorizationが指定されていません。
401 | 1000 | 2 | HTTPヘッダーのAuthorizationの値が不正です（Basic認証，HSSOセッション認証のどちらでもありません）。
401 | 1000 | 3 | HTTPヘッダーのAuthorizationのBasic認証の値が不正です（認証情報のフォーマットが不正です）。
401 | 1000 | 4 | ログインに失敗しました。
401 | 1002 | 1 | ログインセッションが切断されました。または，不正なHSSOトークンが指定されました。
403 | 1003 | 1 | 基本ライセンスが登録されていない，または有効期限を過ぎています。
405 | - | - | サポートされていないメソッドです。
406 | 2010 | 1 | HTTPヘッダーのAcceptの値が不正です。
415 | - | - | HTTPヘッダーのContent-Typeにサポートされていない形式が指定されています。
500 | - | - | HTTPヘッダーのContent-Typeに不正な値が指定されている，またはそれ以外の内部エラーです。
500 | 1000 | 1 | ログインに失敗しました（内部エラー）。
503 | 2020 | 1 | 要求の数がAPIの同時最大接続数を超えました。

付録A. Compute Systems ManagerのAPIの使用例

この章では，Compute Systems ManagerのAPIの使用例として，JavaScriptで記述されたサンプルコードについて説明します。

サンプルコードの動作環境はInternet Explorerを前提としています。

この付録の構成

A.1 ブレードサーバの一覧を取得するAPIの使用例

A.2 ブレードサーバの電源をONにするAPIの使用例

A.1 ブレードサーバの一覧を取得するAPIの使用例

Compute Systems Manager が管理するすべてのブレードサーバの情報を取得し，レスポンスを解析する処理のサンプルコードを示します。ユーザー認証はBasic 認証を使用しています。

処理の概要

HTTP ヘッダーに認証情報や入出力データのエンコード形式などを設定します。
このサンプルでは次のユーザーでログインします。
ユーザーID：system
パスワード：manager
Basic認証のAuthorizationヘッダーは次のように設定します。

Authorization: Basic ＜base64-id-password＞

＜base64-id-password＞には，ユーザーIDとパスワードを半角コロン（:）でつないだ文字列をbase64でエンコードした値を設定します。
上記と異なるユーザーでログインする場合は， Authorizationヘッダーに設定するエンコード済みの文字列を，実際のユーザーIDとパスワードから生成した値に置き換えてください。

localhostの 管理サーバに対して，すべてのブレードサーバの情報を取得するAPI を実行します。

処理2 で実行した API のレスポンスボディーを解析し，ブレードサーバの属性のinstanceId，serverProductName，slotNumber，serverStatusを取得します。

解析した値を画面に出力します。

サンプルコード

<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>HCSM REST API Sample</title>
<script type="text/javascript" lang="javascript">
   function CreateHttpRequest() {
       try {
           return new XMLHttpRequest();
       } catch (e) {
       }
       try {
           return new ActiveXObject('MSXML2.XMLHTTP.6.0');
       } catch (e) {
       }
       try {
           return new ActiveXObject('MSXML2.XMLHTTP.3.0');
       } catch (e) {
       }
       try {
           return new ActiveXObject('MSXML2.XMLHTTP');
       } catch (e) {
       }

       return null;
   }

   /**
    * Set the request header to call HCSM API
    */
   function setHeader(req) {

       // In the Authorization header of the request,
       // specify the word Basic, followed by a base64-encoded string
       // that encodes the user name and password separated by a colon.
       req.setRequestHeader("Authorization", "Basic c3lzdGVtOm1hbmFnZXI=");
       req.setRequestHeader('Accept', 'application/json');
       req.setRequestHeader('Content-Type', 'application/json; charset=UTF-8');
       return req;
   }

   /**
    * Send request (HTTP GET)
    */
   function sendGetRequest(url) {
       var req = new CreateHttpRequest();
       req.open("GET", url, false);
       setHeader(req);
       req.send(null);
       return req;
   }

   /**
    * Parse blade information (JSON)
    */
   function parseBlades(res) {
       // parse responce
       var jsonObj = JSON.parse(res);
       var servers = jsonObj.Server;

       var data = "";

       for (i = 0; i < servers.length; i++) {
           var serverData = "#"
                   + i
                   + "¥t instanceId="
                   + servers[i].instanceId
                   + ", serverProductName="
                   + servers[i].serverProductName
                   + ", slotNumber="
                   + servers[i].slotNumber
                   + ", serverStatus="
                   + servers[i].serverStatus
                   + "<br>";
           data = data
                   + serverData;
       }

       // display a result
       document.getElementById("after").innerHTML = data;
   }

   /**
    * Parse error respose
    */
   function parseErrorRespose(req) {
       var statusCode = req.status;
       var statusText = req.statusText;
       var errorCode;
       var detailCode;
       var resformat = req.getResponseHeader("Content-Type");
       if (req.responseText != null
               && resformat == "application/json") {
           var jsonObj = JSON.parse(req.responseText);
           errorCode = jsonObj.resultCode;
           detailCode = jsonObj.detailCode;
       }

       document.getElementById("after").innerHTML = "HTTP status : "
               + statusCode
               + " "
               + statusText
               + "¥nerrorCode : "
               + errorCode
               + "¥netailCode : "
               + detailCode;
   }

   /**
    * Obtain information for all blade servers
    */
   function GetBlades() {
       try {
           // execute HCSM REST API
           var uri = "http://localhost:22015/ComputeSystemsManager/v1/objects/Blades";
           var req = sendGetRequest(uri);

           if (req.status == 200) {
               // success
               parseBlades(req.responseText);
           } else if (req.status == 204) {
               // success(no content)
               document.getElementById("after").innerHTML = req.status
                       + " "
                       + req.statusText;
           } else {
               // error
               parseErrorRespose(req);
           }

       } catch (err) {
           alert(err.description);
       }
   }
</script>
</head>
<body onload="GetBlades()">
   Obtain some attributes from the information of all blade servers
   <br>
   <hr>
   <div id="after"></div>
</body>

サンプルコードの実行結果例

#0 instanceId=SGl0YWNoaV8wX0RNWV9CTF9TTl8wMTAxMDEwMV8wMA==, serverProductName=BladeSymphony 520AA1, slotNumber=0, serverStatus=Running
#1 instanceId=SGl0YWNoaV8wX0RNWV9CTF9TTl8wMTAxMDEwMV8wMQ==, serverProductName=BladeSymphony 520AA1, slotNumber=1, serverStatus=Running
#2 instanceId=SGl0YWNoaV8wX0RNWV9CTF9TTl8wMTAxMDEwMV8wMg==, serverProductName=BladeSymphony 520AA1, slotNumber=2,3, serverStatus=Running
#3 instanceId=SGl0YWNoaV8wX0RNWV9CTF9TTl8wMTAxMDEwMV8wNA==, serverProductName=BladeSymphony 520HA1, slotNumber=4, serverStatus=Running
#4 instanceId=SGl0YWNoaV8wX0RNWV9CTF9TTl8wMTAxMDEwMV8wNQ==, serverProductName=BladeSymphony 520AA1, slotNumber=5, serverStatus=Running

A.2 ブレードサーバの電源をONにするAPIの使用例

Compute Systems Manager が管理する特定のブレードサーバの電源をON にするタスクを登録し，タスクの終了を確認する処理のサンプルコードを示します。ユーザー認証はBasic 認証を使用しています。

処理の概要

HTTP ヘッダーに認証情報や入出力データのエンコード形式などを設定します。
このサンプルでは次のユーザーでログインします。
ユーザーID：system
パスワード：manager
Basic認証のAuthorizationヘッダーは次のように設定します。

Authorization: Basic ＜base64-id-password＞

＜base64-id-password＞には，ユーザーIDとパスワードを半角コロン（:）でつないだ文字列をbase64でエンコードした値を設定します。
上記と異なるユーザーでログインする場合は， Authorizationヘッダーに設定するエンコード済みの文字列を，実際のユーザーIDとパスワードから生成した値に置き換えてください。

localhostの管理サーバに対して，すべてのブレードサーバの情報を取得するAPIを実行します。

処理2で実行した API のレスポンスボディーを解析し，ブレードサーバの一覧から最初のブレードサーバのinstanceIdを取得します。

処理3で取得したブレードサーバの電源をON にするAPI を実行します。

処理4 で実行したAPI のレスポンスボディーを解析しtaskIDを取得します。

処理5で取得したtaskIDのタスクの情報を取得するAPIを，タスクが終了する（タスクの状態がCompleted，Canceled，FailedまたはSkippedになる）まで繰り返し実行します。

電源をONにするブレードサーバの情報，およびタスクの結果を画面に表示します。

サンプルコード

<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>HCSM REST API Sample</title>
<script type="text/javascript" lang="javascript">
   function CreateHttpRequest() {
       try {
           return new XMLHttpRequest();
       } catch (e) {
       }
       try {
           return new ActiveXObject('MSXML2.XMLHTTP.6.0');
       } catch (e) {
       }
       try {
           return new ActiveXObject('MSXML2.XMLHTTP.3.0');
       } catch (e) {
       }
       try {
           return new ActiveXObject('MSXML2.XMLHTTP');
       } catch (e) {
       }

       return null;
   }

   /**
    * Set the request header to call HCSM API
    */
   function setHeader(req) {

       // In the Authorization header of the request,
       // specify the word Basic, followed by a base64-encoded string
       // that encodes the user name and password separated by a colon.
       req.setRequestHeader("Authorization", "Basic c3lzdGVtOm1hbmFnZXI=");
       req.setRequestHeader('Accept', 'application/json');
       req.setRequestHeader('Content-Type', 'application/json; charset=UTF-8');
       return req;
   }

   /**
    * Send request (HTTP GET)
    */
   function sendGetRequest(url) {
       var req = new CreateHttpRequest();
       req.open("GET", url, false);
       setHeader(req);
       req.send(null);
       return req;
   }

   /**
    * Send request (HTTP PUT)
    */
   function sendPutRequest(url, body) {
       var req = new CreateHttpRequest();
       req.open("PUT", url, false);
       setHeader(req);
       req.send(body);
       return req;
   }

   /**
    * Obtain instance ID of the first blade from the list of blades
    */
   function getFirstBlade() {

       // Obtain information for all blade servers
       var uri = "http://localhost:22015/ComputeSystemsManager/v1/objects/Blades";
       var req = sendGetRequest(uri);

       var instanceId = null;
       if (req.status == 200) { // success
           var jsonObj = JSON.parse(req.responseText);
           var servers = jsonObj.Server;

           // Obtain instance ID of the first blade from the list of blades
           instanceId = servers[0].instanceId;

           document.getElementById("targetblade").innerHTML = "instanceId="
                   + instanceId
                   + "<br>serverProductName="
                   + servers[0].serverProductName
                   + "<br>slotNumber="
                   + servers[0].slotNumber
                   + "<br>serverStatus="
                   + servers[0].serverStatus;
       } else if (req.status == 204) { // no content
           document.getElementById("targetblade").innerHTML = req.status
                   + " "
                   + req.statusText;
       } else { // failed
           document.getElementById("targetblade").innerHTML = req.status
                   + " "
                   + req.statusText
                   + "<br>"
                   + req.responseText;
       }
       return instanceId;
   }

   /**
    * Wait for task completed
    */
   function waitForTaskCompleted(taskid) {
       var status = "error"

       // Obtains information for the task with the specified taskID until a task is completed.
       var hoge = setInterval(function() {
           try {
               //  Obtains information for the task with the specified taskID
               var uri = "http://localhost:22015/ComputeSystemsManager/v1/objects/Tasks/"
                       + taskid;
               var req = sendGetRequest(uri);

               if (req.status == 200) { // success
                   var jsonObj = JSON.parse(req.responseText);
                   var taskExecutionInfoList = jsonObj.TaskExecutionInfo;
                   var taskExecutionInfo = taskExecutionInfoList[0];
                   var taskName = taskExecutionInfo.taskName;
                   status = taskExecutionInfo.status;
                   if (taskExecutionInfo.status == "Canceled"
                           || taskExecutionInfo.status == "Completed"
                           || taskExecutionInfo.status == "Failed"
                           || taskExecutionInfo.status == "Skipped") {

                       clearInterval(hoge);
                   }
                   document.getElementById("taskRes").innerHTML = "taskID="
                           + taskid
                           + ", taskName="
                           + taskName
                           + ", status="
                           + status;

               } else if (req.status == 204) { // no content
                   document.getElementById("taskRes").innerHTML = req.status
                           + " "
                           + req.statusText;
                   clearInterval(hoge);
               } else { // fail
                   document.getElementById("taskRes").innerHTML = req.status
                           + " "
                           + req.statusText
                           + "<br>"
                           + req.responseText;
                   clearInterval(hoge);
               }
           } catch (err) {
               clearInterval(hoge);
               alert(err.description);
           }
       }, 1000);
       return status;
   }

   /**
    * Set parameter for power on blade
    */
   function PowerOnParameter(schedule, time, elapseTime, verifyLpm, lpmElapseTime,
           emailNotificationType) {
       this.schedule = schedule;
       this.time = time;
       this.elapseTime = elapseTime;
       this.verifyLpm = verifyLpm;
       this.lpmElapseTime = lpmElapseTime;
       this.emailNotificationType = emailNotificationType;
   }

   /**
    * Obtains time one minute after the current time
    */
   function getTaskStartTime() {
       var current = new Date();
       formatedData = 'YYYY/MM/DD hh:mm:ss';
       formatedData = formatedData.replace(/YYYY/g, current.getFullYear());
       formatedData = formatedData.replace(/MM/g, ('0' + (current.getMonth() + 1)).slice(-2));
       formatedData = formatedData.replace(/DD/g, ('0' + current.getDate()).slice(-2));
       formatedData = formatedData.replace(/hh/g, ('0' + current.getHours()).slice(-2));
       formatedData = formatedData.replace(/mm/g, ('0' + (current.getMinutes() + 1)).slice(-2));
       formatedData = formatedData.replace(/ss/g, ('0' + current.getSeconds()).slice(-2));
       return formatedData;
   }

   /**
    * Create Http Body
    */
   function createBody() {
       // api parameter
       var schedule = "LATER"; // NOW or LATER
       var time = getTaskStartTime();
       var elapseTime = 0;
       var verifyLpm = "YES"; // YES or NO
       var lpmElapseTime = 0;
       var emailNotificationType = "NOT_SEND"; // NOT_SEND or SEND_ONLY_TASK_FAILED or SEND

       // object -> json
       var param = new PowerOnParameter(schedule, time, elapseTime, verifyLpm, lpmElapseTime,
               emailNotificationType);

       var body = JSON.stringify(param);
       document.getElementById("taskparam").innerHTML = body;
       return body;
   }

   /**
    *  Power on blade
    */
   function powerOnBlade() {
       try {
           // Obtain instance ID of the first blade from the list of blades
           var instanceId = getFirstBlade();
           if (instanceId == null) {
               return;
           }

           // create HTTP Body parameter
           var body = createBody();

           // call HCSM REST API(blade power on)
           var uri = "http://localhost:22015/ComputeSystemsManager/v1/objects/Blades/"
                   + instanceId
                   + "/actions/Poweron/invoke";
           var req = sendPutRequest(uri, body);

           if (req.status == 200) { // success
               var jsonObj = JSON.parse(req.responseText);
               var taskid = jsonObj.id;
               document.getElementById("taskreg").innerHTML = taskid;
               var status = waitForTaskCompleted(taskid);

           } else { // fail
               document.getElementById("taskreg").innerHTML = req.status
                       + " "
                       + req.statusText
                       + "<br>"
                       + req.responseText;
           }

       } catch (err) {
           alert(err.description);
       }
   }
</script>
</head>
<body>
   Obtain information for all blade servers and then power on the first blade of the list
   <br>
   <input type="button" value="Power On" onclick="powerOnBlade()">
   <hr>
   Target blade :
   <div id="targetblade"></div>
   <hr>
   Task parameter :
   <div id="taskparam"></div>
   <hr>
   Task registration :
   <div id="taskreg"></div>
   <hr>
   Task result :
   <div id="taskRes"></div>
</body>
</html>

サンプルコードの実行結果例

Target blade :
instanceId=SGl0YWNoaV8wX0RNWV9CTF9TTl8wMTAxMDEwMV8wMA==
serverProductName=BladeSymphony 520AA1
slotNumber=0
serverStatus=Running
-------------------------------------------------------------------------
Task parameter :
{"schedule":"LATER","time":"2016/03/01 16:49:17","elapseTime":0,"verifyLpm":"YES","lpmElapseTime":0,"emailNotificationType":"NOT_SEND"}
-------------------------------------------------------------------------
Task registration :
400000000015882
-------------------------------------------------------------------------
Task result :
taskID=400000000015882, taskName=Power On-22, status=Completed

付録B. このマニュアルの参考情報

この章では，このマニュアルを読むに当たっての参考情報について説明します。

この付録の構成

B.1 関連マニュアル

B.2 このマニュアルでの表記

B.3 英略語

B.4 KB（キロバイト）などの単位表記について

B.1 関連マニュアル

このマニュアルの関連マニュアルを次に示します。必要に応じてお読みください。

Hitachi Command Suite Compute Systems Manager ユーザーズガイド（3021-9-096）

Hitachi Command Suite Compute Systems Manager 導入・設定ガイド（3021-9-097）

Hitachi Command Suite Compute Systems Manager CLI リファレンスガイド（3021-9-099）

Hitachi Command Suite Compute Systems Manager メッセージ（3021-9-100）

B.2 このマニュアルでの表記

このマニュアルでは，製品名を次のように表記しています。

表記
製品名

Linux
次の製品を区別する必要がない場合の表記です。

Oracle Enterprise Linux®

Oracle Linux®

Red Hat Enterprise Linux®

SUSE Linux® Enterprise Server

VMware ESXi
VMware vSphere® ESXi™

B.3 英略語

このマニュアルで使用する英略語を次に示します。

英略語 | 英字での表記
API | Application Programming Interface
BMC | Baseboard Management Controller
CLI | Command Line Interface
DHCP | Dynamic Host Configuration Protocol
EFI | Extensible Firmware Interface
FC | Fibre Channel
FCoE | Fibre Channel over Ethernet
GUI | Graphical User Interface
HBA | Host Bus Adapter
HVM | Hitachi Virtualization Manager
I/O | Input/Output
JSON | JavaScript Object Notation
LPAR | Logical PARtition
MAC | Media Access Control
NIC | Network Interface Card
NTP | Network Time Protocol
NUMA | Non-Uniform Memory Access
PCI | Peripheral Component Interconnect
SMP | Symmetrical Multi Processing
SMT | Simultaneous MultiThreading
SR-IOV | Single Root I/O Virtualization
SSH | Secure SHell
SSL | Secure Sockets Layer
SVP | SerVice Processor
UEFI | Unified Extensible Firmware Interface
URI | Uniform Resource Identifier
UUID | Universally Unique Identifier
VF | Virtual Function
VM | Virtual Machine
VNIC | Virtual Network Interface Card
WMI | Windows Management Instrumentation
WWN | World Wide Name
WWNN | World Wide Node Name
WWPN | World Wide Port Name

B.4 KB（キロバイト）などの単位表記について

1KB（キロバイト），1MB（メガバイト），1GB（ギガバイト），1TB（テラバイト）はそれぞれ1,024バイト，1,024²バイト，1,024³バイト，1,024⁴バイトです。