This module defines top-level configuration and operational state data related to traffic sampling.
For modularity purposes, the top-level sampling container provides a natural attachment point for implementations such as sFlow, IPFix, NETFLOW
openconfig-extensions
description:
Top-level container for sampling-related configuration and
operational state data
nodetype: container (rw)
description:
Top-level container for sFlow data.
nodetype: container (rw)
description:
Configuration data for global sFlow.
nodetype: container (rw)
description:
Enables or disables sFlow sampling for the device.
nodetype: leaf (rw)
type: boolean
default: false
description:
Sets the agent identifier for IPv4 PDUs.
nodetype: leaf (rw)
type: oc-inet:ipv4-address
description:
Sets the agent identifier for IPv6 PDUs.
nodetype: leaf (rw)
type: oc-inet:ipv6-address
description:
DSCP marking of packets generated by the sFlow subsystem
on the network device.
nodetype: leaf (rw)
type: oc-inet:dscp
description:
Sets the maximum number of bytes to be copied from a
sampled packet.
nodetype: leaf (rw)
type: uint16
default: 128
units: bytes
description:
Sets the traffic sampling polling interval.
nodetype: leaf (rw)
type: uint16
units: seconds
description:
Sets the ingress packet sampling rate. The rate is expressed
as an integer N, where the intended sampling rate is 1/N
packets. An implementation may implement the sampling rate as
a statistical average, rather than a strict periodic sampling.
The allowable sampling rate range is generally a property of
the system, e.g., determined by the capability of the
hardware.
nodetype: leaf (rw)
type: uint32
description:
Sets the egress packet sampling rate. The rate is expressed
as an integer N, where the intended sampling rate is 1/N
packets. An implementation may implement the sampling rate as
a statistical average, rather than a strict periodic sampling.
The allowable sampling rate range is generally a property of
the system, e.g., determined by the capability of the
hardware.
nodetype: leaf (rw)
type: uint32
description:
Operational state data for global sFlow.
nodetype: container (ro)
description:
Enables or disables sFlow sampling for the device.
nodetype: leaf (ro)
type: boolean
default: false
description:
Sets the agent identifier for IPv4 PDUs.
nodetype: leaf (ro)
type: oc-inet:ipv4-address
description:
Sets the agent identifier for IPv6 PDUs.
nodetype: leaf (ro)
type: oc-inet:ipv6-address
description:
DSCP marking of packets generated by the sFlow subsystem
on the network device.
nodetype: leaf (ro)
type: oc-inet:dscp
description:
Sets the maximum number of bytes to be copied from a
sampled packet.
nodetype: leaf (ro)
type: uint16
default: 128
units: bytes
description:
Sets the traffic sampling polling interval.
nodetype: leaf (ro)
type: uint16
units: seconds
description:
Sets the ingress packet sampling rate. The rate is expressed
as an integer N, where the intended sampling rate is 1/N
packets. An implementation may implement the sampling rate as
a statistical average, rather than a strict periodic sampling.
The allowable sampling rate range is generally a property of
the system, e.g., determined by the capability of the
hardware.
nodetype: leaf (ro)
type: uint32
description:
Sets the egress packet sampling rate. The rate is expressed
as an integer N, where the intended sampling rate is 1/N
packets. An implementation may implement the sampling rate as
a statistical average, rather than a strict periodic sampling.
The allowable sampling rate range is generally a property of
the system, e.g., determined by the capability of the
hardware.
nodetype: leaf (ro)
type: uint32
description:
Enclosing container for list of sFlow collectors.
nodetype: container (rw)
description:
List of sFlow collectors to send sampling data. Packet
samples are sent to all collectors specified.
nodetype: list (rw)
description:
Reference to address list key.
nodetype: leaf (list key) (rw)
type: leafref
description:
Reference to port list key.
nodetype: leaf (list key) (rw)
type: leafref
description:
Configuration data for sFlow collectors.
nodetype: container (rw)
description:
IPv4/IPv6 address of the sFlow collector.
nodetype: leaf (rw)
type: oc-inet:ip-address
description:
UDP port number for the sFlow collector.
nodetype: leaf (rw)
type: oc-inet:port-number
default: 6343
description:
Sets the source IPv4/IPv6 address for sFlow datagrams sent
to sFlow collectors.
nodetype: leaf (rw)
type: oc-inet:ip-address
description:
Reference to the network instance used to reach the
sFlow collector. If uspecified, the collector destination
is reachable in the default network instance.
nodetype: leaf (rw)
type: oc-netinst:network-instance-ref
description:
Operational state data for sFlow collectors.
nodetype: container (ro)
description:
IPv4/IPv6 address of the sFlow collector.
nodetype: leaf (ro)
type: oc-inet:ip-address
description:
UDP port number for the sFlow collector.
nodetype: leaf (ro)
type: oc-inet:port-number
default: 6343
description:
Sets the source IPv4/IPv6 address for sFlow datagrams sent
to sFlow collectors.
nodetype: leaf (ro)
type: oc-inet:ip-address
description:
Reference to the network instance used to reach the
sFlow collector. If uspecified, the collector destination
is reachable in the default network instance.
nodetype: leaf (ro)
type: oc-netinst:network-instance-ref
description:
The total number of packets sampled and sent to the
collector.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Enclosing container for list of sFlow interfaces.
nodetype: container (rw)
description:
List of interfaces with sFlow data.
nodetype: list (rw)
list keys: [name]
description:
Reference to list key.
nodetype: leaf (list key) (rw)
type: leafref
description:
Configuration data for sFlow data on interfaces.
nodetype: container (rw)
description:
Reference to the interface for sFlow configuration and
state.
nodetype: leaf (rw)
type: oc-if:base-interface-ref
description:
Enables or disables sFlow on the interface. If sFlow is
globally disabled, this leaf is ignored. If sFlow
is globally enabled, this leaf may be used to disable it
for a specific interface.
nodetype: leaf (rw)
type: boolean
description:
Sets the traffic sampling polling interval.
nodetype: leaf (rw)
type: uint16
units: seconds
description:
Sets the ingress packet sampling rate. The rate is expressed
as an integer N, where the intended sampling rate is 1/N
packets. An implementation may implement the sampling rate as
a statistical average, rather than a strict periodic sampling.
The allowable sampling rate range is generally a property of
the system, e.g., determined by the capability of the
hardware.
nodetype: leaf (rw)
type: uint32
description:
Sets the egress packet sampling rate. The rate is expressed
as an integer N, where the intended sampling rate is 1/N
packets. An implementation may implement the sampling rate as
a statistical average, rather than a strict periodic sampling.
The allowable sampling rate range is generally a property of
the system, e.g., determined by the capability of the
hardware.
nodetype: leaf (rw)
type: uint32
description:
Operational state data for sFlow data on interfaces.
nodetype: container (ro)
description:
Reference to the interface for sFlow configuration and
state.
nodetype: leaf (ro)
type: oc-if:base-interface-ref
description:
Enables or disables sFlow on the interface. If sFlow is
globally disabled, this leaf is ignored. If sFlow
is globally enabled, this leaf may be used to disable it
for a specific interface.
nodetype: leaf (ro)
type: boolean
description:
Sets the traffic sampling polling interval.
nodetype: leaf (ro)
type: uint16
units: seconds
description:
Sets the ingress packet sampling rate. The rate is expressed
as an integer N, where the intended sampling rate is 1/N
packets. An implementation may implement the sampling rate as
a statistical average, rather than a strict periodic sampling.
The allowable sampling rate range is generally a property of
the system, e.g., determined by the capability of the
hardware.
nodetype: leaf (ro)
type: uint32
description:
Sets the egress packet sampling rate. The rate is expressed
as an integer N, where the intended sampling rate is 1/N
packets. An implementation may implement the sampling rate as
a statistical average, rather than a strict periodic sampling.
The allowable sampling rate range is generally a property of
the system, e.g., determined by the capability of the
hardware.
nodetype: leaf (ro)
type: uint32
description:
Total number of packets sampled from the interface.
nodetype: leaf (ro)
type: oc-yang:counter64
This module defines configuration and operational state data related to data plane traffic sampling based on sFlow.
RFC 3176 - InMon Corporation's sFlow: A Method for Monitoring Traffic in Switched and Routed Networks
openconfig-extensions
openconfig-inet-types
openconfig-interfaces
openconfig-yang-types
openconfig-network-instance
openconfig-sampling