Cisco UCS Invicta API ガイド バージョン 1.6
API メソッド
API メソッド
発行日;2015/02/18 | ドキュメントご利用ガイド | ダウンロード ; この章pdf , ドキュメント全体pdf (PDF - 955KB) | フィードバック

目次

API メソッド

API セクション規定

FIND (Get)

AUTHENTICATE (POST)

USER (GET)

USER (PUT)

UNITINFO (GET)

UNITNAME (GET)

UNITNAME (PUT)

MODEL (GET)

RAIDHEALTH (GET)

SSN (GET)

VOLUMEGROUP (GET)

VOLUMEGROUP (POST)

VOLUMEGROUP (DELETE)

ISCSIAVAILABLE (GET)

ISCSIAVAILABLE (PUT)

ISCSIALLOWED (GET)

ISCSIALLOWED (PUT)

LUN (GET)

LUN (POST)

LUN (PUT)

LUN (DELETE)

LUNMIRROR (POST)

LUNMIRROR (DELETE)

TOTALSPACE (GET)

INITIATORGROUP (GET)

INITIATORGROUP (POST)

INITIATORGROUP (DELETE)

INITIATOR (POST)

INITIATOR (DELETE)

MAPLUN (POST)

MAPLUN (DELETE)

MAPLUNAUTO (POST)

WWN (GET)

IQN (GET)

INTERFACES (GET)

PHYSICALINTERFACES (GET)

BOND (POST)

BOND (PUT)

BOND (DELETE)

TOGGLEBOND (PUT)

ENSLAVE (PUT)

VLAN (POST)

VLAN (PUT)

VLAN (DELETE)

VIRTUALINTERFACE (POST)

VIRTUALINTERFACE (PUT)

VIRTUALINTERFACE (DELETE)

PERFORMANCE - [TYPES] (GET)

PERFORMANCE - [RESOURCES] (GET)

PERFORMANCE - [DATA] (GET)

FILE (GET)

Status Codes

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 と置き換えます。

要求/応答データ

各メソッドの説明での要求と応答のデータ セクションは、返されるエンベロープのデータ部分のみが対象になります。すべてのプリミティブのデータ型は、次のページに示されているように、メソッドの詳細に応じて一致する必要があります。

応答データが配列タイプの場合、(1 次元でない限り)さらに説明されます。

JSON のサンプル

データ出力の JSON のサンプルは、必要に応じてマニュアルに追加されます。

依存関係

各メソッドにリストされている依存関係は、メソッドを正しく動作させるために必要なデバイスまたはオブジェクトです。

注意

メモは、メソッドのさまざまな部分を明確に説明するための追加コメントです。

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
TYPE
注意

unitId

文字列

デバイスのシリアル番号

apiVersion*

配列

文字列の配列

デバイス

文字列

デバイスが Cisco UCS Invicta スケーリング システムまたは Cisco UCS Invicta アプライアンスであるかどうかの情報

boxSerial

文字列

ボックスのシリアル番号

rrVersion

文字列

現在インストールされている RaceRunner ソフトウェアのバージョン

 

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 を使用できます。

AUTHENTICATE (POST)

メソッド名

authenticate

デバイス

Cisco UCS Invicta スケーリング システム、Cisco UCS Invicta アプライアンス

HTTP メソッド

POST

構文

このメソッドは、利用可能な多くの API メソッドを実行する際に使用できる 32 ビットのトークンを返します。トークンは最大で 1 時間有効です。

URL の例

https://10.1.39.127/restapi/16/authenticate

要求データ

 

NAME
TYPE
注意

username

文字列

必須

password

文字列

必須

JSON のサンプル

'{"username":"jdoe", "password":"password"}'

応答データ

 

 

NAME
TYPE
注意

token

文字列

特定の API 呼び出しを実行する際に、合わせて使用されます。

JSON のサンプル

"data":{"token":"1234567890xxxxxxxxxxxxxxxxxxxxx"}

依存関係

n/a

注意

この API メソッドの呼び出しを使用する際に、トークンは不要です。

この API メソッドの呼び出しを実行する際に、着信データが必要です。

トークンは、時間切れになるまで何回でも利用できます。

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":"jdoe@domain.com", “username”, “joedoe”}

依存関係

n/a

注意

この API メソッドの呼び出しを使用する際に、トークンを URI で提示する必要があります。

この API メソッドの呼び出しを実行する際に、着信データは不要です。

USER (PUT)

メソッド名

user

デバイス

Cisco UCS Invicta スケーリング システム、Cisco UCS Invicta アプライアンス

HTTP メソッド

PUT

構文

