PowerShellでCisco DNA Center APIを使いネットワーク機器を効率的に一括更新する方法

ネットワーク管理において、複数の機器を効率的に管理し、一括で設定変更やファームウェア更新を行うことは、運用の負担を大きく軽減します。Cisco DNA Centerは、ネットワーク全体を統合的に管理できる強力なプラットフォームですが、そのAPIを利用することで、さらに柔軟な運用が可能になります。本記事では、PowerShellを用いてCisco DNA Center APIにアクセスし、ネットワーク機器を一括で更新する具体的な方法について解説します。スクリプトを活用することで、管理作業を自動化し、ミスを減らし、効率を向上させる方法を学びましょう。

Cisco DNA Center APIとは

Cisco DNA Center APIは、Cisco DNA Centerが提供するRESTful APIで、ネットワークの設定や管理、トラブルシューティングを自動化するためのインターフェースです。このAPIを利用することで、ネットワーク機器の詳細な情報取得、設定変更、ファームウェア更新、トポロジ情報の可視化など、幅広い操作をプログラムで実行できます。

主要な機能

Cisco DNA Center APIは、以下のような主要な機能を備えています：

機器情報の取得：ネットワーク機器の詳細情報やステータスを取得。
設定変更：ルーティング設定やACL（アクセスコントロールリスト）の一括適用。
ファームウェア管理：ファームウェアのアップデートやバージョン管理。
トラブルシューティング：ネットワークトラブルの特定や診断。

APIの種類

Cisco DNA Center APIは大きく分けて以下のカテゴリに分かれています：

Device APIs：機器情報の取得や操作を行うためのAPI。
Network APIs：ネットワーク全体の設定やトラブルシューティングを支援。
Intent APIs：ネットワークの目的（Intent）を設定するためのAPI。

Cisco DNA Center APIを利用することで、手作業では煩雑で時間がかかるネットワーク管理をスクリプトで簡素化し、効率的に運用することが可能になります。

PowerShellを使うメリット

PowerShellは、Windows環境で標準的に利用できるスクリプト言語であり、APIとの連携やシステム管理に適した柔軟性と強力な機能を持っています。Cisco DNA Center APIと組み合わせることで、ネットワーク管理の自動化に多くの利点をもたらします。

ネットワーク管理の効率化

PowerShellを使用することで、以下の効率化が実現します：

スクリプトによる一括処理：複数の機器に同じ設定や更新を適用できるため、時間を大幅に短縮できます。
繰り返し作業の自動化：ルーティン作業をスクリプト化することで、人的ミスを減らし、一貫性を確保できます。

APIとの簡単な連携

PowerShellは、RESTful APIとの連携を容易に行うためのコマンドレット（Invoke-RestMethodなど）を提供しています。これにより、Cisco DNA Center APIをシンプルに利用できます。

クロスプラットフォームの対応

最新のPowerShell（PowerShell Core）は、WindowsだけでなくLinuxやmacOSでも動作します。そのため、異なるプラットフォームからでも同じスクリプトを実行可能です。

スクリプトの再利用性

PowerShellスクリプトは、テンプレート化して他のプロジェクトや環境で再利用できます。また、変数やパラメータを活用することで柔軟に適応できます。

PowerShellを活用することで、Cisco DNA Center APIの機能を最大限に引き出し、日常的なネットワーク管理業務をより効率的かつ効果的に行うことが可能になります。

必要な事前準備

PowerShellを使用してCisco DNA Center APIを活用するためには、スクリプトを実行する環境の整備やCisco DNA Centerの設定を事前に行う必要があります。以下に具体的な準備手順を解説します。

1. PowerShellのセットアップ

PowerShellを最新バージョンにアップデートすることで、スクリプトの互換性や機能性を向上させることができます。

Windows環境の場合：Windows PowerShellを利用している場合は、最新のPowerShell（PowerShell Core）へのアップデートを推奨します。公式サイトからインストール可能です。
クロスプラットフォームの利用：LinuxやmacOSを利用している場合も、PowerShell Coreをインストールして利用できます。

