Sie können einen Watcher registrieren, der Benachrichtigungen basierend auf bestimmten Kriterien erhält.

Um einen Watcher zu registrieren, können Sie die folgende API aufrufen.

POST /api/v1/notification-watcher

Nach dem Hinzufügen eines Watchers müssen Sie eine „notification_id“ (feature_name.notification_name) bei einer „watcher_id“ registrieren und Benachrichtigungen angeben, die der Watcher erhalten soll. Beachten Sie, dass der Watcher ohne die Registrierung keine Benachrichtigungen erhält. Rufen Sie die folgenden APIs mit den erforderlichen Anforderungsparametern auf, um „notification_id“ zu registrieren und Benachrichtigungen anzugeben. Weitere Informationen zu NSX-Benachrichtigungs-APIs finden Sie unter Handbuch zu NSX-API.

  • PUT /api/v1/notification-watchers/<watcher-id>
  • POST /api/v1/notification-watchers/<watcher-id>/notifications?action=add_uri_filters mit den folgenden Anforderungsparametern:
    • notification_id: Eine Zeichenfolge, die „feature_name.notification_name“ identifiziert, um eine Benachrichtigung anzugeben, die Watcher für die durch „feature_name.notification_name“ identifizierte URI erhalten möchte.
    • uri_filters: Optionale Liste der URIs zum Filtern von Benachrichtigungen basierend auf ihrem Richtlinienpfad. Wenn Sie „uri_filters“ angeben, können Sie anstelle eines bestimmten Werts auch * als Platzhalterzeichen verwenden.

      Wenn „notification_id“ beispielsweise „group.change_name“ ist, lautet das „uri_filter“-Muster „/policy/api/v1/infra/domains/<domain>/groups/<group>“. Sie können das Muster als „/policy/api/v1/infra/domains/domain1/groups/group2“ angeben, um Benachrichtigungen speziell für Domäne1 und Gruppe2 abzurufen. Alternativ können Sie auch das Muster „/policy/api/v1/infra/domains/domain2/groups/*“ angeben, um Benachrichtigungen für alle Gruppen in Domäne2 abzurufen, oder als „/policy/api/v1/infra/domains/*/groups/*“, um Benachrichtigungen für alle Gruppen in allen Domänen zu erhalten.

In der folgenden Tabelle sind die Funktionsnamen und ihre jeweiligen URIs aufgeführt.
Funktionsname Funktionsbeschreibung Benachrichtigungsname Benachrichtigungsbeschreibung URI
group Von der NS-Gruppenfunktion unterstützte Benachrichtigungen. change_notification Gruppenbenachrichtigung, „<domain>“ identifiziert den Domänennamen und „<group>“ identifiziert den Gruppennamen. /policy/api/v1/infra/domains/<domain>/groups/<group>
monitoring Von der Überwachungsfunktion unterstützte Benachrichtigungen. alarm Alarmbenachrichtigungen. „<alarm-id>“ identifiziert eine Alarminstanz. Eine Benachrichtigung wird gesendet, sobald eine Alarminstanz erstellt oder gelöscht wird und wenn die Alarminstanz aktualisiert wird. /api/v1/alarms/<alarm-id>
alarm_status_change_notification Alarmbenachrichtigungen. „<alarm-id>“ identifiziert eine Alarminstanz. Eine Benachrichtigung wird gesendet, wenn eine Alarminstanz erstellt wird und wenn der Statuseigenschaftswert einer Alarminstanz aktualisiert wird. /api/v1/alarms/<alarm-id>
notification

Vom Benachrichtigungs-Framework unterstützte Benachrichtigungen.

 watcher Plattformbenachrichtigung zur Übermittlung von Updates für die Watcher-Konfiguration. „<watcher-id>“ identifiziert den Watcher. /api/v1/notification-watchers/<watcher-id>
watcher_notification Plattformbenachrichtigung zur Übermittlung von Updates für Benachrichtigungen. „<watcher-id>“ identifiziert den Watcher. /api/v1/notification-watchers/<watcher-id>/notifications
service_config Von der Dienstkonfigurationsfunktion unterstützte Benachrichtigungen. change_notification Benachrichtigung zur Dienstkonfiguration. „<domain>“ identifiziert den Domänennamen, „<policy>“ identifiziert die Endpoint-Richtlinie und „<rule>“ identifiziert die Endpoint-Regel. Diese Benachrichtigung wird generiert, wenn eine in der Endpoint-Regel verwendete Dienstkonfiguration aktualisiert wird oder wenn das UPM-Profil aktualisiert wird. /policy/api/v1/infra/domains/<domain>/endpoint-policies/<policy>/endpoint-rules/<rule>
service_insertion

Vom Service Insertion-Modul unterstützte Benachrichtigungen.

Derzeit unterstützt das Service Insertion-Modul Benachrichtigungen für Dienstprofil, Laufzeit der Dienstinstanz und Richtliniengruppen.

 instance_runtime_notification Laufzeitbenachrichtigung der Dienstinstanz. „<service-id>“ identifiziert den Dienst, „<service-instance-id>“ identifiziert die Dienstinstanz. Die Benachrichtigung wird für bereitgestellte und nicht bereitgestellte Vorgänge gesendet. /api/v1/serviceinsertion/services/<service-id>/service-instances/<service-instance-id>/instance-runtimes
profile_notification Benachrichtigung zur Änderung des Dienstprofils. „<service-reference>“ identifiziert den Dienstnamen und „<service-profile>“ identifiziert den Profilnamen. Die Benachrichtigung wird für das Erstellen, Aktualisieren und Löschen von Profilen gesendet. /policy/api/v1/infra/service-references/<service-reference>/service-profiles/<service-profile>
profile_chain_mapping_notification Benachrichtigung über die Zuordnung der Dienstprofilkette. „<service-reference>“ identifiziert den Dienstnamen und „<service-profile>“ identifiziert den Profilnamen. Die Benachrichtigung wird gesendet, wenn ein Profil als Teil einer Dienstkette hinzugefügt oder entfernt wird. /policy/api/v1/infra/service-references/<service-reference>/service-profiles/<service-profile>/service-chain-mappings
profile_nsgroups_notification Benachrichtigung zu Dienstprofil-NSGroups. „<service-reference>“ identifiziert den Dienstnamen und „<service-profile>“ identifiziert den Profilnamen. Diese Benachrichtigung wird immer dann ausgelöst, wenn eine Ost-West-Regel, die nsgroups enthält, mit dem jeweiligen Profil hinzugefügt oder gelöscht wird. /policy/api/v1/infra/service-references/<service-reference>/service-profiles/<service-profile>/group-associations
instance_nsgroups_notification Benachrichtigung zu Dienstinstanz-NSGroups. „<service-id>“ identifiziert den Dienstnamen und „<service-instance-id>“ identifiziert die Dienstinstanz. Diese Benachrichtigung wird immer dann ausgelöst, wenn eine Nord-Süd-Regel, die „nsgroups“ enthält, mit der jeweiligen Instanz hinzugefügt oder gelöscht wird. /api/v1/serviceinsertion/services/<service-id>/service-instances/<service-instance-id>/group-associations