CLI リファレンス
SSH(管理ユーザーでログイン)と本体の画面で使えるコマンドです。表示は英語です。コマンドは前の数文字だけでも通り(show int → show interfaces)、Tab で補い、? で候補を出します。
権限は管理画面と同じで、ロールで閲覧だけの領域は変えられません。
動作モード
ログインした直後のモードです。プロンプトは ユーザー名@ホスト名>。
| コマンド | 説明 |
|---|---|
show interfaces | インターフェース・アドレス・通信量 |
show configuration | 動作中の設定 [パス] |
show routes | 経路表 |
show dhcp leases | DHCP のリース一覧 |
show vpn sites | 拠点間 VPN の状態 |
show vpn wireguard | WireGuard のピア |
show vpn openvpn | 接続中の OpenVPN のクライアント |
show vpn ikev2 | 接続中の IKEv2 の端末 |
show vpn l2tp | 接続中の L2TP の端末 |
show history | 設定履歴 [件数、既定 20] |
show system | 版・稼働時間・時刻 |
show log | 最近のログ [行数] |
show hardware | NIC の一覧(request interfaces assign で使う名前) |
request interfaces assign | request interfaces assign <WAN の NIC|none> <LAN の NIC> — NIC を WAN・LAN に割り当てる |
request lan-address | request lan-address <アドレス/プレフィックス長> — LAN のアドレスと DHCP の割り当て範囲 |
request factory-default | 設定を既定の設定に置き換える |
ping | ping <ホスト> — 4 回 ping を送る |
traceroute | traceroute <ホスト> |
configure | 設定モードに入る |
confirm | commit で適用した変更を確定する |
rollback | rollback <番号> — 前の設定を適用する |
reboot | ルーターを再起動する |
poweroff | ルーターの電源を切る |
exit | 設定モードを出る。動作モードではログアウト |
help | この一覧 |
設定モード
configure で入ります。プロンプトは ユーザー名@ホスト名#。変更は「候補」に入り、commit するまで動作に影響しません。
| コマンド | 説明 |
|---|---|
confirm | commit で適用した変更を確定する |
set | set <パス…> <値> — 候補を変える |
delete | delete <パス…> — 候補から消す |
show | show [パス…] — 候補の設定 |
compare | 候補と動作中の設定の違い |
commit | commit [comment <文>] — 適用する。5 分以内に confirm しないと元に戻る |
discard | 適用していない変更をすべて捨てる |
run | run <コマンド> — 設定モードのまま動作モードのコマンドを使う |
exit | 設定モードを出る。動作モードではログアウト |
help | この一覧 |
例
admin@felixxrt> configure admin@felixxrt# set dhcp lan lease 24h admin@felixxrt# set dns upstream [1.1.1.1, 9.9.9.9] admin@felixxrt# set firewall port_forwards web proto tcp admin@felixxrt# set firewall port_forwards web wan_port 8080 admin@felixxrt# set firewall port_forwards web to 192.168.1.20:80 admin@felixxrt# compare admin@felixxrt# commit comment "DHCP and DNS" Applied. Type confirm within 5 minutes to keep it; otherwise it is reverted automatically. admin@felixxrt# confirm admin@felixxrt# exit
- 値は YAML として読みます。数・true/false・[リスト]・{項目: 値} が書けます。
- リストの要素は名前(name)で指定します。無い名前を指定すると、その名前の要素が増えます。0 から始まる番号でも指定できます。
- 項目がそろうまでは「Saved, but cannot be committed yet」と足りない項目が出ます。そろえば commit できます。
- commit のあと 5 分以内に confirm しないと、自動で元に戻ります。管理画面の「確定」と同じです。
設定の項目(set のパス)
<name> は名前(インターフェース名・ゾーン名など)、<item> はリストの要素です。各項目の意味は管理画面の同じ名前の欄の「?」にあります。
system
system hostname | 文字 |
system timezone | 文字 |
system web_names | 文字 のリスト |
interfaces
interfaces <name> device | 文字 |
interfaces <name> mac | 文字 |
interfaces <name> vlan | 数 |
interfaces <name> zone | 文字 |
interfaces <name> mtu | 数 |
interfaces <name> ipv4 mode | 文字 |
interfaces <name> ipv4 address | 文字 |
interfaces <name> ipv4 gateway | 文字 |
interfaces <name> ipv4 dns | 文字 のリスト |
interfaces <name> ipv6 mode | 文字 |
interfaces <name> ipv6 pd_hint | 数 |
interfaces <name> ipv6 from | 文字 |
interfaces <name> ipv6 subnet_id | 数 |
interfaces <name> ipv6 ra | true/false |
interfaces <name> ipv6 address | 文字 |
interfaces <name> ipv6 gateway | 文字 |
interfaces <name> pppoe user | 文字 |
interfaces <name> pppoe password | 文字 |
interfaces <name> pppoe mtu | 数 |
interfaces <name> pppoe service | 文字 |
interfaces <name> ds_lite aftr | 文字 |
interfaces <name> map_e br | 文字 |
interfaces <name> map_e ipv6_prefix | 文字 |
interfaces <name> map_e ipv4_prefix | 文字 |
interfaces <name> map_e ea_len | 数 |
interfaces <name> map_e psid_offset | 数 |
interfaces <name> map_e format | 文字 |
dhcp
dhcp <name> range | 文字 のリスト |
dhcp <name> lease | 文字 |
dhcp <name> dns | 文字 のリスト |
dhcp <name> static <item> name | 文字 |
dhcp <name> static <item> mac | 文字 |
dhcp <name> static <item> ip | 文字 |
dns
dns upstream | 文字 のリスト |
dns cache_size | 数 |
dns dnssec | true/false |
dns local_domain | 文字 |
dns forward_zones <item> zone | 文字 |
dns forward_zones <item> servers | 文字 のリスト |
dns hosts <item> name | 文字 |
dns hosts <item> ip | 文字 |
firewall
firewall zones <name> input | 文字 |
firewall zones <name> forward | 文字 |
firewall zones <name> allow_services | 文字 のリスト |
firewall policies <item> from | 文字 |
firewall policies <item> to | 文字 |
firewall policies <item> action | 文字 |
firewall nat masquerade | 文字 のリスト |
firewall port_forwards <item> name | 文字 |
firewall port_forwards <item> proto | 文字 |
firewall port_forwards <item> from | 文字 |
firewall port_forwards <item> wan_port | 文字 |
firewall port_forwards <item> to | 文字 |
firewall rules <item> name | 文字 |
firewall rules <item> from | 文字 |
firewall rules <item> to | 文字 |
firewall rules <item> src | 文字 のリスト |
firewall rules <item> dst | 文字 のリスト |
firewall rules <item> proto | 文字 |
firewall rules <item> ports | 文字 |
firewall rules <item> action | 文字 |
firewall rules <item> disabled | true/false |
firewall flowtable | true/false |
routes
routes static <item> to | 文字 |
routes static <item> via | 文字 |
vpn
vpn endpoint | 文字 |
vpn wireguard enabled | true/false |
vpn wireguard port | 数 |
vpn wireguard network | 文字 |
vpn wireguard mtu | 数 |
vpn openvpn enabled | true/false |
vpn openvpn proto | 文字 |
vpn openvpn port | 数 |
vpn openvpn network | 文字 |
vpn ikev2 enabled | true/false |
vpn ikev2 network | 文字 |
vpn l2tp enabled | true/false |
vpn l2tp network | 文字 |
vpn l2tp psk | 文字 |
vpn groups <item> name | 文字 |
vpn groups <item> label | 文字 |
vpn groups <item> methods | 文字 のリスト |
vpn groups <item> allow | 文字 のリスト |
vpn groups <item> expires | 文字 |
vpn sites <item> name | 文字 |
vpn sites <item> label | 文字 |
vpn sites <item> enabled | true/false |
vpn sites <item> type | 文字 |
vpn sites <item> zone | 文字 |
vpn sites <item> remote_networks | 文字 のリスト |
vpn sites <item> local_networks | 文字 のリスト |
vpn sites <item> tunnel_address | 文字 |
vpn sites <item> mtu | 数 |
vpn sites <item> ipsec version | 数 |
vpn sites <item> ipsec peer | 文字 |
vpn sites <item> ipsec connect | 文字 |
vpn sites <item> ipsec local_id | 文字 |
vpn sites <item> ipsec remote_id | 文字 |
vpn sites <item> ipsec auth | 文字 |
vpn sites <item> ipsec psk | 文字 |
vpn sites <item> ipsec remote_ca | 文字 |
vpn sites <item> ipsec proposals | 文字 |
vpn sites <item> ipsec ike encryption | 文字 のリスト |
vpn sites <item> ipsec ike integrity | 文字 のリスト |
vpn sites <item> ipsec ike dh | 文字 のリスト |
vpn sites <item> ipsec ike lifetime | 文字 |
vpn sites <item> ipsec esp encryption | 文字 のリスト |
vpn sites <item> ipsec esp integrity | 文字 のリスト |
vpn sites <item> ipsec esp dh | 文字 のリスト |
vpn sites <item> ipsec esp lifetime | 文字 |
vpn sites <item> ipsec nat_traversal | 文字 |
vpn sites <item> ipsec dpd | 数 |
vpn sites <item> ipsec aggressive | true/false |
vpn sites <item> wireguard peer | 文字 |
vpn sites <item> wireguard public_key | 文字 |
vpn sites <item> wireguard listen_port | 数 |
vpn sites <item> wireguard preshared_key | 文字 |
vpn sites <item> wireguard keepalive | 数 |
monitoring
monitoring zabbix enabled | true/false |
monitoring zabbix servers | 文字 のリスト |
monitoring zabbix active | true/false |
monitoring zabbix hostname | 文字 |
monitoring zabbix psk_identity | 文字 |
monitoring zabbix psk | 文字 |
monitoring snmp enabled | true/false |
monitoring snmp allow | 文字 のリスト |
monitoring snmp version | 文字 |
monitoring snmp community | 文字 |
monitoring snmp user | 文字 |
monitoring snmp auth_password | 文字 |
monitoring snmp priv_password | 文字 |
monitoring snmp location | 文字 |
monitoring snmp contact | 文字 |
monitoring node_exporter enabled | true/false |
monitoring node_exporter allow | 文字 のリスト |
monitoring node_exporter port | 数 |