cisco ucs director powershell api ユーザガイド、...

Cisco UCS Director PowerShell API ユーザガイド、リリース 5.0初版：2014年 08月 04日

シスコシステムズ合同会社〒107-6227 東京都港区赤坂9-7-1 ミッドタウン・タワーhttp://www.cisco.com/jpお問い合わせ先：シスココンタクトセンター

0120-092-255 （フリーコール、携帯・PHS含む）電話受付時間：平日 10:00～12:00、13:00～17:00http://www.cisco.com/jp/go/contactcenter/

Text Part Number: OL-32375-01-J

【注意】シスコ製品をご使用になる前に、安全上の注意（ www.cisco.com/jp/go/safety_warning/ ）をご確認ください。本書は、米国シスコ発行ドキュメントの参考和訳です。リンク情報につきま

しては、日本語版掲載時点で、英語版にアップデートがあり、リンク先のページが移動/変更されている場合がありますことをご了承ください。あくまでも参考和訳となりますので、正式な内容

については米国サイトのドキュメントを参照ください。また、契約等の記述については、弊社販

売パートナー、または、弊社担当者にご確認ください。

このマニュアルに記載されている仕様および製品に関する情報は、予告なしに変更されることがあります。このマニュアルに記載されている表現、情報、および推奨

事項は、すべて正確であると考えていますが、明示的であれ黙示的であれ、一切の保証の責任を負わないものとします。このマニュアルに記載されている製品の使用

は、すべてユーザ側の責任になります。

対象製品のソフトウェアライセンスおよび限定保証は、製品に添付された『Information Packet』に記載されています。添付されていない場合には、代理店にご連絡ください。

The Cisco implementation of TCP header compression is an adaptation of a program developed by the University of California, Berkeley (UCB) as part of UCB's public domain versionof the UNIX operating system. All rights reserved. Copyright © 1981, Regents of the University of California.

ここに記載されている他のいかなる保証にもよらず、各社のすべてのマニュアルおよびソフトウェアは、障害も含めて「現状のまま」として提供されます。シスコお

よびこれら各社は、商品性の保証、特定目的への準拠の保証、および権利を侵害しないことに関する保証、あるいは取引過程、使用、取引慣行によって発生する保証

をはじめとする、明示されたまたは黙示された一切の保証の責任を負わないものとします。

いかなる場合においても、シスコおよびその供給者は、このマニュアルの使用または使用できないことによって発生する利益の損失やデータの損傷をはじめとする、

間接的、派生的、偶発的、あるいは特殊な損害について、あらゆる可能性がシスコまたはその供給者に知らされていても、それらに対する責任を一切負わないものと

します。

このマニュアルで使用している IPアドレスおよび電話番号は、実際のアドレスおよび電話番号を示すものではありません。マニュアル内の例、コマンド出力、ネットワークトポロジ図、およびその他の図は、説明のみを目的として使用されています。説明の中に実際のアドレスおよび電話番号が使用されていたとしても、それは意

図的なものではなく、偶然の一致によるものです。

Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this URL: http://www.cisco.com/go/trademarks. Third-party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnershiprelationship between Cisco and any other company. (1110R)

© 2014 Cisco Systems, Inc. All rights reserved.

http://www.cisco.com/go/trademarks

http://www.cisco.com/go/trademarks

目次

はじめに v

対象読者 v

表記法 vi

関連資料 vii

マニュアルに関するフィードバック viii

マニュアルの入手方法およびテクニカルサポート viii

スタート時点 1

Cisco UCS Directorについて 1

Microsoft Windows PowerShellについて 2

システム要件 2

PowerShellの操作 3

コマンドレットの操作 5

PowerShellコンソールでのCisco UCS Director用の設定 5

へルプの利用方法 6

入力の定義 7

コマンドレットの実行 7

使用例：サービス要求のキャンセル 8

パイプラインオブジェクト 9

レポートの表示 10

トラブルシューティング 13

トラブルシューティング 13

Cisco UCS Director PowerShell API ユーザガイド、リリース 5.0 OL-32375-01-J iii

