概要
このドキュメントでは、サーバ上の特定のアクションを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 Referenceに移動し、自分のアカウントでログインします。
注:Intersight Connected Virtual Appliance(CVA)またはIntersight Private Virtual Appliance(PVA)などのアプライアンス環境の場合は、ブラウザでhttps://<Appliance-Hostname>/apidocs/apirefsに移動し、アプライアンスのクレデンシャルを使用してログインします。
- 必要なAPI要求を探し、
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"}を使用してください。
サーバプロファイルの割り当て解除
Server/Profiles要求を探し、最初のGETコールを選択してから、必要なクエリーパラメータを入力します。
この例では、次のパラメータを使用します。
キー |
値 |
用途 |
フィルタ($f) |
名前Eq 'UCSX-Server-boot-SAN' |
入力した名前を持つサーバプロファイルへの出力をフィルタリングします。 |
選択($s) |
Moid、名前 |
オブジェクトから表示する値を選択します。この場合 |
必要なアクションを指定して、PATCHコールを適用します。この例では次の設定を使用しています。
{"Action":"Unassign"}
サーバーの削除
Intersight APIリファレンスドキュメントで、compute/BladeIdentities要求を探し、最初の要求を選択します GET
を呼び出し、必要なクエリーパラメータを入力します。
この例では、次のパラメータを使用します。
キー |
値 |
用途 |
フィルタ($f) |
シリアルEq 'FLM2402001A' |
シリアル番号が指定されたサーバだけに出力をフィルタリングします。 |
選択($s) |
モイド |
オブジェクトから表示する値を選択します。表示される値はサーバモードです。 |
必要なアクションを指定して、PATCHコールを適用します。この例では次の設定を使用しています。
{"AdminAction":"Remove"}
警告:この要求により、サーバーがインベントリから削除されます。ドメインのインベントリにサーバを追加し直すには、新しいディスカバリが必要です。これは、サーバの物理的な抜き差しによって、またはシャーシの再検出タスクによって引き起こされます。
デバイスコンソールのAPIエクスプローラを使用したアクションのトラブルシューティング
デバイスコンソールを使用すると、デバイスの状態とIntersightへの接続のステータスを監視できます。問題のトラブルシューティングと分析を行うための診断情報を含むテクニカルサポートバンドルを生成できます。さらに、デバイスコンソールには、API Explorerを起動してRedfish™ベースの操作をサーバで実行する機能が含まれています。
Intersightまたはアプライアンス間の接続が失われた場合は、デバイスコンソールのAPIエクスプローラを使用して、基本的なトラブルシューティング操作を実行することもできます。
1)デバイスコンソールを開き、Fabric InterconnectのIPアドレスの1つに移動して、Inventoryタブを選択します。
2)トラブルシューティングする必要がある特定のデバイスに移動し、その右側にある3つのドットを選択して、 Launch API Explorer
を参照。API Explorerは、そのデバイスに対してのみ起動し、それ以外のデバイスは起動しません。
サーバのCIMC Management Controllerのリブート
サーバのAPI Explorerを起動します。
{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"}
{>でピアIOMをリブートするにはManagerID}フィールドを入力します。 PeerCMC
以前と同じコールで行われます。
関連情報
Intersight APIの概要
デバイスコンソールの概要