Cisco UCS Director REST 開発者ガイド、リリース 5.2
API の操作
API の操作

目次

API の操作

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

REST API の操作の概要

この項に記載された Cisco UCS Director REST API 操作のカタログは、どの操作がニーズに対応するか、各操作をどのように行うかを知るために役立ちます。 レポート メタデータおよび REST API ブラウザを介した API 操作の要求と応答値の例が記載されています。


(注)  


POST メソッドを使用して実行される操作は、主に、サービスとプロビジョニングに使用されます。



(注)  


API 要求 URL の opData には、次の JSON パラメータ(操作に関連付けられた引数)が含まれます。
  • param0:REST API 経由で呼び出されるワークフローの名前。

  • param1:ワークフローに渡される入力。 複数の入力が存在する場合は、それらを引用符で囲んでから、カンマで区切って、中括弧内に入れます。 入力が存在しない場合は、API 呼び出しで null を使用します。

  • param2:このワークフローが他のサービス要求の子ワークフローとして呼び出される場合は、サービス要求(SR)ID を使用します。 このワークフローが子ワークフローとして呼び出されない場合は、-1 を使用します。 -1 を使用した場合は、新しいサービス要求が呼び出されます。


ログインの操作

userAPIGetMyLoginProfile

説明

ログインしたユーザに関する情報を返します。

パラメータ

なし。

戻り値のタイプ

APILoginProfile

アクセス可能

管理者/エンド ユーザ

userAPIGetUserLoginProfile

説明

特定のユーザ ID に関するユーザ情報を返します。

パラメータ

String userId

戻り値のタイプ

APILoginReport

アクセス可能

管理者/エンド ユーザ


(注)  


ユーザ アカウントの操作も参照してください。ユーザの追加、オンボーディング、パスワードの管理、プロファイルなどの操作が説明されています。


値のフェッチ操作

userAPIGetLOVValues

説明

変数の組み込みリスト(LOV)(embedded-lov)の特定のワークフロー入力タイプに対する値の候補のリストを返します。 API がエンド ユーザの REST API キーを使用してアクセスされている場合、データはエンド ユーザ ID に基づいてフィルタされます。

パラメータ

String type:入力タイプの取得に userAPIGetWorkInputs API を使用します。

戻り値のタイプ

FormLOVPair

アクセス可能

管理者/エンド ユーザ

userAPIGetTabularValues

説明

テーブルまたはポップアップ テーブルの特定のワークフロー入力タイプに対する値の候補を表形式で返します。 API がエンド ユーザの REST API キーを使用してアクセスされている場合、データはエンド ユーザ ID に基づいてフィルタされます。

パラメータ

String type:入力タイプの取得に userAPIGetWorkInputs API を使用します。

戻り値のタイプ

APITabularReport

アクセス可能

管理者/エンド ユーザ

ユーザ アカウントの操作

userAPIAddUser

説明

提供された情報(ユーザ ID、パスワード、電子メールなど)とともにユーザを追加します。

パラメータ
  • String userId:ユーザの一意の ID。

  • String password:ユーザのパスワード。

  • String firstName:ユーザの名。

  • String lastName:ユーザの姓。

  • String email:ユーザの電子メール アドレス。

  • String role:ユーザのロール。 ユーザ ロールには、Regular、GroupAdmin、Admin、AdminIS、AdminComputing、AdminStorage、AdminNetwork、AdminAllPolicy、Operator、MSPAdmi、および BillingAdmin が含まれます。

  • String groupName:ユーザが属するグループの名前。

戻り値のタイプ

ブール値(成功の場合 true)

アクセス可能

管理者

userAPIOnBoarding

説明

APIUserOnBoardDetails 引数で提供された詳細を使用し、ユーザ、グループ、VDC を作成します。

パラメータ

APIUserOnBoardParams inParams

この JSON オブジェクトの例については、JSON オブジェクト パラメータ タイプを参照してください。

戻り値のタイプ

APIUserOnBoardDetails

この JSON オブジェクトの例については、JSON オブジェクト パラメータ タイプを参照してください。

アクセス可能

管理者/エンド ユーザ

userAPIGetUserLoginProfile

説明

特定のユーザ ID に関するユーザ情報を返します。

パラメータ

String userId

戻り値のタイプ

APILoginReport

アクセス可能

管理者/エンド ユーザ

userAPIDeleteUser

説明

特定のユーザ ID のユーザを削除します。

パラメータ

String userId

戻り値のタイプ

ブール値(成功の場合 true)

アクセス可能

管理者

userAPIResetMyPassword

説明

ユーザ アカウントのパスワードを、要求で提供された新しいパスワードにリセットします。

パラメータ

String newPassword

戻り値のタイプ

ブール値(成功の場合 true)

アクセス可能

管理者/エンド ユーザ

userAPIResetUserPassword

説明

ユーザのパスワードを、提供されたユーザ ID と新しいパスワードにリセットします。

パラメータ
  • String user ID

  • String newPassword

  • boolean resetAPIKey


(注)  


resetAPIKey が true に設定されている場合には、パスワードのリセットだけでなく、REST API キーも Cisco UCS Director によってリセットされます。 false に設定されている場合には、その特定ユーザのパスワードのみがリセットされ、REST API キーは変更されません。 resetAPIKey が true に設定されている場合には、ユーザは何もする必要がありません。 パスワードのリセット時に REST API キーをリセットするか否かを決める必要があります。


戻り値のタイプ

ブール値(成功の場合 true)

アクセス可能

管理者

userAPIVerifyUser

説明

提供されたパスワードでユーザを認証します。

パラメータ
  • String userId

  • String passWord

戻り値のタイプ

APILoginProfile

この JSON オブジェクトの例については、JSON オブジェクト パラメータ タイプを参照してください。

アクセス可能

管理者/エンド ユーザ


(注)  


ログインの操作も参照してください。


userAPIGetRESTAccessKey

説明

特定のユーザ名に対する API アクセス キーを返します。

パラメータ

String username:API アクセス キーを抽出する必要のあるユーザの名前。

戻り値のタイプ

文字列

アクセス可能

管理者/エンド ユーザ

userAPIIsMspMode

説明

現在ログイン中のユーザが Management Software Provider(MSP)モードの場合は true を返します。

パラメータ

なし

戻り値のタイプ

ブール値

アクセス可能

管理者/エンド ユーザ

グループの操作

userAPICreateGroup

説明

Cisco UCS Director にグループを作成します。 グループ タイプは、管理者またはエンド ユーザに対しては 0、マネージド サービス プロバイダー(MSP)組織ユーザに対しては 1 と設定されます。 親グループ ID が 0 より大きい場合、作成したグループ名は親グループ ID にマップされます。


(注)  


グループがグループまたは組織に属している場合、parentId および parentGroupName パラメータは必須です。 グループ タイプが 0 として設定されている場合、グループ名および電子メールアドレスは必須です。


パラメータ

apiGroup APIGroup

APIGroup には、次のパラメータが含まれます。

  • int groupId

  • String groupName

  • String description

  • int parentGroupId

  • String emailAddress

  • String lastName

  • String firstName

  • String phoneNumber

  • String address

  • int groupType

戻り値のタイプ

Int groupId

アクセス可能

管理者

userAPIAddGroup

説明

指定されたデータ(グループ名、説明、名前、電子メール)とともにグループを追加します。

パラメータ
  • String groupName

  • String description

  • String firstName

  • String lastName

  • String contactEmail

