前のトピック: SetSoftwareJobContainer2次のトピック: ソフトウェア グループ

Web サービス リファレンス › メソッド › ソフトウェア › 優先度、再インストール、およびポリシーの拡張 › SetSoftwareJobContainerPriority

SetSoftwareJobContainerPriority

これは、ソフトウェア ジョブ コンテナの優先度を設定するメソッドです。

パラメータ

xsd:string sessionId (m)

Web サービスへのログインによって取得されたセッション ID を指定します。

xsd:string softwareJobContainerId (m)

設定する優先度を含むソフトウェア ジョブ コンテナの UUID です。

xsd:long priority（必須）

1（最高）から 10（最低）までの範囲になります。

戻り値

戻り値を露出しない void メソッドです。

特記事項

なし

OSIM

DSM Web サービスは、OSIM 機能に関する後のセクションに示されているメソッドを使用します。

OSIM Web サービスの使用に関する考慮事項

OSIM Web サービスを使用する場合は、以下の要因を考慮します。

CreateOSIMComputer

CreateOSIMComputer メソッドは、OS 展開用の新しいコンピュータを作成するために使用されます。

パラメータ

xsd:string sessionId

Web サービスへのログインによって取得されたセッション ID を指定します。

dsm:createOSIMComputerProperties

コンピュータを作成するためのプロパティを定義します。

戻り値

xsd:string computerId

コンピュータが作成されると、UUID を返します。

特記事項

この Web サービスでは新しいコンピュータが事前登録されます。

RegisterComputerWithOSIM

RegisterComputerWithOSIM メソッドは、OSIM 展開用の CA ITCM コンピュータを登録するために使用されます。

パラメータ

xsd:string sessionId

Web サービスへのログインによって取得されたセッション ID を指定します。

xsd:string OSIMTargetID

コンピュータの UUID を指定します。

xsd:string osimImage

OSIM イメージを指定します。

戻り値

なし

特記事項

なし

RegisterComputerWithOSIMByName

RegisterComputerWithOSIMByName メソッドは、ホスト名を使用して OSIM 展開用の CA ITCM コンピュータを登録するために使用されます。

パラメータ

xsd:string sessionId

DSM Web サービス ログインから取得されたセッション ID を指定します。

xsd:string osimTargetName

ターゲット コンピュータのホスト名を指定します。

xsd:string osimImage

OSIM イメージを指定します。

戻り値

なし

特記事項

なし

ActivateOSInstallation

ActivateOSInstallation は、計画されたインストール リクエストの実行を有効にするメソッドです。

パラメータ

xsd:string sessionId

Web サービスへのログインによって取得されたセッション ID を指定します。

xsd:string OSIMTargetMACAddress

ターゲット コンピュータの MAC アドレスを指定します。

xsd:boolean bWakeOnLAN

ブート サーバがターゲット コンピュータに Wake On LAN を送信する必要があることを指定します。

xsd:boolean bReboot

ブート サーバがターゲット コンピュータに再起動リクエストを送信する必要があることを指定します。

注： ターゲット コンピュータが再起動するには、ソフトウェア配信エージェントをインストールする必要があります。

xsd:boolean bWaitForBootServer

ターゲット コンピュータがブート サーバを割り当てられるまで実行を待機する必要があることを指定します。

dsm:WS_OSIM_DEPLOY bWaitForImages

マネージャが OS イメージを待機する必要があるかどうかを指定します。

dsm:DateTime activateTime

インストール日時を指定します。 開始日が指定されていない場合、インストールはすぐに開始されます。

戻り値

なし

特記事項

なし

ActivateOSInstallationByName

ActivateOSInstallationByName は、ホスト名を使用して計画されたインストール リクエストの実行を有効にするメソッドです。

パラメータ

xsd:string sessionId

Web サービスへのログインによって取得されたセッション ID を指定します。

xsd:String OSIMTargetComputerLabel

ターゲット コンピュータのコンピュータ ラベルを指定します。

xsd:boolean bWakeOnLAN

ブート サーバがターゲット コンピュータに Wake On LAN を送信するように指定します。

xsd:boolean bReboot

ブート サーバがターゲット コンピュータに再起動リクエストを送信するように指定します。

注： ターゲット コンピュータが再起動するには、ソフトウェア配信エージェントをインストールする必要があります。

xsd:boolean bWaitForBootServer

ターゲット コンピュータがブート サーバを割り当てられるまで実行を待機する必要があることを指定します。

dsm:WS_OSIM_DEPLOY bWaitForImages

マネージャが OS イメージを待機する必要があるかどうかを指定します。

dsm:DateTime activateTime

インストール日時を指定します。 開始日が指定されていない場合、インストールはすぐに開始されます。

戻り値

なし

特記事項

なし

CancelOSInstallation

CancelOSInstallation は、OS のインストールをキャンセルするメソッドです。

パラメータ

xsd:string sessionId

DSM Web サービス ログインから取得されたセッション ID を指定します。

xsd:string OSIMTargetMACAddress

ターゲット コンピュータの MAC アドレスを指定します。

xsd:bool bForceCancel

OS インストールがキャンセルされる必要があることを指定します。

注： インストール中の状態の OS インストール ジョブはキャンセルできません。

戻り値

なし

特記事項

なし

CancelOSInstallationByName

CancelOSInstallationByName は、指定されたホスト名の OS インストールをキャンセルするメソッドです。

パラメータ

xsd:string sessionId

DSM Web サービス ログインから取得されたセッション ID を指定します。

xsd:String OSIMTargetComputerLabel