Cisco UCS Director PowerShell API ユーザガイド、リリース 5.0iv OL-32375-01-J

目次

はじめに

ここでは、次の項について説明します。

• 対象読者, v ページ

• 表記法, vi ページ

• 関連資料, vii ページ

• マニュアルに関するフィードバック, viii ページ

• マニュアルの入手方法およびテクニカルサポート, viii ページ

対象読者このマニュアルは、Cisco UCS Directorを使用し、次の 1つ以上の分野の責任者で、それらの分野の専門知識を持つデータセンター管理者を主な対象としています。

•サーバ管理

•ストレージ管理

•ネットワーク管理

•ネットワークセキュリティ

•仮想化および仮想マシン

Cisco UCS Director PowerShell API ユーザガイド、リリース 5.0 OL-32375-01-J v

表記法

用途テキストのタイプ

タブの見出し、領域名、フィールドのラベルのようなGUI要素は、[GUI要素]のように示しています。

ウィンドウ、ダイアログボックス、ウィザードのタイトルのようなメイ

ンタイトルは、[メインタイトル]のように示しています。

GUI要素

マニュアルのタイトルは、イタリック体（italic）で示しています。マニュアルのタイトル

テキストベースのユーザインターフェイスでは、システムによって表

示されるテキストは、courierフォントで示しています。TUI要素

システムが表示するターミナルセッションおよび情報は、courierフォントで示しています。

システム出力

CLIコマンドのキーワードは、ボールド体（bold）で示しています。

CLIコマンド内の変数は、イタリック体（italic）で示しています。

CLIコマンド

角カッコの中の要素は、省略可能です。[ ]

どれか1つを選択しなければならない必須キーワードは、波カッコで囲み、縦棒で区切って示しています。

{x | y | z}

どれか1つを選択できる省略可能なキーワードは、角カッコで囲み、縦棒で区切って示しています。

[x | y | z]

引用符を付けない一組の文字。 stringの前後には引用符を使用しません。引用符を使用すると、その引用符も含めて stringとみなされます。

string

パスワードのように出力されない文字は、山カッコで囲んで示していま

す。

< >

システムプロンプトに対するデフォルトの応答は、角カッコで囲んで

示しています。

[ ]

コードの先頭に感嘆符（!）またはポンド記号（#）がある場合には、コメント行であることを示します。

!、#

Cisco UCS Director PowerShell API ユーザガイド、リリース 5.0vi OL-32375-01-J

はじめに

表記法

「注釈」です。役立つ情報や、このマニュアル以外の参照資料などを紹介しています。（注）

「問題解決に役立つ情報」です。ヒントには、トラブルシューティングや操作方法ではなく、

ワンポイントアドバイスと同様に知っておくと役立つ情報が記述される場合もあります。

ヒント

「要注意」の意味です。機器の損傷またはデータ損失を予防するための注意事項が記述され

ています。

注意

「時間の節約に役立つ操作」です。ここに紹介している方法で作業を行うと、時間を短縮で

きます。

ワンポイントアドバイス

安全上の重要事項

「危険」の意味です。人身事故を予防するための注意事項が記述されています。機器の取り

扱い作業を行うときは、電気回路の危険性に注意し、一般的な事故防止対策に留意してくださ

い。警告の各国語版については、各警告文の末尾に提示されている番号をもとに、この機器

に付属している各国語で記述された安全上の警告を参照してください。

これらの注意事項を保存しておいてください。

警告

関連資料

『Cisco UCS Director Documentation Roadmap』

Cisco UCS Directorの資料の詳細なリストについては、次の URLにある『Cisco UCS DirectorDocumentation Roadmap』を参照してください：http://www.cisco.com/en/US/docs/unified_computing/ucs/ucs-director/doc-roadmap/b_UCSDirectorDocRoadmap.html。

『Cisco UCS Documentation Roadmaps』

すべての Bシリーズマニュアルの一覧については、http://www.cisco.com/go/unifiedcomputing/b-series-docで入手できる『Cisco UCS B-Series Servers Documentation Roadmap』を参照してください。

