Model-gedreven telemetrie op Cisco IOS-XE apparaten configureren met YANG Suite

Inleiding

Dit document beschrijft hoe u model-gedreven telemetrie kunt configureren op Cisco IOS®-XE-apparaten met het gebruik van YANG Suite om voorbeelden van Telemetry Remote Procedure Calls (RPCs) uit te voeren.

Voorwaarden

Vereisten

Cisco raadt kennis van de volgende onderwerpen aan:

• Kennis van YANG is nodig om de gegevens te begrijpen die nodig zijn bij het gebruik van telemetrie.
• Kennis van NETCONF-bewerkingen, zoals get, get-config, edit-config.

Gebruikte componenten

De informatie in dit document is gebaseerd op de volgende software- en hardware-versies:

• CSR100V met Cisco IOS XE 17.3.3
• Cisco YANG Suite versie 2.8

De informatie in dit document is gebaseerd op de apparaten in een specifieke laboratoriumomgeving. Alle apparaten die in dit document worden beschreven, hadden een opgeschoonde (standaard)configuratie. Als uw netwerk live is, moet u zorgen dat u de potentiële impact van elke opdracht begrijpt.

Verwante producten

Dit document kan ook worden gebruikt met deze hardware- en softwareversies: Cisco IOS XE-apparaten, inclusief Cisco Catalyst 9000 switches, Cisco ASR 1000, ISR 4000 en CSR 1000 routers.

Achtergrondinformatie

YANG Suite moet worden geïnstalleerd. Ga voor meer informatie over de installatie van YANG Suite naar de documentatie of de Github-opslagplaats.

NETCONF-YANG moet worden geconfigureerd en uitgevoerd op het apparaat, zelfs als NETCONF niet wordt gebruikt. Ga voor meer informatie over de NETCONF-configuratie naar de documentatie.

Een apparaatprofiel, een YANG-opslagplaats en een YANG-modulereeks die aan het apparaat van belang is gekoppeld, moeten in YANG Suite bestaan. Voor meer informatie over het maken van een apparaatprofiel, een YANG-opslagplaats en een YANG-moduleset bezoek de documentatie van de YANG Suite onder Apparaatprofielen beheren.

Informatie over model-gedreven telemetrie

Telemetrie is een geautomatiseerd communicatieproces waarbij metingen en andere gegevens worden verzameld op afgelegen of ontoegankelijke punten en worden verzonden naar de ontvangende apparatuur voor bewaking. Model gedreven telemetrie biedt een mechanisme om YANG-gemodelleerde data naar een data collector te streamen.

Toepassingen kunnen zich abonneren op specifieke gegevensposten die ze nodig hebben met het gebruik van op standaarden gebaseerde YANG-datamodellen via NETCONF-, RESTCONF- of gRPC Network Management Interface-protocollen (gNMI). Er kunnen ook abonnementen worden gemaakt met de opdrachtregel (CLI).

Gestructureerde gegevens worden gepubliceerd op een bepaald ritme (periodiek), of bij verandering, gebaseerd op de abonnementscriteria en het gegevenstype.

telemetriefollen

In systemen die telemetrie gebruiken, spelen verschillende rollen. In dit document worden deze telemetriefollen beschreven:

• Uitgever: Netwerkelement dat de telemetriegegevens verstuurt.
• Ontvanger: Ontvangt de telemetriegegevens. Dit wordt ook wel de verzamelaar genoemd.
• Controller: Netwerkelement dat abonnementen maakt maar de telemetriegegevens niet ontvangt. De telemetriegegevens die bij de abonnementen horen, gaan naar ontvangers. Dit wordt ook wel de managementagent of managemententiteit genoemd.
• Abonnee: Netwerkelement dat abonnementen maakt. Technisch gezien, hoewel dit niet ook de ontvanger hoeft te zijn, zijn beide in dit document hetzelfde.

Overzicht van abonnementen

Abonnementen zijn items die associaties creëren tussen telemetriefollen, en de data definiëren die tussen hen wordt verzonden.

Er worden twee typen abonnementen gebruikt in telemetrie op Cisco IOS XE-systemen: dynamische en geconfigureerde abonnementen.

Dynamische abonnementen worden gecreëerd door klanten (de abonnee) die verbinding maken met de uitgever, ze worden beschouwd als inbellen. Geconfigureerde abonnementen zorgen ervoor dat de uitgever verbindingen met ontvangers initieert, waardoor ze als uitbel worden beschouwd.

Identifiers voor abonnementen

Abonnementen worden geïdentificeerd door een 32-bits positieve integerwaarde. De ID's voor geconfigureerde abonnementen worden ingesteld door de controller en voor dynamische abonnementen worden ingesteld door de uitgever.

