UnimusでLinuxサーバーの設定ファイルをバックアップ・差分管理してみた

はじめに

ネットワーク障害が発生した際、原因調査の対象となるのはルーターやスイッチだけとは限りません。DNSサーバーや認証サーバーなど、Linuxサーバー上の設定変更が関係している場合もあります。

しかし、ネットワーク機器のコンフィグはUnimus、Linuxサーバーの設定ファイルは別のツールや保存先で管理しているなど、設定情報の確認先が分かれていることもあります。

もし、Linuxサーバーの設定ファイルもUnimusに取り込み、ネットワーク機器と同じ管理画面からバックアップ履歴や変更差分を確認できれば、障害調査や設定変更作業の確認がしやすくなるのではないでしょうか。

そこで今回は、UnimusのREST APIとPowerShellを組み合わせ、Ubuntu Linuxの設定ファイルをUnimusでバックアップ・差分管理するPoC(概念実証)を実施しました。

Unimusとは

Unimusは、ネットワーク機器のコンフィグバックアップや変更履歴の管理、設定の一括反映などを行うネットワーク構成管理ツールです。

Cisco、Juniper、Fortinetなど、さまざまなメーカーのネットワーク機器に対応しており、取得したコンフィグをWeb画面から確認したり、変更前後の差分を比較したりできます。

通常は、Unimus自身が対応機器に接続し、設定されたスケジュールに従ってコンフィグを自動取得します。

また、REST APIを備えており、外部のプログラムからデバイスの登録やバックアップデータの操作も可能です。

今回はこのAPIを活用し、Unimusが直接取得しないLinuxの設定ファイルを、外部から取り込んで管理する方法を検証します。

今回のPoCの仕組み

今回のPoCでは、Linuxサーバーの設定ファイルをPowerShellで取得し、Unimusにバックアップとして登録します。

処理は「初回準備」と「バックアップ処理」の2つに分かれます。

Linux設定バックアップの全体構成図
UnmanagedデバイスとREST APIを利用したLinux設定バックアップの流れ

Unmanagedデバイスを利用する理由

Unimusでは通常、Managedデバイスに対してDiscovery(機器の識別)や自動バックアップを行います。

一方、UnmanagedはUnimusによる通常の自動管理の対象から外した状態です。Discoveryや自動バックアップは実行されませんが、デバイス情報やバックアップ履歴は保持されます。

今回のPoCでは、UbuntuをUnmanagedとして登録し、設定ファイルの取得を外部スクリプトに任せます。

取得したデータはREST API経由で登録するため、Unimusによる自動取得を使用しなくても、バックアップ履歴や差分表示の機能を活用できます。

検証環境

今回の検証環境は次のとおりです。

項目検証環境
Unimus2.10.0-Beta2
対象サーバーUbuntu Linux(192.168.xx.xxx)
実行環境Windows PowerShell
設定ファイル取得SCP(SSH)
バックアップ登録Unimus REST API v2
整合性確認SHA-256

バックアップ対象には、UbuntuのSSHサーバー設定ファイルを使用しました。

/etc/ssh/sshd_config

今回は、この設定ファイルの取得・保存を検証するとともに、別途用意した検証用ファイルで差分表示も確認します。

※Unimus 2.10.0-Beta2はベータ版です。

Linux設定ファイルのバックアップ手順

UbuntuをUnmanagedとして登録

まず、Unimus REST API v2を利用するためのAPIトークンを準備します。

UnimusのREST API v2では、APIトークンによる認証が必要です。APIトークンは、Unimusの管理画面にある「ユーザー管理(User management)> APIトークン(API tokens)」から作成できます。

UnimusのAPIトークン管理画面
UnimusのAPIトークン管理画面。REST APIへのアクセスに必要なトークンを作成します。

続いて、作成したAPIトークンを使用し、PowerShellからUnimus REST API v2を呼び出してUbuntuを登録します。