ターゲット コンピュータのコンピュータ ラベルを指定します。

xsd:bool bForceCancel

OS インストールがキャンセルされる必要があることを指定します。

注： インストール中の状態の OS インストール ジョブはキャンセルできません。

戻り値

なし

特記事項

なし

ReActivateOSInstallation

ReActivateOSInstallation は、キャンセルされたか失敗した OS インストールを再度有効にするメソッドです。

パラメータ

xsd:string sessionId

Web サービスへのログインによって取得されたセッション ID を指定します。

xsd:string OSIMTargetMACAddress

ターゲット コンピュータの MAC アドレスを指定します。

xsd:boolean bWakeOnLAN

ブート サーバがターゲット コンピュータに Wake On LAN を送信する必要があることを指定します。

xsd:boolean wakeOnLANSupplied

bWakeOnLAN 値が指定されているかどうかを指定します。

xsd:boolean bReboot

ブート サーバがターゲット コンピュータに再起動リクエストを送信する必要があることを指定します。

注： ターゲット コンピュータが再起動するには、ソフトウェア配信エージェントをインストールする必要があります。

xsd: boolean rebootSupplied

bReboot 値が指定されているかどうかを指定します。

xsd:boolean bWaitForBootServer

ターゲット コンピュータがブート サーバを割り当てられるまで実行を待機する必要があることを指定します。

xsd:boolean waitForBootServerSupplied

bWaitForBootServer 値が指定されているかどうかを指定します。

dsm:WS_OSIM_DEPLOY bWaitForImages

マネージャが OS イメージを待機する必要があるかどうかを指定します。

xsd:boolean waitForImagesSupplied

bWaitForImages 値が指定されているかどうかを指定します。

dsm:DateTime activateTime

インストール日時を指定します。 開始日が指定されていない場合、インストールはすぐに開始されます。

戻り値

なし

特記事項

なし

ReActivateOSInstallationByName

ReActivateOSInstallationByName は、指定されたターゲット コンピュータのキャンセルされたか失敗した OS インストールを再度有効にするメソッドです。

パラメータ

xsd:string sessionId

Web サービスへのログインによって取得されたセッション ID を指定します。

xsd:String OSIMTargetComputerLabel

ターゲット コンピュータのコンピュータ ラベルを指定します。

xsd:boolean bWakeOnLAN

ブート サーバがターゲット コンピュータに Wake On LAN を送信するように指定します。

xsd:boolean wakeOnLANSupplied

bWakeOnLAN 値が指定されているかどうかを指定します。

xsd:boolean bReboot

ブート サーバがターゲット コンピュータに再起動リクエストを送信するように指定します。

注： ターゲット コンピュータが再起動するには、ソフトウェア配信エージェントをインストールする必要があります。

xsd: boolean rebootSupplied

bReboot 値が指定されているかどうかを指定します。

xsd:boolean bWaitForBootServer

ターゲット コンピュータがブート サーバを割り当てられるまで実行を待機する必要があることを指定します。

xsd:boolean waitForBootServerSupplied

bWaitForBootServer 値が指定されているかどうかを指定します。

dsm:WS_OSIM_DEPLOY bWaitForImages

マネージャが OS イメージを待機する必要があるかどうかを指定します。

xsd:boolean waitForImagesSupplied

bWaitForImages 値が指定されているかどうかを指定します。

dsm:DateTime activateTime

インストール日時を指定します。 開始日が指定されていない場合、インストールはすぐに開始されます。

戻り値

なし

特記事項

なし

ReInstallOS

ReInstallOS は、現在の OS を再インストールするメソッドです。

パラメータ

xsd:string sessionId

Web サービスへのログインによって取得されたセッション ID を指定します。

xsd:string OSIMTargetMACAddress

ターゲット コンピュータの MAC アドレスを指定します。

xsd:boolean bWakeOnLAN

ブート サーバがターゲット コンピュータに Wake On LAN を送信する必要があることを指定します。

xsd:boolean wakeOnLANSupplied

bWakeOnLAN 値が指定されているかどうかを指定します。

xsd:boolean bReboot

ブート サーバがターゲット コンピュータに再起動リクエストを送信する必要があることを指定します。

注： ターゲット コンピュータが再起動するには、ソフトウェア配信エージェントをインストールする必要があります。

xsd: boolean rebootSupplied

bReboot 値が指定されているかどうかを指定します。

xsd:boolean bWaitForBootServer

ターゲット コンピュータがブート サーバを割り当てられるまで実行を待機する必要があることを指定します。

xsd:boolean waitForBootServerSupplied

bWaitForBootServer 値が指定されているかどうかを指定します。

dsm:WS_OSIM_DEPLOY bWaitForImages

マネージャが OS イメージを待機する必要があるかどうかを指定します。

xsd:boolean waitForImagesSupplied

bWaitForImages 値が指定されているかどうかを指定します。

dsm:DateTime activateTime

インストール日時を指定します。 開始日が指定されていない場合、インストールはすぐに開始されます。

戻り値

なし

特記事項

なし

ReInstallOSByName

ReInstallOSByName は、ターゲット コンピュータのホスト名によって現在の OS を再インストールするメソッドです。

パラメータ

xsd:string sessionId

Web サービスへのログインによって取得されたセッション ID を指定します。

xsd:String OSIMTargetComputerLabel

ターゲット コンピュータのコンピュータ ラベルを指定します。

xsd:boolean bWakeOnLAN

ブート サーバがターゲット コンピュータに Wake On LAN を送信するように指定します。

xsd:boolean wakeOnLANSupplied

