この製品のマニュアルセットは、偏向のない言語を使用するように配慮されています。このマニュアルセットでの偏向のない言語とは、年齢、障害、性別、人種的アイデンティティ、民族的アイデンティティ、性的指向、社会経済的地位、およびインターセクショナリティに基づく差別を意味しない言語として定義されています。製品ソフトウェアのユーザーインターフェイスにハードコードされている言語、RFP のドキュメントに基づいて使用されている言語、または参照されているサードパーティ製品で使用されている言語によりドキュメントに例外が存在する場合があります。シスコのインクルーシブランゲージに対する取り組みの詳細は、こちらをご覧ください。
このドキュメントは、米国シスコ発行ドキュメントの参考和訳です。リンク情報につきましては、日本語版掲載時点で、英語版にアップデートがあり、リンク先のページが移動/変更されている場合がありますことをご了承ください。あくまでも参考和訳となりますので、正式な内容については米国サイトのドキュメントを参照ください。
この章は、次の項で構成されています。
Cisco UCS Manager プラグインを使用し始めるには、vRealize Orchestrator クライアントにログインする必要があります。vRealize Orchestrator クライアントは、使いやすいデスクトップ アプリケーションです。vRealize Orchestrator クライアントを使用して、パッケージのインポート、ワークフローの実行およびスケジューリング、ユーザ権限の管理が可能です。vRealize Orchestrator クライアントの使用の詳細については、『Using the VMware vRealize Orchestrator Client』を参照してください。
これらの機能の使用については、『Developing with VMware vRealize Orchestrator』を参照してください。
vRealize Orchestrator インベントリは、3 つすべての観点で利用できます。インベントリには、Orchestrator で有効になっているプラグインのオブジェクトが表示されます。インベントリ ビューを使用して、インベントリ オブジェクトでワークフローを実行できます。
UCS Manager ユーザ インターフェイスの [Equipment] および [Servers] カテゴリ下に表示される管理対象オブジェクトは、プラグインで vRealize Orchestrator インベントリ オブジェクトとして使用することが可能です。
UCS Manager アクション
アクションとは、ワークフロー、Web ビューおよびスクリプトで構築ブロックとして使用できる個々の機能を意味します。アクションには複数の入力パラメータが存在し、戻り値は 1 つです。これらは、事前定義されるか、プラグインの一部としてインストールされます。UCS Manager プラグインが提供する約 1800 のアクションでは、UCS Manager ユーザ インターフェイスで現在利用可能なすべての操作を Orchestrator によって実行できます。
ワークフローが実行されると、アクションはワークフローの属性から入力パラメータを取得します。これらの属性は、ワークフローの初期入力パラメータか、ワークフローの他のアクションが実行されたときに設定される属性のいずれかです。
(注) | vRealize Orchestrator の Web 設定ツールからプラグインをインストールすると、すべてのアクションとワークフローがインストールされますが、(ワークフローまたはアクションが誤って削除された場合には)配布 zip ファイルで入手できる「com.cisco.ucs.mgr.package」をインポートすれば、アクションおよびワークフローを個別にインストールできます。 |
プラグインには、さまざまな機能を提供するユーティリティ アクションが用意されています。ここでは、これらのアクションについて説明します。
このアクションでは、UcsmComputeRackUnit および UcsmComputeBlade の管理対象オブジェクトを検索することができます。また、1 つのアクションで、ラック ユニットおよびブレード(計算ノード)を検索できます。
入力
ucsDomain:UcsDomain:UCS Manager の接続ハンドル。
Blade または RackUnit プロパティ:<type of property>:その他の入力はラック ユニットおよびブレードの共通プロパティで、これらのプロパティをキーワードまたは文字列として使用して検索できます。詳細については、UcsmComputeRackUnit、UcsmComputeBlade スクリプト オブジェクトを参照してください。
showMos:ブーリアン:検索されるラック ユニットまたはブレード オブジェクトを System.log に出力します。
出力
配列または Any:すべての検索対象 UcsmComputeRackUnit および UcsmComputeBlade の配列。
このアクションでは、UCS ドメイン インスタンスを追加できます。このアクションは、vCO5.5.x 以降および vRO 6.0.x 以降のバージョンでサポートされます。
入力
UcsHost:文字列:UCS ホスト名/IP
userId:文字列:ユーザ名
password:SecureString:パスワード
noSsl:ブーリアン:セキュアでない接続(HTTP)を使用
port:文字列:接続ポート
出力
UcsDomain:追加された UCS ドメイン。
このアクションでは、UCS ドメイン インスタンスの詳細を変更できます。このアクションは、vCO5.5.x 以降および vRO 6.0.x 以降のバージョンでサポートされます。
UcsDomain:UcsDomain:変更する UcsDomain
userId:文字列:ユーザ名
password:SecureString:パスワード
noSsl:ブーリアン:セキュアでない接続(HTTP)を使用
port:文字列:接続ポート
出力
UcsDomain:変更された UCS ドメイン。
このアクションでは、UCS ドメイン インスタンスを削除できます。このアクションは、vCO5.5.x 以降および vRO 6.0.x 以降のバージョンでサポートされます。
入力
ucsDomain:UcsDomain:削除する UcsDomain
出力
ブーリアン:UcsDomain が正常に削除されたかどうかを示します。
このアクションでは、vRealize Orchestrator インベントリに登録されているすべての UCS ドメインのリストを取得できます。
入力
入力不要。
出力タイプ
配列または UcsDomain:登録されている UCS Manager のすべての接続ハンドルのリスト。
このアクションでは、選択した組織にサービス プロファイルの複製を作成できます。
入力
serviceProfile:ServiceProfile:複製するサービス プロファイル。
newName:文字列:複製したサービス プロファイルの新しい名前。
destOrg:OrganizationHierarchy:複製したサービス プロファイルを配置する必要がある組織。
出力タイプ
ServiceProfile:複製されたサービス プロファイル。
(注) | このオプションは UCS Manager バージョン 2.1(2a) 以降で使用できます。 |
入力
template:ServiceProfileTemplate:サービス プロファイルの基となるサービス プロファイル テンプレート。
newName:配列または文字列:作成されるサービス プロファイルの新しい名前。
destOrg:OrganizationHierarchy:新しく作成するサービス プロファイルの配置先になる組織。
prefix:文字列:作成するサービス プロファイル名のプレフィックス。
count:数字:作成するサービス プロファイルの数。
出力タイプ
配列または ServiceProfile:作成されたサービス プロファイルのリスト。
(注) | このオプションは UCS Manager バージョン 2.1(1a) 以降で使用できます。 |
入力
出力タイプ
ServiceProfile:名前を変更されたサービス プロファイル。
このアクションでは、ブレード サーバまたはラック サーバにサービス プロファイルを関連付けることができます。
入力
serviceProfile:ServiceProfile:サーバに関連付けるサービス プロファイル。
computeObj:Any:サービス プロファイルを関連付けるブレードまたはラック サーバ オブジェクト。
restrictMigration:ブーリアン:関連付け中の移行を制限します。
出力タイプ
空:オブジェクトは返されません。
このアクションでは、ブレード サーバまたはラック サーバとサービス プロファイルの関連付けを解除できます。
入力
serviceProfile:ServiceProfile:サーバとの関連付けを解除するサービス プロファイル。
出力タイプ
空:オブジェクトは返されません。
入力
ucsDomain:UcsDomain:テクニカル サポート ファイルを作成およびダウンロードする UCS ドメイン。
(注) | パスには、実際の値に置き換えられる特殊シーケンスを含めることができます。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 から削除するためのブール型のフラグ。
出力タイプ
空:オブジェクトは返されません。
入力
ucsDomain:UcsDomain:バックアップを作成し、それをダウンロードする UCS ドメイン。
(注) | パスには、実際の値に置き換えられる特殊シーケンスを含めることができます。pathPattern の値に使用できる特殊シーケンスのリストについては、「付録 B」を参照してください。 |
type:文字列:バックアップのタイプ(config-all、config-logical、config-system、full-state のいずれかの値)。
preservePooledValues:ブーリアン:プールされた値を維持するためのフラグ。
timeoutSec:数字:データをバックアップできる時間の長さ。設定した時間内にバックアップが生成されない場合、生成は失敗します。
出力タイプ
空:オブジェクトは返されません。
このアクションでは、UCS Manager に設定バックアップの XML ファイルをインポートします。マージ オプションを使用すると現在の設定とバックアップ設定がマージされます。使用しない場合は現在の設定が新しい設定に置換されます。
入力
このアクションでは、UCS Manager で管理対象オブジェクトのフィールド値の配列を取得できます。このアクションを使用して、管理対象オブジェクトのフィールドで値のみのセットに制限されたドロップダウン リストに入力することができます。
出力タイプ
配列または文字列:指定した管理対象オブジェクトのフィールドのフィールド値のリスト。
このアクションでは、UCS Manager ですべての管理対象オブジェクトのクラス ID を取得できます。
入力
入力不要。
出力タイプ
配列または文字列:UCS Manager でのすべての管理対象オブジェクトのクラス ID のリスト。
このアクションを使用すると、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 で既存の管理対象オブジェクト(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 に管理対象オブジェクトを追加できます。追加された管理対象オブジェクトのリストが返されます。
入力
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 から管理対象オブジェクト(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 ワークフローは、アクション、決定、結果が組み合わされ、特定の順序で実行されることにより、仮想環境で特定のタスクまたは特定のプロセスを完了します。
ワークフローは、スキーマ、属性、およびパラメータで構成されます。ワークフロー スキーマは、すべてのワークフロー要素およびその論理接続を定義する、ワークフローの主要コンポーネントです。ワークフローの属性およびパラメータとは、データ転送に使用される変数です。vRealize Orchestrator は、ワークフローが実行されるたびにワークフローのトークンを保存し、その個別の実行の詳細を記録します。詳細については、『Using the VMware vRealize Orchestrator Client』マニュアルを参照してください。
[Add a UCS Domain Instance]:UCS ドメイン インスタンスを vRealize Orchestrator インベントリに追加します。このワークフローは、vCO5.5.x 以降、および vRealize Orchestrator 6.0.x 以降のバージョンでサポートされます。
[Modify a UCS Domain Instance]:vRealize Orchestrator インベントリで登録された UCS ドメイン インスタンスの接続の詳細を変更します。このワークフローは、vCO5.5.x 以降、および vRealize Orchestrator 6.0.x 以降のバージョンでサポートされます。
[Remove a UCS Domain Instance]:UCS ドメイン インスタンスを vRealize Orchestrator インベントリから削除します。このワークフローは、vCO5.5.x 以降、および vRealize Orchestrator 6.0.x 以降のバージョンでサポートされます。
[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]:サービス プロファイルをブレード サーバまたはラック サーバに関連付けます。
[Disassociate Service Profile]:ブレード サーバまたはラック サーバへのサービス プロファイルの関連付けを解除します。
[Set Service Profile Power State]:このアクションはサービス プロファイルの配列を入力として取得し、その電源状態を設定します。これにより、関連付けられたブレード サーバまたはラック サーバの電源状態が変更されます。選択されたサービス プロファイルにブレード サーバまたはラック サーバが関連付けられるまで変更は適用されません。
[Create Service Profile From Template]:サービス プロファイル テンプレートを入力として選択し、複数のサービス プロファイルを作成します。サービス プロファイルは、プレフィックスおよびカウンタの名前または組み合わせの配列に基づき、選択された部門に作成されます。このオプションは Cisco UCS Manager リリース 2.1(1a) 以上でのみ使用できます。
[Configure BIOS Hyper Threading]:vRealize プラグインに登録されたホストを選択します。選択された UCS Manager から関連するサービス プロファイルを決定し、そのサービス プロファイルの BIOS ポリシーでハイパー スレッディングをイネーブル、またはディセーブルにします。
[Configure BIOS Virtualization Technology]:vRealize プラグインに登録されたホストを選択します。選択された UCS Manager から関連するサービス プロファイルを決定し、そのサービス プロファイルの BIOS ポリシーで仮想化技術をイネーブル、またはディセーブルにします。
[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 サーバまたは計算オブジェクト(ブレードまたはラック ユニット)を検索します。