現在のユーザのユーザ情報を変更します。

URL の例

https://10.1.39.127/restapi/16/<token>/user

要求データ

 

NAME
TYPE
注意

first_name

文字列

システムに記録されるユーザの名

last_name

文字列

システムに記録されるユーザの姓

email_address

文字列

システムに記録されるユーザの電子メール アドレス

password

文字列

ユーザのパスワード

JSON のサンプル

{"password":”xxxxx”}

応答データ

 

NAME
TYPE
注意

n/a

依存関係

n/a

注意

この API メソッドの呼び出しを使用する際に、トークンを URI で提示する必要があります。

この API メソッドの呼び出しを実行する際に、着信データが必要です。

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
TYPE
注意

modelName

文字列

デバイス モデルの名前

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

注意

この API メソッドの呼び出しを使用する際に、トークンを URI で提示する必要があります。

この API メソッドの呼び出しを実行する際に、着信データは不要です。

UNITNAME (GET)

メソッド名

unitname

デバイス

Cisco UCS Invicta スケーリング システム、Cisco UCS Invicta アプライアンス

HTTP メソッド

GET

構文

このメソッドは、ストレージ デバイスのユニット名を返します。

URL の例

https://10.1.39.127/restapi/16/<token>/unitname

要求データ

NAME
TYPE
注意

n/a

応答データ

NAME
TYPE
注意

unitName

文字列

ホスト名

JSON のサンプル

"data":{"unitName":"SSRA"}

依存関係

n/a

注意

この API メソッドの呼び出しを使用する際に、トークンを URI で提示する必要があります。

この API メソッドの呼び出しを実行する際に、着信データは不要です。

UNITNAME (PUT)

メソッド名

unitname

デバイス

Cisco UCS Invicta スケーリング システム、Cisco UCS Invicta アプライアンス

HTTP メソッド

PUT

構文

このメソッドは、ストレージ デバイスのユニット名を変更します。

URL の例

https://10.1.39.127/restapi/16/<token>/unitname/0

要求データ

NAME
TYPE
注意

unitName

文字列

新しいホスト名(必須)

JSON のサンプル

{"unitName":”HeadOne”}

応答データ

NAME
TYPE
注意

n/a

依存関係

n/a

注意

この API メソッドの呼び出しを使用する際に、トークンを URI で提示する必要があります。

この API メソッドの呼び出しを実行する際に、着信データが必要です。

文字列 unitName には、15 文字以内の英数字およびダッシュとピリオドが使用できます。


) 重要:API アプリケーションの PUT 規格に従い、ゼロ(0)が URI の一部として含まれています。パラメータが不十分な場合、要求は失敗します。


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
TYPE
注意

modelName

文字列

デバイス モデルの名前

JSON のサンプル

"data":{"modelName":"INVICTA"}

依存関係

n/a

注意

この API メソッドの呼び出しを使用する際に、トークンを URI で提示する必要があります。

この API メソッドの呼び出しを実行する際に、着信データは不要です。

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
TYPE
注意

raids

配列

下記の説明を参照

nodes

配列

Raids には、実際の RAID ユニットの名前と同一の配列キーがあります。これらのキー内に、RAID に関する情報としての次のデータがあります。

NAME
TYPE
注意

name

文字列

status

文字

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

注意

この API メソッドの呼び出しを使用する際に、トークンを URI で提示する必要があります。

この API メソッドの呼び出しを実行する際に、着信データは不要です。

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
TYPE
注意

name

文字列

SSN の名前

allocation_status

ブール

SSN が割り当てられているかどうか

allocated_vg

文字列||Null

SSN が割り当てられた VG の名前

JSON のサンプル

"data":[{"name":"SSN1","allocation_status":true,"allocated_vg":"vg1"}]

依存関係

n/a

注意

この API メソッドの呼び出しを使用する際に、トークンを URI で提示する必要があります。

この API メソッドの呼び出しを実行する際に、着信データは不要です。

VOLUMEGROUP (GET)

メソッド名

volumegroup

デバイス

Cisco UCS Invicta スケーリング システム

HTTP メソッド

GET

構文

一連のすべてのボリューム グループを、名前、サイズ、空きスペース、SSN とステータスのリストと共に返します。

URL の例

https://10.1.39.127/restapi/16/<token>/volumegroup

要求データ

NAME
TYPE
注意

n/a

応答データ

NAME
TYPE
注意

配列

ボリューム グループ オブジェクトの配列

ボリューム グループ オブジェクト

NAME
TYPE
注意

name

文字列

ボリューム グループの名前

size

Float

ボリューム グループの合計サイズ(GB)

size_available

Float

