openconfig-ate-flow

openconfig-version: 0.4.0

Description

This module defines telemetry that relates to flows that are tracked by a network device, or automated test equipment. A flow is an arbitrary stream of packets whose definition is outside of the context of this module.

Imports

openconfig-extensions
openconfig-yang-types
openconfig-types
openconfig-inet-types
openconfig-mpls-types
openconfig-vlan-types

Data elements

/
flows

description:
Flow statistics collected by the network device. A flow is defined to be an arbitrary stream of packets whose definition is outside of the context of the module.

nodetype: container (rw)

/flows/
flow

description:
A flow of packets between one or more internal and external sources and one or more internal and external destinations that the target is able to track and report statistics on. Each flow is identified by an arbitrary string identifier.

nodetype: list (ro)

list keys: [name]

/flows/flow/
name

description:
Reference to the flow's name, acting as a key of the flow list.

nodetype: leaf (list key) (ro)

type: leafref

  • path reference: ../state/name

/flows/flow/
state

description:
Operational state of the individual flow.

nodetype: container (ro)

/flows/flow/state/
name

description:
An arbitary name used for the flow tracked by the system. This name must be unique for the flows tracked and exported by the target.

nodetype: leaf (ro)

type: string

/flows/flow/state/
src-port

description:
Value of the source port for ingress tracking.

nodetype: leaf (ro)

type: string

/flows/flow/state/
dst-port

description:
Value of the destination port for ingress tracking.

nodetype: leaf (ro)

type: string

/flows/flow/state/
mpls-label

description:
Value of the MPLS label for ingress tracking.

nodetype: leaf (ro)

type: oc-mplst:mpls-label

/flows/flow/state/
src-ipv4

description:
The source IPv4 value of the traffic header.

nodetype: leaf (ro)

type: oc-inet:ipv4-address

/flows/flow/state/
dst-ipv4

description:
The destination IPv4 value of the traffic header.

nodetype: leaf (ro)

type: oc-inet:ipv4-address

/flows/flow/state/
src-ipv6

description:
The source IPv6 value of the traffic header.

nodetype: leaf (ro)

type: oc-inet:ipv6-address

/flows/flow/state/
dst-ipv6

description:
The destination IPv6 value of the traffic header.

nodetype: leaf (ro)

type: oc-inet:ipv6-address

/flows/flow/state/
vlan-id

description:
The VLAN ID of the traffic header.

nodetype: leaf (ro)

type: oc-vlan:vlan-id

/flows/flow/state/
filter

description:
Name of the filter on which the egress stats are tracked

nodetype: leaf (ro)

type: string

/flows/flow/state/
loss-pct

description:
The percentage of transmitted packets that were not received by the destinations of the flow.

nodetype: leaf (ro)

type: oc-types:ieeefloat32

/flows/flow/state/
out-frame-rate

description:
The rate, measured in frames per second, at which frames are being transmitted for the flow.

nodetype: leaf (ro)

type: oc-types:ieeefloat32

/flows/flow/state/
in-frame-rate

description:
The rate, measured in frames per second, at which frames are being received for the flow.

nodetype: leaf (ro)

type: oc-types:ieeefloat32

/flows/flow/state/
out-rate

description:
The rate, measured in bits per second, at which the flow is being transmitted.

nodetype: leaf (ro)

type: oc-types:ieeefloat32

/flows/flow/state/
in-rate

description:
The rate, measured in bits per second, at which the flow is being received.

nodetype: leaf (ro)

type: oc-types:ieeefloat32

/flows/flow/state/
first-packet-latency

description:
The time from when the flow was started to when the first packet was received.

nodetype: leaf (ro)

type: oc-types:timeticks64

/flows/flow/state/
convergence-time

description:
The time from when the first packet was received to when traffic loss dropped below a minimal threshold value.

nodetype: leaf (ro)

type: oc-types:timeticks64

/flows/flow/state/
counters

description:
Counters that correspond to the individual flow.

nodetype: container (ro)

/flows/flow/state/counters/
in-octets

description:
The total number of bytes received by the target for the flow.

nodetype: leaf (ro)

type: oc-yang:counter64

/flows/flow/state/counters/
in-pkts

description:
The total number of packets received by the target for the flow.

nodetype: leaf (ro)

type: oc-yang:counter64

/flows/flow/state/counters/
out-octets

description:
The total number of bytes sent by the target for the flow. These packets may be generated or forwarded by the target.

nodetype: leaf (ro)

type: oc-yang:counter64

/flows/flow/state/counters/
out-pkts

description:
The total number of packets sent by the target for the flow. These packets may be generated or forwarded by the target.

nodetype: leaf (ro)

type: oc-yang:counter64

/flows/flow/
ingress-tracking

description:
Flow statistics grouped by ingress tracking filter.

