VMware vCenter Orchestrator 用 Cisco UCS Manager プラグイン ユーザ ガイド、リリース 1.0(1)
プラグインの使用
プラグインの使用

プラグインの使用

この章は、次の項で構成されています。

概要

Cisco UCS Manager プラグインの使用を開始するには、vCenter Orchestrator クライアントにログインする必要があります。 vCenter Orchestrator クライアントは、使いやすいデスクトップ アプリケーションです。 vCenter Orchestrator クライアントを使用して、パッケージのインポート、ワークフローの実行およびスケジューリング、ユーザ権限の管理が可能です。 vCenter Orchestrator クライアントの使用の詳細については、『Using the VMware vCenter Orchestrator Client』を参照してください。

さらに vCenter Orchestrator クライアントによって、ワークフローおよびアクションを開発するだけでなく、パッケージおよびリソース要素を作成することもできます。 vCenter Orchestrator クライアントには 3 つのビューまたは観点があります。
  • 実行:ワークフローを実行およびスケジュールできる機能を提供します。

  • 設計:アクションおよびワークフローを開発できる機能を提供します。

  • 管理:ユーザやパッケージなどを管理できる機能を提供します。

これらの機能の使用については、『Developing with VMware vCenter Orchestrator』を参照してください。

ここでは、プラグインの次の機能について説明します。
  • UCSM インベントリ

  • UCSM アクション

  • UCSM ワークフロー

UCSM インベントリ

vCenter Orchestrator インベントリは、3 つのすべての観点で利用できます。 インベントリには、Orchestrator で有効になっているプラグインのオブジェクトが表示されます。 インベントリ ビューを使用して、インベントリ オブジェクトでワークフローを実行できます。

UCS Manager ユーザ インターフェイスの [Equipment] および [Servers] カテゴリ下に表示される管理対象オブジェクトは、プラグインで vCenter Orchestrator インベントリ オブジェクトとして使用することが可能です。 「付録 A」に、Cisco UCS Manager プラグインの vCenter Orchestrator インベントリ タイプのリストを示します。

UCSM アクション

UCSM アクションについて

アクションとは、ワークフロー、Web ビューおよびスクリプトで構築ブロックとして使用できる個々の機能を意味します。 アクションには複数の入力パラメータが存在し、戻り値は 1 つです。 これらは、事前定義されるか、プラグインの一部としてインストールされます。 UCS Manager プラグインが提供する約 1800 のアクションでは、UCS Manager ユーザ インターフェイスで現在利用可能なすべての操作を Orchestrator によって実行できます。

UCS Manager プラグインには次のアクションがあります。
  • XML API によって公開されるすべての UCS 管理対象オブジェクトに対する取得、設定、追加、および削除アクション。

  • UCS バックアップのエクスポートおよびインポート

  • UCS テクニカル サポート データの取得

  • すべての登録済み UCS ドメインの取得

  • 管理対象オブジェクトの属性に使用できる値の取得

  • UCS Manager のすべての管理対象オブジェクトのクラス ID またはタイプの取得

  • サービス プロファイルの関連付けおよび関連付け解除。

  • サービス プロファイル テンプレートからのサービス プロファイルの作成。

  • サービス プロファイルの名前の変更。

ワークフローが実行されると、アクションはワークフローの属性から入力パラメータを取得します。 これらの属性は、ワークフローの初期入力パラメータか、ワークフローの他のアクションが実行されたときに設定される属性のいずれかです。


(注)  


vCenter Orchestrator の Web 設定ツールからプラグインをインストールすると、すべてのアクションとワークフローがインストールされますが、(ワークフローまたはアクションが誤って削除された場合には)配布 zip ファイルで入手できる「com.cisco.ucs.mgr.package」をインポートすれば、アクションおよびワークフローを個別にインストールできます。


ユーティリティ アクション

プラグインには、さまざまな機能を提供する 11 のユーティリティ アクションが用意されています。 ここでは、これらのアクションについて説明します。

getAllUcsDomains

このアクションでは、vCenter Orchestrator インベントリに登録されているすべての UCS ドメインのリストを取得できます。

入力

入力不要。

出力タイプ

配列または UcsDomain:登録されている UCS Manager のすべての接続ハンドルのリスト。