bWakeOnLAN 値が指定されているかどうかを指定します。

xsd:boolean bReboot

ブート サーバがターゲット コンピュータに再起動リクエストを送信するように指定します。

注： ターゲット コンピュータが再起動するには、ソフトウェア配信エージェントをインストールする必要があります。

xsd: boolean rebootSupplied

bReboot 値が指定されているかどうかを指定します。

xsd:boolean bWaitForBootServer

ターゲット コンピュータがブート サーバを割り当てられるまで実行を待機する必要があることを指定します。

xsd:boolean waitForBootServerSupplied

bWaitForBootServer 値が指定されているかどうかを指定します。

dsm:WS_OSIM_DEPLOY bWaitForImages

マネージャが OS イメージを待機する必要があるかどうかを指定します。

xsd:boolean waitForImagesSupplied

bWaitForImages 値が指定されているかどうかを指定します。

dsm:DateTime activateTime

インストール日時を指定します。 開始日が指定されていない場合、インストールはすぐに開始されます。

戻り値

なし

特記事項

なし

DeregisterOSIMComputer

DeRegisterOSIMComputer は、ターゲット コンピュータの MAC アドレスを使用して、OSIM 管理対象システムからターゲット コンピュータを削除するメソッドです。

注： このメソッドは CA ITCM MDB からターゲット コンピュータを削除しません。 ネットワークからコンピュータを削除せず、PXE を無効にしない場合、コンピュータは起動中に OSIM に再登録されます。

パラメータ

xsd:string sessionId

DSM Web サービス ログインから取得されたセッション ID を指定します。

xsd:string OSIMTargetMACAddress

OSIM コンピュータの MAC アドレスを指定します。

戻り値

なし

特記事項

なし

DeRegisterOSIMComputerByName

DeRegisterOSIMComputerByName は、ターゲット コンピュータのホスト名を使用して、OSIM 管理対象システムからターゲット コンピュータを削除するメソッドです。

注： このメソッドは CA ITCM MDB からターゲット コンピュータを削除しません。 ネットワークからコンピュータを削除せず、PXE を無効にしない場合、コンピュータは起動中に OSIM に再登録されます。

パラメータ

xsd:string sessionId

DSM Web サービス ログインから取得されたセッション ID を指定します。

xsd:string osimTargetLabel

ターゲット コンピュータのコンピュータ ラベルを指定します。

戻り値

なし

特記事項

なし

GetUnnamedOSIMRegisteredComputers

GetUnnamedOSIMRegisteredComputers は、検出されたハードウェアではなく、ネットワークから OSIM に登録されるコンピュータのリストを取得するメソッドです。 これらのコンピュータは、ホスト名ではなく MAC アドレスを表示します。

パラメータ

xsd:string sessionId

DSM Web サービス ログインから取得されたセッション ID を指定します。

戻り値

dsm:ArrayOfOSIMTargetProperties

OSIM ターゲット プロパティの配列です。OSIM 登録されている各コンピュータに 1 つが対応します。 配列には、ターゲット コンピュータの以下のプロパティが含まれます。

特記事項

なし

GetUnmanagedOSIMRegisteredComputers

GetUnmanagedOSIMRegisteredComputers は、管理対象外状態であるコンピュータのリストを取得します。

パラメータ

xsd:string sessionId

DSM Web サービス ログインから取得されたセッション ID を指定します。

戻り値

dsm:ArrayOfOSIMTargetProperties

OSIM ターゲット プロパティの配列です。管理対象外の各コンピュータに 1 つが対応します。 配列には、ターゲット コンピュータの以下のプロパティが含まれます。

特記事項

なし

GetOSInstallationRequest

GetOSInstallationRequest メソッドは、ターゲット コンピュータのインストール リクエストの詳細を取得するために使用されます。

パラメータ

xsd:string sessionId

DSM Web サービス ログインから取得されたセッション ID を指定します。

xsd:string OSIMTargetMACAddress

ターゲット コンピュータの MAC アドレスを指定します。

dsm:WS_OSIM_CONF_TYPE

インストール リクエストのタイプを指定します。

xsd:bool confTypeSupplied

設定タイプが指定されているかどうかを指定します。

戻り値

dsm:ArrayOfOSIMProperties

OSIM インストール リクエスト属性のリストを表示します。 配列には、ターゲット コンピュータの以下のプロパティが含まれます。

以下の詳細はスケジュールされたリクエストにのみ使用可能です。

特記事項

なし。

GetOSInstallationRequestByName

GetOSInstallationRequestByName メソッドは、ホスト名を使用してターゲット コンピュータのインストール リクエストの詳細を取得するために使用されます。

パラメータ

xsd:string sessionId

DSM Web サービス ログインから取得されたセッション ID を指定します。

xsd:String OSIMTargetLabel

ターゲット コンピュータのコンピュータ ラベルを指定します。

dsm:WS_OSIM_CONF_TYPE

インストール リクエストのタイプを指定します。

xsd:bool confTypeSupplied

設定タイプが指定されているかどうかを指定します。

戻り値

dsm:ArrayOfOSIMProperties

OSIM インストール リクエスト属性のリストを表示します。配列には、ターゲット コンピュータの以下のプロパティが含まれます。

以下の詳細はスケジュールされたリクエストにのみ使用可能です。

特記事項

なし。

GetInstallationRequestList

GetInstallationRequestList メソッドは、ターゲット コンピュータのインストール リクエストのリストをリクエストするために使用されます。

パラメータ

xsd:string sessionId