ボリューム グループの合計空きスペース(GB)

ssns

配列

すべてのバウンド SSN の配列

status

文字列

ボリューム グループのステータス

JSON のサンプル

"data":[{"name":"vg1","size":100000,"size_available":80000,"ssns":["ssn1","ssn2"],"status":"good"}]

依存関係

n/a

注意

この API メソッドの呼び出しを使用する際に、トークンを URI で提示する必要があります。

この API メソッドの呼び出しを実行する際に、着信データは不要です。

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 メソッドの呼び出しを実行する際に、着信データが必要です。

VOLUMEGROUP (DELETE)

メソッド名

volumegroup

デバイス

Cisco UCS Invicta スケーリング システム

HTTP メソッド

DELETE

構文

ボリューム グループを削除します。

URL の例

https://10.1.39.127/restapi/16/<token>/volumegroup/<existing target volume group>

要求データ

NAME
TYPE
注意

n/a

応答データ

NAME
TYPE
注意

n/a

依存関係

n/a

注意

この API メソッドの呼び出しを使用する際に、トークンを URI で提示する必要があります。

この API メソッドの呼び出しを実行する際に、着信データは不要です。

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
TYPE
注意

ip

配列

IP 情報オブジェクトの配列

JSON のサンプル

"data": {"ip":["10.127.15.135","192.168.3.17"]}

依存関係

n/a

注意

この API メソッドの呼び出しを使用する際に、トークンを URI で提示する必要があります。

この API メソッドの呼び出しを実行する際に、着信データは不要です。

ISCSIAVAILABLE (PUT)

メソッド名

iscsiavailable

デバイス

Cisco UCS Invicta スケーリング システム、Cisco UCS Invicta アプライアンス

HTTP メソッド

PUT

構文

有効な IP アドレスを「利用可能」に追加し、これらを「許可」から削除します。

URL の例

https://10.1.39.127/restapi/16/<token>/iscsiavailable/0

要求データ

NAME
TYPE
注意

ip

文字列

IP アドレス

JSON のサンプル

{"ip": "10.127.15.135"}

応答データ

NAME
TYPE
注意

n/a

依存関係

n/a

注意

この API メソッドの呼び出しを使用する際に、トークンを URI で提示する必要があります。


) 重要:API アプリケーションの PUT 規格に従い、ゼロ(0)が URI の一部として含まれています。パラメータが不十分な場合、要求は失敗します。


 

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
TYPE
注意

ip

配列

IP アドレスの配列

JSON のサンプル

"data": {"ip" : ["10.127.15.207", "192.168.3.18"]}

依存関係

n/a

注意

この API メソッドの呼び出しを使用する際に、トークンを URI で提示する必要があります。

この API メソッドの呼び出しを実行する際に、着信データは不要です。

ISCSIALLOWED (PUT)

メソッド名

iscsiallowed

デバイス

Cisco UCS Invicta スケーリング システム、Cisco UCS Invicta アプライアンス

HTTP メソッド

PUT

構文

有効な IP アドレスを「許可」に追加し、これらを「利用可能」から削除します。

URL の例

https://10.1.39.127/restapi/16/<token>/iscsiallowed/0

要求データ

NAME
TYPE
注意

ip

文字列

IP アドレス

JSON のサンプル

{"ip":"10.127.15.162"}

応答データ

NAME
TYPE
注意

n/a

依存関係

n/a

注意

この API メソッドの呼び出しを使用する際に、トークンを URI で提示する必要があります。


) 重要:API アプリケーションの PUT 規格に従い、ゼロ(0)が URI の一部として含まれています。パラメータが不十分な場合、要求は失敗します。


 

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
TYPE
注意

luns

配列

LUN レコードには、ボリューム グループとダッシュ記号(‘-‘)で結合した実際の LUN 名で構成された配列キーがあります。各レコードには、次の LUN 詳細情報が含まれています。

NAME
TYPE
注意

name

文字列

LUN 名

t10id

文字列

LUN T10ID 文字列

lunid

文字列

LUN ID

size

整数

LUN サイズ

volumegroup

文字列

この LUN が属しているボリューム グループ名

mirror

文字列

ミラーリングの一方の名前(該当する場合)

origin

文字列

スナップショットが関連付けられている元のボリューム名または LUN。スナップショット ボリューム以外の場合、‘-‘ を返します。

snap_pct

文字列

使用しているスナップショット ボリュームの現在の割合を示します。スナップショット ボリューム以外の場合、‘-‘ を返します。

NAME
TYPE
注意

created

文字列

スナップショットがいつ作成されたかを示します。スナップショット ボリューム以外の場合、‘-‘ を返します。