戻り値のタイプ

ブール値(成功の場合 true)

アクセス可能

管理者


(注)  


userAPIGetCatalogsPerGroup など多くの操作がグループ値に関連付けられています。 詳細については、主要操作のカテゴリを参照してください。


userAPIGetGroups

説明

Cisco UCS Director ですべてのグループをリストとして返します。

パラメータ

なし

戻り値のタイプ

List APIGroup

アクセス可能

管理者/エンド ユーザ

userAPIGetGroupById

説明

特定のグループ IDに対するグループ詳細を返します。

パラメータ

int groupId:グループの ID。

戻り値のタイプ

List APIGroup

アクセス可能

管理者/エンド ユーザ

userAPIGetGroupByName

説明

特定のグループ名に対するグループ詳細を返します。

パラメータ

String groupName:グループの名前。

戻り値のタイプ

List APIGroup

アクセス可能

管理者/エンド ユーザ

userAPIUpdateGroup

説明

特定の情報でグループの詳細を更新します。 グループ ID およびグループ名は編集できません。

パラメータ

apiGroup APIGroup

戻り値のタイプ

ブール値

アクセス可能

管理者

userAPIDeleteGroup

説明

特定のグループ ID に基づいて Cisco UCS Director からグループを削除します。

パラメータ

int groupId

戻り値のタイプ

ブール値

アクセス可能

管理者

アカウントの操作

userAPICreateInfraAccount

説明

インフラ アカウントを作成します。

パラメータ
  • InfraAccountDetails infraAccountDetails

戻り値のタイプ

ブール値(成功の場合 true)

アクセス可能

管理者/エンド ユーザ

userAPIUpdateInfraAccount

説明

インフラ アカウントを更新します。

パラメータ
  • InfraAccountDetails infraAccountDetails

戻り値のタイプ

ブール値(成功の場合 true)

アクセス可能

管理者/エンド ユーザ

userAPIGetAllAccounts

説明

すべてのアカウントの名前を返します。

パラメータ
なし
戻り値のタイプ

List as String タイプ

アクセス可能

管理者/エンド ユーザ

userAPIGetAllPhysicalInfraAccounts

説明

すべての物理インフラ アカウント タイプを返します。

パラメータ
なし
戻り値のタイプ

List PhysicalInfraAccount

アクセス可能

管理者/エンド ユーザ

userAPIGetAccountTypeEntryByName

説明

特定のアカウント名のアカウント タイプ エントリを返します。

パラメータ
String Account name
戻り値のタイプ

List AccountTypeEntry

アクセス可能

管理者/エンド ユーザ

userAPIGetAccountTypeByName

説明

アカウント名に基づいてアカウント タイプを表示します。

パラメータ
String Account name
戻り値のタイプ

List as String

アクセス可能

管理者/エンド ユーザ

userAPIDeleteInfraAccount

説明

インフラ アカウントを削除します。

パラメータ
String Account name
戻り値のタイプ

ブール値(成功の場合 true)

アクセス可能

管理者/エンド ユーザ

レポートの操作

userAPIGetAvailableReports

説明

特定のコンテキストで利用可能なレポートを返します。

パラメータ
  • String contextName

  • String contextValue

戻り値のタイプ

List

アクセス可能

管理者/エンド ユーザ

userAPIGetTabularReports

説明

特定のコンテキストとレポート ID について表形式のレポートを返します。

パラメータ
  • String contextName

  • String contextValue

  • String reportId

戻り値のタイプ

APITabularReport

アクセス可能

管理者/エンド ユーザ

userAPIFilterTabularReport

説明

特定の列ラベルおよび列値に基づいて表形式のレポートをフィルタリングします。 レポートのすべての行は、列ラベルおよび列値パラメータに空の値(" ")を渡すことで取得できます。

パラメータ
  • String contextName

  • String contextValue

  • String reportId

  • String columnLabel

  • String cloumnValue


(注)  


columnLabel パラメータは userAPIGetTabularReport API の結果から取得する必要があります。 VM ID に基づいた VM の表形式レポートのフィルタリングには、列ラベルとして VM-ID を使用します。


戻り値のタイプ

APITabularReport

アクセス可能

管理者/エンド ユーザ

userAPIGetHistoricalReport

説明

特定のコンテキスト、レポート ID、および期間について表形式のレポートを返します。

パラメータ
  • String contextName

  • String contextValue

  • String reportId

  • String durationName

戻り値のタイプ

APIHistoricalReport

アクセス可能

管理者/エンド ユーザ

userAPIGetInstantDataReport

説明

特定のコンテキストとレポート ID についてスナップショット レポートを返します。

パラメータ
  • String contextName

  • String contextValue

  • String reportId

戻り値のタイプ

APISnapshotReport

アクセス可能

管理者/エンド ユーザ

userAPIGetTabularReportWithMetaData

説明

メタデータを含むレポートを提供します。

パラメータ
  • String contextName

  • String contextValue

  • String reportId

戻り値のタイプ

APITabularReport

アクセス可能

管理者/エンド ユーザ

承認の操作

userAPIGetMyApprovalList

説明

ログインしたユーザの承認リストを返します。

パラメータ

なし。

戻り値のタイプ

APITabularReport

アクセス可能

管理者/エンド ユーザ

userAPIUpdateMyApproval

説明

提供されたデータを使用し、現在のユーザの承認ステータスを更新します。

パラメータ
  • int requestId

  • int entryId

  • boolean isApproved

  • String comments

戻り値のタイプ

ブール値(成功の場合 true)

アクセス可能

管理者/エンド ユーザ

カタログの操作

userAPICreateCatalogItem

説明

提供データで定義された特徴でカタログ項目を作成します。

パラメータ

APICatalogItem item

この JSON オブジェクトの例については、JSON オブジェクト パラメータ タイプを参照してください。

戻り値のタイプ

ブール値(成功の場合 true)

アクセス可能

管理者

userAPIGetAllCatalogs

説明

すべてのカタログ レポートを返します。

パラメータ

なし。

戻り値のタイプ

APITabularReport

アクセス可能

管理者/エンド ユーザ

userAPIGetCatalogsPerGroup

説明

特定のグループに割り当てられたカタログを返します。

パラメータ

String groupName

戻り値のタイプ

APITabularReport

アクセス可能

管理者/エンド ユーザ

userAPIGetAllCatalogs

説明

すべてのカタログ レポートを返します。

パラメータ

なし。

戻り値のタイプ

APITabularReport

アクセス可能

管理者/エンド ユーザ

チャージバックの操作

userAPIChargebackDetails

説明

ログインしたユーザ グループに関するチャージバックの詳細を返します。

パラメータ

なし。

戻り値のタイプ

APITabularReport

アクセス可能

管理者/エンド ユーザ

資金の操作

userAPICheckFunds

説明

利用可能な顧客の資金を返します。


(注)  


Cisco UCS Director リリース 5.x 以降のリリースでは、userAPIGlobal フォルダから使用できる UserAPICheckFunds API は廃止されています。 使用可能な顧客資金を調べるには、userAPIChargeBack フォルダの UserAPICheckFunds API を使用します。


パラメータ

String userID

戻り値のタイプ

Double(利用可能な資金)

アクセス可能

管理者/エンド ユーザ


(注)  


支払いステータスの操作も参照してください。


インベントリ(クラウド)の操作

userAPIRequestInventoryCollection

説明

指定されたクラウドのインベントリ収集をトリガーします。

