solution/smo/oam/ves-collector/externalRepo/o-ran-sc/experimental/yes-o1-notify-pnf-registration.yaml

   1 openapi: 3.0.3
   2 info:
   3   version: 1.0.0
   4   title: YES-API-PROVIDER modules of RestConf (RFC8040)
   5   license:
   6     name: Apache 2.0
   7     url: http://www.apache.org/licenses/LICENSE-2.0.html
   8 servers:
   9   - url: https://yes-api-provider.orbit-lab.org/
  10 paths:
  11   /restconf/yang-based-event-stream:event-history:
  12     get:
  13       description: 'The root container of an event log. '
  14       summary: GET - YES-API-PROVIDER - yang-based-event-stream - event-history
  15       tags:
  16         - mounted YES-API-PROVIDER yang-based-event-stream
  17       responses:
  18         '200':
  19           content:
  20             application/json:
  21               schema:
  22                 $ref: '#/components/schemas/yang-based-event-stream_event-history_TOP'
  23           description: OK
  24 components:
  25   schemas:
  26     domain-id:
  27       title: domain-id
  28       description: |-
  29         Base identity for the event domain.  A unique identification of the
  30         event domain.
  31
  32         This identity is abstract and MUST NOT be used for domains.
  33       enum:
  34         - o1-notify-pnf-registration
  35       type: string
  36     event-type-id:
  37       title: event-type-id
  38       description: |-
  39         Base identity for the event type.  A unique identification of the
  40         event type.
  41
  42         This identity is abstract and MUST NOT be used for event types.
  43       enum:
  44         - application
  45         - platform
  46         - micro-service
  47         - guest-operating-system
  48         - physical-network-function
  49         - host-operating-system
  50       type: string
  51     yang-based-event-stream_event-history_event_header:
  52       properties:
  53         domain:
  54           $ref: '#/components/schemas/domain-id'
  55         event-id:
  56           description: The event key that is unique to the event source.
  57           minLength: 1
  58           maxLength: 255
  59           type: string
  60         event-name:
  61           description: |-
  62             A unique event name. A names space ensures the uniqueness
  63             between the data-models.
  64           default: Some event-name
  65           type: string
  66         event-type:
  67           $ref: '#/components/schemas/event-type-id'
  68         last-epoch:
  69           description: The latest time aka epoch time associated with the event from any component.
  70           minLength: 20
  71           maxLength: 1024
  72           default: '1970-01-01T00:00:00.000Z'
  73           type: string
  74         nfc-naming-code:
  75           description: |-
  76             The network function component type, aligned with vfc naming
  77             standards.
  78
  79             TODO: Add a reference to the VFC naming standard.
  80           minLength: 3
  81           maxLength: 3
  82           type: string
  83         nf-naming-code:
  84           description: |-
  85             The network function type, aligned with network-function (NF)
  86             naming standards.
  87
  88             TODO: Add a reference to the NF naming standard.
  89           minLength: 4
  90           maxLength: 4
  91           type: string
  92         nf-vendor-pen:
  93           description: Network function vendor IANA private enterprise number.
  94           format: int64
  95           type: integer
  96         nf-vendor-name:
  97           description: Network function vendor name according to IANA Private Enterprise Numbers
  98           type: string
  99         priority:
 100           description: The event priority to control the processing of the event.
 101           enum:
 102             - high
 103             - medium
 104             - normal
 105             - low
 106           default: high
 107           type: string
 108         reporting-entity-id:
 109           description: The entity reporting the event, for example an OAM VM.
 110           minLength: 1
 111           maxLength: 1024
 112           type: string
 113         reporting-entity-name:
 114           description: |-
 115             The name of the entity reporting the event, for example, an EMS
 116             name; may be the same as 'source-name'.
 117           minLength: 1
 118           maxLength: 255
 119           type: string
 120         sequence:
 121           description: Ordering of events communicated by an event source instance or 0, if not needed.
 122           default: 0
 123           type: integer
 124         source-id:
 125           description: UUID identifying the entity experiencing the event issue.
 126           minLength: 1
 127           maxLength: 1024
 128           type: string
 129         source-name:
 130           description: The name of the entity experiencing the event issue,
 131           type: string
 132         start-epoch:
 133           description: |-
 134             The earliest time aka epoch time associated with the event from
 135             any component.
 136           minLength: 20
 137           maxLength: 1024
 138           default: '1970-01-01T00:00:00.000Z'
 139           type: string
 140       required:
 141         - domain
 142         - event-id
 143         - event-name
 144         - last-epoch
 145         - priority
 146         - reporting-entity-name
 147         - sequence
 148         - source-name
 149         - start-epoch
 150       type: object
 151       title: yang-based-event-stream_event-history_event_header
 152       description: |-
 153         This contains all the parameters which are common to all
 154         events.
 155     o1-notify-pnf-registration:
 156       properties:
 157         object-class:
 158           description: |-
 159             The name of the object class describing a PNF in the context of
 160             PNF registration.
 161           minLength: 3
 162           maxLength: 255
 163           default: managed-function
 164           type: string
 165         object-instance:
 166           description: Reference to the object representing the PNF.
 167           type: string
 168         notification-identifier:
 169           description: An notification identifier of this event as defined in ITU-T Rec. X.733.
 170           type: integer
 171         notification-type:
 172           $ref: '#/components/schemas/domain-id'
 173         event-time:
 174           description: |-
 175             The earliest time aka epoch time associated with the event from
 176             any component.
 177           minLength: 20
 178           maxLength: 1024
 179           default: '1970-01-01T00:00:00.000Z'
 180           type: string
 181         system-distinguished-name:
 182           description: Distinguished Name of the management service provider of the notification
 183           default: Some system-distinguished-name
 184           type: string
 185         o1-specification-version:
 186           description: The version of the O1 Specification defining the format of this PNF registration notification
 187           minLength: 1
 188           maxLength: 32
 189           default: v07.00
 190           type: string
 191         serial-number:
 192           description: The serial number of the network function.
 193           minLength: 1
 194           maxLength: 255
 195           type: string
 196         vendor-pen:
 197           description: Network function vendor IANA private enterprise number.
 198           format: int64
 199           type: integer
 200         vendor-name:
 201           description: Network function vendor name according to IANA Private Enterprise Numbers
 202           type: string
 203         oam-host:
 204           description: |-
 205             The m-plane fully qualified domain name (host) or IP address to
 206             be used by the manager to contact the PNF.
 207           type: string
 208         oam-port:
 209           description: The port number the PNF listens for OAM commands..
 210           format: int32
 211           default: 830
 212           type: integer
 213         mac-address:
 214           description: The MAC address of OAM interface of the network function in Colon-Hexadecimal notation.
 215           minLength: 17
 216           maxLength: 17
 217           type: string
 218         unit-family:
 219           description: The general type of hardware.
 220           minLength: 1
 221           maxLength: 255
 222           type: string
 223         unit-type:
 224           description: Name for the network function
 225           minLength: 1
 226           maxLength: 255
 227           type: string
 228         model-number:
 229           description: Version of the network function from the vendor.
 230           minLength: 1
 231           maxLength: 255
 232           type: string
 233         software-version:
 234           description: The active software version running on the network function.
 235           minLength: 1
 236           maxLength: 255
 237           type: string
 238         restart-reason:
 239           description: The reason the network function restarted.
 240           minLength: 1
 241           maxLength: 255
 242           type: string
 243         manufacture-date:
 244           description: Manufacture date of the network function.
 245           minLength: 10
 246           maxLength: 1024
 247           default: '1970-01-01T00:00:00.000Z'
 248           type: string
 249         last-service-date:
 250           description: Date when the field operation stuff way on-side.
 251           minLength: 10
 252           maxLength: 1024
 253           default: '1970-01-01T00:00:00.000Z'
 254           type: string
 255         transport-protocol:
 256           description: Defines the security protocol for NETCONF
 257           enum:
 258             - ssh
 259             - tls
 260           default: ssh
 261           type: string
 262         username:
 263           description: The username for the connection.
 264           minLength: 3
 265           maxLength: 255
 266           type: string
 267         password:
 268           description: The user's password for the SSH session.
 269           minLength: 8
 270           maxLength: 255
 271           type: string
 272         host-key:
 273           description: |-
 274             BASE-64 encoded public key which is used by the network-function
 275              during the connection.
 276           type: string
 277         key-reference:
 278           description: |-
 279             Key identifier inside the NETCONF server's keystore.
 280              It is used during two-way TLS authentication.
 281           type: string
 282         reconnect-on-changed-schema:
 283           description: |-
 284             Defines if the NETCONF client should reconnect to the network
 285             function, if new YANG capabilities are exposed.
 286           default: false
 287           type: boolean
 288         connection-timeout:
 289           description: |-
 290             Defines the NETCONF client timeout to indicate that the connection
 291             was lost.
 292           format: int64
 293           default: 20000
 294           type: integer
 295         max-connection-attempts:
 296           description: |-
 297             Defines the number of attempts by the NETCONF client to connect
 298             to the NETCONF server, before the automated connection function, by
 299             the NETCONF client is switched off. The value 0 means 'infinity'.
 300           format: int64
 301           default: 0
 302           type: integer
 303         between-attempts-timeout:
 304           description: |-
 305             Defines the first delay time in milliseconds to try a new reconnect
 306             by the NETCONF client. For the next attempts the values is
 307             multiplied with the 'sleep-factor'.
 308           format: int64
 309           default: 2000
 310           type: integer
 311         sleep-factor:
 312           description: Defines the factor to increase the reconnect attempt.
 313           default: 1.5
 314           type: number
 315         keepalive-delay:
 316           description: |-
 317             Defines the time in seconds between two 'empty' NETCONF request to
 318             check if the NETCONF server is functional or can be reached. The
 319             value 0 turns of such function.
 320           format: int64
 321           default: 120
 322           type: integer
 323       required:
 324         - object-class
 325         - object-instance
 326         - notification-identifier
 327         - notification-type
 328         - event-time
 329         - system-distinguished-name
 330         - o1-specification-version
 331         - serial-number
 332         - oam-host
 333       type: object
 334       title: o1-notify-pnf-registration
 335       description: |-
 336         A single object for specific parameters, used for the registration of
 337         physical network functions (PNF).
 338     yang-based-event-stream_event-history_event:
 339       properties:
 340         header:
 341           $ref: '#/components/schemas/yang-based-event-stream_event-history_event_header'
 342         o1-notify-pnf-registration:
 343           $ref: '#/components/schemas/o1-notify-pnf-registration'
 344       type: object
 345       title: yang-based-event-stream_event-history_event
 346       description: This contains the set of asynchronous messages.
 347     yang-based-event-stream_event-history:
 348       properties:
 349         maximum-number-of-entries:
 350           description: |-
 351             The maximum number of item in the event list supported by
 352             the server.
 353           format: int32
 354           default: 255
 355           type: integer
 356         event:
 357           type: array
 358           items:
 359             $ref: '#/components/schemas/yang-based-event-stream_event-history_event'
 360           description: This contains the set of asynchronous messages.
 361       type: object
 362       title: yang-based-event-stream_event-history
 363       description: 'The root container of an event log. '
 364     yang-based-event-stream_event-history_TOP:
 365       type: object
 366       properties:
 367         event-history:
 368           $ref: '#/components/schemas/yang-based-event-stream_event-history'
 369       title: yang-based-event-stream_event-history_TOP