テナントの作成

2024年1月25日

ID 259250

REST API メソッドの呼び出し時に指定するテナントタイプに応じて、次の動作が実行されます:

  • 複合的なテナントタイプの場合:
    • Integration Server データベースにテナントデータを追加します。
    • Kaspersky Security Center で、テナントの保護インフラストラクチャを作成します(仮想管理サーバー、仮想管理サーバーへの接続用アカウント、フォルダーと管理グループの構造、)。
    • テナントの仮想管理サーバーの情報を Integration Server の定義データベースへ追加します。
  • 単純なテナントタイプの場合:Integration Server の定義データベースにテナントデータを追加します。

メソッド:

POST /api/2.0/virtualization/tenants

リクエスト本文に次のパラメータを指定する必要があります:

<tenant>

<name>{名前}</name>

<description>{説明}</description>

<userData><![CDATA[{詳細情報}]]></userData>

<preferredViisAddress>{IP アドレス}</preferredViisAddress>

<type>{テナントタイプ}</type>

<!-- vKsc セクションのデータは、複合的なテナントタイプのみ指定可能です -->

</vKsc>

<user>

<name>{管理者名}</name>

<password>{管理者パスワード}</password>

</user>

</vKsc>

</tenant>

各パラメータの説明:

  • {日時} – テナント名(必須パラメータ)。
  • {説明} – テナントの説明(任意のパラメータ)。
  • {追加情報} – 追加のテナント情報(オプションのパラメータ)。
  • {IP アドレス}– テナントの仮想マシンにインストールされた Light Agent が接続する Integration Server の IP アドレス(オプションのパラメータ)。指定したアドレスが既定値として、Light Agent ポリシーの作成時に使用されます。パラメータが指定されていない場合、ポリシーは Integration Server の IP アドレスを REST API へのリクエストから使用します。
  • {テナントタイプ} – テナントタイプ:複合的または単一的なテナントタイプ(オプションパラメータ)。
  • {管理者名} – テナントの仮想管理サーバーへの接続に使用される管理者アカウントの名前(複合的なテナントタイプの作成時に必要)。アカウントは処理中に自動的に作成されます。
  • {管理者パスワード} – 管理者アカウントの Base64 エンコードされたパスワード(複合的なテナントを作成する場合に必要)。

このリクエストは非同期で実行され、REST API は CreateTenant タスクの識別子を返します。このタスクを使用して、テナントの作成処理の進捗を監視できます。タスクの実行が完了すると、[結果]フィールドに作成されたテナントの識別子を含むテナントの情報、またはエラーメッセージが表示されます。処理のどこかのステップでエラーが発生すると、変更がすべて元に戻されます。

リターンコード:

  • 202 (Accepted) – リクエストの実行が受諾されました。レスポンスは、CreateTenant タスクの識別子を返します。
  • 400 (Bad request) VIRMT_MandatoryParameterIsNotSpecified – 必須パラメータの 1 つ(テナント名など)がリクエスト本文に指定されていません。
  • 400 (Bad request) VIRMT_InvalidTenantType – 無効なテナントタイプがリクエスト本文に指定されており、指定されたテナントタイプが存在しません。
  • 400 (Bad request) VIRMT_VKscCredentialsNotSpecified – 仮想 Kaspersky Security Center 管理サーバーの管理者アカウント名またはパスワードが指定されていません(複合的なテナントタイプの作成時)。
  • 400 (Bad request) VIRMT_InvalidViisAddressFormat – Integration Server の IP アドレスの形式が無効です。
  • 403 (Forbidden) – リソースへのアクセスが拒否されました。

タスクで発生する可能性があるエラーコード:

  • KSC_ServiceNotConfigured – Kaspersky Security Center 接続設定が指定されていません。
  • VIRMT_TenantGroupAlreadyExists – 指定したテナント名に対応する名前のフォルダーが Kaspersky Security Center に既に存在します。
  • VIRMT_TenantWithSpecifiedNameAlreadyExists – Integration Server の定義データベース内に、指定した名前のテナントが見つかりません。
  • VIRMT_PasswordNotComplyPolicy – Kaspersky Security Center 仮想管理サーバーの管理者アカウントを作成できませんでした:指定したパスワードが Kaspersky Security Center のパスワード要件を満たしていません。
  • VIRMT_UserWithSpecifiedNameAlreadyExists – Kaspersky Security Center 仮想管理サーバーの管理者アカウントを作成できませんでした:指定した名前のユーザーが既に Kaspersky Security Center に存在します。

この記事はお役に立ちましたか?
改善できる点がありましたらお聞かせください。
フィードバックをいただき、ありがとうございました。改善に向けて取り組んでまいります。
フィードバックをいただき、ありがとうございました。改善に向けて取り組んでまいります。