1. FutureNet製品活用ガイド
  2. FutureNet NXR,VXRシリーズ
  3. REST-API編

FutureNet

NXR,VXRシリーズ

REST-API編

8. 各種サービス設定

8-7. スケジュール設定（scheduler）

 処理概要

スケジュール設定に関する処理を実行します。

 

URIおよびメソッド

機能 Version URI メソッド
POST PUT GET DELETE
Schedule v2 /api/v2/scheduler － － － －
/api/v2/scheduler/sched-list 〇 － ● －
/api/v2/scheduler/sched-list/{NUM} － 〇 ● 〇

凡例：

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

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

－ : 未対応

 

実行例

スケジュール設定の作成

メソッド URI
POST /api/v2/scheduler/sched-list
JSON
リクエスト

POST /api/v2/scheduler/sched-list
Content-Type: application/json

 

{
"sched-list": {
"number": 1,
"time": {
"minute": 0,
"hour": 1
},
"date": {
"day": "*",
"month": "*"
},
"order": {
"type": "system",
"action": "restart"
}
}
}

 

レスポンス

201 Created

 

XML
リクエスト

POST /api/v2/scheduler/sched-list
Content-Type: application/xml

 

<scheduler>
<sched-list>
<number>1</number>
<time>
<minute>0</minute>
<hour>1</hour>
</time>
<date>
<day>*</day>
<month>*</month>
</date>
<order>
<type>system</type>
<action>restart</action>
</order>
</sched-list>
</scheduler>

 

レスポンス

201 Created

 

全スケジュール設定の取得

メソッド URI
GET /api/v2/scheduler/sched-list
JSON
リクエスト

GET /api/v2/scheduler/sched-list
Accept: application/json

 

レスポンス

200 OK
Content-Type: application/json

 

{
"sched-list": [
{
"number": 1,
"time": {
"minute": 0,
"hour": 1
},
"date": {
"day": "*",
"month": "*"
},
"order": {
"type": "system",
"action": "restart"
}
},
{
"number": 2,
"time": {
"minute": 0,
"hour": 4
},
"date": {
"day": "*",
"month": "*"
},
"order": {
"type": "syslog",
"action": "rotate"
}
}
]
}

 

XML
リクエスト

GET /api/v2/scheduler/sched-list
Accept: application/xml

 

レスポンス

200 OK
Content-Type: application/xml

 

<scheduler>
<sched-list>
<number>1</number>
<time>
<minute>0</minute>
<hour>1</hour>
</time>
<date>
<day>*</day>
<month>*</month>
</date>
<order>
<type>system</type>
<action>restart</action>
</order>
</sched-list>
<sched-list>
<number>2</number>
<time>
<minute>0</minute>
<hour>4</hour>
</time>
<date>
<day>*</day>
<month>*</month>
</date>
<order>
<type>syslog</type>
<action>rotate</action>
</order>
</sched-list>
</scheduler>

 

TEXT/PLAIN
リクエスト

GET /api/v2/scheduler/sched-list
Accept: text/plain

 

レスポンス

200 OK
Content-Type: text/plain

 

schedule 1 01:00 * * system restart
schedule 2 04:00 * * syslog rotate

 

スケジュール設定の更新

メソッド URI
PUT /api/v2/scheduler/sched-list/{NUM}
JSON
リクエスト

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

 

{
"number": 1,
"time": {
"minute": 0,
"hour": 5
},
"date": {
"day": "*",
"month": "*"
},
"order": {
"type": "system",
"action": "restart"
}
}

 

レスポンス

204 No content

 

XML
リクエスト

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

 

<sched-list>
<number>1</number>
<time>
<minute>0</minute>
<hour>5</hour>
</time>
<date>
<day>*</day>
<month>*</month>
</date>
<order>
<type>system</type>
<action>restart</action>
</order>
</sched-list>

 

レスポンス

204 No content

 

スケジュール設定の取得

メソッド URI
GET /api/v2/scheduler/sched-list/{NUM}
JSON
リクエスト

GET /api/v2/scheduler/sched-list/1
Accept: application/json

 

レスポンス

200 OK
Content-Type: application/json

 

{
"number": 1,
"time": {
"minute": 0,
"hour": 5
},
"date": {
"day": "*",
"month": "*"
},
"order": {
"type": "system",
"action": "restart"
}
}

 

XML
リクエスト

GET /api/v2/scheduler/sched-list/1
Accept: application/xml

 

レスポンス

200 OK
Content-Type: application/xml

 

<sched-list>
<number>1</number>
<time>
<minute>0</minute>
<hour>5</hour>
</time>
<date>
<day>*</day>
<month>*</month>
</date>
<order>
<type>system</type>
<action>restart</action>
</order>
</sched-list>

 

TEXT/PLAIN
リクエスト

GET /api/v2/scheduler/sched-list/1
Accept: text/plain

 

レスポンス

200 OK
Content-Type: text/plain

 

schedule 1 05:00 * * system restart

 

スケジュール設定の削除

メソッド URI
DELETE /api/v2/scheduler/sched-list/{NUM}
リクエスト

DELETE /api/v2/scheduler/sched-list/1

 

レスポンス

204 No content

 

パラメータ

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

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

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

 