Specificatie van gegevensbron

De bronnen van telemetriegegevens in een abonnement worden gespecificeerd door het gebruik van een stroom en een filter. De term stream verwijst naar een reeks gerelateerde gebeurtenissen. RFC 5277 definieert een gebeurtenisstroom als een verzameling gebeurtenismeldingen die overeenkomen met bepaalde doorstuurcriteria.

Cisco IOS XE ondersteunt twee stromen: yang-push en yang-notif-native.

Normaal gesproken wordt de reeks gebeurtenissen uit een stream gefilterd. Er worden verschillende filtertypen gebruikt voor verschillende stroomtypen.

In dit document wordt yang-push gebruikt als het type stream en worden XPath-filters gebruikt.

Configureren

Een periodiek dynamisch abonnement configureren met YANG Suite

Dynamische abonnementen worden gemaakt door abonnees die verbinding maken met de uitgever en een oproep doen voor het maken van een abonnement met behulp van een mechanisme binnen die verbinding, meestal een RPC. De levensduur van het abonnement is beperkt tot de levensduur van de verbinding tussen de abonnee en de uitgever, en telemetriegegevens worden alleen naar die abonnee verzonden. Deze abonnementen blijven niet bestaan als de uitgever of de abonnee opnieuw wordt opgestart. U kunt dynamische abonnementen maken met behulp van de in-band <establishment-subscript> RPC. Het <setup-abonnement>RPC wordt van een IETF-telemetrieabonnee naar het netwerkapparaat verzonden. De stroom, xpath-filter en periodevelden in de RPC zijn verplicht.

Wanneer een RPC wordt verzonden, bevat het RPC-antwoord van een uitgever een bericht met een element dat een resultaatstring bevat.

Deze tabel geeft het antwoord en de reden voor het antwoord weer in een <rpc-antwoord>-bericht:

U kunt een RPC verzenden vanuit YANG Suite om een periodiek abonnement te configureren.

Stappen om het XPath-filter te verkrijgen

Om het XPath-filter te verkrijgen kunt u gebruik maken van YANG Suite zodra u de gegevens hebt gedefinieerd die u moet streamen. In dit voorbeeld, is de informatie van geheugenstatistieken de gegevens aan stroom.

Stap 1. Selecteer in YANG Suit onder Protocollen > NETCONF de YANG-set die is gekoppeld aan het gebruikte apparaat. In dit voorbeeld heet de YANG Set CSR1000V.

Stap 2. Laad de YANG module die de gegevens van belang bevat. In dit voorbeeld is het Cisco-IOS-XE-memory-oper.

Stap 3. In de YANG-boom vind de knoop die u wilt verkrijgen de XPath-filter voor, in dit voorbeeld is geheugen-statistiek, klik met de rechtermuisknop op het en selecteer Eigenschappen.

Stap 4. In het pop-upvenster dat wordt weergegeven, zijn er 2 eigenschappen die samen het XPath-filter definiëren. Deze waarden zijn Xpath en Prefix.

Stappen voor het maken van een periodiek NETCONF dynamisch abonnement

Om een periodiek NETCONF dynamisch abonnement te maken, moet u de IETF-event-notification YANG module gebruiken.

Stap 1. Selecteer in YANG Suit onder Protocollen > NETCONF de YANG-set die is gekoppeld aan het gebruikte apparaat. In dit voorbeeld heet de YANG Set CSR1000V.

Stap 2. Laad de IETF-event-notifications YANG Module.

Stap 3. De NETCONF-handeling moet een andere RPC zijn.

Stap 4. Selecteer het gewenste apparaat in het vervolgkeuzemenu Apparaat en klik vervolgens op Apparaatvenster openen in een nieuw venster of op een nieuw tabblad.

Stap 5. Klik in het afzonderlijke venster dat nu wordt geopend op Start Session om een actieve NETCONF-sessie met het apparaat op te starten. Dit is een voorbeeld van een gevestigd NETCONF-sessievenster.

Stap 6. Ga terug naar het vorige venster. Vouw in de knooppunten onder de structuur voor ietf-event-notification de knooppunt voor het opzetten van een abonnement uit en kies de invoer.

Stap 7. U moet de waarden voor stream, filter en update-trigger definiëren.

stroom: yang-push.

Filter: xpath-filter

Het XPath-filter moet deze indeling hebben:

/prefix:xpath

In dit voorbeeld, met het gebruik van de parameters die in Stappen worden verkregen om de sectie van de Filter van XPath te verkrijgen.

/memory-ios-xe-oper:memory-statistics/memory-statistics

Tip: Let op de positie van de "/" in het XPath-filter

