コンポーネント XML 構造

デバイス コンポーネントは XML を使用して、デバイスと関連付けられているコンポーネント アイテムのクラスを定義します。 事前に定義された多くのコンポーネントが提供されますが、通常、カスタム コンポーネントはカスタム メトリック ファミリに対して定義されます。 コンポーネントは、npc に対してコンポーネント アイテムを同期するオプションの ItemSyncDefinition を定義できます。 その後コンポーネントは、インベントリ リスト、グループ、およびコンテキスト ページ内で参照できます。
capm280
HID_Component_XML_Structure
デバイス コンポーネントは XML を使用して、デバイスと関連付けられているコンポーネント アイテムのクラスを定義します。 事前に定義された多くのコンポーネントが提供されますが、通常、カスタム コンポーネントはカスタム メトリック ファミリに対して定義されます。 コンポーネントは、
NetOps Portal
に対してコンポーネント アイテムを同期するオプションの ItemSyncDefinition を定義できます。 その後コンポーネントは、インベントリ リスト、グループ、およびコンテキスト ページ内で参照できます。
XML のいくつかのプロパティは特定の順序でリスト化する必要があります。 XML の例に含まれているプロパティと、以下の説明に記載されているプロパティは、推奨される順序で表示されています。
2
例:
この例では、frPVC という名前のカスタム コンポーネントを示しています。
ブラウザでコンポーネント XML を表示する場合、特定のタグが非表示になります。 このため、REST クライアントからのみ、コンポーネント XML をコピーして貼り付けてください。
<?xml version="1.0" encoding="UTF-8"?>
<!--Auto-generated by the type catalog local manager.-->
<DataModel namespace="http://im.ca.com/inventory" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="ComponentFacet.xsd">
<Author>Custom</Author>
<Version>1.0</Version>
<FacetType name="frPVC">
<Documentation>A Frame Relay PVC</Documentation>
<FacetOf namespace="http://im.ca.com/core" name="Item" />
<Component>true</Component>
<ItemSyncDefinition itemTypeName="component" itemSubtypeName="frpvc" itemTypeLabel="FrameRelayPVC" itemTypeLabelPlural="FrameRelayPVCs" categorize="false" groupBy="false" context="true">
</ItemSyncDefinition>
</FacetType>
</DataModel>
カスタム コンテキスト ページへのリンクを有効にするには、ItemSyncDefinition の context を “true” に設定します。 このページには、frPVC デバイス コンポーネントから移動できます([インベントリ]-[デバイス コンポーネント]リストに表示)。 "true" に設定すると、メトリック ファミリを "context" として選択できるようになります。これにより、カスタム メトリック ファミリが動的トレンド タイプのチャートで使用可能になります。
基本プロパティ
カスタム コンポーネントの基本プロパティは、ユーザが作成したその他のカスタム コンポーネントとの区別に役立ちます。
以下のリストでは、ドキュメントのプロパティのみを更新できます。
  • FacetType/name
    コンポーネント名を指定します。 各コンポーネントには、システム内部で識別するための一意の名前が必要です。 将来的に、同様のコンポーネントとのネーミング競合の可能性が最も小さいと考えられる名前を慎重に選択してください。 たとえば、これらのコンポーネント名が一意であることを保証する命名スキームを定義します。
    この名前は外部には表示されません。 ユーザ インターフェースにコンポーネント名を表示するには、
    ItemSyncDefinition
    itemTypeLabel
    、および
    itemTypeLabelPlural
    エレメントを使用します。
    可能な値:
    英数字およびアンダースコア。 ドットおよびダッシュは使用できません。
    • Documentation
      コンポーネント用の内部コメントを指定します。 これらのコメントを有効に活用するために、コメントを追加または変更した理由および時期を記述します。
      可能な値:
      プレーン テキスト
      更新による影響:
      なし
      更新が有効化されるタイミング:
      即時
      更新の有効化に必要なアクション:
      なし
      このプロパティは、
      FacetType/name
      の下にリストされている必要があります。 このプロパティおよび
      FacetOf
      プロパティは、XML 内で
      Component
      および
      ItemSyncDefinition
      プロパティの前にリストされている必要があります。
    • FacetOf
      このコンポーネントがアイテムであることを示します。
      可能な値: namespace="http://im.ca.com/core" name="Item"
      このプロパティおよび
      Documentation
      プロパティは、XML 内で
      Component
      および
      ItemSyncDefinition
      プロパティの前にリストされている必要があります。
    • コンポーネント
      このアイテムがコンポーネントであることを示します。
      可能な値:
      true