パラメータおよびレベル 説明
Lv.1 Lv.2 Lv.3 Lv.4 Lv.5
scheduler sched-list number スケジュール番号
time minute 分 … <0-59>
hour 時 … <0-23>、毎時の場合は*
date day 日 … <1-31>、毎日の場合は*
month 月 … <1-12>、毎月の場合は*
week start 週（始め） … [ sunday | monday | tuesday | wednesday | thursday | friday | saturday ]
end 週（終わり） … [ sunday | monday | tuesday | wednesday | thursday | friday | saturday ]
order type タイプ … [ config | dns-intercept | firmware | http-client | interface | ipsec | ipset | ipv6set | limit | mobile | monitor-log | ntp | speed-test | syslog | system | wifi | wol ]
※設定可能項目は機種により異なります
action action …

  • config … copy
  • dns-intercept … update
  • firmware … [ check | list-update | update ]
  • http-client … update
  • interface … [ connect | disconnect | reconnect ]
  • ipsec … [ connect | disconnect ]
  • ipset … update
  • ipv6set … update
  • limit … clear
  • mobile … [ clear | update ]
  • monitor-log … rotate
  • ntp … adjust
  • speed-test … restart
  • syslog … [ copy | rotate ]
  • system … [ notify | restart | resume | shutdown | sleep ]
  • wifi … clear
  • wol … send

※設定可能項目は機種により異なります
option option …

  • config … [ URL | cms ]
    ※URLではコンフィグの取得先を指定（ex. http://www.example.jp/config.xml）
  • dns-intercept … セットネーム
  • firmware … [ URL | cms | official ]
    ※URLではファームウェアまたリストの取得先を指定（ex. ftp://192.168.0.1/nxr530-v210601.bin）
  • http-client … HTTPクライアント番号
  • interface … pppX,wwanX
    ※Xはインタフェース番号（ex. ppp0）
  • ipsec … [ isakmp | tunnel ]
  • ipset … セットネーム
  • ipv6set … セットネーム
  • limit … pppX
    ※Xはインタフェース番号（ex. ppp0）
  • mobile … モバイル番号
  • monitor-log … [ reachability | resource ]
  • speed-test … テスト番号
  • syslog … cms
  • system … [ cms | schedule | timer ]
  • wifi … WiFiモジュール番号
  • wol … name

※設定可能項目は機種により異なります
soption soption …

  • config … [ config | config-and-save | startup-config ]
  • dns-intercept … URL
    ※URLではリストファイルの取得先を指定（ex. http://www.example.jp/dnsi-list.xml）
  • firmware … [ A.B.C.D | X:X::X:X ]
    ※送信元IPアドレスを指定
  • ipsec … isakmpまたはtunnel番号
  • ipset … URL
    ※URLではIPsetファイルの取得先を指定（ex. ftp://192.168.0.1/ipset.txt）
  • ipv6set … URL
    ※URLではIPv6setファイルの取得先を指定（ex. ftp://192.168.0.1/ipv6set.txt）
  • limit … data-usage
  • mobile …  … [ cms | gps-assist ]
  • system … [ <60-31536000>（sec） | <1-255> ]
    ※actionでsleep指定時、レジューム方法を指定。timer選択時はスリープ時間、schedule選択時はスケジュール番号を指定
    ※actionでshutdown指定時、次回起動時間を指定。timer選択時は次回起動するまでの時間、schedule選択時はスケジュール番号を指定
  • wol … WOLコンフィグ名

※設定可能項目は機種により異なります
toption toption …

  • config … [ A.B.C.D | X:X::X:X ]
    ※送信元IPアドレスを指定
  • dns-intercept … [ A.B.C.D | X:X::X:X ]
    ※送信元IPアドレスを指定
  • firmware … hold
  • ipset …  [ A.B.C.D | X:X::X:X ]
    ※送信元IPアドレスを指定
  • ipv6set … [ A.B.C.D | X:X::X:X ]
    ※送信元IPアドレスを指定
  • mobile … [ A.B.C.D | X:X::X:X | URL ]
    ※soptionでcms指定時は送信元IPアドレスを指定。gps-assist指定時はURL（gps assist dataの取得先）を指定
  • syslog … [ A.B.C.D | X:X::X:X ]
    ※送信元IPアドレスを指定
  • system … [ A.B.C.D | X:X::X:X ]
    ※送信元IPアドレスを指定

※設定可能項目は機種により異なります
foption foption …

  • config … <30-86400>（sec）
    ※マージンを指定
  • firmware … <30-86400>（sec）
    ※マージンを指定
  • mobile … [ <30-86400>（sec） | A.B.C.D | X:X::X:X ]
    ※soptionでcms指定時はマージンを指定。gps-assist指定時は送信元IPアドレスを指定
  • speed-test … <1-36000>（sec）
    ※マージンを指定
  • syslog … <30-86400>（sec）
    ※マージンを指定
  • system … <30-86400>（sec）
    ※マージンを指定

※設定可能項目は機種により異なります
fioption
  • mobile … <30-86400>（sec）
    ※gps-assist指定時のマージンを指定
password hidden 暗号化 … [ enable | disable ]
passphrase パスワード
apply 暗号化適用 … [ enable | disable ]
※hidden化する場合は必要