cloneServiceProfile

このアクションでは、選択した組織にサービス プロファイルの複製を作成できます。

入力

  • serviceProfile:ServiceProfile:複製するサービス プロファイル。

  • newName:文字列:複製したサービス プロファイルの新しい名前。

  • destOrg:OrganizationHierarchy:複製したサービス プロファイルを配置する必要がある組織。

出力タイプ

ServiceProfile:複製されたサービス プロファイル。

createServiceProfileFromTemplate

このアクションでは、サービス プロファイル テンプレートからサービス プロファイルを作成できます。

(注)  


このオプションは UCS Manager バージョン 2.1(2a) 以降で利用可能です。


入力

  • template:ServiceProfileTemplate:サービス プロファイルの基となるサービス プロファイル テンプレート。

  • newName:配列または文字列:作成されるサービス プロファイルの新しい名前。

  • destOrg:OrganizationHierarchy:新しく作成するサービス プロファイルの配置先になる組織。

  • prefix:文字列:作成するサービス プロファイル名のプレフィックス。

  • count:数字:作成するサービス プロファイルの数。

出力タイプ

配列または ServiceProfile:作成されたサービス プロファイルのリスト。

renameServiceProfile

このアクションでは、既存のサービス プロファイルの名前を変更できます。

(注)  


このオプションは UCS Manager バージョン 2.1(1a) 以降で利用可能です。


入力

  • serviceProfile:ServiceProfile:名前を変更するサービス プロファイル。

  • newName:文字列:サービス プロファイルの新しい名前。

出力タイプ

ServiceProfile:名前を変更されたサービス プロファイル。

associateServiceProfile

このアクションでは、ブレード サーバまたはラック サーバにサービス プロファイルを関連付けることができます。

入力

  • serviceProfile:ServiceProfile:サーバに関連付けるサービス プロファイル。

  • computeObj:Any:サービス プロファイルを関連付けるブレードまたはラック サーバ オブジェクト。

  • restrictMigration:ブーリアン:関連付け中の移行を制限します。

出力タイプ

空:オブジェクトは返されません。

disassociateServiceProfile

このアクションでは、ブレード サーバまたはラック サーバとサービス プロファイルの関連付けを解除できます。

入力

serviceProfile:ServiceProfile:サーバとの関連付けを解除するサービス プロファイル。

出力タイプ

空:オブジェクトは返されません。

getUcsTechSupport

このアクションでは、さまざまなテクニカル サポート ファイルを作成およびダウンロードできます。 次に関するテクニカル サポート データを作成およびダウンロードできます。
  • ucsManager:UCS Manager 用。

  • ucsMgmt:ファブリック インターコネクトを除く UCS Manager 管理サービス。

  • Chassis Id:シャーシの I/O モジュールまたは Cisco IMC。

  • Rack Server Id:ラック サーバおよびアダプタ。

  • Fex id:ファブリック インターコネクト。

入力

  • ucsDomain:UcsDomain:テクニカル サポート ファイルを作成およびダウンロードする UCS ドメイン。

  • pathPattern:文字列:テクニカル サポート ファイルを保存するファイルの絶対パス。 tar または zip ファイル形式である必要があります。

    (注)  


    パスには、実際の値に置き換えられる特殊シーケンスを含めることができます。 pathPattern の値に使用できる特殊シーケンスのリストについては、「付録 B」を参照してください。


  • ucsManager:ブーリアン:UCS Manager オプション。

  • ucsMgmt:ブーリアン:UCS 管理オプション。

  • chassisId:数字:シャーシ ID。

  • cimcId:文字列:Cisco IMC ID。

  • adapterId:文字列:Cisco IMC アダプタ ID。

  • iomId:文字列:IOM ID。

  • rackServerId:数字:ラック サーバ ID。

  • rackAdapterId:文字列:ラック アダプタ ID。

  • fexId:数字:ファブリック インターコネクト ID。

  • timeoutSec:数字:テクニカル サポート ファイルの生成を完了するまでの許容時間(ミリ秒単位)。 設定した時間内にファイルが生成されない場合、生成は失敗します。

  • removeFromUcs:ブーリアン:UCS から削除するためのブール型のフラグ。

