Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Telekom MMS GmbH committed Aug 29, 2024
1 parent 609c189 commit 39e3c90
Show file tree
Hide file tree
Showing 41 changed files with 459 additions and 459 deletions.
28 changes: 14 additions & 14 deletions docs/icinga_command.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Parameters


command (optional, str, None)
The command Icinga should run. Required when state is \ :literal:`present`\ .
The command Icinga should run. Required when state is :literal:`present`.

Absolute paths are accepted as provided, relative paths are prefixed with "PluginDir + ", similar Constant prefixes are allowed.

Expand Down Expand Up @@ -77,9 +77,9 @@ Parameters

Each argument can take either a string, a json or a dict

When using a dict as argument value, the following properties are supported. \ :literal:`skip\_key`\ , \ :literal:`repeat\_key`\ , \ :literal:`required`\ , \ :literal:`order`\ , \ :literal:`description`\ ), \ :literal:`set\_if`\ , \ :literal:`value`\ .
When using a dict as argument value, the following properties are supported. :literal:`skip\_key`\ , :literal:`repeat\_key`\ , :literal:`required`\ , :literal:`order`\ , :literal:`description`\ ), :literal:`set\_if`\ , :literal:`value`.

The \ :literal:`value`\ property can be either a string, a json or a dict. When used as a dict, you can define its \ :literal:`type`\ as \ :literal:`Function`\ and set its \ :literal:`body`\ property as an Icinga DSL piece of config.
The :literal:`value` property can be either a string, a json or a dict. When used as a dict, you can define its :literal:`type` as :literal:`Function` and set its :literal:`body` property as an Icinga DSL piece of config.


append (optional, bool, None)
Expand All @@ -95,59 +95,59 @@ Parameters


force (optional, bool, False)
If \ :literal:`yes`\ do not get a cached copy.
If :literal:`yes` do not get a cached copy.


http_agent (optional, str, ansible-httpget)
Header to identify as, generally appears in web server logs.


use_proxy (optional, bool, True)
If \ :literal:`no`\ , it will not use a proxy, even if one is defined in an environment variable on the target hosts.
If :literal:`no`\ , it will not use a proxy, even if one is defined in an environment variable on the target hosts.


validate_certs (optional, bool, True)
If \ :literal:`no`\ , SSL certificates will not be validated.
If :literal:`no`\ , SSL certificates will not be validated.

This should only be used on personally controlled sites using self-signed certificates.


url_username (optional, str, None)
The username for use in HTTP basic authentication.

This parameter can be used without \ :emphasis:`url\_password`\ for sites that allow empty passwords
This parameter can be used without :emphasis:`url\_password` for sites that allow empty passwords


url_password (optional, str, None)
The password for use in HTTP basic authentication.

If the \ :emphasis:`url\_username`\ parameter is not specified, the \ :emphasis:`url\_password`\ parameter will not be used.
If the :emphasis:`url\_username` parameter is not specified, the :emphasis:`url\_password` parameter will not be used.


force_basic_auth (optional, bool, False)
Credentials specified with \ :emphasis:`url\_username`\ and \ :emphasis:`url\_password`\ should be passed in HTTP Header.
Credentials specified with :emphasis:`url\_username` and :emphasis:`url\_password` should be passed in HTTP Header.


client_cert (optional, path, None)
PEM formatted certificate chain file to be used for SSL client authentication.

This file can also include the key as well, and if the key is included, \ :literal:`client\_key`\ is not required.
This file can also include the key as well, and if the key is included, :literal:`client\_key` is not required.


client_key (optional, path, None)
PEM formatted file that contains your private key to be used for SSL client authentication.

If \ :literal:`client\_cert`\ contains both the certificate and key, this option is not required.
If :literal:`client\_cert` contains both the certificate and key, this option is not required.


use_gssapi (optional, bool, False)
Use GSSAPI to perform the authentication, typically this is for Kerberos or Kerberos through Negotiate authentication.

Requires the Python library \ `gssapi <https://github.com/pythongssapi/python-gssapi>`__\ to be installed.
Requires the Python library \ `gssapi <https://github.com/pythongssapi/python-gssapi>`__ to be installed.

Credentials for GSSAPI can be specified with \ :emphasis:`url\_username`\ /\ :emphasis:`url\_password`\ or with the GSSAPI env var \ :literal:`KRB5CCNAME`\ that specified a custom Kerberos credential cache.
Credentials for GSSAPI can be specified with :emphasis:`url\_username`\ /\ :emphasis:`url\_password` or with the GSSAPI env var :literal:`KRB5CCNAME` that specified a custom Kerberos credential cache.

NTLM authentication is \ :literal:`not`\ supported even if the GSSAPI mech for NTLM has been installed.
NTLM authentication is :literal:`not` supported even if the GSSAPI mech for NTLM has been installed.



