{"type":"api","title":"Retrieve IGP link performance metrics","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/1d80624b-479e-34fb-8b53-50017ed1766d","info":{"title":"Performance Metrics","description":"This module defines a Data Model for reporting various performance metrics in Crosswork.\nThese statistics tend to be attributes that are constantly changing.\nFor this reason, they are not included in their respective topology models, as that would\nimply constant updates via notifications for all the relevant entities (eg. Links and SR Policies).\nThis model is provided as a way to query for these performance metrics as needed.\nThere's no mechanism to subscribe to these changes via notifications.","contact":{"name":"Crosswork Team, Cisco","email":"support@cisco.com"},"license":{"name":"Cisco Software License Agreement","url":"http://www.cisco.com/public/sw-license-agreement.html"},"version":"7.1.0"},"tags":[{"name":"Operational data","description":"Operational data resources"}],"openapi":"3.0.1","servers":[{"url":"https://{cnc-host}:{cnc-port}/crosswork/nbi/topology/v3/restconf","variables":{"cnc-host":{"default":"127.0.0.1","description":"host name or ip address of the target CNC Cluster"},"cnc-port":{"default":"30603","description":"port number of the target CNC Cluster"}}}],"securitySchemes":{"basicAuth":{"description":"authentication","type":"http","scheme":"basic"}}},"spec":{"tags":["Operational data","Since 3.0"],"summary":"Retrieve IGP link performance metrics","description":"Attributes related to performance metrics for a IGP links.","operationId":"data_cisco_crosswork_performance_metrics_igp_links_performance_metrics_igp_link_pm_igp_link_pm_link_id_get","parameters":[{"name":"link-id","in":"path","description":"The identifier of a link in the topology.\nA link is specific to a topology to which it belongs.\nThis is the same link-id as used in the topology model.","required":true,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"Attributes related to performance metrics for a IGP links.","content":{"application/yang-data+json":{"schema":{"type":"object","properties":{"cisco-crosswork-performance-metrics:igp-link-pm":{"type":"array","description":"Attributes related to performance metrics for a IGP links.","items":{"type":"object","properties":{"link-id":{"type":"string","description":"The identifier of a link in the topology.\nA link is specific to a topology to which it belongs.\nThis is the same link-id as used in the topology model.","format":"string"},"source":{"type":"object","properties":{"source-node":{"type":"string","description":"Source node identifier. Must be in the same topology.","format":"string"},"source-tp":{"type":"string","description":"This termination point is located within the source node\nand terminates the link.","format":"string"}},"description":"This container holds the logical source of a particular\nlink."},"destination":{"type":"object","properties":{"dest-node":{"type":"string","description":"Destination node identifier. Must be in the same\nnetwork.","format":"string"},"dest-tp":{"type":"string","description":"This termination point is located within the\ndestination node and terminates the link.","format":"string"}},"description":"This container holds the logical destination of a\nparticular link."},"max-bandwidth-kbps":{"type":"integer","description":"Max bandwidth for this link, in kilobits per second.","format":"uint64"},"bandwidth-utilization-kbps":{"type":"integer","description":"Current bandwidth utilization for this link, in kilobits per second.","format":"uint64"},"delay":{"type":"integer","description":"The unidirectional minimum delay for this link, in microseconds.","format":"uint32"},"delay-telemetry":{"type":"integer","description":"Current delay for this link, in microseconds. This value comes from NAPM telemetry.","format":"uint32"},"jitter-telemetry":{"type":"integer","description":"Current jitter for this link, in microseconds. This value comes from NAPM telemetry.","format":"uint32"},"interfaces":{"type":"object","properties":{"TX-packet-drops":{"type":"integer","description":"Number of transmitted packets dropped on this interface.","format":"uint64"},"RX-packet-drops":{"type":"integer","description":"Number of received packets dropped on this interface.","format":"uint64"},"TX-Errors":{"type":"integer","description":"Number of errors on transmitted packets on this interface.","format":"uint64"},"RX-Errors":{"type":"integer","description":"Number of errors on received packets on this interface.","format":"uint64"},"Throughput":{"type":"number","description":"Transmit utilization percentage for this interface.","format":"double"},"Bandwidth":{"type":"integer","description":"Speed of the interface in Mbps.","format":"uint64"}},"description":"This container holds the pm traffic data of the interfaces releated to the link. These values come from NAPM telemetry."}}}}}}}}},"204":{"description":"No Content","content":{}},"400":{"description":"Bad Request","content":{}},"401":{"description":"Unauthorized","content":{}},"404":{"description":"Not Found","content":{}},"405":{"description":"Method Not Allowed","content":{}},"409":{"description":"Conflict","content":{}}},"security":[{"basicAuth":[]}],"__originalOperationId":"data_cisco_crosswork_performance_metrics_igp_links_performance_metrics_igp_link_pm_igp_link_pm_link_id_get","method":"get","path":"/data/cisco-crosswork-performance-metrics:igp-links-performance-metrics/igp-link-pm={link-id}"}}