DSM Web サービス ログインから取得されたセッション ID を指定します。

xsd:string OSIMTargetMACAddress

ターゲット コンピュータの MAC アドレスを指定します。

戻り値

dsm:ArrayOfOSIMTargetInstallationRequestsProperties

ターゲット コンピュータのインストール リクエストを表示します。 配列には、インストール リクエストごとに 1 つのインストール リクエスト プロパティが含まれます。

以下の詳細はスケジュールされたリクエストにのみ使用可能です。

特記事項

なし。

GetInstallationRequestListByName

GetInstallationRequestListByName メソッドは、ホスト名を使用してターゲット コンピュータのインストール リクエストのリストを取得するために使用されます。

パラメータ

xsd:string sessionId

DSM Web サービス ログインから取得されたセッション ID を指定します。

xsd:String OSIMTargetLabel

ターゲット コンピュータのコンピュータ ラベルを指定します。

戻り値

dsm:ArrayOfOSIMTargetInstallationRequestsProperties

ターゲット コンピュータのインストール リクエストを表示します。 配列には、ターゲット コンピュータのインストール リクエスト プロパティが含まれます。

以下の詳細はスケジュールされたリクエストにのみ使用可能です。

特記事項

なし

DeleteOSInstallationRequest

DeleteOSInstallationRequest メソッドは、OSIM ターゲット コンピュータの計画されたかスケジュールされたインストールを削除するために使用されます。

パラメータ

xsd:string sessionId

DSM Web サービス ログインから取得されたセッション ID を指定します。

xsd:string OSIMTargetMACAddress

ターゲット コンピュータの MAC アドレスを指定します。

dsm:WS_OSIM_IR_STATUS irStatus

OSIM コンピュータのインストール リクエスト ステータスを指定します。

戻り値

なし

特記事項

なし

DeleteOSInstallationRequestByName

DeleteOSInstallationRequestByName メソッドは、ホスト名を使用して OSIM ターゲット コンピュータの計画されたかスケジュールされたインストールを削除するために使用されます。

パラメータ

xsd:string sessionId

DSM Web サービス ログインから取得されたセッション ID を指定します。

xsd:String OSIMTargetLabel

ターゲット コンピュータのコンピュータ ラベルを指定します。

dsm:WS_OSIM_IR_STATUS irStatus

OSIM コンピュータのインストール リクエスト ステータスを指定します。

戻り値

なし

特記事項

なし

SetOSIMComputerMACAddressByName

SetOSIMComputerMACAddressByName メソッドは、ターゲット コンピュータのホスト名を使用して MAC アドレス情報およびインストール リクエストを変更するために使用されます。

注： このメソッドを適用できるのは、スケジュールされたリクエストがない場合のみです。 スケジュールされたリクエストがある場合、そのリクエストは失敗または停止ステータスである必要があります。

パラメータ

xsd:string sessionId

DSM Web サービス ログインから取得されたセッション ID を指定します。

xsd:String OSIMTargetLabel

ターゲット コンピュータのコンピュータ ラベルを指定します。

xsd:string MACAddress

ターゲット コンピュータの新しい MAC アドレスを指定します。

戻り値

なし

特記事項

なし

SetOSInstallationParameters

SetOSInstallationParameters は、MAC アドレスによって識別された特定のターゲットの複数の OS インストール パラメータを更新するメソッドです。

パラメータ

xsd:string sessionId

DSM Web サービス ログインから取得されたセッション ID を指定します。

xsd:string osimTargetMACAddress

OS インストール パラメータが更新されるターゲットの MAC アドレスを指定します。

ArrayOfOSIMParameters arrParams

更新されるインストール パラメータの配列を指定します。

SetOSInstallationParametersByName

SetOSInstallationParametersByName は、コンピュータ ラベルによって識別された特定のターゲットの複数の OS インストール パラメータを更新するメソッドです。

パラメータ

xsd:string sessionId

DSM Web サービス ログインから取得されたセッション ID を指定します。

xsd:string string osimTargetComputerLabel

OS インストール パラメータが更新されるターゲットのコンピュータ ラベルを指定します。

ArrayOfOSIMParameters arrParams

更新されるインストール パラメータの配列を指定します。

GetOSInstallationParameters

GetOSInstallationParameters メソッドは、インストール パラメータ設定とターゲット コンピュータの計画された、スケジュールされた、または現在のインストール リクエストの説明を取得するために使用されます。

パラメータ

xsd:string sessionId

DSM Web サービス ログインから取得されたセッション ID を指定します。

xsd:string OSIMTargetMACAddress

ターゲット コンピュータの MAC アドレスを指定します。

戻り値

dsm:ArrayOfOSIMTargetPropertiesWithDesc

ターゲット コンピュータのインストール パラメータの配列。

特記事項

なし

GetOSInstallationParametersByName

GetOSInstallationParametersByName メソッドは、ターゲット コンピュータのホスト名を使用して、インストール パラメータ設定と計画された、スケジュールされた、または現在のインストール リクエストの説明を取得するために使用されます。

パラメータ

xsd:string sessionId

DSM Web サービス ログインから取得されたセッション ID を指定します。

xsd:String OSIMTargetLabel

ターゲット コンピュータのコンピュータ ラベルを指定します。

戻り値

dsm:ArrayOfOSIMTargetPropertiesWithDesc

ターゲット コンピュータのインストール パラメータの配列。

特記事項

なし

SetOSInstallationParameter

SetOSInstallationParameter は、ターゲット コンピュータの OS インストール パラメータを変更するメソッドです。

パラメータ

xsd:string sessionId

