サブテナンシーの有効化

uim203
REST API (
contact_origins
)を使用して、発生元に基づいて複数ユーザのリソースへのアクセスを有効または無効にできます。MSP 管理者は、テナントの特定の発生元にマッピングすることによって、既存または新規のユーザのユーザ発生元の関連付けをグローバルに変更できます。デフォルトでは、ユーザをアカウントに追加しても、ユーザに対して事前プロビジョニング済みの発生元ホワイトリストを有効にするまで、そのユーザはアラーム ビューアや OC ダッシュボードなど、いかなるリソースへのアクセス権も持っていません。複数の UIM コンタクト ユーザと LDAP ユーザに対し、複数の発生元を有効にできます。この機能は、プライマリ ハブと OC (OC が別のサーバに展開されている場合)上で wasp プローブの RAW 設定の
contact_origins_enabled
フラグを有効にするとサポートされます。
さまざまなお客様にソフトウェアを販売する MSP を考えます。MSP はソフトウェアを確認し、お客様のソフトウェアの設定や各種最適化のサポートもします。MSP は CA UIM のお客様であり、MSP のお客様はサブテナントになります。お客様のビジネスの性質に応じて、MSP はオンライン サポート、予知保全、リモート パフォーマンスの最適化などの各種サービスを提供します。お客様の環境に存在している間に収集されたソフトウェアのデータを表示できます。パフォーマンス レポート、アラームの表示、ビジネスを最適化するダッシュボードなどの各種リソースをお客様(サブテナント)に提供できます。
目次
前提条件
以下の要件があります。
サブテナンシーの有効化
ユーザを 1 つ以上の発生元にマッピングせずにサブテナンシーを有効にすると、ユーザが発生元にマッピングされるか、この機能を無効化しない限り、
すべて
のユーザの OC サーバへのログインが失敗します。ユーザが OC サーバにログインできるようにするには、以下の手順をすべて実行する
必要があります
。サブテナンシーを無効にするには、手順「サブテナンシーの無効化」に従います。
手順 1: サブテナンシー機能の有効化
OC サーバとプライマリ ハブは同じサーバに配置できます。OC とプライマリ ハブが別のサーバで展開されている場合、両方のサーバでこの手順を実行します。
以下の手順に従います。
  1. OC サーバで、
    [ハブ]
    -
    [ロボット]
    -
    [プローブ]
    の順に選択し、
    wasp
    プローブの
    [RAW 設定]
    ページを開きます。
  2. セットアップ
    ]をクリックして設定セクションを表示します。
    Raw Configure setup Sections
  3. contact_origins_enabled
    パラメータの[
    値の編集
    ]オプションを選択します。
    Edit Value
  4. パラメータの値を
    true
    に定義して、サブテナンシー オプションを有効にし、[
    更新
    ]をクリックします。
    Define Parameter Value
  5. Raw 設定
    ]ページの[
    更新
    ]をクリックし、サーバへの変更を保存します。
  6. 残りの OC サーバおよび adminconsoleapp パッケージが展開される場所では、
    contact_origins_enabled
    パラメータを
    true
    に設定します。
  7. OC とアドミン コンソールが動作するすべてのサーバで、
    wasp
    を再起動します。
  8. REST クライアントにアクセスして、API エンドポイントがリストに表示されることを確認してください。
    たとえば、以下の URL を使用します。
    http://<<hostname>>:<<port>>/uimapi/docs/index.html#/contact_origins
手順 2: ユーザの作成または編集
ユーザの作成または編集、アカウントへの発生元の関連付け、ACL の定義を行います。
文字制限は、loginName では 64 文字、発生元では 255 文字です。
以下の手順に従います。
  1. MSP 管理者として OC にログインし、
    [設定]
    ->
    [アカウント アドミニストレーション]
    に移動します。
  2. 必要に応じて、ユーザを作成または既存のユーザを編集します。詳細については、「アカウント アドミンを使用したユーザの追加または変更」を参照してください。
    Add or Modify Users with Account Admin
    必要に応じて、アカウントの詳細を編集します。
    Edit Account Details
    ユーザから発生元へのマッピングがないため、OC サーバへのログインは失敗します。
