DNAC: DNA Center 調査用ログ取得手順（Restricted Shell 導入版, 2.3.3 以降）

yukoga · ‎2023-01-27

DNA Center の解析用ログ採取
注意事項
事前に準備するもの
rca ファイルの生成
magctl appstack status コマンド結果の取得
ファイルのコピー
ファイルの削除
参考資料
参考動画
ドキュメント

本ドキュメントでは、Cisco DNA Center (Cisco Digital Network Architecture Center) の 'rca' コマンドおよび 'magctl appstack status' コマンドによる基本的なログ採取方法を説明します。

本ドキュメント作成時に確認している製品バージョンは、Cisco DNA Center 2.3.3.6-70045 です。
Restricted Shell 導入環境での作業を想定しています。以前のバージョンについては DNAC: DNA Center 調査用ログ取得手順（Restricted Shell 未導入版）の記事をご参考ください。

DNA Center の解析用ログ採取

'rca' コマンドは、 DNA Center の Maglev プラットフォームで動作する解析用ログ収集のためのコマンドラインツールです。TAC からの指示があった場合、本手順にてオフライン解析用のファイルを取得できます。また、各サービスの稼働状況を簡易的に確認するため、'magctl appstack status' コマンド結果も同時に保存しておくと便利です。関連するサービスの概要や稼働状況の確認方法の詳細については、DNA Center の各サービスの記事を参照します。

注意事項

マルチノードクラスタ環境では、各ノードで 'rca' コマンドを実行し、全ノード分のファイルを採取します。
アプライアンスのインストール直後やノード再起動後は各サービスが起動完了しておらず、有効なログが取得できないことがあります。'magctl appstack status' コマンド結果にて稼働状況を確認するか、ノード起動から 100 分程度時間を置いてから 'rca' を取得します。
再現可能な問題を調査する場合、現象を再現させた後のタイミングで 'rca' コマンドを実行します。時間が経つと問題が発生していた時の環境情報を採取できなくなる可能性があります。
再現手順が GUI 操作を伴う場合、スクリーンショットとあわせて操作時の時刻情報も記録します。エラーが表示されてもすぐ消えてしまう場合など記録が困難な場合は、DNAC: GUI エラーメッセージの確認・保存手順を参照します。
'rca' コマンドの実行には、数分から数十分程度かかります。
'rca' コマンドが正常に実行できない場合は、DNAC: rcaコマンドが実行できない場合に取得頂きたいログを参考に資料を採取します。
Restricted Shell が導入されたバージョンでは実行可能なコマンドに制限があり、また SCP クライアント側からファイルを引き出すことができなくなっています。詳細は DNAC: magshell (Restricted Shell) の概要と bash 使用手順を参照します。
バージョン 2.3.5 では RCA コマンドの実行時の既知不具合 CSCwf57289 が報告されています。当該不具合の影響を受けるバージョンでは Cisco DNA Center 2.3.5 がクラッシュする問題の記事を参照して対応します。
バージョン 2.3.7 では GUI から RCA ファイルを取得できる新機能が導入されています。手順は Catalyst Center 2.3.7.x: RCA ファイルを Catalyst Center UI から生成する記事を参照します。

事前に準備するもの

CIMC GUI 管理画面の情報（アドレス、ユーザー名、パスワード）
SSH 接続用ターミナルソフトウェア（PuTTY, Tera Term など）
SCP でファイル受信可能なコピー先サーバの情報（アドレス、パス、ユーザー名、パスワード）
maglev ユーザー(CLI)と admin ユーザー(WebUI)のパスワード

rca ファイルの生成

CIMC 接続（推奨）の場合、Web ブラウザから CIMC の GUI 管理画面を開き、管理用ユーザー(通常 admin)でログインします。右上メニューの [Launch KVM] から [Java based KVM] と [HTML based KVM] のいずれかを選択してターミナルを起動します。

SSH 経由の場合、ポート番号は 2222 です。タイムアウトが発生しうるためDNAC: SSH ターミナルの idle timeout 抑制の記事を参考に対応します。
```
$ ssh -p 2222 maglev@<DNA Center の IP アドレス>
```
'maglev' ユーザーにて DNA Center CLI にログインします。

プロンプトから、'rca' コマンドを実行します。sudo パスワードを確認されますので、'maglev' ユーザーのパスワードを入力します。

$ rca

===============================================================
VERIFYING SSH/SUDO ACCESS
===============================================================
[sudo] password for maglev: <maglev ユーザーのパスワードを入力>
Done

’admin’ ユーザーのパスワードを確認されますので、パスワードを入力します。

===============================================================
VERIFYING ADMINISTRATION ACCESS

Please note that after 3 failed login attempts, diagnostic
collection will proceed, but not all diagnostics will be
collected.
===============================================================
[administration] password for 'admin': <admin ユーザーのパスワードを入力>
User 'admin' logged into 'kong-frontend.maglev-system.svc.cluster.local' successfully

ログ情報収集中は、ターミナルに rca コマンドの実行状況が出力されます。(この出力自体は DNA Center のログではないため、ファイル生成に問題が発生しない限り特に保存する必要はありません。)
取得時間は規模やログの量により異なりますが、完了までおよそ数分から数十分かかります。
```
===============================================================
RCA package created on Thu Jan 26 16:26:27 UTC 2023
===============================================================

2023-01-26 16:26:27 | INFO | Generating log for 'date'...
```
'rca' コマンド出力結果の最後には、実際に作成したログファイル名とパスが含まれています。
```
Created RCA package: /data/rca/maglev-<DNA Center の IP アドレス>-rca-<YYYY-MM-DD_hh-mm-ss>_UTC.tar.gz
```
生成したファイルは 'rca view' コマンドでも確認できます。
```
$ rca view 
```

magctl appstack status コマンド結果の取得

'maglev' ユーザーにて DNA Center の CLI にログインします。
SSH の場合のポート番号は 2222 です。
```
$ ssh -p 2222 maglev@<DNA Center の IP アドレス>
```
CIMC 管理画面から KVM コンソールを起動して CLI 環境を利用することも可能です。
プロンプトから、'magctl appstack status' コマンドを実行し、結果の出力をコピーして任意のテキストファイルに保存します。
```
$ magctl appstack status
```

ファイルのコピー

'rca copy' コマンドで rca ファイルのコピーを行います。scp コマンドオプションのようにファイル送信先のリモートサーバの情報を指定します。

$ rca copy --files maglev-<DNA Center の IP アドレス>-rca-<YYYY-MM-DD_hh-mm-ss>_UTC.tar.gz <コピー先サーバの username>@<コピー先サーバのアドレス>:<コピー先サーバのパス>

ファイルの削除

ファイル転送が完了したら、'rca clear' コマンドで rca ファイルを削除します。

$ rca clear maglev-<DNA Center の IP アドレス>-rca-<YYYY-MM-DD_hh-mm-ss>_UTC.tar.gz

'rca view' コマンドでファイルを確認します。

$ rca view

rca ファイルは容量が大きいため、生成したファイルをそのままにするような運用を続けると、ディスク容量を逼迫させることがあります。正常にファイルを引き上げたら消しておくことを推奨します。

参考資料

参考動画

RCAファイルの取得 - Cisco DNA Center(2.3.3以降) サクセスちゃんの Cisco Customer Success ちゃんねる