DSM Web サービス ログインから取得されたセッション ID を指定します。

xsd:string OSIMTargetMACAddress

ターゲット コンピュータの MAC アドレスを指定します。

xsd:string installParameterName

ターゲット コンピュータのパラメータ名を指定します。

xsd:string installParameterValue

ターゲット コンピュータの新しいパラメータ値を指定します。

戻り値

なし

特記事項

なし

SetOSInstallationParameterByName

SetOSInstallationParameterByName は、ターゲット コンピュータのホスト名によって OS インストール パラメータを変更するメソッドです。

パラメータ

xsd:string sessionId

DSM Web サービス ログインから取得されたセッション ID を指定します。

xsd:String OSIMTargetComputerLabel

ターゲット コンピュータのコンピュータ ラベルを指定します。

xsd:string installParameterName

ターゲット コンピュータのパラメータ名を指定します。

xsd:string installParameterValue

ターゲット コンピュータの新しいパラメータ値を指定します。

戻り値

なし

特記事項

なし

OpenOSImageList

OpenOSImageList は、すべての使用可能な OS イメージのリストを取得するメソッドです。

パラメータ

xsd:string sessionId

DSM Web サービス ログインから取得されたセッション ID を指定します。

xsd:bool isBootServerNameSupplied

ブート サーバ名が入力されているかどうかを指定します。

xsd:string bootServerName

ブート サーバの名前を指定します。

dsm:ArrayOfOSImageFilter

OS イメージ プロパティのフィルタを指定します。

xsd:bool matchAll

フィルタ プロパティの条件を指定します。

dsm:OSIMAGEPROPERTY sortProperty

並べ替える OS イメージ プロパティを指定します。

xsd:bool ascending

並べ替えが昇順かどうかを指定します。

戻り値

xsd:long OpenListHandle

GetOSImages に渡すことができる、OS イメージのリストに対する数値ハンドルを指定します。

xsd:long totalNoOfImages

OpenListHandle パラメータによって返されたリスト内のイメージの合計数を指定します。

GetOSImages

GetOSImages は、OpenOSImageList から OS イメージのプロパティを取得するメソッドです。

パラメータ

xsd:string sessionId

Web サービスへのログインによって取得されたセッション ID を指定します。

xsd:long listHandle

OpenOSImageList への直前の呼び出しで返されたリストに対する数値ハンドルを指定します。

xsd:long noOfImages

リストから取得する OS イメージの合計数を指定します。 この数値は、OpenOSImageList への直前の呼び出しによって返されたリスト内の合計数以下である必要があります。

戻り値

dsm:ArrayOfOSImageProperties

開いている OS イメージのリストを表示します。

特記事項

なし

CloseOSImageList

CloseOSImageList は、リスト ハンドルを閉じるメソッドです。

パラメータ

xsd:string sessionId

DSM Web サービス ログインから取得されたセッション ID を指定します。

xsd:long listHandle

OS イメージのリストのリスト ハンドルを指定します。

戻り値

なし

特記事項

なし

GetBootImageList

GetBootImageList は、使用可能なブート イメージをすべて取得するメソッドです。

パラメータ

xsd:string sessionId

DSM Web サービス ログインから取得されたセッション ID を指定します。

xsd:bool isBootServerNameSupplied

ブート サーバ名が入力されているかどうかを指定します。

xsd:string bootServerName

ブート サーバの名前を指定します。

戻り値

dsm:ArrayOfOSIMImageProperties

ブート イメージ プロパティのリストの配列。 配列には以下のブート イメージ プロパティが含まれます。

AssignOSIMTargetsToBootServer

AssignOSIMTargetsToBootServer は、ブート サーバに MAC アドレスを使用してターゲット コンピュータのリストを割り当てるメソッドです。

パラメータ

xsd:string sessionId

DSM Web サービス ログインから取得されたセッション ID を指定します。

xsd:string bootServerName

ブート サーバの名前を指定します。

dsm:ArrayOfstring osimTargetMACAddress

ターゲット コンピュータの MAC アドレスのリストを指定します。

戻り値

なし

特記事項

なし

AssignOSIMTargetsToBootServerByName

AssignOSIMTargetsToBootServerByName は、ブート サーバにホスト名を使用してターゲット コンピュータのリストを割り当てるメソッドです。

パラメータ

xsd:string sessionId

DSM Web サービス ログインから取得されたセッション ID を指定します。

xsd:string bootServerName

ブート サーバの名前を指定します。

dsm:ArrayOfstring osimTargetLabel

ターゲット コンピュータのコンピュータ ラベルのリストを指定します。

戻り値

なし

特記事項

なし

OpenScalabilityServerList

OpenScalabilityServerList は、ドメイン マネージャに登録されたすべてのスケーラビリティ サーバのリストを取得します。

パラメータ

xsd:string sessionId

DSM Web サービス ログインから取得されたセッション ID を指定します。

dsm:ScalabilityServerPropertiesRequired

リストからスケーラビリティ サーバを取得するのに必要なプロパティを指定します。

戻り値

xsd:long OpenListHandle

GetScalabilityServers によって使用されるサーバのリストに対する数値ハンドルを指定します。

xsd:long totalNoOfQueries

OpenListHandle パラメータによって返されたリスト内のイメージの合計数を指定します。

特記事項

このメソッドでは、リストのサイズおよび GetScalabilityServers メソッドで使用可能なリストに対するハンドルが返されます。

GetScalabilityServers

GetScalabilityServers は、スケーラビリティ サーバ リストからスケーラビリティ サーバのプロパティを取得するメソッドです。

