Web サービスを使用したプログラムによるテナントの作成

npc は、ユーザにプロビジョニング タスクと設定タスクを自動化できる API セットを提供します。 最も頻繁に繰り返されるタスク、または時間のかかるタスクは、Web サービスによりユーザに公開されます。 これらの API の一部は、REST(Representational State Transfer)モデルと一致する Web サービスから構成されます。
capm300
NetOps Portal
は、ユーザがプロビジョニング タスクと設定タスクを自動化できる API セットを提供します。 最も頻繁に繰り返されるタスク、または時間のかかるタスクは、Web サービスによりユーザに公開されます。 これらの API の一部は、REST(Representational State Transfer)モデルと一致する Web サービスから構成されます。
このユース ケースでは、CA
NetOps Portal
RESTful Web サービスを使用して複数のテナント定義を作成するために、管理者が展開できる手順について説明します。 CA
NetOps Portal
へのアクセス権限を付与する独自ユーザ アカウントはテナントごとに持つため、テナント内でのユーザ アカウントの作成についても説明します。 このユース ケースでは REST クライアント(総括的な Web サービス ユーザ インターフェース アプリケーション)を使用する場合に実行する手順について説明します。 このユース ケースには、デフォルト サーバ ポート 8181 を使用して生成する URI が含まれています。
プログラムによるテナントの作成
グローバル管理者は、固有パラメータでテナントを作成するために CA
NetOps Portal
RESTful Web サービスを使用できます。 基本的なテナント定義には MSP 顧客を識別するためのいくつかのパラメータが含まれており、管理対象アイテムおよび顧客用の設定を他のオペレータがアクセスできるようになります。 管理者アカウントは、顧客がいくつかのテナント セットアップを実行できるようにするため、テナント定義に必要なコンポーネントです。
各顧客の監視対象デバイスおよび製品の設定を、個別の手順でテナント定義に関連付けることができます。 テナントごとに 1 つ以上の IP ドメインが必要です。 その後、ユーザおよびテナント管理者は、その顧客の企業インフラストラクチャおよびアプリケーションを管理するために必要な他の製品設定を設定できます。
Web サービスを使用したテナントの作成
テナント 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. 必要な数のテナントを作成するまで、前述の手順を繰り返します。
Web サービスを使用したユーザの作成
ユーザ Web サービスを使用して、ユーザ アカウントの作成および設定を行うために、任意の REST クライアントを使用します。
すべてのユーザ アカウントは、自動的にテナントに関連付けられます。 マルチ テナントを展開している場合、新規ユーザは、REST サービス コールの作成に使用された認証済みユーザ アカウントのテナントに割り当てられます。 ユーザがマルチ テナントを展開していない場合、この関連付けは透過的に行われます。つまり、新規ユーザ アカウントはデフォルト テナントに関連付けられます。
以下の手順に従います。
  1. NetOps Portal
    サーバへ接続されている REST クライアントをセットアップします。
  2. REST クライアントに、
    NetOps Portal
    RESTful Web サービス API の URL を入力します。 次の形式を使用します:
    http://
    PC_host
    :8181/pc/center/webservice/users/role/
    {roleIdName}
    /
    roleIdValue
    /
    • roleIdName
      http://
      PC_host
      :8181/pc/center/webservice/roles/idName
      s で指定されている値を使用します。
      例:
      roleName
      」および「
      roleId
      」。
    • roleIdValue
      この値は、ユーザが選択した
      roleIdName
      に依存します。 たとえば「
      roleName
      」を使用する場合は、
      roleIdValue
      を有効な役割名に置き換えます。
      この役割はテナント内に利用できる必要があります。
  3. 「HTTP」メソッド
    POST
    を選択します。
  4. NetOps Portal
    に対してホストまたはテナント管理者アクセス権があるユーザ アカウントの有効なユーザ名およびパスワードを指定します。
  5. Body 設定内の「
    Body Content-type
    」として「
    application/xml
    」を選択します。
  6. [Body]テキスト セクション内に、以下のパラメータを追加します。
    <user> <name>{UserName}</name> <description>{UserDescription}</description> <enabled>{UserEnabled}</enabled> <removable>{UserRemovable}</removable> <timezone>{UserTimeZone}</timezone> <culture>{UserCulture}</culture> <administeredGroups> <group ID="{GroupID}"/> <group ID="{GroupID}"/> </administeredGroups> </user>
  7. 任意の値を新しいテナントに対して使用する値に置換します。
    たとえば、以下のパラメータを提供します。
    <user> <name>Jane Doe</name> <description>User associated with the John Doe Corporation tenant.</description> <enabled>true</enabled> <removable>true</removable> <timezone>CST6CDT</timezone> <culture>en-US</culture> <administeredGroups> <group ID="105"/> <group ID="367"/> </administeredGroups> </user>
    ユーザ パラメータの詳細については、「ユーザ Web サービス」を参照してください。
    administeredGroups
    タグはオプションです。 管理対象グループのないユーザを作成するには、タグを除外します。
  8. メソッドを実行します。
  9. 必要な数のユーザを作成するまで、前述の手順を繰り返します。