ItemSyncDefinition
ItemSyncDefinition 属性はオプションです。 この属性は、コンポーネント アイテムが
NetOps Portal
でどのように同期され表示されるかを指定します。 コンポーネント アイテムが指定されない場合、
NetOps Portal
の[インベントリ]リストには表示されません(たとえばデバイス コンポーネント)。 しかし、今までどおりカスタム ビューでレポートできます。
それ以外の場合、更新を有効にするために必要なアクションはありません。
  • ItemSyncDefinition/itemTypeName
    アイテムのタイプを指定します。 カスタム コンポーネントについては、この値は「component」である必要があります。
    更新の可否:
    いいえ
    可能な値:
    Component
  • ItemSyncDefinition/itemSubtypeName
    NetOps Portal
    でコンポーネントの内部名を指定します。 この値はすべてのコンポーネントに対して一意である必要があります。 将来的に標準およびカスタムのコンポーネントとの競合を回避する命名規則を使用します。たとえば、ユーザの組織「acmeFan」を表す接頭辞を使用します。
    更新の可否:
    いいえ
    可能な値:
    英数字(すべてのコンポーネントに対して一意)
  • ItemSyncDefinition/itemTypeLabel
    このタイプの単一コンポーネントを表示するときに使用するユーザ インターフェースのラベルを指定します。 たとえば、この値は[インベントリ]-[デバイス コンポーネント]の UI [タイプ]列)で使用されます。
    更新の可否:
    はい
    可能な値:
    プレーン テキスト(すべてのコンポーネントに対して一意)
    更新による影響:
    ラベルは
    NetOps Portal
    [インベントリ]ユーザ インターフェースに表示されます。
    更新が有効化されるタイミング:
    再同期が発生し、15 分以内に更新が完了する場合。
  • ItemSyncDefinition/itemTypeLabelPlural
    このタイプの複数のコンポーネントを表示するときに使用するユーザ インターフェースのラベルを指定します。 [インベントリ]メニュー(groupBy を参照)および[グループ]名(categorizeを参照)によって使用されます。
    更新の可否:
    はい
    可能な値:
    プレーン テキスト(すべてのコンポーネントに対して一意)
    更新による影響:
    ラベルは
    NetOps Portal
    [インベントリ]の UI に表示されます。
    更新が有効化されるタイミング:
    再同期が発生し、15 分以内に更新が完了する場合。
  • ItemSyncDefinition/categorize
    NetOps Portal
    で、[インベントリ]-[すべてのアイテム]の下にインベントリ グループが作成されるようにします。 このグループには、このコンポーネント タイプのすべてのアイテムが含まれています。 グループは「
    {itemTypeLabelPlural}
    」と命名されます。
    作成されるインベントリ グループはダッシュボードのレポートには使用できません。 このグループはインベントリ目的専用です。 グループがレポート用に選択された場合、データは表示されません。 その他のデバイス ベースのインベントリ グループ([インベントリ]-[すべてのアイテム])は、ルータおよびサーバのようにレポートに使用できます。 ただし、コンポーネント ベースのインベントリ グループ(デバイス コンポーネントなど)は使用できません。
    更新の可否:
    はい
    可能な値:
    true、false
    更新による影響:
    NetOps Portal
    でインベントリ グループを作成または削除します。
    NetOps Portal
    グループ管理者の場合、[グループの管理]ページで、[インベントリ]-[すべてのアイテム]-[
    {itemTypeLabelPlural}
    ]の下にグループが作成されます。
    更新が有効化されるタイミング:
    再同期が発生し、30 分以内に更新が完了する場合。
    更新の有効化に必要なアクション:
    通常 30 分以内にアイテムがグループに表示されます。 表示されない場合は、手動で Data Aggregator データ ソースを再同期します。 [再同期]の確認ボタンをクリックする前に、[完全な再同期を実行]を選択します。
  • ItemSyncDefinition/groupBy
    NetOps Portal
    で、このコンポーネント アイテム タイプのすべてのアイテムを表示するためのインベントリ メニュー アイテム([インベントリ]の下)が作成されるようにします。 メニューは「
    {itemTypeLabelPlural}
    」と命名されます。 この属性はまた、ビュー コンテキストを設定する場合に[コンテキスト タイプ]ドロップダウン リストにコンポーネント タイプが表示されるようにします。 False の場合、コンポーネントは、[インベントリ]の[デバイス コンポーネント]テーブルに、「
    {itemTypeLabel}
    」タイプで表示されます。 groupBy プロパティはグループを作成しません(「categorize」を参照)。
    更新の可否:
    はい
    可能な値:
    true、false
    更新による影響:
    true の場合、メニュー アイテムが作成され、false の場合は削除されます。
    更新が有効化されるタイミング:
    再同期が発生し、15 分以内に更新完了が可能な場合。
  • ItemSyncDefinition
    /
    context
    各コンポーネント アイテム名を[インベントリ]コンポーネント ビュー内でコンテキスト ハイパーリンクにします。このリンクをクリックすると、個別のコンポーネント コンテキスト ページに移動します。
    更新の可否:
    はい/いいえ
    可能な値:
    プレーン テキスト
    更新による影響:
    各コンポーネント アイテム名を[インベントリ]コンポーネント ビュー内でコンテキスト ハイパーリンクにします。
    更新が有効化されるタイミング:
    再同期が発生し、15 分以内に更新完了が可能な場合。
ItemSyncDefinition の削除
ItemSyncDefinition を完全に削除するには特定の手順が必要です。
以下の手順に従います。
  1. <ItemSyncDefinition> の開始タグおよび終了タグを含む ItemSyncDefinition セクションを削除します。
  2. Data Aggregator にコンポーネント変更を適用したら、
    NetOps Portal
    に管理者としてログインします。
  3. [データ ソース]ページで
    DataAggregator データソースを選択します。
  4. 再同期
    ]ボタンをクリックします。
  5. [完全な再同期を実行]オプションを選択し、[再同期]の確認ボタンをクリックします。
    再同期処理が開始します。 変更が同期されるには 15~30 分必要です。
    このプロセスが完了したら、ItemSyncDefinition がコンポーネントに対して定義した
    NetOps Portal
    の動作がすべて削除されます。
カスタム コンポーネントのサポートされていないプロパティ
以下のプロパティは、カスタム コンポーネントに対してサポートされて
いない
ため、XML に存在してはなりません。
  • 属性
  • Web サービス
  • ItemSyncDefinition/isDeviceComponent
  • ItemSyncDefinition/mapped
  • ItemSyncDefinition/ItemProperty