saltstack/salt
1
0
Fork 0
mirror of https://github.com/saltstack/salt.git synced 2025-04-17 10:10:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Add documentation for netapi_enable_client option

Browse source
This commit is contained in:
Barney Sowood 2021-02-26 10:57:09 +00:00 • committed by Barney Sowood
parent 1780e503b7
commit bed609ff4a
1 changed files with 33 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

33
doc/ref/configuration/master.rst
View file

@ -5099,6 +5099,39 @@ Used by ``salt-api`` for the master requests timeout.
rest_timeout: 300
.. conf_master:: netapi_disable_clients
``netapi_enable_clients``
--------------------------
Default: ``[]``
Used by ``salt-api`` to enable access to the listed clients. Unless a
client is addded to this list, equests to be rejected before
authentication is attempted or processing of the low state occurs.
This can be used to only expose the required functionality via
``salt-api``.
Configuration with all possible clients enabled:
.. code-block:: yaml
netapi_enable_clients:
- local
- local_async
- local_batch
- local_subset
- runner
- runner_async
- ssh
- wheel
- wheel_async
.. note::
Disabling all clients is not recommened as it will stop
the ``salt-api`` functioning.
.. _syndic-server-settings: