WA2L/edrc:edrcapi
Package: WA2L/edrc 1.5.57
Section: General Commands (1)
Updated: 27 December 2021
Index
Return to Main Contents
NAME
WA2L/edrc:edrcapi - EDRC REST API
SYNOPSIS
http://server.acme.ch:9902/vn/command[?option]
https://server.acme.ch:9903/vn/command[?option]
edrc/lib/thttpd
{
start
|
stop
|
...
}
edrcapi
edrc/bin/edrcinit
{
start
|
stop
|
...
}
thttpd_edrcapi
edrc/bin/edrcinit
{
start
|
stop
|
...
}
nginx_edrcapi
AVAILABILITY
WA2L/edrc
DESCRIPTION
web application
WA2L/edrc:edrcapi
(EDRC REST API) to serve WA2L/edrc information
in API fashion.
/v1/hostlist
return WA2L/edrc hostlist in different formats.
See also:
hostlist(3).
/v1/hostlist - Ansible inventory json format
/v1/hostlist?json - Ansible inventory json format
/v1/hostlist?yaml - Ansible inventory yaml format
/v1/hostlist?ini - Ansible inventory ini format
OPTIONS
- start
-
start webserver.
- stop
-
stop webserver.
- edrcapi
-
web application name of WA2L/edrc:edrcapi.
- thttpd_edrcapi
-
http service name of WA2L/edrc:edrcapi.
- nginx_edrcapi
-
https service name of WA2L/edrc:edrcapi.
ENVIRONMENT
-
EXIT STATUS
-
FILES
- edrc/etc/thttpd.edrcapi.cfg
-
configuration file for the HTTP server daemon
thttpd
which serves the application.
See also
thttpd(3)
for more information.
- edrc/etc/nginx.edrcapi.cfg
-
configuration file for the HTTPS server daemon
nginx
which serves the application.
The
thttpd_edrcapi
service is a prerequisite for
nginx_edrcapi.
See also
nginx(3)
for more information.
- edrc/etc/edrcinit.cfg
-
configuration file of the WA2L/edrc service handler.
See also
edrcinit(1m)
for more information.
- edrc/www/edrcapi/
-
base directory of WA2L/edrc:edrcapi.
- edrc/www/edrcapi/.meta/
-
directory containing meta data for WA2L/edrc:edrcapi as application version
and description.
- edrc/www/edrcapi/v1/
-
directory containing all cgi scripts of WA2L/edrc:edrcapi with version 1.
EXAMPLES
-
SEE ALSO
edrcintro(1),
edrcinit(1m),
edrcinit.cfg(3),
nginx(3),
nginx.edrcapi.cfg(3),
thttpd(3),
thttpd.edrcapi.cfg(3)
NOTES
The web application is served using
thttpd,
because it is a fast, small, secure and simple HTTP server that is available
and compilable on many operating systems without problems and therefore
predestined for a multi platform framework as WA2L/edrc. See
thttpd(3)
and
http://www.acme.com/software/thttpd
for more information.
BUGS
-
AUTHOR
WA2L/edrc:edrcapi was developed by Christian Walther. Send suggestions
and bug reports to wa2l@users.sourceforge.net .
COPYRIGHT
Copyright © 2021 Christian Walther
This is free software; see
edrc/doc/COPYING
for copying conditions. There is ABSOLUTELY NO WARRANTY; not
even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
This document was created by man2html
using the manual pages.
Time: 00:14:33 GMT, March 08, 2025