パラメータ

String cloudName

戻り値のタイプ

ブール値(成功の場合 true)

アクセス可能

管理者/エンド ユーザ

LOV プロバイダーの操作

userAPIgetStaticListByName

説明

リストの要素を返します。

パラメータ

リストの名前

戻り値のタイプ

FormLOVPair[]

アクセス可能

管理者/エンド ユーザ

userAPIgetBMAOSList

説明

Baremetal Agent OS 名のリストを返します。

パラメータ

なし。

戻り値のタイプ

FormLOVPair[]

アクセス可能

管理者/エンド ユーザ

userAPIGetLOVProvidersList

説明

システム内の利用可能なリストの名前を返します。

パラメータ

なし。

戻り値のタイプ

List<String>

アクセス可能
管理者/エンド ユーザ

支払いステータスの操作

userAPIUpdatePaymentStatus

説明

金額およびタイムスタンプで支払いステータスを更新します。

パラメータ

APIMakePaymentParams inParams

この JSON オブジェクトの例については、JSON オブジェクト パラメータ タイプを参照してください。

戻り値のタイプ

ブール値(成功の場合 true)

アクセス可能

管理者/エンド ユーザ


(注)  


資金の操作も参照してください。


リソース アカウンティングおよび制限

userAPIGetResourceAccounting

説明

ログインしたユーザ グループのリソース使用状況を返します。

パラメータ

なし。

戻り値のタイプ

APITabularReport

アクセス可能

管理者/エンド ユーザ

userAPIGetResourceAccountingDetails

説明

ログインしたユーザ グループのリソース使用状況の詳細を返します。

パラメータ

なし。

戻り値のタイプ

APITabularReport

アクセス可能

管理者/エンド ユーザ

userAPIGetResourceLimits

説明

要求されたグループに対するリソース制限を返します。

パラメータ

String groupName

戻り値のタイプ

APITabularReport

アクセス可能

管理者

userAPIGetResourceLimitsForMyGroup

説明

ログインしたグループのリソース制限を返します。

パラメータ

なし。

戻り値のタイプ

APITabularReport

アクセス可能

管理者/エンド ユーザ

サービス コンテナの操作

サービス コンテナ API は、保護されるコンテナおよび APIC コンテナの両方をサポートします。 REST API ブラウザで、APIC およびフェンスド コンテナに対する API は、リソース列で UserAPIAPICContainer および UserAPIFencedContainer として区別されます。 API URL で、APIC コンテナの名前空間と保護されるコンテナは apic および fenced として記述されます。

APIC コンテナのサンプル API URL は次のとおりです。
/app/api/rest?formatType=json&opName=apic:userAPIPowerOnServiceContainer&opData={param0:1000}
保護されるコンテナのサンプル API URL は次のとおりです。
/app/api/rest?formatType=json&opName=fenced:userAPIPowerOnServiceContainer&opData={param0:1000}

userAPICreateServiceContainerTemplate

説明

Cisco UCS Director にサービス コンテナ テンプレートを作成します。

パラメータ

パラメータの一覧については、JSON の例:APIServiceContainerTemplateを参照してください。

戻り値のタイプ

ブール値

アクセス可能

管理者/エンド ユーザ

userAPIUpdateServiceContainerTemplate

説明

Cisco UCS Director でサービス コンテナ テンプレートを更新します。

パラメータ

container Id:更新するサービス コンテナの ID。

戻り値のタイプ

ブール値

アクセス可能

管理者/エンド ユーザ

userAPIGetServiceContainerTemplates

説明

Cisco UCS Director でサービス コンテナ テンプレートのリストを返します。

パラメータ

なし

戻り値のタイプ

API サービス コンテナ テンプレートのリスト

アクセス可能

管理者/エンド ユーザ

userAPIGetApplicationContainerTemplateDetails

説明

サービス コンテナを作成するために使用されるアプリケーション コンテナ テンプレートの詳細を返します。

パラメータ

applicationContainerTemplateName:アプリケーション コンテナに使用されるテンプレートの名前。

戻り値のタイプ

APITabularReport

アクセス可能

管理者/エンド ユーザ

userAPICreateServiceContainer

説明

サービス コンテナを作成して、サービス要求(SR ID)を整数値として返します。


(注)  


APIC コンテナを作成するには、userAPICreateAPICContainer API を使用します。 詳細については、APIC コンテナの操作を参照してください。


パラメータ
  • groupName:ユーザが所属し、コンテナ プロビジョニング許可が許可されているグループの名前。

  • catalogName:アプリケーション コンテナ テンプレートを含むカタログの名前。

  • serviceContainerName:作成されるサービス コンテナの名前。

  • Comments:プロビジョニング操作に関するコメント。

戻り値のタイプ

整数

アクセス可能

管理者/エンド ユーザ

userAPICreateServiceContainerWithoutCatalog

説明

カタログを使用せずにサービス コンテナを作成して、サービス要求(SR ID)を整数値として返します。

パラメータ
  • containerId:サービス コンテナの ID。

  • groupId:ユーザが属しており、コンテナ プロビジョニング権限が許可されているグループの ID。

  • applicationContainerTemplateName:サービス コンテナの作成に必要なコンテナ テンプレートの名前。

戻り値のタイプ

整数(サービス要求 ID)

アクセス可能

管理者/エンド ユーザ

userAPIGetContainerId

説明

サービス コンテナの ID を返します。

パラメータ

containerName:ID を取得するサービス コンテナの名前。

戻り値のタイプ

整数

アクセス可能

管理者/エンド ユーザ

userAPIGetVNCURL

説明

仮想ネットワーク コンピューティング(VNC)が起動して動作しているかどうかを確認するために使用される VNC URL を返します。

パラメータ

vmId:仮想マシンの ID。

戻り値のタイプ

String

アクセス可能

管理者/エンド ユーザ

userAPIGetAllServiceContainers

説明

Cisco UCS Director ですべてのサービス コンテナを返します。

パラメータ

なし

戻り値のタイプ

サービス コンテナのリスト

アクセス可能

管理者/エンド ユーザ

userAPIGetServiceContainerData

説明

Cisco UCS Director でサービス コンテナのデータを返します。

パラメータ

Service container id:サービス コンテナの ID。

戻り値のタイプ

ContainerDataObjects

アクセス可能

管理者/エンド ユーザ

userAPIGetServiceContainerDetails

説明

ネットワーク サマリー、ポート マッピング、仮想マシン情報、イベント履歴などのサービス コンテナの詳細を返します。

パラメータ

container id:詳細を確認する必要があるサービス コンテナの ID。

戻り値のタイプ

APITabularReport

アクセス可能

管理者/エンド ユーザ

userAPIGetServiceContainerVirtualInfraPolicy

説明

Cisco UCS Director でインフラ ポリシーの詳細を返します。

パラメータ

infrapolicy name:詳細を確認する必要があるインフラ ポリシーの名前。

戻り値のタイプ

リスト

アクセス可能

管理者/エンド ユーザ

userAPIAddVMsServiceContainer

説明

サービス コンテナに仮想マシン(VM)を追加します。

パラメータ
  • containerId:仮想マシンを追加可能なサービス コンテナの ID。

  • ContainerVirtualMachine[ ]:サービス コンテナでプロビジョニングするコンテナ VM の配列。 VM パラメータを渡す必要があります。 Quantity と AppName が必須 VM パラメータです。ここで、AppName は VM 名です。