adminStatus

整数

0 - オフライン

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":{"name":"L3","lunid":"198790e0-L3","t10id":"198790e0-L3","size":20,"volumegroup":"VG1","mirror":"","origin":"-","snap_pct":"-","created":"1409164250","adminStatus":"1"}}}

依存関係

n/a

注意

この API メソッドの呼び出しを使用する際に、トークンを URI で提示する必要があります。

LUN (POST)

メソッド名

lun

デバイス

Cisco UCS Invicta スケーリング システム、Cisco UCS Invicta アプライアンス

HTTP メソッド

POST

構文

このメソッドは、デバイスに新しい LUN を作成します。

URL の例

https://10.1.39.127/restapi/16/<token>/lun

要求データ

NAME
TYPE
注意

name

文字列

LUN 名(必須)

vg

文字列

ボリューム グループ名(必須)

size

整数

LUN サイズ(必須)

GB 単位の値

striping

ブール

任意

このプロパティは、Cisco UCS Invicta C3124SA アプライアンスでは無視されます

JSON のサンプル

'{"name":"lun1", "vg":"vg1", "size":10}'

 

 

応答データ

NAME
TYPE
注意

n/a

依存関係

n/a

注意

この API メソッドの呼び出しを使用する際に、トークンを URI で提示する必要があります。

サイズはギガバイト(GB)単位で指定する必要があります。例:2 = 2 GB。

LUN (PUT)

メソッド名

lun

デバイス

Cisco UCS Invicta スケーリング システム、Cisco UCS Invicta アプライアンス

HTTP メソッド

PUT

構文

このメソッドは、デバイスの LUN サイズを増大させます。

URL の例

https://10.1.39.127/restapi/16/<token>/lun/<name>

要求データ

NAME
TYPE
注意

size

整数

GB 単位の値

前の値よりも小さくすることはできません

JSON のサンプル

{“size”:1234}

応答データ

NAME
TYPE
注意

n/a

依存関係

n/a

注意

この API メソッドの呼び出しを使用する際に、トークンを URI で提示する必要があります。

URI で提示した <name> は、変更する必要がある LUN の一意の名前です。

サイズ(GB)は、前の値よりも小さくすることはできません。

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 を削除することをお勧めします。

LUNMIRROR (POST)

メソッド名

lunmirror

デバイス

Cisco UCS Invicta スケーリング システム

HTTP メソッド

POST

構文

既存の LUN のミラーを作成します。

URL の例

https://10.1.39.127/restapi/16/<token>/lunmirror

要求データ

NAME
TYPE
注意

lun

文字列

ミラーされる LUN

mirror

文字列

ミラーの結果としての新しい LUN の名前

vg

文字列

元の LUN が使用する VG とは異なる使用可能な VG の名前

JSON のサンプル

'{"lun":"lun1", "mirror":"lun1mirror", "vg":"vg1"}'

応答データ

NAME
TYPE
注意

n/a

依存関係

n/a

注意

この API メソッドの呼び出しを使用する際に、トークンを URI で提示する必要があります。

LUN のサイズによっては、この呼び出しから応答を受信するのに時間がかかる場合があります。

LUNMIRROR (DELETE)

メソッド名

lunmirror

デバイス

Cisco UCS Invicta スケーリング システム

HTTP メソッド

DELETE

構文

LUN ミラーを破棄します。

URL の例

https://10.1.39.127/restapi/16/<token>/lunmirror/<lun id>

要求データ

NAME
TYPE
注意

breakMode

文字列

破棄モード:

keep - ミラーを破棄し、両方の LUN を維持する

deleteTarget - ミラーを破棄し、ミラー先の LUN を削除する

deleteSource - ミラーを破棄し、ミラー元の LUN を削除する

JSON のサンプル

‘{"breakMode":"deleteTarget"}'

応答データ

NAME
TYPE
注意

n/a

依存関係

n/a

注意

この API メソッドの呼び出しを使用する際に、トークンを URI で提示する必要があります。

この API メソッドの呼び出しを実行する際に、着信データは不要です。

この呼び出しでは、LUN ミラー名ではなく LUN 名が渡されます。

TOTALSPACE (GET)

メソッド名

totalspace

デバイス

Cisco UCS Invicta スケーリング システム、Cisco UCS Invicta アプライアンス

HTTP メソッド

GET

構文

このメソッドは、デバイス全体での合計空きスペースを返します。

URL の例

https://10.1.39.127/restapi/16/<token>/totalspace

要求データ

NAME
TYPE
注意

n/a

応答データ

NAME
TYPE
注意

配列