出力タイプ

空:オブジェクトは返されません。

exportUcsBackup

このアクションでは、指定した UCS Manager の現在のバックアップをエクスポートできます。 次のタイプのバックアップを作成できます。
  • full-state:システム全体のスナップショットを含むバイナリ ファイルを作成します。 このバックアップにより生成されたファイルを使用して、ディザスタ リカバリ時にシステムを復元できます。

  • config-logical:サービス プロファイル、VLAN、VSAN、プール、ポリシーなどのすべての論理設定を含む XML ファイルを作成します。

  • config-system:ユーザ名、ロール、ロケールなどのすべてのシステム設定を含む XML ファイルを作成します。

  • config-all:すべてのシステムおよび論理設定を含む XML ファイルを作成します。

入力

  • ucsDomain:UcsDomain:バックアップを作成およびダウンロードする UCS ドメイン。

  • pathPattern:文字列:バックアップを保存するファイルの絶対パス。 ファイルは XML 形式である必要があります。

    (注)  


    パスには、実際の値に置き換えられる特殊シーケンスを含めることができます。 pathPattern の値に使用できる特殊シーケンスのリストについては、「付録 B」を参照してください。


  • type:文字列:バックアップのタイプ(config-all、config-logical、config-system、full-state のいずれかの値)。

  • preservePooledValues:ブーリアン:プールされた値を維持するためのフラグ。

  • timeoutSec:数字:データのバックアップを完了するまでの許容時間(秒単位)。 設定した時間内にバックアップが生成されない場合、生成は失敗します。

出力タイプ

空:オブジェクトは返されません。

importUcsBackup

このアクションでは、UCS Manager に設定バックアップの XML ファイルをインポートします。 マージ オプションを使用すると現在の設定とバックアップ設定がマージされます。 使用しない場合は現在の設定が新しい設定に置換されます。

入力

  • handle:UcsSystem:バックアップをインポートする UCS システム。

  • literalPath:文字列:設定のインポート元である UCS バックアップ ファイルへの絶対パス。

  • type:文字列:バックアップのタイプ(config-all、config-logical、config-system、full-state のいずれかの値)。

  • merge:ブーリアン:既存の設定とインポートされたバックアップをマージするためのフラグ。 この値が false の場合、既存の設定が新しい設定によって置換されます。

    出力タイプ

    空:オブジェクトは返されません。

getMoFieldOptions

このアクションでは、UCS Manager で管理対象オブジェクトのフィールド値の配列を取得できます。 このアクションを使用して、管理対象オブジェクトのフィールドで値のみのセットに制限されたドロップダウン リストに入力することができます。

入力
  • classId:文字列:管理対象オブジェクトのクラス ID。

  • fieldName:文字列:フィールド値のセットを抽出する管理対象オブジェクトのプロパティ名。

出力タイプ

配列または文字列:指定した管理対象オブジェクトのフィールドのフィールド値のリスト。

getMoClassIds

このアクションでは、UCS Manager ですべての管理対象オブジェクトのクラス ID を取得できます。

入力

入力不要。

出力タイプ

配列または文字列:UCS Manager でのすべての管理対象オブジェクトのクラス ID のリスト。

UCS Manager での管理対象オブジェクトの取得アクション

このアクションを使用すると、UCS Manage から既存の管理対象オブジェクト(MO)を取得できます。 このアクションでは、選択した条件に一致する管理対象オブジェクトのリストが返されます。

入力

  • ucsDomain - UcsDomain:UCS Manager の接続ハンドル。

  • parentMos - 配列/<Type of ParentMo>:検索する UCS Manager MO の UCS Manager 親 MO のリスト。


    (注)  


    このプロパティは、検索する管理対象オブジェクトに親が定義されている場合にのみ有効です。


  • Managed Object Properties - <type of property>:検索する MO の複数のプロパティ。

  • limitScope - ブーリアン:範囲検索を親のみに限定し、子 MO を検索しません。


    (注)  


    parentMos プロパティ タイプに複数の検索レベルがある場合にのみ(たとえば、OrganizationHierarchy)、このプロパティが存在します。


  • showMos - ブーリアン:検索された UCS Manager MO を System.log ファイルに書き込みます。

出力タイプ