戻り値のタイプ

整数(サービス要求 ID)

アクセス可能

管理者/エンド ユーザ

userAPIPowerOnServiceContainer

説明

サービス コンテナ内のすべての仮想マシン(VM)の電源を 1 つずつオンにします。

Cisco UCS Director は、次のように、VM の状態に基づいてサービス コンテナを異なる色で表示します。

  • なし:すべての VM の電源がオンになっています。

  • 青色:VM の電源をオンにしている最中。


    (注)  


    コンテナが長時間青色のままになっている場合は、サービス要求 ID をクリックして、VM プロビジョニング ステータスをチェックします。


  • 橙色:すべての非アクティブなインフラストラクチャ VM の電源がオンになっており、アクティブなアプリケーション VM が起動しています。

  • 黄色:すべてのアクティブなアプリケーション VM と非アクティブなアプリケーション VM の電源がオンになっています。

  • 緑色:すべてのインフラストラクチャ VM の電源がオンになっており、すべてのアプリケーション VM が起動しています。

  • 赤色:すべてのインフラストラクチャ VM(データベースなど)の電源がオフになっており、アクティブなアプリケーション VM(ゲートウェイ(GW)VM など)がダウンしています。

  • 灰色:すべてのインフラストラクチャ VM の電源がオフになっており、すべてのアプリケーション VM がダウンしています。

パラメータ

containerId:電源をオンにするサービス コンテナの ID。

戻り値のタイプ

ブール値

アクセス可能

管理者/エンド ユーザ

userAPIPowerOffServiceContainer

説明

サービス コンテナ内のすべての VM の電源をオフにします。 すべての VM の電源がオフになっており、GW VM がダウンしている場合は、コンテナが赤色で表示されます。

パラメータ

containerId:電源をオフにするサービス コンテナの ID。

戻り値のタイプ

ブール値

アクセス可能

管理者/エンド ユーザ

userAPIDeleteServiceContainer

説明

Cisco UCS Director からサービス コンテナを削除します。

パラメータ

containerId:削除するサービス コンテナの ID。

戻り値のタイプ

整数(サービス要求 ID)

アクセス可能

管理者/エンド ユーザ

userAPICloneServiceContainer

説明

ソース サービス コンテナに基づいて新しいサービス コンテナを作成します。

パラメータ
  • sourceContainerName:複製元にするサービス コンテナの名前。

  • destinationContainerName:新しいサービス コンテナの名前。

戻り値のタイプ

整数(サービス要求 ID)

アクセス可能

管理者/エンド ユーザ

APIC コンテナの操作

userAPICreateAPICContainer

説明

APIC コンテナを作成して、サービス要求(SR)ID を整数値として返します。

パラメータ
  • groupName:ユーザが所属し、コンテナ プロビジョニング許可が許可されているグループの名前。

  • catalogName:APIC カタログの名前。

  • serviceContainerName:作成される APIC コンテナの名前。

  • Comments:プロビジョニング操作に関するコメント。

  • apicTenantName:テナントの ID。


    (注)  


    apicTenantName は APIC アカウント名とテナント名の組み合わせです。 apicTenantName の形式は apicAccountName@TenantName です。


  • APIResourceLimits apiResourceLimits:リソース制限を定義します。 APIResourceLimits には、次のパラメータが含まれます。

    • long cpu

    • long memory

    • double provisionedDiskGB

    • int physicalServerLimit


(注)  


  • APIResourceLimits が必要ない場合は、param5:null としてパラメータ 5 にヌル値を渡してください。

  • APIResourceLimits が CPU およびメモリに対してのみ必須パラメータとして要求される場合は、provisionedDiskGB および physicalServerLimit に -1 を渡してください。


サンプル
/app/api/rest?formatType=json&opName=apic:userAPICreateAPICContainer&opData=
{param0:"Ten2Dec14",param1:"ConCat",param2:"T2D1001",param3:"sample",
param4:"VNX_APIC@ Ten2Dec14",
param5:{"cpu":1,"memory":1,"provisionedDiskGB":-1,"physicalServerLimit":-1}}
戻り値のタイプ

Int ServiceRequest

アクセス可能

管理者/エンド ユーザ

サービス カテゴリの操作

userAPIGetServiceCategory

説明

Cisco UCS Director ですべてのサービス カテゴリを返します。

パラメータ

なし

戻り値のタイプ

List APIServiceCategoryPojo

アクセス可能

管理者/エンド ユーザ

userAPICreateServiceCategory

説明

Cisco UCS Director でサービス カテゴリを作成します。

パラメータ
  • apiPojo APIServiceCategoryPojo

戻り値のタイプ

ブール値

アクセス可能

管理者/エンド ユーザ

userAPICloneServiceCategory

説明

ソース サービス カテゴリに基づいて新しいサービス カテゴリを作成します。

パラメータ
  • apiPojo APIServiceCategoryPojo

戻り値のタイプ

ブール値

アクセス可能

管理者/エンド ユーザ

userAPIModifyServiceCategory

説明

Cisco UCS Director でサービス カテゴリを更新します。

パラメータ

apiPojo APIServiceCategoryPojo

戻り値のタイプ

ブール値

アクセス可能

管理者/エンド ユーザ

userAPIDeleteServiceCategory

説明

Cisco UCS Director からサービス カテゴリを削除します。

パラメータ

serviceOfferingName:削除されるサービス提供の名前。

戻り値のタイプ

ブール値

アクセス可能

管理者/エンド ユーザ

サービス要求操作

userAPISubmitServiceRequest

説明

仮想マシン(VM)プロビジョニングのサービス要求を送信します。


(注)  


Cisco UCS Director リリース 5.x 以降のリリースでは、VM のプロビジョニング用の userAPISubmitServiceRequest API は廃止されています。 代わりに、VM のプロビジョニングに userAPIProvisionRequest API を使用できます。 詳細については、UserAPIProvisionRequestを参照してください。


パラメータ
  • String catalogName:カタログの名前。

  • String vdcName:VDC の名前。

  • int durationHours:時間単位の VM のプロビジョニングの期間。 設定した期間の経過後、VM は自動的にプロビジョニング解除されます。 期間を無限に設定するには -1 を使用します。

  • long beginTime:VM のプロビジョニングを開始したい時間をスケジュールします。 たとえば、「January 1, 2014, 00:00:00 GMT」と設定します。 VM プロビジョニングを即時に開始するには 0 または -1 を使用します。

  • int qty:プロビジョニングされる VM の数。

    (注)  


    Cisco UCS Director リリース 5.x では、サポートされる数は 1 です。


  • String comments:プロビジョニングされた VM ラベルとして設定されるコメント。

戻り値のタイプ

整数(サービス 要求 ID)

アクセス可能

管理者/エンド ユーザ

userAPISubmitServiceRequestCustom

説明

入力 vmName、vCPU、およびメモリで仮想マシン(VM)のプロビジョニングに対するサービス リクエストを送信します。


(注)  


Cisco UCS Director リリース 5.x 以降のリリースでは、VM のプロビジョニング用の userAPISubmitServiceRequestCustom API は廃止されています。 代わりに、VM のプロビジョニングに userAPIProvisionRequest API を使用できます。 詳細については、UserAPIProvisionRequestを参照してください。


