From 2a169ceb469ca90540a8547e58fb1ded9a3024de Mon Sep 17 00:00:00 2001 From: Rafael Guterres Jeffman <rjeffman@redhat.com> Date: Mon, 4 Oct 2021 14:11:04 -0300 Subject: [PATCH] templates: Add IPA API connection variables to README. All modules should use the same description for IPA API connection variables. This change add description for ipaapi_context and ipaapi_ldap_cache variable to the module README templates. --- utils/templates/README-module+member.md.in | 2 ++ utils/templates/README-module.md.in | 2 ++ 2 files changed, 4 insertions(+) diff --git a/utils/templates/README-module+member.md.in b/utils/templates/README-module+member.md.in index 026496b3..074ea4ec 100644 --- a/utils/templates/README-module+member.md.in +++ b/utils/templates/README-module+member.md.in @@ -119,6 +119,8 @@ Variable | Description | Required -------- | ----------- | -------- `ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no `ipaadmin_password` | The admin password is a string and is required if there is no admin ticket available on the node | no +`ipaapi_context` | The context in which the module will execute. Executing in a server context is preferred. If not provided context will be determined by the execution environment. Valid values are `server` and `client`. | no +`ipaapi_ldap_cache` | Use LDAP cache for IPA connection. The bool setting defaults to yes. (bool) | no `name` \| `ALIAS` | The list of $name name strings. | yes `PARAMETER1` \| `API_PARAMETER_NAME` | DESCRIPTION | BOOL `PARAMETER2` \| `API_PARAMETER_NAME` | DESCRIPTION | BOOL diff --git a/utils/templates/README-module.md.in b/utils/templates/README-module.md.in index e5054fb2..25c69e4d 100644 --- a/utils/templates/README-module.md.in +++ b/utils/templates/README-module.md.in @@ -84,6 +84,8 @@ Variable | Description | Required -------- | ----------- | -------- `ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no `ipaadmin_password` | The admin password is a string and is required if there is no admin ticket available on the node | no +`ipaapi_context` | The context in which the module will execute. Executing in a server context is preferred. If not provided context will be determined by the execution environment. Valid values are `server` and `client`. | no +`ipaapi_ldap_cache` | Use LDAP cache for IPA connection. The bool setting defaults to yes. (bool) | no `name` \| `ALIAS` | The list of $name name strings. | yes `PARAMETER1` \| `API_PARAMETER_NAME` | DESCRIPTION | BOOL `PARAMETER2` \| `API_PARAMETER_NAME` | DESCRIPTION | BOOL -- GitLab