すべての Cシリーズマニュアルの一覧については、http://www.cisco.com/go/unifiedcomputing/c-series-docで入手できる『Cisco UCS C-Series Servers Documentation Roadmap』を参照してください。

Cisco UCS Director PowerShell API ユーザガイド、リリース 5.0 OL-32375-01-J vii

はじめに

関連資料

http://www.cisco.com/en/US/docs/unified_computing/ucs/ucs-director/doc-roadmap/b_UCSDirectorDocRoadmap.html

http://www.cisco.com/en/US/docs/unified_computing/ucs/ucs-director/doc-roadmap/b_UCSDirectorDocRoadmap.html

http://www.cisco.com/go/unifiedcomputing/b-series-doc

http://www.cisco.com/go/unifiedcomputing/b-series-doc

http://www.cisco.com/go/unifiedcomputing/c-series-doc

http://www.cisco.com/go/unifiedcomputing/c-series-doc

『Cisco UCS B-Series Servers Documentation Roadmap』にはCisco UCSManagerおよびCisco UCSCentralのドキュメントのリンクが含まれています。『CiscoUCSC-Series ServersDocumentationRoadmap』には Cisco Integrated Management Controllerのドキュメントのリンクが含まれています。

（注）

マニュアルに関するフィードバックこのマニュアルに関する技術的なフィードバック、または誤りや記載もれなどお気づきの点がご

ざいましたら、HTMLドキュメント内のフィードバックフォームよりご連絡ください。ご協力をよろしくお願いいたします。

マニュアルの入手方法およびテクニカルサポートマニュアルの入手方法、テクニカルサポート、その他の有用な情報について、毎月更新される

『What's New in Cisco Product Documentation』を参照してください。シスコの新規および改訂版の技術マニュアルの一覧も示されています。

『What's New in Cisco Product Documentation』は RSSフィードとして購読できます。また、リーダーアプリケーションを使用してコンテンツがデスクトップに直接配信されるように設定するこ

ともできます。RSSフィードは無料のサービスです。シスコは現在、RSSバージョン2.0をサポートしています。

Cisco UCS Director PowerShell API ユーザガイド、リリース 5.0viii OL-32375-01-J

はじめに

マニュアルに関するフィードバック

http://www.cisco.com/c/en/us/td/docs/general/whatsnew/whatsnew.html

第 1 章

スタート時点

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

• Cisco UCS Directorについて, 1 ページ

• Microsoft Windows PowerShellについて, 2 ページ

• システム要件, 2 ページ

• PowerShellの操作, 3 ページ

Cisco UCS DirectorについてCisco UCS Director（旧称 Cisco Cloupia Unified Infrastructure Controller）は、次の標準的なテンプレートを使用する 64ビットのアプライアンスです。

• Open Virtualization Format（OVF）for VMware vSphere

• Virtual Hard Disk（VHD）for Microsoft Hyper-V

Cisco UCS Directorは、Cisco UCSおよび Cisco Nexusプラットフォームに基づく業界をリードする統合インフラストラクチャソリューションに、セキュリティで高度に保護された統合管理機能を

提供します。

Cisco UCS Directorは、Cisco UCSを通じて、コンピューティング階層とネットワーク階層の統合を拡張し、データセンターの管理者に包括的な可視性と管理機能を提供します。この製品は、

CiscoUCSおよびCiscoNexusプラットフォームをベースにした、NetAppFlexPodおよびExpressPod、EMC Isilon、EMC VSPEX、EMC VPLEX、および VCE Vblockシステムをサポートします。

CiscoUCSDirectorは物理的、仮想的、ベアメタル型の環境にわたって、リソースプールのプロビジョニングを自動化します。この製品は、正常性、ステータス、リソース使用率に関して、ネイ

ティブな自動化されたモニタリング機能を提供します。CiscoUCSDirectorを使用して次を実行できます。

•すべてのサーバおよびアプリケーションを対象に、サービスプロファイルとテンプレートを作成、複製、および導入すること

Cisco UCS Director PowerShell API ユーザガイド、リリース 5.0 OL-32375-01-J 1

