Cisco UCS Director PowerShell API ユーザ ガイド、リリース 5.3
使用する前に
使用する前に

使用する前に

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

Cisco UCS Director について

Cisco UCS Director は、シスコおよびシスコ以外の多岐にわたるデータ インフラストラクチャ コンポーネントと、Cisco UCS および Cisco Nexus プラットフォームに基づいており、業界をリードするコンバージド インフラストラクチャ ソリューションとして、安全性に非常に優れたエンドツーエンドの管理、オーケストレーション、および自動化を提供します。 サポート対象のインフラストラクチャ コンポーネントとソリューションの完全なリストについては、『Cisco UCS Director Compatibility Matrix』を参照してください。

Cisco UCS Director は、次の標準テンプレートを使用する 64 ビットのアプライアンスです。

  • Open Virtualization Format(OVF)for VMware vSphere

  • Virtual Hard Disk(VHD)for Microsoft Hyper-V

Cisco UCS Director を介した管理

Cisco UCS Director は、Cisco UCS を通じてコンピューティング層およびネットワーク層の統合を拡張し、データセンター インフラストラクチャ コンポーネントの包括的な可視性と管理性を提供します。 Cisco UCS Director を使用して、シスコやシスコ以外が提供するサポート対象のコンポーネントを設定、管理、およびモニタできます。 実行できるタスクには次のものがあります。

  • すべての Cisco UCS サーバおよびコンピューティング アプリケーションを対象にした、サービス プロファイルとテンプレートの作成、複製、および導入。

  • コンバージド インフラストラクチャにおける組織の使用状況、トレンドおよび容量の継続的なモニタリング。 たとえば、すべてのデータセンター間の仮想マシン(VM)の使用率を示すヒート マップを表示できます。

  • 一貫したリピート可能な方法によるコンバージド インフラストラクチャへの容量の導入や追加

  • Cisco UCS ドメインや Cisco Nexus ネットワーク デバイスなどのデータセンター コンポーネントの管理、監視、報告。

  • 物理インフラストラクチャへのサービスを追加するための仮想サービス カタログの拡張。

  • 非仮想化ワークロードで動作する仮想化ワークロードに対応するための安全なマルチテナント環境の管理。

Cisco UCS Director による自動化とオーケストレーション

Cisco UCS Director を使用することで、自動化サービスを提供するワークフローを構築し、そのワークフローを発行してオンデマンド方式でサービスをユーザに拡大することができます。 社内の他の専門家と協力して、単純または複雑なプロビジョニングと設定のプロセスを自動化するためのポリシーの作成や、Cisco UCS Director ワークフローの構築といった作業を迅速かつ容易に行うことができます。

一度構築および検証された後は、これらのワークフローは誰が実行しても常に同じように実行できます。 経験豊富なデータセンター管理者がそれらを実行したり、または、ロールベース アクセス コントロールを実行してユーザや顧客が必要に応じてセルフサービス ベースでワークフローを実行できるようにすることができます。

Cisco UCS Director を使用することで、シスコやシスコ以外が提供するサポート対象の各種ハードウェアやソフトウェアのデータセンター コンポーネント間で、多岐にわたるタスクおよびユースケースを自動化できます。 自動化できる使用例には以下のものがありますが、これらに限定されません。

  • VM のプロビジョニングとライフサイクル管理

  • ネットワーク リソースの設定とライフサイクル管理

  • ストレージ リソースの設定とライフサイクル管理

  • テナント オンボーディングとインフラストラクチャの設定

  • アプリケーション インフラストラクチャのプロビジョニング

  • セルフサービス カタログと VM プロビジョニング

  • オペレーティング システムのインストールを含むベアメタル サーバのプロビジョニング

Microsoft Windows PowerShell について

Microsoft Windows PowerShell は、システム管理者がネットワーク内のシステム リソースの管理を自動化するために使用できる、タスク ベースのコマンドライン shell およびスクリプト言語です。 PowerShell インターフェイスを Cisco UCS Director API に統合すると、データセンター管理を簡単に行えるようになります。