使用したエンドポイントは以下です。

POST /api/v2/devices

今回は、次の情報を指定しました。

{
  "address": "192.168.xx.xxx",
  "description": "Ubuntu-Linux-Backup-PoC",
  "managed": false
}

ここで重要なのが、managed: falseです。

Unimus 2.9.0以降では、API v2を使ったデバイス登録時にManaged / Unmanagedの状態を指定できます。

今回は、Ubuntu上の設定ファイルをPowerShellで取得し、その内容をUnimus API経由で登録する方式を採用しました。そのため、Ubuntuを**Unmanaged(自動管理対象外)**として登録しています。

登録が成功すると、UnimusからデバイスID(deviceId)が返されます。このIDは、後続のバックアップ登録APIで使用します。

Unmanagedデバイスとして登録したUbuntu
Unimusに登録されたUbuntuと、Unmanaged(このデバイスを管理しない)の設定状態

このデバイス登録は初回の準備作業です。 以降は登録済みのdeviceIdを使用するため、バックアップのたびにデバイスを登録し直す必要はありません。

次に、PowerShellからUbuntuに接続し、バックアップ対象の設定ファイルを取得します。

PowerShellから設定ファイルを取得

続いて、Windows PowerShellからUbuntuに接続し、バックアップ対象の設定ファイルを取得します。

今回は、Windows環境のOpenSSHに含まれるscpコマンドを使用し、UbuntuのSSHサーバー設定ファイル/etc/ssh/sshd_configをWindows側の一時ファイルとして保存しました。

接続にはUbuntuのSSHアカウントを使用します。

ファイル取得後は、Ubuntu側の元ファイルとWindows側に保存したファイルについて、それぞれSHA-256ハッシュ値とファイルサイズを比較し、内容が一致することを確認しました。

取得したファイルをUnimusに登録

PowerShellで取得した設定ファイルの内容を、Unimus REST API v2を使用してバックアップとして登録します。

使用したエンドポイントは以下です。

POST /api/v2/devices/{deviceId}/backups

ここで指定するdeviceIdは、手順1でUbuntuを登録した際に取得したものです。

今回は、Windows側に一時保存した設定ファイルの内容を読み込み、Base64形式に変換してAPIに送信しました。

{
  "backup": "<Base64形式に変換した設定データ>",
  "type": "TEXT"
}

TEXTを指定することで、Unimus上ではテキスト形式のバックアップとして管理されます。

つまり、設定ファイルそのものをアップロードするのではなく、ファイルの内容を登録済みUbuntuのバックアップデータとして保存する仕組みです。

これにより、UnimusのWeb画面から設定内容を確認したり、変更前後の差分を比較したりできます。

動作検証

バックアップの保存と整合性

Ubuntuから取得したsshd_configの内容をUnimusに登録したところ、バックアップ画面から設定内容を確認できました。

さらに、Unimusに保存されたデータをAPIで再取得し、元ファイルと内容が一致することも確認しました。

GET /api/v2/devices/{deviceId}/backups/latest

その結果、Ubuntu上の元ファイル、SCPで取得したファイル、Unimusに保存されたデータの内容が一致することを確認できました。

Unimusのバックアップ表示画面
Unimusにバックアップとして登録したUbuntuのSSH設定ファイル

設定変更前後の差分表示

続いて、設定変更時の差分表示を確認するため、検証用の設定ファイルを用意しました。

このファイルの内容をUnimusにバックアップとして登録した後、一部の設定を変更して再度登録しました。

その結果、変更後の内容が新しいバックアップ履歴として保存され、UnimusのWeb画面から変更前後の差分を確認できました。

Unimusの差分表示画面
検証用ファイルの変更前後をUnimusで比較

今回のPoCで特に注目したいのが、この差分表示です。

外部からAPI経由で登録したテキストデータについても、Unimusの差分表示機能を利用できることを確認しました。

