はじめに
この記事では、Cisco Intersight のアラーム情報をREST API Browserを使用して取得する手順をご紹介します。
概要
Intersight ではUCS/HyperFlexなどのハードウェアのアラーム情報を集約し、統合管理ポータルから一元管理することができます。
またREST API を使用してアラーム情報を取得し、外部連携することも可能です。
今回はREST API Browser機能を利用して、アラーム情報の取得やフィルタリングやアラーム件数をカウントする手法についてご案内します。
関連資料
REST API Browserのアクセス方法とアラームの確認方法
・intersight.comにアクセスし、「ヘルプセンター」のリンクをクリックし、ヘルプページにアクセスします。
・最下部までスクロールし「API Documentation」のリンクを開きます。
・画面右上の「サインイン」ボタンをクリックします。
・認証画面が表示されますので、認証情報を入力し、Intersightアカウントにログオンします。
ご注意：この際はRead-Only権限のロールでログオンを行います。（※Account Administratorなどの高権限のロールでログオンした場合、誤って更新・削除操作などを行った場合の影響を避けるため）ログオンユーザにRead-onlyロールを割り当てていない場合は、割り当ててから実施いただくようにお願いいたします。
・右側のアカウントメニューをクリックし、RoleがRead-Onlyであることを確認します。
API Referenceリンクをクリックします。
・API Referenceメニューが表示されます。ここでREST Clientがグリーン（ON）の場合、REST API Browserとして利用できます。
まず、画面左上の検索窓にalarmsと入力します。アラーム機能に関連するAPIが絞り込まれて表示されます。
GETメソッドをクリックすると、右側のペインの表示が切り替わります。
Sendボタンをクリックすると、APIを実行します。正常に結果が返されるとResponse Infoにhttpのステータスコードが表示されます。
＄filterや$countキーを活用したフィルタリングの例
・Query Parameter を指定することでより詳細な検索が可能です。
まず、$filterの使用例です。Query Parameter＋のリンクをクリックします。
Key値に$filterと入力し、Value値を以下のように入力が可能です。
not(Severity eq %27Cleared%27) and ( CreateTime gt now() sub %27P3M%27 )
※%27は'をURLエンコードした際の置き換え文字です。
こちらの例ではSeverity（重大度）がCleared以外 かつ CreateTimeが直近３ヵ月のアラームを
抽出できます。
・このようにフィルタリングした結果を確認できます。
・続いて$countの使用例です。このキーを利用することで検索結果数を確認できます。
先ほどの$filter用のQuery parameterに追加します。Query Parameter＋をクリックします。
key値に$count、ValueにTrueと入力し、[Send]ボタンをクリックします。
結果に24と表示されます。
・ここで、差分を比較するために最初に設定したQuery Parameterを削除します。
・このような状態で「Send」ボタンをクリックすると、結果は78件となりました。
・Read-Only ロールのためPOSTメソッドによる更新は許可されておりません。更新対象となるアラームのMoidを入力し、「Send」
を実施した場合、UnauthorisedOperationと表示され、更新が拒否されます。
・Httpのレスポンスコードとしては403が返却されます。
まとめ
Intersightには運用管理を簡単にシンプル化できる様々な機能が用意されています。
本投稿に記載の内容を用いることで、REST API経由で取得可能なIntersightでのアラーム情報についてご理解いただくことが可能になります。
Cisco Customer SuccessではCisco Communityを通じて様々なベストプラクティス情報の提供を進めています。
こちらを、設計検討、運用検討の際にご活用ください。
検索バーにキーワード、フレーズ、または質問を入力し、お探しのものを見つけましょう
シスコ コミュニティをいち早く使いこなしていただけるよう役立つリンクをまとめました。みなさんのジャーニーがより良いものとなるようお手伝いします
