openconfig-probes-types

openconfig-version: 0.1.1

Description

This module defines types related to the probes.

Imports

openconfig-extensions

Defined types

test-type

description:
Type definition with enumerations describing the basis of the probe test type identifier

type: enumeration

  • ICMP
    Send ICMP echo requests.
  • ICMP6
    Send ICMP6 echo requests.
  • ICMP_TIMESTAMP
    Send ICMP timestamp requests.
  • ICMP6_TIMESTAMP
    Sedn ICMP6 timestamp requests.
  • TCP
    Send TPC packets.
  • UDP
    Send UDP packets.
  • UDP_TIMESTAMP
    Send UDP packets with timestamp.
  • HTTP_GET
    Execute HTTP GET requests.
  • HTTP_GET_META
    Execute HTTP GET requests of metadata.

Data elements

openconfig-probes

openconfig-version: 0.0.2

Description

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.

Imports

ietf-yang-types
openconfig-types
openconfig-extensions
openconfig-inet-types
openconfig-probes-types

Data elements

/
probes

description:
The container containing the list of probes.

nodetype: container (rw)

/probes/
probe

description:
List of probes configured.

nodetype: list (rw)

list keys: [name]

/probes/probe/
name

description:
Reference to the list key

nodetype: leaf (list key) (rw)

type: leafref

  • path reference: ../config/name

/probes/probe/
config

description:
Configuration data for the probes.

nodetype: container (rw)

/probes/probe/config/
name

description:
The name of the probe.

nodetype: leaf (rw)

type: string

/probes/probe/config/
enabled

description:
Whether the probe is enabled.

nodetype: leaf (rw)

type: boolean

default: true

/probes/probe/
state

description:
Operational state data

nodetype: container (ro)

/probes/probe/state/
name

description:
The name of the probe.

nodetype: leaf (ro)

type: string

/probes/probe/state/
enabled

description:
Whether the probe is enabled.

nodetype: leaf (ro)

type: boolean

default: true

/probes/probe/
tests

description:
The tests associated to be executed for the probe.

nodetype: container (rw)

/probes/probe/tests/
test

description:
List of tests associated with this probe.

nodetype: list (rw)

list keys: [name]

/probes/probe/tests/test/
name

description:
Reference to the list key

nodetype: leaf (list key) (rw)

type: leafref

  • path reference: ../config/name

/probes/probe/tests/test/
config

description:
Configuration data for the test of this probe.

nodetype: container (rw)

/probes/probe/tests/test/config/
name

description:
The name of the test probe

nodetype: leaf (rw)

type: string

/probes/probe/tests/test/config/
enabled

description:
Whether the test is enabled.

nodetype: leaf (rw)

type: boolean

default: true

/probes/probe/tests/test/config/
test-type

description:
The type of the probe test.

nodetype: leaf (rw)

type: oc-probes-types:test-type

/probes/probe/tests/test/config/
count

description:
The number of probes per test.

nodetype: leaf (rw)

type: yang:counter64

/probes/probe/tests/test/config/
interval

description:
Time between two consecutive probes.

nodetype: leaf (rw)

type: yang:counter64

/probes/probe/tests/test/config/
source

description:
Source address used when probing, either IPv4 or IPv6.

nodetype: leaf (rw)

type: oc-inet:ip-address

/probes/probe/tests/test/config/
history-size

description:
The number of history entries stored.

nodetype: leaf (rw)

type: yang:counter64

/probes/probe/tests/test/config/
source-port

description:
Source number used.

nodetype: leaf (rw)

type: oc-inet:port-number

/probes/probe/tests/test/config/
dscp

description:
DSCP code points

nodetype: leaf (rw)

type: oc-inet:dscp

/probes/probe/tests/test/
state

description:
Operational state data

nodetype: container (ro)

/probes/probe/tests/test/state/
name

description:
The name of the test probe

nodetype: leaf (ro)

type: string

/probes/probe/tests/test/state/
enabled

description:
Whether the test is enabled.

nodetype: leaf (ro)

type: boolean

default: true

/probes/probe/tests/test/state/
test-type

description:
The type of the probe test.

nodetype: leaf (ro)

type: oc-probes-types:test-type

/probes/probe/tests/test/state/
count

description:
The number of probes per test.

nodetype: leaf (ro)

type: yang:counter64

/probes/probe/tests/test/state/
interval

description:
Time between two consecutive probes.

nodetype: leaf (ro)

type: yang:counter64

/probes/probe/tests/test/state/
source

description:
Source address used when probing, either IPv4 or IPv6.

nodetype: leaf (ro)

type: oc-inet:ip-address

/probes/probe/tests/test/state/
history-size

description:
The number of history entries stored.

nodetype: leaf (ro)

type: yang:counter64

/probes/probe/tests/test/state/
source-port

description:
Source number used.

nodetype: leaf (ro)

type: oc-inet:port-number

/probes/probe/tests/test/state/
dscp

description:
DSCP code points

nodetype: leaf (ro)

type: oc-inet:dscp

/probes/probe/tests/test/
target

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)

/probes/probe/tests/test/target/
config

description:
Configuration data for the test target.

nodetype: container (rw)

/probes/probe/tests/test/target/config/
address

description:
IP address of the target, either IPv4 or IPv6.

nodetype: leaf (rw)

type: oc-inet:ip-address

/probes/probe/tests/test/target/config/
port

description:
Destination port.

nodetype: leaf (rw)

type: oc-inet:port-number

/probes/probe/tests/test/target/config/
url

description:
Target URL to probe.

nodetype: leaf (rw)

type: oc-inet:url