nodetype: container (ro)

/flows/flow/ingress-tracking/
ingress-tracking

description:
If the ATE is configured to track incoming frames by their header fields, this list will map combinations of values of those header fields to the flow statistics specific to frames that match that combination.

nodetype: list (ro)

list keys: [src-port] [dst-port] [mpls-label] [src-ipv4] [dst-ipv4] [src-ipv6] [dst-ipv6] [vlan-id]

/flows/flow/ingress-tracking/ingress-tracking/
src-port

description:
Value of the source port for ingress tracking.

nodetype: leaf (list key) (ro)

type: leafref

  • path reference: ../state/src-port

/flows/flow/ingress-tracking/ingress-tracking/
dst-port

description:
Value of the destination port for ingress tracking.

nodetype: leaf (list key) (ro)

type: leafref

  • path reference: ../state/dst-port

/flows/flow/ingress-tracking/ingress-tracking/
mpls-label

description:
The MPLS label value of the traffic header.

nodetype: leaf (list key) (ro)

type: leafref

  • path reference: ../state/mpls-label

/flows/flow/ingress-tracking/ingress-tracking/
src-ipv4

description:
The src IPv4 value of the traffic header.

nodetype: leaf (list key) (ro)

type: leafref

  • path reference: ../state/src-ipv4

/flows/flow/ingress-tracking/ingress-tracking/
dst-ipv4

description:
The dst IPv4 value of the traffic header.

nodetype: leaf (list key) (ro)

type: leafref

  • path reference: ../state/dst-ipv4

/flows/flow/ingress-tracking/ingress-tracking/
src-ipv6

description:
The src IPv6 value of the traffic header.

nodetype: leaf (list key) (ro)

type: leafref

  • path reference: ../state/src-ipv6

/flows/flow/ingress-tracking/ingress-tracking/
dst-ipv6

description:
The dst IPv6 value of the traffic header.

nodetype: leaf (list key) (ro)

type: leafref

  • path reference: ../state/dst-ipv6

/flows/flow/ingress-tracking/ingress-tracking/
vlan-id

description:
The VLAN ID value of the traffic header.

nodetype: leaf (list key) (ro)

type: leafref

  • path reference: ../state/vlan-id

/flows/flow/ingress-tracking/ingress-tracking/
state

description:
Operational state of the flow by ingress tracking filter.

nodetype: container (ro)

/flows/flow/ingress-tracking/ingress-tracking/state/
name

description:
An arbitary name used for the flow tracked by the system. This name must be unique for the flows tracked and exported by the target.

nodetype: leaf (ro)

type: string

/flows/flow/ingress-tracking/ingress-tracking/state/
src-port

description:
Value of the source port for ingress tracking.

nodetype: leaf (ro)

type: string

/flows/flow/ingress-tracking/ingress-tracking/state/
dst-port

description:
Value of the destination port for ingress tracking.

nodetype: leaf (ro)

type: string

/flows/flow/ingress-tracking/ingress-tracking/state/
mpls-label

description:
Value of the MPLS label for ingress tracking.

nodetype: leaf (ro)

type: oc-mplst:mpls-label

/flows/flow/ingress-tracking/ingress-tracking/state/
src-ipv4

description:
The source IPv4 value of the traffic header.

nodetype: leaf (ro)

type: oc-inet:ipv4-address

/flows/flow/ingress-tracking/ingress-tracking/state/
dst-ipv4

description:
The destination IPv4 value of the traffic header.

nodetype: leaf (ro)

type: oc-inet:ipv4-address

/flows/flow/ingress-tracking/ingress-tracking/state/
src-ipv6

description:
The source IPv6 value of the traffic header.

nodetype: leaf (ro)

type: oc-inet:ipv6-address

/flows/flow/ingress-tracking/ingress-tracking/state/
dst-ipv6

description:
The destination IPv6 value of the traffic header.

nodetype: leaf (ro)

type: oc-inet:ipv6-address

/flows/flow/ingress-tracking/ingress-tracking/state/
vlan-id

description:
The VLAN ID of the traffic header.

nodetype: leaf (ro)

type: oc-vlan:vlan-id

/flows/flow/ingress-tracking/ingress-tracking/state/
filter

description:
Name of the filter on which the egress stats are tracked

nodetype: leaf (ro)

type: string

/flows/flow/ingress-tracking/ingress-tracking/state/
loss-pct

description:
The percentage of transmitted packets that were not received by the destinations of the flow.

nodetype: leaf (ro)

type: oc-types:ieeefloat32

/flows/flow/ingress-tracking/ingress-tracking/state/
out-frame-rate

description:
The rate, measured in frames per second, at which frames are being transmitted for the flow.

nodetype: leaf (ro)

type: oc-types:ieeefloat32

