Cisco UCS Invicta API ガ イ ド
バージ ョ ン 1.6
2014 年 8 月 22 日
Cisco Systems, Inc.
www.cisco.com
シ ス コ は世界各国 200 箇所にオ フ ィ ス を開
設 し ています。 住所、 電話番号、 FAX 番号は
以下のシ ス コ Web サイ ト を ご覧 く だ さ い。
www.cisco.com/go/offices
Text Part Number:
こ のマ ニ ュ アルに記載 さ れてい る 仕様お よ び製品に関す る 情報は、 予告な し に変更 さ れ る こ と が あ り ま す。 こ のマ ニ ュ アルに記載 さ れてい る 表現、 情報、 お
よ び推奨事項は、 すべて正確で あ る と 考え てい ま すが、 明示的で あれ黙示的で あれ、 一切の保証の責任を 負わない も の と し ま す。 こ のマ ニ ュ アルに記載 さ れ
てい る 製品の使用は、 すべてユーザ側の責任に な り ま す。
対象製品の ソ フ ト ウ ェ ア ラ イ セ ン ス お よ び限定保証は、 製品に添付 さ れた 『Information Packet』 に記載 さ れてい ま す。 添付 さ れていない場合には、 代理店に
ご連絡 く だ さ い。
FCC ク ラ ス A 準拠装置に関す る 記述 ： こ の装置はテ ス ト 済みで あ り 、 FCC ルール Part 15 に規定 さ れた仕様の ク ラ ス A デジ タ ル装置の制限に準拠 し てい る こ
と が確認済みです。 こ れ ら の制限は、 商業環境で装置を 使用 し た と き に、 干渉を 防止す る 適切な保護を 規定 し てい ま す。 こ の装置は、 無線周波エネルギー を
生成、 使用、 ま たは放射す る 可能性が あ り 、 こ の装置のマ ニ ュ アルに記載 さ れた指示に従っ て設置お よ び使用 し なか っ た場合、 ラ ジ オお よ びテ レ ビ の受信障
害が起 こ る こ と が あ り ま す。 住宅地で こ の装置を 使用す る と 、 干渉を 引 き 起 こ す可能性が あ り ま す。 その場合には、 ユーザ側の負担で干渉防止措置 を講 じ る
必要が あ り ま す。
FCC ク ラ ス B 準拠装置に関す る 記述 ： こ の装置はテ ス ト 済みで あ り 、 FCC ルール Part 15 に規定 さ れた仕様の ク ラ ス B デジ タ ル装置の制限に準拠 し てい る こ
と が確認済みです。 こ れ ら の制限は、 住宅地で使用 し た と き に、 干渉を 防止す る 適切な保護を 規定 し てい ま す。 本機器は、 無線周波数エネルギー を生成、 使
用、 ま たは放射す る 可能性が あ り 、 指示に従っ て設置お よ び使用 し なか っ た場合、 無線通信障害 を 引 き 起 こ す場合が あ り ま す。 ただ し 、 特定の設置条件にお
いて干渉が起 き ない こ と を 保証す る も のでは あ り ま せん。 装置が ラ ジオ ま たはテ レ ビ受信に干渉す る 場合には、 次の方法で干渉が起 き ない よ う に し て く だ さ
い。 干渉 し てい る か ど う かは、 装置の電源のオ ン/オ フ に よ っ て判断で き ま す。
•
•
•
•
受信ア ン テナの向 き を 変え る か、 場所を 移動 し ま す。
機器 と 受信機 と の距離を 離 し ま す。
受信機 と 別の回路に あ る コ ン セ ン ト に機器を 接続 し ま す。
販売業者 ま たは ラ ジオやテ レ ビ の専門技術者に連絡 し ま す。
シ ス コ では、 こ の製品の変更 ま たは改造を 認めてい ま せん。 変更 ま たは改造 し た場合には、 FCC 認定が無効にな り 、 さ ら に製品を 操作す る 権限を 失 う こ と に
な り ま す。
The Cisco implementation of TCP header compression is an adaptation of a program developed by the University of California, Berkeley (UCB) as part of UCB’ s public
domain version of the UNIX operating system.All rights reserved. Copyright © 1981, Regents of the University of California.
こ こ に記載 さ れてい る 他のいか な る 保証に も よ ら ず、 各社のすべてのマ ニ ュ アルお よ び ソ フ ト ウ ェ ア は、 障害 も 含めて 「現状の ま ま 」 と し て提供 さ れ ま す。
シ ス コ お よ び こ れ ら 各社は、 商品性の保証、 特定目的への準拠の保証、 お よ び権利を 侵害 し ない こ と に関す る 保証、 あ る いは取引過程、 使用、 取引慣行に
よ っ て発生す る 保証を は じ め と す る 、 明示 さ れた ま たは黙示 さ れた一切の保証の責任を 負わない も の と し ま す。
いか な る 場合において も 、 シ ス コ お よ びその供給者は、 こ のマ ニ ュ アルの使用 ま たは使用で き ない こ と に よ っ て発生す る 利益の損失やデー タ の損傷 を は じ め
と す る 、 間接的、 派生的、 偶発的、 あ る いは特殊な損害について、 あ ら ゆ る 可能性が シ ス コ ま たはその供給者に知 ら さ れていて も 、 それ ら に対す る 責任 を一
切負わない も の と し ま す。
CCDE, CCENT, CCSI, Cisco Eos, Cisco Explorer, Cisco HealthPresence, Cisco IronPort, the Cisco logo, Cisco Nurse Connect, Cisco Pulse, Cisco SensorBase,
Cisco StackPower, Cisco StadiumVision, Cisco TelePresence, Cisco TrustSec, Cisco Unified Computing System, Cisco WebEx, DCE, Flip Channels, Flip for Good, Flip
Mino, Flipshare (Design), Flip Ultra, Flip Video, Flip Video (Design), Instant Broadband, and Welcome to the Human Network are trademarks; Changing the Way We Work,
Live, Play, and Learn, Cisco Capital, Cisco Capital (Design), Cisco:Financed (Stylized), Cisco Store, Flip Gift Card, and One Million Acts of Green are service marks; and
Access Registrar, Aironet, AllTouch, AsyncOS, Bringing the Meeting To You, Catalyst, CCDA, CCDP, CCIE, CCIP, CCNA, CCNP, CCSP, CCVP, Cisco, the
Cisco Certified Internetwork Expert logo, Cisco IOS, Cisco Lumin, Cisco Nexus, Cisco Press, Cisco Systems, Cisco Systems Capital, the Cisco Systems logo, Cisco Unity,
Collaboration Without Limitation, Continuum, EtherFast, EtherSwitch, Event Center, Explorer, Follow Me Browsing, GainMaker, iLYNX, IOS, iPhone, IronPort, the
IronPort logo, Laser Link, LightStream, Linksys, MeetingPlace, MeetingPlace Chime Sound, MGX, Networkers, Networking Academy, PCNow, PIX, PowerKEY,
PowerPanels, PowerTV, PowerTV (Design), PowerVu, Prisma, ProConnect, ROSA, SenderBase, SMARTnet, Spectrum Expert, StackWise, WebEx, and the WebEx logo are
registered trademarks of Cisco and/or its affiliates in the United States and certain other countries.
Cisco and the Cisco Logo are trademarks of Cisco Systems, Inc. and/or its affiliates in the U.S. and other countries.A listing of Cisco's trademarks can be found at
www.cisco.com/go/trademarks. Third party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnership
relationship between Cisco and any other company. (1005R)
こ のマ ニ ュ アルで使用 し てい る IP ア ド レ ス お よ び電話番号は、 実際の ア ド レ ス お よ び電話番号 を示す も のでは あ り ま せん。 マ ニ ュ アル内の例、 コ マ ン ド 出
力、 ネ ッ ト ワ ー ク ト ポ ロ ジ図、 お よ びその他の図は、 説明のみ を目的 と し て使用 さ れてい ま す。 説明の中に実際の ア ド レ ス お よ び電話番号が使用 さ れていた
と し て も 、 それは意図的な も のではな く 、 偶然の一致に よ る も のです。
Cisco UCS Invicta ア プ ラ イ ア ン ス の イ ン ス ト ールお よ びサービ ス ガ イ ド
© 2014 Cisco Systems, Inc. All rights reserved.
目次
は じ めに
V
マニ ュ アルの構成
表記法
V
V
マニ ュ アルの入手方法およびテ ク ニ カル サポー ト
第
1
章
概要
1-1
API の構造 1-1
API のバージ ョ ン
JSON 1-1
cURL の例
1-1
1-2
API のア ク セス / 権限
1-2
サポー ト さ れる HTTP メ ソ ッ ド
サポー ト さ れる着信デー タ 形式
第
2
章
VI
API メ ソ ッ ド
2-3
2-5
AUTHENTICATE (POST)
USER (GET)
2-8
USER (PUT)
2-9
UNITINFO (GET)
2-12
UNITNAME (PUT)
2-13
2-14
RAIDHEALTH (GET)
SSN (GET)
2-7
2-10
UNITNAME (GET)
MODEL (GET)
1-2
2-3
API セ ク シ ョ ン規定
FIND (Get)
1-2
2-15
2-17
VOLUMEGROUP (GET)
2-19
VOLUMEGROUP (POST)
VOLUMEGROUP (DELETE)
2-21
2-22
ISCSIAVAILABLE (GET)
2-23
ISCSIAVAILABLE (PUT)
2-24
Cisco UCS Invicta API ガ イ ド 、 v1.6
v
目次
ISCSIALLOWED (GET)
2-25
ISCSIALLOWED (PUT)
2-26
LUN (GET)
2-27
LUN (POST)
2-29
LUN (PUT)
2-30
LUN (DELETE)
2-31
LUNMIRROR (POST)
2-32
LUNMIRROR (DELETE)
TOTALSPACE (GET)
2-33
2-34
INITIATORGROUP (GET)
2-35
INITIATORGROUP (POST)
2-36
INITIATORGROUP (DELETE)
INITIATOR (POST)
2-38
INITIATOR (DELETE)
MAPLUN (POST)
2-39
2-40
MAPLUN (DELETE)
2-41
MAPLUNAUTO (POST)
WWN (GET)
IQN (GET)
2-37
2-42
2-43
2-44
INTERFACES (GET)
2-45
PHYSICALINTERFACES (GET)
BOND (POST)
2-49
BOND (PUT)
2-51
BOND (DELETE)
2-52
TOGGLEBOND (PUT)
ENSLAVE (PUT)
VLAN (POST)
VLAN (PUT)
2-48
2-53
2-54
2-55
2-57
VLAN (DELETE)
2-59
VIRTUALINTERFACE (POST)
VIRTUALINTERFACE (PUT)
2-60
2-62
VIRTUALINTERFACE (DELETE)
PERFORMANCE – [TYPES] (GET)
2-64
2-65
PERFORMANCE – [RESOURCES] (GET)
PERFORMANCE – [DATA] (GET)
Cisco UCS Invicta API ガ イ ド 、 v1.6
vi
2-67
2-66
目次
FILE (GET)
Status Codes
2-71
2-72
Cisco UCS Invicta API ガ イ ド 、 v1.6
OL-31371-01-J
vii
目次
Cisco UCS Invicta API ガ イ ド 、 v1.6
viii
は じ めに
マニ ュ アルの構成
こ の文書は、 次の項で構成 さ れてい ま す。
セクシ ョ ン
タイ トル
説明
1
概要
ア プ リ ケーシ ョ ン プ ロ グ ラ ミ ン グ イ ン タ ー
フ ェ イ ス （API） と そのすべてのプ ロ パテ ィ
につい て説明 し ま す。
2
API メ ソ ッ ド
API と そのプ ロ パテ ィ について説明 し ま す。
表記法
こ のマ ニ ュ アルでは、 次の表記法を使用 し てい ま す。
表記法
説明
太字
コ マ ン ド 、 キー ワ ー ド 、 お よ びユーザが入力す る テ キ ス ト は太字で記載
さ れ ま す。
イ タ リ ッ ク体
文書の タ イ ト ル、 新規用語、 強調す る 用語、 お よ びユーザが値を指定す
る 引数は、 イ タ リ ッ ク 体 で示 し てい ま す。
[ ]
角カ ッ コ の中の要素は、 省略可能です。
{x | y | z }
必ずいずれか 1 つを選択 し な ければな ら ない必須キー ワ ー ド は、 波カ ッ
コ で囲み、 縦棒で区切っ て示 し てい ま す。
[x|y|z]
いずれか 1 つを選択で き る 省略可能な キー ワ ー ド は、 角カ ッ コ で囲み、
縦棒で区切っ て示 し てい ま す。
string
引用符を付け ない一組の文字。 string の前後には引用符を使用 し ま せん。
引用符を使用す る と 、 その引用符 も 含めて string と みな さ れ ま す。
courier
フォン ト
シ ス テ ム が表示す る 端末セ ッ シ ョ ンお よ び情報は、 courier フ ォ ン ト で示
し てい ま す。
< >
パス ワー ド の よ う に出力 さ れない文字は、 山カ ッ コ で囲んで示 し てい ます。
[ ]
シ ス テ ム プ ロ ン プ ト に対す る デ フ ォ ル ト の応答は、 角カ ッ コ で囲んで示
し てい ま す。
!、 #
コ ー ド の先頭に感嘆符 （!） ま たはポ ン ド 記号 （#） が あ る 場合には、 コ
メ ン ト 行で あ る こ と を示 し ま す。
Cisco UCS Invicta API ガ イ ド 、 v1.6
V
「は じ めに」
マニ ュ アルの入手方法およびテ ク ニ カル サポー ト
（注）
「注釈」 です。 役立つ情報や こ のマ ニ ュ アルに記載 さ れていない参照資料を紹介 し てい ま す。
ヒント
「問題解決に役立つ情報」 です。 ヒ ン ト には、 ト ラ ブルシ ュ ーテ ィ ン グや操作方法ではな く 、
ワ ン ポ イ ン ト ア ド バ イ ス と 同様に知っ てお く と 役立つ情報が記述 さ れ る 場合 も あ り ま す。
注意
ワ ンポ イ ン ト ア ド バイ ス
警告 （Warning）
「要注意」 の意味です。 機器の損傷 ま たはデー タ 損失を予防す る ための注意事項が記述 さ れて
い ま す。
「時間の節約に役立つ操作」 です。 記述 さ れてい る 操作を実行す る と 時間を節約で き ま す。
安全上の重要事項
「危険」 の意味です。 人身事故を予防する ための注意事項が記述 さ れています。 機器の取 り 扱
い作業を行 う と きは、 電気回路の危険性に注意 し 、 一般的な事故防止対策に留意 し て く だ さ
い。 警告の各国語版は、 各注意事項の番号を基に、 装置に付属の 「Translated Safety Warnings」
を参照 し て く だ さ い。 ス テー ト メ ン ト 1071。
こ れ ら の注意事項を保存 し ておいて く だ さ い
警告 （Warning）
こ のシ ン ボルを使 っ た ス テー ト メ ン ト は、 追加情報お よ び規制要件ま たは顧客要件に準拠する
ための も のです。
マニ ュ アルの入手方法およびテ ク ニ カル サポー ト
マ ニ ュ アルの入手方法、 テ ク ニ カル サポー ト 、 その他の有用な情報について、 次の URL で、
毎月更新 さ れ る 『What's New in Cisco Product Documentation （Cisco 製品資料の更新情報）』 を参
照 し て く だ さ い。 シ ス コ の新規お よ び改訂版の技術マ ニ ュ アルの一覧 も 示 さ れてい ま す。
http://www.cisco.com/c/en/us/td/docs/general/whatsnew/whatsnew.html
『What's New in Cisco Product Documentation （Cisco 製品資料の更新情報）』 は、 シ ス コ の新規お
よ び改訂版の技術マ ニ ュ アルの一覧 も 示 し 、 RSS フ ィ ー ド と し て購読で き ま す。 ま た、 リ ー
ダー ア プ リ ケーシ ョ ン を使用 し て コ ン テ ン ツ をデ ス ク ト ッ プに配信す る こ と も で き ま す。 RSS
フ ィ ー ド は無料のサービ ス です。
Cisco UCS Invicta API ガ イ ド 、 v1.6
VI
第
1
章
概要
API の構造
こ のマ ニ ュ アルでは、 Cisco UCS Invicta シ リ ーズ ソ リ ッ ド ス テー ト シ ス テ ム を維持 し 、 操作す
る 際に使用で き る 、 ア プ リ ケーシ ョ ン プ ロ グ ラ ミ ン グ イ ン タ ー フ ェ イ ス （API） と そのすべて
のプ ロ パテ ィ について説明 し ま す。
Cisco UCS Invicta シ リ ーズ ソ リ ッ ド ス テー ト シ ス テ ム の API は、 RESTful Web サー ビ ス と し
て設計 さ れ、 実装 さ れ ま し た。 すべての API メ ソ ッ ド は、 次の部分で構成 さ れ る URL を使用
し て、 HTTPS 要求に よ り ア ク セ ス 可能です。
•
ド メ イ ン ： Cisco UCS Invicta シ リ ーズ ソ リ ッ ド ス テー ト シ ス テ ム の IP
•
URI ： /restapi/<API_version>/<token>/<methodName>/<URI_reminder>
URI リ マ イ ン ダは必須で ない場合 も あ り ま すが、 PUT ま たは DELETE で要求 さ れ る メ ソ ッ ド に
は必須です。
API のバージ ョ ン
URI での <API_version> （例 ： 16） は、 一貫 し た API サポー ト と 互換性を維持す る ために重要
です。 今後の API メ ソ ッ ド の機能拡張お よ び更新が実装 さ れ る と 、 以前のバージ ョ ン のサポー
ト が利用可能にな り ま す。 すべての拡張機能や変更は、 新 し い API のバージ ョ ン番号で使用で
き ま すが、 各 API メ ソ ッ ド は、 リ リ ー ス さ れたバージ ョ ン で、 その署名お よ び応答デー タ 構造
を維持 し ま す。
<token> URI 要素は、 API の不正使用か ら 基本 レ ベルで保護す る ためのセ キ ュ リ テ ィ 手段 と し
て追加 さ れてい ま す。 詳細については、 認証 メ ソ ッ ド の章を参照 し て く だ さ い。
JSON
入力で必要なデー タ エ ンベ ロ ープ （POST お よ び PUT 要求の未加工デー タ ） は、 JSON オブ
ジ ェ ク ト 表記 ラ ベル付 き デー タ です。
応答オブジ ェ ク ト の構造は、 envelope_version、 status、 message、 および data で構成 さ れ
ています。 返すデータ がない場合、 データ部分は空にな る可能性があ る こ と に注意し て く だ さ い。
検索す る API メ ソ ッ ド の呼び出 し に続 く JSON の未加工文字列の出力例は次の と お り です。
{"status":1,"message":"OK","data":{"unitName":"devMachine","apiVersions":["15","16"]},"envelope_version":"15"}
Cisco UCS Invicta API ガ イ ド 、 v1.6
1-1
第1章
概要
API のア ク セス/権限
cURL の例
cURL を使用す る 場合は、 次の例に従っ て く だ さ い。 <ip_address> お よ び <token> のエ ン
テ ィ テ ィ は、 実際の IP ア ド レ ス お よ び ト ー ク ン で置 き 換え る こ と に注意 し て く だ さ い。
•
GET
curl -k -X GET --url https://<ip_address>/restapi/16/<token>/raidshealth
-H "Accept: application/json"
•
POST
curl -X POST -d data='{"name":"lun1","vg":"ssd1","size":2,"striping":true}' -k --url https://<ip_address>/restapi/16/<token>/lun -H
"Accept: application/json"
•
PUT
curl -X PUT -d data='{"size":3}' -k --url
https://<ip_address>/restapi/16/<token>/lun/lun1 -H "Accept: application/json"
•
DELETE
curl -X DELETE -d data='{"name":"bond0:1"}' -k --url
https://<ip_address>/restapi/16/<token>/virtualinterface/0 -H "Accept:
application/json"
API のア ク セス/権限
ユーザ ア カ ウ ン ト は、 API ア ク セ ス 権限が付与 さ れてい る 役割に割 り 当て る 必要が あ り ま す。
それぞれの API メ ソ ッ ド の権限は、 UI でユーザに割 り 当て た ロ ール と その関連の権限に依存
し 、 直接関連 し ま す。 た と えば、 UI で、 ユーザが LUN 設定ページに ア ク セ ス す る 権限の あ る
役割に割 り 当て ら れない場合、 そのユーザは、 LUN 設定の API メ ソ ッ ド に関連す る ど の LUN
設定に も ア ク セ ス で き ま せん。 同様に、 UI で、 ユーザに LUN の追加 と 編集の権限が あ る 役割
が割 り 当て ら れて も 、 LUN の削除権限がない場合、 同 じ 制限が API に適用 さ れ ま す。
サポー ト さ れる HTTP メ ソ ッ ド
バージ ョ ン
1.5
GET /list
POST
PUT
DELETE
X
X
X
X
1.6
X
X
X
X
サポー ト さ れる着信デー タ 形式
バージ ョ ン
1.5
X
1.6
X
Cisco UCS Invicta API ガ イ ド 、 v1.6
1-2
JSON
XML
第
2
章
API メ ソ ッ ド
こ の項では、 使用可能なすべての API メ ソ ッ ド について説明 し ま す。 デー タ 要件、 予期 さ れ る
応答、 依存関係、 お よ びその他の関連情報は、 各呼び出 し においてすべて明確に定義 さ れてい
ま す。 し たが っ て、 受信可能な エ ンベ ロ ープ内で送信 さ れ る 情報が、 要求を実行す る ために処
理 さ れ ま す。 API メ ソ ッ ド の範囲外 と な る 送信デー タ は ど れ も 無視 さ れ ま す。
API セ ク シ ョ ン規定
API メ ソ ッ ド は、 次のセ ク シ ョ ン を使用 し て文書化 さ れ ま す。
表 2-1
API セ ク シ ョ ン規定
API セ ク シ ョ ン名
説明
メ ソ ッ ド名
メ ソ ッ ド 名は、 API 呼び出 し に使用 さ れ る 正確な構文です。
デバ イ ス
API メ ソ ッ ド が適用 さ れ る デバ イ ス です。
方式
メ ソ ッ ド は、デバ イ ス に要求の一部 と し て送信 さ れ る HTTP METHOD
です。 メ ソ ッ ド は、 POST、 PUT、 GET、 ま たは DELETE です。
•
サーバで リ ソ ー ス を作成す る には、 POST を使用 し ま す。
•
リ ソ ー ス を取得す る には、 GET を使用 し ま す。
•
リ ソ ー ス の状態を変更 ま たは更新す る には、 PUT を使用 し ま す。
•
リ ソ ー ス を削除す る には、 DELETE を使用 し ま す。
構文
構文は、 メ ソ ッ ド の目的の概要を簡単に示 し ま す。
URL の例
URL の例は、 API メ ソ ッ ド が呼び出 さ れ る モデルです。 URL の構造
に関す る 詳細につい ては、 導入部を参照 し て く だ さ い。
PUT お よ び DELETE メ ソ ッ ド では、 URI に追加パ ラ メ ー タ が必要です。
こ れは、 変更が必要なオブ ジ ェ ク ト の固有識別子 （ID） と し て機能 し
ま す。 ただ し 、 ID には メ ソ ッ ド を停止す る よ う な無効な文字が含 ま
れてい る 場合が あ る ため、 すべての PUT ま たは DELETE メ ソ ッ ド が
URI で ID を渡す と は限 り ません。 代わ り に、 偽の ID （通常はゼ ロ ） が
URI で渡 さ れ、 実際の ID がデー タ と し て送信 さ れ ま す。
例では人為的な IP ア ド レ ス を採用 し てい る こ と に注意 し て く だ さ い。
例は、 マ シ ン の実際の IP と 置 き 換え ま す。
Cisco UCS Invicta API ガ イ ド 、 v1.6
2-3
第2章
API メ ソ ッ ド
API セ ク シ ョ ン規定
API セ ク シ ョ ン名
説明
要求/応答デー タ
各 メ ソ ッ ド の説明での要求 と 応答のデー タ セ ク シ ョ ン は、 返 さ れ る
エ ンベ ロ ープのデー タ 部分のみが対象にな り ま す。 すべてのプ リ ミ
テ ィ ブのデー タ 型は、 次のページに示 さ れてい る よ う に、 メ ソ ッ ド の
詳細に応 じ て一致す る 必要が あ り ま す。
応答デー タ が配列 タ イ プの場合、 （1 次元で ない限 り ） さ ら に説明 さ
れ ま す。
JSON のサ ン プル
デー タ 出力の JSON のサ ン プルは、 必要に応 じ て マ ニ ュ アルに追加 さ
れ ま す。
依存関係
各 メ ソ ッ ド に リ ス ト さ れてい る 依存関係は、 メ ソ ッ ド を正 し く 動作 さ
せ る ために必要なデバ イ ス ま たはオブ ジ ェ ク ト です。
注意
メ モは、 メ ソ ッ ド の さ ま ざ ま な部分を明確に説明す る ための追加 コ メ
ン ト です。
Cisco UCS Invicta API ガ イ ド 、 v1.6
2-4
第2章
API メ ソ ッ ド
FIND (Get)
FIND (Get)
メ ソ ッ ド名
find
デバイ ス
Cisco UCS Invicta ス ケー リ ン グ シ ス テ ム、 Cisco UCS Invicta ア プ ラ イ ア ン ス
HTTP メ ソ ッ ド
GET
構文
こ の メ ソ ッ ド は、 自動検出機能を提供 し ま す。 ど の Cisco UCS Invicta シ リ ーズ ソ リ ッ ド ス テー
ト シ ス テ ム も こ の呼び出 し に応答 し て、 検出で き ま す。
（注）
注 ： こ れは、 URI でバージ ョ ン ま たは ト ー ク ンが存在す る 必要のない唯一の API メ ソ ッ ド です。
URL の例
https://10.1.39.127/restapi/find
要求デー タ
NAME
TYPE
注意
n/a
応答デー タ
NAME
unitId
TYPE
注意
文字列
デバ イ ス のシ リ アル番号
apiVersion*
配列
文字列の配列
文字列
デバ イ ス が Cisco UCS Invicta
ス ケー リ ン グ シ ス テ ム ま た
は Cisco UCS Invicta ア プ ラ
イ ア ン ス で あ る か ど う かの
情報
文字列
ボ ッ ク ス のシ リ アル番号
文字列
現在 イ ン ス ト ール さ れてい
る RaceRunner ソ フ ト ウ ェ ア
のバージ ョ ン
デバ イ ス
boxSerial
rrVersion
Cisco UCS Invicta API ガ イ ド 、 v1.6
2-5
第2章
API メ ソ ッ ド
FIND (Get)
JSON のサン プル
{"status":1,"message":"OK","data":{"apiVersion":[15, 16],"unitId":"WT-INV-QA-0000003","device":"INVICTA", "rrVersion":"Version 5.0.0 Release
004","boxSerial":"WT-INV-QA-SSRA-0000003"},"envelope_version":15}
依存関係
n/a
注意
•
こ の API メ ソ ッ ド の呼び出 し を使用す る 際に、 ト ー ク ン は不要です。
•
こ の API メ ソ ッ ド の呼び出 し を実行す る 際に、 着信デー タ は不要です。
•
*apiVersions は、 文字列の配列 と し て返 さ れ ま す。
•
同 じ Cisco UCS Invicta ス ケー リ ン グ シ ス テ ム で異な る SSR を識別す る 場合、 Cisco UCS
Invicta ス ケー リ ン グ シ ス テ ム で unitId お よ び boxSerial を使用で き ま す。
Cisco UCS Invicta API ガ イ ド 、 v1.6
2-6
第2章
API メ ソ ッ ド
AUTHENTICATE (POST)
AUTHENTICATE (POST)
メ ソ ッ ド名
authenticate
デバイ ス
Cisco UCS Invicta ス ケー リ ン グ シ ス テ ム、 Cisco UCS Invicta ア プ ラ イ ア ン ス
HTTP メ ソ ッ ド
POST
構文
こ の メ ソ ッ ド は、 利用可能な多 く の API メ ソ ッ ド を実行す る 際に使用で き る 32 ビ ッ ト の ト ー
ク ン を返 し ま す。 ト ー ク ン は最大で 1 時間有効です。
URL の例
https://10.1.39.127/restapi/16/authenticate
要求デー タ
JSON のサン プル
NAME
TYPE
注意
username
文字列
必須
password
文字列
必須
'{"username":"jdoe", "password":"password"}'
応答デー タ
NAME
TYPE
注意
token
文字列
特定の API 呼び出 し を 実行
す る 際に、 合わせて使用 さ
れ ま す。
JSON のサン プル
"data":{"token":"1234567890xxxxxxxxxxxxxxxxxxxxx"}
依存関係
n/a
注意
•
こ の API メ ソ ッ ド の呼び出 し を使用す る 際に、 ト ー ク ン は不要です。
•
こ の API メ ソ ッ ド の呼び出 し を実行す る 際に、 着信デー タ が必要です。
•
ト ー ク ン は、 時間切れにな る ま で何回で も 利用で き ま す。
Cisco UCS Invicta API ガ イ ド 、 v1.6
2-7
第2章
API メ ソ ッ ド
USER (GET)
USER (GET)
メ ソ ッ ド名
user
デバイ ス
Cisco UCS Invicta ス ケー リ ン グ シ ス テ ム、 Cisco UCS Invicta ア プ ラ イ ア ン ス
HTTP メ ソ ッ ド
GET
構文
現在 ロ グ イ ン し てい る ユーザのユーザ情報を返 し ま す。
URL の例
https://10.1.39.127/restapi/16/<token>/user
要求デー タ
NAME
TYPE
注意
n/a
応答デー タ
NAME
TYPE
注意
first_name
文字列
シ ス テ ム に記録 さ れてい る
ユーザの名
last_name
文字列
シ ス テ ム に記録 さ れてい る
ユーザの姓
email_address
文字列
シ ス テ ム に記録 さ れてい る
ユーザの電子 メ ール ア ド レ ス
username
文字列
ユーザの ロ グ イ ン名
JSON のサン プル
"data":{"first_name":"Joe","last_name":”Doe”,"email_address":"[email protected]",
“username”, “joedoe”}
依存関係
n/a
注意
•
こ の API メ ソ ッ ド の呼び出 し を使用す る 際に、 ト ー ク ン を URI で提示す る 必要があ り ます。
•
こ の API メ ソ ッ ド の呼び出 し を実行す る 際に、 着信デー タ は不要です。
Cisco UCS Invicta API ガ イ ド 、 v1.6
2-8
第2章
API メ ソ ッ ド
USER (PUT)
USER (PUT)
メ ソ ッ ド名
user
デバイ ス
Cisco UCS Invicta ス ケー リ ン グ シ ス テ ム、 Cisco UCS Invicta ア プ ラ イ ア ン ス
HTTP メ ソ ッ ド
PUT
構文
現在のユーザのユーザ情報を変更 し ま す。
URL の例
https://10.1.39.127/restapi/16/<token>/user
要求デー タ
JSON のサン プル
NAME
TYPE
注意
first_name
文字列
シ ス テ ム に記録 さ れ る ユーザ
の名
last_name
文字列
シ ス テ ム に記録 さ れ る ユーザ
の姓
email_address
文字列
シ ス テ ム に記録 さ れ る ユーザ
の電子 メ ール ア ド レ ス
password
文字列
ユーザのパ ス ワ ー ド
{"password":”xxxxx”}
応答デー タ
NAME
TYPE
注意
n/a
依存関係
注意
n/a
•
こ の API メ ソ ッ ド の呼び出 し を使用す る 際に、 ト ー ク ン を URI で提示す る 必要があ り ます。
•
こ の API メ ソ ッ ド の呼び出 し を実行す る 際に、 着信デー タ が必要です。
Cisco UCS Invicta API ガ イ ド 、 v1.6
2-9
第2章
API メ ソ ッ ド
UNITINFO (GET)
UNITINFO (GET)
メ ソ ッ ド名
unitinfo
デバイ ス
Cisco UCS Invicta ス ケー リ ン グ シ ス テ ム、 Cisco UCS Invicta ア プ ラ イ ア ン ス
HTTP メ ソ ッ ド
GET
構文
こ の メ ソ ッ ド は、 ス ト レ ージ デバ イ ス のモデル名、 ユニ ッ ト ID と 名前、 ユ ニ ッ ト の総容量 と
空 き 容量、 稼働時間、 IP ア ド レ ス を返 し ま す。
URL の例
https://10.1.39.127/restapi/16/<token>/unitinfo
要求デー タ
NAME
TYPE
注意
n/a
応答デー タ
NAME
modelName
TYPE
注意
文字列
デバ イ ス モデルの名前
unitId
文字列
デバ イ ス のシ リ アル番号
unitName
文字列
ホス ト 名
totalCapacity
整数
総容量 （バ イ ト ）
availableCapacity
整数
空 き 容量 （バ イ ト ）
systemUptime
文字列
シ ス テ ム の稼働時間情報
IPs
配列
IP オブ ジ ェ ク ト の配列
IP オブ ジ ェ ク ト
NAME
TYPE
注意
ipDevice
文字列
ネ ッ ト ワー ク イ ン ターフ ェ
イ ス の名前。
ip
文字列
こ のネ ッ ト ワ ー ク イ ン タ ー
フ ェ イ ス に割 り 当て ら れた IP
JSON のサン プル
"data":{"modelName":"INVICTA","unitId":" WT-INV-PROD-0000001","unitName":"SSRA","totalCapacity":1187472557998,"availableCapacity":1143492092887,"systemUptime":"4 days
03:24:15.46","IPs":[{“ipDevice”:”bond1”, “ip”:”192.168.110.116”}]}
依存関係
n/a
Cisco UCS Invicta API ガ イ ド 、 v1.6
2-10
第2章
API メ ソ ッ ド
UNITINFO (GET)
注意
•
こ の API メ ソ ッ ド の呼び出 し を使用す る 際に、 ト ー ク ン を URI で提示す る 必要があ り ます。
•
こ の API メ ソ ッ ド の呼び出 し を実行す る 際に、 着信デー タ は不要です。
Cisco UCS Invicta API ガ イ ド 、 v1.6
2-11
第2章
API メ ソ ッ ド
UNITNAME (GET)
UNITNAME (GET)
メ ソ ッ ド名
unitname
デバイ ス
Cisco UCS Invicta ス ケー リ ン グ シ ス テ ム、 Cisco UCS Invicta ア プ ラ イ ア ン ス
HTTP メ ソ ッ ド
GET
構文
こ の メ ソ ッ ド は、 ス ト レ ージ デバ イ ス のユニ ッ ト 名を返 し ま す。
URL の例
https://10.1.39.127/restapi/16/<token>/unitname
要求デー タ
NAME
TYPE
注意
TYPE
注意
文字列
ホス ト 名
n/a
応答デー タ
NAME
unitName
JSON のサン プル
"data":{"unitName":"SSRA"}
依存関係
n/a
注意
•
こ の API メ ソ ッ ド の呼び出 し を使用す る 際に、 ト ー ク ン を URI で提示す る 必要があ り ます。
•
こ の API メ ソ ッ ド の呼び出 し を実行す る 際に、 着信デー タ は不要です。
Cisco UCS Invicta API ガ イ ド 、 v1.6
2-12
第2章
API メ ソ ッ ド
UNITNAME (PUT)
UNITNAME (PUT)
メ ソ ッ ド名
unitname
デバイ ス
Cisco UCS Invicta ス ケー リ ン グ シ ス テ ム、 Cisco UCS Invicta ア プ ラ イ ア ン ス
HTTP メ ソ ッ ド
PUT
構文
こ の メ ソ ッ ド は、 ス ト レ ージ デバ イ ス のユニ ッ ト 名を変更 し ま す。
URL の例
https://10.1.39.127/restapi/16/<token>/unitname/0
要求デー タ
NAME
unitName
JSON のサン プル
{"unitName":”HeadOne”}
応答デー タ
NAME
TYPE
注意
文字列
新 し い ホ ス ト 名 （必須）
TYPE
注意
n/a
n/a
依存関係
注意
（注）
•
こ の API メ ソ ッ ド の呼び出 し を使用す る 際に、 ト ー ク ン を URI で提示す る 必要があ り ます。
•
こ の API メ ソ ッ ド の呼び出 し を実行す る 際に、 着信デー タ が必要です。
•
文字列 unitName には、 15 文字以内の英数字お よ びダ ッ シ ュ と ピ リ オ ド が使用で き ま す。
重要 ： API アプ リ ケーシ ョ ンの PUT 規格に従い、 ゼ ロ （0） が URI の一部 と し て含まれています。
パ ラ メ ー タ が不十分な場合、 要求は失敗 し ま す。
Cisco UCS Invicta API ガ イ ド 、 v1.6
2-13
第2章
API メ ソ ッ ド
MODEL (GET)
MODEL (GET)
メ ソ ッ ド名
model
デバイ ス
Cisco UCS Invicta ス ケー リ ン グ シ ス テ ム、 Cisco UCS Invicta ア プ ラ イ ア ン ス
HTTP メ ソ ッ ド
PUT
タ ス ク ID構文
こ の メ ソ ッ ド は、 デバ イ ス のモデル を返 し ま す。
URL の例
https://10.1.39.127/restapi/16/<token>/model
要求デー タ
NAME
TYPE
注意
n/a
応答デー タ
NAME
modelName
JSON のサン プル
"data":{"modelName":"INVICTA"}
依存関係
n/a
注意
注意
文字列
デバ イ ス モデルの名前
•
こ の API メ ソ ッ ド の呼び出 し を使用す る 際に、 ト ー ク ン を URI で提示す る 必要があ り ます。
•
こ の API メ ソ ッ ド の呼び出 し を実行す る 際に、 着信デー タ は不要です。
Cisco UCS Invicta API ガ イ ド 、 v1.6
2-14
TYPE
第2章
API メ ソ ッ ド
RAIDHEALTH (GET)
RAIDHEALTH (GET)
メ ソ ッ ド名
raidhealth
デバイ ス
Cisco UCS Invicta ス ケー リ ン グ シ ス テ ム、 Cisco UCS Invicta ア プ ラ イ ア ン ス
HTTP メ ソ ッ ド
GET
構文
こ の メ ソ ッ ド は、 すべての RAID ユ ニ ッ ト のヘル ス 情報を返 し ま す。
URL の例
https://10.1.39.127/restapi/16/<token>/raidhealth
要求デー タ
NAME
TYPE
注意
n/a
応答デー タ
NAME
raids
TYPE
注意
配列
下記の説明を参照
nodes
配列
Raids には、 実際の RAID ユ ニ ッ ト の名前 と 同一の配列キーが あ り ま す。 こ れ ら の キー内に、
RAID に関す る 情報 と し ての次のデー タ が あ り ま す。
NAME
name
status
TYPE
注意
文字列
文字
G = 良好
B = 不良
D = 低下
R = 回復中
ssn
文字列
RAID が属す る SSN
JSON のサン プル
“data":{"nodes":{"SSN1":{"raids":[{"name":"rs0","status":"G"}]},"SSN2":{"raids":[{"name":"
rs0","status":"G"},{"name":"rs1","status":"G"},{"name":"rs2","status":"G"}]}
依存関係
n/a
Cisco UCS Invicta API ガ イ ド 、 v1.6
2-15
第2章
API メ ソ ッ ド
RAIDHEALTH (GET)
注意
•
こ の API メ ソ ッ ド の呼び出 し を使用す る 際に、 ト ー ク ン を URI で提示す る 必要があ り ます。
•
こ の API メ ソ ッ ド の呼び出 し を実行す る 際に、 着信デー タ は不要です。
Cisco UCS Invicta API ガ イ ド 、 v1.6
2-16
第2章
API メ ソ ッ ド
SSN (GET)
SSN (GET)
メ ソ ッ ド名
ssn
デバイ ス
Cisco UCS Invicta ス ケー リ ン グ シ ス テ ム
HTTP メ ソ ッ ド
GET
構文
名前 と 割 り 当て ス テー タ ス を含めて SSN の リ ス ト を、 割 り 当て ら れた ボ リ ュ ーム グループの
名前 と 共に返 し ま す。 割 り 当て ス テー タ ス がない場合、 null が返 さ れ ま す。
URL の例
https://10.1.39.127/restapi/16/<token>/ssn
要求デー タ
NAME
TYPE
注意
n/a
応答デー タ
NAME
TYPE
注意
配列
SSN オブジ ェ ク ト の配列
各 SSN は SSN オブ ジ ェ ク ト で表 さ れ ま す。
SSN オブジ ェ ク ト
NAME
name
TYPE
注意
文字列
SSN の名前
allocation_status
ブール
SSN が割 り 当て ら れてい る か
どうか
allocated_vg
文字列||Null
SSN が割 り 当て ら れた VG の
名前
JSON のサン プル
"data":[{"name":"SSN1","allocation_status":true,"allocated_vg":"vg1"}]
依存関係
n/a
Cisco UCS Invicta API ガ イ ド 、 v1.6
2-17
第2章
API メ ソ ッ ド
SSN (GET)
注意
•
こ の API メ ソ ッ ド の呼び出 し を使用す る 際に、 ト ー ク ン を URI で提示す る 必要があ り ます。
•
こ の API メ ソ ッ ド の呼び出 し を実行す る 際に、 着信デー タ は不要です。
Cisco UCS Invicta API ガ イ ド 、 v1.6
2-18
第2章
API メ ソ ッ ド
VOLUMEGROUP (GET)
VOLUMEGROUP (GET)
メ ソ ッ ド名
volumegroup
デバイ ス
Cisco UCS Invicta ス ケー リ ン グ シ ス テ ム
HTTP メ ソ ッ ド
GET
構文
一連のすべてのボ リ ュ ーム グループ を、 名前、 サ イ ズ、 空 き ス ペー ス 、 SSN と ス テー タ ス の リ
ス ト と 共に返 し ま す。
URL の例
https://10.1.39.127/restapi/16/<token>/volumegroup
要求デー タ
NAME
TYPE
注意
TYPE
注意
配列
ボ リ ュ ーム グループ オブ
ジ ェ ク ト の配列
n/a
応答デー タ
NAME
ボ リ ュ ーム グループ オブジ ェ ク ト
NAME
name
size
TYPE
注意
文字列
Float
ボ リ ュ ーム グループの名前
size_available
Float
ボ リ ュ ーム グループの合計空
き ス ペー ス （GB）
ssns
配列
すべてのバ ウ ン ド SSN の配列
status
文字列
ボ リ ュ ーム グループの ス テー
タス
ボ リ ュ ーム グループの合計サ
イ ズ （GB）
JSON のサン プル
"data":[{"name":"vg1","size":100000,"size_available":80000,"ssns":["ssn1","ssn2"],"status"
:"good"}]
依存関係
n/a
Cisco UCS Invicta API ガ イ ド 、 v1.6
2-19
第2章
API メ ソ ッ ド
VOLUMEGROUP (GET)
注意
•
こ の API メ ソ ッ ド の呼び出 し を使用す る 際に、 ト ー ク ン を URI で提示す る 必要があ り ます。
•
こ の API メ ソ ッ ド の呼び出 し を実行す る 際に、 着信デー タ は不要です。
Cisco UCS Invicta API ガ イ ド 、 v1.6
2-20
第2章
API メ ソ ッ ド
VOLUMEGROUP (POST)
VOLUMEGROUP (POST)
メ ソ ッ ド名
volumegroup
デバイ ス
Cisco UCS Invicta ス ケー リ ン グ シ ス テ ム
HTTP メ ソ ッ ド
POST
構文
ボ リ ュ ーム グループ を作成 し ま す。
URL の例
https://10.1.39.127/restapi/16/<token>/volumegroup
要求デー タ
NAME
TYPE
注意
vgName
文字列
新 し いボ リ ュ ーム グループ
の名前
ssn
配列
新し いボ リ ューム グループが
割 り 当て ら れる SSN の配列
JSON のサン プル
'{"vgname":"vg3", "ssn": ["ssn3", "ssn4"]}'
応答デー タ
NAME
TYPE
注意
n/a
依存関係
注意
n/a
•
こ の API メ ソ ッ ド の呼び出 し を使用す る 際に、 ト ー ク ン を URI で提示す る 必要があ り ます。
•
こ の API メ ソ ッ ド の呼び出 し を実行す る 際に、 着信デー タ が必要です。
Cisco UCS Invicta API ガ イ ド 、 v1.6
2-21
第2章
API メ ソ ッ ド
VOLUMEGROUP (DELETE)
VOLUMEGROUP (DELETE)
メ ソ ッ ド名
volumegroup
デバイ ス
Cisco UCS Invicta ス ケー リ ン グ シ ス テ ム
HTTP メ ソ ッ ド
DELETE
構文
ボ リ ュ ーム グループ を削除 し ま す。
URL の例
https://10.1.39.127/restapi/16/<token>/volumegroup/<existing target volume group>
要求デー タ
NAME
TYPE
注意
TYPE
注意
n/a
応答デー タ
NAME
n/a
依存関係
注意
n/a
•
こ の API メ ソ ッ ド の呼び出 し を使用す る 際に、 ト ー ク ン を URI で提示す る 必要があ り ます。
•
こ の API メ ソ ッ ド の呼び出 し を実行す る 際に、 着信デー タ は不要です。
Cisco UCS Invicta API ガ イ ド 、 v1.6
2-22
第2章
API メ ソ ッ ド
ISCSIAVAILABLE (GET)
ISCSIAVAILABLE (GET)
メ ソ ッ ド名
iscsiavailable
デバイ ス
Cisco UCS Invicta ス ケー リ ン グ シ ス テ ム、 Cisco UCS Invicta ア プ ラ イ ア ン ス
HTTP メ ソ ッ ド
GET
構文
ま だ割 り 当て ら れていないすべての使用可能な IP ア ド レ ス の リ ス ト を返 し ま す。
URL の例
https://10.1.39.127/restapi/16/<token>/iscsiavailable
要求デー タ
NAME
TYPE
注意
n/a
応答デー タ
NAME
ip
TYPE
注意
配列
IP 情報オブ ジ ェ ク ト の配列
JSON のサン プル
"data": {"ip":["10.127.15.135","192.168.3.17"]}
依存関係
n/a
注意
•
こ の API メ ソ ッ ド の呼び出 し を使用す る 際に、 ト ー ク ン を URI で提示す る 必要があ り ます。
•
こ の API メ ソ ッ ド の呼び出 し を実行す る 際に、 着信デー タ は不要です。
Cisco UCS Invicta API ガ イ ド 、 v1.6
2-23
第2章
API メ ソ ッ ド
ISCSIAVAILABLE (PUT)
ISCSIAVAILABLE (PUT)
メ ソ ッ ド名
iscsiavailable
デバイ ス
Cisco UCS Invicta ス ケー リ ン グ シ ス テ ム、 Cisco UCS Invicta ア プ ラ イ ア ン ス
HTTP メ ソ ッ ド
PUT
構文
有効な IP ア ド レ ス を 「利用可能」 に追加 し 、 こ れ ら を 「許可」 か ら 削除 し ま す。
URL の例
https://10.1.39.127/restapi/16/<token>/iscsiavailable/0
要求デー タ
NAME
ip
JSON のサン プル
{"ip": "10.127.15.135"}
応答デー タ
NAME
TYPE
注意
文字列
IP ア ド レ ス
TYPE
注意
n/a
n/a
依存関係
注意
•
（注）
こ の API メ ソ ッ ド の呼び出 し を使用す る 際に、 ト ー ク ン を URI で提示す る 必要があ り ます。
重要 ： API アプ リ ケーシ ョ ンの PUT 規格に従い、 ゼ ロ （0） が URI の一部 と し て含まれています。
パ ラ メ ー タ が不十分な場合、 要求は失敗 し ま す。
Cisco UCS Invicta API ガ イ ド 、 v1.6
2-24
第2章
API メ ソ ッ ド
ISCSIALLOWED (GET)
ISCSIALLOWED (GET)
メ ソ ッ ド名
iscsiallowed
デバイ ス
Cisco UCS Invicta ス ケー リ ン グ シ ス テ ム、 Cisco UCS Invicta ア プ ラ イ ア ン ス
HTTP メ ソ ッ ド
GET
構文
許可 さ れたすべての IP ア ド レ ス の リ ス ト を返 し ま す。
URL の例
https://10.1.39.127/restapi/16/<token>/iscsiallowed
要求デー タ
NAME
TYPE
注意
n/a
応答デー タ
NAME
ip
TYPE
注意
配列
IP ア ド レ ス の配列
JSON のサン プル
"data": {"ip" : ["10.127.15.207", "192.168.3.18"]}
依存関係
n/a
注意
•
こ の API メ ソ ッ ド の呼び出 し を使用す る 際に、 ト ー ク ン を URI で提示す る 必要があ り ます。
•
こ の API メ ソ ッ ド の呼び出 し を実行す る 際に、 着信デー タ は不要です。
Cisco UCS Invicta API ガ イ ド 、 v1.6
2-25
第2章
API メ ソ ッ ド
ISCSIALLOWED (PUT)
ISCSIALLOWED (PUT)
メ ソ ッ ド名
iscsiallowed
デバイ ス
Cisco UCS Invicta ス ケー リ ン グ シ ス テ ム、 Cisco UCS Invicta ア プ ラ イ ア ン ス
HTTP メ ソ ッ ド
PUT
構文
有効な IP ア ド レ ス を 「許可」 に追加 し 、 こ れ ら を 「利用可能」 か ら 削除 し ま す。
URL の例
https://10.1.39.127/restapi/16/<token>/iscsiallowed/0
要求デー タ
NAME
ip
JSON のサン プル
{"ip":"10.127.15.162"}
応答デー タ
NAME
TYPE
注意
文字列
IP ア ド レ ス
TYPE
注意
n/a
n/a
依存関係
注意
•
（注）
こ の API メ ソ ッ ド の呼び出 し を使用す る 際に、 ト ー ク ン を URI で提示す る 必要があ り ます。
重要 ： API アプ リ ケーシ ョ ンの PUT 規格に従い、 ゼ ロ （0） が URI の一部 と し て含まれています。
パ ラ メ ー タ が不十分な場合、 要求は失敗 し ま す。
Cisco UCS Invicta API ガ イ ド 、 v1.6
2-26
第2章
API メ ソ ッ ド
LUN (GET)
LUN (GET)
メ ソ ッ ド名
lun
デバイ ス
Cisco UCS Invicta ス ケー リ ン グ シ ス テ ム、 Cisco UCS Invicta ア プ ラ イ ア ン ス
HTTP メ ソ ッ ド
GET
構文
こ の メ ソ ッ ド は、 デバ イ ス の LUN を返 し ま す。
URL の例
https://10.1.39.127/restapi/16/<token>/lun
要求デー タ
NAME
注意
TYPE
n/a
応答デー タ
NAME
luns
注意
TYPE
配列
LUN レ コ ー ド には、 ボ リ ュ ー ム グ ループ と ダ ッ シ ュ 記号 （‘- ‘） で結合 し た実際の LUN 名で
構成 さ れた配列キーが あ り ま す。 各 レ コ ー ド には、 次の LUN 詳細情報が含 ま れてい ま す。
NAME
name
TYPE
注意
文字列
LUN 名
t10id
文字列
lunid
文字列
LUN T10ID 文字列
LUN ID
size
整数
LUN サ イ ズ
volumegroup
文字列
こ の LUN が属 し てい る ボ リ ュ ーム
グループ名
mirror
文字列
ミ ラ ー リ ン グ の一方の名前 （該当
す る 場合）
文字列
スナ ッ プシ ョ ッ ト が関連付け ら れて
い る元のボ リ ューム名ま たは LUN。
スナ ッ プシ ョ ッ ト ボ リ ューム以外の
場合、 ‘- ‘ を返 し ま す。
文字列
使用 し てい る ス ナ ッ プシ ョ ッ ト ボ
リ ュ ーム の現在の割合を示 し ま す。
ス ナ ッ プシ ョ ッ ト ボ リ ュ ーム以外
の場合、 ‘- ‘ を返 し ま す。
origin
snap_pct
Cisco UCS Invicta API ガ イ ド 、 v1.6
2-27
第2章
API メ ソ ッ ド
LUN (GET)
NAME
TYPE
注意
文字列
ス ナ ッ プシ ョ ッ ト がいつ作成 さ れ
たか を示 し ま す。 ス ナ ッ プシ ョ ッ
ト ボ リ ュ ーム以外の場合、 ‘- ‘ を
返 し ま す。
整数
0 – オフ ラ イ ン
created
adminStatus
1 – オン ラ イ ン
2 - 低下
JSON のサン プル
"data":{"luns”:{“VG1-L2":{"name":"L2","lunid":"1987cb76-L2","t10id":"
1987cb76-L2","size":10,”volumegroup”:”VG1”,”mirror":"","origin":"-","
snap_pct":"-","created":"1409165442","adminStatus”:”1”},”VG1-L3":{"na
me":"L3","lunid":"198790e0-L3","t10id":"198790e0-L3","size":20,"volum
egroup”:”VG1","mirror":"","origin":"-","snap_pct":"-","created":"1409
164250","adminStatus":"1"}}}
依存関係
注意
n/a
•
こ の API メ ソ ッ ド の呼び出 し を使用す る 際に、 ト ー ク ン を URI で提示す る 必要があ り ます。
Cisco UCS Invicta API ガ イ ド 、 v1.6
2-28
第2章
API メ ソ ッ ド
LUN (POST)
LUN (POST)
メ ソ ッ ド名
lun
デバイ ス
Cisco UCS Invicta ス ケー リ ン グ シ ス テ ム、 Cisco UCS Invicta ア プ ラ イ ア ン ス
HTTP メ ソ ッ ド
POST
構文
こ の メ ソ ッ ド は、 デバ イ ス に新 し い LUN を作成 し ま す。
URL の例
https://10.1.39.127/restapi/16/<token>/lun
要求デー タ
NAME
name
TYPE
注意
文字列
LUN 名 （必須）
vg
文字列
ボ リ ューム グループ名 （必須）
整数
LUN サ イ ズ （必須）
size
GB 単位の値
ブール
任意
こ のプ ロ パテ ィ は、 Cisco UCS
Invicta C3124SA ア プ ラ イ ア ン
ス では無視 さ れ ま す
striping
JSON のサン プル
'{"name":"lun1", "vg":"vg1", "size":10}'
応答デー タ
NAME
TYPE
注意
n/a
依存関係
注意
n/a
•
こ の API メ ソ ッ ド の呼び出 し を使用す る 際に、 ト ー ク ン を URI で提示す る 必要があ り ます。
•
サ イ ズはギ ガバ イ ト （GB） 単位で指定す る 必要が あ り ま す。 例 ： 2 = 2 GB。
Cisco UCS Invicta API ガ イ ド 、 v1.6
2-29
第2章
API メ ソ ッ ド
LUN (PUT)
LUN (PUT)
メ ソ ッ ド名
lun
デバイ ス
Cisco UCS Invicta ス ケー リ ン グ シ ス テ ム、 Cisco UCS Invicta ア プ ラ イ ア ン ス
HTTP メ ソ ッ ド
PUT
構文
こ の メ ソ ッ ド は、 デバ イ ス の LUN サ イ ズ を増大 さ せ ま す。
URL の例
https://10.1.39.127/restapi/16/<token>/lun/<name>
要求デー タ
NAME
size
TYPE
注意
整数
GB 単位の値
前の値 よ り も 小 さ く す る こ
と はで き ま せん
JSON のサン プル
{ “size” :1234}
応答デー タ
NAME
TYPE
注意
n/a
依存関係
注意
n/a
•
こ の API メ ソ ッ ド の呼び出 し を使用す る 際に、 ト ー ク ン を URI で提示す る 必要があ り ます。
•
URI で提示 し た <name> は、 変更す る 必要が あ る LUN の一意の名前です。
•
サ イ ズ （GB） は、 前の値 よ り も 小 さ く す る こ と はで き ま せん。
Cisco UCS Invicta API ガ イ ド 、 v1.6
2-30
第2章
API メ ソ ッ ド
LUN (DELETE)
LUN (DELETE)
メ ソ ッ ド名
lun
デバイ ス
Cisco UCS Invicta ス ケー リ ン グ シ ス テ ム、 Cisco UCS Invicta ア プ ラ イ ア ン ス
HTTP メ ソ ッ ド
DELETE
構文
こ の メ ソ ッ ド は、 デバ イ ス か ら LUN を削除 し ま す。
URL の例
https://10.1.39.127/restapi/16/<token>/lun/<name>
要求デー タ
NAME
TYPE
注意
n/a
JSON のサン プル
{“breakMode”:”deleteTarget”}
応答デー タ
NAME
TYPE
注意
n/a
依存関係
注意
n/a
•
こ の API メ ソ ッ ド の呼び出 し を使用す る 際に、 ト ー ク ン を URI で提示す る 必要があ り ます。
•
こ の API メ ソ ッ ド の呼び出 し を実行す る 際に、 着信デー タ は不要です。
•
LUN の削除処理中に、 プ ロ セ ス が完了す る ま で GUI のパフ ォ ーマ ン ス が低下す る こ と があ り
ま す。 LUN が大 き いほ ど 、 プ ロ セ ス に時間かか る 場合が あ り ま す。 オ フ ピ ー ク 時間中は大
き な LUN を削除す る こ と をお勧め し ま す。
Cisco UCS Invicta API ガ イ ド 、 v1.6
2-31
第2章
API メ ソ ッ ド
LUNMIRROR (POST)
LUNMIRROR (POST)
メ ソ ッ ド名
lunmirror
デバイ ス
Cisco UCS Invicta ス ケー リ ン グ シ ス テ ム
HTTP メ ソ ッ ド
POST
構文
既存の LUN の ミ ラ ーを作成 し ま す。
URL の例
https://10.1.39.127/restapi/16/<token>/lunmirror
要求デー タ
NAME
lun
TYPE
注意
文字列
ミ ラ ー さ れ る LUN
mirror
文字列
ミ ラ ーの結果 と し ての新 し い
LUN の名前
vg
文字列
元の LUN が使用す る VG と は
異な る 使用可能な VG の名前
JSON のサン プル
'{"lun":"lun1", "mirror":"lun1mirror", "vg":"vg1"}'
応答デー タ
NAME
TYPE
注意
n/a
依存関係
注意
n/a
•
こ の API メ ソ ッ ド の呼び出 し を使用す る 際に、 ト ー ク ン を URI で提示す る 必要があ り ます。
•
LUN のサ イ ズに よ っ ては、 こ の呼び出 し か ら 応答を受信す る のに時間がかか る 場合が あ り
ま す。
Cisco UCS Invicta API ガ イ ド 、 v1.6
2-32
第2章
API メ ソ ッ ド
LUNMIRROR (DELETE)
LUNMIRROR (DELETE)
メ ソ ッ ド名
lunmirror
デバイ ス
Cisco UCS Invicta ス ケー リ ン グ シ ス テ ム
HTTP メ ソ ッ ド
DELETE
構文
LUN ミ ラ ーを破棄 し ま す。
URL の例
https://10.1.39.127/restapi/16/<token>/lunmirror/<lun id>
要求デー タ
NAME
breakMode
TYPE
注意
文字列
破棄モー ド ：
keep – ミ ラ ーを破棄 し 、 両方
の LUN を維持す る
deleteTarget – ミ ラ ーを破棄し、
ミ ラ ー先の LUN を削除す る
deleteSource – ミ ラ ーを破棄し、
ミ ラ ー元の LUN を削除す る
JSON のサン プル
‘{“breakMode”:”deleteTarget”}’
応答デー タ
NAME
TYPE
注意
n/a
依存関係
注意
n/a
•
こ の API メ ソ ッ ド の呼び出 し を使用す る 際に、 ト ー ク ン を URI で提示す る 必要があ り ます。
•
こ の API メ ソ ッ ド の呼び出 し を実行す る 際に、 着信デー タ は不要です。
•
こ の呼び出 し では、 LUN ミ ラ ー名ではな く LUN 名が渡 さ れ ま す。
Cisco UCS Invicta API ガ イ ド 、 v1.6
2-33
第2章
API メ ソ ッ ド
TOTALSPACE (GET)
TOTALSPACE (GET)
メ ソ ッ ド名
totalspace
デバイ ス
Cisco UCS Invicta ス ケー リ ン グ シ ス テ ム、 Cisco UCS Invicta ア プ ラ イ ア ン ス
HTTP メ ソ ッ ド
GET
構文
こ の メ ソ ッ ド は、 デバ イ ス 全体での合計空 き ス ペー ス を返 し ま す。
URL の例
https://10.1.39.127/restapi/16/<token>/totalspace
要求デー タ
NAME
TYPE
注意
TYPE
注意
配列
すべてのボ リ ュ ーム グルー
プの リ ス ト
n/a
NAME
応答デー タ
name
文字列
freeSpace
整数
GB で計算 さ れ る
JSON のサン プル
"data":[{"name":"vg1","freeSpace":"822"},{"name":"vg2","freeSpace":"818"
}]
依存関係
n/a
注意
•
こ の API メ ソ ッ ド の呼び出 し を使用す る 際に、 ト ー ク ン を URI で提示す る 必要があ り ます。
•
こ の API メ ソ ッ ド の呼び出 し を実行す る 際に、 着信デー タ は不要です。
Cisco UCS Invicta API ガ イ ド 、 v1.6
2-34
第2章
API メ ソ ッ ド
INITIATORGROUP (GET)
INITIATORGROUP (GET)
メ ソ ッ ド名
initiatorgroup
デバイ ス
Cisco UCS Invicta ス ケー リ ン グ シ ス テ ム、 Cisco UCS Invicta ア プ ラ イ ア ン ス
HTTP メ ソ ッ ド
GET
構文
こ の メ ソ ッ ド は、 すべての イ ニ シ エー タ と 割 り 当て ら れた LUN の リ ス ト と 共に、 すべての イ
ニ シ エー タ グループ を返 し ま す。
URL の例
https://10.1.39.127/restapi/16/<token>/initiatorgroup
要求デー タ
NAME
TYPE
注意
TYPE
注意
配列
すべての イ ニ シ エー タ グルー
プの リ ス ト
文字列
イ ニ シ エー タ グループ名
文字列の配列
こ の特定の イ ニ シ エー タ グ
ループに属 し てい る すべての
イ ニ シ エー タ の リ ス ト
文字列の配列
こ の特定の イ ニ シ エー タ グ
ループに割 り 当て ら れ る すべ
ての LUN の リ ス ト
n/a
応答デー タ
NAME
name
initiators
luns
JSON のサン プル
"data":[{"name":"IGsomename","initiators":[],"luns":["dev1:0"]},{"name":
"vmwaretest","initiators":["iqn.1998-01.com.vmware:wt-lab-esx01-2229f4c5
"],"luns":["dev:3","dev1:0"]}]
依存関係
n/a
注意
•
こ の API メ ソ ッ ド の呼び出 し を使用す る 際に、 ト ー ク ン を URI で提示す る 必要があ り ます。
•
こ の API メ ソ ッ ド の呼び出 し を実行す る 際に、 着信デー タ は不要です。
Cisco UCS Invicta API ガ イ ド 、 v1.6
2-35
第2章
API メ ソ ッ ド
INITIATORGROUP (POST)
INITIATORGROUP (POST)
メ ソ ッ ド名
initiatorgroup
デバイ ス
Cisco UCS Invicta ス ケー リ ン グ シ ス テ ム、 Cisco UCS Invicta ア プ ラ イ ア ン ス
HTTP メ ソ ッ ド
POST
構文
こ の メ ソ ッ ド は、 デバ イ ス に イ ニ シ エー タ グループ を追加 し ま す。
URL の例
https://10.1.39.127/restapi/16/<token>/initiatorgroup
要求デー タ
NAME
TYPE
注意
name
文字列
必須
一意で あ る こ と を確認 し ま す
JSON のサン プル
{“name”:”IG123”}
応答デー タ
NAME
TYPE
注意
n/a
依存関係
注意
n/a
•
こ の API メ ソ ッ ド の呼び出 し を使用す る 際に、 ト ー ク ン を URI で提示す る 必要があ り ます。
•
こ の API メ ソ ッ ド の呼び出 し を実行す る 際に、 着信デー タ が必要です。
Cisco UCS Invicta API ガ イ ド 、 v1.6
2-36
第2章
API メ ソ ッ ド
INITIATORGROUP (DELETE)
INITIATORGROUP (DELETE)
メ ソ ッ ド名
initiatorgroup
デバイ ス
Cisco UCS Invicta ス ケー リ ン グ シ ス テ ム、 Cisco UCS Invicta ア プ ラ イ ア ン ス
HTTP メ ソ ッ ド
DELETE
構文
こ の メ ソ ッ ド は、 デバ イ ス か ら イ ニ シ エー タ グループ を削除 し ま す。
URL の例
https://10.1.39.127/restapi/16/<token>/initiatorgroup/<group>
要求デー タ
NAME
TYPE
注意
TYPE
注意
n/a
応答デー タ
NAME
n/a
依存関係
注意
n/a
•
こ の API メ ソ ッ ド の呼び出 し を使用す る 際に、 ト ー ク ン を URI で提示す る 必要があ り ます。
•
<group> は、 デバ イ ス か ら 削除す る イ ニ シ エー タ グループの一意の名前です。
Cisco UCS Invicta API ガ イ ド 、 v1.6
2-37
第2章
API メ ソ ッ ド
INITIATOR (POST)
INITIATOR (POST)
メ ソ ッ ド名
発信側
デバイ ス
Cisco UCS Invicta ス ケー リ ン グ シ ス テ ム、 Cisco UCS Invicta ア プ ラ イ ア ン ス
HTTP メ ソ ッ ド
POST
構文
こ の メ ソ ッ ド は、 デバ イ ス の イ ニ シ エー タ グループで イ ニ シ エー タ を作成 し ま す。
URL の例
https://10.1.39.127/restapi/16/<token>/initiator
要求デー タ
NAME
name
TYPE
注意
文字列
必須
イ ニ シエー タ グループの名前
initiator
文字列
必須
一意の割 り 当て を確認す る – イ
ニ シ エー タ は複数の グループ
に割 り 当て る こ と はで き ま せ
ん
JSON のサン プル
{“name”:“IG123”, “initiator”:“iqn.1998-01.com.vmware:wt-lab-esx01-2229f4c5”}
応答デー タ
NAME
TYPE
注意
n/a
依存関係
注意
こ の メ ソ ッ ド を使用す る 際に、 少な く と も 1 つの イ ニシエー タ グループが使用で き る 必要があ り
ま す。
•
こ の API メ ソ ッ ド の呼び出 し を使用す る 際に、 ト ー ク ン を URI で提示す る 必要があ り ます。
•
name は、 イ ニ シ エー タ を追加す る イ ニ シ エー タ グループの一意の名前です。
•
イ ニ シ エー タ の文字列には、 次の 3 種類の形式がサポー ト さ れてい ま す。
•
iSCSI 接続用の特定 IQN 形式
•
FC 接続用の コ ロ ン で区切っ た WWN 16 進表記
•
IB 接続用の WWN “0X” 16 進表記
Cisco UCS Invicta API ガ イ ド 、 v1.6
2-38
第2章
API メ ソ ッ ド
INITIATOR (DELETE)
INITIATOR (DELETE)
メ ソ ッ ド名
initiator
デバイ ス
Cisco UCS Invicta ス ケー リ ン グ シ ス テ ム、 Cisco UCS Invicta ア プ ラ イ ア ン ス
HTTP メ ソ ッ ド
DELETE
構文
こ の メ ソ ッ ド は、 デバ イ ス の イ ニ シ エー タ グループか ら イ ニ シ エー タ を削除 し ま す。
URL の例
https://10.1.39.127/restapi/16/<token>/initiator/<initiator_group>
要求デー タ
NAME
name
TYPE
注意
文字列
必須
JSON のサン プル
{“name”:“iqn.1998-01.com.vmware:wt-lab-esx01-2229f4c5”}
応答デー タ
NAME
TYPE
注意
n/a
依存関係
注意
n/a
•
こ の API メ ソ ッ ド の呼び出 し を使用す る 際に、 ト ー ク ン を URI で提示す る 必要があ り ます。
•
name は、 <initiator_group> か ら 削除す る イ ニシエー タ を指定す る イ ニ シエー タ の文字
列であ り 、 URI で提示 し ま す。
Cisco UCS Invicta API ガ イ ド 、 v1.6
2-39
第2章
API メ ソ ッ ド
MAPLUN (POST)
MAPLUN (POST)
メ ソ ッ ド名
maplun
デバイ ス
Cisco UCS Invicta ス ケー リ ン グ シ ス テ ム、 Cisco UCS Invicta ア プ ラ イ ア ン ス
HTTP メ ソ ッ ド
POST
構文
こ の メ ソ ッ ド は、 イ ニ シ エー タ グループの レ ベルで LUN マ ッ ピ ン グ を作成 し ま す。
URL の例
https://10.1.39.127/restapi/16/<token>/maplun
要求デー タ
NAME
TYPE
注意
name
文字列
イ ニ シ エー タ グループ名
（必須）
lunName
文字列
LUN 名 （必須）
id
整数
0 ～ 255 の値 （必須）
JSON のサン プル
{“name”:“IG123”, “lunName”:“lunt1”, “id”:3}
応答デー タ
NAME
TYPE
注意
n/a
依存関係
注意
こ の メ ソ ッ ド を使用す る には、 LUN お よ び イ ニ シ エー タ グループがデバ イ ス に存在 し てい る
必要が あ り ま す。
•
こ の API メ ソ ッ ド の呼び出 し を使用す る 際に、 ト ー ク ン を URI で提示す る 必要があ り ます。
•
name は、 イ ニ シ エー タ グループの一意の名前です。
•
lunName は、 イ ニ シ エー タ グループにマ ッ プ さ れ る LUN の一意の名前です。
•
イ ニ シ エー タ グループに ID 0 （ゼ ロ ） でのマ ッ ピ ン グ がな く 、 こ の要求の id フ ィ ール ド に
0 （ゼ ロ ） 以外の番号が あ る 場合、 エ ラ ーが返 さ れ ま す。
Cisco UCS Invicta API ガ イ ド 、 v1.6
2-40
第2章
API メ ソ ッ ド
MAPLUN (DELETE)
MAPLUN (DELETE)
メ ソ ッ ド名
maplun
デバイ ス
Cisco UCS Invicta ス ケー リ ン グ シ ス テ ム、 Cisco UCS Invicta ア プ ラ イ ア ン ス
HTTP メ ソ ッ ド
DELETE
構文
こ の メ ソ ッ ド は、 イ ニ シ エー タ グループの レ ベルで LUN マ ッ ピ ン グ を削除 し ま す。
URL の例
https://10.1.39.127/restapi/16/<token>/maplun/<lun_name>
要求デー タ
NAME
name
TYPE
注意
文字列
イ ニシエータ グループ名 （必須）
ブール
任意
マ ッ プ解除 さ れ る LUN に 0 の
MAP ID が あ る 場合、MAP ID 0
がマ ッ プ解除 さ れ る こ と を示す
警告が返 さ れ ま す。 警告 を オー
バー ラ イ ド す る には、 こ のパ ラ
メ ー タ を送信 し ま す。
force_mapid0_delete
JSON のサン プル
{“name”:“IG123”, “force_mapid0_delete”:true}
応答デー タ
NAME
TYPE
注意
n/a
依存関係
注意
n/a
•
こ の API メ ソ ッ ド の呼び出 し を使用す る 際に、 ト ー ク ン を URI で提示す る 必要があ り ます。
•
name は、 イ ニ シ エー タ グループの一意の名前です。
•
lunName は、 イ ニ シ エー タ グループか ら マ ッ プ解除 さ れ る LUN の一意の名前です。
Cisco UCS Invicta API ガ イ ド 、 v1.6
2-41
第2章
API メ ソ ッ ド
MAPLUNAUTO (POST)
MAPLUNAUTO (POST)
メ ソ ッ ド名
maplunauto
デバイ ス
Cisco UCS Invicta ス ケー リ ン グ シ ス テ ム、 Cisco UCS Invicta ア プ ラ イ ア ン ス
HTTP メ ソ ッ ド
POST
構文
こ の メ ソ ッ ド は、 イ ニ シ エー タ グループの レ ベルで LUN マ ッ ピ ン グ を作成 し ま す。
URL の例
https://10.1.39.127/restapi/16/<token>/maplunauto
要求デー タ
NAME
TYPE
注意
name
文字列
イ ニ シ エー タ グループ名
（必須）
lunName
文字列
LUN 名 （必須）
JSON のサン プル
{“name”:“IG123”, “lunName”:“lunt1”}
応答デー タ
NAME
TYPE
注意
n/a
依存関係
注意
こ の メ ソ ッ ド を使用す る には、 LUN お よ び イ ニ シ エー タ グループがデバ イ ス に存在 し てい る
必要が あ り ま す。
•
こ の API メ ソ ッ ド の呼び出 し を使用す る 際に、 ト ー ク ン を URI で提示す る 必要があ り ます。
•
name は、 イ ニ シ エー タ グループの一意の名前です。
•
lunName は、 イ ニ シ エー タ グループにマ ッ プ さ れ る LUN の一意の名前です。
•
次に使用で き る マ ッ ピ ン グ ID が自動的に選択 さ れ ま す。
Cisco UCS Invicta API ガ イ ド 、 v1.6
2-42
第2章
API メ ソ ッ ド
WWN (GET)
WWN (GET)
メ ソ ッ ド名
wwn
デバイ ス
Cisco UCS Invicta ス ケー リ ン グ シ ス テ ム、 Cisco UCS Invicta ア プ ラ イ ア ン ス
HTTP メ ソ ッ ド
GET
構文
こ の メ ソ ッ ド は、 デバ イ ス の ワ ール ド ワ イ ド 名 （WWN） を取得 し ま す。
URL の例
https://10.1.39.127/restapi/16/<token>/wwn
要求デー タ
NAME
TYPE
注意
TYPE
注意
配列
文字列の配列
n/a
応答デー タ
NAME
wwns
JSON のサン プル
“data”:{“wwns”:[{“0”:”21:00:00:24:ff:39:fa:98”},{“1”:”
21:00:00:24:ff:39:fa:99”}]}
依存関係
n/a
注意
•
こ の API メ ソ ッ ド の呼び出 し を使用す る 際に、 ト ー ク ン を URI で提示す る 必要があ り ます。
Cisco UCS Invicta API ガ イ ド 、 v1.6
2-43
第2章
API メ ソ ッ ド
IQN (GET)
IQN (GET)
メ ソ ッ ド名
iqn
デバイ ス
Cisco UCS Invicta ス ケー リ ン グ シ ス テ ム、 Cisco UCS Invicta ア プ ラ イ ア ン ス
HTTP メ ソ ッ ド
GET
構文
こ の メ ソ ッ ド は、 デバ イ ス の iSCSI 修飾名 （IQN） を取得 し ま す。
URL の例
https://10.1.39.127/restapi/16/<token>/iqn
要求デー タ
NAME
TYPE
注意
n/a
NAME
iqn
応答デー タ
TYPE
注意
文字列
iSCSI 修飾名
JSON のサン プル
"data":{"iqn.2008-07.com.WHIPTAILtech:storage"}
依存関係
n/a
注意
•
こ の API メ ソ ッ ド の呼び出 し を使用す る 際に、 ト ー ク ン を URI で提示す る 必要があ り ます。
Cisco UCS Invicta API ガ イ ド 、 v1.6
2-44
第2章
API メ ソ ッ ド
INTERFACES (GET)
INTERFACES (GET)
メ ソ ッ ド名
イ ン ターフ ェ イ ス
デバイ ス
Cisco UCS Invicta ス ケー リ ン グ シ ス テ ム、 Cisco UCS Invicta ア プ ラ イ ア ン ス
HTTP メ ソ ッ ド
GET
構文
こ の メ ソ ッ ド は、 デバ イ ス でのすべての イ ン タ ー フ ェ イ ス を取得 し ま す。
URL の例
https://10.1.39.127/restapi/16/<token>/interfaces
要求デー タ
NAME
TYPE
注意
TYPE
注意
配列
イ ン タ ー フ ェ イ ス の配列
n/a
応答デー タ
NAME
interfaces*
interfaces には、 実際の イ ン タ ー フ ェ イ ス の名前 と 同一の配列キーが あ り ま す。 各 レ コ ー ド
には、 イ ン タ ー フ ェ イ ス の次の詳細情報が含 ま れてい ま す。
NAME
name
TYPE
注意
文字列
イ ン ターフ ェ イ ス名
mtu
整数
Maximum Transmission Unit ：
最大伝送単位
status
文字列
ip
文字列
イ ン タ ー フ ェ イ ス ス テー タ ス
Interface IP
mac
文字列
イ ン タ ー フ ェ イ ス MAC ア ド
レス
mask
文字列
イ ン ターフ ェ イ ス ネ ッ ト ワー
ク マス ク
speed
文字列
物理デバ イ ス の場合のみ
イ ン タ ーフ ェ イ ス
配列
文字列の配列
論理の場合のみ （接合）
maxSpeed
duplex
文字列
物理デバ イ ス の場合のみ
文字列
物理デバ イ ス の場合のみ
onboot
文字列
“Yes” ま たは “No”
Cisco UCS Invicta API ガ イ ド 、 v1.6
2-45
第2章
API メ ソ ッ ド
INTERFACES (GET)
mode
整数
Virtuals お よ び Vlans の場合、
Empty が返 さ れ ま す。
vlan
ブール
vlan の場合は TRUE
virtualinterface
ブール
仮想 イ ン タ ー フ ェ イ ス の場合
は TRUE
label
文字列
非接合 イ ン タ ー フ ェ イ ス にの
み適用
mac
文字列
非接合 イ ン タ ー フ ェ イ ス の
MAC ア ド レ ス
status
文字列
非接合 イ ン タ ー フ ェ イ ス にの
み適用
speed
非接合 イ ン タ ー フ ェ イ ス にの
み適用
イ ン タ ー フ ェ イ ス が接合 さ れ
る ま では ス テー タ ス デー タ が
ないため、 該当 し ま せん。
パフ ォ ーマ ン ス
文字列
非接合 イ ン タ ー フ ェ イ ス にの
み適用
イ ン タ ー フ ェ イ ス が接合 さ れ
る ま ではパ フ ォ ーマ ン ス デー
タ がないため、 該当 し ません。
type
文字列
非接合 イ ン タ ー フ ェ イ ス にの
み適用
接続の種類 ：
TWISTED PAIR
FIBRE
DIRECT ATTACH COPPER
JSON のサンプル
"data":{"interfaces":{"bond0":{"name":"bond0","status":"UP","ip":"10.10.
15.215","speed":"1000\/FULL","mtu":"1500","mask":"255.255.255.0","onBoot
":"yes","mode":"6","maxSpeed":null,"vlan":false,"virtualinterface":false
,"interfaces":["eth0"],"duplex":"FULL","mac":"00:50:56:B1:4E:FD"},"bond0
.1":{"name":"bond0.1","status":"UP","ip":"10.10.15.223","speed":"UNKNOWN
","mtu":"1500","mask":"255.255.255.0","onBoot":"yes","mode":"","maxSpeed
":null,"vlan":true,"virtualinterface":false,"interfaces":[],"duplex":nul
l,"mac":"00:50:56:B1:4E:FD"},"bond0:0":{"name":"bond0:0","status":"DOWN"
,"ip":"10.10.15.224","speed":"UNKNOWN","mtu":"1500","mask":"255.255.255.
0","onBoot":"yes","mode":"","maxSpeed":null,"vlan":false,"virtualinterfa
ce":true,"interfaces":[],"duplex":null,"mac":"00:50:56:B1:4E:FD"},"bond1
00":{"name":"bond100","status":"UP","ip":"10.90.90.2","speed":"1000\/FUL
L","mtu":"1500","mask":"255.255.255.0","onBoot":"yes","mode":"6","maxSpe
ed":null,"vlan":false,"virtualinterface":false,"interfaces":["eth1"],"du
plex":"FULL","mac":"00:50:56:B1:02:5A"}}}
Cisco UCS Invicta API ガ イ ド 、 v1.6
2-46
第2章
API メ ソ ッ ド
INTERFACES (GET)
依存関係
注意
n/a
•
こ の API メ ソ ッ ド の呼び出 し を使用す る 際に、 ト ー ク ン を URI で提示す る 必要があ り ます。
Cisco UCS Invicta API ガ イ ド 、 v1.6
2-47
第2章
API メ ソ ッ ド
PHYSICALINTERFACES (GET)
PHYSICALINTERFACES (GET)
メ ソ ッ ド名
physicalinterfaces
デバイ ス
Cisco UCS Invicta ス ケー リ ン グ シ ス テ ム、 Cisco UCS Invicta ア プ ラ イ ア ン ス
HTTP メ ソ ッ ド
GET
構文
こ の メ ソ ッ ド は、 デバ イ ス でのすべての非接合物理 イ ン タ ー フ ェ イ ス を取得 し ま す。
URL の例
https://10.1.39.127/restapi/16/<token>/physicalinterfaces
要求デー タ
NAME
TYPE
注意
TYPE
注意
配列
イ ン タ ー フ ェ イ ス の配列
n/a
NAME
interfaces*
応答デー タ
interfaces には、 実際の イ ン タ ー フ ェ イ ス の名前 と 同一の配列キーが あ り ま す。 各 レ コ ー ド
には、 イ ン タ ー フ ェ イ ス の次の詳細情報が含 ま れてい ま す。
NAME
name
TYPE
注意
文字列
イ ン ターフ ェ イ ス名
JSON のサン プル
"data":{"interfaces":[{"name":"eth5"},{"name":"eth6"}]]}
依存関係
n/a
注意
•
こ の API メ ソ ッ ド の呼び出 し を使用す る 際に、 ト ー ク ン を URI で提示す る 必要があ り ます。
Cisco UCS Invicta API ガ イ ド 、 v1.6
2-48
第2章
API メ ソ ッ ド
BOND (POST)
BOND (POST)
メ ソ ッ ド名
bond
デバイ ス
Cisco UCS Invicta ス ケー リ ン グ シ ス テ ム、 Cisco UCS Invicta ア プ ラ イ ア ン ス
HTTP メ ソ ッ ド
POST
構文
こ の メ ソ ッ ド は、 新 し い接合を作成 し ま す。
URL の例
https://10.1.39.127/restapi/16/<token>/bond
要求デー タ
NAME
ip
TYPE
注意
文字列
接合 IP
mask
文字列
接合ネ ッ ト ワ ー ク マ ス ク
mtu
整数
Maximum Transmission Unit ：
最大伝送単位
mode
整数
モー ド コ ー ド （必須）
0 = ラ ウン ド ロビン
1 = アクテ ィブ バッ クアップ
4 = LACP
6 = ALB
onboot
ブール
起動時に初期化す る （必須）
TRUE ま たは FALSE
JSON のサン プル
'{"ip":"10.10.10.120","mask":"255.255.255.0","mtu":1505,"mode":4,"onboot
":false}'
応答デー タ
NAME
name
JSON のサン プル
TYPE
注意
文字列
“data”:{“name”:”bond1”}
Cisco UCS Invicta API ガ イ ド 、 v1.6
2-49
第2章
API メ ソ ッ ド
BOND (POST)
依存関係
注意
n/a
•
こ の API メ ソ ッ ド の呼び出 し を使用す る 際に、 ト ー ク ン を URI で提示す る 必要があ り ます。
Cisco UCS Invicta API ガ イ ド 、 v1.6
2-50
第2章
API メ ソ ッ ド
BOND (PUT)
BOND (PUT)
メ ソ ッ ド名
bond
デバイ ス
Cisco UCS Invicta ス ケー リ ン グ シ ス テ ム、 Cisco UCS Invicta ア プ ラ イ ア ン ス
HTTP メ ソ ッ ド
PUT
構文
こ の メ ソ ッ ド は、 既存の接合を更新 し ま す。
URL の例
https://10.1.39.127/restapi/16/<token>/bond/<bond_name>
要求デー タ
NAME
ip
TYPE
注意
文字列
接合 IP （必須）
mask
文字列
接合ネ ッ ト ワ ー ク マ ス ク （必
須）
mtu
整数
最大転送単位 （必須）
mode
整数
モー ド コ ー ド （必須）
0= ラ ウ ン ド ロ ビ ン
1 = アクテ ィブ バッ クアップ
4 = LACP
6 = ALB
onboot
ブール
起動時に初期化す る （必須）
TRUE ま たは FALSE
JSON のサン プル
'{"ip":"10.10.10.120","mask":"255.255.255.0","mtu":1505,"mode":4,"onboot
":false}'
応答デー タ
NAME
注意
TYPE
n/a
依存関係
注意
n/a
•
こ の API メ ソ ッ ド の呼び出 し を使用す る 際に、 ト ー ク ン を URI で提示す る 必要があ り ます。
•
URI での bond_name は、 接合/デバ イ ス の一意の名前です。
Cisco UCS Invicta API ガ イ ド 、 v1.6
2-51
第2章
API メ ソ ッ ド
BOND (DELETE)
BOND (DELETE)
メ ソ ッ ド名
bond
デバイ ス
Cisco UCS Invicta ス ケー リ ン グ シ ス テ ム、 Cisco UCS Invicta ア プ ラ イ ア ン ス
HTTP メ ソ ッ ド
DELETE
構文
こ の メ ソ ッ ド は、 既存の接合を削除 し ま す。
URL の例
https://10.1.39.127/restapi/16/<token>/bond/<bond_name>
要求デー タ
NAME
TYPE
注意
n/a
応答デー タ
NAME
TYPE
注意
n/a
依存関係
注意
n/a
•
こ の API メ ソ ッ ド の呼び出 し を使用す る 際に、 ト ー ク ン を URI で提示す る 必要があ り ます。
•
URI での bond_name は、 接合/デバ イ ス の一意の名前です。
Cisco UCS Invicta API ガ イ ド 、 v1.6
2-52
第2章
API メ ソ ッ ド
TOGGLEBOND (PUT)
TOGGLEBOND (PUT)
メ ソ ッ ド名
togglebond
デバイ ス
Cisco UCS Invicta ス ケー リ ン グ シ ス テ ム、 Cisco UCS Invicta ア プ ラ イ ア ン ス
HTTP メ ソ ッ ド
PUT
構文
こ の メ ソ ッ ド は、 接合デバ イ ス を有効/無効に し ま す。
URL の例
https://10.1.39.127/restapi/16/<token>/togglebond/<bond_name>
要求デー タ
NAME
toggleState
TYPE
注意
文字列
ア ク シ ョ ン イ ン ジ ケー タ
（必須）
enable ま たは disable
JSON のサン プル
'{"toggleState":"enable"}'
応答デー タ
NAME
注意
TYPE
n/a
依存関係
注意
n/a
•
こ の API メ ソ ッ ド の呼び出 し を使用す る 際に、 ト ー ク ン を URI で提示す る 必要があ り ます。
•
URI での bond_name は、 接合/デバ イ ス の一意の名前です。
Cisco UCS Invicta API ガ イ ド 、 v1.6
2-53
第2章
API メ ソ ッ ド
ENSLAVE (PUT)
ENSLAVE (PUT)
メ ソ ッ ド名
enslave
デバイ ス
Cisco UCS Invicta ス ケー リ ン グ シ ス テ ム、 Cisco UCS Invicta ア プ ラ イ ア ン ス
HTTP メ ソ ッ ド
PUT
構文
こ の メ ソ ッ ド は、 既存の接合で物理 イ ン タ ー フ ェ イ ス を追加 ま たは削除 し ま す。
URL の例
https://10.1.39.127/restapi/16/<token>/enslave/<bond_name>
要求デー タ
NAME
nicName
TYPE
注意
文字列
物理 イ ン タ ー フ ェ イ ス 名
（例 ： eth2）
アクシ ョ ン
文字列
add ま たは remove
JSON のサンプル
‘{“nicName”:”eth4”, “action”:”add”}’
応答デー タ
NAME
TYPE
注意
n/a
依存関係
注意
n/a
•
こ の API メ ソ ッ ド の呼び出 し を使用す る 際に、 ト ー ク ン を URI で提示す る 必要があ り ます。
•
URI での bond_name は、 接合/デバ イ ス の一意の名前です。
Cisco UCS Invicta API ガ イ ド 、 v1.6
2-54
第2章
API メ ソ ッ ド
VLAN (POST)
VLAN (POST)
メ ソ ッ ド名
vlan
デバイ ス
Cisco UCS Invicta ス ケー リ ン グ シ ス テ ム、 Cisco UCS Invicta ア プ ラ イ ア ン ス
HTTP メ ソ ッ ド
POST
構文
こ の メ ソ ッ ド は、 新 し い VLAN を作成 し ま す。
URL の例
https://10.1.39.127/restapi/16/<token>/vlan
要求デー タ
NAME
name
TYPE
注意
文字列
「親」 イ ン タ ー フ ェ イ ス 名
（必須）
vlanID
整数
VLAN ID （必須）
1 ～ 4096 の値
ip
文字列
VLAN IP （必須）
mask
文字列
VLAN ネ ッ ト ワ ー ク マ ス ク
（必須）
mtu
整数
最大転送単位 （必須）
onboot
ブール
起動時に初期化す る （必須）
TRUE ま たは FALSE
force
ブール
TRUE の場合、 IP がすでに使用
さ れてい る かど う かの確認を
省略する （任意）
TRUE ま たは FALSE
JSON のサン プル
‘{"name":"bond0","vlanID":1,"ip":"10.10.15.221","mask":"255.255.255.0",
"mtu":1500,"onboot":true,"force":true}’
応答デー タ
NAME
TYPE
注意
n/a
依存関係
こ の メ ソ ッ ド を使用す る には、 接合がデバ イ ス に存在 し てい る 必要が あ り ま す。
Cisco UCS Invicta API ガ イ ド 、 v1.6
2-55
第2章
API メ ソ ッ ド
VLAN (POST)
注意
•
こ の API メ ソ ッ ド の呼び出 し を使用す る 際に、 ト ー ク ン を URI で提示す る 必要があ り ます。
•
name は、 接合/デバ イ ス の一意の名前です。
•
PING に応答で き る IP の場合、 API はその IP がすでに使用 さ れてい る と 見なすため、 ス テー
タ ス コ ー ド 391 のエ ラ ーが返 さ れ ます。 「強制」 パ ラ メ ー タ を使用 し て呼び出 し を再送信す
る こ と で、 その IP は引 き 続 き 使用で き ま す。
Cisco UCS Invicta API ガ イ ド 、 v1.6
2-56
第2章
API メ ソ ッ ド
VLAN (PUT)
VLAN (PUT)
メ ソ ッ ド名
vlan
デバイ ス
Cisco UCS Invicta ス ケー リ ン グ シ ス テ ム、 Cisco UCS Invicta ア プ ラ イ ア ン ス
HTTP メ ソ ッ ド
PUT
構文
こ の メ ソ ッ ド は、 既存の VLAN を更新 し ま す。
URL の例
https://10.1.39.127/restapi/16/<token>/vlan/0
要求デー タ
NAME
name
TYPE
注意
文字列
VLAN 名 （必須）
ip
文字列
VLAN IP （必須）
mask
文字列
VLAN ネ ッ ト ワ ー ク マ ス ク
（必須）
mtu
整数
最大転送単位 （必須）
onboot
ブール
起動時に初期化す る （必須）
TRUE ま たは FALSE
force
ブール
TRUE の場合、 IP がすでに使用
さ れてい る かど う かの確認を
省略する （任意）
TRUE ま たは FALSE
JSON のサン プル
‘{"name":"bond0.1","ip":"10.10.15.222","mask":"255.255.255.0","mtu":1500,
"onboot":true,"force":true}’
応答デー タ
NAME
TYPE
注意
n/a
依存関係
n/a
Cisco UCS Invicta API ガ イ ド 、 v1.6
2-57
第2章
API メ ソ ッ ド
VLAN (PUT)
注意
（注）
•
こ の API メ ソ ッ ド の呼び出 し を使用す る 際に、 ト ー ク ン を URI で提示す る 必要があ り ます。
•
name は、 接合/デバ イ ス と vlanID を ピ リ オ ド で結合 し た一意の名前です （例 ： bond0.1234）。
•
PING に応答で き る IP の場合、 API はその IP がすでに使用 さ れてい る と 見なすため、 ス
テー タ ス コ ー ド 391 のエ ラ ーが返 さ れ ま す。 「強制」 パ ラ メ ー タ を使用 し て呼び出 し を再
送信す る こ と で、 その IP は引 き 続 き 使用で き ま す。
重要 ： API アプ リ ケーシ ョ ンの PUT 規格に従い、 ゼ ロ （0） が URI の一部 と し て含まれています。
パ ラ メ ー タ が不十分な場合、 要求は失敗 し ま す。
Cisco UCS Invicta API ガ イ ド 、 v1.6
2-58
第2章
API メ ソ ッ ド
VLAN (DELETE)
VLAN (DELETE)
メ ソ ッ ド名
vlan
デバイ ス
Cisco UCS Invicta ス ケー リ ン グ シ ス テ ム、 Cisco UCS Invicta ア プ ラ イ ア ン ス
HTTP メ ソ ッ ド
DELETE
構文
こ の メ ソ ッ ド は、 既存の VLAN を削除 し ま す。
URL の例
https://10.1.39.127/restapi/16/<token>/vlan/0
要求デー タ
NAME
name
JSON のサン プル
{"name":"bond3.1"}
応答デー タ
NAME
TYPE
注意
文字列
TYPE
注意
n/a
n/a
依存関係
注意
（注）
•
こ の API メ ソ ッ ド の呼び出 し を使用す る 際に、 ト ー ク ン を URI で提示す る 必要があ り ます。
•
name は、 接合/デバ イ ス と vlanID を ピ リ オ ド で結合 し た一意の名前です （例 ： bond0.1234）。
重要 ： API ア プ リ ケーシ ョ ン の DELETE 規格に従い、 ゼ ロ （0） が URI の一部 と し て含 ま れて
い ま す。 パ ラ メ ー タ が不十分な場合、 要求は失敗 し ま す。
Cisco UCS Invicta API ガ イ ド 、 v1.6
2-59
第2章
API メ ソ ッ ド
VIRTUALINTERFACE (POST)
VIRTUALINTERFACE (POST)
メ ソ ッ ド名
virtualinterface
デバイ ス
Cisco UCS Invicta ス ケー リ ン グ シ ス テ ム、 Cisco UCS Invicta ア プ ラ イ ア ン ス
HTTP メ ソ ッ ド
POST
構文
こ の メ ソ ッ ド は、 仮想 イ ン タ ー フ ェ イ ス を作成 し ま す。
URL の例
https://10.1.39.127/restapi/16/<token>/virtualinterface
要求デー タ
NAME
TYPE
注意
name
文字列
「親」 イ ン タ ー フ ェ イ ス 名 （必
須）
ip
文字列
仮想 イ ン タ ー フ ェ イ ス IP
（必須）
mask
文字列
仮想 イ ン タ ー フ ェ イ ス ネ ッ ト
ワ ー ク マ ス ク （必須）
mtu
整数
最大転送単位 （必須）
ブール
起動時に初期化す る （必須）
onboot
TRUE ま たは FALSE
ブール
force
TRUE の場合、 IP がすでに
使用 さ れてい る か ど う かの
確認を省略す る （必須）
TRUE ま たは FALSE
JSON のサン プル
‘{"name":"bond0","ip":"10.10.15.226","mask":"255.255.255.0","mtu":1500,
"onboot":true,"force":true}’
応答デー タ
NAME
TYPE
注意
n/a
依存関係
こ の メ ソ ッ ド を使用す る には、 接合がデバ イ ス に存在 し てい る 必要が あ り ま す。
Cisco UCS Invicta API ガ イ ド 、 v1.6
2-60
第2章
API メ ソ ッ ド
VIRTUALINTERFACE (POST)
注意
•
こ の API メ ソ ッ ド の呼び出 し を使用す る 際に、 ト ー ク ン を URI で提示す る 必要があ り ます。
•
name は、 接合/デバ イ ス の一意の名前です。
•
PING に応答で き る IP の場合、 API はその IP がすでに使用 さ れてい る と 見なすため、 ス テー
タ ス コ ー ド 391 のエ ラ ーが返 さ れ ま す。 「強制」 パ ラ メ ー タ を使用 し て呼び出 し を再送信
す る こ と で、 その IP は引 き 続 き 使用で き ま す。
Cisco UCS Invicta API ガ イ ド 、 v1.6
2-61
第2章
API メ ソ ッ ド
VIRTUALINTERFACE (PUT)
VIRTUALINTERFACE (PUT)
メ ソ ッ ド名
virtualinterface
デバイ ス
Cisco UCS Invicta ス ケー リ ン グ シ ス テ ム、 Cisco UCS Invicta ア プ ラ イ ア ン ス
HTTP メ ソ ッ ド
PUT
構文
こ の メ ソ ッ ド は、 仮想 イ ン タ ー フ ェ イ ス を更新 し ま す。
URL の例
https://10.1.39.127/restapi/16/<token>/virtualinterface/0
要求デー タ
NAME
TYPE
注意
name
文字列
仮想 イ ン タ ー フ ェ イ ス 名
（必須）
ip
文字列
仮想 イ ン タ ー フ ェ イ ス IP
（必須）
mask
文字列
仮想 イ ン タ ー フ ェ イ ス ネ ッ
ト ワ ー ク マ ス ク （必須）
mtu
整数
最大転送単位 （必須）
ブール
起動時に初期化す る （必須）
onboot
TRUE ま たは FALSE
ブール
force
TRUE の場合、 IP がすでに使用
さ れてい る かど う かの確認を
省略する （任意）
TRUE ま たは FALSE
JSON のサン プル
‘{"name":"bond0:0","ip":"10.10.15.227","mask":"255.255.255.0","mtu":1500,
"onboot":true,"force":true}’
応答デー タ
NAME
n/a
依存関係
n/a
Cisco UCS Invicta API ガ イ ド 、 v1.6
2-62
TYPE
注意
第2章
API メ ソ ッ ド
VIRTUALINTERFACE (PUT)
注意
（注）
•
こ の API メ ソ ッ ド の呼び出 し を使用す る 際に、 ト ー ク ン を URI で提示す る 必要があ り ます。
•
name は、 接合/デバ イ ス と 割 り 当て ら れた ID を コ ロ ン で結合 し た一意の名前です （例 ：
bond1:1）。
•
PING に応答で き る IP の場合、 API はその IP がすでに使用 さ れてい る と 見なすため、 ス
テー タ ス コ ー ド 391 のエ ラ ーが返 さ れ ま す。 「強制」 パ ラ メ ー タ を使用 し て呼び出 し を再
送信す る こ と で、 その IP は引 き 続 き 使用で き ま す。
重要 ： API アプ リ ケーシ ョ ンの PUT 規格に従い、 ゼ ロ （0） が URI の一部 と し て含まれています。
パ ラ メ ー タ が不十分な場合、 要求は失敗 し ま す。
Cisco UCS Invicta API ガ イ ド 、 v1.6
2-63
第2章
API メ ソ ッ ド
VIRTUALINTERFACE (DELETE)
VIRTUALINTERFACE (DELETE)
メ ソ ッ ド名
virtualinterface
デバイ ス
Cisco UCS Invicta ス ケー リ ン グ シ ス テ ム、 Cisco UCS Invicta ア プ ラ イ ア ン ス
HTTP メ ソ ッ ド
DELETE
構文
こ の メ ソ ッ ド は、 仮想 イ ン タ ー フ ェ イ ス を削除 し ま す。
URL の例
https://10.1.39.127/restapi/16/<token>/virtualinterface/0
要求デー タ
NAME
name
JSON のサン プル
{"name":"bond0:1”}
応答デー タ
NAME
TYPE
注意
文字列
仮想 イ ン タ ー フ ェ イ ス 名
（必須）
TYPE
n/a
n/a
依存関係
注意
（注）
•
こ の API メ ソ ッ ド の呼び出 し を使用す る 際に、 ト ー ク ン を URI で提示す る 必要があ り ます。
•
name は、 接合/デバ イ ス と 割 り 当て ら れた ID を コ ロ ン で結合 し た一意の名前です （例 ：
bond1:1）。
重要 ： API ア プ リ ケーシ ョ ン の DELETE 規格に従い、 ゼ ロ （0） が URI の一部 と し て含 ま れて
い ま す。 パ ラ メ ー タ が不十分な場合、 要求は失敗 し ま す。
Cisco UCS Invicta API ガ イ ド 、 v1.6
2-64
第2章
API メ ソ ッ ド
PERFORMANCE – [TYPES] (GET)
PERFORMANCE – [TYPES] (GET)
メ ソ ッ ド名
パ フ ォ ーマ ン ス
デバイ ス
Cisco UCS Invicta ス ケー リ ン グ シ ス テ ム、 Cisco UCS Invicta ア プ ラ イ ア ン ス
HTTP メ ソ ッ ド
GET
構文
こ の メ ソ ッ ド は、 使用可能なパ フ ォ ーマ ン ス ロ グ の タ イ プ を取得 し ま す。
URL の例
https://10.1.39.127/restapi/16/<token>/performance/types
要求デー タ
NAME
n/a
URL 要求のサン プ
curl -k -X GET --url 'https://10.10.15.181/restapi/16/<token>/performance/types' -H "Accept: application/json"
応答デー タ
NAME
TYPE
注意
TYPE
注意
配列
使用可能な タ イ プの配列
JSON のサン プル
"data":{"types":["bricks","luns","networkphysical","networkvirtual"]}
依存関係
n/a
注意
•
こ の API メ ソ ッ ド の呼び出 し を使用す る 際に、 ト ー ク ン を URI で提示す る 必要があ り ます。
Cisco UCS Invicta API ガ イ ド 、 v1.6
2-65
第2章
API メ ソ ッ ド
PERFORMANCE – [RESOURCES] (GET)
PERFORMANCE – [RESOURCES] (GET)
メ ソ ッ ド名
パ フ ォ ーマ ン ス
デバイ ス
Cisco UCS Invicta ス ケー リ ン グ シ ス テ ム、 Cisco UCS Invicta ア プ ラ イ ア ン ス
HTTP メ ソ ッ ド
GET
構文
こ の メ ソ ッ ド は、 指定 さ れたパ フ ォ ーマ ン ス ロ グ タ イ プで使用可能な リ ソ ー ス を取得 し ま す。
URL の例
https://10.1.39.127/restapi/16/<token>/performance/resources/type/<type>
要求デー タ
NAME
type
TYPE
注意
文字列
パ フ ォ ーマ ン ス ロ グ タ イ プ
の名前
URL 要求のサン プ
curl -k -X GET --url 'https://10.10.15.181/restapi/16/<token>/performance/resources/type/bricks' -H "Accept: application/json"
応答デー タ
NAME
TYPE
注意
type
文字列
パ フ ォ ーマ ン ス ロ グ タ イ プの
名前
resources
配列
指定 さ れた タ イ プで使用可
能な リ ソ ー ス の配列
JSON 応答のサン
"data":{"type":"bricks","resources":["all","ssb1","ssb2"]}
依存関係
使用可能なパ フ ォ ーマ ン ス ロ グ タ イ プの リ ス ト は、 PERFORMANCE – TYPES の API メ ソ ッ ド
に よ っ て取得で き ま す。
注意
•
こ の API メ ソ ッ ド の呼び出 し を使用す る 際に、 ト ー ク ン を URI で提示す る 必要があ り ます。
Cisco UCS Invicta API ガ イ ド 、 v1.6
2-66
第2章
API メ ソ ッ ド
PERFORMANCE – [DATA] (GET)
PERFORMANCE – [DATA] (GET)
メ ソ ッ ド名
パ フ ォ ーマ ン ス
デバイ ス
Cisco UCS Invicta ス ケー リ ン グ シ ス テ ム、 Cisco UCS Invicta ア プ ラ イ ア ン ス
HTTP メ ソ ッ ド
GET
構文
こ の メ ソ ッ ド は、 指定 さ れた タ イ プ と リ ソ ー ス のデー タ を取得 し ま す。
URL の例
https://10.1.39.127/restapi/16/<token>/performance/data/type/
<type>/name/<name>/start/<start>/finish/<finish>/format/<format>
要求デー タ
NAME
type
TYPE
注意
文字列
パ フ ォ ーマ ン ス ロ グ タ イ プの
名前
name
文字列
リ ソ ー ス の名前
start
日時
次の形式で指定す る 時間範囲
の開始時間
“yyyy-mm-dd HH:MM:ss”
finish
日時
次の形式で指定す る 時間範囲
の終了時間
“yyyy-mm-dd HH:MM:ss”
format
文字列
オプ シ ョ ン パ ラ メ ー タ です。
次の戻 り 値の形式を指定 し
ま す。
raw、 json、 zip
URL 要求のサン プ
curl -k -X GET --url 'https://10.10.15.181/restapi/16/<token>/
performance/data/type/bricks/name/all/start/2013-08-02%2012:33:00/finish/2013-08-02%2012:34:00/format/raw' -H 'Accept: application/json'
応答デー タ
応答デー タ は、 要求 さ れたパフ ォ ーマ ン ス ロ グ タ イ プお よ び戻 り 値の形式に よ っ て異な り ます。
Type ： bricks、 luns
Format ： raw
Cisco UCS Invicta API ガ イ ド 、 v1.6
2-67
第2章
API メ ソ ッ ド
PERFORMANCE – [DATA] (GET)
応答デー タ ：
NAME
TYPE
注意
配列
未加工デー タ の配列
形式 ：
Unixdatetime、 MBs、 IOPS、 Latency
JSON 応答のサ ン プル
"data":"["1375461181,0.0,0.0,0.00","1375461186,0.0,0.0,0.00","1375461191
,0.0,0.0,0.00","1375461196,0.0,0.0,0.00","1375461201,0.0,0.0,0.00","1375
461206,0.0,0.0,0.00","1375461211,0.0,0.0,0.00","1375461216,0.0,0.0,0.00"
,"1375461221,0.0,0.0,0.00","1375461226,0.0,0.0,0.00","1375461231,0.0,0.0
,0.00","1375461236,0.0,0.0,0.00"]"
Type ： networkphysical、 networkvirtual
Format ： raw
応答デー タ ：
NAME
TYPE
注意
配列
未加工デー タ の配列
形式 ：
Unixdatetime、 rxpck、 txpck、 rxkb、 txkb
JSON 応答のサ ン プル
"data":"["1375288381,10.0,3.0,0.5,0.0","1375288386,11.0,3.0,0.5,0.0","13
75288391,7.0,3.0,0.0,0.0","1375288396,6.5,3.0,0.0,0.0","1375288401,7.0,3
.0,0.0,0.0","1375288406,5.5,3.0,0.0,0.0","1375288411,9.0,3.0,0.5,0.0","1
375288416,11.5,3.0,0.5,0.0","1375288421,6.5,3.0,0.0,0.0","1375288426,4.0
,3.0,0.0,0.0","1375288431,6.0,3.0,0.0,0.0","1375288436,8.5,3.0,0.0,0.0"]
"
Type ： bricks、 luns
Format ： json
応答デー タ ：
TYPE
注意
配列
Unix 形式での日時
NAME
TYPE
注意
mbs
Float
iops
Float
latency
Float
NAME
配列項目の構造 ：
Cisco UCS Invicta API ガ イ ド 、 v1.6
2-68
第2章
API メ ソ ッ ド
PERFORMANCE – [DATA] (GET)
JSON 応答のサ ン プル
"data":"{"1375461181":{"mbs":0,"iops":0,"latency":0},"1375461186":{"mbs"
:0,"iops":0,"latency":0},"1375461191":{"mbs":0,"iops":0,"latency":0},"13
75461196":{"mbs":0,"iops":0,"latency":0},"1375461201":{"mbs":0,"iops":0,
"latency":0},"1375461206":{"mbs":0,"iops":0,"latency":0},"1375461211":{"
mbs":0,"iops":0,"latency":0},"1375461216":{"mbs":0,"iops":0,"latency":0}
,"1375461221":{"mbs":0,"iops":0,"latency":0},"1375461226":{"mbs":0,"iops
":0,"latency":0},"1375461231":{"mbs":0,"iops":0,"latency":0},"1375461236
":{"mbs":0,"iops":0,"latency":0}}"
Type ： networkphysical、 networkvirtual
Format ： json
応答デー タ ：
TYPE
注意
配列
Unix 形式での日時
NAME
TYPE
注意
rxpck
Float
txpck
Float
rxkb
Float
txkb
Float
NAME
配列項目の構造 ：
JSON 応答のサ ン プル
"data":"{"1375288381":{"rxpck":10,"txpck":3,"rxkb":0.5,"txkb":0},"137528
8386":{"rxpck":11,"txpck":3,"rxkb":0.5,"txkb":0},"1375288391":{"rxpck":7
,"txpck":3,"rxkb":0,"txkb":0},"1375288396":{"rxpck":6.5,"txpck":3,"rxkb"
:0,"txkb":0},"1375288401":{"rxpck":7,"txpck":3,"rxkb":0,"txkb":0},"13752
88406":{"rxpck":5.5,"txpck":3,"rxkb":0,"txkb":0},"1375288411":{"rxpck":9
,"txpck":3,"rxkb":0.5,"txkb":0},"1375288416":{"rxpck":11.5,"txpck":3,"rx
kb":0.5,"txkb":0},"1375288421":{"rxpck":6.5,"txpck":3,"rxkb":0,"txkb":0}
,"1375288426":{"rxpck":4,"txpck":3,"rxkb":0,"txkb":0},"1375288431":{"rxp
ck":6,"txpck":3,"rxkb":0,"txkb":0},"1375288436":{"rxpck":8.5,"txpck":3,"
rxkb":0,"txkb":0}}"
Type ： any
Format ： zip
応答デー タ ：
NAME
TYPE
注意
file
文字列
フ ァ イ ル名
JSON 応答のサ ン プル
"data":"{"file":"perf_bricks_all_20130802123300_20130802123400.log.gz"}"
zip フ ァ イ ル を取得す る には、 FILE API メ ソ ッ ド を使用 し ま す。
Cisco UCS Invicta API ガ イ ド 、 v1.6
2-69
第2章
API メ ソ ッ ド
PERFORMANCE – [DATA] (GET)
依存関係
使用可能なパ フ ォ ーマ ン ス ロ グ タ イ プの リ ス ト は、 PERFORMANCE – TYPES の API メ ソ ッ ド
に よ っ て取得で き ま す。
使用可能な リ ソ ース は、 PERFORMANCE – RESOURCES の API メ ソ ッ ド に よ っ て取得で き ます。
注意
•
こ の API メ ソ ッ ド の呼び出 し を使用す る 際に、 ト ー ク ン を URI で提示す る 必要があ り ます。
•
リ ソ ー ス 名の LUN が <vgname>/<lunname> の形式で返 さ れ る 場合、 ス ラ ッ シ ュ 文字を置 き
換え る 必要があ り ま す （JSON 形式の “vg1\/lun1” では ス ラ ッ シ ュ 文字はエ ス ケープ さ れ
る ）。 こ の場合、 URL 符号化は動作 し ま せん。 こ れは、 URL が内部で処理 さ れ る と き に、
‘%2F’ シーケ ン ス は ‘/’ （ ス ラ ッ シ ュ ） にすでに変換 し 直 さ れ、 シ ス テ ム が応答処理のた
めに存在 し ない場所に要求を転送 し よ う と す る ためです。
こ のため、 次の例では、 ‘/’ （ ス ラ ッ シ ュ ） を置 き 換え る 文字 と し て ‘~’ （チルダ） が選択
さ れ ま し た。
‘vg1/lun1’ lun-resource name
Cisco UCS Invicta API ガ イ ド 、 v1.6
2-70
“vg1~lun1”
第2章
API メ ソ ッ ド
FILE (GET)
FILE (GET)
メ ソ ッ ド名
file
デバイ ス
Cisco UCS Invicta ス ケー リ ン グ シ ス テ ム、 Cisco UCS Invicta ア プ ラ イ ア ン ス
HTTP メ ソ ッ ド
GET
HTTP ヘ ッ ダー
Accept: application/octet-stream
構文
こ の メ ソ ッ ド は、 フ ァ イ ル を ダ ウ ン ロ ー ド し ま す。
URL の例
https://10.1.39.127/restapi/16/<token>/file/<filename>
要求デー タ
NAME
filename
TYPE
注意
文字列
zip 形式が指定 さ れた場合
の、 PERFORMANCE – DATA
か ら の フ ァ イ ル名
URL 要求のサン プ
curl -k -O -X GET --url 'https://10.10.15.181/restapi/16/<token>/file/perf_bricks_all_20130802123300_20130802123400.log.gz' -H "Accept: application/octet-stream"
応答デー タ
バ イ ナ リ デー タ を ス ト リ ーム し ま す。
依存関係
使用可能なパ フ ォ ーマ ン ス ロ グ タ イ プの リ ス ト は、 デー タ 形式を zip と し て指定 し た、
PERFORMANCE – DATA の API メ ソ ッ ド に よ っ て取得で き ま す。
注意
•
こ の API メ ソ ッ ド の呼び出 し を使用す る 際に、 ト ー ク ン を URI で提示す る 必要があ り ます。
•
ソ ース と 同 じ フ ァ イ ル名を受け入れ る には、 curl オプシ ョ ン –O を指定す る 必要があ り ます。
Cisco UCS Invicta API ガ イ ド 、 v1.6
2-71
第2章
API メ ソ ッ ド
Status Codes
Status Codes
表 2-2 は、 ス テー タ ス コ ー ド を リ ス ト し ま す。
表 2-2
ステー タ ス コ ー ド
コード
MESSAGE
1
OK。
2
OK ： 廃止 さ れた メ ソ ッ ド 。
100
無効なデー タ 形式。
101
<function> REST メ ソ ッ ド では、 HTTP メ ソ ッ ド <type> はサポー ト さ れていな
い。
102
ク レ デン シ ャ ルが無効で あ る 。
103
不十分な権限。
104
予期 さ れていない呼び出 し 。
105
内部 API エ ラ ー。
106
こ のデバ イ ス タ イ プではサポー ト さ れていない メ ソ ッ ド 。
107
リ ソ ー ス が検出 さ れない。
121
<function> の検証に失敗 し てい る 。 <primitive> が正 し いデー タ タ イ プ/形
式で あ る こ と を確認す る 。
320
イ ニ シ エー タ グループの削除に失敗 し た。
321
無効な イ ニ シ エー タ グループ ID。
322
イ ニ シ エー タ グループの作成に失敗 し た。
323
イ ニ シ エー タ グループ ID はすで存在 し てい る 。
324
イ ニ シ エー タ が無効で あ る 。
325
イ ニ シ エー タ の追加に失敗 し た。
326
イ ニ シ エー タ の削除に失敗 し た。
327
LUN ま たは NFS ボ リ ュ ーム がボ リ ュ ーム グループに存在 し てい る 。 ボ リ ュ ーム
グループの削除に失敗 し た。
328
ボ リ ュ ーム グループは存在 し ない。 ボ リ ュ ーム グループの削除に失敗 し た。
329
ボ リ ュ ーム グループの削除に失敗 し た。
330
パー ト ナーが ロ ッ ク を保持 し てい る 。 ボ リ ュ ーム グループの作成に失敗 し た。
331
ボ リ ュ ーム グループの作成に失敗 し た。
332
ボ リ ュ ーム グループ名の変更に失敗 し た。
333
無効な ボ リ ュ ーム グループ。 LUN の作成に失敗 し た。
334
無効なデバ イ ス グループ。 LUN の作成に失敗 し た。
335
こ の LUN は ス ト ラ イ プで き ない。 LUN の作成に失敗 し た。
336
LUN 名は使用で き ない。 LUN の作成に失敗 し た。
Cisco UCS Invicta API ガ イ ド 、 v1.6
2-72
第2章
API メ ソ ッ ド
Status Codes
表 2-2
ステー タ ス コ ー ド （続き）
337
LUN は存在 し ない。 LUN の削除に失敗 し た。
338
量はゼ ロ 以上で あ る 必要が あ る 。 LUN の更新に失敗 し た。
339
LUN の更新に失敗 し た。
340
イ ニ シ エー タ グループは存在 し ない。
341
無効な ボ リ ュ ーム グループ。 LUN の ミ ラ ー化に失敗 し た。
342
LUN の ミ ラ ー化に失敗 し た。
343
LUN 名は使用で き ない。 LUN の ミ ラ ー化に失敗 し た。
344
LUN マ ッ ピ ン グ の作成に失敗 し た。 作成 し よ う と し てい る 特定のマ ッ ピ ン グ がす
でに存在 し てい る 可能性が あ る 。
345
指定 さ れた LUN 名は存在 し ない。
346
指定 さ れた ID は無効で あ る 。
347
指定 さ れた イ ニ シ エー タ グループに イ ニ シ エー タ がない。
348
LUN ミ ラ ーの削除に失敗 し た。
349
マ ッ プ解除 し よ う と し てい る LUN は、 指定 さ れた グループにマ ッ プ さ れていな
い。
350
空いてい る 次の mapID を取得で き ない。
351
到達不能な IP。 パー ト ナー IP を変更で き ない。
352
パー ト ナー IP を変更で き ない。
353
使用可能な IP ア ド レ ス がない。 接合の作成に失敗 し た。
354
接合の作成に失敗 し た。
355
無効な接合。 接合の削除に失敗 し た。
356
接合の削除に失敗 し た。
357
接合が検出で き ない。 接合の更新に失敗 し た。
358
接合の更新に失敗 し た。
359
無効な接合。 VLAN の作成に失敗 し た。
360
VLAN の作成に失敗 し た。
361
VLANID は使用で き ない。 VLAN の作成に失敗 し た。
362
ス レ ーブ化を試みた ア ク シ ョ ン を実行で き ない。
363
要求が予期 さ れてい る 使用方法 と 一致 し ない。 使用方法 ： createBondedEth
<bond> <eth>.
364
タ ーゲ ッ ト の イ ーサネ ッ ト イ ン タ ー フ ェ イ ス が使用中で あ る 。 再試行す る 前に、
イ ン タ ー フ ェ イ ス が使用中で ない こ と を確認す る 。
365
指定 さ れた イ ーサネ ッ ト イ ン タ ー フ ェ イ ス は存在 し ない。
366
指定 さ れた接合 イ ン タ ー フ ェ イ ス は存在 し ない。
367
ス レーブ化ア ク シ ョ ンが認識 さ れない。期待 さ れ る ア ク シ ョ ンは < add | remove
> であ る。
368
ポー タ ルはすでに許可 さ れてい る 。
369
ポー タ ルは存在 し ない。
Cisco UCS Invicta API ガ イ ド 、 v1.6
2-73
第2章
API メ ソ ッ ド
Status Codes
表 2-2
ステー タ ス コ ー ド （続き）
370
使用可能な IP ア ド レ ス がない。 接合の更新に失敗 し た。
371
パ ラ メ ー タ が無効で あ る 。
372
要求 さ れた接合ア ク シ ョ ン を実行で き ない。 接合は DELETE ま たは PUT 要求に
存在 し 、 POST に存在 し ない こ と を検証す る 。
373
ユーザの更新に失敗 し た。
375
デバ イ ス は存在 し ない。
376
LUN は存在 し ない。
377
送信先のボ リ ュ ーム グループに十分な ス ペー ス がない。
378
ピ ア に接続で き ない。 あ と で も う 一度実行 し て く だ さ い。 .
379
LUN ミ ラ ーの破棄に失敗 し た ： こ の LUN には破棄す る ミ ラ ーがない。
380
シ リ アル番号を検索で き ない。
381
FIND が失敗 し た。 apiVersion を取得で き ない。
382
FIND が失敗 し た。 unitId を取得で き ない。
383
FIND が失敗 し た。 device を取得で き ない。
384
FIND が失敗 し た。 boxSerial を取得で き ない。
385
使用可能な IP ア ド レ ス がない。 仮想 イ ン タ ー フ ェ イ ス の作成に失敗 し た。
386
LUN が ミ ラ ー リ ン グ さ れてい る 。 LUN の更新に失敗 し た。
387
IP はすでに使用中で あ る 。 VLAN の更新に失敗 し た。
388
エ ラ ーが発生 し ま し た。 VLAN での ア ク シ ョ ン の実行に失敗 し た。
389
IP はすでに使用中で あ る 。 VLAN の追加に失敗 し た。
390
Map ID 0 は も う す ぐ 削除 さ れ る 。 LUN 0 の リ マ ッ プに失敗す る と 、 イ ニ シエー タ
の問題が発生す る 。 force_mapid0_delete パ ラ メ ー タ を使用 し て、 こ の LUN のマ ッ
ピ ン グ を強制的に解除す る 。
Cisco UCS Invicta API ガ イ ド 、 v1.6
2-74