配列/<Type of Searched MO>:検索された UCS Manager 管理対象オブジェクト(MO)のリスト。 検索された MO のタイプがインベントリで公開されている場合、戻り値の型はそのタイプの配列、または Any の配列です。

UCS Manager での管理対象オブジェクトの変更アクション

このアクションを使用すると、UCS Manager で既存の管理対象オブジェクト(MO)を変更できます。 変更された MO のリストが返されます。

入力

  • ucsDomain - UcsDomain:UCS Manager の接続ハンドル。

  • mosToModify - 配列/<Type of mosToModify>:変更する UCS Manager MO のリスト。

  • Managed Object Properties - <type of property>:変更する MO の複数のプロパティ。

  • showMos - ブーリアン:変更された UCS Manager MO を System.log ファイルに書き込みます。

出力タイプ

配列/<Type of modified MO>:変更された UCS Manager MO のリスト。 変更された MO のタイプがインベントリで公開されている場合、戻り値の型はそのタイプの配列、または Any の配列です。

UCS Manager での管理対象オブジェクトの追加アクション

このアクションを使用すると、UCS Manager に管理対象オブジェクトを追加できます。 追加された管理対象オブジェクトのリストが返されます。

入力

  • ucsDomain - UcsDomain:UCS Manager の接続ハンドル。

  • parentMos - 配列/<Type of ParentMo>:追加する UCS Manager MO の親になる UCS Manager 管理対象オブジェクト(MO)のリスト。


    (注)  


    このプロパティは、追加する管理対象オブジェクトに親が定義されている場合にのみ有効です。


  • Managed Object Properties - <type of property>:追加する MO の複数のプロパティ。

  • modifyPresent - ブーリアン:追加する UCS Manager MO がすでに UCS Manager に存在する場合は、既存の UCS Manager MO を変更します。

  • showMos:ブーリアン:追加された UCS Manager MO を System.log ファイルに書き込みます。

出力タイプ

配列/<Type of modified MO>:追加された UCS Manager MO のリスト。 追加された MO のタイプがインベントリで公開されている場合、戻り値の型はそのタイプの配列、または Any の配列です。

UCS Manager での管理対象オブジェクトの削除アクション

このアクションを使用すると、UCS Manager から管理対象オブジェクト(MO)を削除できます。 削除された管理対象オブジェクトのリストが返されます。

入力

  • ucsDomain - UcsDomain:UCS Manager の接続ハンドル。

  • mosToRemove - 配列/<Type of ParentMo>:削除する UCS Manager 管理対象オブジェクト(MO)のリスト。

  • dn - 文字列:削除される管理対象オブジェクトの識別名(DN プロパティ)。 DN は ucsDomain と一緒に使用されます。

  • showMos - ブーリアン:削除された UCS Manager MO を System.log ファイルに書き込みます。

出力タイプ

配列/<Type of removed MO>:削除された UCSM 管理対象オブジェクト(MO)のリスト。 削除された MO のタイプがインベントリで公開されている場合、戻り値の型はそのタイプの配列、または Any の配列です。

UCS Manager プラグイン ワークフロー

Cisco UCS Manager ワークフロー

Cisco UCS Manager ワークフローは、アクション、決定、結果が組み合わされ、特定の順序で実行されることにより、仮想環境で特定のタスクまたは特定のプロセスを完了します。

ワークフローは、スキーマ、属性、およびパラメータで構成されます。 ワークフロー スキーマは、すべてのワークフロー要素およびその論理接続を定義する、ワークフローの主要コンポーネントです。 ワークフローの属性およびパラメータとは、データ転送に使用される変数です。 vCenter Orchestrator は、ワークフローが実行されるたびにワークフローのトークンを保存し、その個別の実行の詳細を記録します。 詳細については、『Using the VMware vCenter Orchestrator Client』マニュアルを参照してください。

