Web サービスを使用した保守インジケータの管理

管理者は、Web サービスを使用して保守インジケータを作成することができます。 保守インジケータは、保守が実行されている時間を表します。 保守インジケータをスケジュールすると、ビューは網かけで保守を示します。
capm300
管理者は、Web サービスを使用して保守インジケータを作成することができます。 保守インジケータは、保守が実行されている時間を表します。 保守インジケータをスケジュールすると、ビューは網かけで保守を示します。
保守インジケータは、サイト グループ内のすべてのデバイスおよびコンポーネントに適用されます。 関連付けられたサイト グループがコンテキストで選択されると、ダッシュボード間を移動したときに、該当するビューに保守インジケータが表示されます。 各ビューのサブタイトルは、保守インジケータがビューに適用されるかどうかを示します。
サブグループは、サイト グループから保守インジケータを直接継承しません。 保守インジケータを関連する各サブグループに関連付けます。 ただし、ビューを表示する際に、これらのフィルタは選択されたサイト グループに基づくすべてのアイテムに適用されます。 選択されたサイト グループのフィルタは、そのグループおよび任意のサブグループ内のすべてのアイテムに適用されます。 選択されたサイト グループをサブグループに変更すると、親グループのフィルタは適用されなくなります。
参照グループは、関連付けられた保守インジケータを元のサイト グループから継承します。
保守インジケータ Web サービスの操作
保守インジケータ Web サービスで使用可能な操作を確認するには、次のコールを発行します。
http://
PC_host
:8181/pc/center/rest/maintenanceindicators/documentation
Operations
  • PC_host
    :8181
    NetOps Portal
    IP アドレスのポートを指定します。 8181 は必須ポートです。
  • get list
    認証済みのユーザに対するすべての保守インジケータ定義のリストを取得します。
    URL:
    http://
    PC_host
    :8181/pc/center/webservice/maintenanceindicators/
    HTTP メソッド:
    GET
    返される XML の XSD:
    http://
    PC_host
    :8181/pc/center/rest/maintenanceindicators/xsd
  • add
    指定された XML から保守インジケータ定義を作成します。
    URL:
    http://PC_host:8181/pc/center/webservice/maintenanceindicators/tenantId/
    {tenantId}
    • {tenantId}
      目的のテナントの ID を指定します。
    HTTP メソッド:
    POST
    提供される XML の XSD:
    http://
    PC_host
    :8181/pc/center/rest/maintenanceindicators/xsd
    返される XML の XSD:
    http://
    PC_host
    :8181/pc/center/rest/maintenanceindicators/xsd
  • 削除
    指定された ID を使用して、保守インジケータ定義を削除します。
    URL:
    http://
    PC_host
    :8181/pc/center/webservice/maintenanceindicators/id/
    {maintenanceIndicatorId}
    • {maintenanceIndicatorId}
      目的の保守インジケータの ID を指定します。
    HTTP メソッド:
    DELETE
    戻り値の型は、文字列です。
  • get
    特定の保守インジケータ定義を取得します。
    URL:
    http://
    PC_host
    :8181/pc/center/webservice/maintenanceindicators/id/
    {maintenanceIndicatorId}
    HTTP メソッド:
    GET
    返される XML の XSD:
    http://
    PC_host
    :8181/pc/center/rest/maintenanceindicators/xsd
  • get id names
    特定のオブジェクトを識別するために他のメソッドで使用できる識別子のリストを返します。 この Web サービスでは、空のリストが返されます。
    URL:
    http://
    PC_host
    :8181/pc/center/webservice/maintenanceindicators/idNames
    HTTP メソッド:
    GET
  • get list for tenant
    指定されたテナントに対するすべての保守インジケータ定義のリストを取得します。
    URL:
    http://
    PC_host
    :8181/pc/center/webservice/maintenanceindicators/tenantId/
    {tenantId}
    • {tenantId}
      目的のテナントの ID を指定します。
    HTTP メソッド:
    GET
    返される XML の XSD:
    http://
    PC_host
    :8181/pc/center/rest/maintenanceindicators/xsd
  • 更新
    指定された XML から、指定された保守インジケータ定義を更新します。
    URL:
    http://
    PC_host
    :8181/pc/center/webservice/maintenanceindicators/tenantId/
    {tenantId}
    /id/
    {maintenanceIndicatorId}
    HTTP メソッド:
    PUT
    提供される XML の XSD:
    http://
    PC_host
    :8181/pc/center/rest/maintenanceindicators/xsd
    返される XML の XSD:
    http://
    PC_host
    :8181/pc/center/rest/maintenanceindicators/xsd
