JavaScript is required to for searching.
ナビゲーションリンクをスキップ
印刷ビューの終了
Oracle® ZFS Storage Appliance RESTful API ガイド、Release 2013.1.3.0
Oracle Technology Network
ライブラリ
PDF
印刷ビュー
フィードバック
search filter icon
search icon

ドキュメント情報

Oracle ZFS Storage Appliance RESTful API の概要

RESTful API の操作

RESTful API 警告サービス

Analytics サービス

ハードウェアサービス

ログのコマンド

ネットワークのコマンド

RESTful API 問題サービス

RESTful API ロールサービス

RESTful API SAN サービス

SAN の概要

SAN イニシエータ

List Initiators

Get Initiator Details

Create an Initiator

Modify an Initiator

Delete an Initiator

イニシエータグループ

List Initiator Groups

Get Initiator Group Details

Create an Initiator Group

Delete an Initiator Group

ターゲット

List Targets

Get Target Details

Create a Target

Modify a Target

Delete a Target

ターゲットグループ

List Target Groups

Get Target Group

Create a Target Group

Delete a Target Group

サービスコマンド

RESTful API ストレージサービス

システムコマンド

RESTful API ユーザーサービス

ワークフローコマンド

RESTful クライアント

SAN イニシエータ

SAN イニシエータの管理には、次のコマンドが使用されます。

表 10-1  イニシエータコマンド
リクエスト
パス /san/v1.0
説明
GET
/<protocol>/initiators
指定されたプロトコル (FC、iSCSI、SRP) オブジェクトのすべての SAN イニシエータを一覧表示します
GET
/<protocol>/initiators /<initiator>
指定されたプロトコル (FC、iSCSI、SRP) プロパティーの指定された SAN イニシエータを取得します。
POST
/<protocol>/initiators
指定されたプロトコル (FC、iSCSI、SRP) の新しい SAN イニシエータを作成します
PUT
/<protocol>/initiators /<initiator>
指定されたプロトコル (FC、iSCSI、SRP) オブジェクトの指定された SAN イニシエータを変更します
DELETE
/<protocol>/initiators /<initiator>
指定されたイニシエータオブジェクトを破棄します

これらのコマンドは次の URI パラメータを使用します。

表 10-2  URI パラメータ
名前
説明
protocol
イニシエータ (FC、iSCSI、SRP) の NAS プロトコル
initiator
イニシエータの iqn、wwn、または eui

イニシエータコマンドの多くは戻り値として次に示すプロパティーを使用します。作成および変更コマンドも入力値としてプロパティーを使用します。

表 10-3  イニシエータのプロパティー
名前
プロトコル
説明
alias
all
このイニシエータの別名
initiator
fc
このイニシエータのポート World Wide Name (WWN)
iqn
iscsi
このイニシエータの iSCSI 修飾名
chapuser
iscsi
チャレンジハンドシェイク認証プロトコル (CHAP) ユーザー名
chapsecret
iscsi
チャレンジハンドシェイク認証プロトコル (CHAP) シークレット
initiator
srp
EUI (Extended Unique Identifier)

List Initiators

指定されたプロトコルタイプのアプライアンス上に構成されたすべてのイニシエータを一覧表示します。応答本文に、JSON 形式で「initiators」という名前のイニシエータプロパティーの配列が含まれます。

iSCSI イニシエータを一覧表示するリクエストの例:

GET /api/san/v1/iscsi/initiators HTTP/1.1
Host: zfs-storage.example.com
Accept: application/json

レスポンスの例:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "initiators": [{
        "alias": "init-02",
        "href": "/api/san/v1/iscsi/initiators/iqn.1986-03.com.sun:02:02",
        "initiator": "iqn.1986-03.com.sun:02:02",
        "chapsecret": "",
        "chapuser": ""
    },{
        "alias": "init-01",
        "initiator": "iqn.1986-03.com.sun:02:01",
        "href": "/api/san/v1/iscsi/initiators/iqn.1986-03.com.sun:02:01",
        "chapsecret": "",
        "chapuser": ""
    }]
}

Get Initiator Details

単一の iSCSI イニシエータの詳細を一覧表示します。応答本文に、JSON 形式で「initiator」という名前のオブジェクトとして iSCSI イニシエータプロパティーが含まれます。

リクエストの例:

GET /api/san/v1/iscsi/initiators/iqn.1986-03.com.sun:02:01 HTTP/1.1
Host: zfs-storage.example.com
Accept: application/json

レスポンスの例:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "initiator": {
        "alias": "init-01",
        "href": "/api/san/v1/iscsi/initiators/iqn.1986-03.com.sun:02:01"
        "initiator": "iqn.1986-03.com.sun:02:01",
        "chapsecret": "",
        "chapuser": ""
    }
}

Create an Initiator

新しい iSCSI イニシエータを作成します。ISCSI 修飾名 (IQN) を指定する必要があります。リクエスト本文に JSON 形式で iSCSI イニシエータプロパティーが含まれます。応答には、成功時に HTTP ヘッダーに新しい iSCSI イニシエータの場所の URI とステータスコード 201 (Created) が含まれます。応答本文に、JSON 形式で「initiator」という名前のオブジェクトとして iSCSI イニシエータプロパティーが含まれます。

リクエストの例:

POST /api/san/v1.0/iscsi/initiators HTTP/1.1
Host: zfs-storage.example.com
Content-Type: application/json
Accept: application/json

{
    "initiator": "iqn.1986-03.com.sun:02:02",
    "alias":"init-02"
}

レスポンスの例:

HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 181
X-Zfssa-San-Api: 1.0
Location: /api/san/v1/iscsi/initiators/iqn.1986-03.com.sun:02:02

{
    "initiator": {
        "alias": "init-02",
        "href": "/api/san/v1/iscsi/initiators/iqn.1986-03.com.sun:02:02",
        "initiator": "iqn.1986-03.com.sun:02:02",
        "chapsecret": "",
        "chapuser": ""
    }
}

Modify an Initiator

このコマンドは既存のイニシエータを変更します。リクエスト本文に JSON 形式で変更すべきイニシエータプロパティーが含まれます。イニシエータの IQN は URI で提供されます。成功時に HTTP ステータス 202 (Accepted) が返されます。応答本文に、JSON 形式で「initiator」という名前のオブジェクトとして、新しい iSCSI イニシエータプロパティーが含まれます。

リクエストの例:

PUT /api/san/v1/iscsi/initiators/iqn.1986-03.com.sun:01  /HTTP/1.1
Host: zfs-storage.example.com
Content-Type: application/json
Accept: application/json

{
    "alias":"init-01-secure",
    "chapuser":"chuck",
    "chapsecret":"igottheintersect"
}

レスポンスの例:

HTTP/1.1 202 Accepted
Content-Length: 167
Content-Type: application/json
X-Zfs-Sa-Nas-Api: 1.0

{
    "initiator": {
        "alias": "init-01-secure",
        "href": "/api/san/v1/iscsi/initiators/iqn.1986-03.com.sun:01",
        "iqn": "iqn.1986-03.com.sun:1",
        "chapsecret": "igottheintersect",
        "chapuser": "chuck"
    }
}

Delete an Initiator

アプライアンスからイニシエータを削除します。

リクエストの例:

DELETE /api/san/v1/iscsi/initiators/iqn.1986-03.com.sun:01 HTTP/1.1
Host: zfs-storage.example.com:215

Delete が成功すると HTTP コード 204 (No Content) を返します。

HTTP/1.1 204 No-Content