netconfcentral logo

ietf-dots-signal-channel@2020-07-02



  module ietf-dots-signal-channel {

    yang-version 1.1;

    namespace
      "urn:ietf:params:xml:ns:yang:ietf-dots-signal-channel";

    prefix signal;

    import ietf-inet-types {
      prefix inet;
      reference
        "Section 4 of RFC 6991";


    }
    import ietf-yang-types {
      prefix yang;
      reference
        "Section 3 of RFC 6991";


    }
    import ietf-dots-data-channel {
      prefix ietf-data;
      reference
        "RFC 8783: Distributed Denial-of-Service Open Threat Signaling
        	  (DOTS) Data Channel Specification";


    }
    import iana-dots-signal-channel {
      prefix iana-signal;
      reference
        "RFC 8782: Distributed Denial-of-Service Open Threat Signaling
        	  (DOTS) Signal Channel Specification";


    }
    import ietf-yang-structure-ext {
      prefix sx;
      reference
        "RFC 8791: YANG Data Structure Extensions";


    }

    organization
      "IETF DDoS Open Threat Signaling (DOTS) Working Group";

    contact
      "WG Web:   <https://datatracker.ietf.org/wg/dots/>
     WG List:  <mailto:dots&ietf.org>

     Editor:  Mohamed Boucadair
              <mailto:mohamed.boucadair&orange.com>

     Editor:  Jon Shallow
              <mailto:supjps-ietf&jpshallow.com>

     Author:  Konda, Tirumaleswar Reddy.K
              <mailto:TirumaleswarReddy_Konda&McAfee.com>

     Author:  Prashanth Patil
              <mailto:praspati&cisco.com>

     Author:  Andrew Mortensen
              <mailto:amortensen&arbor.net>

     Author:  Nik Teague
              <mailto:nteague&ironmountain.co.uk>";

    description
      "This module contains YANG definition for the signaling
     messages exchanged between a DOTS client and a DOTS server.

     Copyright (c) 2020 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.";

    revision "2020-07-02" {
      description
        "Updated revision to comply with RFC8791.";
      reference
        "RFC xxxx: A YANG Data Model for Distributed Denial-of-Service
        	  Open Threat Signaling (DOTS) Signal Channel";

    }

    revision "2020-05-28" {
      description "Initial revision.";
      reference
        "RFC 8782: Distributed Denial-of-Service Open Threat
        	  Signaling (DOTS) Signal Channel Specification";

    }

    sx:structure "dots-signal" {
      description "Main structure for DOTS signal message.

A DOTS signal message can be a mitigation, a configuration,
or a redirected signal message.";
      choice "message-type" {
        description "Can be a mitigation, a configuration, or a redirect
message.";
        case "mitigation-scope" {
          description "Mitigation scope of a mitigation message.";
          uses "mitigation-scope";
        }
        case "signal-config" {
          description "Configuration message.";
          uses "signal-config";
        }
        case "redirected-signal" {
          description "Redirected signaling.";
          uses "redirected-signal";
        }
        case "heartbeat" {
          description "DOTS heartbeats.";
          leaf "peer-hb-status" {
            type "boolean";
            mandatory "true";
            description "Indicates whether a DOTS agent receives heartbeats
from its peer.  The value is set to 'true' if the
DOTS agent is receiving heartbeat messages
from its peer.";
          }
        }
      }
    }
  }  // module ietf-dots-signal-channel