Web サービスを使用してアラーム属性を管理

管理者は、Web サービスを使用してアラーム属性を作成できます。 特定のテナントまたはすべてのテナント(グローバル)に対して作成することができます。
capm360
管理者は、Web サービスを使用してアラーム属性を作成できます。 特定のテナントまたはすべてのテナント(グローバル)に対して作成することができます。
テナント レベルおよびグローバル レベルで同じ属性を作成できます。 テナント レベル属性はテナント ユーザに適用され、グローバル レベル属性は他のすべてのテナント ユーザにのみ適用されます。
これらの Web サービスを使用して、外部属性を管理しないでください。外部属性は、
DX NetOps Spectrum
の特定の MIB 変数に直接対応しています。
詳細については、「アラーム ビュー」を参照してください。
アラーム属性 Web サービスの操作
以下の呼び出しを発行して、アラーム属性 Web サービスで使用可能な操作を確認します。
http://
PC_host
:8181/pc/center/rest/alarmattributes/documentation
Operations
  • PC_host
    :8181
  • NetOps Portal
    ホスト名を指定します。 8181 は必須ポートです。
  • 削除
    指定した ID を使用して属性を削除します。
    URL:
    http://
    PC_host
    :8181/pc/center/webservice/alarmattributes/tenantId/
    {tenantId}
    /attributeId/
    {attributeId}
    • {tenantId}
      希望するテナントのID
    • {attributeId}
      アラーム属性の 16 進数 ID
    HTTP メソッド:
    DELETE
    戻り値の型は、文字列です。
  • delete global
    指定した ID を使用してグローバル属性を削除します。
    URL:
    http://
    PC_host
    :8181/pc/center/webservice/alarmattributes/global/attributeId/
    {attributeId}
    • {attributeId}
      アラーム属性の 16 進数 ID
    HTTP メソッド:
    DELETE
    戻り値の型は、文字列です。
  • get id names
    空の文字列を戻します。 他のWebサービスでは、特定のオブジェクトを識別するために他のメソッドで使用できる識別子のリストを返します。
    URL:
    http://
    PC_host
    :8181/pc/center/webservice/alarmattributes/idNames
    HTTP メソッド:
    GET
  • get list for tenant
    指定したテナントのすべての属性定義のリストを取得します。
    URL:
    http://
    PC_host
    :8181/pc/center/webservice/alarmattributes/tenantId/
    {tenantId}
    • {tenantId}
      希望するテナントのID
    HTTP メソッド:
    GET
    返された XML の XSD:
    http://
    PC_host
    :8181/pc/center/rest/alarmattributes/xsd
  • 追加または更新
    指定したテナントの属性を追加または更新します。
    URL:
    http://
    PC_host
    :8181/pc/center/webservice/alarmattributes/tenantId/
    {tenantId}
    • {tenantId}
      希望するテナントのID
    HTTP method =
    POST
    提供された XML の XSD:
    http://
    PC_host
    :8181/pc/center/rest/alarmattributes/xsd
    返された XML の XSD:
    http://
    PC_host
    :8181/pc/center/rest/alarmattributes/xsd
  • get global list
    すべてのグローバル属性定義のリストを取得します。
    URL:
    http://
    PC_host
    :8181/pc/center/webservice/alarmattributes/global
    HTTP メソッド:
    GET
    返された XML の XSD:
    http://
    PC_host
    :8181/pc/center/rest/alarmattributes/xsd
  • add or update global
    グローバル属性を追加または更新します。
    URL:
    http://
    PC_host
    :8181/pc/center/webservice/alarmattributes/global
    HTTP method =
    POST
    提供された XML の XSD:
    http://
    PC_host
    :8181/pc/center/rest/alarmattributes/xsd
    返された XML の XSD:
    http://
    PC_host
    :8181/pc/center/rest/alarmattributes/xsd
Web サービスを使用してアラーム属性を作成
アラーム属性 Web サービスを使用し、REST クライアントでアラーム属性を作成および設定します。
以下の手順に従います。
  1. NetOps Portal
    サーバへ接続されている REST クライアントをセットアップします。
  2. REST クライアントで URL に以下の形式を使用します。
    http://
    PC_host
    :8181/pc/center/webservice/alarmattributes/tenantId/8
    8 は、デフォルト テナントの ID です。
  3. 以下を選択します。
    POST
    「HTTP」メソッド
    の場合。
  4. NetOps Portal
    へのグローバル管理者アクセス権を持つユーザ アカウントの有効なユーザ名およびパスワードを指定します。
  5. Body Content-type
    として、
    application/XML
    を選択します。
  6. [Body]テキスト セクション内に、以下の XML を追加します。
    <AlarmAttribute>
    <AttributeID>
    HEX_ID
    </AttributeID>
    <Name>
    Attribute_Name
    </Name>
    <Description>
    Attribute_Description
    </Description>
    <Type>
    Value_Type
    </Type>
    <AddAsFilter>true</AddAsFilter>
    <AddAsColumn>true</AddAsColumn>
    </AlarmAttribute>
    • AttributeID
      アラーム属性の 16 進数 ID を指定します。
    • 名前
      このアラーム属性の名前を指定します。
    • 説明
      このアラーム属性の説明を指定します。
    • Type
      以下の使用可能なタイプのいずれかを指定します。
      • 文字列
        たとえば、デバイス名の文字列フィールド
      • ブール値
        たとえば、Boolean値が確認済み
      • ADDRESS_RANGE
        たとえば、IP アドレス、IP アドレス フィールド
      • INTEGER
        数値、たとえば、オカレンス数
      • 16 進数
        16 進値、たとえば、原因コード
      • OCTET_STRING
        数値として処理される文字列値
    • AddAsFilter
      フィルタ リストに属性を追加するかどうかを指定します。
      デフォルト:
      true
    • AddAsColumn
      アラーム ビューに属性を列として追加するかどうかを指定します。 この列はデフォルトでは表示されません。
      デフォルト:
      true
  7. 任意の値を、新しいアラーム属性に使用する値に置き換えます。
    例:
    <AlarmAttribute>
    <AttributeID>0x129e7</AttributeID>
    <Name>Topology Model Name</Name>
    <Description>The Topology Model Name String</Description>
    <Type>STRING</Type>
    <AddAsFilter>true</AddAsFilter>
    <AddAsColumn>true</AddAsColumn>
    </AlarmAttribute>
  8. メソッドを実行します。
  9. 前述の手順を繰り返して、必要な数のアラーム属性を作成します。