テナント Web サービス

API は、テナント Web サービスを提供し、ユーザがテナント定義を参照、作成、変更できるようにします。
capm250
API は、テナント Web サービスを提供し、ユーザがテナント定義を参照、作成、変更できるようにします。
基本的なテナント定義には、テナントを識別するためのいくつかのパラメータが含まれます。 カスタマの監視対象システムのすべてのインフラストラクチャ(デバイス、ネットワーク、サーバ)とすべての監視パラメータをテナント定義と関連付ける必要があります。 各テナントには少なくとも 1 つの IP ドメインと、関連企業のインフラストラクチャとアプリケーションの管理に必要な数だけの以下の定義が含まれている必要があります。
  • ユーザ アカウント
  • 役割
  • カスタム グループとシステム グループ
  • カスタム レポート
  • カスタム メニュー
定義と監視パラメータを既存のテナント定義と関連付けるには、テナント管理者としてログインし、必要な Web サービスを使用し、必要な定義を作成します。 その後、定義はテナント定義と関連付けられ、このテナントのユーザ アカウントでログインしたユーザが利用できます。
テナント Web サービスおよびユーザ Web サービスの使用に役立つユース ケース ドキュメントについては、CA
NetOps Portal
ドキュメントのマニュアル選択メニューを参照してください。
テナント Web サービスのパラメータ
テナント Web サービスで使用可能なパラメータおよび操作を確認するには、次のコールを発行します。
http://
PC_host
:8181/pc/center/rest/tenants/documentation
[パラメータ]
  • tenantDescription
    (オプション)テナントに関する説明です。
  • idName
    テナントの名前です。
  • ステータス
    このテナントのステータスです。 以下の値のいずれかを選択します。
    • 有効: 使用するテナント ユーザ アカウントを有効にします。
    • 無効: このテナントに関連付けられたユーザ アカウントによるすべてのアクションを禁止します。
  • removable
    項目が削除できるかどうか(データベースから削除)を指定します。
    値:
    true または false
  • theme
    このテナントに使用する形式(ブラウザ ウィンドウ内のページの外観を制御するテーマ)を指定します。 このテナントに関連付けられているユーザ アカウントを持つすべてのオペレータにこのテーマが表示されます。 CA-Blue および CA-Gray の 2 つのテーマが利用可能です。
    デフォルト:
    CA-Blue
  • defaultCulture
    言語(ロケール)を指定します。 以下のリストからの言語識別子を提供します。
    • en - US(英語、米国)
    • ja - JP (日本語)
    • zh-CN (中国語(簡体字))
    • fr-FR (フランス語、フランス)
  • accountId
    このテナントを識別します。通常は、MSP アカウント番号と一致します。 値が入力として提供される場合、この値はすべての定義済みテナントで一意である必要があります。
  • tenantID
    テナント定義用の内部(データベース)識別子です。
テナント Web サービスの構文例
テナント Web サービスを使用すると、現在のテナント定義のリストの取得、新しいテナント定義の作成、およびパラメータの変更によるテナント定義の変更ができます。
テナント Web サービスの使用に役立つユース ケース ドキュメントについては、CA
NetOps Portal
ドキュメントのマニュアル選択メニューを参照してください。
Operations
テナント Web サービスでは、以下の基本操作がサポートされています。
  • GET
    名前別に並べ替えられたテナント定義の一覧を返します。 /tenantID エンドポイントで利用できます。 以下の構文を使用します。
    http://
    PC_host
    :8181/pc/center/webservice/tenants/
  • POST
    カスタム テナントを作成します。 以下の構文を使用します。
    http://
    PC_host
    :8181/pc /center/webservice/tenants/
  • PUT
    既存のテナント定義を更新します。 以下の構文を使用します。
    http://
    PC_host
    :8181/pc/center/webservice/tenants/
テナントの作成
テナント Web サービスを使用して、テナントの作成および設定を行うために、任意の REST クライアントを使用します。
以下の手順に従います。
  1. NetOps Portal
    サーバへ接続されている REST クライアントをセットアップします。
  2. REST クライアントに、
    NetOps Portal
    RESTful Web サービス API の URL を入力します。 次の形式を使用します:
    http://
    PC_host
    :8181/pc/center/webservice/tenants/
  3. 「HTTP」メソッド
    POST
    を選択します。
  4. NetOps Portal
    へのグローバル管理者アクセス権を持つユーザ アカウントの有効なユーザ名およびパスワードを指定します。
  5. Body 設定内の「
    Body Content-type
    」として「
    application/xml
    」を選択します。
  6. [Body]テキスト セクション内に、以下の XML を追加します。
    <tenant> <tenantName>Name of tenant</tenantName> <tenantDesc>Description of the tenant</tenantDesc> <accountIdentifier>unique string for this tenant</accountIdentifier> <status>{activated or disabled}</status> <removable>{true or false}</removable> <theme>{CA-Blue or CA-Gray}</theme> <defaultCulture>culture</defaultCulture> </tenant>
  7. 任意の値を新しいテナントに対して使用する値に置換します。
    たとえば、以下のパラメータを提供します。
    <tenant> <tenantName>John Doe</tenantName> <tenantDesc>John Doe Corporation tenant</tenantDesc> <accountIdentifier>JD1234</accountIdentifier> <status>Enabled</status> <removable>false</removable> <theme>CA-Blue</theme> <defaultCulture>en-US</defaultCulture> </tenant>
  8. メソッドを実行します。
  9. 必要な数のテナントを作成するまで、前述の手順を繰り返します。