パラメータ
  • String catalogName:カタログの名前。

  • String vdcName:VDC の名前。

  • int durationHours:時間単位の VM のプロビジョニングの期間。 設定した期間の経過後、VM は自動的にプロビジョニング解除されます。 期間を無限に設定するには -1 を使用します。

  • long beginTime:VM のプロビジョニングを開始したい時間をスケジュールします。 たとえば、「January 1, 2014, 00:00:00 GMT」と設定します。 VM プロビジョニングを即時に開始するには 0 または -1 を使用します。

  • int qty:プロビジョニングされる VM の数。

    (注)  


    Cisco UCS Director リリース 5.x では、サポートされる数は 1 です。


  • String comments:プロビジョニングされた VM ラベルとして設定されるコメント。

  • String vmName:プロビジョニングする仮想マシンの名前。

  • double vCPU:VM に対する仮想 CPU の数。

  • double memory:MB 単位のメモリのサイズ。

戻り値のタイプ

整数(サービス 要求 ID)

アクセス可能

管理者/エンド ユーザ

userAPIGetServiceRequests

説明

ユーザ グループのすべてのサービス リクエストを返します。

パラメータ

なし。

戻り値のタイプ

APITabularReport

アクセス可能

管理者/エンド ユーザ

userAPIGetServiceRequestDetails

説明

サービス要求の詳細を返します。

パラメータ

int requestId

戻り値のタイプ

APIServiceRequestDetails:requestId、requestType、initiatingUser、groupName、requestTime、comments、provisionQuantity、provisionCatalog、provisionVDCName、provisionDurationHours、および status を含むサービス リクエスト詳細を表示します。 status の値は、Complete、Failed、In Progress、および Cancelled です。

アクセス可能

管理者/エンド ユーザ

userAPICancelServiceRequest

説明

進行中のサービス要求をキャンセルします。

パラメータ

int requestID

戻り値のタイプ

ブール値

アクセス可能

管理者/エンド ユーザ

userAPIGetServiceRequestLogEntries

説明

要求された重大度のサービス要求のログ エントリを返します。

  • 0:デバッグ

  • 1:情報

  • 2:警告

  • 3:エラー

パラメータ
  • int srId

  • int severity(0 ~ 3)

戻り値のタイプ

ServiceRequestLogEntry[ ]

アクセス可能

管理者

userAPIGetServiceRequestLogEntriesAtLevels

説明

要求された重大度のサービス要求のログ エントリを返します。

  • 0:デバッグ

  • 1:情報

  • 2:警告

  • 3:エラー

パラメータ
  • int srId

  • String severityList(カンマ区切りの重大度値)

戻り値のタイプ

ServiceRequestLogEntry[]

アクセス可能

管理者

userAPIGetServiceRequestWorkFlow

説明

サービス要求ワークフローの詳細を返します。

パラメータ

int requestId

戻り値のタイプ

APIWorkFlowStatus

ワークフローの実行ステータスの値のセットは次のとおりです。

  • EXECUTION_STATUS_NOT_STARTED = 0

  • EXECUTION_STATUS_IN_PROGRESS = 1

  • EXECUTION_STATUS_FAILED = 2

  • EXECUTION_STATUS_COMPLETED = 3

  • EXECUTION_STATUS_COMPLETED_WITH_WARNING = 4

  • EXECUTION_STATUS_CANCELLED = 5

このレポートの例については、レポートおよび JSON オブジェクト応答サンプルを参照してください。

アクセス可能

管理者/エンド ユーザ

userAPISubmitVAppServiceRequest

説明

仮想アプリケーション カタログ タイプおよび引数とともにサービス要求を送信します。

パラメータ
  • String catalogName

  • APINameValueList list

戻り値のタイプ

int(サービス 要求 ID)

アクセス可能

管理者/エンド ユーザ

userAPIGetVMsForServiceRequest

説明

指定されたサービス要求に現在関連付けられている VM を返します。

パラメータ

int requestId

戻り値のタイプ

APIVMList

このレポートの例については、レポートおよび JSON オブジェクト応答サンプルを参照してください。

アクセス可能

管理者/エンド ユーザ

userAPISubmitWorkflowServiceRequest

説明

ワークフローとともにサービス要求を送信します。 サービス要求の ID を返します。

パラメータ
  • String workflowName

  • APINameValueList list

  • int parentSRID

戻り値のタイプ

int(サービス 要求 ID)

アクセス可能

管理者/エンド ユーザ


(注)  


userAPIGetServiceRequestWorkFlow などのサービス要求に関連した操作の詳細については、ワークフローの操作を参照してください。


タスクの操作

タスクのさまざまな API 操作に関する情報は REST API ブラウザで見つけることができます。 詳細については、REST API ブラウザの使用を参照してください。


(注)  


ワークフローの操作も参照してください。


VDC の操作

userAPIGetAllVDCs

説明

ログインしたユーザ グループのすべての仮想データ センター(vDCs)を返します。 パラメータは必要ありません。

パラメータ

なし。

戻り値のタイプ

APITabularReport

このレポートの詳細については、表形式のレポートを参照してください。

アクセス可能

管理者/エンド ユーザ

userAPICreateVDC

説明

指定されたデータによって定義された vDC を作成します。

パラメータ

APIVDCDetails

この JSON オブジェクトの例については、JSON オブジェクト パラメータ タイプを参照してください。

戻り値のタイプ

ブール値(成功の場合 true)

アクセス可能

管理者


(注)  


ユーザ アカウントの操作userAPIOnboarding および サービス要求操作userAPISubmitServiceRequest も参照してください。


userAPIExportVDC

説明

Cisco UCS Director から vDC をエクスポートします。

パラメータ

vdcName:エクスポートする vDC の名前。

戻り値のタイプ

String

アクセス可能

管理者/エンド ユーザ

userAPIImportVDC

説明

Cisco UCS Director に vDC をインポートします。

パラメータ

vdcName:インポートする vDC の名前。

戻り値のタイプ

VDC

アクセス可能

管理者/エンド ユーザ

VM の操作

UserAPIProvisionRequest

説明

仮想マシン(VM)をプロビジョニングします。

パラメータ

次のパラメータは、VM のプロビジョニングで必須です。

  • String catalogName

  • String vdcName

  • String userID

次のパラメータは、VM のプロビジョニングでオプションです。

  • int durationHours

  • int beginTime

  • int quantity

  • int memoryMB

  • int diskGB

  • int cores

  • int estimatedCost

  • String comments

  • String additionalInfo

  • int chargeFrequency

  • String nicAliasName

  • String nicPortGroupName

  • boolean resourceAllocated

  • String allocatedHost

  • String allocatedDataStore

  • String allocatedResourcePool

  • String altAllocatedHost

  • String altAllocatedDataStore

  • String altAllocatedResourcePool

  • int customStartupMemory

  • int customMaxMemory

  • int customMemoryBuffer

  • boolean customMemoryConfig

  • String customStoragePolicy

  • String allocatedCluster

  • int customCpuSockets

  • int customCpuCoresPerSocket

  • String altAllocatedCluster

  • String allocatedAddnlDatastores

  • String altAllocatedAddnlDatastores

  • String altAllocatedAddnlVNICs

  • String altAllocatedAddnlVNICsIpv6

  • String actionId

  • String vmName

  • String vdcCategory

  • String windowsLicensePool

  • String templateUserId

  • String templatePassword

  • String credentialOption

  • boolean provisionAllDisk

  • boolean enableGuestCustomization

  • boolean enablePostProvisioningCustomActions

  • String workflow

  • Int vmId

  • Int vMAppChargeFrequency

  • Int activeVMAppCost

  • Int inactiveVMAppCost

  • boolean useLinkedClone

  • Int snapshotId

  • String snapshotKey

  • String newSnapshotName

  • boolean isHighlyAvailable

  • List postProvWFUserInputs

