ntsimulator/deploy/o-ran-ru-fh/yang/o-ran-ves-subscribed-notifications@2020-12-10.yang

   1 module o-ran-ves-subscribed-notifications {
   2   yang-version 1.1;
   3   namespace "urn:o-ran:ves-sn:1.0";
   4   prefix o-ran-vsn;
   5
   6   import ietf-subscribed-notifications {
   7     prefix sn;
   8   }
   9   import ietf-inet-types {
  10     prefix inet;
  11   }
  12
  13   organization "O-RAN Alliance";
  14
  15   contact
  16     "www.o-ran.org";
  17
  18   description
  19     "This module defines augmentations to ietf-subscribed-notifications to
  20     enable support of configured notifications sent using VNF Event Stream
  21     notifications.
  22
  23     Copyright 2020 the O-RAN Alliance.
  24
  25     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 'AS IS'
  26     AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  27     IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  28     ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
  29     LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  30     CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  31     SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  32     INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  33     CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  34     ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  35     POSSIBILITY OF SUCH DAMAGE.
  36
  37     Redistribution and use in source and binary forms, with or without
  38     modification, are permitted provided that the following conditions are met:
  39
  40     * Redistributions of source code must retain the above copyright notice,
  41     this list of conditions and the above disclaimer.
  42     * Redistributions in binary form must reproduce the above copyright notice,
  43     this list of conditions and the above disclaimer in the documentation
  44     and/or other materials provided with the distribution.
  45     * Neither the Members of the O-RAN Alliance nor the names of its
  46     contributors may be used to endorse or promote products derived from
  47     this software without specific prior written permission.";
  48
  49   revision "2020-12-10" {
  50     description
  51       "version 5.0.0
  52
  53       1) initial version";
  54
  55     reference "ORAN-WG4.M.0-v05.00";
  56   }
  57
  58   // identity statements
  59   identity o-ran-ves-connectionless {
  60     base sn:transport;
  61     description
  62       "A transport type used to indicate that notifications should be sent using an
  63       ONAP VES Notification using RESTful connectionless transport";
  64   }
  65
  66   grouping event-collector {
  67     description
  68       "Provides a reusable description of an event-collector.";
  69     leaf notification-recipient {
  70       type inet:uri;
  71       mandatory true;
  72       description
  73         "This URI specifies the address of the notification receiver
  74         HTTPS endpoint. Additional path elements may be added as required by the
  75         protocol, i. e. it configures the server root.
  76         E.g. https://myserver.mydomain.com:8443/notifications.";
  77     }
  78   }
  79
  80   augment "/sn:subscriptions/sn:subscription/sn:receivers/sn:receiver" {
  81     when "(derived-from-or-self(../../sn:transport, 'o-ran-vsn:o-ran-ves-connectionless'))";
  82     description
  83       "This augmentation allows VES-specific receiver parameters to be
  84       configured.";
  85     uses event-collector;
  86   }
  87 }