Web サービスを使用した保守インジケータの作成
保守インジケータ Web サービスを使用して、保守インジケータの作成および設定を行うために、任意の REST クライアントを使用します。
以下の手順に従います。
  1. NetOps Portal
    サーバへ接続されている REST クライアントをセットアップします。
  2. REST クライアントで URL に以下の形式を使用します。
    http://
    PC_host
    :8181/pc/center/webservice/maintenanceindicators/tenantId/8
    8 は、デフォルト テナントの ID です。
  3. 以下を選択します。
    POST
    「HTTP」メソッド
    の場合。
  4. NetOps Portal
    へのグローバル管理者アクセス権を持つユーザ アカウントの有効なユーザ名およびパスワードを指定します。
  5. Body Content-type
    として、
    application/XML
    を選択します。
  6. [Body]テキスト セクション内に、以下の XML を追加します。
    <MaintenanceIndicator>
    <Name>Maintenance Indicator Name</Name>
    <Description> Maintenance Indicator Description</Description>
    <MaintenanceYear>Year</MaintenanceYear>
    <MaintenanceMonth>Month</MaintenanceMonth>
    <MaintenanceDay>Day</MaintenanceDay>
    <StartHour>StartHour</StartHour>
    <EndHour>EndHour</EndHour>
    <SelectedSites>
    <SelectedSite>SiteID</SelectedSite>
    <SelectedSite>SiteID</SelectedSite>
    </SelectedSites>
    </MaintenanceIndicator>
    • Name
      この保守インジケータ定義の名前を指定します。
    • 説明
      この保守インジケータ定義の説明を指定します。
    • MaintenanceYear
      関連する保守が実行される 4 桁の年を指定します。
    • MaintenanceMonth
      関連する保守が実行される月(1 ~ 12)を指定します。
    • MaintenanceDay
      関連する保守が実行される日(1 ~ 31)を指定します。
    • StartHour
      関連する保守が実行される時間(0 ~ 23)を指定します。
    • EndHour
      関連する保守が実行される時間(1 ~ 24)を指定します。
    • SelectedSites
      (オプション)この保守インジケータ定義を割り当てるサイト ID を含む 1 つ以上のタグを指定します。 割り当てられたサイトを使用せずに定義を作成するには、このパラメータを省略します。
  7. 任意の値を、新しい保守インジケータに対して使用する値に置換します。
    たとえば、以下のパラメータを指定します。ここで、3569 は
    Framingham
    サイトのサイト ID です。
    <MaintenanceIndicator>
    <Name>Framingham router maintenance</Name>
    <Description>Upgrade of the network for framingham</Description>
    <MaintenanceYear>2016</MaintenanceYear>
    <MaintenanceMonth>8</MaintenanceMonth>
    <MaintenanceDay>5</MaintenanceDay>
    <StartHour>19</StartHour>
    <EndHour>22</EndHour>
    <SelectedSites>
    <SelectedSite>510</SelectedSite>
    <SelectedSite>511</SelectedSite>
    </SelectedSites>
    </MaintenanceIndicator>
  8. メソッドを実行します。
  9. 必要な数の保守インジケータを作成するまで、前述の手順を繰り返します。