2. 必要なモジュールのインストール

Cisco DNA Center APIを呼び出すためには、HTTPリクエストを扱うモジュールをインストールします。

必要なモジュール：Invoke-RestMethod（PowerShellに組み込み済み）。
他に必要なモジュールがある場合は、Install-Moduleコマンドでインストールします。

例：
“`powershell
Install-Module -Name Posh-SSH -Force

<h3>3. Cisco DNA Centerの準備</h3>  
Cisco DNA Center APIを利用するには、以下の設定を行う必要があります：  
- **APIアクセスの有効化**：Cisco DNA Centerの管理画面にログインし、APIアクセスを有効にします。  
- **ユーザーアカウントの作成**：APIにアクセスできる権限を持つユーザーアカウントを作成します。  
- **トークンの取得**：後述するトークンの発行手順で使用するための設定を完了させます。  

<h3>4. ネットワーク環境の確認</h3>  
Cisco DNA Centerと通信するために、ネットワークの接続状況を確認します。  
- Cisco DNA Centerのホスト名またはIPアドレスが正しく設定されていることを確認してください。  
- ポート（通常443）が開放されていることを確認します。  

<h3>5. 開発者ドキュメントの参照</h3>  
Cisco DNA Center APIの開発者向けドキュメントをダウンロードして、利用可能なエンドポイントやパラメータを確認します。公式ドキュメントは、Cisco DNA Centerの管理画面からアクセスできます。  

これらの準備を整えることで、PowerShellスクリプトの作成とCisco DNA Center APIの活用がスムーズに行えるようになります。
<h2>APIトークンの取得方法</h2>  

Cisco DNA Center APIを利用するには、認証のためにトークンを取得する必要があります。このトークンは、API呼び出し時に認証情報として使用されます。以下では、トークンの取得手順をPowerShellを使用して説明します。  

<h3>1. Cisco DNA CenterのAPIエンドポイントを確認</h3>  
トークンを取得するためのエンドポイントは、通常以下の形式になります：

https:///dna/system/api/v1/auth/token

ここで、`<DNA_CENTER_HOSTNAME>`はCisco DNA Centerのホスト名またはIPアドレスを指定します。  

<h3>2. 必要な情報を準備</h3>  
トークンを取得するには、以下の情報が必要です：  
- **ユーザー名**：APIアクセス権限を持つユーザーアカウントのユーザー名。  
- **パスワード**：上記アカウントのパスワード。  

<h3>3. PowerShellスクリプトでトークンを取得</h3>  
以下のPowerShellコードを使用して、トークンを取得します：

powershell

Cisco DNA Centerのホスト情報

$DNAC_Host = “https://”
$DNAC_Username = “” # ユーザー名
$DNAC_Password = “” # パスワード

トークン取得用エンドポイント

$TokenEndpoint = “$DNAC_Host/dna/system/api/v1/auth/token”

ヘッダー情報の準備

$Headers = @{
“Content-Type” = “application/json”
}

認証情報の送信とトークンの取得

$response = Invoke-RestMethod -Method POST -Uri $TokenEndpoint -Headers $Headers -Credential (Get-Credential) -SkipCertificateCheck

トークンの表示

$Token = $response.Token
Write-Output “取得したトークン: $Token”

<h3>4. トークンの保存と再利用</h3>  
取得したトークンは一定期間有効です（通常は5～60分間）。その間、再取得せずに使用可能です。トークンは以下のように変数に保存し、APIリクエストに利用します：

powershell
$Headers = @{
“Content-Type” = “application/json”
“X-Auth-Token” = $Token
}

<h3>5. トラブルシューティング</h3>  
- **認証エラー**：ユーザー名やパスワード、エンドポイントURLを再確認してください。  
- **接続エラー**：Cisco DNA Centerのホスト名/IPアドレスやネットワーク設定を確認します。  

このトークン取得手順を成功させることで、以降のAPIリクエストが可能になります。スクリプトに組み込むことで、認証プロセスを簡略化し、効率的な運用を実現します。
<h2>ネットワーク機器の一覧取得</h2>  

Cisco DNA Center APIを使用すると、ネットワークに接続されたすべての機器の情報を取得できます。以下では、PowerShellを使用してネットワーク機器の一覧を取得する方法を解説します。  

<h3>1. 使用するAPIエンドポイント</h3>  
ネットワーク機器の一覧を取得するためのエンドポイントは次のようになります：

https:///dna/intent/api/v1/network-device

このエンドポイントは、ネットワーク内のすべてのデバイス情報を返します。  

<h3>2. PowerShellスクリプト</h3>  
以下のスクリプトを使用して、機器一覧を取得します：

powershell

Cisco DNA Centerのホスト情報

$DNAC_Host = “https://”
$Token = “” # 事前に取得したトークン

機器一覧取得エンドポイント

$DeviceEndpoint = “$DNAC_Host/dna/intent/api/v1/network-device”

ヘッダー情報

$Headers = @{
“Content-Type” = “application/json”
“X-Auth-Token” = $Token
}

APIリクエストの送信

$response = Invoke-RestMethod -Method GET -Uri $DeviceEndpoint -Headers $Headers -SkipCertificateCheck

結果の表示

$response.response | ForEach-Object {
Write-Output “デバイス名: $($_.hostname), IPアドレス: $($_.managementIpAddress), 機種: $($_.platformId)”
}

<h3>3. スクリプトの動作</h3>  
- **トークンの利用**：取得した認証トークンをリクエストのヘッダーに含めます。  
- **APIレスポンスの処理**：レスポンスデータにはデバイスの詳細情報が含まれます。必要な項目（ホスト名、IPアドレス、機種など）を抽出して表示します。  

<h3>4. 実行結果の例</h3>  
スクリプトの実行により、以下のような結果が得られます：

デバイス名: Switch01, IPアドレス: 192.168.1.1, 機種: Catalyst 9300
デバイス名: Router01, IPアドレス: 192.168.1.254, 機種: ISR 4451
デバイス名: AccessPoint01, IPアドレス: 192.168.1.101, 機種: Aironet 3802

<h3>5. 応用例</h3>  
取得したデバイス情報をCSVファイルにエクスポートすることで、さらに便利に利用できます：

powershell

CSVファイルにエクスポート

$response.response | Select-Object hostname, managementIpAddress, platformId | Export-Csv -Path “NetworkDevices.csv” -NoTypeInformation
Write-Output “デバイス情報をCSVに保存しました。”

<h3>6. トラブルシューティング</h3>  
- **トークンエラー**：トークンが期限切れの場合は再取得してください。  
- **接続エラー**：DNSやネットワークの疎通状況を確認してください。  
- **データの空白**：機器がCisco DNA Centerに正しく登録されていることを確認してください。  

この手順を利用して、ネットワークの全体像を把握し、管理業務を効率化しましょう。
<h2>ファームウェア更新スクリプトの作成</h2>  

Cisco DNA Center APIを使用すると、ネットワーク機器のファームウェアを一括で更新できます。以下では、PowerShellを使用してファームウェア更新を行うスクリプトを構築する手順を解説します。  

<h3>1. 使用するAPIエンドポイント</h3>  
ファームウェア更新には以下のエンドポイントを使用します：

https:///dna/intent/api/v1/software/image/activation/device

このエンドポイントでは、指定したデバイスに対してファームウェアの適用を行います。  

<h3>2. スクリプトの構築</h3>  

以下のPowerShellスクリプトを使用して、ファームウェアを更新する手順を説明します：

powershell

Cisco DNA Centerのホスト情報

$DNAC_Host = “https://”
$Token = “” # 事前に取得したトークン

ファームウェア更新エンドポイント

$FirmwareEndpoint = “$DNAC_Host/dna/intent/api/v1/software/image/activation/device”

デバイスIDとイメージIDを指定

$DeviceID = “” # 対象デバイスのID
$ImageID = “” # 適用するファームウェアのID

リクエストボディの作成

$Body = @{
deviceUuid = $DeviceID
imageUuid = $ImageID
activate = $true
schedule = $false # 即時更新
} | ConvertTo-Json -Depth 2

ヘッダー情報

$Headers = @{
“Content-Type” = “application/json”
“X-Auth-Token” = $Token
}

APIリクエストの送信

$response = Invoke-RestMethod -Method POST -Uri $FirmwareEndpoint -Headers $Headers -Body $Body -SkipCertificateCheck

結果の確認

if ($response.status -eq “success”) {
Write-Output “ファームウェアの更新が開始されました。”
} else {
Write-Output “更新に失敗しました: $($response.message)”
}

<h3>3. スクリプトの動作説明</h3>  
- **デバイスIDとイメージID**：デバイスIDは対象機器を識別するため、イメージIDは適用するファームウェアを指定するために使用します。  
- **即時更新とスケジュール更新**：`schedule`パラメータを`true`にすると、スケジュールを設定して更新を実施できます。  

<h3>4. デバイスIDとイメージIDの取得方法</h3>  
- **デバイスIDの取得**：ネットワーク機器の一覧を取得する際に、各デバイスのIDがレスポンスに含まれています（`network-device`エンドポイントを使用）。  
- **イメージIDの取得**：使用可能なファームウェアの一覧は、以下のエンドポイントで取得できます：

https:///dna/intent/api/v1/software/image

<h3>5. スクリプト実行例</h3>  
以下のようなメッセージが表示されます：

ファームウェアの更新が開始されました。

または、エラーが発生した場合はエラーメッセージが表示されます。  

<h3>6. エラー発生時の対処</h3>  
- **デバイスが見つからない**：デバイスIDを再確認してください。  
- **イメージが適用できない**：ファームウェアのバージョンがデバイスに対応しているか確認してください。  
- **認証エラー**：トークンが有効であるか確認し、必要に応じて再取得してください。  

このスクリプトをカスタマイズすることで、複数のデバイスに対するファームウェア更新を一括で行い、管理業務を効率化できます。
<h2>スクリプト実行と動作確認</h2>  

作成したPowerShellスクリプトを実行し、Cisco DNA Center APIを通じてネットワーク機器のファームウェアを更新します。この段階では、スクリプトの動作確認や結果の検証を行い、正しく更新が行われているかを確認します。  

<h3>1. スクリプトの実行方法</h3>  

以下の手順でPowerShellスクリプトを実行します：  

1. **PowerShellを開く**：管理者権限でPowerShellを起動します。  
2. **スクリプトファイルの準備**：作成したスクリプトをファイル（例：`UpdateFirmware.ps1`）として保存します。  
3. **実行ポリシーの確認**：スクリプトの実行ポリシーを変更します（必要に応じて）。

powershell
Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass

4. **スクリプトの実行**：以下のコマンドを実行します。

powershell
.\UpdateFirmware.ps1

<h3>2. 実行結果の確認</h3>  

スクリプトの実行結果はコンソールに出力されます。以下のような結果が表示されます：  

- **成功時**：

ファームウェアの更新が開始されました。

- **エラー時**：

更新に失敗しました: 指定されたデバイスが見つかりません。

<h3>3. Cisco DNA Centerでの確認</h3>  

スクリプトの実行後、Cisco DNA Centerの管理画面から以下を確認します：  

- **デバイスの更新ステータス**：対象デバイスのファームウェア更新が進行中または完了していることを確認します。  
- **エラーの有無**：管理画面に表示されるエラー情報を確認します。  

<h3>4. スクリプトのログ出力</h3>  

スクリプトにログ出力機能を追加することで、実行結果を記録できます。例：

powershell

ログファイルに出力

$LogFile = “FirmwareUpdateLog.txt”
$response.response | Out-File -FilePath $LogFile -Append
Write-Output “ログファイルに結果を保存しました: $LogFile”

<h3>5. トラブルシューティング</h3>  

- **接続エラー**：Cisco DNA Centerへの通信が失敗した場合、以下を確認します：  
  - ホスト名またはIPアドレスが正しいこと。  
  - ポート443が開放されていること。  

- **認証エラー**：トークンの有効期限が切れている場合、再取得してください。  

- **対象デバイスが更新されない**：デバイスIDやファームウェアIDが正しいことを再確認してください。  

<h3>6. 更新結果の検証</h3>  

ファームウェア更新が完了した後、以下を確認します：  

- **デバイスのファームウェアバージョン**：更新後のバージョンが適用されていることを確認します。  
- **動作確認**：デバイスが正常に動作しているかをテストします。  

これらの手順を通じて、スクリプトの実行が正しく行われ、ネットワーク機器のファームウェアが適用されたことを確認できます。
<h2>エラー発生時の対処方法</h2>  

スクリプト実行中にエラーが発生することがあります。ここでは、一般的なエラーの原因とその対処方法について説明します。これらの方法を使用して、スクリプトを正常に動作させましょう。  

<h3>1. トークン関連のエラー</h3>  

**エラー例**：

Unauthorized: Invalid Token

**原因**：  
- トークンが有効期限切れになっている。  
- トークンが正しく取得されていない。  

**対処方法**：  
- トークンの有効期限を確認し、期限切れの場合は再取得してください。  
- トークン取得時の認証情報（ユーザー名、パスワード）が正しいか確認してください。  

**再取得コマンド例**：

powershell

トークンの再取得

$response = Invoke-RestMethod -Method POST -Uri $TokenEndpoint -Headers $Headers -Credential (Get-Credential) -SkipCertificateCheck
$Token = $response.Token

---

<h3>2. デバイス関連のエラー</h3>  

**エラー例**：

Device not found

**原因**：  
- 指定したデバイスIDが存在しない。  
- デバイスがCisco DNA Centerに正しく登録されていない。  

**対処方法**：  
- ネットワーク機器の一覧を取得して、デバイスIDが正しいか確認してください。  
- Cisco DNA Centerで対象デバイスが管理対象になっていることを確認してください。  

**確認コマンド例**：

powershell
$response = Invoke-RestMethod -Method GET -Uri “$DNAC_Host/dna/intent/api/v1/network-device” -Headers $Headers -SkipCertificateCheck
$response.response | ForEach-Object {
Write-Output “デバイスID: $($_.id), ホスト名: $($_.hostname)”
}

---

<h3>3. ファームウェア関連のエラー</h3>  

**エラー例**：

Invalid Image ID

**原因**：  
- ファームウェアのイメージIDが正しく指定されていない。  
- デバイスに対応していないファームウェアが指定されている。  

**対処方法**：  
- 使用可能なファームウェアの一覧を取得して、イメージIDが正しいか確認してください。  
- デバイスに適合するファームウェアを選択してください。  

**確認コマンド例**：

powershell
$response = Invoke-RestMethod -Method GET -Uri “$DNAC_Host/dna/intent/api/v1/software/image” -Headers $Headers -SkipCertificateCheck
$response.response | ForEach-Object {
Write-Output “イメージID: $($_.id), バージョン: $($_.version)”
}

---

<h3>4. 接続エラー</h3>  

**エラー例**：

Connection timed out

**原因**：  
- Cisco DNA Centerのホスト名またはIPアドレスが間違っている。  
- ネットワーク接続が遮断されている。  

**対処方法**：  
- Cisco DNA Centerのホスト名またはIPアドレスを確認してください。  
- ポート443が開放されているか確認し、ネットワークの接続状況をチェックしてください。  

**確認コマンド例**：

powershell
Test-Connection -ComputerName

---

<h3>5. 一般的なデバッグ手法</h3>  

エラーが特定できない場合は、以下の手法を試してください：  
- **APIレスポンスの確認**：レスポンス全体をログに出力し、エラーの詳細を確認します。

powershell
$response | ConvertTo-Json | Out-File “ResponseLog.json”

- **詳細ログの有効化**：PowerShellでデバッグモードを有効にします。

powershell
$DebugPreference = “Continue”
“`