手順 3: ユーザの発生元へのマップ
REST クライアントを使用して、必要な 1 つ以上の発生元に各ユーザをマップします。
以下の手順に従います。
  1. 以下の URL を使用して、REST クライアントを開きます。
    http://<<hostname>>:<<port>>/uimapi/docs/index.html#/contact_origins
  2. 各ユーザは、POST (addorigins) API を使用して割り当てられた発生元の数を定義します。
    たとえば、コンタクト ユーザ acme_user1、
    acme_user2
    を発生元
    win2k12-m-sh03
    および
    win2k12-m-ph_hub
    に追加する場合、以下のパラメータを定義します。
    1. 本文
      で、
      loginName
      パラメータのユーザおよび
      origin
      のアカウント リストを定義します。
      [ { "loginName": "acme_user1", "origin": [ "win2k12-m-sh03","win2k12-m-ph_hub" ] }, { "loginName": "acme_user2", "origin": [ "win2k12-m-sh03", "win2k12-m-ph_hub" ] } ]
    2. パラメータ コンテンツ タイプ
      で、
      application/json
      を選択します。
    3. Try it out
      ]をクリックして、クエリを実行します。
    4. レスポンス本文
      で、発生元がレスポンスで返されることを確認します。
      以下のレスポンスは、ユーザ acme_user1 および acme_user2 について、発生元 win2k12-m-ph_hub および win2k12-m-sh03 との関連付けが有効であることを示します。
      [ { "loginName": "acme_user1", "origin": [ "win2k12-m-ph_hub", "win2k12-m-sh03" ] }, { "loginName": "acme_user2", "origin": [ "win2k12-m-ph_hub", "win2k12-m-sh03", ] } ]
  3. GET API を使用して、ユーザと発生元が関連付けられていることを確認します。
    1. loginname
      で userID を定義します。たとえば、
      acme_user1
      を定義します。
      get_api.png
    2. 応答コンテンツ タイプ
      で、
      application/json
      を選択します。
    3. Try it out
      ]をクリックして、クエリを実行します。
    4. レスポンス本文
      で、発生元がレスポンスで返されることを確認します。
      { "loginName": "acme_user1", "origin": [ "win2k12-m-ph_hub", "win2k12-m-sh03" ] }
  4. POST API getcontactorigins を使用して、ユーザと発生元が関連付けられていることを確認します。
    1. 本文
      で、ログイン名を定義します。たとえば、
      ["acme_user1","acme_user2"]
      を定義します。
      multiple origins.png
    2. 応答コンテンツ タイプ
      で、
      application/json
      を選択します。
    3. Try it out
      ]をクリックして、クエリを実行します。
    4. レスポンス本文
      で、発生元がレスポンスで返されることを確認します。
      [ { "loginName": "acme_user1", "origin": [ "win2k12-m-ph_hub", "win2k12-m-sh03" ] }, { "loginName": "acme_user2", "origin": [ "win2k12-m-ph_hub", "win2k12-m-sh03", ] } ]
手順 4: 設定の確認
以下の手順に従います。
  1. OC で、アラーム ビューに移動して、ユーザ(acme_user1)が前の手順でマップされた発生元にアクセスできることを確認します。