•全データセンターを対象として、仮想マシン（VM）の使用率を示すヒートマップを表示するなど、統合インフラストラクチャで組織の使用率、傾向、容量を継続的にモニタすること

•作業者ごとにばらつきのない方法で ExpressPodおよび FlexPodインフラストラクチャの導入や容量の増設を行うこと

• Cisco UCSドメインとそのコンポーネントを対象として、管理、モニタリング、報告を行うこと

•物理的なインフラストラクチャサービスを含むように、仮想サービスカタログを拡張すること

•仮想化された作業負荷と仮想化されていない作業負荷の両方に対応するために、セキュリティで保護されたマルチテナント環境を管理すること

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

WindowsPowerShellでオブジェクトを操作するには、コマンドレット（cmdlet）を使用します。コマンドレットとは、単一機能を持つコマンドです。コマンドレットは、動詞と名詞をダッシュ

（-）で区切った組み合わせとして表されます。コマンドレットの例には、Get-Help、Get-Process、Invoke-APIなどがあります。コマンドレットはMicrosoft Windowsサーバで実行されます。各コマンドレットが単一の操作を実行します。複数のコマンドレットを連結することもできます。

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

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

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

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

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

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

Cisco UCS Director PowerShell API ユーザガイド、リリース 5.02 OL-32375-01-J

スタート時点

Microsoft Windows PowerShell について

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

• .NET Framework 4.0以降

• PowerShellバージョン 3.0以降

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

PowerShell へのアクセス

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

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

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

以下に、CiscoUCSDirectorがインストールされているプライマリコンソールと、使用されているPowerShellのバージョンに関する情報を表示する例を示します。PS C:\Program Files (x86)\Cisco\Cisco UCS Director PowerShell Console\Modules\CiscoUcsdPS>$PSVersionTable

