- FutureNet製品活用ガイド
- FutureNet NXR,VXRシリーズ
- REST-API編
FutureNet
NXR,VXRシリーズ
REST-API編
4. ルーティング設定
4-4. BGP設定（bgp）
処理概要
BGP設定に関する処理を実行します。
URIおよびメソッド
| 機能 | Version | URI | メソッド | |||
| POST | PUT | GET | DELETE | |||
| BGP4 | v2 | /api/v2/bgp | 〇 | 〇 | ● | 〇 |
凡例：
● : 読み取り専用ユーザも含めアクセス可
〇 : 読み取り専用ユーザはアクセス不可
－ : 未対応
実行例
BGP設定の作成
| メソッド | URI |
| POST | /api/v2/bgp |
JSON
リクエスト
POST /api/v2/bgp
Content-Type: application/json
{
"service": "enable",
"as-number": 65000,
"redistribute": {
"protocol": "static"
},
"network": {
"prefix": "192.168.0.0/24"
},
"neighbor": {
"address": "203.0.113.1",
"remote-as": 65001
}
}
レスポンス
201 Created
XML
リクエスト
POST /api/v2/bgp
Content-Type: application/xml
<bgp>
<service>enable</service>
<as-number>65000</as-number>
<redistribute>
<protocol>static</protocol>
</redistribute>
<network>
<prefix>192.168.0.0/24</prefix>
</network>
<neighbor>
<address>203.0.113.1</address>
<remote-as>65001</remote-as>
</neighbor>
</bgp>
レスポンス
201 Created
BGP設定の更新
| メソッド | URI |
| PUT | /api/v2/bgp |
- 既存設定と異なるAS番号の設定で更新することはできません。
JSON
リクエスト
PUT /api/v2/bgp
Content-Type: application/json
{
"service": "enable",
"as-number": 65000,
"redistribute": {
"protocol": "static"
},
"network": {
"prefix": "192.168.0.0/24"
},
"neighbor": {
"address": "203.0.113.1",
"remote-as": 65001,
"soft-reconfigration": "enable"
}
}
レスポンス
204 No content
XML
リクエスト
PUT /api/v2/bgp
Content-Type: application/xml
<bgp>
<service>enable</service>
<as-number>65000</as-number>
<redistribute>
<protocol>static</protocol>
</redistribute>
<network>
<prefix>192.168.0.0/24</prefix>
</network>
<neighbor>
<address>203.0.113.1</address>
<remote-as>65001</remote-as>
<soft-reconfigration>enable</soft-reconfigration>
</neighbor>
</bgp>
レスポンス
204 No content
BGP設定の取得
| メソッド | URI |
| GET | /api/v2/bgp |
JSON
リクエスト
GET /api/v2/bgp
Accept: application/json
レスポンス
200 OK
Content-Type: application/json
{
"service": "enable",
"as-number": 65000,
"redistribute": {
"protocol": "static"
},
"network": {
"prefix": "192.168.0.0/24"
},
"neighbor": {
"address": "203.0.113.1",
"remote-as": 65001,
"soft-reconfigration": "enable"
}
}
XML
リクエスト
GET /api/v2/bgp
Accept: application/xml
レスポンス
200 OK
Content-Type: application/xml
<bgp>
<service>enable</service>
<as-number>65000</as-number>
<redistribute>
<protocol>static</protocol>
</redistribute>
<network>
<prefix>192.168.0.0/24</prefix>
</network>
<neighbor>
<address>203.0.113.1</address>
<remote-as>65001</remote-as>
<soft-reconfigration>enable</soft-reconfigration>
</neighbor>
</bgp>
TEXT/PLAIN
リクエスト
GET /api/v2/bgp
Accept: text/plain
レスポンス
200 OK
Content-Type: text/plain
router bgp 65000
network 192.168.0.0/24
redistribute static
neighbor 203.0.113.1 remote-as 65001
neighbor 203.0.113.1 soft-reconfiguration inbound
BGP設定の削除
| メソッド | URI |
| DELETE | /api/v2/bgp |
JSON
リクエスト
DELETE /api/v2/bgp
Content-Type: application/json
{
"as-number": 65000
}
レスポンス
204 No content
XML
リクエスト
DELETE /api/v2/bgp
Content-Type: application/xml
<bgp>
<as-number>65000</as-number>
</bgp>
レスポンス
204 No content
パラメータ
指定可能なパラメータは下記の通りです。
なお、指定可能なパラメータは製品およびファームウェアのバージョンにより異なりますので、各パラメータの詳細については各製品のユーザーズガイド（CLI版）も合わせてご参照ください。
- パラメータ表の説明文中の表記について
< > … 括弧内の値の範囲から選択することを示しています。
[ ] … 括弧内の値のどれかを選択することを示しています。
数字,文字列 … 初期値 - パラメータ表の説明文中のデータタイプについて
A.B.C.D … IPv4アドレス
A.B.C.D/M … IPv4プレフィックスおよびマスク長
X:X::X:X … IPv6アドレス
X:X::X:X/M … IPv6プレフィックスおよびプレフィックス長
| パラメータおよびレベル | 説明 | ||||
|---|---|---|---|---|---|
| Lv.1 | Lv.2 | Lv.3 | Lv.4 | Lv.5 | |
| bgp | service | BGP4機能 … enable | |||
| as-number | AS番号 … <1-65535> | ||||
| router-id | ルータID … A.B.C.D | ||||
| scan-time | スキャンタイム … <0-60>（sec） | ||||
| redistribute | protocol | プロトコル … [ connected | ospf | rip | static ] | |||
| route-map | ルートマップ名 | ||||
| distance | ebgp | eBGPディスタンス値 … <1-255(20)> | |||
| ibgp | iBGPディスタンス値 … <1-255(200)> | ||||
| local | localディスタンス値 … <1-255(200)> | ||||
| import-check | import-check … [ enable | disable ] | ||||
| always-compare-med | always-compare-med … [ enable | disable ] | ||||
| enforce-first-as | enforce-first-as … [ enable | disable ] | ||||
| as-path-ignore | as-path-ignore … [ enable | disable ] | ||||
| med-missing-as-worst | med-missing-as-worst … [ enable | disable ] | ||||
| default-local-preference | default-local-preference … <0-4294967295(100)> | ||||
| no-default-ipv4 | no-default-ipv4 … [ enable | disable ] | ||||
| default-information-check | default-information-check … [ enable | disable ] | ||||
| network | prefix | BGPネットワーク … A.B.C.D/M | |||
| backdoor | backdoor … [ enable | disable ] | ||||
| aggregate-address | prefix | 経路集約 … A.B.C.D/M | |||
| summary-only | summary-only … [ enable | disable ] | ||||
| as-set | as-set … [ enable | disable ] | ||||
| neighbor | address | Neighbor address …
|
|||
| remote-as | リモートAS番号 … <1-65535> | ||||
| activate | activate … [ enable | disable ] | ||||
| keepalive | Keepaliveインターバル … <0-65535(60)>（sec） | ||||
| holdtime | ホールドタイム … <0-65535(180)>（sec） | ||||
| connect-time | コネクトタイム … <0-65535(120)>（sec） | ||||
| default-origination | デフォルトルートの配信 … [ enable | disable ] | ||||
| next-hop-self | next-hop-self … [ enable | disable ] | ||||
| update-source | update-source … インタフェース名（ex. ethernet0） | ||||
| interface | インタフェース名（ex. ethernet0） | ||||
| ebgp-multihop | eBGPマルチホップ … <1-255> | ||||
| advertisement-interval | advertisementインターバル … <1-600>（sec） ※eBGPでのデフォルト値は30, iBGPでのデフォルト値は5 |
||||
| as-origination-interval | as-originationインターバル … <1-600(15)>（sec） | ||||
| soft-reconfiguration | soft-reconfiguration inbound … [ enable | disable ] | ||||
| remove-private-as | remove-private-as … [ enable | disable ] | ||||
| route-map | in | ルートマップ名（in） | |||
| out | ルートマップ名（out） | ||||
| distribute-list | in | IPルートアクセスリスト名（in） | |||
| out | IPルートアクセスリスト名（out） | ||||
| filter-list | in | ASパスアクセスリスト名（in） | |||
| out | ASパスアクセスリスト名（out） | ||||
| netevent | track-id | トラックID | |||
| action | ネットイベントアクション … advertise-stop | ||||
| address-family-ipv6 | aggregate-address | prefix | 経路集約 … X:X::X:X/M | ||
| summary-only | summary-only … [ enable | disable ] | ||||
| as-set | as-set … [ enable | disable ] | ||||
| neighbor | address | Neighbor address …
|
|||
| activate | activate … [ enable | disable ] | ||||
| default-origination | デフォルトルートの配信 … [ enable | disable ] | ||||
| next-hop-self | next-hop-self … [ enable | disable ] | ||||
| soft-reconfiguration | soft-reconfiguration inbound … [ enable | disable ] | ||||
| remove-private-as | remove-private-as … [ enable | disable ] | ||||
| route-map | in | ルートマップ名（in） | |||
| out | ルートマップ名（out） | ||||
| distribute-list | in | IPv6ルートアクセスリスト名（in） | |||
| out | IPv6ルートアクセスリスト名（out） | ||||
| filter-list | in | ASパスアクセスリスト名（in） | |||
| out | ASパスアクセスリスト名（out） | ||||
目次
更新情報
→ 一覧へカテゴリ
タグ
- CRG
- DDNS
- DHCP
- DNAT
- DNSインターセプト
- Ethernet
- IIJモバイル
- IKE Modeconfig
- IKEv2 Configuration Payload
- IPinIP
- IPoE
- IPv6
- KDDI
- L2TPv3
- MAP-E
- NGN
- NTTドコモ
- PBR
- Policy Based IPsec
- PPP
- PPPoE
- QoS
- RADIUS連携
- RAシリーズ
- Route Based IPsec
- SMS
- SNAT
- SoftBank
- UPnP
- URL転送
- VLAN
- VRRP
- Web認証
- WiMAX
- コンフィグロールバック
- ネットイベント
- フィルタ
- ブリッジ
- モニタログ
- ワイモバイル
- 仮想スイッチ
- 冗長化
- 無線LAN