すべてのボリューム グループのリスト

name

文字列

freeSpace

整数

GB で計算される

JSON のサンプル

"data":[{"name":"vg1","freeSpace":"822"},{"name":"vg2","freeSpace":"818"}]

依存関係

n/a

注意

この API メソッドの呼び出しを使用する際に、トークンを URI で提示する必要があります。

この API メソッドの呼び出しを実行する際に、着信データは不要です。

INITIATORGROUP (GET)

メソッド名

initiatorgroup

デバイス

Cisco UCS Invicta スケーリング システム、Cisco UCS Invicta アプライアンス

HTTP メソッド

GET

構文

このメソッドは、すべてのイニシエータと割り当てられた LUN のリストと共に、すべてのイニシエータ グループを返します。

URL の例

https://10.1.39.127/restapi/16/<token>/initiatorgroup

要求データ

NAME
TYPE
注意

n/a

応答データ

NAME
TYPE
注意

配列

すべてのイニシエータ グループのリスト

name

文字列

イニシエータ グループ名

initiators

文字列の配列

この特定のイニシエータ グループに属しているすべてのイニシエータのリスト

luns

文字列の配列

この特定のイニシエータ グループに割り当てられるすべての LUN のリスト

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 メソッドの呼び出しを実行する際に、着信データは不要です。

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 メソッドの呼び出しを実行する際に、着信データが必要です。

INITIATORGROUP (DELETE)

メソッド名

initiatorgroup

デバイス

Cisco UCS Invicta スケーリング システム、Cisco UCS Invicta アプライアンス

HTTP メソッド

DELETE

構文

このメソッドは、デバイスからイニシエータ グループを削除します。

URL の例

https://10.1.39.127/restapi/16/<token>/initiatorgroup/<group>

要求データ

NAME
TYPE
注意

n/a

応答データ

NAME
TYPE
注意

n/a

依存関係

n/a

注意

この API メソッドの呼び出しを使用する際に、トークンを URI で提示する必要があります。

<group> は、デバイスから削除するイニシエータ グループの一意の名前です。

INITIATOR (POST)

メソッド名

発信側

デバイス

Cisco UCS Invicta スケーリング システム、Cisco UCS Invicta アプライアンス

HTTP メソッド

POST

構文

このメソッドは、デバイスのイニシエータ グループでイニシエータを作成します。

URL の例

https://10.1.39.127/restapi/16/<token>/initiator

要求データ

NAME
TYPE
注意

name

文字列

必須

イニシエータ グループの名前

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 進表記

INITIATOR (DELETE)

メソッド名

initiator

デバイス

Cisco UCS Invicta スケーリング システム、Cisco UCS Invicta アプライアンス

HTTP メソッド

DELETE

構文

このメソッドは、デバイスのイニシエータ グループからイニシエータを削除します。

URL の例

https://10.1.39.127/restapi/16/<token>/initiator/<initiator_group>

要求データ

NAME
TYPE
注意

name

文字列

必須

JSON のサンプル

{"name":"iqn.1998-01.com.vmware:wt-lab-esx01-2229f4c5"}

応答データ

NAME
TYPE
注意

n/a

依存関係

n/a

注意

この API メソッドの呼び出しを使用する際に、トークンを URI で提示する必要があります。

name は、 <initiator_group> から削除するイニシエータを指定するイニシエータの文字列であり、URI で提示します。

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(ゼロ)以外の番号がある場合、エラーが返されます。

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
TYPE
注意

name

文字列

イニシエータ グループ名(必須)

force_mapid0_delete

ブール

任意

マップ解除される LUN に 0 の MAP ID がある場合、MAP ID 0 がマップ解除されることを示す警告が返されます。警告をオーバーライドするには、このパラメータを送信します。

JSON のサンプル

{"name":"IG123", "force_mapid0_delete":true}

応答データ

NAME
TYPE
注意

n/a

依存関係

n/a

注意

この API メソッドの呼び出しを使用する際に、トークンを URI で提示する必要があります。

name は、イニシエータ グループの一意の名前です。

lunName は、イニシエータ グループからマップ解除される LUN の一意の名前です。

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 が自動的に選択されます。

WWN (GET)

メソッド名

wwn

デバイス

Cisco UCS Invicta スケーリング システム、Cisco UCS Invicta アプライアンス

HTTP メソッド

GET

構文

このメソッドは、デバイスのワールド ワイド名(WWN)を取得します。

URL の例

https://10.1.39.127/restapi/16/<token>/wwn

要求データ

NAME
TYPE
注意

n/a

応答データ

NAME
TYPE
注意

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 で提示する必要があります。

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
TYPE
注意