Stap 8. De update-trigger is een waarde in centiseconden (1/100 van een seconde). Een periode van 1000 resulteert in het krijgen van updates elke 10 seconden.

Stap 9. Zodra de stream-, filter- en update-trigger-waarden zijn geleverd, klikt u op Build RPC en een RPC zoals die in dit beeld wordt getoond, zal verschijnen.

Stap 10. U kunt nu op RPC uitvoeren klikken en een periodiek NETCONF-inbelabonnement maken.

Stap 11. RPC-berichten verschijnen nu in het venster waar de NETCONF-sessie is ingesteld.

Dit beeld is een voorbeeld van de verzonden RPC en het RPC-antwoord ontvangen met een OK bericht dit betekent dat het abonnement succesvol was.

Dit beeld is een voorbeeld van de gegevens van geheugenstatistieken die om de 10 seconden worden ontvangen.

Dynamisch abonnement op Aanpassen aan YANG Suite configureren

Alle stappen die in de sectie Een periodiek abonnement met YANG Suite configureren worden aangegeven, zijn van toepassing op deze sectie, het enige verschil is in de update-trigger waarde waar u een demping-periode met een waarde van 0 moet definiëren, is geen andere waarde mogelijk.

Dit is een voorbeeld van een RPC om een abonnement op verandering voor CDP burengegevens te vestigen.

Een periodiek geconfigureerd abonnement met YANG Suite configureren

De gevormde abonnementen worden gecreëerd door beheersverrichtingen op de uitgever door controlemechanismen, en omvatten uitdrukkelijk de specificatie van de ontvanger van de telemetriegegevens die door een abonnement worden bepaald. Deze abonnementen blijven bestaan over reboots van de uitgever wanneer ze deel gaan uitmaken van de configuratie van het apparaat. 

Configureerde inbelabonnementen worden op het apparaat geconfigureerd met een van deze methoden:

• Gebruik van configuratie CLI’s om de configuratie van het apparaat te wijzigen via console/VTY.
• Gebruik van NETCONF/RESTCONF om het gewenste abonnement te configureren.

Dit document beschrijft niet hoe u een uitbelabonnement met de CLI kunt configureren, maar toont in plaats daarvan hoe u een NETCONF RPC-bericht kunt verzenden vanuit YANG Suite om een uitbelabonnement te configureren.

Voor geconfigureerde abonnementen is het gRPC-protocol beschikbaar en kan het alleen worden gebruikt met de yang-push-stream. Alleen Key-value Google Protocol Buffers (kvGPB) codering wordt ondersteund met het gRPC transportprotocol.

U kunt YANG Suite gebruiken als ontvanger om voorbeeldabonnementen voor uitbellen te testen.

Om een periodiek geconfigureerd abonnement te maken, moet u de Cisco-IOS-XE-mdt-cfg YANG module gebruiken.

Stap 1. Voer in YANG Suite onder Protocollen > gRPC Telemetry IP-adres en poort in en klik vervolgens op Telemetry Receiver voor YANG Suite om te beginnen met luisteren op het aangegeven IP-adres en poort.

Opmerking: Als gRPC Telemetry optie niet beschikbaar is, kan de plugin worden geïnstalleerd via Admin > Manager plugins pagina in YANG Suite

Stap 2. Selecteer onder Protocollen > NETCONF de YANG-set die is gekoppeld aan het gebruikte apparaat. In dit voorbeeld heet de YANG Set CSR1000V.

Stap 3. Laad de Cisco-IOS-XE-mdt-cfg YANG module.

Stap 4. De NETCONF-handeling moet worden bewerkt-geconfigureerd.

Stap 5. Kies het te gebruiken apparaat.

Stap 6. Onder de Cisco-IOS-XE-mdt-cfg-boom moeten deze waarden worden gedefinieerd in het mdt-abonnementsknooppunt: abonnement-id, stream, codering, periode en xpath-filter. En ook de informatie over de ontvanger: IP-adres, poort en protocol.

Stap 7. Deze waarden worden bij dit voorbeeld gebruikt:

Abonnementsnummer: 100

stroom: yang-push

codering: encode-kvgpb

periode: 1000

Filter voor pad: /memory-ios-xe-oper:memory-statistics/memory-statistics

Informatie over de ontvanger moet worden gedefinieerd

adres: <IP-adres>

port: <poort>

protocol: grpc-TCP

Stap 8. Klik op de knop Build RPC.

Stap 9. Klik op RPC uitvoeren.

Stap 10. Indien geslaagd, dan wordt onder Protocollen > RPC Telemetry, informatie nu ontvangen.

Een geconfigureerd abonnement op wijzigingen configureren met YANG Suite