Windows PowerShell でオブジェクトを操作するには、コマンドレット(cmdlet)を使用します。コマンドレットとは、単一機能を持つコマンドです。 コマンドレットは、動詞と名詞をダッシュ(-)で区切った組み合わせとして表されます。 コマンドレットの例には、Get-Help、Get-Process、Invoke-API などがあります。 コマンドレットは Microsoft Windows サーバで実行されます。 各コマンドレットが単一の操作を実行します。複数のコマンドレットを連結することもできます。

Cisco UCS Director には、PowerShell の内部動作を管理するための Representational State Transfer(REST)インターフェイスが用意されています。 PowerShell コマンドレットは、これらの REST API のラッパーになります。

Cisco UCS Director には、次の REST API タイプがあります。

  • レガシー JSON ベースの REST API:ワークフロー要求の送信、ワークフロー入出力スキーマの検査、およびレポートの取得を実行できます。

  • XML ベースの REST API:Cisco UCS Director でサポートされているワークフロー タスクを実行できます。

PowerShell は、ワークフロー管理を支援するレガシー JSON ベースの API のコマンドレット ラッパーを提供します。

システム要件

Windows PowerShell は、.NET Framework 共通言語ランタイム(CLR)と .NET Framework をベースに作成されています。 これは .NET Framework オブジェクトを受け入れて、返します。

PowerShell を操作するには、次のものをサポートする任意の Windows ベースのシステムに Cisco UCS Director PowerShell コンソールをインストールする必要があります。

  • .NET Framework 4.0 以降

  • PowerShell バージョン 3.0 以降

PowerShell の操作

PowerShell は、コマンドレットを実行するための対話式プロンプトを提供します。

PowerShell へのアクセス

PowerShell.exe を使用すると、Cmd.exe などの別のツールのコマンドラインから PowerShell.exe を使用して Windows PowerShell セッションを開始したり、Windows PowerShell コマンドラインで新しいセッションを開始したりすることができます。

プライマリ コンソールおよび PowerShell バージョンの表示

PowerShell のサポートは、Cisco UCS Director リリース 4.1.0.3 以降のリリースで使用できます。 Cisco UCS Director がインストールされているプライマリ コンソールおよびシステムで実行される PowerShell のバージョンを確認するには、$PSVersionTable コマンドを使用します。

以下に、Cisco UCS Director がインストールされているプライマリ コンソールと、使用されている PowerShell のバージョンに関する情報を表示する例を示します。

PS C:\Program Files (x86)\Cisco\Cisco UCS Director PowerShell Console\Modules\CiscoUcsdPS> $PSVersionTable

Name                       Value
----                       -----
PSVersion                  4.0
WSManStackVersion          3.0
SerializationVersion       1.1.0.1
CLRVersion                 4.0.30319.34209
BuildVersion               6.3.9600.16406
PSCompatibleVersions       {1.0, 2.0, 3.0, 4.0}
PSRemotingProtocolVersion  2.2


PS C:\Program Files (x86)\Cisco\Cisco UCS Director PowerShell Console\Modules\CiscoUcsdPS>

Cisco UCS Director モジュールの確認

Cisco UCS Director モジュールがインストールされていることを、Get-Module コマンドから確認する必要があります。 また、このコマンドを使用することで、Cisco UCS Director モジュールのタイプ、バージョン、および名前を表示することもできます。

以下に、Cisco UCS Director モジュールがインストールされているかどうかを確認する例を示します。

PS C:\Program Files (x86)\Cisco\Cisco UCS Director PowerShell Console\Modules\CiscoUcsdPS> Get-Module