/flows/flow/ingress-tracking/ingress-tracking/state/
in-frame-rate

description:
The rate, measured in frames per second, at which frames are being received for the flow.

nodetype: leaf (ro)

type: oc-types:ieeefloat32

/flows/flow/ingress-tracking/ingress-tracking/state/
out-rate

description:
The rate, measured in bits per second, at which the flow is being transmitted.

nodetype: leaf (ro)

type: oc-types:ieeefloat32

/flows/flow/ingress-tracking/ingress-tracking/state/
in-rate

description:
The rate, measured in bits per second, at which the flow is being received.

nodetype: leaf (ro)

type: oc-types:ieeefloat32

/flows/flow/ingress-tracking/ingress-tracking/state/
first-packet-latency

description:
The time from when the flow was started to when the first packet was received.

nodetype: leaf (ro)

type: oc-types:timeticks64

/flows/flow/ingress-tracking/ingress-tracking/state/
convergence-time

description:
The time from when the first packet was received to when traffic loss dropped below a minimal threshold value.

nodetype: leaf (ro)

type: oc-types:timeticks64

/flows/flow/ingress-tracking/ingress-tracking/state/
counters

description:
Counters that correspond to the flow by ingress tracking filter.

nodetype: container (ro)

/flows/flow/ingress-tracking/ingress-tracking/state/counters/
in-octets

description:
The total number of bytes received by the target for the flow.

nodetype: leaf (ro)

type: oc-yang:counter64

/flows/flow/ingress-tracking/ingress-tracking/state/counters/
in-pkts

description:
The total number of packets received by the target for the flow.

nodetype: leaf (ro)

type: oc-yang:counter64

/flows/flow/ingress-tracking/ingress-tracking/state/counters/
out-octets

description:
The total number of bytes sent by the target for the flow. These packets may be generated or forwarded by the target.

nodetype: leaf (ro)

type: oc-yang:counter64

/flows/flow/ingress-tracking/ingress-tracking/state/counters/
out-pkts

description:
The total number of packets sent by the target for the flow. These packets may be generated or forwarded by the target.

nodetype: leaf (ro)

type: oc-yang:counter64

/flows/flow/ingress-tracking/ingress-tracking/
egress-tracking

description:
Flow statistics grouped by egress tracking filter.

nodetype: container (ro)

/flows/flow/ingress-tracking/ingress-tracking/egress-tracking/
egress-tracking

description:
If the ATE is configured to track outgoing frames by a header field, this list will map values of that header field to the flow statistics specific to frames that match that value.

nodetype: list (ro)

list keys: [filter]

/flows/flow/ingress-tracking/ingress-tracking/egress-tracking/egress-tracking/
filter

description:
The filter value of the egress tracking configuration.

nodetype: leaf (list key) (ro)

type: leafref

  • path reference: ../state/filter

/flows/flow/ingress-tracking/ingress-tracking/egress-tracking/egress-tracking/
state

description:
Operational state of the flow by egress tracking filter.

nodetype: container (ro)

/flows/flow/ingress-tracking/ingress-tracking/egress-tracking/egress-tracking/state/
filter

description:
Value of the filter on which the egress stats are tracked

nodetype: leaf (ro)

type: string

/flows/flow/ingress-tracking/ingress-tracking/egress-tracking/egress-tracking/state/
loss-pct

description:
The percentage of transmitted packets that were not received by the destinations of the flow.

nodetype: leaf (ro)

type: oc-types:ieeefloat32

/flows/flow/ingress-tracking/ingress-tracking/egress-tracking/egress-tracking/state/
out-frame-rate

description:
The rate, measured in frames per second, at which frames are being transmitted for the flow.

nodetype: leaf (ro)

type: oc-types:ieeefloat32

/flows/flow/ingress-tracking/ingress-tracking/egress-tracking/egress-tracking/state/
in-frame-rate

description:
The rate, measured in frames per second, at which frames are being received for the flow.

nodetype: leaf (ro)

type: oc-types:ieeefloat32

/flows/flow/ingress-tracking/ingress-tracking/egress-tracking/egress-tracking/state/
out-rate

description:
The rate, measured in bits per second, at which the flow is being transmitted.

nodetype: leaf (ro)

type: oc-types:ieeefloat32

/flows/flow/ingress-tracking/ingress-tracking/egress-tracking/egress-tracking/state/
in-rate

description:
The rate, measured in bits per second, at which the flow is being received.

nodetype: leaf (ro)

type: oc-types:ieeefloat32

/flows/flow/ingress-tracking/ingress-tracking/egress-tracking/egress-tracking/state/
first-packet-latency

description:
The time from when the flow was started to when the first packet was received.

nodetype: leaf (ro)

type: oc-types:timeticks64

/flows/flow/ingress-tracking/ingress-tracking/egress-tracking/egress-tracking/state/
convergence-time

