transport/transport-tcp/src/main/yang/ietf-tcp-common@2024-02-08.yang

   1 module ietf-tcp-common {
   2   yang-version 1.1;
   3   namespace "urn:ietf:params:xml:ns:yang:ietf-tcp-common";
   4   prefix tcpcmn;
   5
   6   organization
   7     "IETF NETCONF (Network Configuration) Working Group and the
   8      IETF TCP Maintenance and Minor Extensions (TCPM) Working Group";
   9
  10   contact
  11     "WG Web:   https://datatracker.ietf.org/wg/netconf
  12                https://datatracker.ietf.org/wg/tcpm
  13      WG List:  NETCONF WG list <mailto:netconf@ietf.org>
  14                TCPM WG list <mailto:tcpm@ietf.org>
  15      Authors:  Kent Watsen <mailto:kent+ietf@watsen.net>
  16                Michael Scharf
  17                <mailto:michael.scharf@hs-esslingen.de>";
  18
  19   description
  20     "This module define a reusable 'grouping' that is common
  21      to both TCP-clients and TCP-servers.  This grouping statement
  22      is used by both the 'ietf-tcp-client' and 'ietf-tcp-server'
  23      modules.
  24
  25      Copyright (c) 2023 IETF Trust and the persons identified
  26      as authors of the code. All rights reserved.
  27
  28      Redistribution and use in source and binary forms, with
  29      or without modification, is permitted pursuant to, and
  30      subject to the license terms contained in, the Revised
  31      BSD License set forth in Section 4.c of the IETF Trust's
  32      Legal Provisions Relating to IETF Documents
  33      (https://trustee.ietf.org/license-info).
  34
  35      This version of this YANG module is part of RFC DDDD
  36      (https://www.rfc-editor.org/info/rfcDDDD); see the RFC
  37      itself for full legal notices.
  38
  39      The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL',
  40      'SHALL NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED',
  41      'NOT RECOMMENDED', 'MAY', and 'OPTIONAL' in this document
  42      are to be interpreted as described in BCP 14 (RFC 2119)
  43      (RFC 8174) when, and only when, they appear in all
  44      capitals, as shown here.";
  45
  46   revision 2024-02-08 {
  47     description
  48       "Initial version";
  49     reference
  50       "RFC DDDD: YANG Groupings for TCP Clients and TCP Servers";
  51   }
  52
  53   // Features
  54
  55   feature keepalives-supported {
  56     description
  57       "Indicates that keepalives are supported.";
  58   }
  59
  60   // Groupings
  61
  62   grouping tcp-common-grouping {
  63     description
  64       "A reusable grouping for configuring TCP parameters common
  65        to TCP connections as well as the operating system as a
  66        whole.";
  67     container keepalives {
  68       if-feature "keepalives-supported";
  69       presence
  70         "Indicates that keepalives are enabled, aligning to
  71          the requirement in Section 3.8.4 RFC 9293 that
  72          keepalives are off by default.";
  73       description
  74         "Configures the keep-alive policy, to proactively test the
  75          aliveness of the TCP peer.  An unresponsive TCP peer is
  76          dropped after approximately (idle-time + max-probes *
  77          probe-interval) seconds.  Further guidance can be found
  78          in Section 2.1.5 of RFC DDDD.";
  79       reference
  80         "RFC 9293: Transmission Control Protocol (TCP)";
  81       leaf idle-time {
  82         type uint16 {
  83           range "1..max";
  84         }
  85         units "seconds";
  86         default 7200;
  87         description
  88           "Sets the amount of time after which if no data has been
  89            received from the TCP peer, a TCP-level probe message
  90            will be sent to test the aliveness of the TCP peer.
  91            Two hours (7200 seconds) is safe value, per RFC 9293
  92            Section 3.8.4.";
  93         reference
  94           "RFC 9293: Transmission Control Protocol (TCP)";
  95
  96       }
  97       leaf max-probes {
  98         type uint16 {
  99           range "1..max";
 100         }
 101         default 9;
 102         description
 103           "Sets the maximum number of sequential keep-alive probes
 104            that can fail to obtain a response from the TCP peer
 105            before assuming the TCP peer is no longer alive.";
 106       }
 107       leaf probe-interval {
 108         type uint16 {
 109           range "1..max";
 110         }
 111         units "seconds";
 112         default 75;
 113         description
 114           "Sets the time interval between failed probes. The interval
 115            SHOULD be significantly longer than one second in order to
 116            avoid harm on a congested link.";
 117       }
 118     } // container keepalives
 119   } // grouping tcp-common-grouping
 120
 121 }