ModuleType   Version   Name                     ExportedCommands
----------   -------   ----                     ---------------
Binary       5.3.1.0   CiscoUcsdPS              {Invoke-userAPICan...


PS C:\Program Files (x86)\Cisco\Cisco UCS Director PowerShell Console\Modules\CiscoUcsdPS>
 

Cisco UCS Director モジュールがインストールされている場合は、次の例に示すコマンドを使用してバージョンを検証できます。

PS C:\Program Files (x86)\Cisco\Cisco UCS Director PowerShell Console\Modules\CiscoUcsdPS> (Get-Module CiscoUcsdPS).version

Major Minor Build Revision
----- ----- ----- --------
5     3     1     0

PS C:\Program Files (x86)\Cisco\Cisco UCS Director PowerShell Console\Modules\CiscoUcsdPS>
 

(注)  


前の 2 つの例は、インストールされている Cisco UCS Director PowerShell モジュールが 5.3.1.0 であることを示しています。 異なるバージョンがインストールされている場合(新しいバージョンにアップグレードした場合など)は、このバージョン番号は異なります。


コマンドレットの表示

使用可能なコマンドレットのリストを表示するには、Get-Command コマンドを使用できます。 [Name] 列に、動詞と名詞の命名規則で表現されたコマンドレットがリストされます。

以下に、使用可能なコマンドレットのリストを表示する例を示します。

PS C:\Program Files (x86)\Cisco\Cisco UCS Director PowerShell Console\Modules\CiscoUcsdPS> Get-Command -Module CiscoUcsdPS

CommandType   Name                                               ModuleName
----------    ----                                               ----------
Cmdlet        Invoke-UserAPICancelSeviceRequest                  CiscoUcsdPS
Cmdlet        Invoke-UserAPIExecuteVMAction                      CiscoUcsdPS
Cmdlet        Invoke-UserAPIGetAllCatalogs                       CiscoUcsdPS
Cmdlet        Invoke-UserAPIGetAllGroups                         CiscoUcsdPS
Cmdlet        Invoke-userAPIGetAllVDCs                           CiscoUcsdPS
Cmdlet        Invoke-UserAPIGetAvailableReports                  CiscoUcsdPS
Cmdlet        Invoke-UserAPIGetHistoricalReport   	              CiscoUcsdPS
Cmdlet        Invoke-UserAPIGetInstantDataReport                 CiscoUcsdPS
Cmdlet        Invoke-UserAPIGetPage                              CiscoUcsdPS
Cmdlet        Invoke-UserAPIGetSeviceRequestDetails              CiscoUcsdPS
Cmdlet        Invoke-UserAPIGetSeviceRequests                    CiscoUcsdPS
Cmdlet        Invoke-UserAPIGetSeviceRequestWorkflow             CiscoUcsdPS
Cmdlet        Invoke-UserAPIGetTabularReport                     CiscoUcsdPS
Cmdlet        Invoke-UserAPIGetVMActionRequests                  CiscoUcsdPS
Cmdlet        Invoke-UserAPIGetWorkflowInputs                    CiscoUcsdPS
Cmdlet        Invoke-UserAPIGetWorkflowInputValue                CiscoUcsdPS
Cmdlet        Invoke-UserAPIGetWorkflowInputValues               CiscoUcsdPS
Cmdlet        Invoke-UserAPIGetWorkflows                         CiscoUcsdPS
Cmdlet        Invoke-UserAPIGetWorkflowStatus                    CiscoUcsdPS
Cmdlet        Invoke-UserAPIReconfigureVM                        CiscoUcsdPS
Cmdlet        Invoke-UserAPIRollbackflow                         CiscoUcsdPS
Cmdlet        Invoke-UserAPISubmitServiceRequest                 CiscoUcsdPS
Cmdlet        Invoke-UserAPISubmitServiceRequestCustom           CiscoUcsdPS
Cmdlet        Invoke-UserAPISubmitWorkflowServiceRequest         CiscoUcsdPS
Cmdlet        Invoke-UserAPISubmitWorkflowServiceRequestWithG... CiscoUcsdPS
Cmdlet        Invoke-UserAPISubmitWorkflowServiceRequestWithS... CiscoUcsdPS
Cmdlet        Invoke-UserAPIValidateWorkflow                     CiscoUcsdPS
Cmdlet        Invoke-UserAPIWorkflowInputDetails                 CiscoUcsdPS


PS C:\Program Files (x86)\Cisco\Cisco UCS Director PowerShell Console\Modules\CiscoUcsdPS>