ネットワークルート

言語:

ネットワークルートを管理します。

表 41 ネットワークルートの管理

リクエスト	パス /api/network/v1	説明
POST	/routes	新しいネットワークルートを作成します
GET	/routes/<`route`>	指定されたネットワークルートのプロパティーを取得します
GET	/routes	すべてのネットワークルートオブジェクトを一覧表示します
DELETE	/routes/<`route`>	指定されたルートオブジェクトを破棄します
GET	/routing	ネットルーティングプロパティーを取得します
PUT	/routing	ネットルーティングプロパティーを変更します

表 42 ネットワークルートのプロパティー

名前	説明
type	ルートのタイプ (「system」、「static」など (変更不可))
family	アドレスファミリ (IPv4 または IPv6)
destination	ルーティング先アドレス
gateway	ゲートウェイアドレス
interface	ネットワークデータリンクのインタフェース

各ルートへの href パスでは、CLI で設定されたルート ID を使用しますが、これらの値はルートの変更に伴って変更されることがあります。API は、ルート内で固有のプロパティーを使用することで、単一ルートの選択をサポートします。その構文は、routes/route-### に対して routes/<name>=<value> になります。

ルートの一覧表示

アプライアンス上で作成されたすべてのネットワークルートを一覧表示します。

リクエストの例:

GET /api/network/v1/routes HTTP/1.1
Authorization: Basic abcd1234MWE=
Host: zfssa.example.com:215
Accept: application/json

結果例:

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

{
    "routes": [{
        "destination": "0.0.0.0",
        "family": "IPv4",
        "gateway": "10.80.231.1",
        "href": "/api/network/v1/routing/route-000",
        "interface": "ixgbe0",
        "mask": 0,
        "route": "route-000",
        "type": "static"
    }, {
        "destination": "10.80.231.0",
        "family": "IPv4",
        "gateway": "10.80.231.58",
        "href": "/api/network/v1/routes/route-001",
        "interface": "ixgbe0",
        "mask": 24,
        "route": "route-001",
        "type": "system"
    }]
}

ルートの取得

単一ルートのプロパティーを取得します。

リクエストの例:

GET /api/network/v1/routes/destination=10.80.231.0 HTTP/1.1
Authorization: Basic abcd1234MWE=
Host: zfssa.example.com:215
Accept: application/json

結果例:

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

{
    "route": {
        "destination": "10.80.231.0",
        "family": "IPv4",
        "gateway": "10.80.231.58",
        "href": "/api/network/v1/routes/route-001",
        "interface": "ixgbe0",
        "mask": 24,
        "route": "route-001",
        "type": "system"
    }
}

ルートの追加

新しいネットワークルートを作成します。ルート href の値は、ほかのルートがシステムに追加されると変更されることがあります。作成時には、返されるプロパティーは入力プロパティーと同一であるため、ルート情報は返されません。作成に成功すると、HTTP ステータス 204 (Created) が返されます。

静的ルートを作成するリクエストの例:

POST /api/network/v1/routes HTTP/1.1
Authorization: Basic abcd1234MWE=
Host: zfssa.example.com:215
Content-Type: application/json
Content-Length: 164

{
    "family": "IPv4",
    "destination": "0.0.0.0",
    "mask": "0",
    "gateway": "10.11.12.1",
    "interface": "ixgbe0"
}

結果例:

HTTP/1.1 201 Created

ルートの削除

既存のネットワークルートを削除します。

リクエストの例:

DELETE /api/network/v1/routes/route-001 HTTP/1.1
Authorization: Basic abcd1234MWE=
Host: zfssa.example.com:215

結果例:

HTTP/1.1 204 No Content