NXR,VXRシリーズ

10-1. モバイル設定（mobile）

 処理概要

モバイル設定に関する処理を実行します。

 

URIおよびメソッド

機能	Version	URI	メソッド
			POST	PUT	GET	DELETE
mobile	v2	/api/v2/mobile	－	－	－	－
		/api/v2/mobile/error-recovery-restart	－	〇	●	〇
		/api/v2/mobile/error-recovery-reset	－	〇	●	〇
		/api/v2/mobile/term-recovery	－	〇	●	〇
		/api/v2/mobile/mobile-list	〇	－	●	－
		/api/v2/mobile/mobile-list/{NUM}	－	〇	●	〇

凡例：

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

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

－ : 未対応

• api/v1は対応していません。

 

実行例

error-recovery-restart設定の更新

メソッド	URI
PUT	/api/v2/mobile/error-recovery-restart

JSON

リクエスト

PUT /api/v2/mobile/error-recovery-restart
Content-Type: application/json

 

{
"error-recovery-restart": "enable"
}

 

レスポンス

204 No content

 

XML

リクエスト

PUT /api/v2/mobile/error-recovery-restart
Content-Type: application/xml

 

<mobile>
<error-recovery-restart>enable</error-recovery-restart>
</mobile>

 

レスポンス

204 No content

 

error-recovery-restart設定の取得

メソッド	URI
GET	/api/v2/mobile/error-recovery-restart

JSON

リクエスト

GET /api/v2/mobile/error-recovery-restart
Accept: application/json

 

レスポンス

200 OK
Content-Type: application/json

 

{
"error-recovery-restart": "enable"
}

 

XML

リクエスト

GET /api/v2/mobile/error-recovery-restart
Accept: application/xml

 

レスポンス

200 OK
Content-Type: application/xml

 

<mobile>
<error-recovery-restart>enable</error-recovery-restart>
</mobile>

 

TEXT/PLAIN

リクエスト

GET /api/v2/mobile/error-recovery-restart
Accept: text/plain

 

レスポンス

200 OK
Content-Type: text/plain

 

mobile error-recovery-restart

 

error-recovery-restart設定の削除

メソッド	URI
DELETE	/api/v2/mobile/error-recovery-restart

リクエスト

DELETE /api/v2/mobile/error-recovery-restart

 

レスポンス

204 No content

 

error-recovery-reset設定の更新

メソッド	URI
PUT	/api/v2/mobile/error-recovery-reset

JSON

リクエスト

PUT /api/v2/mobile/error-recovery-reset
Content-Type: application/json

 

{
"error-recovery-reset": "enable"
}

 

レスポンス

204 No content

 

XML

リクエスト

PUT /api/v2/mobile/error-recovery-reset
Content-Type: application/xml

 

<mobile>
<error-recovery-reset>enable</error-recovery-reset>
</mobile>

 

レスポンス

204 No content

 

error-recovery-reset設定の取得

メソッド	URI
GET	/api/v2/mobile/error-recovery-reset

JSON

リクエスト

GET /api/v2/mobile/error-recovery-reset
Accept: application/json

 

レスポンス

200 OK
Content-Type: application/json

 

{
"error-recovery-reset": "enable"
}

 

XML

リクエスト

GET /api/v2/mobile/error-recovery-reset
Accept: application/xml

 

レスポンス

200 OK
Content-Type: application/xml

 

<mobile>
<error-recovery-reset>enable</error-recovery-reset>
</mobile>

 

TEXT/PLAIN

リクエスト

GET /api/v2/mobile/error-recovery-reset
Accept: text/plain

 

レスポンス

200 OK
Content-Type: text/plain

 

mobile error-recovery-reset

 

error-recovery-reset設定の削除

メソッド	URI
DELETE	/api/v2/mobile/error-recovery-reset

リクエスト

DELETE /api/v2/mobile/error-recovery-reset

 

レスポンス

204 No content

 

termination-recovery設定の更新

メソッド	URI
PUT	/api/v2/mobile/term-recovery

JSON

リクエスト

PUT /api/v2/mobile/term-recovery
Content-Type: application/json

 

{
"term-recovery": "reset"
}

 

レスポンス

204 No content

 

XML

リクエスト