戻り値のタイプ

int(サービス要求 ID)

アクセス可能

管理者

UserAPIProvisionRequestWithPortGroup

説明
VMWare VM をプロビジョニングして、ユーザが VM のプロビジョニング中にポート グループ名を選択できるようにします。

(注)  


Cisco UCS Director リリース 5.x 以降のリリースでは、UserAPIProvisionRequestWithPortGroup API は廃止されています。 代わりに、userAPIVMWareProvisionRequest API を使用できます。 VM プロビジョニングの詳細については、userAPIVMWareProvisionRequestを参照してください。


パラメータ
  • String catalogName

  • String vdcName

  • String userID

  • int durationHours

  • int beginTime

  • int quantity

  • int memoryMB

  • int diskGB

  • int cores

  • int estimatedCost

  • String comments

  • String additionalInfo

  • int chargeFrequency

  • String nicAliasName

  • String nicPortGroupName

戻り値のタイプ

int(サービス要求 ID)

アクセス可能

管理者

userAPIGetAllVMs

説明

ログインしたユーザのすべての VM を返します。 パラメータは必要ありません。

パラメータ
  • int vmId

  • int hostid

戻り値のタイプ

APITabularReport

アクセス可能

管理者/エンド ユーザ

userAPIGetVMSummary

説明

指定された VM のサマリーを返します。

パラメータ

int vmId

戻り値のタイプ

APITabularReport

アクセス可能

管理者/エンド ユーザ

userAPIGetVMsForServiceRequest

説明

指定されたサービス要求に現在関連付けられている VM を返します。

パラメータ

int requestId

戻り値のタイプ

APIVMList

レポートの例については、レポートおよび JSON オブジェクト応答サンプルを参照してください。

アクセス可能

管理者/エンド ユーザ

userAPIGetVMActionRequests

説明

特定コンテキストの VM アクション要求を返します。

パラメータ
  • String contextName

  • String contextValue

戻り値のタイプ

APITabularReport

アクセス可能

管理者/エンド ユーザ

userAPIGetAvailableVMActions

説明

特定の VM ID で利用可能な VM アクションを返します。

パラメータ

int vmId

戻り値のタイプ

List

アクセス可能

管理者/エンド ユーザ

userAPIExecuteVMAction(汎用 VM の場合)

説明

特定の汎用 VM で指定された電源管理オプション アクションを実行します。

パラメータ
  • int vmId

  • String actionName:actionName の値には次が含まれます。

    • discardSaveState

    • pause

    • powerOff

    • powerOn

    • reboot

    • rebuildServer

    • repairVM

    • reset

    • resume

    • saveState

    • shutdownGuest

    • standby

    • suspend

  • String comments

戻り値のタイプ

String(VM アクション要求 ID)。 要求のステータス取得に使用されます。

アクセス可能

管理者/エンド ユーザ

userAPIExecuteVMAction(VMware vSphere VM の場合)

説明

特定の VMware vSphere VM で指定された電源管理オプション アクションを実行します。

パラメータ
  • int vmId

  • String actionName:actionName の値には次が含まれます。
    • addVMvNICs

    • assignVMToVDC

    • configureVMVNC

    • convertVMToTemplate

    • createVMDisks

    • customVMStackView

    • deleteVMDisks

    • deleteVMvNICs

    • destroyVM

    • diskResize

    • enableVMRCConsole

    • migrateVM

    • moveVMToVdc

    • powerOff

    • powerOn

    • privateCloudVMClone

    • reboot

    • reconfigure

    • reset

    • resynchVM

    • saveVMAsTemplate

    • shutdownGuest

    • standby

    • suspend

    • testVMVNCConnection

    • vmMountISOImageAsCDROM

    • vmwareVMInventory

  • String comments

戻り値のタイプ

String(VM アクション要求 ID)。 要求のステータス取得に使用されます。

アクセス可能

管理者/エンド ユーザ

userAPIExecuteVMAction(Microsoft Hyper-V VM の場合)

説明

特定の Microsoft Hyper-V VM で指定された電源管理オプション アクションを実行します。

パラメータ
  • int vmId

  • String actionName:actionName の値には次が含まれます。
    • addHyperVvNics

    • customVMStackView

    • deleteHyperVvNic

    • destroyVM

    • discardSaveState

    • hypervAddVMDisk

    • hypervDiskResize

    • hypervMarkGoldenSnapshot

    • hyperVReconfigure

    • hypervRemoveVMDisk

    • hyperVRepair

    • hypervSnapshotCreate

    • hypervSnapshotDelete

    • hypervSnapshotDeleteAll

    • hypervSnapshotRevert

    • pause

    • powerOff

    • powerOn

    • reset

    • resume

    • saveState

    • shutdownGuest

    • vmwareVMInventory

  • String comments

戻り値のタイプ

整数(サービス要求 ID)

アクセス可能

管理者/エンド ユーザ

userAPIHypervVMProvisioningWithVMNetwork

説明

ネットワーク グループと関連付けられた Hyper-V VM をプロビジョニングします。

パラメータ
  • String catalogName

  • String vdcName

  • String userID

  • List<ApiHypervNetworks> hypervNetworkList

    • String nicAliasName

    • String vmNetworkName:VM ネットワークの名前。


      (注)  


      vmNetworkName の形式は次のとおりです。

      accountName@vmnetworkname@vmsubnetname@vlanid@ismacspoofingenabled

      @isdhcp@accountName;ippoolName;ippoolId@portclassification

      値の一部を使用できない場合、使用できない値を次の例に示すように空白で置き換えてください。
      hyperv196@Vlan_VMNetwork2@ @ @false@true@ @ :
      
      hyperv196@Vlan_VMNetwork1@ @ @false@false@hyperv196;Vlan_IpPool1
      ;9e58366c-675d-4e1b-845e-b5f7eeaff107@ :
      ippoolid を取得するには、メニュー バーで [仮想] > [ネットワーク] を選択し、[Hyperv] アカウントを選択して [静的IPアドレスのプール] タブをクリックします。

  • String allocatedHost

  • String allocatedDataStore

  • String altAllocatedHost

  • String altAllocatedDataStore

  • int cores

  • int memoryMB

  • boolean customMemoryConfig

  • int customStartupMemory

  • int customMaxMemory

  • int customMemoryBuffer

  • int diskGB

  • int estimatedCost

  • String comments

  • String additionalInfo

  • String vmName

  • boolean isHighlyAvailabilityEnabled

戻り値のタイプ

int(サービス 要求 ID)

アクセス可能

管理者/エンド ユーザ

userAPIReconfigureVM

説明

指定された VM をリサイズします。

パラメータ
  • int vmId

  • int memorySizeInMb

  • int numVCPUS:仮想マシン用仮想 CPU の数

  • String comments

戻り値のタイプ

String

アクセス可能

管理者/エンド ユーザ

userAPIGetVMActionStatus

説明

特定の VM アクション要求の VM アクション ステータスを返します。

パラメータ

String requestactionId

戻り値のタイプ

APIVMActionStatus

アクセス可能

管理者/エンド ユーザ

userAPISetVMProperties

説明

VM にユーザ ラベルを割り当てます。

