blob: 4b412aebe25b3a6206c522bc48e787ebb4879155 [file] [log] [blame]
Gaurav Agrawal28920d82017-10-06 17:39:42 +05301submodule ietf-snmp-engine {
2
3 belongs-to ietf-snmp {
4 prefix snmp;
5 }
6
7 import ietf-inet-types {
8 prefix inet;
9 }
10
11 include ietf-snmp-common;
12
13 organization
14 "IETF NETMOD (NETCONF Data Modeling Language) Working Group";
15
16 contact
17 "WG Web: <http://tools.ietf.org/wg/netmod/>
18 WG List: <mailto:netmod@ietf.org>
19
20 WG Chair: Thomas Nadeau
21 <mailto:tnadeau@lucidvision.com>
22
23 WG Chair: Juergen Schoenwaelder
24 <mailto:j.schoenwaelder@jacobs-university.de>
25
26 Editor: Martin Bjorklund
27 <mailto:mbj@tail-f.com>
28
29 Editor: Juergen Schoenwaelder
30 <mailto:j.schoenwaelder@jacobs-university.de>";
31
32 description
33 "This submodule contains a collection of YANG definitions
34 for configuring SNMP engines.
35
36 Copyright (c) 2014 IETF Trust and the persons identified as
37 authors of the code. All rights reserved.
38
39 Redistribution and use in source and binary forms, with or
40 without modification, is permitted pursuant to, and subject
41 to the license terms contained in, the Simplified BSD License
42 set forth in Section 4.c of the IETF Trust's Legal Provisions
43 Relating to IETF Documents
44 (http://trustee.ietf.org/license-info).
45 This version of this YANG module is part of RFC 7407; see
46 the RFC itself for full legal notices.";
47
48 revision 2014-12-10 {
49 description
50 "Initial revision.";
51 reference
52 "RFC 7407: A YANG Data Model for SNMP Configuration";
53 }
54
55 augment /snmp:snmp {
56
57 container engine {
58
59 description
60 "Configuration of the SNMP engine.";
61
62 leaf enabled {
63 type boolean;
64 default "false";
65 description
66 "Enables the SNMP engine.";
67 }
68
69 list listen {
70 key "name";
71 description
72 "Configuration of the transport endpoints on which the
73 engine listens.";
74
75 leaf name {
76 type snmp:identifier;
77 description
78 "An arbitrary name for the list entry.";
79 }
80
81 choice transport {
82 mandatory true;
83 description
84 "The transport-protocol-specific parameters for this
85 endpoint. Submodules providing configuration for
86 additional transports are expected to augment this
87 choice.";
88 case udp {
89 container udp {
90 leaf ip {
91 type inet:ip-address;
92 mandatory true;
93 description
94 "The IPv4 or IPv6 address on which the engine
95 listens.";
96 }
97 leaf port {
98 type inet:port-number;
99 description
100 "The UDP port on which the engine listens.
101
102 If the port is not configured, an engine that
103 acts as a Command Responder uses port 161, and
104 an engine that acts as a Notification Receiver
105 uses port 162.";
106 }
107 }
108 }
109 }
110 }
111
112 container version {
113 description
114 "SNMP version used by the engine.";
115 leaf v1 {
116 type empty;
117 }
118 leaf v2c {
119 type empty;
120 }
121 leaf v3 {
122 type empty;
123 }
124 }
125
126 leaf engine-id {
127 type snmp:engine-id;
128 description
129 "The local SNMP engine's administratively assigned unique
130 identifier.
131
132 If this leaf is not set, the device automatically
133 calculates an engine ID, as described in RFC 3411. A
134 server MAY initialize this leaf with the automatically
135 created value.";
136 reference
137 "RFC 3411: An Architecture for Describing Simple Network
138 Management Protocol (SNMP) Management
139 Frameworks.
140 SNMP-FRAMEWORK-MIB.snmpEngineID";
141 }
142
143 leaf enable-authen-traps {
144 type boolean;
145 description
146 "Indicates whether the SNMP entity is permitted to
147 generate authenticationFailure traps.";
148 reference
149 "RFC 3418: Management Information Base (MIB) for the
150 Simple Network Management Protocol (SNMP)
151 SNMPv2-MIB.snmpEnableAuthenTraps";
152 }
153 }
154 }
155}