パラメータ

xsd:string sessionId

Web サービスへのログインによって取得されたセッション ID を指定します。

xsd:long listHandle

OpenScalabilityServerList への直前の呼び出しで返された、リストに対する数値ハンドルを指定します。

xsd:long noOfServers(m)

リストから取得するサーバの合計数を指定します。 この数値は、OpenScalabilityServerList への直前の呼び出しによって返された、リスト内の合計数以下である必要があります。

戻り値

dsm:ArrayOfServerProperties GetServerReturn

スケーラビリティ サーバ プロパティの配列を各サーバに 1 つ指定します。

特記事項

なし

CloseScalabilityServerList

CloseScalabilityServerList は、開いているスケーラビリティ サーバのリストを閉じます。

パラメータ

xsd:string sessionId

DSM Web サービス ログインから取得されたセッション ID を指定します。

xsd:long listHandle

OpenListHandle パラメータによって返されたリスト内のイメージの合計数を指定します。

戻り値

なし

特記事項

なし

SearchComputerProperty

SearchComputerProperty は、指定されたプロパティ値を持ったコンピュータが存在するかどうかを確認するメソッドです。

パラメータ

xsd:string sessionId

DSM Web サービス ログインから取得されたセッション ID を指定します。

xsd:string propertyValue

検索するコンピュータ プロパティ値を指定します。

dsm:PROPERTY-TYPE propType

プロパティのタイプを示します。

戻り値

なし

特記事項

なし

GetOSImageParameters

GetOSImageParameters は、OS イメージのデフォルト パラメータ設定を取得するメソッドです。

パラメータ

xsd:string sessionId

DSM Web サービス ログインから取得されたセッション ID を指定します。

xsd:string osImage

OS イメージ名を指定します。 指定された OS イメージのデフォルト パラメータ設定が取得されます。

戻り値

dsm:ArrayOfOSIMPropertiesWithDesc

OS イメージのデフォルト パラメータの配列。

特記事項

なし

GetBootServerList

GetBootServerList は、ドメイン マネージャに登録されたブート サーバのリストを取得するメソッドです。

パラメータ

xsd:string sessionId

DSM Web サービス ログインから取得されたセッション ID を指定します。

戻り値

dsm:ArrayOfBootServerProperties

ドメイン マネージャに登録されたブート サーバ プロパティの配列。 配列には以下のブート サーバ プロパティが含まれます。

特記事項

なし

GetOSImageDeployedBootServers

GetOSImageDeployedBootServers は、OS イメージが登録されているブート サーバのリストを取得します。

パラメータ

xsd:string sessionId

DSM Web サービス ログインから取得されたセッション ID を指定します。

xsd:string osImage

OS イメージの名前を指定します

戻り値

dsm:ArrayOfBootServerProperties

ドメイン マネージャに登録されたブート サーバ プロパティの配列。 配列には以下のブート サーバ プロパティが含まれます。

特記事項

なし

GetBootImageDeployedBootServers

GetBootImageDeployedBootServers は、ブート イメージが登録されているすべてのブート サーバのリストを取得するメソッドです。

パラメータ

xsd:string sessionId

DSM Web サービス ログインから取得されたセッション ID を指定します。

xsd:string bootImage

ブート イメージの名前を指定します。

戻り値

dsm:ArrayOfBootServerProperties

ドメイン マネージャに登録されたブート サーバ プロパティの配列。 配列には以下のブート サーバ プロパティが含まれます。

特記事項

なし

DeRegisterOSImage

DeRegisterOSImage は、ドメイン マネージャから OS イメージを登録解除するメソッドです。

パラメータ

xsd:string sessionId

DSM Web サービス ログインから取得されたセッション ID を指定します。

xsd:string osImage

OS イメージの名前を指定します

戻り値

なし

特記事項

なし

DeRegisterBootImage

DeRegisterBootImage は、ドメイン マネージャからブート イメージを登録解除するメソッドです。

パラメータ

xsd:string sessionId

DSM Web サービス ログインから取得されたセッション ID を指定します。

xsd:string bootImage

ブート イメージの名前を指定します。

戻り値

なし

特記事項

なし

AssignOSImageToOSIMTargets

AssignOSImageToOSIMTargets は、ターゲット コンピュータに OS イメージを割り当てるメソッドです。

パラメータ

xsd:string sessionId

DSM Web サービス ログインから取得されたセッション ID を指定します。

xsd:string osImage

OS イメージの名前を指定します

dsm:ArrayOfstring osimTargetNames

ターゲット コンピュータのコンピュータ ラベルのリストの配列を指定します。

戻り値

なし

特記事項

なし

OpenOSIMTargetList

OpenOSIMTargetList は、登録済みの OSIM ターゲット コンピュータのハンドルをリスト表示するメソッドです。

パラメータ

xsd:string sessionId

DSM Web サービス ログインから取得されたセッション ID を指定します。

xsd:bool isBootServerNameSupplied

ブート サーバ名が入力されているかどうかを指定します。

xsd:string bootServerName

ブート サーバの名前を指定します。

dsm:ArrayOfOSImageFilter

OS イメージ プロパティのフィルタを指定します。

xsd:bool matchAll

フィルタ プロパティの条件を指定します。

dsm:OSIMAGEPROPERTY sortProperty

並べ替える OS イメージ プロパティを指定します。

xsd:bool ascending

昇順の並べ替えを指定します。

戻り値

なし

特記事項

なし

GetOSIMTargets

GetOSIMTargets は、OSIM ターゲット コンピュータのリストを取得するメソッドです。