6. エラー発生時のまとめ

エラーが発生した場合、問題を分解して以下の順序で確認してください：

トークンや認証情報が正しいか。
デバイスIDやファームウェアIDが正しいか。
Cisco DNA Centerとの接続が正常か。

これらの対処方法を活用して、スクリプトを正常に動作させ、ファームウェア更新を成功させましょう。

まとめ

本記事では、PowerShellを活用してCisco DNA Center APIを使用し、ネットワーク機器を一括で更新する方法を解説しました。Cisco DNA Center APIの基本概要からトークンの取得、ネットワーク機器の一覧取得、ファームウェア更新スクリプトの作成、そしてエラー発生時の対処方法まで、具体的な手順を紹介しました。

PowerShellスクリプトを活用することで、ネットワーク管理業務を効率化し、手作業によるミスを減らしながら迅速な運用が可能となります。本記事を参考に、より効率的で柔軟なネットワーク管理を実現してください。

この記事を書いた人

佐藤健司

実務の現場で詰まりがちなポイントを地図にするITブログ「IT trip」を運営。Windows／Office（Teams・Excel）からSQL、サーバ運用、ガジェットまで、再現性のある手順と“なぜそうなるか”を丁寧に解説します。読んだらすぐ試せること、そして迷った人の次の一歩が見えることを大切にしています。

