グループ Web サービスの構文例

管理 Web サービス › グループ Web サービス › グループ Web サービスの構文例

グループ Web サービスの構文例

グループ Web サービスのパラメータを確認するには、次のコールを発行します。

http://CA Performance Center Server IP Address:8181/pc/center/webservice/groups

サポートされる操作のリストを参照するには、次のコールを発行します。

http://CA Performance Center Server IP Address:8181/pc/center/rest/groups/documentation

グループツリーの最上位レベルのグループの下にあるすべてのグループのリスト（デフォルトでは［All Groups］）を取得するには、groupPath パラメータまたは groupItemId パラメータが使用できます。

groupPath パラメータを使ってデフォルトグループを識別し、次のコールを発行します。

http://CA Performance Center Server IP Address:8181/pc/center/webservice/groups/
groupPath/All%20Groups

注：いくつかの REST クライアントを使用する場合、「All%20Groups」ではなく、「All Groups」構文が必要です。しかし、一般的に、ブランクのスペースは URL 内で有効ではありません。

デフォルトグループ（その groupItemId 値は 1）を識別するために groupItemId パラメータを使って、次のコールを呼び出します。

http://CA Performance Center Server IP Address:8181/pc/center/webservice/
groups/groupItemId/1

サブグループ構文

指定したグループの下のすべてのサブグループのリストを取得するには、次の 2 つのオプションがあります。

groupPath パラメータを使用する。
groupItemId パラメータを使用する。

groupPath パラメータを使ってグループを特定し、次のコールを発行すると、返された XML にそのサブグループが一覧表示されます。

http://CA Performance Center Server IP address:8181/pc/center/webservice/
groups/groupPath/All%20Groups%2FInventory

groupItemId パラメータを使ってグループを特定し、次のコールを発行すると、返された XML にそのサブグループが一覧表示されます。

注：デフォルトの「Inventory」グループの groupItemId は 5 です。

http://CA Performance Center Server IP address:8181/pc/center/webservice/
groups/groupItemId/5

返される XML には、そのグループに適用されるあらゆるグループルールの構文が含まれます。そのため、ユーザインターフェースで作成するさまざまなルールをテストし、生成された構文を調べることをお勧めします。

サイトグループ構文

POST コマンド内の以下の XML でサイトグループが作成されます（例の値は、新しいサイトグループに適した任意の値に置き換えてください）。

<GroupTree path="/All Groups">
   <Group name="East Coast USA" desc="This is a site group"
   inherit="true" type="site group" location="North America"
   bHourID="99990" timeZone="EST"/>
</GroupTree>

inherit

グループにグループメンバの子アイテムを含めるかどうかを指定します。たとえば、「inherit」属性を true に設定すると、デバイスがグループに追加された際に、デバイスインターフェースはグループメンバになります。

type

グループのタイプを指定します。以下の値を受け入れます。

custom group：ユーザが作成したグループ。
site group：物理サイトを表す、ユーザが作成したグループ。
system group：変更または削除できない事前定義済みグループ
automatic group： Data Aggregator 以外のデータソースのアイテムに基づいて事前定義されたグループ。変更や削除はできません。

bHourID

（オプション）このサイトグループと関連付ける必要がある、内部的に割り当てられた営業時間定義の識別子。

timeZone

（オプション）このサイトグループと関連付けるタイムゾーン。タイムゾーンを関連付けることができるのはサイトグループのみで、カスタムグループとは関連付けられません。

グループルール

グループルールは正規表現に加えて、多重比較をサポートします。たとえば、次の XML の構文を使用すると、名前が単語「Cisco」から始まるデバイスを追加するグループルールをポストします。

<Match>
   <Compare readOnly="true" using="MEMBER_OF">
       <Property name="ItemID" type="device"/>
           <Value reference="/All Groups">1</Value>
   </Compare>
   <Compare readOnly="false" using="STARTS_WITH">
      <Property name="DisplayName" type="device"/>
           <Value>Cisco*</Value>
   </Compare>
</Match>

AllowDeletes

グループ削除は、［allowDeletes］パラメータを［true］に設定する必要があります。サブグループを削除する場合、コンテナグループにこのパラメータを適用します。たとえば、この XML は、以下のサブグループを削除します： All Groups\Texas\Austin:

<GroupTree path="/All Groups/Texas">
   Group name="USA" desc="Group to represent the entire
   United States" allowDeletes="true" type="custom group"/> 
</GroupTree>

グループパス構文については、スラッシュ文字は、ポストする XML ドキュメントに適切です。この例では、「/All Groups/Texas/Austin」というグループ構造をすでに持っていると仮定します。

<GroupTree inheritDefault="true" path="/All Groups/Texas/Austin">
    <Group desc="" inherit="true" location="" name="CA Office" type="custom group">
        <Group desc="" inherit="true" location="" name="Austin Lab" type="custom group"/>
    </Group>
    <Group desc="" inherit="true" location="" name="Austin Data Center" type="custom group"/>
</GroupTree>

ただし、Web サービスリクエスト用の URL で、円記号文字をグループパスに使用します。スラッシュは、ブラウザによって誤って解釈されます。