例えば、Linuxサーバーの設定変更前後のデータを同じ方法で登録すれば、設定変更の確認や障害調査への活用が期待できます。

その他の検証結果

バックアップの保存と差分表示に加え、次の動作も確認しました。

検証内容結果
設定内容を変更せず再登録新しいバックアップ履歴は増えなかった
存在しないファイルを指定SCPの取得エラーを検出
ファイル取得に失敗API登録を行わず、既存履歴を維持

Unimusでは、設定内容に変更があった場合に新しいバックアップ履歴が作成されます。今回の検証でも、API経由で同じ内容を再登録した際には新しい履歴が追加されず、通常のバックアップと同様に変更履歴を管理できることを確認しました。

実運用での活用例

今回の仕組みを応用すれば、ネットワーク機器だけでなく、Linuxサーバーの設定変更履歴もUnimus上で確認する運用が考えられます。

例えば、社内システムへの接続障害が発生し、ネットワーク機器とDNSサーバーの両方を調査するケースです。

ルーターやスイッチの設定はUnimusで確認できても、Linux上のDNS設定が別の場所で管理されていると、調査のたびに保存先やツールを切り替える必要があります。

DNSサーバーの設定情報も今回の方式でUnimusに取り込んでおけば、ネットワーク機器とLinuxサーバーの設定変更履歴を、同じ管理画面から確認できます。

これは、すでにUnimusを利用している企業にとって、既存の構成管理環境を活かしながら管理対象を広げられるというメリットがあります。

さらに実運用へ発展させるなら

今回のPoCでは、PowerShellからの設定ファイル取得とUnimusへのバックアップ登録を実証しました。

この仕組みを実運用に発展させる場合、例えばWindowsのタスクスケジューラを利用して、バックアップ処理を定期実行する方法が考えられます。

デバイス登録は初回の準備作業なので、定期実行するのは設定ファイルの取得とAPIによるバックアップ登録の部分です。

さらに、取得失敗時の通知を組み込んだり、WebサーバーやDNSサーバーなど、ほかの設定ファイルにも対象を広げたりすることで、より実用的な設定管理へと発展させられるでしょう。

なお、定期実行や複数ファイルへの対応は今回の検証対象外です。実運用では、取得権限や機密情報の保護、ファイルの管理単位についても検討する必要があります。

まとめ

今回は、Unimus REST API v2とWindows PowerShellを組み合わせ、Ubuntu Linuxの設定ファイルをUnimusでバックアップ・差分管理するPoCを実施しました。

実際のSSH設定ファイルについては、SCPによる取得、Unimusへのバックアップ登録、保存データの整合性を確認しました。また、別途用意した検証用ファイルでは、変更前後の差分表示やバックアップ履歴の管理も確認できました。

今回の検証では、Unimusが標準のバックアップ機能で直接対応していないLinuxサーバーについても、外部スクリプトとREST APIを組み合わせることで、設定情報をUnimus上でバックアップ・差分管理できることを確認しました。

この仕組みは、Unimusの標準サポート対象外の機器にも管理範囲を広げられる可能性があるという点で、さまざまな運用環境への応用が期待できます。

今回のPoCが、Unimusの活用範囲を広げるヒントになれば幸いです。

参考資料

さいごに

Unimusのインストールから初期設定、デバイス登録、バックアップ取得までの詳しい操作手順を確認したい場合は、Unimus評価ガイドもあわせてご活用ください。

Unimusの詳細や評価版については、製品紹介ページやダウンロードページもあわせてご確認ください。

こんな記事も読まれています

最新記事

おすすめ記事

  1. 「ログイン成功」でも安心できない?正常なログに潜む異常の兆候を見つけるUEBA

  2. ゼロから始めるCheckmk!評価版OVA×VirtualBoxで簡単に検証環境を構築

  3. AIが1万件超の脆弱性を見つける時代に、企業は“既知の穴”を塞げているか

製品カテゴリー

その他の情報

TOP