iqn

文字列

iSCSI 修飾名

JSON のサンプル

"data":{"iqn.2008-07.com.WHIPTAILtech:storage"}

依存関係

n/a

注意

この API メソッドの呼び出しを使用する際に、トークンを URI で提示する必要があります。

INTERFACES (GET)

メソッド名

インターフェイス

デバイス

Cisco UCS Invicta スケーリング システム、Cisco UCS Invicta アプライアンス

HTTP メソッド

GET

構文

このメソッドは、デバイスでのすべてのインターフェイスを取得します。

URL の例

https://10.1.39.127/restapi/16/<token>/interfaces

要求データ

NAME
TYPE
注意

n/a

応答データ

NAME
TYPE
注意

interfaces*

配列

インターフェイスの配列

interfaces には、実際のインターフェイスの名前と同一の配列キーがあります。各レコードには、インターフェイスの次の詳細情報が含まれています。

NAME
TYPE
注意

name

文字列

インターフェイス名

mtu

整数

Maximum Transmission Unit:最大伝送単位

status

文字列

インターフェイス ステータス

ip

文字列

Interface IP

mac

文字列

インターフェイス MAC アドレス

mask

文字列

インターフェイス ネットワーク マスク

speed

文字列

物理デバイスの場合のみ

インターフェイス

配列

文字列の配列

論理の場合のみ(接合)

maxSpeed

文字列

物理デバイスの場合のみ

duplex

文字列

物理デバイスの場合のみ

onboot

文字列

“Yes” または “No”

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":null,"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,"virtualinterface":true,"interfaces":[],"duplex":null,"mac":"00:50:56:B1:4E:FD"},"bond100":{"name":"bond100","status":"UP","ip":"10.90.90.2","speed":"1000\/FULL","mtu":"1500","mask":"255.255.255.0","onBoot":"yes","mode":"6","maxSpeed":null,"vlan":false,"virtualinterface":false,"interfaces":["eth1"],"duplex":"FULL","mac":"00:50:56:B1:02:5A"}}}

依存関係

n/a

注意

この API メソッドの呼び出しを使用する際に、トークンを URI で提示する必要があります。

PHYSICALINTERFACES (GET)

メソッド名

physicalinterfaces

デバイス

Cisco UCS Invicta スケーリング システム、Cisco UCS Invicta アプライアンス

HTTP メソッド

GET

構文

このメソッドは、デバイスでのすべての非接合物理インターフェイスを取得します。

URL の例

https://10.1.39.127/restapi/16/<token>/physicalinterfaces

要求データ

NAME
TYPE
注意

n/a

応答データ

NAME
TYPE
注意

interfaces*

配列

インターフェイスの配列

interfaces には、実際のインターフェイスの名前と同一の配列キーがあります。各レコードには、インターフェイスの次の詳細情報が含まれています。

NAME
TYPE
注意

name

文字列

インターフェイス名

JSON のサンプル

"data":{"interfaces":[{"name":"eth5"},{"name":"eth6"}]]}

依存関係

n/a

注意

この API メソッドの呼び出しを使用する際に、トークンを URI で提示する必要があります。

BOND (POST)

メソッド名

bond

デバイス

Cisco UCS Invicta スケーリング システム、Cisco UCS Invicta アプライアンス

HTTP メソッド

POST

構文

このメソッドは、新しい接合を作成します。

URL の例

https://10.1.39.127/restapi/16/<token>/bond

要求データ

NAME
TYPE
注意

ip

文字列

接合 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
TYPE
注意

name

文字列

JSON のサンプル

"data":{"name":"bond1"}

依存関係

n/a

注意

この API メソッドの呼び出しを使用する際に、トークンを URI で提示する必要があります。

BOND (PUT)

メソッド名

bond

デバイス

Cisco UCS Invicta スケーリング システム、Cisco UCS Invicta アプライアンス

HTTP メソッド

PUT

構文

このメソッドは、既存の接合を更新します。

URL の例

https://10.1.39.127/restapi/16/<token>/bond/<bond_name>

要求データ

NAME
TYPE
注意

ip

文字列

接合 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 は、接合/デバイスの一意の名前です。

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 は、接合/デバイスの一意の名前です。

TOGGLEBOND (PUT)

メソッド名

togglebond

デバイス

Cisco UCS Invicta スケーリング システム、Cisco UCS Invicta アプライアンス

HTTP メソッド

PUT

構文

このメソッドは、接合デバイスを有効/無効にします。

URL の例

https://10.1.39.127/restapi/16/<token>/togglebond/<bond_name>

要求データ

NAME
TYPE
注意

toggleState