Name Value---- -----PSVersion 3.0WSManStackVersion 3.0SerializationVersion 1.1.0.1CLRVersion 4.0.30319.18408BuildVersion 6.2.9200.16398PSCompatibleVersions {1.0, 2.0, 3.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コマンドを使って確認する必要があります。さらに、このコマンドを使用して、CiscoUCSDirectorモジュールのタイプ、バージョン、および名前を表示することもできます。

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

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

ModuleType Version Name ExportedCommands---------- ------- ---- ---------------Binary 0.9 CiscoUcsdPS <Invoke–userAPICan...


スタート時点

PowerShell の操作

Manifest 3.1.0.0 Microsoft.PowerShell.Utility <Add–Member, Add–T...


コマンドレットの表示

使用可能なコマンドレットのリストを表示するには、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 CiscoUcsdPSCmdlet Invoke-UserAPIExecuteVMAction CiscoUcsdPSCmdlet Invoke-UserAPIGetAllCatalogs CiscoUcsdPSCmdlet Invoke-UserAPIGetAllGroups CiscoUcsdPSCmdlet Invoke-UserAPIGetAvailableReports CiscoUcsdPSCmdlet Invoke-UserAPIGetHistoricalReports CiscoUcsdPSCmdlet Invoke-UserAPIGetInstantDataReport CiscoUcsdPSCmdlet Invoke-UserAPIGetPage CiscoUcsdPSCmdlet Invoke-UserAPIGetSeviceRequestDetails CiscoUcsdPSCmdlet Invoke-UserAPIGetSeviceRequests CiscoUcsdPSCmdlet Invoke-UserAPIGetSeviceRequestWorkflow CiscoUcsdPSCmdlet Invoke-UserAPIGetTabularReport CiscoUcsdPSCmdlet Invoke-UserAPIGetVMActionRequests CiscoUcsdPSCmdlet Invoke-UserAPIGetWorkflowInputs CiscoUcsdPSCmdlet Invoke-UserAPIGetWorkflowInputValue CiscoUcsdPSCmdlet Invoke-UserAPIGetWorkflowInputValues CiscoUcsdPSCmdlet Invoke-UserAPIGetWorkflows CiscoUcsdPSCmdlet Invoke-UserAPIGetWorkflowStatus CiscoUcsdPSCmdlet Invoke-UserAPIReceiveObject CiscoUcsdPSCmdlet Invoke-UserAPIReconfigureVM CiscoUcsdPSCmdlet Invoke-UserAPIRollbackflow CiscoUcsdPSCmdlet Invoke-UserAPISubmitServiceRequest CiscoUcsdPSCmdlet Invoke-UserAPISubmitServiceRequestCustom CiscoUcsdPSCmdlet Invoke-UserAPISubmitWorkflowServiceRequest CiscoUcsdPSCmdlet Invoke-UserAPISubmitWorkflowServiceRequestWithG... CiscoUcsdPSCmdlet Invoke-UserAPISubmitWorkflowServiceRequestWithS... CiscoUcsdPSCmdlet Invoke-UserAPIValidateWorkflow CiscoUcsdPSCmdlet Invoke-UserAPIWorkflowInputDetails CiscoUcsdPS



スタート時点

PowerShell の操作

第 2 章

コマンドレットの操作

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

• PowerShellコンソールでのCisco UCS Director用の設定, 5 ページ

• へルプの利用方法, 6 ページ

• 入力の定義, 7 ページ

• コマンドレットの実行, 7 ページ

• パイプラインオブジェクト, 9 ページ

• レポートの表示, 10 ページ

PowerShell コンソールでのCisco UCS Director用の設定コマンドレットを Cisco UCS Directorサーバに対して実行するには、PowerShellコンソールで環境変数を設定する必要があります。すべてのコマンドレットは、Cisco UCS Directorの IPアドレスおよびRESTキーをオプションパラメータとして受け入れます。これらのパラメータを指定しない場合、コマンドレットは PowerShell環境変数 UCSD_SERVERおよび UCSD_RESTKEYから選択します。

環境変数は、以下のように SetEnvironmentVariableメソッドを使用して設定できます。[Environment]::SetEnvironmentVariable("UCSD_SERVER","10.1.1.1","User")[Environment]::SetEnvironmentVariable("UCSD_RESTKEY","562FDF763A384E78B9BAB7FE02CA13B6","User")

設定済みの環境変数を取得するには、次のようにGetEnvironmentVariableコマンドを使用します。[Environment]::GetEnvironmentVariable("UCSD_RESTKEY","User")

環境変数を変更した場合、セッションの再開後に適用されます。


へルプの利用方法コマンドレットは、Windows PowerShellで実行できます。コマンドレットのヘルプを表示するには、?または get-Helpコマンドを使用します。

コマンドレットで ?を入力すると、そのコマンドレットの構文、パラメータ、エイリアス、および説明が表示されます。

以下に、コマンドレットのヘルプを表示する例を示します。

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

NAMEInvoke–userAPISubmitServiceRequest

SYNTAXInvoke–userAPISubmitServiceRequest [–catalogName] <string> [-vdcName] <string>

[-durationHours] <int> [-beginTime] <long> [-quantity] <int> [-comments] <string> [-server <string>] [-restkey <string>]

ALIASESNone

REMARKSNone


各コマンドレットには、必須パラメータとオプションパラメータがあります。たとえば、

Invoke–userAPISubmitServiceRequestコマンドレットには、必須パラメータとして catalogName、オプションパラメータとして serverおよび restKeyがあります。

次のようにget-Helpコマンド、コマンドレット名、およびパラメータを使用すると、コマンドレットの個々のパラメータに関する詳しいヘルプを表示できます。

PS C:\Program Files (x86)\Cisco\Cisco UCS Director PowerShell Console\Modules\CiscoUcsdPS>get-Help Invoke–userAPISubmitServiceRequest –Parameter catalogName

–catalogName <string>

Required? truePosition? 0Accept pipeline input? falseParamter set name <All>Aliases NoneDynamic? None

PS C:\Program Files (x86)\Cisco\Cisco UCS Director PowerShell Console\Modules\CiscoUcsdPS>PS C:\Program Files (x86)\Cisco\Cisco UCS Director PowerShell Console\Modules\CiscoUcsdPS>get-Help Invoke–userAPISubmitServiceRequest –Parameter server

–server <string>

Required? falsePosition? NamedAccept pipeline input? falseParamter set name <All>Aliases NoneDynamic? false




へルプの利用方法

入力の定義コマンドレットが受け入れる入力は、『Cisco UCS Director REST Developer Guide』で説明されています。RESTAPIの詳細については、『Cisco UCSDirector RESTDeveloper Guide』を参照してください。

ワークフローを送信するコマンドレットは、名前と値のペアの配列をワークフロー入力として受

け入れます。入力は、以下のようにコロンで区切った名前と値のペアからなる配列として指定す

る必要があります。

Name1:value1, Name2:value2

たとえば、user-add-testという名前のワークフローを送信する場合、コマンドラインは次のようになります。

Invoke-userAPISubmitWorkflowServiceRequest user-add-test -parametersuser-type:Regular,group-id:1,login-name:cmdlettest1,password:test,confirm-password:test,email:[email protected]

コマンドレットの実行コマンドレットは、他のすべての PowerShellコマンドと同じ方法で実行されます。パイプ演算子（¦）を使用することで、一般的な操作（検索やフィルタリングなど）をコマンドの出力に適用できます。

以下に示す例では、?コマンドを使ってコマンドレットのパラメータを取得し、コマンドレット出力をキャプチャしてフィルタリングします。

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

NAMEInvoke–userAPIGetWorkflowInputValues

SYNTAXInvoke–userAPIGetWorkflowInputValues [–srId] <int> [-server <string>] [-restkey <string>]

[<CommonParameters>]

ALIASESNone

REMARKSNone

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

Input Set Id Action Id Field Id Field Value------------ --------- -------- -----------18 0 WF_EMPTY_INPUTS18 156 input_0_user-type471 Regular18 156 AddUser_231.OUTUT_USER_NAME cmdlettest118 156 input_3_password453 test18 156 input_4_confirm-password361 test18 156 input_5_email1932 [email protected] 156 input_1_group-id135 118 156 input_2_login-name867 cmdlettest1




入力の定義

http://www.cisco.com/c/en/us/support/servers-unified-computing/ucs-director/products-programming-reference-guides-list.html

Invoke–userAPIGetWorkflowInputValues 429 ¦ Select-Object 'Field Id', 'Field Value'

Field Id Field Value-------- -----------WF_EMPTY_INPUTSinput_0_user-type471 RegularAddUser_231.OUTUT_USER_NAME cmdlettest1input_3_password453 testinput_4_confirm-password361 testinput_5_email1932 [email protected]_1_group-id135 1input_2_login-name867 cmdlettest1


使用例：サービス要求のキャンセル

ここでは、PowerShellコンソールからサービス要求をキャンセルする方法について説明します。

はじめる前に

Cisco UCS Directorサーバに対してコマンドレットを実行する場合は、PowerShellコンソールで環境変数がすでに設定されていることを確認してください。詳細については、PowerShellコンソールでのCisco UCS Director用の設定, （5ページ）を参照してください。

ステップ 1 Get-Commandを使用して、使用可能なコマンドレットのリストを表示します。サービス要求をキャンセルするためのコマンドレットは、Invoke–userAPICancelServiceRequestです。

ステップ 2 Invoke–userAPICancelServiceRequestコマンドレットのパラメータを取得するには、?コマンドを使用します。PS C:\Program Files (x86)\Cisco\Cisco UCS Director PowerShell Console\Modules\CiscoUcsdPS>Invoke–userAPICancelServiceRequest –?

NAMEInvoke–userAPICancelServiceRequest

SYNTAXInvoke–userAPICancelServiceRequest [–requestId] <int> [-server <string>] [-restkey <string>]

[<CommonParameters>]

ALIASESNone

REMARKSNone

Invoke–userAPICancelServiceRequestコマンドレットを実行するために必要な入力は、以下のとおりです。

• requestId：必須パラメータ

• server：オプションパラメータ

• restKey：オプションパラメータ



使用例：サービス要求のキャンセル

コマンドレットの個々のパラメータについての詳細なヘルプを表示するには、get-Helpコマンドを使用します。詳細については、へルプの利用方法, （6ページ）を参照してください。

（注）

ステップ 3 以下のように、サービス要求 ID（たとえば 79）を渡して、コマンドを実行します。

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

このコマンドは出力としてブール値を返します。サービス要求が正常にキャンセルされると、出力として

Trueが返されます。

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

パイプラインオブジェクトパイプ演算子（¦）で複数のコマンドを連結することで、コマンド出力に対して共通のオプションを実行できます。各コマンドの出力が、その次のコマンドの入力として使用されます。

次の表に、コマンドレットごとにパイプラインに書き込まれるオブジェクトのタイプを記載しま

す。

返されるオブジェクトタイプコマンドレット

SR ID（Int）Invoke-userAPICancelServiceRequest

VM ID（String）Invoke-userAPIExecuteVMAction

APITabularReportInvoke-UserAPIGetAllCatalogs

APITabularReportInvoke-userAPIGetAllGroups

APITabularReportInvoke-userAPIGetAllVDCs

APIReportDefinitionの配列Invoke-userAPIGetAvailableReports

HistoricalDataSeriesの配列Invoke-userAPIGetHistoricalReport

APISnapshotReportInvoke-userAPIGetInstantDataReport

VMDataViewPaginatedInvoke-userAPIGetPage

APIServiceRequestDetailsInvoke-userAPIGetServiceRequestDetails

APITabularReportInvoke-userAPIGetServiceRequests

APIWorkflowStatusInvoke-userAPIGetServiceRequestWorkFlow

APITabularReportInvoke-userAPIGetTabularReport

APITabularReportInvoke-userAPIGetVMActionRequests



パイプラインオブジェクト

返されるオブジェクトタイプコマンドレット

APIWorkflowInputDetailの配列Invoke-userAPIGetWorkflowInputs

StringInvoke-userAPIGetWorkflowInputValue

WorkflowInputValueInvoke-userAPIGetWorkflowInputValues

CustomActionDefinitionの配列Invoke-userAPIGetWorkflows

整数Invoke-userAPIGetWorkflowStatus

VM ID（String）Invoke-userAPIReconfigureVM

SR IDInvoke-userAPIRollbackWorkflow

SR IDInvoke-userAPISubmitServiceRequest

SR IDInvoke-userAPISubmitServiceRequestCustom

SR IDInvoke-userAPISubmitWorkflowServiceRequest

SR IDInvoke-userAPISubmitWorkflowServiceRequestWithGroup

SR IDInvoke-userAPISubmitWorkflowServiceRequestWithStartTimeAndDurationHours

APIWFValidationResultInvoke-userAPIValidateWorkFlow

APIWorkflowInputDetailsInvoke-userAPIWorkflowInputDetails

レポートの表示レポートを表示するには、次のコマンドレットを使用できます。

• Invoke-UserAPIGetAllCatalogs

• Invoke-UserAPIGetAllGroups

• Invoke-UserAPIGetAvailableReports

• Invoke-UserAPIGetHistoricalReports

• Invoke-UserAPIGetInstantDataReport

• Invoke-UserAPIGetPage

• Invoke-UserAPIGetSeviceRequestDetails

• Invoke-UserAPIGetSeviceRequests

• Invoke-UserAPIGetSeviceRequestWorkflow

• Invoke-UserAPIGetTabularReport

• Invoke-UserAPIGetVMActionRequests

• Invoke-UserAPIGetWorkflowInputs

• Invoke-UserAPIGetWorkflowInputValue



レポートの表示

• Invoke-UserAPIGetWorkflowInputValues

• Invoke-UserAPIGetWorkflows

• Invoke-UserAPIGetWorkflowStatus

userAPIGetPageAPIはパラメータの1つとして、ページ番号付きレポートの名前を必要とします。

以下の表に、レポート名とそのコンテキスト値を示します。

コンテキスト

値

レポート名

なしCHARGEBACK_DETAILS_SERVICES_GLOBAL_TABULAR

<cloudName>PER_CLOUD_ARCHIVED_HYPERV_VM_LIST_REPORT

<cloudName>vms.paginated.report

<cloudName>PER_CLOUD_ARCHIVED_VM_LIST_REPORT

以下に、vmware-accountアカウントレポートのページを取得する例を示します。Invoke-userAPIGetPage vms.paginated.report vmware-account 1 10




第 3 章

トラブルシューティング

この章の内容は、次のとおりです。

• トラブルシューティング, 13 ページ

トラブルシューティングここでは、管理者がPowerShellコンソールを使用する際に生じる可能性のある問題のソリューションについて説明します。

スクリプトを実行できない

問題

スクリプトを実行できません。

説明

PowerShellコマンドプロンプトを起動すると、以下のように、スクリプトを実行できないことを通知するエラーメッセージがスローされます。

PS C:\Program Files (x86)\Cisco\Cisco UCS Director PowerShell Console\Modules\CiscoUcsdPS>C:\Windows\System32\windowspowershell\v1.0\powershell.exe -NoExit -File -\StartUcsdPS.ps1

Widows PowerShellCopyright <c> 2013 Microsoft Corporation. All rights reserved.

File C:\Program Files <x86>\Cisco\Cisco UCS Director PowerShellConsole\Modules\CiscoUcsdPS\StartUcsdPS.ps1 cannot be loaded because running scripts isdisabled on this system. For more information, see about_Exeuction_Policies athttp://go.microsoft.com/fwlink/?LinkID=135170.

+ CategoryInfo : SecurityError: <:> [], ParentContainsErrorRecord Exception+ FullyQualifiedErrorId : UnauthorizedAccess

ソリューション

Windows PowerShellのセキュリティ戦略には、実行ポリシーが含まれています。これにより、（Windows PowerShellプロファイルを含む）コンフィギュレーションファイルをロードしてスクリプトを実行できるかどうか、そして実行前にデジタル署名を付けなければならないスクリプト


（存在する場合）が決まります。 Set-ExecutionPolicyコマンドレットは、Windows PowerShell実行ポリシーのユーザ設定を変更します。

デフォルトスコープの実行ポリシーを変更するには、Windows PowerShellを起動して、次のように ExecutionPolicyをUnrestrictedに設定します。PS C:\Program Files (x86)\Cisco\Cisco UCS Director PowerShell Console\Modules\CiscoUcsdPS>Set-ExecutionPolicy Unrestricted

コマンドレットの実行が失敗する

問題

コマンドレットの実行中に、PowerShellコンソールが次のいずれかのエラーをスローします。

• Cisco UCS Directorサーバに到達できませんでした。

•操作のタイムアウトエラーが発生しました。

• IP/RESTキーを空にすることはできません。

説明

環境変数UCSD_RESTKEYおよびUCSD_SERVERを設定しても、コマンドレットの実行が失敗します。

PS C:\UCSDPowerShellTest\Modules\CiscoUcsdPS>[Environment]::SetEnvironmentVariable("UCSD_SERVER","10.1.1.1","User")

PS C:\UCSDPowerShellTest\Modules\CiscoUcsdPS>[Environment]::SetEnvironmentVariable("UCSD_RESTKEY","5E8DA3924FDB4CC49213FCAAE2CBCEEB","User")

PS C:\UCSDPowerShellTest\Modules\CiscoUcsdPS> Invoke-userAPIGetAllGroupsInvoke-userAPIGetAllGroups : IP/REST Key can't be EmptyAt line:1 char:1+ Invoke-userAPIGetAllGroups+ ~~~~~~~~~~~~~~~~~~~~~~~~~~

+ CategoryInfo : InvalidArgument: (server/restKey:String) [Invoke- userAPIGetAllGroups], ArgumentException

ソリューション

環境変数に設定した値は、コンソールを再起動した後に APIに反映されます。




cisco ucs director powershell api ユーザ ガイド、...

Documents

cisco ucs director powershell api ユーザガイド、...