Expand Down
22 changes: 11 additions & 11 deletions docs/icinga_command_info.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,59 +45,59 @@ Parameters


force (optional, bool, False)
If \ :literal:`yes`\ do not get a cached copy.
If :literal:`yes` do not get a cached copy.


http_agent (optional, str, ansible-httpget)
Header to identify as, generally appears in web server logs.


use_proxy (optional, bool, True)
If \ :literal:`no`\ , it will not use a proxy, even if one is defined in an environment variable on the target hosts.
If :literal:`no`\ , it will not use a proxy, even if one is defined in an environment variable on the target hosts.


validate_certs (optional, bool, True)
If \ :literal:`no`\ , SSL certificates will not be validated.
If :literal:`no`\ , SSL certificates will not be validated.

This should only be used on personally controlled sites using self-signed certificates.


url_username (optional, str, None)
The username for use in HTTP basic authentication.

This parameter can be used without \ :emphasis:`url\_password`\ for sites that allow empty passwords
This parameter can be used without :emphasis:`url\_password` for sites that allow empty passwords


url_password (optional, str, None)
The password for use in HTTP basic authentication.

If the \ :emphasis:`url\_username`\ parameter is not specified, the \ :emphasis:`url\_password`\ parameter will not be used.
If the :emphasis:`url\_username` parameter is not specified, the :emphasis:`url\_password` parameter will not be used.


force_basic_auth (optional, bool, False)
Credentials specified with \ :emphasis:`url\_username`\ and \ :emphasis:`url\_password`\ should be passed in HTTP Header.
Credentials specified with :emphasis:`url\_username` and :emphasis:`url\_password` should be passed in HTTP Header.


client_cert (optional, path, None)
PEM formatted certificate chain file to be used for SSL client authentication.

This file can also include the key as well, and if the key is included, \ :literal:`client\_key`\ is not required.
This file can also include the key as well, and if the key is included, :literal:`client\_key` is not required.


client_key (optional, path, None)
PEM formatted file that contains your private key to be used for SSL client authentication.

If \ :literal:`client\_cert`\ contains both the certificate and key, this option is not required.
If :literal:`client\_cert` contains both the certificate and key, this option is not required.


use_gssapi (optional, bool, False)
Use GSSAPI to perform the authentication, typically this is for Kerberos or Kerberos through Negotiate authentication.

Requires the Python library \ `gssapi <https://github.com/pythongssapi/python-gssapi>`__\ to be installed.
Requires the Python library \ `gssapi <https://github.com/pythongssapi/python-gssapi>`__ to be installed.

Credentials for GSSAPI can be specified with \ :emphasis:`url\_username`\ /\ :emphasis:`url\_password`\ or with the GSSAPI env var \ :literal:`KRB5CCNAME`\ that specified a custom Kerberos credential cache.
Credentials for GSSAPI can be specified with :emphasis:`url\_username`\ /\ :emphasis:`url\_password` or with the GSSAPI env var :literal:`KRB5CCNAME` that specified a custom Kerberos credential cache.

NTLM authentication is \ :literal:`not`\ supported even if the GSSAPI mech for NTLM has been installed.
NTLM authentication is :literal:`not` supported even if the GSSAPI mech for NTLM has been installed.



Expand Down
26 changes: 13 additions & 13 deletions docs/icinga_command_template.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -77,9 +77,9 @@ Parameters

Each argument can take either a string, a json or a dict

When using a dict as argument value, the following properties are supported. \ :literal:`skip\_key`\ , \ :literal:`repeat\_key`\ , \ :literal:`required`\ , \ :literal:`order`\ , \ :literal:`description`\ ), \ :literal:`set\_if`\ , \ :literal:`value`\ .
When using a dict as argument value, the following properties are supported. :literal:`skip\_key`\ , :literal:`repeat\_key`\ , :literal:`required`\ , :literal:`order`\ , :literal:`description`\ ), :literal:`set\_if`\ , :literal:`value`.

The \ :literal:`value`\ property can be either a string, a json or a dict. When used as a dict, you can define its \ :literal:`type`\ as \ :literal:`Function`\ and set its \ :literal:`body`\ property as an Icinga DSL piece of config.
The :literal:`value` property can be either a string, a json or a dict. When used as a dict, you can define its :literal:`type` as :literal:`Function` and set its :literal:`body` property as an Icinga DSL piece of config.


append (optional, bool, None)
Expand All @@ -95,59 +95,59 @@ Parameters


force (optional, bool, False)
If \ :literal:`yes`\ do not get a cached copy.
If :literal:`yes` do not get a cached copy.