Cisco UCS Manager プラグインが提供する一連の一般的ワークフローを次に示します。これらを使用して、vCenter Orchestrator から Cisco UCS Manager を管理できます。
  • [Add Service Profile]:UCS Manager で選択された組織にサービス プロファイルを追加します。

  • [Get Service Profile]:UCS Manager から既存のサービス プロファイルを取得します。

  • [Set Service Profile]:選択されたサービス プロファイルのプロパティを変更します。

  • [Remove Service Profile]:UCS Manager から選択されたサービス プロファイルを削除します。

  • [Rename Service Profile]:選択されたサービス プロファイルの名前を変更します。 このオプションは、Cisco UCS Manager リリース 2.1(1a) 以上でのみ使用できます。

  • [Clone Service Profile]:選択されたサービス プロファイルのコピーを作成し、選択された組織に保存します。

  • [Associate Service Profile to Blade Server]:サービス プロファイルをブレード サーバに関連付けます。

  • [Disassociate Service Profile to Blade Server]:ブレード サーバへのサービス プロファイルの関連付けを解除します。

  • [Set Service Profile Power State]:このアクションはサービス プロファイルの配列を入力として取得し、その電源状態を設定します。これにより、関連付けられたブレード サーバの電源状態が変更されます。 選択されたサービス プロファイルにブレードが関連付けられるまで変更は適用されません。

  • [Create Service Profile From Template]:サービス プロファイル テンプレートを入力として選択し、名前の配列またはプレフィックスとカウンタの組み合わせに基づいて、選択された組織にそのテンプレートから複数のサービス プロファイルを作成します。 このオプションは Cisco UCS Manager リリース 2.1(1a) 以上でのみ使用できます。

  • [Configure Bios Hyper Threading]:vCenter プラグインに登録されているホストを選択し、選択された UCS Manager からそのホストに関連付けられたサービス プロファイルを特定して、そのサービス プロファイルの BIOS ポリシーでハイパー スレッディングを有効または無効にします。

  • [Configure Bios Virtualization Technology]:vCenter プラグインに登録されているホストを選択し、選択された UCS Manager からそのホストに関連付けられたサービス プロファイルを特定して、そのサービス プロファイルの BIOS ポリシーで仮想化テクノロジーを有効または無効にします。

  • [Download UCS Manager Technical Support Files]:さまざまなタイプのテクニカル サポート ファイルを作成およびダウンロードします。 テクニカル サポート データを作成およびダウンロードするには、次のオプションを使用します。
    • ucsManager:UCS Manager インスタンス全体。

    • ucsMgmt:ファブリック インターコネクトを除く UCS Manager 管理サービス。

    • Chassis ID:シャーシの I/O モジュールまたは Cisco IMC。

    • Rack Server ID:ラック サーバおよびアダプタ。

    • Fex ID:ファブリック インターコネクト。

  • [Export UCS Manager Backup]:指定された UCS Manager の現在のバックアップをエクスポートします。 次のタイプのバックアップ操作がサポートされています。
    • full-state:システム全体のスナップショットを含むバイナリ ファイルを作成します。 このバックアップにより生成されたファイルを使用して、ディザスタ リカバリ時にシステムを復元できます。

    • config-logical:サービス プロファイル、VLAN、VSAN、プール、およびポリシーなどのすべての論理設定を含む XML ファイルを作成します。

    • config-system:ユーザ名、ロール、およびロケールなどのすべてのシステム設定を含む XML ファイルを作成します。

    • config-all:すべてのシステムおよび論理設定を含む XML ファイルを作成します。

  • [Import UCS Manager Backup]:UCS Manager に設定バックアップの XML ファイルをインポートします。 [Merge] オプションを使用して、設定を現在の設定とマージします。このオプションを使用しない場合、現在の設定が新しい設定によって置換されます。

  • [Get ESX Host from UCS Service Profile]:サービス プロファイルを選択し、このサービス プロファイルが関連付けられた計算オブジェクトまたはUCS サーバ(ブレードまたはラック ユニット)にインストールされている ESX ホストを検索します。

  • [Get UCS Service Profile from ESX Host]:ESX ホストを選択し、この ESX ホストがインストールされている計算オブジェクトまたはUCS サーバ(ブレードまたはラック ユニット)に関連付けられたサービス プロファイルを検索します。

  • [Get UCS Server by UUID]:[Get UCS Service Profile from ESX Host] ワークフローで使用されます。 このワークフローでは、UUID を取得して、この UUID を持つ UCS サーバまたは計算オブジェクト(ブレードまたはラック ユニット)を検索します。