パラメータ
  • int vmId

  • String userLabel

戻り値のタイプ

ブール値(成功の場合 true)

アクセス可能

管理者/エンド ユーザ

userAPIGetVMAccessCredentials

説明

VM アクセス クレデンシャルを返します。

パラメータ

int vmId

戻り値のタイプ

APIVMAccess

アクセス可能

管理者/エンド ユーザ

userAPIGetVMSnapshotDetails

説明

VM スナップショットの詳細を返します。

パラメータ

int vmId

戻り値のタイプ

APITabularReport

アクセス可能

管理者/エンド ユーザ/エンド ユーザ

userAPICreateVMSnapshot

説明

提供されたパラメータに基づいてスナップショットを作成します。 スナップショットは VM 上の既存データのバックアップです。 後で VM に障害が発生した場合、エンド ユーザはスナップショットに復元することができます。

パラメータ
  • int vmId

  • String name

  • String descr

  • boolean isMemory:値を true に設定すると、メモリのスナップショットを作成

  • boolean isQuiesce:値を true に設定すると、ファイル システムを休止

戻り値のタイプ

String(VM アクション要求 ID)

アクセス可能

管理者/エンド ユーザ

userAPICheckContextActionStatus

説明

VM アクションのステータス メッセージの詳細を返します。

パラメータ

statusId:VM アクションを実行するスレッドから更新されるデータベースからステータスをチェックするために使用される文字列の ID 値です。

戻り値のタイプ

String

API namespace

genericvm

アクセス可能

管理者/エンド ユーザ

userAPIDeleteCatalogItem

説明

VM をプロビジョニングするために作成されたカタログを削除します。

パラメータ

catalogItemName:削除する必要のあるカタログ項目の名前。

戻り値のタイプ

ブール値

アクセス可能

管理者/エンド ユーザ

userAPIVMWareProvisionRequest

説明

テンプレートを使用して VMware VM をプロビジョニングし、サービス要求(SR)ID を整数値として返します。

パラメータ
  • String catalogName:カタログの名前。

  • String vdcName:vDC の名前。

  • String vmName:プロビジョニングする VM の名前。

  • String comment:VM ラベルに設定されるコメント。

  • double vCpus:CPU の数。

  • double memory:GB 単位のメモリのサイズ。

  • String datastores:VM ディスクの数。

  • String opNicPortGroup:VM ネットワーク。

戻り値のタイプ

整数(サービス要求 ID)

アクセス可能

管理者/エンド ユーザ

userAPIVMWareCloneVMProvisionRequest

説明

VMware VM を複製して、サービス要求(SR)ID を整数値として返します。

パラメータ
  • String vmID:複製する必要のある VM の ID。

  • String vdcName:vDC の名前。

  • String vmName:プロビジョニングする必要のある VM の名前。

  • boolean useLinkedClone:リンク付き複製機能を使用する場合は true に設定します。

  • String snapshotKey:新しいスナップショットを作成せずに使用する必要のある Snapshotkey。

  • String snapshotName:新しいスナップショットの名前。 このパラメータは、新しいスナップショットの作成に使用されます。

  • String comment:VM ラベルに設定されるコメント。

  • double vCpus:CPU の数。

  • double memory:GB 単位のメモリのサイズ。

  • String chargeFrequency:充電の頻度。 このパラメータは、Hourly または Monthly の値を受け入れます。

  • String datastores:VM ディスクの数。

  • String opNicPortGroup:VM ネットワーク。

  • String credentials:このパラメータは、"Do not share"、"Share after password reset"、または "Share template credentials" の値を受け入れます。

  • String userid

  • String password

  • boolean provisionDiskinSingleDatastore:単一のデータストアにすべてのディスクをプロビジョニングする場合は true に設定します。

  • String vmappChargeFrequency:vmapp 充電の頻度。 このパラメータは、Hourly または Monthly の値を受け入れます。

  • double activeVMCost

  • double inactiveVMCost

戻り値のタイプ

整数(サービス要求 ID)

アクセス可能

管理者/エンド ユーザ

userAPIVMWareMoveVMProvisionRequest

説明

VM を vDC に移動して、サービス要求(SR)ID を整数値として返します。

パラメータ
  • String vmID:移動する必要のある VM の ID。

  • String vdcName:vDC の名前。

  • String credentials:このパラメータは、"Do not share"、"Share after password reset"、または "Share template credentials" の値を受け入れます。

  • String userid

  • String password

  • boolean provisionDiskinSingleDatastore:単一のデータストアにすべてのディスクをプロビジョニングする場合は true に設定します。

  • String vmappChargeFrequency:vmapp 充電の頻度。 このパラメータは、Hourly または Monthly の値を受け入れます。

  • double activeVMCost

  • double inactiveVMCost

  • String comment:VM ラベルに設定されるコメント。

  • double vCpus:CPU の数。

  • double memory:GB 単位のメモリのサイズ。

  • String datastores:VM ディスクの数。

  • String opNicPortGroup:VM ネットワーク。

戻り値のタイプ

整数(サービス要求 ID)

アクセス可能

管理者/エンド ユーザ


(注)  


オプション入力を設定する場合は、空の文字列を渡します。 sample をダミー文字列として渡さないでください。


ワークフローの操作

userAPIGetWorkflows

説明

特定のフォルダ名で使用できるワークフローを返します。


(注)  


Cisco UCS Director リリース 5.x 以降のリリースでは、userAPIGetWorkflows API 応答に表示される [noOfInputFields] フィールドは廃止されています。 userAPIGetWorkflowInputs API を使用してワークフローのユーザ入力の詳細情報を取得できます。


パラメータ

String folderName

戻り値のタイプ

CustomActionDefinition[ ]

アクセス可能

管理者

userAPIGetWorkflowStatus

説明

ワークフローの実行ステータス コードを返します。

パラメータ

int srId

戻り値のタイプ

int

ワークフローの実行ステータスの値のセットは次のとおりです。

  • EXECUTION_STATUS_NOT_STARTED = 0

  • EXECUTION_STATUS_IN_PROGRESS = 1

  • EXECUTION_STATUS_FAILED = 2

  • EXECUTION_STATUS_COMPLETED = 3

  • EXECUTION_STATUS_COMPLETED_WITH_WARNING = 4

  • EXECUTION_STATUS_CANCELLED = 5

  • EXECUTION_STATUS_PAUSED = 6

  • EXECUTION_STATUS_SKIPPED = 7

アクセス可能

管理者

userAPIGetWorkflowInputs

説明

特定のワークフローの名前のワークフロー ユーザ入力詳細を返します。

パラメータ

String workflowName:ワークフローの名前。

戻り値のタイプ

次のプロパティとともに APINameValueList を返します。

  • isOptional:ワークフロー入力フィールドが必須として設定されている場合は true を表示します。

  • inputFieldType:このフィールドの値は、ワークフロー入力フィールドのフォーム フィールド タイプを示します。 フィールド タイプには、text、number、table、boolean、label、embedded-lov、embedded-lov-radio、password、date、time、date-and-time、html-text、multi-select-list、label-with-space、button-panel、popup-table、embedded-lov-combo、および file-upload があります。

アクセス可能

管理者

userAPIValidateWorkFlow

説明

ワークフローを検証し、結果を返します。

パラメータ

String workflowName

戻り値のタイプ

APIWFValidationResult

アクセス可能

管理者

userAPISubmitWorkflowServiceRequest

説明