http_agent (optional, str, ansible-httpget)
Header to identify as, generally appears in web server logs.


use_proxy (optional, bool, True)
If \ :literal:`no`\ , it will not use a proxy, even if one is defined in an environment variable on the target hosts.
If :literal:`no`\ , it will not use a proxy, even if one is defined in an environment variable on the target hosts.


validate_certs (optional, bool, True)
If \ :literal:`no`\ , SSL certificates will not be validated.
If :literal:`no`\ , SSL certificates will not be validated.

This should only be used on personally controlled sites using self-signed certificates.


url_username (optional, str, None)
The username for use in HTTP basic authentication.

This parameter can be used without \ :emphasis:`url\_password`\ for sites that allow empty passwords
This parameter can be used without :emphasis:`url\_password` for sites that allow empty passwords


url_password (optional, str, None)
The password for use in HTTP basic authentication.

If the \ :emphasis:`url\_username`\ parameter is not specified, the \ :emphasis:`url\_password`\ parameter will not be used.
If the :emphasis:`url\_username` parameter is not specified, the :emphasis:`url\_password` parameter will not be used.


force_basic_auth (optional, bool, False)
Credentials specified with \ :emphasis:`url\_username`\ and \ :emphasis:`url\_password`\ should be passed in HTTP Header.
Credentials specified with :emphasis:`url\_username` and :emphasis:`url\_password` should be passed in HTTP Header.


client_cert (optional, path, None)
PEM formatted certificate chain file to be used for SSL client authentication.

This file can also include the key as well, and if the key is included, \ :literal:`client\_key`\ is not required.
This file can also include the key as well, and if the key is included, :literal:`client\_key` is not required.


client_key (optional, path, None)
PEM formatted file that contains your private key to be used for SSL client authentication.

If \ :literal:`client\_cert`\ contains both the certificate and key, this option is not required.
If :literal:`client\_cert` contains both the certificate and key, this option is not required.


use_gssapi (optional, bool, False)
Use GSSAPI to perform the authentication, typically this is for Kerberos or Kerberos through Negotiate authentication.

Requires the Python library \ `gssapi <https://github.com/pythongssapi/python-gssapi>`__\ to be installed.
Requires the Python library \ `gssapi <https://github.com/pythongssapi/python-gssapi>`__ to be installed.

Credentials for GSSAPI can be specified with \ :emphasis:`url\_username`\ /\ :emphasis:`url\_password`\ or with the GSSAPI env var \ :literal:`KRB5CCNAME`\ that specified a custom Kerberos credential cache.
Credentials for GSSAPI can be specified with :emphasis:`url\_username`\ /\ :emphasis:`url\_password` or with the GSSAPI env var :literal:`KRB5CCNAME` that specified a custom Kerberos credential cache.

NTLM authentication is \ :literal:`not`\ supported even if the GSSAPI mech for NTLM has been installed.
NTLM authentication is :literal:`not` supported even if the GSSAPI mech for NTLM has been installed.



Expand Down
22 changes: 11 additions & 11 deletions docs/icinga_command_template_info.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,59 +41,59 @@ Parameters


force (optional, bool, False)
If \ :literal:`yes`\ do not get a cached copy.
If :literal:`yes` do not get a cached copy.


http_agent (optional, str, ansible-httpget)
Header to identify as, generally appears in web server logs.


use_proxy (optional, bool, True)
If \ :literal:`no`\ , it will not use a proxy, even if one is defined in an environment variable on the target hosts.
If :literal:`no`\ , it will not use a proxy, even if one is defined in an environment variable on the target hosts.


validate_certs (optional, bool, True)
If \ :literal:`no`\ , SSL certificates will not be validated.
If :literal:`no`\ , SSL certificates will not be validated.

This should only be used on personally controlled sites using self-signed certificates.


url_username (optional, str, None)
The username for use in HTTP basic authentication.

This parameter can be used without \ :emphasis:`url\_password`\ for sites that allow empty passwords
This parameter can be used without :emphasis:`url\_password` for sites that allow empty passwords


url_password (optional, str, None)
The password for use in HTTP basic authentication.

If the \ :emphasis:`url\_username`\ parameter is not specified, the \ :emphasis:`url\_password`\ parameter will not be used.
If the :emphasis:`url\_username` parameter is not specified, the :emphasis:`url\_password` parameter will not be used.


force_basic_auth (optional, bool, False)
Credentials specified with \ :emphasis:`url\_username`\ and \ :emphasis:`url\_password`\ should be passed in HTTP Header.
Credentials specified with :emphasis:`url\_username` and :emphasis:`url\_password` should be passed in HTTP Header.


client_cert (optional, path, None)
PEM formatted certificate chain file to be used for SSL client authentication.