PUT /api/v2/mobile/term-recovery
Content-Type: application/xml

 

<mobile>
<term-recovery>reset</term-recovery>
</mobile>

 

レスポンス

204 No content

 

termination-recovery設定の取得

メソッド	URI
GET	/api/v2/mobile/term-recovery

JSON

リクエスト

GET /api/v2/mobile/term-recovery
Accept: application/json

 

レスポンス

200 OK
Content-Type: application/json

 

{
"term-recovery": "reset"
}

 

XML

リクエスト

GET /api/v2/mobile/term-recovery
Accept: application/xml

 

レスポンス

200 OK
Content-Type: application/xml

 

<mobile>
<term-recovery>reset</term-recovery>
</mobile>

 

TEXT/PLAIN

リクエスト

GET /api/v2/mobile/term-recovery
Accept: text/plain

 

レスポンス

200 OK
Content-Type: text/plain

 

mobile termination-recovery reset

 

termination-recovery設定の削除

メソッド	URI
DELETE	/api/v2/mobile/term-recovery

リクエスト

DELETE /api/v2/mobile/term-recovery

 

レスポンス

204 No content

 

mobile-list設定の作成

メソッド	URI
POST	/api/v2/mobile/mobile-list

JSON

リクエスト

POST /api/v2/mobile/mobile-list
Content-Type: application/json

 

{
"mobile-list": {
"number": 1,
"carrier-info": {
"carrier": "docomo"
}
}
}

 

レスポンス

201 Created

 

XML

リクエスト

POST /api/v2/mobile/mobile-list
Content-Type: application/xml

 

<mobile>
<mobile-list>
<number>1</number>
<carrier-info>
<carrier>docomo</carrier>
</carrier-info>
</mobile-list>
</mobile>

 

レスポンス

201 Created

 

全mobile-list設定の取得

メソッド	URI
GET	/api/v2/mobile/mobile-list

JSON

リクエスト

GET /api/v2/mobile/mobile-list
Accept: application/json

 

レスポンス

200 OK
Content-Type: application/json

 

{
"mobile-list": [
{
"number": 1,
"carrier-info": {
"carrier": "docomo"
}
},
{
"number": 2,
"ppp-client": "ppp0",
"carrier-info": {
"carrier": "kddi"
}
}
]
}

 

XML

リクエスト

GET /api/v2/mobile/mobile-list
Accept: application/xml

 

レスポンス

200 OK
Content-Type: application/xml

 

<mobile>
<mobile-list>
<number>1</number>
<carrier-info>
<carrier>docomo</carrier>
</carrier-info>
</mobile-list>
<mobile-list>
<number>2</number>
<ppp-client>ppp0</ppp-client>
<carrier-info>
<carrier>kddi</carrier>
</carrier-info>
</mobile-list>
</mobile>

 

TEXT/PLAIN

リクエスト

GET /api/v2/mobile/mobile-list
Accept: text/plain

 

レスポンス

200 OK
Content-Type: text/plain

 

mobile 1 carrier docomo
mobile 2 ppp 0
mobile 2 carrier kddi

 

mobile-list設定の更新

メソッド	URI
PUT	/api/v2/mobile/mobile-list/{NUM}

JSON

リクエスト

PUT /api/v2/mobile/mobile-list/1
Content-Type: application/json

 

{
"number": 1,
"carrier-info": {
"carrier": "softbank"
}
}

 

レスポンス

204 No content

 

XML

リクエスト

PUT /api/v2/mobile/mobile-list/1
Content-Type: application/xml

 

<mobile-list>
<number>1</number>
<carrier-info>
<carrier>softbank</carrier>
</carrier-info>
</mobile-list>

 

レスポンス

204 No content

 

mobile-list設定の取得

メソッド	URI
GET	/api/v2/mobile/mobile-list/{NUM}

JSON

リクエスト

GET /api/v2/mobile/mobile-list/1
Accept: application/json

 

レスポンス

200 OK
Content-Type: application/json

 

{
"number": 1,
"carrier-info": {
"carrier": "docomo"
}
}

 

XML

リクエスト

GET /api/v2/mobile/mobile-list/1
Accept: application/xml

 

レスポンス

200 OK
Content-Type: application/xml

 

