summaryrefslogtreecommitdiff
path: root/doc/service.rst
diff options
context:
space:
mode:
authorA. Wilcox <AWilcox@Wilcox-Tech.com>2020-09-22 17:53:18 -0500
committerA. Wilcox <AWilcox@Wilcox-Tech.com>2020-09-22 17:53:18 -0500
commit83c1e1451d2cfac34cae4e4d7a9eb30a134436d0 (patch)
treefc6511d9af0f6bd49d3388ef07ea82f8c866e8b5 /doc/service.rst
parent7cbc505de4f06896617c24fcf54855b8790ac75e (diff)
downloadnetconfapk-83c1e1451d2cfac34cae4e4d7a9eb30a134436d0.tar.gz
netconfapk-83c1e1451d2cfac34cae4e4d7a9eb30a134436d0.tar.bz2
netconfapk-83c1e1451d2cfac34cae4e4d7a9eb30a134436d0.tar.xz
netconfapk-83c1e1451d2cfac34cae4e4d7a9eb30a134436d0.zip
doc: Add initial YANG model for service mgmt
Diffstat (limited to 'doc/service.rst')
-rw-r--r--doc/service.rst24
1 files changed, 22 insertions, 2 deletions
diff --git a/doc/service.rst b/doc/service.rst
index 194b9c9..7770586 100644
--- a/doc/service.rst
+++ b/doc/service.rst
@@ -84,7 +84,7 @@ A service has at least the following properties:
* ``starting``: the service is in the process of starting up.
- * ``started``: the service is presently running.
+ * ``running``: the service is presently running.
* ``stopping``: the service is in the process of stopping.
@@ -223,4 +223,24 @@ restarted successfully, you must query the service's status.
YANG Model
==========
-TBD
+Data model
+----------
+
+The data model for system services has the following structure:
+
+::
+
+ +--rw services
+ +--rw service* [name]
+ +--rw name string
+ +--ro description? string
+ +--rw enabled boolean
+ +--ro status service-status
+ +--ro start-time? yang:date-and-time
+
+Module
+------
+
+See `adelie-services.yang`_.
+
+.. _`adelie-services.yang`: ../yang-modules/adelie-services.yang