This file can also include the key as well, and if the key is included, \ :literal:`client\_key`\ is not required.
This file can also include the key as well, and if the key is included, :literal:`client\_key` is not required.


client_key (optional, path, None)
PEM formatted file that contains your private key to be used for SSL client authentication.

If \ :literal:`client\_cert`\ contains both the certificate and key, this option is not required.
If :literal:`client\_cert` contains both the certificate and key, this option is not required.


use_gssapi (optional, bool, False)
Use GSSAPI to perform the authentication, typically this is for Kerberos or Kerberos through Negotiate authentication.

Requires the Python library \ `gssapi <https://github.com/pythongssapi/python-gssapi>`__\ to be installed.
Requires the Python library \ `gssapi <https://github.com/pythongssapi/python-gssapi>`__ to be installed.

Credentials for GSSAPI can be specified with \ :emphasis:`url\_username`\ /\ :emphasis:`url\_password`\ or with the GSSAPI env var \ :literal:`KRB5CCNAME`\ that specified a custom Kerberos credential cache.
Credentials for GSSAPI can be specified with :emphasis:`url\_username`\ /\ :emphasis:`url\_password` or with the GSSAPI env var :literal:`KRB5CCNAME` that specified a custom Kerberos credential cache.

NTLM authentication is \ :literal:`not`\ supported even if the GSSAPI mech for NTLM has been installed.
NTLM authentication is :literal:`not` supported even if the GSSAPI mech for NTLM has been installed.



Expand Down
22 changes: 11 additions & 11 deletions docs/icinga_deploy.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,59 +31,59 @@ Parameters


force (optional, bool, False)
If \ :literal:`yes`\ do not get a cached copy.
If :literal:`yes` do not get a cached copy.


http_agent (optional, str, ansible-httpget)
Header to identify as, generally appears in web server logs.


use_proxy (optional, bool, True)
If \ :literal:`no`\ , it will not use a proxy, even if one is defined in an environment variable on the target hosts.
If :literal:`no`\ , it will not use a proxy, even if one is defined in an environment variable on the target hosts.


validate_certs (optional, bool, True)
If \ :literal:`no`\ , SSL certificates will not be validated.
If :literal:`no`\ , SSL certificates will not be validated.

This should only be used on personally controlled sites using self-signed certificates.


url_username (optional, str, None)
The username for use in HTTP basic authentication.

This parameter can be used without \ :emphasis:`url\_password`\ for sites that allow empty passwords
This parameter can be used without :emphasis:`url\_password` for sites that allow empty passwords


url_password (optional, str, None)
The password for use in HTTP basic authentication.

If the \ :emphasis:`url\_username`\ parameter is not specified, the \ :emphasis:`url\_password`\ parameter will not be used.
If the :emphasis:`url\_username` parameter is not specified, the :emphasis:`url\_password` parameter will not be used.


force_basic_auth (optional, bool, False)
Credentials specified with \ :emphasis:`url\_username`\ and \ :emphasis:`url\_password`\ should be passed in HTTP Header.
Credentials specified with :emphasis:`url\_username` and :emphasis:`url\_password` should be passed in HTTP Header.


client_cert (optional, path, None)
PEM formatted certificate chain file to be used for SSL client authentication.

This file can also include the key as well, and if the key is included, \ :literal:`client\_key`\ is not required.
This file can also include the key as well, and if the key is included, :literal:`client\_key` is not required.


client_key (optional, path, None)
PEM formatted file that contains your private key to be used for SSL client authentication.

If \ :literal:`client\_cert`\ contains both the certificate and key, this option is not required.
If :literal:`client\_cert` contains both the certificate and key, this option is not required.


use_gssapi (optional, bool, False)
Use GSSAPI to perform the authentication, typically this is for Kerberos or Kerberos through Negotiate authentication.

Requires the Python library \ `gssapi <https://github.com/pythongssapi/python-gssapi>`__\ to be installed.
Requires the Python library \ `gssapi <https://github.com/pythongssapi/python-gssapi>`__ to be installed.

Credentials for GSSAPI can be specified with \ :emphasis:`url\_username`\ /\ :emphasis:`url\_password`\ or with the GSSAPI env var \ :literal:`KRB5CCNAME`\ that specified a custom Kerberos credential cache.
Credentials for GSSAPI can be specified with :emphasis:`url\_username`\ /\ :emphasis:`url\_password` or with the GSSAPI env var :literal:`KRB5CCNAME` that specified a custom Kerberos credential cache.

NTLM authentication is \ :literal:`not`\ supported even if the GSSAPI mech for NTLM has been installed.
NTLM authentication is :literal:`not` supported even if the GSSAPI mech for NTLM has been installed.



Expand Down
Loading

0 comments on commit 39e3c90

Please sign in to comment.