/probes/probe/tests/test/target/
state

description:
Operational data for the test target.

nodetype: container (ro)

/probes/probe/tests/test/target/state/
address

description:
IP address of the target, either IPv4 or IPv6.

nodetype: leaf (ro)

type: oc-inet:ip-address

/probes/probe/tests/test/target/state/
port

description:
Destination port.

nodetype: leaf (ro)

type: oc-inet:port-number

/probes/probe/tests/test/target/state/
url

description:
Target URL to probe.

nodetype: leaf (ro)

type: oc-inet:url

/probes/probe/tests/test/
results

description:
Contains the results of the tests.

nodetype: container (rw)

/probes/probe/tests/test/results/
state

description:
Results of this test: operational data only

nodetype: container (ro)

/probes/probe/tests/test/results/state/
timestamp

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

/probes/probe/tests/test/results/state/
start-timestamp

description:
The timestamp when the test started.

nodetype: leaf (ro)

type: oc-types:timeticks64

/probes/probe/tests/test/results/state/
last-test-timestamp

description:
The timestamp when the test finished.

nodetype: leaf (ro)

type: oc-types:timeticks64

/probes/probe/tests/test/results/state/
test-duration

description:
The duration of the test, in microseconds.

nodetype: leaf (ro)

type: yang:counter64

/probes/probe/tests/test/results/state/
failed

description:
Whether the test failed or succeeded.

nodetype: leaf (ro)

type: boolean

/probes/probe/tests/test/results/state/
probes-sent

description:
Number of test probes sent.

nodetype: leaf (ro)

type: yang:counter64

/probes/probe/tests/test/results/state/
probes-received

description:
Number of test probes received.

nodetype: leaf (ro)

type: yang:counter64

/probes/probe/tests/test/results/state/
loss-percentage

description:
The loss percentage.

nodetype: leaf (ro)

type: oc-types:percentage

/probes/probe/tests/test/results/state/
jitter

description:
The round trip jitter, in microseconds.

nodetype: leaf (ro)

type: yang:counter64

/probes/probe/tests/test/results/state/
min-delay

description:
The minimum delay recorded during the test, in microseconds.

nodetype: leaf (ro)

type: yang:counter64

/probes/probe/tests/test/results/state/
max-delay

description:
The maximum delay recorded during the test, in microseconds.

nodetype: leaf (ro)

type: yang:counter64

/probes/probe/tests/test/results/state/
avg-delay

description:
The average delay recorded during the test, in microseconds.

nodetype: leaf (ro)

type: yang:counter64

/probes/probe/tests/test/results/state/
stddev-delay

description:
The standard deviation of the delay of the test.

nodetype: leaf (ro)

type: yang:counter64

/probes/probe/tests/test/results/
history

description:
Historical data of the tests.

nodetype: container (ro)

/probes/probe/tests/test/results/history/
items

description:
The list of items in the probe history. The length depends on the history size.

nodetype: container (ro)

/probes/probe/tests/test/results/history/items/
item

description:
List of history items.

nodetype: list (ro)

list keys: [id]

/probes/probe/tests/test/results/history/items/item/
id

description:
Reference to the history entry ID.

nodetype: leaf (list key) (ro)

type: leafref

  • path reference: ../state/id

/probes/probe/tests/test/results/history/items/item/
state

description:
A history item of the probe results: operational data only.

nodetype: container (ro)

/probes/probe/tests/test/results/history/items/item/state/
id

description:
The test item ID.

nodetype: leaf (ro)

type: yang:counter64

/probes/probe/tests/test/results/history/items/item/state/
timestamp

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

/probes/probe/tests/test/results/history/items/item/state/
start-timestamp

description:
The timestamp when the test started.

nodetype: leaf (ro)

type: oc-types:timeticks64

/probes/probe/tests/test/results/history/items/item/state/
end-timestamp

description:
The timestamp when the test finished.

nodetype: leaf (ro)

type: oc-types:timeticks64

/probes/probe/tests/test/results/history/items/item/state/
test-duration

description:
The duration of the test, in microseconds.

nodetype: leaf (ro)

type: yang:counter64

/probes/probe/tests/test/results/history/items/item/state/
failed

description:
Whether the test failed or succeeded.

nodetype: leaf (ro)

type: boolean

/probes/probe/tests/test/results/history/items/item/state/
probes-sent

description:
Number of test probes sent.

nodetype: leaf (ro)

type: yang:counter64

/probes/probe/tests/test/results/history/items/item/state/
probes-received

description:
Number of test probes received.

nodetype: leaf (ro)

type: yang:counter64

/probes/probe/tests/test/results/history/items/item/state/
loss-percentage

description:
The loss percentage.

nodetype: leaf (ro)

type: oc-types:percentage

/probes/probe/tests/test/results/history/items/item/state/
jitter

description:
The round trip jitter, in microseconds.

nodetype: leaf (ro)

type: yang:counter64

/probes/probe/tests/test/results/history/items/item/state/
min-delay

description:
The minimum delay recorded during the test, in microseconds.

nodetype: leaf (ro)

type: yang:counter64

/probes/probe/tests/test/results/history/items/item/state/
max-delay

description:
The maximum delay recorded during the test, in microseconds.

nodetype: leaf (ro)

type: yang:counter64

/probes/probe/tests/test/results/history/items/item/state/
avg-delay

description:
The average delay recorded during the test, in microseconds.

nodetype: leaf (ro)

type: yang:counter64

/probes/probe/tests/test/results/history/items/item/state/
stddev-delay

description:
The standard deviation of the delay of the test.

nodetype: leaf (ro)

type: yang:counter64