はじめに
このドキュメントでは、サーバ上の特定のアクションをUIを介して実行できない競合の際に役立つAPI要求について説明します。
著者:Cisco TACエンジニア、Luis Uribe Rojas、テクニカルリーダー、Justin Pierce
前提条件
要件
次の項目に関する知識があることが推奨されます。
- Intersight
- Unified Computing System(UCS)サーバ
- Intersightマネージドモード(IMM)
- アプリケーションプログラミングインターフェイス(API)
使用するコンポーネント
このドキュメントの情報は、次のソフトウェアとハードウェアのバージョンに基づいています。
- Cisco UCS 6454ファブリックインターコネクト、ファームウェア4.2(1m)
- UCSB-B200-M5ブレードサーバ、ファームウェア4.2(1a)
- Intersight Software as a Service(SaaS)
このドキュメントの情報は、特定のラボ環境にあるデバイスに基づいて作成されました。このドキュメントで使用するすべてのデバイスは、クリアな(デフォルト)設定で作業を開始しています。本稼働中のネットワークでは、各コマンドによって起こる可能性がある影響を十分確認してください。
背景説明
Cisco Intersightは、複数のデータセンターにまたがるIntersight接続ターゲットを管理するためのクラウドベースのRESTful APIを提供します。Cisco Intersightインフラストラクチャサービスには、物理インフラストラクチャと仮想インフラストラクチャの導入、監視、管理、サポートが含まれます。
オプションがグレー表示されていたり、UIへのアクセスが利用できないために、Intersight管理対象サーバの特定のアクションをIntersightのユーザインターフェイス(UI)から実行できない場合は、API要求が有効な代替手段になります。
Intersight SaaSまたはIntersightアプライアンスアカウントからのAPI要求
手順の概要
次の例では、一貫した構造に従っていますが、使用されるパラメータと値は異なる場合があります。次に、関連する手順の概要を示します。
Intersightアカウントにログインします。
SaaS環境の場合は、ブラウザで「APIリファレンス」に移動し、アカウントでログインします。
注:Intersight Connected Virtual Appliance(CVA)やIntersight Private Virtual Appliance(PVA)などのアプライアンス環境の場合は、ブラウザでhttps://<Appliance-Hostname>/apidocs/apirefsに移動し、アプライアンスのクレデンシャルでログインします。
- 必要なAPI要求を探し、シリアル番号、サーバプロファイル、サーバ名、デバイスMOIDなど、既知のフィールド値でフィルタリングされた
GET
コールを使用します。
- 必要なタスクを実行するには、
PATCH
コールと対応するアクションを使用します
ヒント:クエリパラメータでは、エラーを回避するために、キーと値の例に同じ正確な文字を使用してください。
『APIリファレンスガイド』では、Response Model
タブを参照して適切な構文や、コールのペイロードで使用できるサポートされているすべてのアクションを確認すると便利です。たとえば、/api/v1/compute/BladeIdentities/,
でサポートされるAdminActionは、None
、Decommission
、Recommission
、Reack
、Remove
、およびReplace
です。このモデルは、このドキュメント全体で使用されています。
サーバの運用停止/再稼働
『Intersight APIリファレンスドキュメント』で、compute/BladeIdentities
要求を探し、最初のGET
コールを選択し、必要なクエリーパラメータを入力します。
この例では、次のパラメータを使用します。
キー |
値 |
用途 |
フィルタ($f) |
シリアルEq FLM2402001A' |
シリアル番号が指定されているサーバへの出力をフィルタリングします。 |
選択($s) |
モイド |
オブジェクトから表示する値を選択します。表示される値はサーバモードです。 |
必要なアクションを指定してPATCH
コールを適用します。この例では次の設定を使用しています。
{"AdminAction":"Decommission"}
ヒント:再予約が必要な場合は、{"AdminAction":"Recommission"}を使用します。
ヒント:IMMのラック統合型サーバとシャーシに対しても同様のアクションを実行できます。compute/RackUnitIdentitiesおよびequipment/ChassisIdentities APIコールを探します。
サーバプロファイルの割り当て解除
Server/Profiles要求を探して、最初のGETコールを選択してから、必要なクエリーパラメータを入力します。
この例では、次のパラメータを使用します。
キー |
値 |
用途 |
フィルタ($f) |
名前Eq 'UCSX-Server-boot-SAN' |
入力した名前のサーバプロファイルへの出力をフィルタリングします。 |
選択($s) |
Moid、名前 |
オブジェクトから表示する値を選択します。この場合 |
必要なアクションを指定してパッチコールを適用します。この例では次の設定を使用しています。
{"Action":"Unassign"}
サーバーの削除
Intersight APIリファレンスドキュメントで、compute/BladeIdentities要求を探し、最初のGET
コールを選択してから、必要なクエリーパラメータを入力します。
この例では、次のパラメータを使用します。
キー |
値 |
用途 |
フィルタ($f) |
シリアルEq FLM2402001A' |
シリアル番号が指定されたサーバだけに出力をフィルタリングします。 |
選択($s) |
モイド |
オブジェクトから表示する値を選択します。表示される値はサーバモードです。 |
必要なアクションを指定してパッチコールを適用します。この例では次の設定を使用しています。
{"AdminAction":"Remove"}
警告:この要求により、サーバがインベントリから削除されます。サーバをドメインのインベントリに追加し直すには、新しいディスカバリが必要です。これは、サーバの物理的な再装着またはシャーシの再検出タスクによってトリガーされる可能性があります。
サーバのIMCのリブート
『Intersight APIリファレンスドキュメント』で、compute/ServerSettings
要求を探し、最初のGET
コールを選択し、必要なクエリーパラメータを入力します。
この例では、次のパラメータを使用します。
キー |
値 |
用途 |
フィルタ($f) |
名前Eq 'FI-6536-1-3' |
名前が入力されたブレードへの出力をフィルタリングします。 |
選択($s) |
Moid、名前 |
オブジェクトから表示する値を選択します。 |
必要なアクションを指定してパッチコールを適用します。この例では次の設定を使用しています。
{"AdminPowerState":"Reboot"}
警告:この要求の結果、問題のサーバのIMCトラフィックがリブートします。管理コントローラのリブート後には、検出の浅いワークフローが表示されることが予想されます。
デバイスコンソールのAPIエクスプローラを使用したトラブルシューティング操作
デバイスコンソールでは、デバイスの状態とIntersightへの接続のステータスを監視できます。問題のトラブルシューティングと分析を行うための診断情報を含むテクニカルサポートバンドルを生成できます。さらに、デバイスコンソールには、API Explorerを起動してサーバ上でRedfish™ベースの操作を実行する機能が含まれています。
Intersightまたはアプライアンス間の接続が失われた場合は、デバイスコンソールのAPIエクスプローラを使用して、基本的なトラブルシューティング操作を実行することもできます。
1)デバイスコンソールを開き、Fabric InterconnectのIPアドレスのいずれかに移動して、Inventoryタブを選択します。
2)トラブルシューティングを行う必要がある特定のデバイスに移動し、その右側の3つのドットを選択して、Launch API Explorer
を選択します。APIエクスプローラは、そのデバイスに対してのみ起動され、それ以外のデバイスでは起動されません。
サーバのCIMC Management Controllerのリブート
サーバのAPIエクスプローラを起動します。
{ManagerID}にCIMCと入力してPOSTを適用します。 Managers/{ManagerId}/Actions/Manager.Resetにコールを発信し、リセットのタイプを追加します。
この例では次の設定を使用しています。
{"ResetType": "ForceRestart"}
I/Oモジュール(IOM)のリブート
IOMのAPI Explorerを起動します。
{ManagerID}にCMCと入力してPOSTを適用します。 Managers/{ManagerId}/Actions/Manager.Resetを呼び出して、Reset Typeを追加します。この例では次の設定を使用しています。
{"ResetType": "ForceRestart"}
{ManagerID}フィールドでピアIOMをリブートするには、前と同じコールでPeerCMC
を入力します。
関連情報
Intersight APIの概要
デバイスコンソールの概要