summaryrefslogtreecommitdiffstats
path: root/yang/frr-backend.yang
blob: 7149cbb991e0663c0a9c09c799a5f146280d73c0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
// SPDX-License-Identifier: BSD-2-Clause
module frr-backend {
  yang-version 1.1;
  namespace "http://frrouting.org/yang/oper";
  prefix frr-backend;

  organization
    "FRRouting";
  contact
    "FRR Users List:       <mailto:frog@lists.frrouting.org>
     FRR Development List: <mailto:dev@lists.frrouting.org>";
  description
    "This module defines a model for FRR backend management.

     Copyright (c) 2024, LabN Consulting, L.L.C.

     Redistribution and use in source and binary forms, with or without
     modification, are permitted provided that the following conditions
     are met:

     1. Redistributions of source code must retain the above copyright notice,
     this list of conditions and the following disclaimer.

     2. Redistributions in binary form must reproduce the above copyright
     notice, this list of conditions and the following disclaimer in the
     documentation and/or other materials provided with the distribution.

     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
     \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
     LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
     A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
     HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
     SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
     LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
     DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
     THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
     OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.";

  revision 2024-12-29 {
    description "Initial revision";
    reference "FRR source code";
  }

  container clients {
    config false;
    description "The backend clients";

    list client {
      key name;
      description "A backend client";

      leaf name {
        type string;
        description "Name of the backend client";
      }

      container state {
        description "FRR backend operational state";

        leaf candidate-config-version {
          type uint64;
          description "Local candidate config version.";
        }
        leaf running-config-version {
          type uint64;
          description "Local running config version.";
        }
        leaf edit-count {
          type uint64;
          description "Number of config edits handled.";
        }
        leaf avg-edit-time {
          type uint64;
          description "Average edit time in microseconds.";
        }
        leaf prep-count {
          type uint64;
          description "Number of config preps handled.";
        }
        leaf avg-prep-time {
          type uint64;
          description "Average prep time in microseconds.";
        }
        leaf apply-count {
          type uint64;
          description "Number of config applies handled.";
        }
        leaf avg-apply-time {
          type uint64;
          description "Average apply time in microseconds.";
        }
        leaf-list notify-selectors {
          type string;
          description
            "List of paths identifying which state to send change
               notifications for.";
        }
      }
    }
  }
}