diff options
| author | A. Wilcox <AWilcox@Wilcox-Tech.com> | 2020-09-21 18:48:05 -0500 |
|---|---|---|
| committer | A. Wilcox <AWilcox@Wilcox-Tech.com> | 2020-09-21 18:48:05 -0500 |
| commit | 7cbc505de4f06896617c24fcf54855b8790ac75e (patch) | |
| tree | 02a2b9ff428b09eb8cf00b6528819b8d624d5f53 | |
| parent | ec53b2c8088d2336b05e3d50ecb97549579cc091 (diff) | |
| download | netconfapk-7cbc505de4f06896617c24fcf54855b8790ac75e.tar.gz netconfapk-7cbc505de4f06896617c24fcf54855b8790ac75e.tar.bz2 netconfapk-7cbc505de4f06896617c24fcf54855b8790ac75e.tar.xz netconfapk-7cbc505de4f06896617c24fcf54855b8790ac75e.zip | |
doc: Add reload and restart to service mgmt spec
| -rw-r--r-- | doc/service.rst | 36 |
1 files changed, 33 insertions, 3 deletions
diff --git a/doc/service.rst b/doc/service.rst index b567366..194b9c9 100644 --- a/doc/service.rst +++ b/doc/service.rst @@ -170,7 +170,8 @@ under the ``status`` property in the `Data model definition`_ section. This method starts the service associated with the Service object. -This method has no effect if the status of the service is ``started``. +This method has no effect if the status of the service is ``starting`` or +``started``. This method returns immediately with no value. To determine if a service started successfully, you must query the service's status. @@ -181,13 +182,42 @@ started successfully, you must query the service's status. This method stops the service associated with the Service object. -This method has no effect if the status of the service is ``stopped`` or -``crashed``. +This method has no effect if the status of the service is ``stopping``, +``stopped`` or ``crashed``. This method returns immediately with no value. To determine if a service stopped successfully, you must query the service's status. +``reload()`` +~~~~~~~~~~~~ + +This method reloads the service associated with the Service object. + +This method has no effect unless the status of the service is ``started``. + +This method returns immediately with no value. + + +``restart(full)`` +~~~~~~~~~~~~~~~~~ + +This method restarts the service associated with the Service object. + +This method has no effect if the status of the service is ``stopping`` or +``starting``. + +If the status of the service is not ``started``, the service will be +started without a stop attempt. + +The argument ``full`` determines if the restart is a full restart or not. +The meaning of a full restart is implementation-defined. The argument +defaults to ``True`` if it is not specified. + +This method returns immediately with no value. To determine if a service +restarted successfully, you must query the service's status. + + YANG Model |