Cisco IMC PowerTool の概要
Cisco IMC PowerTool は、XML API を使用して Cisco IMC のさまざまな側面の自動化を支援する PowerShell モジュールです。既存の IT 管理プロセスやツールとの容易な統合を可能にします。
PowerTool コマンドレットは、Cisco IMC 管理情報ツリー(MIT)で機能します。コマンドレットを使用して、ツリーの管理対象オブジェクト(MO)に対するアクションを作成、変更、削除することができます。
この製品のマニュアルセットは、偏向のない言語を使用するように配慮されています。このマニュアルセットでの偏向のない言語とは、年齢、障害、性別、人種的アイデンティティ、民族的アイデンティティ、性的指向、社会経済的地位、およびインターセクショナリティに基づく差別を意味しない言語として定義されています。製品ソフトウェアのユーザーインターフェイスにハードコードされている言語、RFP のドキュメントに基づいて使用されている言語、または参照されているサードパーティ製品で使用されている言語によりドキュメントに例外が存在する場合があります。シスコのインクルーシブランゲージに対する取り組みの詳細は、こちらをご覧ください。
このドキュメントは、米国シスコ発行ドキュメントの参考和訳です。リンク情報につきましては、日本語版掲載時点で、英語版にアップデートがあり、リンク先のページが移動/変更されている場合がありますことをご了承ください。あくまでも参考和訳となりますので、正式な内容については米国サイトのドキュメントを参照ください。
この章の内容は、次のとおりです。
Cisco IMC PowerTool は、XML API を使用して Cisco IMC のさまざまな側面の自動化を支援する PowerShell モジュールです。既存の IT 管理プロセスやツールとの容易な統合を可能にします。
PowerTool コマンドレットは、Cisco IMC 管理情報ツリー(MIT)で機能します。コマンドレットを使用して、ツリーの管理対象オブジェクト(MO)に対するアクションを作成、変更、削除することができます。
Cisco IMC を構成するすべての物理および論理コンポーネントは、MIT と呼ばれる階層型の管理情報モデル(MIM)で表されます。ツリー内の各ノードは管理対象オブジェクト(MO)を表し、一意の識別名(DN)で識別されます。
管理情報モデル
管理対象オブジェクトは、CPU、DIMM、アダプタ カード、ファン、電源装置などの Cisco IMC MIT リソースを抽象化したものです。MO は、Cisco IMC MIT で設定または管理される論理または物理エンティティを表します。たとえば、CPU、DIMM、アダプタ カード、ファンなどの物理エンティティや、ユーザ、通信サービス(HTTP、SSH など)などの論理エンティティが MO として表されます。
管理対象オブジェクト
ツリー内では、各 MO は識別名(DN)によって識別されます。親コンテキスト内では、相対名(RN)によって MO を識別できます。DN は、MIT での MO の位置を識別します。DN は、ルートから開始してその MO 自身までのすべての相対名を連結したものです。基本形は、DN = [RN]/[RN]/[RN]/…/[RN] です。
次の例では、DN はモデル内の adapter-1 の完全修飾名を示しています。
< dn = "sys/rack-unit-1/adapter-1" />
この DN は次の RN から構成されています。
topSystem MO: rn="sys" computeRackUnit MO: rn="rack-unit-1" adapterUnit MO: rn ="adapter-<id>"
RN には、1 つ以上の MO プロパティの値を組み込むことができます。これによって、親コンテキスト内で同タイプの複数の MO を区別することができます。RN の一部を成すプロパティは、Naming プロパティと呼ばれます。
たとえば、1 つのラック ユニット MO の下には複数のアダプタ MO があります。アダプタ MO には RN の一部としてアダプタ ID(adapter-[Id])が含まれているので、ラック ユニットのコンテキストで各アダプタ MO を一意に識別できます。
Cisco IMC PowerTool をインストールする前に、システムが次の要件を満たしていることを確認します。
Windows PowerShell 3.0 以降をインストール
.NET Framework バージョン 4.5 以降
Windows PowerShell 4.0 以降(DSC の場合)
Cisco IMC PowerTool は、次の Cisco IMC リリースと互換性があります。
Release 4.0
リリース 3.1
リリース 3.0
リリース 2.0 以降
リリース 1.5 以降
Cisco IMC PowerTool は、次の Cisco UCS E シリーズ リリースと互換性があります。
E シリーズ サーバ向けリリース 2.2(1) 以降
システムの管理および監視には、Cisco IMC XML API メソッドが使用されます。次の方式がサポートされています。
認証
aaaLogin—初期ログイン方式
aaaRefresh—現在の認証 Cookie を更新します
aaaLogout—現在のセッションを終了し、対応する認証 Cookie を非アクティブ化します
configResolveDn — DN によってオブジェクトを取得します
configResolveClass —指定されたクラスのオブジェクトを取得します。
configResolveChildren—オブジェクトの子オブジェクトを取得します
configResolveParent—オブジェクトの親オブジェクトを取得します
configConfMo—単一の管理対象オブジェクトに影響します。たとえば、DN
eventSubscribe—イベントへの登録に使用されます
ほとんどの Cisco IMC PowerTool コマンドレットは MO の仕様から生成されます。タイプの代わりに名詞が使用されます(EquipmentFan の代わりに Fan など)。さまざまな MO タイプに対して、Get、Add、Set、Remove コマンドレットまたはサブセットが生成されます。すべてのコマンドレットは、XML 要求および応答を画面にダンプする XML パラメータをサポートします。
コマンドレットを追加します
-指定されたプロパティ値とともに MO ステータス「created」で ConfigConfMo メソッドを使用します。Force パラメータが指定されている場合、確認を求めるプロンプトは表示されません。
コマンドレットを取得します
-ConfigResolveClass メソッドを使用して MO を取得します。Cisco IMC の XML API はいずれのフィルタもサポートしていません。プロパティ パラメータを指定すると、PowerTool は指定されたクラスのインスタンスを収集し、プロパティ値を使用してクライアント側でフィルタリングします。
Set コマンドレット
-指定されたプロパティ値とともに MO ステータス「modified」で ConfigConfMo メソッドを使用します。Force パラメータが指定されている場合、確認を求めるプロンプトは表示されません。
コマンドレットを削除します
-MO ステータス「deleted」を指定して ConfigConfMo メソッドを使用しますForce パラメータが指定されている場合、確認を求めるプロンプトは表示されません。
次の表は、特定の verb に指定できるプロパティのリストです。
プロパティ |
get |
Add |
Set |
---|---|---|---|
Naming |
Yes(位置指定) |
Yes(位置指定) |
No |
Create-Only |
Yes |
Yes |
No |
Read-Write |
Yes |
Yes |
Yes |
Operational/ Read-Only |
はい |
No |
× |
次の表は、対応するコマンドレッドのパイプラインに表示されるタイプのリストです。
動詞/タイプ |
パイプラインの入力 |
---|---|
get |
Singleton-None non-singleton-Parent Type |
[Add |
Singleton-None non-singleton-Parent Type |
セット |
Naming プロパティがある MO – Naming プロパティがない同一タイプの MO – 同一タイプまたは親タイプ |
Remove/Clear |
同一タイプ |
次の表は、必要な XML 要求を生成するために呼び出されるメソッドを示します。
コマンドレット |
方式 |
---|---|
Add-Imc Set-Imc |
ConfigConfMo |
Get-Imc |
ConfigResolveClass(クライアント側でフィルタ) |
Get-ImcManagedObject -ClassId |
ConfigResolveClass |
Get-ImcManagedObject -ClassId -Dnlist |
ConfigResolveClass (一致する DN を検出するため出力がフィルタリングされます |
Get-ImcManagedObject -Dn |
ConfigResolveDn |
Connect-Imc |
AaaLogin |
Disconnect-Imc |
AaaLogout |
Background これはコマンドレットではありません。バックグラウンド サービスです。 |
AaaRefresh |
Get-ImcChild |
ConfigResolveChildren |
Get-ImcCmdletMeta は、MO のタイプ、対応する名詞、サポートされる動詞、および MO のプロパティを検出するために使用されます。プロパティの詳細(Naming、Read、Write などのタイプ、プロパティが導入された Cisco IMC のバージョンなど)の表示にも使用されます。