Oracle^® ZFS Storage Appliance RESTful API ガイド、Release OS8.8.x

SAN イニシエータ

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

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

protocol

イニシエータ用の NAS プロトコル: fc、iscsi、または srp

initiator

イニシエータの IQN、WWN、または EUI

表 32  イニシエータコマンド

リクエスト パス /san/v{1|2} の後ろに追加 説明 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 指定されたイニシエータオブジェクトを破棄します

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

表 33  イニシエータのプロパティー

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

イニシエータの一覧表示

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

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

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

結果例:

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

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

イニシエータの詳細の取得

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

リクエストの例:

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

結果例:

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

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

イニシエータの作成

新しい 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:215
Content-Type: application/json
Accept: application/json

{
    "initiator": "iqn.zfs-storage.example.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.zfs-storage.example.com.sun:02:02

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

イニシエータの変更

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

リクエストの例:

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

{
    "alias":"init-01-secure",
    "chapuser":"admin4",
    "chapsecret":"secret"
}

結果例:

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.zfs-storage.example.com.sun:01",
        "iqn": "iqn.zfs-storage.example.com.sun:1",
        "chapsecret": "secret",
        "chapuser": "admin4"
    }
}

イニシエータの削除

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

リクエストの例:

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

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

HTTP/1.1 204 No-Content