Blob Blame History Raw
<?xml version="1.0" encoding="UTF-8"?>
<submodule name="ietf-snmp-target"
           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 targets.

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>
  <reference>
    <text>RFC 3413: Simple Network Management Protocol (SNMP)
  Applications</text>
  </reference>
  <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">
    <list name="target">
      <key value="name"/>
      <description>
        <text>List of targets.</text>
      </description>
      <reference>
        <text>RFC 3413: Simple Network Management Protocol (SNMP)
  Applications.
  SNMP-TARGET-MIB.snmpTargetAddrTable</text>
      </reference>
      <leaf name="name">
        <type name="snmp:identifier"/>
        <description>
          <text>Identifies the target.</text>
        </description>
        <reference>
          <text>RFC 3413: Simple Network Management Protocol (SNMP)
  Applications.
  SNMP-TARGET-MIB.snmpTargetAddrName</text>
        </reference>
      </leaf>
      <choice name="transport">
        <mandatory value="true"/>
        <description>
          <text>Transport address of the target.

The snmpTargetAddrTDomain and snmpTargetAddrTAddress
objects are mapped to transport-specific YANG nodes.  Each
transport is configured as a separate case in this
choice.  Submodules providing configuration for additional
transports are expected to augment this choice.</text>
        </description>
        <reference>
          <text>RFC 3413: Simple Network Management Protocol (SNMP)
  Applications.
  SNMP-TARGET-MIB.snmpTargetAddrTDomain
  SNMP-TARGET-MIB.snmpTargetAddrTAddress</text>
        </reference>
        <case name="udp">
          <reference>
            <text>RFC 3417: Transport Mappings for the Simple Network
  Management Protocol (SNMP).
  SNMPv2-TM.snmpUDPDomain
RFC 3419: Textual Conventions for Transport Addresses.
  TRANSPORT-ADDRESS-MIB.transportDomainUdpIpv4
  TRANSPORT-ADDRESS-MIB.transportDomainUdpIpv4z
  TRANSPORT-ADDRESS-MIB.transportDomainUdpIpv6
  TRANSPORT-ADDRESS-MIB.transportDomainUdpIpv6z</text>
          </reference>
          <container name="udp">
            <leaf name="ip">
              <type name="inet:ip-address"/>
              <mandatory value="true"/>
              <reference>
                <text>RFC 3413: Simple Network Management Protocol (SNMP).
  SNMP-TARGET-MIB.snmpTargetAddrTAddress</text>
              </reference>
            </leaf>
            <leaf name="port">
              <type name="inet:port-number"/>
              <default value="162"/>
              <description>
                <text>UDP port number.</text>
              </description>
              <reference>
                <text>RFC 3413: Simple Network Management Protocol (SNMP).
  SNMP-TARGET-MIB.snmpTargetAddrTAddress</text>
              </reference>
            </leaf>
            <leaf name="prefix-length">
              <type name="uint8"/>
              <description>
                <text>The value of this leaf must match the value of
../snmp:ip.  If ../snmp:ip contains an IPv4 address,
this leaf must be less than or equal to 32.  If it
contains an IPv6 address, it must be less than or
equal to 128.

Note that the prefix-length is currently only used
by the Community-based Security Model to filter
incoming messages.  Furthermore, the prefix-length
filtering does not cover all possible filters
supported by the corresponding MIB object.</text>
              </description>
              <reference>
                <text>RFC 3584: Coexistence between Version 1, Version 2,
  and Version 3 of the Internet-standard
  Network Management Framework.
  SNMP-COMMUNITY-MIB.snmpTargetAddrTMask</text>
              </reference>
            </leaf>
          </container>
        </case>
      </choice>
      <leaf-list name="tag">
        <type name="snmp:tag-value"/>
        <description>
          <text>List of tag values used to select target addresses.</text>
        </description>
        <reference>
          <text>RFC 3413: Simple Network Management Protocol (SNMP).
  Applications.
  SNMP-TARGET-MIB.snmpTargetAddrTagList</text>
        </reference>
      </leaf-list>
      <leaf name="timeout">
        <type name="uint32"/>
        <units name="0.01 seconds"/>
        <default value="1500"/>
        <description>
          <text>Needed only if this target can receive
InformRequest-PDUs.</text>
        </description>
        <reference>
          <text>RFC 3413: Simple Network Management Protocol (SNMP).
  Applications.
  SNMP-TARGET-MIB.snmpTargetAddrTimeout</text>
        </reference>
      </leaf>
      <leaf name="retries">
        <type name="uint8"/>
        <default value="3"/>
        <description>
          <text>Needed only if this target can receive
InformRequest-PDUs.</text>
        </description>
        <reference>
          <text>RFC 3413: Simple Network Management Protocol (SNMP).
  Applications.
  SNMP-TARGET-MIB.snmpTargetAddrRetryCount</text>
        </reference>
      </leaf>
      <leaf name="target-params">
        <type name="snmp:identifier"/>
        <mandatory value="true"/>
        <reference>
          <text>RFC 3413: Simple Network Management Protocol (SNMP).
  Applications.
  SNMP-TARGET-MIB.snmpTargetAddrParams</text>
        </reference>
      </leaf>
    </list>
    <list name="target-params">
      <key value="name"/>
      <description>
        <text>List of target parameters.</text>
      </description>
      <reference>
        <text>RFC 3413: Simple Network Management Protocol (SNMP).
  Applications.
  SNMP-TARGET-MIB.snmpTargetParamsTable</text>
      </reference>
      <leaf name="name">
        <type name="snmp:identifier"/>
      </leaf>
      <choice name="params">
        <description>
          <text>This choice is augmented with case nodes containing
configuration parameters specific to the security model.</text>
        </description>
      </choice>
    </list>
  </augment>
</submodule>