FELIXXRT
日本語English

CLI リファレンス

SSH(管理ユーザーでログイン)と本体の画面で使えるコマンドです。表示は英語です。コマンドは前の数文字だけでも通り(show int → show interfaces)、Tab で補い、? で候補を出します。

権限は管理画面と同じで、ロールで閲覧だけの領域は変えられません。

動作モード

ログインした直後のモードです。プロンプトは ユーザー名@ホスト名>。

コマンド説明
show interfacesインターフェース・アドレス・通信量
show configuration動作中の設定 [パス]
show routes経路表
show dhcp leasesDHCP のリース一覧
show vpn sites拠点間 VPN の状態
show vpn wireguardWireGuard のピア
show vpn openvpn接続中の OpenVPN のクライアント
show vpn ikev2接続中の IKEv2 の端末
show vpn l2tp接続中の L2TP の端末
show history設定履歴 [件数、既定 20]
show system版・稼働時間・時刻
show log最近のログ [行数]
show hardwareNIC の一覧(request interfaces assign で使う名前)
request interfaces assignrequest interfaces assign <WAN の NIC|none> <LAN の NIC> — NIC を WAN・LAN に割り当てる
request lan-addressrequest lan-address <アドレス/プレフィックス長> — LAN のアドレスと DHCP の割り当て範囲
request factory-default設定を既定の設定に置き換える
pingping <ホスト> — 4 回 ping を送る
traceroutetraceroute <ホスト>
configure設定モードに入る
confirmcommit で適用した変更を確定する
rollbackrollback <番号> — 前の設定を適用する
rebootルーターを再起動する
poweroffルーターの電源を切る
exit設定モードを出る。動作モードではログアウト
helpこの一覧

設定モード

configure で入ります。プロンプトは ユーザー名@ホスト名#。変更は「候補」に入り、commit するまで動作に影響しません。

コマンド説明
confirmcommit で適用した変更を確定する
setset <パス…> <値> — 候補を変える
deletedelete <パス…> — 候補から消す
showshow [パス…] — 候補の設定
compare候補と動作中の設定の違い
commitcommit [comment <文>] — 適用する。5 分以内に confirm しないと元に戻る
discard適用していない変更をすべて捨てる
runrun <コマンド> — 設定モードのまま動作モードのコマンドを使う
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

設定の項目(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 ratrue/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 dnssectrue/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> disabledtrue/false
firewall flowtabletrue/false

routes

routes static <item> to文字
routes static <item> via文字

vpn

vpn endpoint文字
vpn wireguard enabledtrue/false
vpn wireguard port数
vpn wireguard network文字
vpn wireguard mtu数
vpn openvpn enabledtrue/false
vpn openvpn proto文字
vpn openvpn port数
vpn openvpn network文字
vpn ikev2 enabledtrue/false
vpn ikev2 network文字
vpn l2tp enabledtrue/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> enabledtrue/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 aggressivetrue/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 enabledtrue/false
monitoring zabbix servers文字 のリスト
monitoring zabbix activetrue/false
monitoring zabbix hostname文字
monitoring zabbix psk_identity文字
monitoring zabbix psk文字
monitoring snmp enabledtrue/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 enabledtrue/false
monitoring node_exporter allow文字 のリスト
monitoring node_exporter port数