文字列

アクション インジケータ(必須)

enable または disable

JSON のサンプル

'{"toggleState":"enable"}'

応答データ

NAME
TYPE
注意

n/a

依存関係

n/a

注意

この API メソッドの呼び出しを使用する際に、トークンを URI で提示する必要があります。

URI での bond_name は、接合/デバイスの一意の名前です。

ENSLAVE (PUT)

メソッド名

enslave

デバイス

Cisco UCS Invicta スケーリング システム、Cisco UCS Invicta アプライアンス

HTTP メソッド

PUT

構文

このメソッドは、既存の接合で物理インターフェイスを追加または削除します。

URL の例

https://10.1.39.127/restapi/16/<token>/enslave/<bond_name>

要求データ

NAME
TYPE
注意

nicName

文字列

物理インターフェイス名(例:eth2)

アクション

文字列

add または remove

JSON のサンプル

‘{"nicName":"eth4", "action":"add"}'

応答データ

NAME
TYPE
注意

n/a

依存関係

n/a

注意

この API メソッドの呼び出しを使用する際に、トークンを URI で提示する必要があります。

URI での bond_name は、接合/デバイスの一意の名前です。

VLAN (POST)

メソッド名

vlan

デバイス

Cisco UCS Invicta スケーリング システム、Cisco UCS Invicta アプライアンス

HTTP メソッド

POST

構文

このメソッドは、新しい VLAN を作成します。

URL の例

https://10.1.39.127/restapi/16/<token>/vlan

要求データ

NAME
TYPE
注意

name

文字列

「親」インターフェイス名(必須)

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

依存関係

このメソッドを使用するには、接合がデバイスに存在している必要があります。

注意

この API メソッドの呼び出しを使用する際に、トークンを URI で提示する必要があります。

name は、接合/デバイスの一意の名前です。

PING に応答できる IP の場合、API はその IP がすでに使用されていると見なすため、ステータス コード 391 のエラーが返されます。「強制」パラメータを使用して呼び出しを再送信することで、その IP は引き続き使用できます。

VLAN (PUT)

メソッド名

vlan

デバイス

Cisco UCS Invicta スケーリング システム、Cisco UCS Invicta アプライアンス

HTTP メソッド

PUT

構文

このメソッドは、既存の VLAN を更新します。

URL の例

https://10.1.39.127/restapi/16/<token>/vlan/0

要求データ

NAME
TYPE
注意

name

文字列

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

注意

この API メソッドの呼び出しを使用する際に、トークンを URI で提示する必要があります。

name は、接合/デバイスと vlanID をピリオドで結合した一意の名前です(例:bond0.1234)。

PING に応答できる IP の場合、API はその IP がすでに使用されていると見なすため、ステータス コード 391 のエラーが返されます。「強制」パラメータを使用して呼び出しを再送信することで、その IP は引き続き使用できます。


) 重要:API アプリケーションの PUT 規格に従い、ゼロ(0)が URI の一部として含まれています。パラメータが不十分な場合、要求は失敗します。


VLAN (DELETE)

メソッド名

vlan

デバイス

Cisco UCS Invicta スケーリング システム、Cisco UCS Invicta アプライアンス

HTTP メソッド

DELETE

構文

このメソッドは、既存の VLAN を削除します。

URL の例

https://10.1.39.127/restapi/16/<token>/vlan/0

要求データ

 

NAME
TYPE
注意

name

文字列

JSON のサンプル

{"name":"bond3.1"}

応答データ

NAME
TYPE
注意

n/a

依存関係

n/a

注意

この API メソッドの呼び出しを使用する際に、トークンを URI で提示する必要があります。

name は、接合/デバイスと vlanID をピリオドで結合した一意の名前です(例:bond0.1234)。


) 重要:API アプリケーションの DELETE 規格に従い、ゼロ(0)が URI の一部として含まれています。パラメータが不十分な場合、要求は失敗します。


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

依存関係

このメソッドを使用するには、接合がデバイスに存在している必要があります。

注意

この API メソッドの呼び出しを使用する際に、トークンを URI で提示する必要があります。

name は、接合/デバイスの一意の名前です。

PING に応答できる IP の場合、API はその IP がすでに使用されていると見なすため、ステータス コード 391 のエラーが返されます。「強制」パラメータを使用して呼び出しを再送信することで、その IP は引き続き使用できます。

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
TYPE
注意

n/a

依存関係

n/a

注意

この API メソッドの呼び出しを使用する際に、トークンを URI で提示する必要があります。

name は、接合/デバイスと割り当てられた ID をコロンで結合した一意の名前です(例:bond1:1)。