Om een On-Change wijzerplaat-out-abonnement te configureren wordt hetzelfde proces gevolgd dat wordt beschreven onder Een periodiek geconfigureerd abonnement met YANG Suite wordt gevolgd. De enige waarde die verandert is het niet-sync-aan-start-blad dat op false moet worden ingesteld.

Dit beeld is een voorbeeld RPC voor een on-change geconfigureerd abonnement.

Verifiëren

Gebruik deze sectie om te controleren of uw configuratie goed werkt.

Informatie over telemetrieabonnementen weergeven op een Cisco IOS XE met telemetrieabonnement alles tonen.

Device# show telemetry ietf subscription all
 Telemetry subscription brief

  ID               Type        State       Filter type
  --------------------------------------------------------
  100              Configured  Valid       xpath
  2147483651       Dynamic     Valid       xpath

Lijst details over een abonnement met show telemetry ietf <abonnementID> detail.

Device#show telemetry ietf 100 detail
 Telemetry subscription detail:

  Subscription ID: 2147483651
  Type: Dynamic
  State: Valid
  Stream: yang-push
  Filter:
    Filter type: xpath
    XPath: /memory-ios-xe-oper:memory-statistics/memory-statistic
  Update policy:
    Update Trigger: periodic
    Period: 10000
  Encoding: encode-xml
  Source VRF:
  Source Address:
  Notes:

  Receivers:
    Address                                    Port     Protocol         Protocol Profile
    -----------------------------------------------------------------------------------------
   10.88.246.10                                 57344    netconf

Controleer de status van de verbinding met de ontvanger met tonen telemetrie interne verbinding.

Device# show telemetry internal connection
Telemetry connection

Peer Address    Port  VRF Source Address  Transport  State         Profile
--------------- ----- --- --------------- ---------- ------------- -------------
10.88.246.10   57344   0 10.88.246.2    grpc-tcp   Active

Problemen oplossen

Deze sectie bevat informatie die u kunt gebruiken om problemen met de configuratie te troubleshooten.

Scenario 1. Als de staat van het telemetrieabonnement geldig is en u geen stromen in de ontvanger ontvangt.

Controleer de status van de verbinding met de ontvanger.

Device#show telemetry internal connection
Telemetry connection

Peer Address    Port  VRF Source Address  Transport  State         Profile
--------------- ----- --- --------------- ---------- ------------- -------------
10.88.246.10    57350   0 10.88.247.86    grpc-tcp   Connecting

Als de staat verbindt, verzeker de correcte connectiviteit tussen de uitgever en de ontvanger.

Device# ping 

Zorg ervoor dat de haven in gebruik open is.

Device# telnet  
 Trying 10.88.246.10, 57350 ...
% Connection refused by remote host

In dit voorbeeld is de poort niet open/bereikbaar. Controleer of er geen firewall is die de poort kan blokkeren en ervoor kan zorgen dat de opgegeven poort de juiste is.

In apparaten die VRF's gebruiken, moet u het bron-VRF/bron-adres in de RPC specificeren voor geconfigureerde abonnementen. Dit beeld toont een RPC waar de bron VRF wordt gespecificeerd.

Scenario 2. Als de staat van het telemetrieabonnement ongeldig is.

Device# show telemetry ietf subscription all
  Telemetry subscription brief

  ID               Type        State       Filter type
  --------------------------------------------------------
  200              Configured  Invalid     xpath

Controleer de abonnementsgegevens.

Device# show telemetry ietf subscription 200 detail
Telemetry subscription detail:

  Subscription ID: 200
  Type: Configured
  State: Invalid
  Stream: yang-push
  Filter:
    Filter type: xpath
    XPath: /memory-ios-xe-oper:/memory-statistics/memory-statistic
  Update policy:
    Update Trigger: periodic
    Period: 1000
  Encoding: encode-kvgpb
  Source VRF:
  Source Address:
  Notes: XPath parse error 'Invalid expression: offset(21)' 58.

  Receivers:
    Address                                    Port     Protocol         Protocol Profile
    -----------------------------------------------------------------------------------------
    10.88.247.89                               57344    grpc-tcp

Let op de syntaxis van de XPath-filter, het heeft een extra "/" na de ":", de juiste XPath-filter is:

/memory-ios-xe-oper:memory-statistics/memory-statistics

Elke syntaxisfout zoals ontbrekende letters of extra tekens in het XPath-filter kan leiden tot een ongeldig abonnement.

Als u ondersteuning nodig hebt voor de YANG Suite tool, neem dan contact op met de support mailer of het support forum.

Gerelateerde informatie

• Model-gedreven telemetrie, programmeerbaarheid configuratiegids, Cisco IOS XE Amsterdam 17.3.x
• Technische ondersteuning en documentatie – Cisco Systems