<mobile-list>
<number>1</number>
<carrier-info>
<carrier>docomo</carrier>
</carrier-info>
</mobile-list>

 

TEXT/PLAIN

リクエスト

GET /api/v2/mobile/mobile-list/1
Accept: text/plain

 

レスポンス

200 OK
Content-Type: text/plain

 

mobile 1 carrier docomo

 

mobile-list設定の削除

メソッド	URI
DELETE	/api/v2/mobile/mobile-list/{NUM}

• 設定を削除する場合、あらかじめ回線を切断しておく必要があります。

 

リクエスト

DELETE /api/v2/mobile/mobile-list/1

 

レスポンス

204 No content

 

パラメータ

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

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

• パラメータ表の説明文中の表記について
  < > … 括弧内の値の範囲から選択することを示しています。
  [ ] … 括弧内の値のどれかを選択することを示しています。
  数字,文字列 … 初期値

 

パラメータおよびレベル						説明
Lv.1	Lv.2	Lv.3	Lv.4	Lv.5	Lv.6
mobile	error-recovery-restart					モバイルエラーリカバリーリスタート … [ enable | disable ]
	error-recovery-reset					モバイルエラーリカバリーリセット … [ enable | disable ]
	term-recovery					モバイルターミネーションリカバリー … [ reset | restart ]
	mobile-list	number				モバイル番号
		ppp-client				PPPインタフェース名（ex. ppp0）
		netevent	track-id			トラックID
			action			ネットイベントアクション … reset
		freq-band				周波数帯 … [ auto | lte | nr5g | w-cdma ] ※設定可能項目は機種により異なります
		nr5g-nw-mode				5Gネットワークモード … [ nsa | nsa-sa | sa ]
		sms	accept-list	phone-number		SMS受信許可電話番号
			auth-key			SMS認証キー
			send-list	number		SMS送信番号
				phone-number		SMS通知先電話番号
		rollback	notify	sms		SMS送信設定番号
		signal	notify	rssi		RSSI閾値 … <510-1130>（x -0.1dBm）
				sinr		SINR閾値 … <0-200>（x 0.1dB）
				send_mail	server	メール送信サーバ設定番号
					subject	件名
				sms		SMS送信設定番号
		fix-band				バンド固定 … [ 01 | 03 | 08 | 18 | 19 | 21 | 28 | 38 | 39 | 40 | 41 ] ※設定可能項目は機種により異なります
		fix-band-lte	fix-band			バンド固定 … [ 01 | 02 | 03 | 04 | 05 | 07 | 08 | 12 | 13 | 14 | 17 | 18 | 19 | 20 | 25 | 26 | 28 | 29 | 30 | 32 | 34 | 38 | 39 | 40 | 41 | 42 | 46 | 48 | 66 ] ※設定可能項目は機種により異なります
		fix-band-nr5g	fix-band			バンド固定 … [ 01 | 02 | 03 | 05 | 07 | 08 | 12 | 20 | 28 | 41 | 66 | 71 | 77 | 78 | 79 ] ※設定可能項目は機種により異なります
		fix-band-wcdma	fix-band			バンド固定 … [ 01 | 02 | 04 | 05 | 06 | 08 | 09 | 19 ] ※設定可能項目は機種により異なります
		exclude-band				無効バンド … 41 ※設定可能項目は機種により異なります
		carrier-info	carrier			キャリア … [ auto | bwa | docomo | generic | local-5g | kddi | rakuten | softbank ] ※設定可能項目は機種により異なります
			mvno			mvno … [ enable | disable ]
		standby	ppp-client			PPPインタフェース名（ex. ppp0）
			carrier-info	carrier		キャリア … [ docomo | generic | kddi | softbank ]
				mvno		mvno … [ enable | disable ]
		dialup-recovery	failure-count			dialup error-recovery失敗回数 … <1-720>
			recovery-method			リカバリ方法 … [ reset | restart ]
		connect-recovery	failure-count			connect error-recovery失敗回数 … <1-720>
			recovery-method			リカバリ方法 … [ reset | restart ]
		gps-assist-data				GPSアシストデータ取得URL
		plmn-id				PLMN
		sim	change-timer			SIM切り戻し時間 … <10-1440>（min）
			netevent	track-id		トラックID
				action		ネットイベントアクション … [ change | failover ]