Origin Columns where associated Origins are visible
[発生元]カラムがデフォルトで表示されていない場合は、
[アクション]
-
[カラムの編集]
に移動し、
[発生元]
を選択します。
サポートされている API 機能
API 名
説明
POST /contact_origins/addorigins
複数の連絡先のログイン名の発生元のリストを追加します。
DELETE /contact_origins/deletecontactorigins
複数のコンタクト ログイン名の発生元のリストを削除します。
POST /contact_origins/getcontactorigins
複数の連絡先のログイン名の発生元のリストを返します。
POST /contact_origins/removeorigins
コンタクト ログイン名の発生元のリストを削除します。
POST /contact_origins/setorigins
連絡先のログイン名の発生元のリストを設定します。
DELETE /contact_origins/{loginname}
コンタクト ログイン名の発生元のリストを削除します。
GET /contact_origins/{loginname}
指定されたコンタクト ログイン名に設定されたコンタクトの発生元を返します。
API 名
リクエスト URL
パラメータ
レスポンス
POST /contact_origins/addorigins
http://<uim_server>/uimapi/contact_origins/addorigins
ログイン名(ユーザ名を指定)
発生元(ユーザに関連付ける発生元のリストを指定)
[
{
   "loginName": "acme_user1",
"origin": [
         "win2k12-m-ph_hub", "win2k12-m-sh03"
]
},
{
  "loginName": "acme_user2",
"origin": [
       "win2k12-m-ph_hub", "win2k12-m-sh03",
]
}
]
DELETE /contact_origins/deletecontactorigins
http://<uim_server>/uimapi/contact_origins/deletecontactorigins
ログイン名(対応する発生元を削除する場合のユーザ名を指定)
なし
POST /contact_origins/getcontactorigins
http://<uim_server>/uimapi/contact_origins/getcontactorigins
ログイン名(対応する発生元を取得する場合のユーザ名を指定)
[
{
   "loginName": "acme_user1",
"origin": [
         "win2k12-m-ph_hub", "win2k12-m-sh03"
]
},
{
  "loginName": "acme_user2",
"origin": [
       "win2k12-m-ph_hub", "win2k12-m-sh03",
]
}
]
POST /contact_origins/removeorigins
http://<uim_server>/uimapi/contact_origins/removeorigins
ログイン名(発生元を削除する場合のユーザ名を指定)
発生元(ユーザのために削除する発生元のリストを指定)
{
"Message": "Success", "ContactOrigins": [ ]
}
{
"Message": "Partial success, Login name does not exist in DB for these contacts",
"ContactOrigins":
[ { "loginName": "acme_user1", "origin": [] },
{ "loginName": "acme_user2", "origin": []
}
]
}
POST /contact_origins/setorigins
http://<uim_server>/uimapi/contact_origins/setorigins
ログイン名(ユーザ名を指定)
発生元(ユーザ用に設定する発生元のリストを指定。以前に設定した発生元が置き換えられます)
[
{
   "loginName": "acme_user1",
"origin": [
         "win2k12-m-ph_hub", "win2k12-m-sh03"
]
},
{
  "loginName": "acme_user2",
"origin": [
       "win2k12-m-ph_hub",
]
}
]
DELETE /contact_origins/{loginname}
http://<uim_server>/uimapi/contact_origins/User1
ログイン名(対応する発生元を削除する場合のユーザ名を指定)
なし
GET /contact_origins/{loginname}
http://<uim_server>/uimapi/contact_origins/User1
ログイン名(対応する発生元を取得する場合のユーザ名を指定)
{
"loginName": "acme_user1", "origin": [ "win2k12-m-ph_hub", "win2k12-m-sh03"
]
}
サブテナンシーの無効化
contact_origins_enabled
オプションを無効にして、ユーザがアカウントに関連付けられているすべてのデバイスおよびその他のリソースを表示できる初期状態に戻すことができます。無効にすると、以前に設定されたコンタクトの発生元はすべてシステムからクリアされます。ユーザの OC 上のデータは、対応する発生元の関連付けに基づいて処理されません。
以下の手順に従います。
  1. 管理者はアドミン コンソールにログインします。
  2. サブテナンシー機能を無効にします。
    1. OC サーバで、
      [ハブ]
      -
      [ロボット]
      -
      [プローブ]
      の順に選択し、
      wasp
      プローブの
      [RAW 設定]
      ページを開きます。
    2. セットアップ
      ]をクリックして設定セクションを表示します。
      Raw Configure setup Sections
    3. contact_origins_enabled
      パラメータの[
      値の編集
      ]オプションを選択します。
      Edit Value
    4. パラメータの値を
      false
      に定義して、サブテナンシー オプションを無効にし、[
      更新
      ]をクリックします。
      Define Parameter Value
    5. Raw 設定
      ]ページの[
      更新
      ]をクリックし、サーバへの変更を保存します。
    6. プライマリ ハブ、残りの OC サーバ、adminconsoleapp パッケージが展開される場所では、
      contact_origins_enabled
      パラメータを
      false
      に設定します。
  3. すべての OC サーバおよびアドミン コンソールで
    wasp
    を再起動します。