PowerShellでCisco DNA Center APIを使いネットワーク機器を効率的に一括更新する方法

Cisco DNA Center APIとは

主要な機能

APIの種類

PowerShellを使うメリット

ネットワーク管理の効率化

APIとの簡単な連携

クロスプラットフォームの対応

スクリプトの再利用性

必要な事前準備

1. PowerShellのセットアップ

2. 必要なモジュールのインストール

Cisco DNA Centerのホスト情報

トークン取得用エンドポイント

ヘッダー情報の準備

認証情報の送信とトークンの取得

トークンの表示

Cisco DNA Centerのホスト情報

機器一覧取得エンドポイント

ヘッダー情報

APIリクエストの送信

結果の表示

CSVファイルにエクスポート

Cisco DNA Centerのホスト情報

ファームウェア更新エンドポイント

デバイスIDとイメージIDを指定

リクエストボディの作成

ヘッダー情報

APIリクエストの送信

結果の確認

ログファイルに出力

トークンの再取得

6. エラー発生時のまとめ

まとめ

この記事を書いた人

コメント

コメントするコメントをキャンセル

PowerShellでCisco DNA Center APIを使いネットワーク機器を効率的に一括更新する方法

Cisco DNA Center APIとは

主要な機能

APIの種類

PowerShellを使うメリット

ネットワーク管理の効率化

APIとの簡単な連携

クロスプラットフォームの対応

スクリプトの再利用性

必要な事前準備

1. PowerShellのセットアップ

2. 必要なモジュールのインストール

Cisco DNA Centerのホスト情報

トークン取得用エンドポイント

ヘッダー情報の準備

認証情報の送信とトークンの取得

トークンの表示

Cisco DNA Centerのホスト情報

機器一覧取得エンドポイント

ヘッダー情報

APIリクエストの送信

結果の表示

CSVファイルにエクスポート

Cisco DNA Centerのホスト情報

ファームウェア更新エンドポイント

デバイスIDとイメージIDを指定

リクエストボディの作成

ヘッダー情報

APIリクエストの送信

結果の確認

ログファイルに出力

トークンの再取得

6. エラー発生時のまとめ

まとめ

この記事を書いた人

関連記事

コメント

コメントする コメントをキャンセル

コメントするコメントをキャンセル