ワークフローとともにサービス要求を送信します。 サービス要求の ID を返します。

パラメータ
  • String workflowName

  • APINameValueList list

  • int parentSRID

戻り値のタイプ

int(サービス リクエスト ID)

アクセス可能

管理者/エンド ユーザ

userAPIRollbackWorkflow

説明

指定されたサービス要求 ID をロールバックします。

パラメータ

int srId

戻り値のタイプ

int(サービス要求 ID)

アクセス可能

管理者

userAPIExportWorkflows

説明

指定されたワークフローをエクスポートします。

パラメータ

String workflowNames

戻り値のタイプ

APICustomWorkflowDefinitionList

アクセス可能

管理者/エンド ユーザ

userAPIImportWorkflows

説明

システムにワークフローをインポートします。

パラメータ

APIWFExport export

戻り値のタイプ

ブール値(成功の場合 true)

アクセス可能

管理者/エンド ユーザ

アクティビティの操作

userAPIGetActivity

説明

Cisco UCS Director にすべてのアクティビティを戻します。

パラメータ
なし
戻り値のタイプ

List APIActivityFormPojo

アクセス可能

管理者/エンド ユーザ

userAPICreateActivity

説明

Cisco UCS Director にアクティビティを作成します。

パラメータ
  • apiPojo APIActivityFormPojo

戻り値のタイプ

ブール値

アクセス可能

管理者/エンド ユーザ

userAPICloneActivity

説明

ソース アクティビティに基づいて新しいアクティビティを作成します。

パラメータ
  • apiPojo APIActivityFormPojo

戻り値のタイプ

ブール値

アクセス可能

管理者/エンド ユーザ

userAPIModifyActivity

説明

Cisco UCS Director でアクティビティを更新します。

パラメータ

apiPojo APIActivityFormPojo

戻り値のタイプ

ブール値

アクセス可能

管理者/エンド ユーザ

userAPIDeleteActivity

説明

Cisco UCS Director からアクティビティを削除します。

パラメータ

apiPojo APIActivityFormPojo

戻り値のタイプ

ブール値

アクセス可能

管理者/エンド ユーザ

タグの操作

userAPIGetTagLibrary

説明

タグ ライブラリから使用可能なタグを返します。

パラメータ

なし

戻り値のタイプ

List APIResourceTag

アクセス可能

管理者/エンド ユーザ

userAPICreateTag

説明

Cisco UCS Director にタグを作成します。

パラメータ
  • apiPojo APIResourceTag

戻り値のタイプ

ブール値

アクセス可能

管理者/エンド ユーザ

userAPICloneTag

説明

ソース タグに基づいて新しいタグを作成します。

パラメータ
  • apiPojo APIResourceTag

戻り値のタイプ

ブール値

アクセス可能

管理者/エンド ユーザ

userAPIModifyTag

説明

Cisco UCS Director でタグを更新します。

パラメータ

apiPojo APIResourceTag

戻り値のタイプ

ブール値

アクセス可能

管理者/エンド ユーザ

userAPIDeleteTag

説明

Cisco UCS Director からタグを削除します。

パラメータ

String tagName:削除するタグの名前。

戻り値のタイプ

ブール値

アクセス可能

管理者/エンド ユーザ

リソース グループの操作

userAPIgetResourceGroups

説明

Cisco UCS Director ですべてのリソース グループを返します。

パラメータ

なし

戻り値のタイプ

List APIResourceGroupMainForm

アクセス可能

管理者/エンド ユーザ

userAPICreateResourceGroup

説明

Cisco UCS Director でリソース グループを作成します。

パラメータ
  • apiPojo APIResourceGroupMainForm

戻り値のタイプ

ブール値

アクセス可能

管理者/エンド ユーザ

userAPIModifyResourceGroup

説明

Cisco UCS Director でリソース グループを更新します。

パラメータ

apiPojo APIResourceGroupMainForm

戻り値のタイプ

ブール値

アクセス可能

管理者/エンド ユーザ

userAPIDeleteResourceGroup

説明

Cisco UCS Director からリソース グループを削除します。

パラメータ
  • String rgName:削除するリソース グループの名前。

戻り値のタイプ

ブール値

アクセス可能

管理者/エンド ユーザ

アプリケーション プロファイルの操作

userAPIGetApplicationProfile

説明

すべてのアプリケーション プロファイルを返します。

パラメータ

なし

戻り値のタイプ

List APIApplicationProfileConfigTemplate

アクセス可能

管理者/エンド ユーザ

userAPICreateApplicationProfile

説明

Cisco UCS Director にアプリケーション プロファイルを作成します。

パラメータ
  • apiPojo APIApplicationProfileConfigTemplate

戻り値のタイプ

ブール値

アクセス可能

管理者/エンド ユーザ

userAPIModifyApplicationProfile

説明

Cisco UCS Director でアプリケーション プロファイルを更新します。

パラメータ

apiPojo APIApplicationProfileConfigTemplate

戻り値のタイプ

ブール値

アクセス可能

管理者/エンド ユーザ

userAPIDeleteApplicationProfile

説明

Cisco UCS Director からアプリケーション プロファイルを削除します。

パラメータ
  • String appprofileName

  • String soff

戻り値のタイプ

ブール値

アクセス可能

管理者/エンド ユーザ

テナント プロファイルの操作

userAPIGetTenantProfile

説明

Cisco UCS Director でテナント プロファイルのリストを返します。

パラメータ

なし

戻り値のタイプ

List APITenantProfilePojo

アクセス可能

管理者/エンド ユーザ

userAPICreateTenantProfile

説明

Cisco UCS Director でテナントのプロファイルを作成します。

パラメータ
  • apiPojo APITenantProfilePojo

戻り値のタイプ

ブール値

アクセス可能

管理者/エンド ユーザ

userAPICloneTenantProfile

説明

ソース テナントのプロファイルに基づいて新しいテナントのプロファイルを作成します。

パラメータ
  • apiPojo APITenantProfilePojo

戻り値のタイプ

ブール値

アクセス可能

管理者/エンド ユーザ

userAPIModifyTenantProfile

説明

Cisco UCS Director でテナント プロファイルを更新します。

パラメータ

apiPojo APITenantProfilePojo

戻り値のタイプ

ブール値

アクセス可能

管理者/エンド ユーザ

userAPIDeleteTenantProfile

説明

Cisco UCS Director からテナント プロファイルを削除します。

パラメータ

String tenantName:削除するテナント プロファイルの名前。

戻り値のタイプ

ブール値

アクセス可能

管理者/エンド ユーザ

テナント オンボーディングの操作

userAPIInitiateTenantOnboarding

説明

テナントのオンボードのためのプロセスを開始します。

パラメータ

apiPojo APITenantOnboarding

戻り値のタイプ

文字列

アクセス可能

管理者/エンド ユーザ

スクリプトの操作

userAPIExecuteVIXScript

説明

スクリプト コマンドを通してゲスト オペレーティング システム(OS)内にパラメータを設定するために、ゲストのオペレーティング OS 内でコマンドを実行可能にします。

パラメータ
  • int vmId:VIX スクリプトを実行する仮想マシン(VM)の ID。

  • String username:VM のアクセスに使用されるユーザ名。

  • String password:VM のアクセスのために設定されるパスワード。

  • String script:VM で実行する必要がある VIX スクリプト コマンド。

戻り値のタイプ

整数(サービス要求 ID)

アクセス可能

管理者/エンド ユーザ