This module defines types related to the probes.
openconfig-extensions
description:
Type definition with enumerations describing the basis of
the probe test type identifier
type: enumeration
This module defines configuration and operational state data for the probes. A probe consists on a group of tests, each test being a source-destination pair to poll. The destination can be either IP Address (and eventually port) or URL, depending on the nature of the test. The test can send ICMP, UDP, TCP, or HTTP requests. Each test groups a list of test items, the test results being an overall view or average of the items list. However, the test preserves only a limited set of history items, whose length can be controlled using the history-size.
ietf-yang-types
openconfig-types
openconfig-extensions
openconfig-inet-types
openconfig-probes-types
description:
The container containing the list of probes.
nodetype: container (rw)
description:
List of probes configured.
nodetype: list (rw)
list keys: [name]
description:
Reference to the list key
nodetype: leaf (list key) (rw)
type: leafref
description:
Configuration data for the probes.
nodetype: container (rw)
description:
The name of the probe.
nodetype: leaf (rw)
type: string
description:
Whether the probe is enabled.
nodetype: leaf (rw)
type: boolean
default: true
description:
Operational state data
nodetype: container (ro)
description:
The name of the probe.
nodetype: leaf (ro)
type: string
description:
Whether the probe is enabled.
nodetype: leaf (ro)
type: boolean
default: true
description:
The tests associated to be executed for the probe.
nodetype: container (rw)
description:
List of tests associated with this probe.
nodetype: list (rw)
list keys: [name]
description:
Reference to the list key
nodetype: leaf (list key) (rw)
type: leafref
description:
Configuration data for the test of this probe.
nodetype: container (rw)
description:
The name of the test probe
nodetype: leaf (rw)
type: string
description:
Whether the test is enabled.
nodetype: leaf (rw)
type: boolean
default: true
description:
The type of the probe test.
nodetype: leaf (rw)
type: oc-probes-types:test-type
description:
The number of probes per test.
nodetype: leaf (rw)
type: yang:counter64
description:
Time between two consecutive probes.
nodetype: leaf (rw)
type: yang:counter64
description:
Source address used when probing, either IPv4 or IPv6.
nodetype: leaf (rw)
type: oc-inet:ip-address
description:
The number of history entries stored.
nodetype: leaf (rw)
type: yang:counter64
description:
Source number used.
nodetype: leaf (rw)
type: oc-inet:port-number
description:
DSCP code points
nodetype: leaf (rw)
type: oc-inet:dscp
description:
Operational state data
nodetype: container (ro)
description:
The name of the test probe
nodetype: leaf (ro)
type: string
description:
Whether the test is enabled.
nodetype: leaf (ro)
type: boolean
default: true
description:
The type of the probe test.
nodetype: leaf (ro)
type: oc-probes-types:test-type
description:
The number of probes per test.
nodetype: leaf (ro)
type: yang:counter64
description:
Time between two consecutive probes.
nodetype: leaf (ro)
type: yang:counter64
description:
Source address used when probing, either IPv4 or IPv6.
nodetype: leaf (ro)
type: oc-inet:ip-address
description:
The number of history entries stored.
nodetype: leaf (ro)
type: yang:counter64
description:
Source number used.
nodetype: leaf (ro)
type: oc-inet:port-number
description:
DSCP code points
nodetype: leaf (ro)
type: oc-inet:dscp
description:
The target configuration of the test.
The nature of the target depends on the probe type:
for HTTP probes we need to provide an URL to poll,
while ICMP probes require an IP address to monitor.
nodetype: container (rw)
description:
Configuration data for the test target.
nodetype: container (rw)
description:
IP address of the target, either IPv4 or IPv6.
nodetype: leaf (rw)
type: oc-inet:ip-address
description:
Destination port.
nodetype: leaf (rw)
type: oc-inet:port-number
description:
Target URL to probe.
nodetype: leaf (rw)
type: oc-inet:url
description:
Operational data for the test target.
nodetype: container (ro)
description:
IP address of the target, either IPv4 or IPv6.
nodetype: leaf (ro)
type: oc-inet:ip-address
description:
Destination port.
nodetype: leaf (ro)
type: oc-inet:port-number
description:
Target URL to probe.
nodetype: leaf (ro)
type: oc-inet:url
description:
Contains the results of the tests.
nodetype: container (rw)
description:
Results of this test: operational data only
nodetype: container (ro)
description:
The test timestamp.
This is not the timestamp when the test
was actually executed nither when it finished.
Should be the timestamp when the test has been scheduled.
It may not be the same with start-timestamp.
nodetype: leaf (ro)
type: oc-types:timeticks64
description:
The timestamp when the test started.
nodetype: leaf (ro)
type: oc-types:timeticks64
description:
The timestamp when the test finished.
nodetype: leaf (ro)
type: oc-types:timeticks64
description:
The duration of the test, in microseconds.
nodetype: leaf (ro)
type: yang:counter64
description:
Whether the test failed or succeeded.
nodetype: leaf (ro)
type: boolean
description:
Number of test probes sent.
nodetype: leaf (ro)
type: yang:counter64
description:
Number of test probes received.
nodetype: leaf (ro)
type: yang:counter64
description:
The loss percentage.
nodetype: leaf (ro)
type: oc-types:percentage
description:
The round trip jitter, in microseconds.
nodetype: leaf (ro)
type: yang:counter64
description:
The minimum delay recorded during the test, in microseconds.
nodetype: leaf (ro)
type: yang:counter64
description:
The maximum delay recorded during the test, in microseconds.
nodetype: leaf (ro)
type: yang:counter64
description:
The average delay recorded during the test, in microseconds.
nodetype: leaf (ro)
type: yang:counter64
description:
The standard deviation of the delay of the test.
nodetype: leaf (ro)
type: yang:counter64
description:
Historical data of the tests.
nodetype: container (ro)
description:
The list of items in the probe history.
The length depends on the history size.
nodetype: container (ro)
description:
List of history items.
nodetype: list (ro)
list keys: [id]
description:
Reference to the history entry ID.
nodetype: leaf (list key) (ro)
type: leafref
description:
A history item of the probe results: operational data only.
nodetype: container (ro)
description:
The test item ID.
nodetype: leaf (ro)
type: yang:counter64
description:
The test timestamp.
This is not the timestamp when the test
was actually executed nither when it finished.
Should be the timestamp when the test has been scheduled.
It may not be the same with start-timestamp.
nodetype: leaf (ro)
type: oc-types:timeticks64
description:
The timestamp when the test started.
nodetype: leaf (ro)
type: oc-types:timeticks64
description:
The timestamp when the test finished.
nodetype: leaf (ro)
type: oc-types:timeticks64
description:
The duration of the test, in microseconds.
nodetype: leaf (ro)
type: yang:counter64
description:
Whether the test failed or succeeded.
nodetype: leaf (ro)
type: boolean
description:
Number of test probes sent.
nodetype: leaf (ro)
type: yang:counter64
description:
Number of test probes received.
nodetype: leaf (ro)
type: yang:counter64
description:
The loss percentage.
nodetype: leaf (ro)
type: oc-types:percentage
description:
The round trip jitter, in microseconds.
nodetype: leaf (ro)
type: yang:counter64
description:
The minimum delay recorded during the test, in microseconds.
nodetype: leaf (ro)
type: yang:counter64
description:
The maximum delay recorded during the test, in microseconds.
nodetype: leaf (ro)
type: yang:counter64
description:
The average delay recorded during the test, in microseconds.
nodetype: leaf (ro)
type: yang:counter64
description:
The standard deviation of the delay of the test.
nodetype: leaf (ro)
type: yang:counter64