概要
このドキュメントでは、Open APIを使用してCisco Identity Service Engine(ISE)3.3ライセンスを設定する方法について説明します。
前提条件
要件
次の項目に関する知識があることが推奨されます。
- Cisco ISE 3.3
- REST API
- スマート ソフトウェア ライセンシング
使用するコンポーネント
このドキュメントの情報は、次のソフトウェアとハードウェアのバージョンに基づいています。
- Cisco ISE 3.3
- 不眠症REST APIクライアント。
このドキュメントの情報は、特定のラボ環境にあるデバイスに基づいて作成されました。このドキュメントで使用するすべてのデバイスは、クリアな(デフォルト)設定で作業を開始しています。本稼働中のネットワークでは、各コマンドによって起こる可能性がある影響を十分確認してください。
背景説明
Cisco ISEライセンスは、Cisco ISEネットワークリソースをいつでも使用できる同時アクティブエンドポイントの数など、アプリケーションの機能とアクセスを管理する機能を提供します。Cisco ISEのライセンスは、フィーチャベースのパッケージとして提供されます。フィーチャベースのパッケージでは、ライセンスタイプごとに異なる機能がサポートされます。
Cisco ISEはサブスクリプションベースのソリューションです。Cisco ISEサブスクリプションライセンスはネストされています。つまり、上位ティアのライセンスにはすべての下位ティアの機能が含まれています。たとえば、ISE Premierライセンスには、ISE AdvantageおよびISE Essentialsライセンスにマッピングされたすべての機能が含まれます。同様に、ISE Advantageライセンスには、ISE Essentialsライセンスにマッピングされたすべての機能が含まれます。このモデルでは、Essentialsライセンスを必要とせずに、PremierライセンスまたはAdvantageライセンスを直接購入できます。
最初のステップ
ISEでのOpen APIの有効化
Open APIは、ISEではデフォルトで無効になっています。これを有効にするには、Administration > System > API Settings > API Service Settingsの順に移動します。Open APIオプションを切り替えます。[Save] をクリックします。
API設定を開く
Swagger UI
ISE上のすべてのオープンAPI定義にアクセスするには、Administration > System > Settings > API Settingsの順に移動します。リンクをクリックします。ISE Open APIの詳細については、を参照してください。
このドキュメントで使用する定義のURLは、https://<ISE-PAN-IP>/api/swagger-ui/index.html?urls.primaryName=Licenseです。
Open APIを使用したライセンスの設定
GETライセンス階層の状態
ライセンスを設定するには、ライセンスが設定されていないため、コンプライアンス属性を評価に設定できるため、コンプライアンス属性を階層ステートを使用して認識する必要があります。
メソッド |
GET |
URL |
https://<ISE-PAN-IP>:443/api/v1/license/system/tier-state |
認証タイプ |
基本 |
Credentials |
Open APIアカウントの資格情報を使用する |
ヘッダー |
許可:application/json コンテンツタイプ:application/json |
[Authentication]
ティア状態認証
ヘッダー
階層ステートヘッダー
予想される出力
Tier-stateの予想される出力
評価ライセンスの残り日数
評価ライセンスの残りの日数を知るには、このAPI呼び出しを使用します。
メソッド |
GET |
URL |
https://<ISE-PAN-IP>:443/api/v1/license/system/eval-license |
認証タイプ |
基本 |
Credentials |
Open APIアカウントの資格情報を使用する |
ヘッダー |
許可:application/json コンテンツタイプ:application/json |
[Authentication]
評価ライセンス認証
ヘッダー
評価ライセンスのヘッダー
予想される出力
評価ライセンスの予想される出力
ライセンスの登録
注:スマートライセンストークンの作成については、このドキュメントの対象外です。
ライセンスを登録するには、connectionType、registrationType、およびtierを入力する必要があります。
接続の種類:
- HTTP_DIRECT
- プロキシ
- SSM_ONPREM_SERVER:この属性を選択した場合は、ssmOnPremServerキーと値を宣言する必要があります。
- TRANSPORT_GATEWAY(トランスポートゲートウェイ)
登録タイプ:
階層:
メソッド |
POST |
URL |
https://<ISE-PAN-IP>:443/api/v1/license/system/register |
認証タイプ |
基本 |
Credentials |
Open APIアカウントの資格情報を使用する |
ヘッダー |
許可:application/json コンテンツタイプ:application/json |
本文 |
{ "connectionType": "PROXY", "registrationType": "REGISTER", "ssmOnPremServer": "CSSM28.demo.local", "tier": [ "ADVANTAGE", "DEVICEADMIN", "ESSENTIAL", "PREMIER", "VM" ], "token": "NzFjNjQyYWYtMjkyYS00OGJiLTkzNzYtNWY5Nzg5OTU4ZjhkLTE2MzE2MTM1%0AMTg4ODl8QU0wdWUzRmZXRnhBQzBWZldmTmZaTjFwdzdaZ0diVXpmU0hjTUVz%0AS0NYZz0%3D%0A" } |
本文
POST – ライセンス本文の登録
[Authentication]
POST – ライセンス認証の登録
ヘッダー
POST – ライセンスヘッダーの登録
予想される出力
POST – ライセンスの登録に必要な出力
確認
ライセンス情報の登録
登録の設定に使用されるキーと値のペアを確認するには、このAPIコールを使用します。
メソッド |
GET |
URL |
https://<ISE-PAN-IP>:443/api/v1/license/system/register |
認証タイプ |
基本 |
Credentials |
Open APIアカウントの資格情報を使用する |
ヘッダー |
許可:application/json コンテンツタイプ:application/json |
[Authentication]
GET – ライセンス認証の登録
ヘッダー
GET – ライセンスヘッダーの登録
予想される出力
GET – ライセンスの登録に必要な出力
スマートライセンス情報の取得
スマートライセンスとの接続の状態を確認するには、このAPIコールを使用します。
メソッド |
GET |
URL |
https://<ISE-PAN-IP>:443/api/v1/license/system/register |
認証タイプ |
基本 |
Credentials |
Open APIアカウントの資格情報を使用する |
ヘッダー |
許可:application/json コンテンツタイプ:application/json |
[Authentication]
スマートライセンス情報の認証
ヘッダー
スマートライセンス情報ヘッダー
予想される出力
スマートライセンス情報の予想される出力
ISE GUIライセンスの検証
GUIで正しくインストールされていることを確認します。Administration > System > Licensing > Licensesの順に移動します。
スマートライセンスGUIの検証
注:リリース済みの権限付与とは、ライセンスが購入され、使用のためにリリースされたが、このCisco ISE導入ではこれまで消費されていないことを意味します。このようなシナリオでは、ライセンスの消費数は0です。消費数が0から変更されると、ライセンスはコンプライアンスに変更されます
トラブルシュート
ライセンス
ISEから、Operation > Troubleshoot > Debug Wizard > Debug Log Configurationの順に移動します。 プライマリ管理ノード(PAN)を選択し、Editをクリックします。
コンポーネント名をライセンスとadmin-licenseでフィルタリングし、必要なログレベルを選択します。Saveをクリックします。
デバッグレベル設定のライセンス
- ISE PAN CLIでは、ログは次の場所にあります。
admin#show logging application ise-psc.log
- ISE GUIで、次の順に移動します。 [Operations] > [Troubleshoot] > [Download Logs] > [Select ISE PAN] > [Debug log] > [Debug Log Type] > [Application Logs]を参照。ise-psc.logのzipファイルをダウンロードします。
オープンAPI
ISEから、Operation > Troubleshoot > Debug Wizard > Debug Log Configurationの順に移動します。 プライマリ管理ノード(PAN)を選択し、Editをクリックします。
Component Nameby apiserviceをフィルタ処理し、必要なログレベルを選択します。Saveをクリックします。
デバッグレベル設定オープンAPI
- ISE PAN CLIでは、ログは次の場所にあります。
admin#show logging application api-service.log
- ISE GUIで、次の順に移動します。 [Operations] > [Troubleshoot] > [Download Logs] > [Select ISE PAN] > [Debug log] > [Debug Log Type] > [Application Logs]を参照。api-service.logのzipファイルをダウンロードします。
- API応答コードとその意味:
- 200 (OK): Open APIが目的のアクションを正常に実行したことを示します。
- 201 (作成済み):リソースが作成され、要求が正常に完了したことを示します。
- 400 (無効な要求):サーバーは要求を処理できません。不正な要求構文や無効なパラメータなどが原因のクライアント認識エラー。メッセージの詳細があれば読みます。
- 401 (認証されていません):これは、操作が間違った資格情報で実行されたか、資格情報がないか、またはアカウントがこの操作を実行する権限がないことを示します。
- 403(禁止):サーバが要求を理解する能力はあるが、許可されていないことを示します。
- 404 (見つかりません):サーバーが要求されたリソースを見つけられないことを示します。
- 500(内部サーバエラー):サーバ側の問題を示します。ISEのログは原因の理解に役立ちます。
関連情報