NXR,VXRシリーズ

4-3. OSPF設定（ospf）

 処理概要

OSPF設定に関する処理を実行します。

 

URIおよびメソッド

機能	Version	URI	メソッド
			POST	PUT	GET	DELETE
OSPF	v2	/api/v2/ospf	〇	〇	●	〇

凡例：

● : 読み取り専用ユーザも含めアクセス可

〇 : 読み取り専用ユーザはアクセス不可

－ : 未対応

 

実行例

OSPF設定の作成

メソッド	URI
POST	/api/v2/ospf

JSON

リクエスト

POST /api/v2/ospf
Content-Type: application/json

 

{
"service": "enable",
"network": {
"prefix": "192.168.0.0/24",
"area-id": 0
},
"redistribute": {
"protocol": "static"
}
}

 

レスポンス

201 Created

 

XML

リクエスト

POST /api/v2/ospf
Content-Type: application/xml

 

<ospf>
<service>enable</service>
<network>
<prefix>192.168.0.0/24</prefix>
<area-id>0</area-id>
</network>
<redistribute>
<protocol>static</protocol>
</redistribute>
</ospf>

 

レスポンス

201 Created

 

OSPF設定の更新

メソッド	URI
PUT	/api/v2/ospf

JSON

リクエスト

PUT /api/v2/ospf
Content-Type: application/json

 

{
"service": "enable",
"network": [
{
"prefix": "192.168.0.0/24",
"area-id": 0
},
{
"prefix": "192.168.1.0/24",
"area-id": 1
}
],
"redistribute": {
"protocol": "static"
}
}

 

レスポンス

204 No content

 

XML

リクエスト

PUT /api/v2/ospf
Content-Type: application/xml

 

<ospf>
<service>enable</service>
<network>
<prefix>192.168.0.0/24</prefix>
<area-id>0</area-id>
</network>
<network>
<prefix>192.168.1.0/24</prefix>
<area-id>1</area-id>
</network>
<redistribute>
<protocol>static</protocol>
</redistribute>
</ospf>

 

レスポンス

204 No content

 

OSPF設定の取得

メソッド	URI
GET	/api/v2/ospf

JSON

リクエスト

GET /api/v2/ospf
Accept: application/json

 

レスポンス

200 OK
Content-Type: application/json

 

{
"service": "enable",
"network": [
{
"prefix": "192.168.0.0/24",
"area-id": 0
},
{
"prefix": "192.168.1.0/24",
"area-id": 1
}
],
"redistribute": {
"protocol": "static"
}
}

 

XML

リクエスト

GET /api/v2/ospf
Accept: application/xml

 

レスポンス

200 OK
Content-Type: application/xml

 

<ospf>
<service>enable</service>
<network>
<prefix>192.168.0.0/24</prefix>
<area-id>0</area-id>
</network>
<network>
<prefix>192.168.1.0/24</prefix>
<area-id>1</area-id>
</network>
<redistribute>
<protocol>static</protocol>
</redistribute>
</ospf>

 

TEXT/PLAIN

リクエスト

GET /api/v2/ospf
Accept: text/plain

 

レスポンス

200 OK
Content-Type: text/plain

 

router ospf
network 192.168.0.0/24 area 0
network 192.168.1.0/24 area 1
redistribute static
exit

 

OSPF設定の削除

メソッド	URI
DELETE	/api/v2/ospf

リクエスト

DELETE /api/v2/ospf

 

レスポンス

204 No content

 

パラメータ

指定可能なパラメータは下記の通りです。

なお、指定可能なパラメータは製品およびファームウェアのバージョンにより異なりますので、各パラメータの詳細については各製品のユーザーズガイド（CLI版）も合わせてご参照ください。

• パラメータ表の説明文中の表記について
  < > … 括弧内の値の範囲から選択することを示しています。
  [ ] … 括弧内の値のどれかを選択することを示しています。
  数字,文字列 … 初期値
• パラメータ表の説明文中のデータタイプについて
  A.B.C.D … IPv4アドレス
  A.B.C.D/M … IPv4プレフィックスおよびマスク長

 

パラメータおよびレベル				説明
Lv.1	Lv.2	Lv.3	Lv.4
ospf	service			OSPF機能 … enable
	router-id			ルータID … A.B.C.D
	area	area-id		エリアID … A.B.C.D <0-4294967295>
		default-cost		デフォルトコスト … <0-16777215(1)> ※デフォルト値はスタブ有効時の値
		auth-type		認証 … [ message-digest | simple ]
		range		経路集約 … A.B.C.D/M
		stub		スタブ … [ enable | disable ]
		no-summary		トータリースタブ … [ enable | disable ]
	network	prefix		OSPFネットワーク … A.B.C.D/M
		area-id		エリアID … A.B.C.D <0-4294967295>
	virtual-link	area-id		エリアID … A.B.C.D <0-4294967295>
		peer-id		ピアルータID … A.B.C.D
		auth-type		認証 … [ message-digest | null | simple ]
		auth-key		認証キー
		message-digest-key	key-id	キーID
			auth-key	認証キー
		hello-interval		Helloインターバル … <1-65535(10)>（sec）
		dead-interval		Deadインターバル … <1-65535(40)>（sec）
		retransmit-interval		Retransmitインターバル … <1-65535(5)>（sec）
		transmit-delay		Transmitディレイ … <1-65535(1)>（sec）
	redistribute	protocol		プロトコル … [ bgp | connected | rip | static ]
		route-map		ルートマップ名
		tag		タグ … <0-4294967295>
		metric	type	メトリックタイプ … [ 1 | 2 ]
			value	OSPFメトリック … <0-16777214>
	distribute-list	acl-name		IPルートアクセスリスト名
		protocol		プロトコル … [ all | bgp | connected | rip | static ]
	distance	all		ディスタンス … <1-255(110)>
		intra-area		intra-areaディスタンス … <1-255(110)>
		inter-area		inter-areaディスタンス … <1-255(110)>
		external		external-areaディスタンス … <1-255(110)>
	timers	spf-delay		SPFディレイ … <0-2147483647(5)>
		spf-holdtime		SPFホールドタイム … <0-2147483647(10)>
	passive-interface			インタフェース名（ex. ethernet0）
	reference-bandwidth			reference-bandwidth … <1-4294967>（Mbps）
	default-information	originate		デフォルトルートの配信 … [ enable | always ]
		metric	type	メトリックタイプ … [ 1 | 2 ]
			value	OSPFメトリック … <0-16777214>
		route-map		ルートマップ名
	max-concurrent-dd			DD交換可能なネイバー数の上限 … <1-65535>