パラメータ

xsd:string sessionId

DSM Web サービス ログインから取得されたセッション ID を指定します。

xsd:long listHandle

OS イメージのリストのリスト ハンドルを指定します。

long totalNoOfOSIMTargets

OSIM ターゲット コンピュータの数を指定します。

戻り値

dsm:ArrayOfTargetProperties arrayofTargetProperties

ターゲット プロパティの配列を返します。

特記事項

なし

CloseOSIMTargetList

CloseOSIMTargetList メソッドは、OSIM ターゲット コンピュータのリスト ハンドルを閉じるために使用されます。

パラメータ

xsd:string sessionId

DSM Web サービス ログインから取得されたセッション ID を指定します。

xsd:long listHandle

OS イメージのリストのリスト ハンドルを指定します。

戻り値

なし

特記事項

なし

GetOSIMTarget

GetOSIMTarget は、OSIM ComputerMACAddress に基づいて OSIM コンピュータのプロパティを取得するメソッドです。

パラメータ

xsd:string sessionId (m)

セッション ID を指定します。

xsd:string OSIMTargetMACAddress

OSIM コンピュータの MAC アドレスを指定します。

戻り値

dsm:ArrayOfOSIMProperties arrayOfOSIMTargetProperties

ターゲット コンピュータの以下のプロパティが含まれる配列を返します。

特記事項

なし

GetOSIMTargetByName

GetOSIMTargetByName は、OSIM ComputerLabel に基づいて OSIM コンピュータのプロパティを取得するメソッドです。

パラメータ

xsd:string sessionId (m)

セッション ID を指定します。

xsd:string OSIMTargetLabel

OSIM コンピュータのラベルを指定します。

戻り値

dsm:ArrayOfOSIMProperties arrayOfOSIMTargetProperties

ターゲット コンピュータの以下のプロパティが含まれる配列を返します。

特記事項

なし

GetOSImages2

GetOSImages2 は、指定されたインデックス番号から OS イメージのリストを返すメソッドです。 たとえば、OS イメージの完全なリストに 10 のイメージ（0 ～ 9）があり、5 番目の位置から読み取る場合、このメソッドでは 5 ～ 9 のイメージのリストを返すことができます。

パラメータ

xsd:string sessionId

DSM Web サービス ログインから取得されたセッション ID を指定します。

xsd:long listHandle

OpenOSImageList への直前の呼び出しで返されたリストに対する数値ハンドルを指定します。

xsd:long noOfImages

startIndex 位置から取得するオブジェクトの数を指定します。 この数値は、OpenOSImageList への直前の呼び出しで返されたリスト内の合計数以下である必要があります。

Xsd:long index

結果セットから項目を返す必要があるインデックス番号を指定します。 インデックスはゼロベースです。

戻り値

dsm:ArrayOfOSImageProperties

結果セットから返されるイメージの OS イメージ プロパティの配列を表示します。

特記事項

なし

GetOSIMTargets2

GetOSIMTargets2 は、指定されたインデックス番号から OSIM 登録済みコンピュータのリストを返すメソッドです。 たとえば、OSIM 登録済みコンピュータの完全なリストに 10 台のコンピュータ（0 ～ 9）があり、5 番目の位置から読み取る場合、このメソッドでは 5 ～ 9 のコンピュータのリストを返すことができます。

パラメータ

xsd:string sessionId

DSM Web サービス ログインから取得されたセッション ID を指定します。

xsd:long listHandle

OS イメージのリストのリスト ハンドルを指定します。

Xsd:long index

結果セットから項目を返す必要があるインデックス番号を指定します。 インデックスはゼロベースです。

Xsd:long noOfTargets

startIndex 位置から取得するオブジェクトの数を指定します。

戻り値

dsm:ArrayOfTargetProperties

OSIM ターゲット プロパティの配列です。各 OSIM ターゲット コンピュータに 1 つが対応します。

特記事項

なし

GetOSIMTargetList

GetOSIMTargetList は、OSIM 登録済みコンピュータを返すメソッドです。

パラメータ

xsd:string sessionId

DSM Web サービス ログインから取得されたセッション ID を指定します。

xsd:bool isBootServerNameSupplied

ブート サーバ名が入力されているかどうかを指定します。

xsd:string bootServerName

ブート サーバの名前を指定します。

dsm:ArrayOfOSIMTargetFilter2 filterArray

OSIM コンピュータ プロパティのフィルタを指定します。

xsd:boolean matchall

フィルタ条件がすべて満たされているかどうかを指定します。 AND 演算を実行するためにパラメータを True に設定します。 OR 演算を実行するためにパラメータを False に設定します。

dsm:OSIMTARGETPROPERTY2 sortProperty

結果を並べ替える基になるプロパティを指定します。

xsd:boolean sortAscending

リストを昇順で並べ替えるかどうかを指定します。

Xsd:long index

結果セットから項目を返す必要があるインデックス番号を指定します。 インデックスはゼロベースです。

Xsd:long noOfTargetsRequired

startIndex 位置から取得するオブジェクトの数を指定します。

Xsd:boolean refreshList

各呼び出しの結果セットを再計算するかどうかを指定します。

戻り値

dsm:ArrayOfTargetProperties2 arrayOfOSIMTargets

OSIM ターゲット プロパティの配列が OSIM ターゲット コンピュータごとに 1 つ含まれています。

xsd:long totalNumberOfTargets

フィルタ条件に一致するコンピュータの合計数が含まれています。

特記事項

