From 39e3c90464b2df00ae39359041a1e15262807c92 Mon Sep 17 00:00:00 2001 From: Telekom MMS GmbH Date: Thu, 29 Aug 2024 13:47:56 +0000 Subject: [PATCH] update documentation --- docs/icinga_command.rst | 28 ++++++++++---------- docs/icinga_command_info.rst | 22 ++++++++-------- docs/icinga_command_template.rst | 26 +++++++++---------- docs/icinga_command_template_info.rst | 22 ++++++++-------- docs/icinga_deploy.rst | 22 ++++++++-------- docs/icinga_deploy_info.rst | 22 ++++++++-------- docs/icinga_director_inventory.rst | 10 ++++---- docs/icinga_endpoint.rst | 22 ++++++++-------- docs/icinga_endpoint_info.rst | 22 ++++++++-------- docs/icinga_host.rst | 26 +++++++++---------- docs/icinga_host_info.rst | 22 ++++++++-------- docs/icinga_host_template.rst | 22 ++++++++-------- docs/icinga_host_template_info.rst | 22 ++++++++-------- docs/icinga_hostgroup.rst | 22 ++++++++-------- docs/icinga_hostgroup_info.rst | 22 ++++++++-------- docs/icinga_notification.rst | 28 ++++++++++---------- docs/icinga_notification_info.rst | 22 ++++++++-------- docs/icinga_notification_template.rst | 22 ++++++++-------- docs/icinga_notification_template_info.rst | 22 ++++++++-------- docs/icinga_scheduled_downtime.rst | 30 +++++++++++----------- docs/icinga_service.rst | 22 ++++++++-------- docs/icinga_service_apply.rst | 22 ++++++++-------- docs/icinga_service_apply_info.rst | 22 ++++++++-------- docs/icinga_service_info.rst | 22 ++++++++-------- docs/icinga_service_template.rst | 22 ++++++++-------- docs/icinga_service_template_info.rst | 22 ++++++++-------- docs/icinga_servicegroup.rst | 22 ++++++++-------- docs/icinga_servicegroup_info.rst | 22 ++++++++-------- docs/icinga_serviceset.rst | 22 ++++++++-------- docs/icinga_timeperiod.rst | 22 ++++++++-------- docs/icinga_timeperiod_info.rst | 22 ++++++++-------- docs/icinga_timeperiod_template.rst | 22 ++++++++-------- docs/icinga_timeperiod_template_info.rst | 22 ++++++++-------- docs/icinga_user.rst | 22 ++++++++-------- docs/icinga_user_group.rst | 22 ++++++++-------- docs/icinga_user_group_info.rst | 22 ++++++++-------- docs/icinga_user_info.rst | 22 ++++++++-------- docs/icinga_user_template.rst | 22 ++++++++-------- docs/icinga_user_template_info.rst | 22 ++++++++-------- docs/icinga_zone.rst | 22 ++++++++-------- docs/icinga_zone_info.rst | 22 ++++++++-------- 41 files changed, 459 insertions(+), 459 deletions(-) diff --git a/docs/icinga_command.rst b/docs/icinga_command.rst index d27b45ef..7bf8959a 100644 --- a/docs/icinga_command.rst +++ b/docs/icinga_command.rst @@ -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. @@ -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) @@ -95,7 +95,7 @@ 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) @@ -103,11 +103,11 @@ Parameters 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. @@ -115,39 +115,39 @@ Parameters 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 `__\ to be installed. + Requires the Python library \ `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. diff --git a/docs/icinga_command_info.rst b/docs/icinga_command_info.rst index 0bde7189..13774665 100644 --- a/docs/icinga_command_info.rst +++ b/docs/icinga_command_info.rst @@ -45,7 +45,7 @@ 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) @@ -53,11 +53,11 @@ Parameters 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. @@ -65,39 +65,39 @@ Parameters 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 `__\ to be installed. + Requires the Python library \ `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. diff --git a/docs/icinga_command_template.rst b/docs/icinga_command_template.rst index acb44acd..f823e07c 100644 --- a/docs/icinga_command_template.rst +++ b/docs/icinga_command_template.rst @@ -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) @@ -95,7 +95,7 @@ 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) @@ -103,11 +103,11 @@ Parameters 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. @@ -115,39 +115,39 @@ Parameters 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 `__\ to be installed. + Requires the Python library \ `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. diff --git a/docs/icinga_command_template_info.rst b/docs/icinga_command_template_info.rst index 22c41cfd..82fe0f95 100644 --- a/docs/icinga_command_template_info.rst +++ b/docs/icinga_command_template_info.rst @@ -41,7 +41,7 @@ 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) @@ -49,11 +49,11 @@ Parameters 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. @@ -61,39 +61,39 @@ Parameters 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 `__\ to be installed. + Requires the Python library \ `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. diff --git a/docs/icinga_deploy.rst b/docs/icinga_deploy.rst index 9fc59ee2..1a2b1b2a 100644 --- a/docs/icinga_deploy.rst +++ b/docs/icinga_deploy.rst @@ -31,7 +31,7 @@ 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) @@ -39,11 +39,11 @@ Parameters 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. @@ -51,39 +51,39 @@ Parameters 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 `__\ to be installed. + Requires the Python library \ `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. diff --git a/docs/icinga_deploy_info.rst b/docs/icinga_deploy_info.rst index 1b8dd5b6..19882954 100644 --- a/docs/icinga_deploy_info.rst +++ b/docs/icinga_deploy_info.rst @@ -35,7 +35,7 @@ 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) @@ -43,11 +43,11 @@ Parameters 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. @@ -55,39 +55,39 @@ Parameters 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 `__\ to be installed. + Requires the Python library \ `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. diff --git a/docs/icinga_director_inventory.rst b/docs/icinga_director_inventory.rst index 1891edc7..12c4645f 100644 --- a/docs/icinga_director_inventory.rst +++ b/docs/icinga_director_inventory.rst @@ -85,11 +85,11 @@ Parameters force (optional, bool, False) - If \ :literal:`yes`\ do not get a cached copy. + If :literal:`yes` do not get a cached copy. strict (optional, bool, False) - If \ :literal:`yes`\ make invalid entries a fatal error, otherwise skip and continue. + If :literal:`yes` make invalid entries a fatal error, otherwise skip and continue. Since it is possible to use facts in the expressions they might not always be available and we ignore those errors by default. @@ -125,13 +125,13 @@ Parameters default_value (optional, str, None) The default value when the host variable's value is an empty string. - This option is mutually exclusive with \ :literal:`trailing\_separator`\ . + This option is mutually exclusive with :literal:`trailing\_separator`. trailing_separator (optional, bool, True) - Set this option to \ :emphasis:`False`\ to omit the \ :literal:`separator`\ after the host variable when the value is an empty string. + Set this option to :emphasis:`False` to omit the :literal:`separator` after the host variable when the value is an empty string. - This option is mutually exclusive with \ :literal:`default\_value`\ . + This option is mutually exclusive with :literal:`default\_value`. diff --git a/docs/icinga_endpoint.rst b/docs/icinga_endpoint.rst index ea122217..b1df5446 100644 --- a/docs/icinga_endpoint.rst +++ b/docs/icinga_endpoint.rst @@ -65,7 +65,7 @@ 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) @@ -73,11 +73,11 @@ Parameters 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. @@ -85,39 +85,39 @@ Parameters 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 `__\ to be installed. + Requires the Python library \ `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. diff --git a/docs/icinga_endpoint_info.rst b/docs/icinga_endpoint_info.rst index 515325d9..3623224e 100644 --- a/docs/icinga_endpoint_info.rst +++ b/docs/icinga_endpoint_info.rst @@ -41,7 +41,7 @@ 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) @@ -49,11 +49,11 @@ Parameters 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. @@ -61,39 +61,39 @@ Parameters 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 `__\ to be installed. + Requires the Python library \ `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. diff --git a/docs/icinga_host.rst b/docs/icinga_host.rst index 9228e7e1..0d5862a9 100644 --- a/docs/icinga_host.rst +++ b/docs/icinga_host.rst @@ -139,9 +139,9 @@ Parameters imports (optional, list, None) - Choose a Host Template. Required when state is \ :literal:`present`\ . + Choose a Host Template. Required when state is :literal:`present`. - Required if \ :emphasis:`state`\ is \ :literal:`present`\ . + Required if :emphasis:`state` is :literal:`present`. master_should_connect (optional, bool, None) @@ -199,7 +199,7 @@ 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) @@ -207,11 +207,11 @@ Parameters 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. @@ -219,39 +219,39 @@ Parameters 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 `__\ to be installed. + Requires the Python library \ `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. diff --git a/docs/icinga_host_info.rst b/docs/icinga_host_info.rst index 65fed000..d04706c9 100644 --- a/docs/icinga_host_info.rst +++ b/docs/icinga_host_info.rst @@ -41,7 +41,7 @@ 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) @@ -49,11 +49,11 @@ Parameters 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. @@ -61,39 +61,39 @@ Parameters 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 `__\ to be installed. + Requires the Python library \ `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. diff --git a/docs/icinga_host_template.rst b/docs/icinga_host_template.rst index ed35aef9..eb5f7e82 100644 --- a/docs/icinga_host_template.rst +++ b/docs/icinga_host_template.rst @@ -197,7 +197,7 @@ 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) @@ -205,11 +205,11 @@ Parameters 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. @@ -217,39 +217,39 @@ Parameters 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 `__\ to be installed. + Requires the Python library \ `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. diff --git a/docs/icinga_host_template_info.rst b/docs/icinga_host_template_info.rst index 792ae426..d58806ee 100644 --- a/docs/icinga_host_template_info.rst +++ b/docs/icinga_host_template_info.rst @@ -41,7 +41,7 @@ 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) @@ -49,11 +49,11 @@ Parameters 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. @@ -61,39 +61,39 @@ Parameters 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 `__\ to be installed. + Requires the Python library \ `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. diff --git a/docs/icinga_hostgroup.rst b/docs/icinga_hostgroup.rst index 261cf4eb..7c52022c 100644 --- a/docs/icinga_hostgroup.rst +++ b/docs/icinga_hostgroup.rst @@ -55,7 +55,7 @@ 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) @@ -63,11 +63,11 @@ Parameters 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. @@ -75,39 +75,39 @@ Parameters 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 `__\ to be installed. + Requires the Python library \ `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. diff --git a/docs/icinga_hostgroup_info.rst b/docs/icinga_hostgroup_info.rst index 9419cead..f9d8ee5d 100644 --- a/docs/icinga_hostgroup_info.rst +++ b/docs/icinga_hostgroup_info.rst @@ -41,7 +41,7 @@ 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) @@ -49,11 +49,11 @@ Parameters 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. @@ -61,39 +61,39 @@ Parameters 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 `__\ to be installed. + Requires the Python library \ `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. diff --git a/docs/icinga_notification.rst b/docs/icinga_notification.rst index d6b63da9..f21afe0d 100644 --- a/docs/icinga_notification.rst +++ b/docs/icinga_notification.rst @@ -51,7 +51,7 @@ Parameters apply_to (optional, str, None) Whether this notification should affect hosts or services. - Required if \ :emphasis:`state`\ is \ :literal:`present`\ . + Required if :emphasis:`state` is :literal:`present`. assign_filter (optional, str, None) @@ -59,11 +59,11 @@ Parameters imports (optional, list, None) - Importable templates, add as many as you want. Required when state is \ :literal:`present`\ . + Importable templates, add as many as you want. Required when state is :literal:`present`. Please note that order matters when importing properties from multiple templates - last one wins. - Required if \ :emphasis:`state`\ is \ :literal:`present`\ . + Required if :emphasis:`state` is :literal:`present`. disabled (optional, bool, False) @@ -107,7 +107,7 @@ 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) @@ -115,11 +115,11 @@ Parameters 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. @@ -127,39 +127,39 @@ Parameters 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 `__\ to be installed. + Requires the Python library \ `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. diff --git a/docs/icinga_notification_info.rst b/docs/icinga_notification_info.rst index 3712bbb2..aa412531 100644 --- a/docs/icinga_notification_info.rst +++ b/docs/icinga_notification_info.rst @@ -41,7 +41,7 @@ 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) @@ -49,11 +49,11 @@ Parameters 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. @@ -61,39 +61,39 @@ Parameters 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 `__\ to be installed. + Requires the Python library \ `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. diff --git a/docs/icinga_notification_template.rst b/docs/icinga_notification_template.rst index c9616cf4..4b22e29b 100644 --- a/docs/icinga_notification_template.rst +++ b/docs/icinga_notification_template.rst @@ -89,7 +89,7 @@ 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) @@ -97,11 +97,11 @@ Parameters 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. @@ -109,39 +109,39 @@ Parameters 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 `__\ to be installed. + Requires the Python library \ `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. diff --git a/docs/icinga_notification_template_info.rst b/docs/icinga_notification_template_info.rst index 1f1db6ee..fa83120c 100644 --- a/docs/icinga_notification_template_info.rst +++ b/docs/icinga_notification_template_info.rst @@ -41,7 +41,7 @@ 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) @@ -49,11 +49,11 @@ Parameters 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. @@ -61,39 +61,39 @@ Parameters 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 `__\ to be installed. + Requires the Python library \ `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. diff --git a/docs/icinga_scheduled_downtime.rst b/docs/icinga_scheduled_downtime.rst index 4ee245f7..00e32f5a 100644 --- a/docs/icinga_scheduled_downtime.rst +++ b/docs/icinga_scheduled_downtime.rst @@ -37,19 +37,19 @@ Parameters author (optional, str, None) Name of the downtime author. - Required if \ :emphasis:`state`\ is \ :literal:`present`\ . + Required if :emphasis:`state` is :literal:`present`. comment (optional, str, None) A descriptive comment for the downtime. - Required if \ :emphasis:`state`\ is \ :literal:`present`\ . + Required if :emphasis:`state` is :literal:`present`. fixed (optional, bool, False) Whether this downtime is fixed or flexible. If unsure please check the related documentation https://icinga.com/docs/icinga2/latest/doc/08-advanced-topics/#downtimes - Required if \ :emphasis:`state`\ is \ :literal:`present`\ . + Required if :emphasis:`state` is :literal:`present`. with_services (optional, bool, True) @@ -63,7 +63,7 @@ Parameters apply_to (optional, str, None) Whether this dependency should affect hosts or services - Required if \ :emphasis:`state`\ is \ :literal:`present`\ . + Required if :emphasis:`state` is :literal:`present`. assign_filter (optional, str, None) @@ -87,7 +87,7 @@ 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) @@ -95,11 +95,11 @@ Parameters 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. @@ -107,39 +107,39 @@ Parameters 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 `__\ to be installed. + Requires the Python library \ `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. diff --git a/docs/icinga_service.rst b/docs/icinga_service.rst index 41f09f06..deb001a1 100644 --- a/docs/icinga_service.rst +++ b/docs/icinga_service.rst @@ -147,7 +147,7 @@ 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) @@ -155,11 +155,11 @@ Parameters 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. @@ -167,39 +167,39 @@ Parameters 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 `__\ to be installed. + Requires the Python library \ `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. diff --git a/docs/icinga_service_apply.rst b/docs/icinga_service_apply.rst index 7846c951..0d6aac57 100644 --- a/docs/icinga_service_apply.rst +++ b/docs/icinga_service_apply.rst @@ -149,7 +149,7 @@ 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) @@ -157,11 +157,11 @@ Parameters 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. @@ -169,39 +169,39 @@ Parameters 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 `__\ to be installed. + Requires the Python library \ `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. diff --git a/docs/icinga_service_apply_info.rst b/docs/icinga_service_apply_info.rst index 3d87fff8..f2c61edd 100644 --- a/docs/icinga_service_apply_info.rst +++ b/docs/icinga_service_apply_info.rst @@ -41,7 +41,7 @@ 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) @@ -49,11 +49,11 @@ Parameters 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. @@ -61,39 +61,39 @@ Parameters 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 `__\ to be installed. + Requires the Python library \ `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. diff --git a/docs/icinga_service_info.rst b/docs/icinga_service_info.rst index cc552097..eaefdb5c 100644 --- a/docs/icinga_service_info.rst +++ b/docs/icinga_service_info.rst @@ -41,7 +41,7 @@ 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) @@ -49,11 +49,11 @@ Parameters 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. @@ -61,39 +61,39 @@ Parameters 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 `__\ to be installed. + Requires the Python library \ `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. diff --git a/docs/icinga_service_template.rst b/docs/icinga_service_template.rst index 1eabbb8f..51f65ae0 100644 --- a/docs/icinga_service_template.rst +++ b/docs/icinga_service_template.rst @@ -163,7 +163,7 @@ 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) @@ -171,11 +171,11 @@ Parameters 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. @@ -183,39 +183,39 @@ Parameters 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 `__\ to be installed. + Requires the Python library \ `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. diff --git a/docs/icinga_service_template_info.rst b/docs/icinga_service_template_info.rst index cb873a03..958f6046 100644 --- a/docs/icinga_service_template_info.rst +++ b/docs/icinga_service_template_info.rst @@ -41,7 +41,7 @@ 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) @@ -49,11 +49,11 @@ Parameters 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. @@ -61,39 +61,39 @@ Parameters 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 `__\ to be installed. + Requires the Python library \ `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. diff --git a/docs/icinga_servicegroup.rst b/docs/icinga_servicegroup.rst index 3573402a..73de6b8c 100644 --- a/docs/icinga_servicegroup.rst +++ b/docs/icinga_servicegroup.rst @@ -55,7 +55,7 @@ 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) @@ -63,11 +63,11 @@ Parameters 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. @@ -75,39 +75,39 @@ Parameters 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 `__\ to be installed. + Requires the Python library \ `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. diff --git a/docs/icinga_servicegroup_info.rst b/docs/icinga_servicegroup_info.rst index de4b2149..09f117c2 100644 --- a/docs/icinga_servicegroup_info.rst +++ b/docs/icinga_servicegroup_info.rst @@ -41,7 +41,7 @@ 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) @@ -49,11 +49,11 @@ Parameters 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. @@ -61,39 +61,39 @@ Parameters 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 `__\ to be installed. + Requires the Python library \ `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. diff --git a/docs/icinga_serviceset.rst b/docs/icinga_serviceset.rst index 99ed370e..13495581 100644 --- a/docs/icinga_serviceset.rst +++ b/docs/icinga_serviceset.rst @@ -53,7 +53,7 @@ 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) @@ -61,11 +61,11 @@ Parameters 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. @@ -73,39 +73,39 @@ Parameters 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 `__\ to be installed. + Requires the Python library \ `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. diff --git a/docs/icinga_timeperiod.rst b/docs/icinga_timeperiod.rst index a8405258..41be99f5 100644 --- a/docs/icinga_timeperiod.rst +++ b/docs/icinga_timeperiod.rst @@ -57,7 +57,7 @@ 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) @@ -65,11 +65,11 @@ Parameters 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. @@ -77,39 +77,39 @@ Parameters 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 `__\ to be installed. + Requires the Python library \ `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. diff --git a/docs/icinga_timeperiod_info.rst b/docs/icinga_timeperiod_info.rst index 289c9697..0f800031 100644 --- a/docs/icinga_timeperiod_info.rst +++ b/docs/icinga_timeperiod_info.rst @@ -41,7 +41,7 @@ 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) @@ -49,11 +49,11 @@ Parameters 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. @@ -61,39 +61,39 @@ Parameters 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 `__\ to be installed. + Requires the Python library \ `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. diff --git a/docs/icinga_timeperiod_template.rst b/docs/icinga_timeperiod_template.rst index ac61b2a2..32a743e5 100644 --- a/docs/icinga_timeperiod_template.rst +++ b/docs/icinga_timeperiod_template.rst @@ -81,7 +81,7 @@ 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) @@ -89,11 +89,11 @@ Parameters 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. @@ -101,39 +101,39 @@ Parameters 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 `__\ to be installed. + Requires the Python library \ `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. diff --git a/docs/icinga_timeperiod_template_info.rst b/docs/icinga_timeperiod_template_info.rst index 82e85b0b..d4e771ce 100644 --- a/docs/icinga_timeperiod_template_info.rst +++ b/docs/icinga_timeperiod_template_info.rst @@ -41,7 +41,7 @@ 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) @@ -49,11 +49,11 @@ Parameters 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. @@ -61,39 +61,39 @@ Parameters 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 `__\ to be installed. + Requires the Python library \ `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. diff --git a/docs/icinga_user.rst b/docs/icinga_user.rst index f359bebc..ccc44b6c 100644 --- a/docs/icinga_user.rst +++ b/docs/icinga_user.rst @@ -77,7 +77,7 @@ 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) @@ -85,11 +85,11 @@ Parameters 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. @@ -97,39 +97,39 @@ Parameters 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 `__\ to be installed. + Requires the Python library \ `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. diff --git a/docs/icinga_user_group.rst b/docs/icinga_user_group.rst index 76efc60d..63cf37a9 100644 --- a/docs/icinga_user_group.rst +++ b/docs/icinga_user_group.rst @@ -53,7 +53,7 @@ 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) @@ -61,11 +61,11 @@ Parameters 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. @@ -73,39 +73,39 @@ Parameters 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 `__\ to be installed. + Requires the Python library \ `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. diff --git a/docs/icinga_user_group_info.rst b/docs/icinga_user_group_info.rst index c1e9f3c3..ed814052 100644 --- a/docs/icinga_user_group_info.rst +++ b/docs/icinga_user_group_info.rst @@ -41,7 +41,7 @@ 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) @@ -49,11 +49,11 @@ Parameters 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. @@ -61,39 +61,39 @@ Parameters 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 `__\ to be installed. + Requires the Python library \ `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. diff --git a/docs/icinga_user_info.rst b/docs/icinga_user_info.rst index 936655a7..cabaa03e 100644 --- a/docs/icinga_user_info.rst +++ b/docs/icinga_user_info.rst @@ -41,7 +41,7 @@ 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) @@ -49,11 +49,11 @@ Parameters 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. @@ -61,39 +61,39 @@ Parameters 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 `__\ to be installed. + Requires the Python library \ `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. diff --git a/docs/icinga_user_template.rst b/docs/icinga_user_template.rst index 4c716e0c..d3593e89 100644 --- a/docs/icinga_user_template.rst +++ b/docs/icinga_user_template.rst @@ -61,7 +61,7 @@ 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) @@ -69,11 +69,11 @@ Parameters 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. @@ -81,39 +81,39 @@ Parameters 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 `__\ to be installed. + Requires the Python library \ `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. diff --git a/docs/icinga_user_template_info.rst b/docs/icinga_user_template_info.rst index 541f379e..bf223fb2 100644 --- a/docs/icinga_user_template_info.rst +++ b/docs/icinga_user_template_info.rst @@ -41,7 +41,7 @@ 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) @@ -49,11 +49,11 @@ Parameters 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. @@ -61,39 +61,39 @@ Parameters 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 `__\ to be installed. + Requires the Python library \ `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. diff --git a/docs/icinga_zone.rst b/docs/icinga_zone.rst index 7648c8a2..eccdfdd3 100644 --- a/docs/icinga_zone.rst +++ b/docs/icinga_zone.rst @@ -57,7 +57,7 @@ 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) @@ -65,11 +65,11 @@ Parameters 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. @@ -77,39 +77,39 @@ Parameters 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 `__\ to be installed. + Requires the Python library \ `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. diff --git a/docs/icinga_zone_info.rst b/docs/icinga_zone_info.rst index c3cc416f..cba5a2d1 100644 --- a/docs/icinga_zone_info.rst +++ b/docs/icinga_zone_info.rst @@ -45,7 +45,7 @@ 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) @@ -53,11 +53,11 @@ Parameters 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. @@ -65,39 +65,39 @@ Parameters 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 `__\ to be installed. + Requires the Python library \ `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.