Trying out bgp-api with apidoc explorer

[unimgr.git] / bgp-api / src / main / yang / iana-bfd-types@2018-08-01.yang

diff --git a/bgp-api/src/main/yang/iana-bfd-types@2018-08-01.yang b/bgp-api/src/main/yang/iana-bfd-types@2018-08-01.yang
new file mode 100644 (file)
index 0000000..21ea453
--- /dev/null
+++ b/bgp-api/src/main/yang/iana-bfd-types@2018-08-01.yang
@@ -0,0 +1,138 @@
+module iana-bfd-types {
+
+  yang-version 1.1;
+
+  namespace "urn:ietf:params:xml:ns:yang:iana-bfd-types";
+
+  prefix "iana-bfd-types";
+
+  organization "IANA";
+
+  contact
+    "        Internet Assigned Numbers Authority
+
+    Postal: ICANN
+            12025 Waterfront Drive, Suite 300
+            Los Angeles, CA 90094-2536
+            United States of America
+
+    Tel:    +1 310 823 9358
+    <mailto:iana@iana.org>";
+
+  description
+    "This module defines YANG data types for IANA-registered
+     BFD parameters.
+
+     This YANG module is maintained by IANA and reflects the
+     'BFD Diagnostic Codes' and 'BFD Authentication Types' registries.
+
+     Copyright (c) 2018 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 XXXX; see
+     the RFC itself for full legal notices.";
+
+  // RFC Ed.: replace XXXX with actual RFC number and remove
+  // this note
+
+  reference "RFC XXXX";
+
+  revision 2018-08-01 {
+    description "Initial revision.";
+    reference "RFC XXXX: IANA BFD YANG Data Types.";
+  }
+
+  /*
+   * Type Definitions
+   */
+  typedef diagnostic {
+    type enumeration {
+      enum none {
+        value 0;
+        description "None";
+      }
+      enum control-expiry {
+        value 1;
+        description "Control timer expiry";
+      }
+      enum echo-failed {
+        value 2;
+        description "Echo failure";
+      }
+      enum neighbor-down {
+        value 3;
+        description "Neighbor down";
+      }
+      enum forwarding-reset {
+
+        value 4;
+        description "Forwarding reset";
+      }
+      enum path-down {
+        value 5;
+        description "Path down";
+      }
+      enum concatenated-path-down {
+        value 6;
+        description "Concatenated path down";
+      }
+      enum admin-down {
+        value 7;
+        description "Admin down";
+      }
+      enum reverse-concatenated-path-down {
+        value 8;
+        description "Reverse concatenated path down";
+      }
+      enum mis-connectivity-defect {
+        value 9;
+        description "Mis-connectivity defect as specified in RFC6428";
+      }
+    }
+    description
+      "BFD diagnostic as defined in RFC 5880, values are maintained in
+      the 'BFD Diagnostic Codes' IANA registry. Range is 0 to 31.";
+  }
+
+  typedef auth-type {
+    type enumeration {
+      enum reserved {
+        value 0;
+        description "Reserved";
+      }
+      enum simple-password {
+        value 1;
+        description "Simple password";
+      }
+      enum keyed-md5 {
+        value 2;
+        description "Keyed MD5";
+      }
+      enum meticulous-keyed-md5 {
+        value 3;
+        description "Meticulous keyed MD5";
+      }
+      enum keyed-sha1 {
+
+        value 4;
+        description "Keyed SHA1";
+      }
+      enum meticulous-keyed-sha1 {
+        value 5;
+        description "Meticulous keyed SHA1";
+      }
+    }
+    description
+      "BFD authentication type as defined in RFC 5880, values are
+       maintained in the 'BFD Authentication Types' IANA registry.
+       Range is 0 to 255.";
+  }
+}
+