4 title: OFHM-PROVIDER modules of RestConf (RFC8040)
7 url: http://www.apache.org/licenses/LICENSE-2.0.html
9 This documentation implements the VES notifications defined by
10 O-RAN Alliance WG4 for OpenFronthaul Management Plane (OFHM).
13 O-RAN Working Group 4 (Open Fronthaul Interfaces WG)
14 Management Plane Specification
15 O-RAN.WG4.MP.0-R003-v11.00
16 url: https://orandownloadsweb.azurewebsites.net/specifications
18 - url: https://ohfm-provider.orbit-lab.org/
20 /restconf/ofhm-event-stream:event-history:
23 The root container of an event log inspired by O-RAN Alliance WG4 OpenFronthaul-Management-Plane.
24 summary: GET - VES-OFHM-API-PROVIDER - ofhm-event-stream - event-history
26 - mounted VES-OFHM-API-PROVIDER - ofhm-event-stream - event-history
32 $ref: '#/components/schemas/ofhm-event-stream-event-history-ref'
37 # notifications for o-ran-supervision.yang
38 o-ran-supervision:supervision-notification:
47 This value uniquely identifies the NETCONF session in an O-RU. The value is conveyed to NETCONF client in hello message.
48 the session-id for the netconf session is sent as part of each supervision-notification notification.
49 and may be used for create-subscription to filter the relevant
52 title: o-ran-supervision:supervision-notification
54 Notification to indicate that NETCONF management interface is up.
56 # notifications for o-ran-file-management.yang
57 o-ran-file-management:file-path-grouping:
60 - local-logical-file-path
63 local-logical-file-path:
66 URI specifying the complete logical path relative to the root of the logical file system
67 structure (the common root for o-ran/log, o-ran/pm, o-ran/transceiver or o-ran/beamforming) of the file
68 to upload/download (no wildcard is allowed), including a file name and its extension.
69 Example: 'o-ran/log/file_1.abc', where 'o-ran/log/' represents relative path to folder containing log files
70 as specified by O-RAN, 'file_1' represents desired filename and 'abc' represents desired filename's extension.
71 The content shall conform to RFC3986 'Uniform Resource Identifier (URI): Generic Syntax'
75 URI specifying the remote-file-path on O-DU/SMO or on stand-alone file server.
76 The content shall conform to RFC3986 'Uniform Resource Identifier (URI): Generic Syntax'.
77 When upload/download is via sftp, the format shall be of the form
78 sftp://<username>@<host>[:port]/path
79 When upload/download is via ftpes, the format shall be of the form
80 ftpes://<username>@<host>[:port]/path
81 Note, ftpes is not an IANA registered URI scheme, but used here to signal
82 that a file transfer should be performed over FTPES
83 title: o-ran-file-management:file-path-grouping
85 Grouping, that provides local path and remote path for the
86 purpose of File Management scenarios.
88 o-ran-file-management:output-status-grouping:
101 The field is only needed when the value of the field 'status' is ual to 'FAILURE'.
102 title: o-ran-file-management:output-status-grouping
106 o-ran-file-management:file-download-event:
109 o-ran-file-management:file-download-event:
112 - $ref: '#/components/schemas/o-ran-file-management:file-path-grouping'
113 - $ref: '#/components/schemas/o-ran-file-management:output-status-grouping'
114 title: o-ran-file-management:file-download-event
116 An abstract object class for a file-download-event.
118 o-ran-file-management:file-upload-notification:
121 o-ran-file-management:file-upload-notification:
124 - $ref: '#/components/schemas/o-ran-file-management:file-path-grouping'
125 - $ref: '#/components/schemas/o-ran-file-management:output-status-grouping'
126 title: o-ran-file-management:file-upload-notification
128 An abstract object class for a file-upload-notification.
130 # Generic part to OFHM specific parts
143 The time the event was generated by the event source. This
144 parameter is of type dateTime and compliant to [RFC3339].
145 Implementations must support time zones.
146 Reference: RFC3339, RFC5277, RFC8040
148 - $ref: '#/components/schemas/o-ran-supervision:supervision-notification'
149 - $ref: '#/components/schemas/o-ran-file-management:file-download-event'
150 - $ref: '#/components/schemas/o-ran-file-management:file-upload-notification'
151 title: ofhm-event-stream
153 This contains the set of asynchronous messages.
156 ofhm-event-stream_event-history:
159 maximum-number-of-entries:
161 The maximum number of item in the event list supported by
169 $ref: '#/components/schemas/ofhm-event-stream'
170 description: This contains the set of asynchronous messages.
171 title: ofhm-event-stream_event-history
173 The properties of the root container of an event log.
175 ofhm-event-stream-event-history-ref:
179 $ref: '#/components/schemas/ofhm-event-stream_event-history'
180 title: ofhm-event-stream-event-history-ref
182 The root container of an event-history list.