インターフェースにフィルタリングに関連するパラメータが含まれている場合でも、メソッドはフィルタ操作をサポートしません。

SetOSInstallationParameter2

SetOSInstallationParameter2 は、MACAddress によって識別されたコンピュータの配列の OS インストール パラメータを変更するメソッドです。

パラメータ

xsd:string sessionId

DSM Web サービス ログインから取得されたセッション ID を指定します。

dsm:ArrayOfstring osimTargetMACAddress

ターゲット コンピュータの MAC アドレスのリストを指定します。

xsd:string installParameterName

変更する OS インストール パラメータのパラメータ名を指定します。

xsd:string installParameterValue

変更する OS インストール パラメータ値を指定します。 デフォルト値を更新するには、NULL を指定します。

戻り値

なし

特記事項

なし

SetOSInstallationParameterByName2

SetOSInstallationParameterByName2 は、ホスト名によって識別されたコンピュータの配列の OS インストール パラメータを変更するメソッドです。

パラメータ

xsd:string sessionId

DSM Web サービス ログインから取得されたセッション ID を指定します。

dsm:ArrayOfstring osimTargetComputerLabel (m)

ターゲット コンピュータのコンピュータ ラベルのリストを指定します。

xsd:string installParameterName

変更する OS インストール パラメータのパラメータ名を指定します。

xsd:string installParameterValue

変更する OS インストール パラメータ値を指定します。 デフォルト値を更新するには、NULL を指定します。

戻り値

なし

特記事項

なし

GetOSIMParameterDefaults

GetOSIMParameterDefaults は、MACAddress によって識別された OSIM コンピュータの OS インストール パラメータに対してサポートされる値を返すメソッドです。 たとえば、タイム ゾーン、言語など、一部の OSIM パラメータには OS イメージの有効な値のリストがあります。

パラメータ

xsd:string sessionId

DSM Web サービス ログインから取得されたセッション ID を指定します。

dsm:ArrayOfstring osimTargetMACAddress

ターゲット コンピュータの MAC アドレスのリストを指定します。

xsd:string paramName

有効な値を取得するパラメータの名前を指定します。

戻り値

dsm:ArrayOfstring defaults

指定されたパラメータの有効な値の配列を返します。

GetOSIMParameterDefaultsByName

GetOSIMParameterDefaultsByName は、ホスト名によって識別された OSIM コンピュータの OS インストール パラメータに対してサポートされる値を返すメソッドです。 たとえば、タイム ゾーン、言語など、一部の OSIM パラメータには OS イメージの有効な値のリストがあります。

パラメータ

xsd:string sessionId

DSM Web サービス ログインから取得されたセッション ID を指定します。

dsm:ArrayOfstring osimTargetComputerLabel

ターゲット コンピュータのコンピュータ ラベルのリストを指定します。

xsd:string paramName

有効な値を取得するパラメータの名前を指定します。

戻り値

dsm:ArrayOfstring defaults

指定されたパラメータの有効な値の配列を返します。

GetBootImageList2

GetBootImageList2 は、ドメイン マネージャ内の登録済みブート イメージをすべて取得するメソッドです。 このメソッドは並べ替えとフィルタの操作もサポートします。

パラメータ

xsd:string sessionId

DSM Web サービス ログインから取得されたセッション ID を指定します。

xsd:bool isBootServerNameSupplied

ブート サーバ名が入力されているかどうかを指定します。

xsd:string bootServerName

ブート サーバの名前を指定します。

dsm: ArrayOfBootImageFilter filterArray

ブート イメージ プロパティのフィルタ条件の配列を指定します。

dsm:BootImageProperty sortProperty

結果を並べ替える基になるプロパティを指定します。

xsd:boolean sortAscending

リストを昇順で並べ替えるかどうかを指定します。

Xsd:long index

結果セットから項目を返す必要があるインデックス番号を指定します。 インデックスはゼロベースです。

xsd:long numRequired

startIndex 位置から取得するオブジェクトの数を指定します。

Xsd:boolean refreshList

各呼び出しの結果セットを再計算するかどうかを指定します。

戻り値

xsd:long totalNumImages

指定されたフィルタ条件に使用可能なイメージの合計数が含まれています。

dsm: ArrayOfBootImageProperties biPropsArray

ブート イメージ プロパティの配列が含まれています。

GetBootServerList2

GetBootServerList2 は、ドメイン マネージャ内のブート サーバを返すメソッドです。 このメソッドは並べ替えとフィルタの操作もサポートします。

パラメータ

xsd:string sessionId

DSM Web サービス ログインから取得されたセッション ID を指定します。

dsm: ArrayOfBootServerFilter filterArray

ブート サーバ プロパティのフィルタ条件の配列を指定します。

dsm:BootServerProperty sortProperty

サーバを並べ替える基になるブート サーバ プロパティを指定します。

xsd:boolean ascending

ブート サーバを昇順で並べ替えるかどうかを指定します。 True に設定されている場合、サーバは指定された並べ替えプロパティに基づいて昇順で並べ替えられます。

Xsd:long index

結果セットから項目を返す必要があるインデックス番号を指定します。 インデックスはゼロベースです。

xsd:long numRequired

指定されたインデックス番号から取得するブート サーバの数を指定します。

Xsd:boolean refreshList

各呼び出しの結果セットを再計算するかどうかを指定します。

戻り値

xsd:long totalNumServers

指定されたフィルタ条件に使用可能なブート サーバの合計数が含まれています。

dsm: ArrayOfBootServerProperties biPropsArray

ブート サーバ プロパティの配列が含まれています。