Blob Blame History Raw
<?xml version="1.0" encoding="UTF-8"?>
<submodule name="ietf-snmp-engine"
           xmlns="urn:ietf:params:xml:ns:yang:yin:1"
           xmlns:snmp="urn:ietf:params:xml:ns:yang:ietf-snmp"
           xmlns:inet="urn:ietf:params:xml:ns:yang:ietf-inet-types">
  <belongs-to module="ietf-snmp">
    <prefix value="snmp"/>
  </belongs-to>
  <import module="ietf-inet-types">
    <prefix value="inet"/>
  </import>
  <include module="ietf-snmp-common"/>
  <organization>
    <text>IETF NETMOD (NETCONF Data Modeling Language) Working Group</text>
  </organization>
  <contact>
    <text>WG Web:   &lt;http://tools.ietf.org/wg/netmod/&gt;
WG List:  &lt;mailto:netmod@ietf.org&gt;

WG Chair: Thomas Nadeau
          &lt;mailto:tnadeau@lucidvision.com&gt;

WG Chair: Juergen Schoenwaelder
          &lt;mailto:j.schoenwaelder@jacobs-university.de&gt;

Editor:   Martin Bjorklund
          &lt;mailto:mbj@tail-f.com&gt;

Editor:   Juergen Schoenwaelder
          &lt;mailto:j.schoenwaelder@jacobs-university.de&gt;</text>
  </contact>
  <description>
    <text>This submodule contains a collection of YANG definitions
for configuring SNMP engines.

Copyright (c) 2014 IETF Trust and the persons identified as
authors of the code.  All rights reserved.

Redistribution and use in source and binary forms, with or
without modification, is permitted pursuant to, and subject
to the license terms contained in, the Simplified BSD License
set forth in Section 4.c of the IETF Trust's Legal Provisions
Relating to IETF Documents
(http://trustee.ietf.org/license-info).
This version of this YANG module is part of RFC 7407; see
the RFC itself for full legal notices.</text>
  </description>
  <revision date="2014-12-10">
    <description>
      <text>Initial revision.</text>
    </description>
    <reference>
      <text>RFC 7407: A YANG Data Model for SNMP Configuration</text>
    </reference>
  </revision>
  <augment target-node="/snmp:snmp">
    <container name="engine">
      <description>
        <text>Configuration of the SNMP engine.</text>
      </description>
      <leaf name="enabled">
        <type name="boolean"/>
        <default value="false"/>
        <description>
          <text>Enables the SNMP engine.</text>
        </description>
      </leaf>
      <list name="listen">
        <key value="name"/>
        <description>
          <text>Configuration of the transport endpoints on which the
engine listens.</text>
        </description>
        <leaf name="name">
          <type name="snmp:identifier"/>
          <description>
            <text>An arbitrary name for the list entry.</text>
          </description>
        </leaf>
        <choice name="transport">
          <mandatory value="true"/>
          <description>
            <text>The transport-protocol-specific parameters for this
endpoint.  Submodules providing configuration for
additional transports are expected to augment this
choice.</text>
          </description>
          <case name="udp">
            <container name="udp">
              <leaf name="ip">
                <type name="inet:ip-address"/>
                <mandatory value="true"/>
                <description>
                  <text>The IPv4 or IPv6 address on which the engine
listens.</text>
                </description>
              </leaf>
              <leaf name="port">
                <type name="inet:port-number"/>
                <description>
                  <text>The UDP port on which the engine listens.

If the port is not configured, an engine that
acts as a Command Responder uses port 161, and
an engine that acts as a Notification Receiver
uses port 162.</text>
                </description>
              </leaf>
            </container>
          </case>
        </choice>
      </list>
      <container name="version">
        <description>
          <text>SNMP version used by the engine.</text>
        </description>
        <leaf name="v1">
          <type name="empty"/>
        </leaf>
        <leaf name="v2c">
          <type name="empty"/>
        </leaf>
        <leaf name="v3">
          <type name="empty"/>
        </leaf>
      </container>
      <leaf name="engine-id">
        <type name="snmp:engine-id"/>
        <description>
          <text>The local SNMP engine's administratively assigned unique
identifier.

If this leaf is not set, the device automatically
calculates an engine ID, as described in RFC 3411.  A
server MAY initialize this leaf with the automatically
created value.</text>
        </description>
        <reference>
          <text>RFC 3411: An Architecture for Describing Simple Network
  Management Protocol (SNMP) Management
  Frameworks.
  SNMP-FRAMEWORK-MIB.snmpEngineID</text>
        </reference>
      </leaf>
      <leaf name="enable-authen-traps">
        <type name="boolean"/>
        <description>
          <text>Indicates whether the SNMP entity is permitted to
generate authenticationFailure traps.</text>
        </description>
        <reference>
          <text>RFC 3418: Management Information Base (MIB) for the
  Simple Network Management Protocol (SNMP)
  SNMPv2-MIB.snmpEnableAuthenTraps</text>
        </reference>
      </leaf>
    </container>
  </augment>
</submodule>