基本ユーザ アカウント パラメータ
以下のユーザ アカウント設定の現在値は GET 操作で取得できます。
http://
PC_host
:8181/pc /center/webservice/users/
cultureId
.
この URL は、このコマンドを実行するために使用されるアカウントと同じテナントに関連付けられたユーザに関する情報を返します。
cultureId
には、出力を表示する言語の言語コード(「en-US」など)を指定します。
  • userID
    ユーザ アカウントに対して内部的に割り当てられた値です。
  • name
    ユーザ アカウントのログイン名です。 名前は 50 文字までに制限されています。
  • 説明
    (オプション)理解を促すためのユーザ アカウントに関する説明です。
  • enabled
    ユーザ アカウントが使用可能か(アクティブか)どうかを決定します。
  • removable
    項目が削除できるかどうか(データベースから削除)を指定します。
    値:
    true または false
2 つの事前定義ユーザ アカウント(
admin
user
)は削除できません。
  • timezone(tz)
    レポート データに表示されるタイムゾーンと一致します。
    デフォルト
    : UTC (協定世界時)。
  • userLevel
    このユーザ アカウントに割り当てられた製品権限を識別します。
  • 役割
    ユーザ アカウントに割り当てられた役割を指定します。
  • tenantId
    ユーザ アカウントが関連付けられているテナント用の内部(データベース)識別子です。
  • culture
    言語(ロケール)を指定します。 以下のリストからの言語識別子を提供します。
    • en - US(英語、米国)
    • ja - JP (日本語)
    • zh-CN (中国語(簡体字))
    • fr-FR (フランス語、フランス)
: GET メソッドはパスワード情報を返しません。 新規ユーザ アカウントの作成時、パスワードはユーザ名と同じになるように自動的に設定されます。
個別の PUT メソッドを使用すると、指定されたユーザ アカウントのパスワードを更新できます。 Web サービスが使用する暗号キーが公表されないように、パスワードはクリア テキストで送信されます。 その結果、パスワードの変更方法は、パスワードの機密性を守るため、CA
NetOps Portal
がインストールされているサーバでだけ使われる必要があります。
ユーザ アカウント製品権限の設定
指定されたユーザ アカウントの製品権限を判断するには、CA
NetOps Portal
ユーザ インターフェースを使用します。 製品権限は、ユーザ アカウントに関連付けられた権限セットの一種です。
製品権限は、選択したデータ ソースの機能にユーザがアクセスすることを許可し、CA
NetOps Portal
の機能には適用されません。
ユーザ アカウントには、以下のいずれかの製品権限割り当てがあります。
  • NONE
    このユーザには指定されたデータ ソースへのアクセス権がないことを示します。
  • ADMINISTRATOR
    このユーザは、示されたデータ ソースに対して管理者製品権限があり、管理タスクを実行できることを示します。
  • POWER_USER
    このユーザは、示されたデータ ソースに対してパワー ユーザ製品権限があり、ユーザ アカウントとダッシュボードに関連付けられた一部の管理タスクを実行できることを示します。
  • USER
    このユーザは、示されたデータ ソースに対してユーザ製品権限があり、管理機能にはアクセス権がないことを示します。