description:
The time from when the first packet was received to when traffic loss dropped below a minimal threshold value.

nodetype: leaf (ro)

type: oc-types:timeticks64

/flows/flow/ingress-tracking/ingress-tracking/egress-tracking/egress-tracking/state/
counters

description:
Counters that correspond to the flow by egress tracking filter.

nodetype: container (ro)

/flows/flow/ingress-tracking/ingress-tracking/egress-tracking/egress-tracking/state/counters/
in-octets

description:
The total number of bytes received by the target for the flow.

nodetype: leaf (ro)

type: oc-yang:counter64

/flows/flow/ingress-tracking/ingress-tracking/egress-tracking/egress-tracking/state/counters/
in-pkts

description:
The total number of packets received by the target for the flow.

nodetype: leaf (ro)

type: oc-yang:counter64

/flows/flow/ingress-tracking/ingress-tracking/egress-tracking/egress-tracking/state/counters/
out-octets

description:
The total number of bytes sent by the target for the flow. These packets may be generated or forwarded by the target.

nodetype: leaf (ro)

type: oc-yang:counter64

/flows/flow/ingress-tracking/ingress-tracking/egress-tracking/egress-tracking/state/counters/
out-pkts

description:
The total number of packets sent by the target for the flow. These packets may be generated or forwarded by the target.

nodetype: leaf (ro)

type: oc-yang:counter64

/flows/flow/
egress-tracking

description:
Flow statistics grouped by egress tracking filter.

nodetype: container (ro)

/flows/flow/egress-tracking/
egress-tracking

description:
If the ATE is configured to track outgoing frames by a header field, this list will map values of that header field to the flow statistics specific to frames that match that value.

nodetype: list (ro)

list keys: [filter]

/flows/flow/egress-tracking/egress-tracking/
filter

description:
The filter value of the egress tracking configuration.

nodetype: leaf (list key) (ro)

type: leafref

  • path reference: ../state/filter

/flows/flow/egress-tracking/egress-tracking/
state

description:
Operational state of the flow by egress tracking filter.

nodetype: container (ro)

/flows/flow/egress-tracking/egress-tracking/state/
filter

description:
Value of the filter on which the egress stats are tracked

nodetype: leaf (ro)

type: string

/flows/flow/egress-tracking/egress-tracking/state/
loss-pct

description:
The percentage of transmitted packets that were not received by the destinations of the flow.

nodetype: leaf (ro)

type: oc-types:ieeefloat32

/flows/flow/egress-tracking/egress-tracking/state/
out-frame-rate

description:
The rate, measured in frames per second, at which frames are being transmitted for the flow.

nodetype: leaf (ro)

type: oc-types:ieeefloat32

/flows/flow/egress-tracking/egress-tracking/state/
in-frame-rate

description:
The rate, measured in frames per second, at which frames are being received for the flow.

nodetype: leaf (ro)

type: oc-types:ieeefloat32

/flows/flow/egress-tracking/egress-tracking/state/
out-rate

description:
The rate, measured in bits per second, at which the flow is being transmitted.

nodetype: leaf (ro)

type: oc-types:ieeefloat32

/flows/flow/egress-tracking/egress-tracking/state/
in-rate

description:
The rate, measured in bits per second, at which the flow is being received.

nodetype: leaf (ro)

type: oc-types:ieeefloat32

/flows/flow/egress-tracking/egress-tracking/state/
first-packet-latency

description:
The time from when the flow was started to when the first packet was received.

nodetype: leaf (ro)

type: oc-types:timeticks64

/flows/flow/egress-tracking/egress-tracking/state/
convergence-time

description:
The time from when the first packet was received to when traffic loss dropped below a minimal threshold value.

nodetype: leaf (ro)

type: oc-types:timeticks64

/flows/flow/egress-tracking/egress-tracking/state/
counters

description:
Counters that correspond to the flow by egress tracking filter.

nodetype: container (ro)

/flows/flow/egress-tracking/egress-tracking/state/counters/
in-octets

description:
The total number of bytes received by the target for the flow.

nodetype: leaf (ro)

type: oc-yang:counter64

/flows/flow/egress-tracking/egress-tracking/state/counters/
in-pkts

description:
The total number of packets received by the target for the flow.

nodetype: leaf (ro)

type: oc-yang:counter64

/flows/flow/egress-tracking/egress-tracking/state/counters/
out-octets

description:
The total number of bytes sent by the target for the flow. These packets may be generated or forwarded by the target.

nodetype: leaf (ro)

type: oc-yang:counter64

/flows/flow/egress-tracking/egress-tracking/state/counters/
out-pkts

description:
The total number of packets sent by the target for the flow. These packets may be generated or forwarded by the target.

nodetype: leaf (ro)

type: oc-yang:counter64