This module contains a collection of YANG definitions for Cisco IOS-XR telemetry-model-driven package operational data. This mo...
Version: 2020-10-30
module Cisco-IOS-XR-telemetry-model-driven-oper { yang-version 1; namespace "http://cisco.com/ns/yang/Cisco-IOS-XR-telemetry-model-driven-oper"; prefix telemetry-model-driven-oper; import ietf-inet-types { prefix inet; } import Cisco-IOS-XR-types { prefix xr; } import cisco-semver { prefix semver; } include Cisco-IOS-XR-telemetry-model-driven-oper-sub2 { revision-date "2020-10-30"; } include Cisco-IOS-XR-telemetry-model-driven-oper-sub1 { revision-date "2020-10-30"; } organization "Cisco Systems, Inc."; contact "Cisco Systems, Inc. Customer Service Postal: 170 West Tasman Drive San Jose, CA 95134 Tel: +1 800 553-NETS E-mail: cs-yang@cisco.com"; description "This module contains a collection of YANG definitions for Cisco IOS-XR telemetry-model-driven package operational data. This module contains definitions for the following management objects: telemetry-model-driven: Telemetry operational data Copyright (c) 2013-2020 by Cisco Systems, Inc. All rights reserved."; revision "2020-10-30" { description "Keys for sensor-paths IosSetYangSchemaRev Cisco-IOS-XR-telemetry-model-driven-oper"; } revision "2020-03-11" { description "Updated the encodings supported 2020-01-30 Added compression leaf to destination container 2020-01-10 GRPC channel statistics added 2019-09-25 Added minimum-cadence and cadence-factor options for target defined mode"; } revision "2019-04-05" { description "Establish semantic version baseline."; } revision "2017-09-27" { description "Summary container added"; } revision "2017-05-05" { description "Modified the type for the state variables"; } revision "2017-05-01" { description "Fixing backward compatibility error in module."; } revision "2017-02-09" { description "Added DSCP"; } revision "2017-01-30" { description "Initial 6.2.1 revision"; } revision "2015-11-09" { description "IOS XR 6.0 revision."; } semver:module-version "1.2.0"; semver:module-version "1.1.0"; semver:module-version "1.0.1"; container telemetry-model-driven { config false; description "Telemetry operational data"; container destinations { description "Telemetry Destinations"; list destination { key "destination-id"; description "Telemetry Destination"; leaf destination-id { type xr:Cisco-ios-xr-string; description "Id of the destination"; } leaf id { type string; description "Destination Group name"; } leaf configured { type uint32; description "Set if this is configured destination group"; } list destination { description "list of destinations defined in this group"; container destination { description "Destination"; container dest-ip-address { description "Destination IP Address"; leaf ip-type { type Mdt-ip; description "IPType"; } leaf ipv4-address { when "../ip-type = 'ipv4'" { description "../IPType = 'IPV4'"; } type inet:ipv4-address; description "IPV4 Address"; } leaf ipv6-address { when "../ip-type = 'ipv6'" { description "../IPType = 'IPV6'"; } type Mdt-in6-addr; description "IPV6 Address"; } } // container dest-ip-address leaf id { type string; description "Destination Id"; } leaf sub-id-str { type string; description "Sub Idstr"; } leaf dest-port { type uint16; description "Destination Port number"; } leaf encoding { type Mdt-encoding-enum; description "Destination group encoding"; } leaf transport { type Mdt-transport-enum; description "Destination group transport"; } leaf vrf { type string; description "Destination group vrf"; } leaf vrf-id { type uint32; description "Destination group vrf id"; } leaf state { type Mdt-dest-state-enum; description "State of streaming on this destination"; } leaf udp-mtu { type uint32; description "UDP MTU if this destination is UDP"; } leaf tls { type uint32; description "TLS connection to this destination"; } leaf tls-host { type string; description "TLS Hostname of this destination"; } leaf total-num-of-packets-sent { type uint64; description "Total number of packets sent for this destination"; } leaf total-num-of-bytes-sent { type uint64; units "byte"; description "Total number of bytes sent for this destination"; } leaf last-collection-time { type uint64; description "Timestamp of the last collection"; } leaf dscp { type uint32; description "DSCP setting for this destination"; } leaf maximum-tokens { type uint32; description "Maximum number of tokens"; } leaf token-processed-time { type string; description "Last token processed time, format 1985-04-12 23 :20:50.521256 -0700"; } leaf cadence-tokens { type uint32; description "Number of available cadence tokens"; } leaf cadence-token-advertised-time { type string; description "Last cadence token advertisement time, format 1985-04-12 23:20:50.254143 -0700"; } leaf event-tokens { type uint32; description "Number of available event tokens"; } leaf event-token-advertised-time { type string; description "Last event token advertisement time, format 1985-04-12 23:20:50.254143 -0700"; } leaf pending-queue-size { type uint32; description "Number of messages in pending queue"; } leaf gnmi-sync-response-time { type string; description "GNMI initial synchronization message time, format 1985-04-12 23:20:50.254143 -0700"; } leaf pending-events { type uint32; description "Number of events pending to be processed"; } leaf processed-events { type uint64; description "Number of events processed"; } leaf collection-tokens { type uint32; description "Number of collection tokens"; } leaf compression { type Mdt-compression; description "Compression algorithm in use"; } list collection-detail { description "Collection details for this destination"; leaf subscription-id { type uint64; description "Subscription ID"; } leaf sysdb-path { type string; description "SysDB path of the sensor path"; } leaf in-progress { type boolean; description "True if collection is in progress"; } leaf create-time { type string; description "Collection request time, format 1985-04-12 23:20 :50.254143 -0700"; } leaf start-time { type string; description "Collection start time, format 1985-04-12 23:20 :50.254143 -0700"; } leaf completion-time { type string; description "Collection finish time, format 1985-04-12 23:20 :50.254143 -0700"; } leaf token-receive-time { type string; description "Last time when tokens were received, format 1985-04-12 23:20:50.254143 -0700"; } leaf last-packet-send-time { type string; description "Last time a packet was sent, format 1985-04-12 23:20:50.254143 -0700"; } } // list collection-detail } // container destination list collection-group { description "List of collection groups for this destination group"; leaf id { type uint64; description "Collection Group id"; } leaf cadence { type uint32; description "Period of the collections (ms)"; } leaf total-collections { type uint32; description "Completed collections count"; } leaf encoding { type Mdt-encoding-enum; description "Destination group encoding"; } leaf last-collection-start-time { type uint64; description "Timestamp of the start of last collection"; } leaf last-collection-end-time { type uint64; description "Timestamp of the end of last collection"; } leaf max-collection-time { type uint32; description "Maximum time for a collection (ms)"; } leaf min-collection-time { type uint32; description "Minimum time for a collection (ms)"; } leaf min-total-time { type uint32; description "Minimum time for all processing (ms)"; } leaf max-total-time { type uint32; description "Maximum time for all processing (ms)"; } leaf avg-total-time { type uint32; description "Average time for all processing (ms)"; } leaf total-other-errors { type uint32; description "Total number of errors"; } leaf total-on-data-instances { type uint32; description "Total number of no data instances"; } leaf total-not-ready { type uint32; description "Total number skipped (not ready)"; } leaf total-send-errors { type uint32; description "Total number of send errors"; } leaf total-send-drops { type uint32; description "Total number of send drops"; } leaf strict-timer { type boolean; description "Set if strict timer is ON"; } leaf heartbeat-interval { type uint32; description "Heartbeat interval (ms)"; } leaf heartbeat-always { type boolean; description "Send heartbeat even if events have occurred within interval"; } list collection-path { description "Array of information for sensor paths within collection group"; leaf path { type string; description "Sensor Path"; } leaf state { type boolean; description "State, if sensor path is resolved or not"; } leaf status-str { type string; description "Error str, if there are any errors resolving the sensor path"; } leaf configured-keys { type string; description "Keys for the sensor path, if configured"; } } // list collection-path list internal-collection-group { description "Array of information for sysdb paths within collection group"; leaf path { type string; description "Sysdb Path"; } leaf cadence { type uint64; description "Period of the collections (ms)"; } leaf total-get-count { type uint64; description "Total number of gets"; } leaf total-list-count { type uint64; description "Total number of lists"; } leaf total-datalist-count { type uint64; description "Total number of datalists"; } leaf total-finddata-count { type uint64; description "Total number of finddata"; } leaf total-get-bulk-count { type uint64; description "Total number of get bulk"; } leaf total-item-count { type uint64; description "Total number of items retrived from sysdb"; } leaf total-get-errors { type uint64; description "Total number of get errors"; } leaf total-list-errors { type uint64; description "Total number of list errors"; } leaf total-datalist-errors { type uint64; description "Total number of datalist errors"; } leaf total-finddata-errors { type uint64; description "Total number of finddata errors"; } leaf total-get-bulk-errors { type uint64; description "Total number of get bulk errors"; } leaf total-encode-errors { type uint64; description "Total number of encode errors"; } leaf total-encode-notready { type uint64; description "Total number of encode deferred"; } leaf total-send-errors { type uint64; description "Total number of send errors"; } leaf total-send-drops { type uint64; description "Total number of send channel full"; } leaf total-sent-bytes { type uint64; units "byte"; description "Total number of bytes sent"; } leaf total-send-packets { type uint64; description "Total number of packets sent"; } leaf total-send-bytes-dropped { type uint64; units "byte"; description "Total number of send bytes dropped"; } leaf total-collections { type uint64; description "Completed collections count"; } leaf total-collections-missed { type uint64; description "Total number of collections missed"; } leaf max-collection-time { type uint64; description "Maximum time for a collection (ms)"; } leaf min-collection-time { type uint64; description "Minimum time for a collection (ms)"; } leaf avg-collection-time { type uint64; description "Average time for a collection (ms)"; } leaf collection-method { type uint64; description "Collection method in use"; } leaf status { type Mdt-internal-path-status; description "Status of collection path"; } leaf total-heartbeats-missed { type uint64; description "Total number of heartbeats missed"; } leaf internal-keys { type string; description "Keys for the sensor path, if configured"; } leaf filtered-item-count { type uint64; description "Count of number of items that got filtered"; } } // list internal-collection-group } // list collection-group } // list destination } // list destination } // container destinations container subscriptions { description "Telemetry Subscriptions"; list subscription { key "subscription-id"; description "Telemetry Subscription"; leaf subscription-id { type xr:Cisco-ios-xr-string; description "Id of the subscription"; } container subscription { description "Subscription"; container source-interface { description "configured source interface"; leaf interface-name { type string; description "Source Interface Name"; } leaf state { type boolean; description "interface state"; } leaf ipv4-address { type inet:ipv4-address; description "IPV4 Address"; } leaf ipv6-address { type Mdt-in6-addr; description "IPV6 Address"; } leaf vrf-id { type uint32; description "Src Vrf Id"; } } // container source-interface leaf id { type string; description "Collection Subscription name"; } leaf state { type Mdt-subs-state-enum; description "Subscription state"; } leaf source-qos-marking { type Mdt-source-qos-marking; description "DSCP"; } list sensor-profile { description "List of sensor groups within a subscription"; container sensor-group { description "sensor group"; leaf id { type string; description "Sensor Group name"; } leaf configured { type uint32; description "Set if this is configured sensor group"; } list sensor-path { description "Array of information for sensor paths within sensor group"; leaf path { type string; description "Sensor Path"; } leaf state { type boolean; description "State, if sensor path is resolved or not"; } leaf status-str { type string; description "Error str, if there are any errors resolving the sensor path"; } leaf configured-keys { type string; description "Keys for the sensor path, if configured"; } } // list sensor-path } // container sensor-group leaf sample-interval { type uint32; description "Sample interval for the sensor group (ms)"; } leaf heartbeat-interval { type uint32; description "Heartbeat interval for the sensor group (s)"; } leaf suppress-redundant { type boolean; description "Suppress Redundant"; } } // list sensor-profile list destination-grp { description "Array of destinations within a subscription"; leaf id { type string; description "Destination Group name"; } leaf configured { type uint32; description "Set if this is configured destination group"; } list destination { description "list of destinations defined in this group"; container dest-ip-address { description "Destination IP Address"; leaf ip-type { type Mdt-ip; description "IPType"; } leaf ipv4-address { when "../ip-type = 'ipv4'" { description "../IPType = 'IPV4'"; } type inet:ipv4-address; description "IPV4 Address"; } leaf ipv6-address { when "../ip-type = 'ipv6'" { description "../IPType = 'IPV6'"; } type Mdt-in6-addr; description "IPV6 Address"; } } // container dest-ip-address leaf id { type string; description "Destination Id"; } leaf sub-id-str { type string; description "Sub Idstr"; } leaf dest-port { type uint16; description "Destination Port number"; } leaf encoding { type Mdt-encoding-enum; description "Destination group encoding"; } leaf transport { type Mdt-transport-enum; description "Destination group transport"; } leaf vrf { type string; description "Destination group vrf"; } leaf vrf-id { type uint32; description "Destination group vrf id"; } leaf state { type Mdt-dest-state-enum; description "State of streaming on this destination"; } leaf udp-mtu { type uint32; description "UDP MTU if this destination is UDP"; } leaf tls { type uint32; description "TLS connection to this destination"; } leaf tls-host { type string; description "TLS Hostname of this destination"; } leaf total-num-of-packets-sent { type uint64; description "Total number of packets sent for this destination"; } leaf total-num-of-bytes-sent { type uint64; units "byte"; description "Total number of bytes sent for this destination"; } leaf last-collection-time { type uint64; description "Timestamp of the last collection"; } leaf dscp { type uint32; description "DSCP setting for this destination"; } leaf maximum-tokens { type uint32; description "Maximum number of tokens"; } leaf token-processed-time { type string; description "Last token processed time, format 1985-04-12 23 :20:50.521256 -0700"; } leaf cadence-tokens { type uint32; description "Number of available cadence tokens"; } leaf cadence-token-advertised-time { type string; description "Last cadence token advertisement time, format 1985-04-12 23:20:50.254143 -0700"; } leaf event-tokens { type uint32; description "Number of available event tokens"; } leaf event-token-advertised-time { type string; description "Last event token advertisement time, format 1985-04-12 23:20:50.254143 -0700"; } leaf pending-queue-size { type uint32; description "Number of messages in pending queue"; } leaf gnmi-sync-response-time { type string; description "GNMI initial synchronization message time, format 1985-04-12 23:20:50.254143 -0700"; } leaf pending-events { type uint32; description "Number of events pending to be processed"; } leaf processed-events { type uint64; description "Number of events processed"; } leaf collection-tokens { type uint32; description "Number of collection tokens"; } leaf compression { type Mdt-compression; description "Compression algorithm in use"; } list collection-detail { description "Collection details for this destination"; leaf subscription-id { type uint64; description "Subscription ID"; } leaf sysdb-path { type string; description "SysDB path of the sensor path"; } leaf in-progress { type boolean; description "True if collection is in progress"; } leaf create-time { type string; description "Collection request time, format 1985-04-12 23:20 :50.254143 -0700"; } leaf start-time { type string; description "Collection start time, format 1985-04-12 23:20 :50.254143 -0700"; } leaf completion-time { type string; description "Collection finish time, format 1985-04-12 23:20 :50.254143 -0700"; } leaf token-receive-time { type string; description "Last time when tokens were received, format 1985-04-12 23:20:50.254143 -0700"; } leaf last-packet-send-time { type string; description "Last time a packet was sent, format 1985-04-12 23:20:50.254143 -0700"; } } // list collection-detail } // list destination } // list destination-grp } // container subscription list collection-group { description "List of collection groups active for this subscription"; leaf id { type uint64; description "Collection Group id"; } leaf cadence { type uint32; description "Period of the collections (ms)"; } leaf total-collections { type uint32; description "Completed collections count"; } leaf encoding { type Mdt-encoding-enum; description "Destination group encoding"; } leaf last-collection-start-time { type uint64; description "Timestamp of the start of last collection"; } leaf last-collection-end-time { type uint64; description "Timestamp of the end of last collection"; } leaf max-collection-time { type uint32; description "Maximum time for a collection (ms)"; } leaf min-collection-time { type uint32; description "Minimum time for a collection (ms)"; } leaf min-total-time { type uint32; description "Minimum time for all processing (ms)"; } leaf max-total-time { type uint32; description "Maximum time for all processing (ms)"; } leaf avg-total-time { type uint32; description "Average time for all processing (ms)"; } leaf total-other-errors { type uint32; description "Total number of errors"; } leaf total-on-data-instances { type uint32; description "Total number of no data instances"; } leaf total-not-ready { type uint32; description "Total number skipped (not ready)"; } leaf total-send-errors { type uint32; description "Total number of send errors"; } leaf total-send-drops { type uint32; description "Total number of send drops"; } leaf strict-timer { type boolean; description "Set if strict timer is ON"; } leaf heartbeat-interval { type uint32; description "Heartbeat interval (ms)"; } leaf heartbeat-always { type boolean; description "Send heartbeat even if events have occurred within interval"; } list collection-path { description "Array of information for sensor paths within collection group"; leaf path { type string; description "Sensor Path"; } leaf state { type boolean; description "State, if sensor path is resolved or not"; } leaf status-str { type string; description "Error str, if there are any errors resolving the sensor path"; } leaf configured-keys { type string; description "Keys for the sensor path, if configured"; } } // list collection-path list internal-collection-group { description "Array of information for sysdb paths within collection group"; leaf path { type string; description "Sysdb Path"; } leaf cadence { type uint64; description "Period of the collections (ms)"; } leaf total-get-count { type uint64; description "Total number of gets"; } leaf total-list-count { type uint64; description "Total number of lists"; } leaf total-datalist-count { type uint64; description "Total number of datalists"; } leaf total-finddata-count { type uint64; description "Total number of finddata"; } leaf total-get-bulk-count { type uint64; description "Total number of get bulk"; } leaf total-item-count { type uint64; description "Total number of items retrived from sysdb"; } leaf total-get-errors { type uint64; description "Total number of get errors"; } leaf total-list-errors { type uint64; description "Total number of list errors"; } leaf total-datalist-errors { type uint64; description "Total number of datalist errors"; } leaf total-finddata-errors { type uint64; description "Total number of finddata errors"; } leaf total-get-bulk-errors { type uint64; description "Total number of get bulk errors"; } leaf total-encode-errors { type uint64; description "Total number of encode errors"; } leaf total-encode-notready { type uint64; description "Total number of encode deferred"; } leaf total-send-errors { type uint64; description "Total number of send errors"; } leaf total-send-drops { type uint64; description "Total number of send channel full"; } leaf total-sent-bytes { type uint64; units "byte"; description "Total number of bytes sent"; } leaf total-send-packets { type uint64; description "Total number of packets sent"; } leaf total-send-bytes-dropped { type uint64; units "byte"; description "Total number of send bytes dropped"; } leaf total-collections { type uint64; description "Completed collections count"; } leaf total-collections-missed { type uint64; description "Total number of collections missed"; } leaf max-collection-time { type uint64; description "Maximum time for a collection (ms)"; } leaf min-collection-time { type uint64; description "Minimum time for a collection (ms)"; } leaf avg-collection-time { type uint64; description "Average time for a collection (ms)"; } leaf collection-method { type uint64; description "Collection method in use"; } leaf status { type Mdt-internal-path-status; description "Status of collection path"; } leaf total-heartbeats-missed { type uint64; description "Total number of heartbeats missed"; } leaf internal-keys { type string; description "Keys for the sensor path, if configured"; } leaf filtered-item-count { type uint64; description "Count of number of items that got filtered"; } } // list internal-collection-group } // list collection-group } // list subscription } // container subscriptions container channel-statistics { description "GRPC channel statistics"; list channel-statistic { description "GRPC channel details"; leaf subscription-id { type xr:Cisco-ios-xr-string; description "Id of the subscription"; } leaf destination-address { type inet:ip-address-no-zone; description "Destination IP address"; } leaf destination-port { type xr:Cisco-ios-xr-port-number; description "Destination port number"; } leaf encoding { type Mdt-encoding-enum; description "Destination group encoding"; } leaf transport { type Mdt-transport-enum; description "Destination group transport"; } leaf state { type Mdt-dest-state-enum; description "State of streaming on this destination"; } leaf channel-id { type uint64; description "GRPC channel ID of this subscription and destination"; } leaf in-use-buffers { type uint32; description "Number of buffers used by the channel"; } leaf dropped-messages { type uint32; description "Number of messages dropped when channel becomes full"; } } // list channel-statistic } // container channel-statistics container sensor-groups { description "Telemetry Sensor Groups"; list sensor-group { key "sensor-group-id"; description "Telemetry Sensor Groups"; leaf sensor-group-id { type xr:Cisco-ios-xr-string; description "Id of the sensor group"; } leaf id { type string; description "Sensor Group name"; } leaf configured { type uint32; description "Set if this is configured sensor group"; } list sensor-path { description "Array of information for sensor paths within sensor group"; leaf path { type string; description "Sensor Path"; } leaf state { type boolean; description "State, if sensor path is resolved or not"; } leaf status-str { type string; description "Error str, if there are any errors resolving the sensor path"; } leaf configured-keys { type string; description "Keys for the sensor path, if configured"; } } // list sensor-path } // list sensor-group } // container sensor-groups container summary { description "Telemetry Summary info"; leaf num-of-subscriptions { type uint32; description "Number of Subscriptions"; } leaf num-of-active-subscriptions { type uint32; description "Number of Active Subscriptions"; } leaf num-of-paused-subscriptions { type uint32; description "Number of Paused Subscriptions"; } leaf num-of-destination-groups { type uint32; description "Number of Destination Groups"; } leaf num-of-destinations { type uint32; description "Number of Destinations"; } leaf num-of-tcp-dialouts { type uint32; description "Number of Tcp Dialout Destinations"; } leaf num-of-udp-dialouts { type uint32; description "Number of Udp Dialout Destinations"; } leaf num-of-grpc-tls-dialouts { type uint32; description "Number of GRPC TLS Dialout Destinations"; } leaf num-of-grpc-non-tls-dialouts { type uint32; description "Number of GRPC Non-TLS Dialout Destinations"; } leaf num-of-dialins { type uint32; description "Number of Dialin Destinations"; } leaf num-of-active-destinations { type uint32; description "Number of Active Destinations"; } leaf num-of-connected-sessions { type uint32; description "Number of Connected Sessions"; } leaf num-of-connecting-sessions { type uint32; description "Number of Connecting Sessions"; } leaf num-of-sensor-groups { type uint32; description "Number of Sensor Groups"; } leaf num-of-unique-sensor-paths { type uint32; description "Number of Unique Sensor Paths"; } leaf num-of-sensor-paths { type uint32; description "Number of Sensor Paths"; } leaf num-of-not-resolved-sensor-paths { type uint32; description "Number of not resolved sensor paths"; } leaf num-of-active-sensor-paths { type uint32; description "Number of Active Sensor Paths"; } leaf max-sensor-paths { type uint32; description "Maximum Sensor Paths allowed"; } leaf max-containers-per-path { type uint32; description "Max containers allowed per Sensor Path"; } leaf min-target-def-cadence { type uint32; description "Minimum cadence for target defined subscriptions"; } leaf target-def-cadence-factor { type uint32; description "Cadence factor for target defined subscriptions"; } } // container summary } // container telemetry-model-driven } // module Cisco-IOS-XR-telemetry-model-driven-oper
© 2023 YumaWorks, Inc. All rights reserved.