vyosでよく使用するコマンドをまとめてみた

はじめに

vyosで使用頻度が高いコマンドをまとめています。

環境

VyOS 1.3-rolling-202005031935

コマンド

モードの切り替え

VyOSには２つのモードがあります。

オペレーションモード	・パラメータの表示、プロセスの再起動やシャットダウン、情報のclear等が可能・SSHやTelnet等でログインした際や、root以外のユーザでログインした際の最初のモード
コンフィグレーションモード	・設定の編集が可能

コンフィグレーションモードでshowコマンドの結果を見たい場合、いちいちオペレーションモードに切り替えるのは手間がかかります。コマンドの頭に「run」をつけることでコマンドのままshowコマンドを実行できます。

操作

再起動/パワーオフ

再起動
$ reboot
Are you sure you want to reboot this system? [y/N] y

パワーオフ
$ poweroff
Are you sure you want to poweroff this system? [y/N] y

確認

Configの確認

階層表示させる
$ show configuration

コマンド形式で表示させる
$ show  configuration commands

特定の文字列（interfaces）を含むコマンドを表示させる
$ show  configuration commands | match interfaces

設定前後の確認

編集前後のConfigチェック
# compare
[edit system]
>host-name vyos2 ←編集後
[edit]
vyos@vyos#

日時の確認

$ show date
Tue 15 Nov 2022 10:55:36 AM JST

ログインしているユーザーを確認する

$ show system login users
Username    Type    Locked    Tty    From           Last login
----------  ------  --------  -----  -------------  ------------------------
vyos        vyos    False     pts/0  192.168.188.1  Fri Dec  9 12:39:37 2022
user01      vyos    False     pts/0  192.168.188.1  Fri Dec  9 12:45:24 2022

バージョンの確認

$ sh version
Version:          VyOS 1.3-rolling-202005031935
Release Train:    equuleus

Built by:         autobuild@vyos.net
Built on:         Sun 03 May 2020 19:35 UTC
Build UUID:       10f5fd23-4fdd-4fca-95bb-9f7baac9aeae
Build Commit ID:  2cb6f390d7bdaa

Architecture:     x86_64
Boot via:         installed image
System type:      VMware guest

Hardware vendor:  VMware, Inc.
Hardware model:   VMware Virtual Platform
Hardware S/N:     VMware-56 4d 2c d3 f5 f1 55 94-5e e8 58 68 bf 41 06 f4
Hardware UUID:    d32c4d56-f1f5-9455-5ee8-5868bf4106f4

Copyright:        VyOS maintainers and contributors

設定

設定の反映

設定の反映
# commit

設定の削除

設定を削除するにはdeleteコマンドを使用します。

タイムゾーンの削除
# delete system time-zone Asia/Tokyo

設定のキャンセル

設定をキャンセルするにはdiscardを使用します。

設定のキャンセル
# exit discard

ロールバック

1つ前のconfigに戻す。
# rollback 1

# rollback ?
Possible completions:
  <N>   Rollback to revision N (currently requires reboot)

  Revisions:
    0   2022-12-09 14:09:40 user01 by cli
    1   2022-12-09 12:45:07 vyos by cli
    2   2022-12-09 12:39:20 vyos by cli
    3   2022-12-09 12:38:01 vyos by cli
    4   2022-12-08 13:07:30 root by vyos-boot-config-loader
    5   2022-11-16 00:36:59 vyos by cli
   ・・・
    54  2020-05-04 16:30:45 root by init

sshを有効にする

# set service ssh

タイムゾーンの設定

# set system time-zone Asia/Tokyo

日時の設定

set date MMDDhhmmYY

$ set date 1115111422
Tue 15 Nov 2022 11:14:00 AM JST

ホスト名の設定

# set system host-name vyos

インターフェースの設定

DHCPを使用する場合
# set interfaces ethernet eth0 address dhcp

DHCPからIPが払い出されたか確認
$ show dhcp client leases
interface  : eth0
ip address : 192.168.xxx.xxx    [Active]
subnet mask: 255.255.255.0
domain name: localdomain        [overridden by domain-name set using CLI]
router     : 192.168.188.x
name server: 192.168.188.x
dhcp server: 192.168.188.x
lease time : 1800
last update: Fri Dec 9 15:47:57 JST 2022
expiry     : Fri Dec 09 16:17:57 JST 2022
reason     : BOUND

interface  : eth1
last update: Thu Jul 7 01:16:23 JST 2022
reason     : RELEASE


手動でIPを割り当てデフォルトルートを設定する場合
# set interfaces ethernet eth0 address 192.168.xxx.xxx/24
# set protocols static route 0.0.0.0/0 next-hop 192.168.xxx.xxx

DNSの設定

# set system name-server 8.8.8.8

NTPサーバの設定

NTP サーバ設定
# set system ntp server 'ntp.nict.jp'

NTP サーバ同期状態確認
$ show ntp
     remote           refid      st t when poll reach   delay   offset  jitter
==============================================================================
 162.159.200.123 10.199.8.4       3 u   24   64    7    6.978   -6.162   0.995
 185.242.56.3    217.31.202.100   2 u   25   64    7  263.115   -4.870   1.553
 133.243.238.243 .NICT.           1 u   23   64    7   15.888   -0.356   1.074
*133.243.238.164 .NICT.           1 u   31   64    3   16.089    0.399   1.192

DHCPサーバの設定

DHCPサーバのプールを作成
# set service dhcp-server shared-network-name LAN_Subnet01

IPを払い出す範囲を設定
# set service dhcp-server shared-network-name LAN_Subnet01 subnet 192.168.1.0/24 range 0 start 192.168.1.100
# set service dhcp-server shared-network-name LAN_Subnet01 subnet 192.168.1.0/24 range 0 stop 192.168.1.200

デフォルトゲートウェイの設定
# set service dhcp-server shared-network-name LAN_Subnet01 subnet 192.168.1.0/24 default-router 192.168.1.1

DNSサーバの設定
# set service dhcp-server shared-network-name LAN_Subnet01 subnet 192.168.1.0/24 dns-server 192.168.1.150

アカウントの作成とパスワードの設定

# set system login user user01
[edit]
# set system login user user01 authentication plaintext-password user01
[edit]
user01@vyos#

user01というユーザを作成してパスワードを設定する。パスワードは暗号化される。

Configの保存と確認

次回OS起動時でも反映されるようにディスクにSAVE
# save
Saving configuration to '/config/config.boot'...
Done
[edit]

$ sh file running://config/
########### DIRECTORY LISTING ###########
total 36K
drwxrwsr-x 2 root 4.0K Nov 15 11:17 archive/
drwxrwsr-x 2 root 4.0K May  4  2020 auth/
drwxrwsr-x 2 root 4.0K May  4  2020 scripts/
drwxrwsr-x 2 root 4.0K May  4  2020 support/
drwxr-sr-x 3 root 4.0K May  4  2020 url-filtering/
drwxrwsr-x 2 root 4.0K May  4  2020 user-data/
-rwxrwxr-x 1 root 4.3K Nov 15 11:31 config.boot
-rw-rw-r-- 1 root   36 Nov 15 11:08 vyos-migrate.log
vyos@vyos:~$

Configのロード

現在のcandidateコンフィグをすべて消去してloadしたコンフィグを読み込む
# load /config/config.boot
Loading configuration from '/config/config.boot'
Load complete. Use 'commit' to make changes effective.
[edit]

ロードしたconfigを反映
# commit