PING に応答できる IP の場合、API はその IP がすでに使用されていると見なすため、ステータス コード 391 のエラーが返されます。「強制」パラメータを使用して呼び出しを再送信することで、その IP は引き続き使用できます。


) 重要:API アプリケーションの PUT 規格に従い、ゼロ(0)が URI の一部として含まれています。パラメータが不十分な場合、要求は失敗します。


VIRTUALINTERFACE (DELETE)

メソッド名

virtualinterface

デバイス

Cisco UCS Invicta スケーリング システム、Cisco UCS Invicta アプライアンス

HTTP メソッド

DELETE

構文

このメソッドは、仮想インターフェイスを削除します。

URL の例

https://10.1.39.127/restapi/16/<token>/virtualinterface/0

要求データ

NAME
TYPE
注意

name

文字列

仮想インターフェイス名(必須)

JSON のサンプル

{"name":"bond0:1"}

応答データ

NAME
TYPE

n/a

依存関係

n/a

注意

この API メソッドの呼び出しを使用する際に、トークンを URI で提示する必要があります。

name は、接合/デバイスと割り当てられた ID をコロンで結合した一意の名前です(例:bond1:1)。


) 重要:API アプリケーションの DELETE 規格に従い、ゼロ(0)が URI の一部として含まれています。パラメータが不十分な場合、要求は失敗します。


PERFORMANCE - [TYPES] (GET)

メソッド名

パフォーマンス

デバイス

Cisco UCS Invicta スケーリング システム、Cisco UCS Invicta アプライアンス

HTTP メソッド

GET

構文

このメソッドは、使用可能なパフォーマンス ログのタイプを取得します。

URL の例

https://10.1.39.127/restapi/16/<token>/performance/types

要求データ

NAME
TYPE
注意

n/a

URL 要求のサンプル

curl -k -X GET --url 'https://10.10.15.181/restapi/16/<token>/performance/types' -H "Accept: application/json"

応答データ

NAME
TYPE
注意

配列

使用可能なタイプの配列

JSON のサンプル

"data":{"types":["bricks","luns","networkphysical","networkvirtual"]}

依存関係

n/a

注意

この API メソッドの呼び出しを使用する際に、トークンを URI で提示する必要があります。

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 で提示する必要があります。

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

応答データ:

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","1375461206,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","1375288391,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","1375288416,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

応答データ:

NAME
TYPE
注意

配列

Unix 形式での日時

配列項目の構造:

NAME
TYPE
注意

mbs

Float

iops

Float

latency

Float

JSON 応答のサンプル

"data":"{"1375461181":{"mbs":0,"iops":0,"latency":0},"1375461186":{"mbs":0,"iops":0,"latency":0},"1375461191":{"mbs":0,"iops":0,"latency":0},"1375461196":{"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

応答データ:

NAME
TYPE
注意

配列

Unix 形式での日時

配列項目の構造:

NAME
TYPE
注意

rxpck

Float

txpck

Float

rxkb

Float

txkb

Float

JSON 応答のサンプル

"data":"{"1375288381":{"rxpck":10,"txpck":3,"rxkb":0.5,"txkb":0},"1375288386":{"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},"1375288406":{"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,"rxkb":0.5,"txkb":0},"1375288421":{"rxpck":6.5,"txpck":3,"rxkb":0,"txkb":0},"1375288426":{"rxpck":4,"txpck":3,"rxkb":0,"txkb":0},"1375288431":{"rxpck":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 メソッドを使用します。

依存関係

使用可能なパフォーマンス ログ タイプのリストは、PERFORMANCE - TYPES の API メソッドによって取得できます。

使用可能なリソースは、PERFORMANCE - RESOURCES の API メソッドによって取得できます。

注意

この API メソッドの呼び出しを使用する際に、トークンを URI で提示する必要があります。

リソース名の LUN が <vgname>/<lunname> の形式で返される場合、スラッシュ文字を置き換える必要があります(JSON 形式の "vg1\/lun1" ではスラッシュ文字はエスケープされる)。この場合、URL 符号化は動作しません。これは、URL が内部で処理されるときに、‘%2F' シーケンスは ‘/'(スラッシュ)にすでに変換し直され、システムが応答処理のために存在しない場所に要求を転送しようとするためです。

このため、次の例では、‘/'(スラッシュ)を置き換える文字として ‘~'(チルダ)が選択されました。

‘vg1/lun1' lun-resource name "vg1~lun1"

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

TYPE

注意

filename

文字列

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 を指定する必要があります。

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 の作成に失敗した。

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

ポータルは存在しない。

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 のマッピングを強制的に解除する。