deploy: 9af202e

branch/main/collections/environment_variables.html

@@ -140,6 +140,7 @@
 <p><code class="docutils literal notranslate"><span class="pre">negotiate</span></code>, <code class="docutils literal notranslate"><span class="pre">kerberos</span></code>, and <code class="docutils literal notranslate"><span class="pre">ntlm</span></code> support encryption over LDAP.</p>
 <p>Kerberos support requires the <code class="docutils literal notranslate"><span class="pre">pyspnego[kerberos]</span></code> extras to be installed.</p>
 <p>See <a class="reference internal" href="microsoft/ad/docsite/guide_ldap_connection.html#ansible-collections-microsoft-ad-docsite-guide-ldap-connection-authentication"><span class="std std-ref">LDAP authentication</span></a> for more information.</p>
+<p>This option can be set using a Jinja2 template value.</p>
 <p><em>Used by:</em>
 <a class="reference internal" href="microsoft/ad/ldap_inventory.html#ansible-collections-microsoft-ad-ldap-inventory"><span class="std std-ref">microsoft.ad.ldap inventory plugin</span></a></p>
 </dd></dl>
@@ -149,6 +150,7 @@
 <span class="sig-name descname"><span class="pre">MICROSOFT_AD_LDAP_CA_CERT</span></span><a class="headerlink" href="#envvar-MICROSOFT_AD_LDAP_CA_CERT" title="Link to this definition"></a></dt>
 <dd><p>Can be the path to a CA certificate PEM or DER file, directory of PEM certificates, or the CA certificate PEM string that is used for certificate validation.</p>
 <p>If omitted, the default CA store used for validation is dependent on the current Python settings.</p>
+<p>This option can be set using a Jinja2 template value.</p>
 <p><em>Used by:</em>
 <a class="reference internal" href="microsoft/ad/ldap_inventory.html#ansible-collections-microsoft-ad-ldap-inventory"><span class="std std-ref">microsoft.ad.ldap inventory plugin</span></a></p>
 </dd></dl>
@@ -162,6 +164,7 @@
 <p><code class="docutils literal notranslate"><span class="pre">ignore</span></code> will ignore any certificate errors.</p>
 <p><code class="docutils literal notranslate"><span class="pre">ignore_hostname</span></code> will validate the CA trust chain but will ignore any hostname checks performed by TLS.</p>
 <p>See <a class="reference internal" href="microsoft/ad/docsite/guide_ldap_connection.html#ansible-collections-microsoft-ad-docsite-guide-ldap-connection-cert-validation"><span class="std std-ref">Certificate validation</span></a> for more information.</p>
+<p>This option can be set using a Jinja2 template value.</p>
 <p><em>Used by:</em>
 <a class="reference internal" href="microsoft/ad/ldap_inventory.html#ansible-collections-microsoft-ad-ldap-inventory"><span class="std std-ref">microsoft.ad.ldap inventory plugin</span></a></p>
 </dd></dl>
@@ -174,6 +177,7 @@
 <p>If using a path to a certificate file, the file can be a PEM encoded certificate, a PEM encoded certificate and key bundle, a DER encoded certificate, or a PFX/PKCS12 encoded certificate and key bundle.</p>
 <p>Use <em>certificate_key</em> if the certificate specified does not contain the key.</p>
 <p>Use <em>certificate_password</em> if the key is encrypted with a password.</p>
+<p>This option can be set using a Jinja2 template value.</p>
 <p><em>Used by:</em>
 <a class="reference internal" href="microsoft/ad/ldap_inventory.html#ansible-collections-microsoft-ad-ldap-inventory"><span class="std std-ref">microsoft.ad.ldap inventory plugin</span></a></p>
 </dd></dl>
@@ -184,6 +188,7 @@
 <dd><p>The certificate key that is used for certificate authentication.</p>
 <p>The value can either be a path to a file containing the key in the PEM or DER encoded form, or it can be the string of a PEM encoded key.</p>
 <p>Use <em>certificate_password</em> if the key is encrypted with a password.</p>
+<p>This option can be set using a Jinja2 template value.</p>
 <p><em>Used by:</em>
 <a class="reference internal" href="microsoft/ad/ldap_inventory.html#ansible-collections-microsoft-ad-ldap-inventory"><span class="std std-ref">microsoft.ad.ldap inventory plugin</span></a></p>
 </dd></dl>
@@ -192,6 +197,7 @@
 <dt class="sig sig-object std" id="envvar-MICROSOFT_AD_LDAP_CERTIFICATE_PASSWORD">
 <span class="sig-name descname"><span class="pre">MICROSOFT_AD_LDAP_CERTIFICATE_PASSWORD</span></span><a class="headerlink" href="#envvar-MICROSOFT_AD_LDAP_CERTIFICATE_PASSWORD" title="Link to this definition"></a></dt>
 <dd><p>The password used to decrypt the certificate key specified by <em>certificate</em> or <em>certificate_key</em>.</p>
+<p>This option can be set using a Jinja2 template value.</p>
 <p><em>Used by:</em>
 <a class="reference internal" href="microsoft/ad/ldap_inventory.html#ansible-collections-microsoft-ad-ldap-inventory"><span class="std std-ref">microsoft.ad.ldap inventory plugin</span></a></p>
 </dd></dl>
@@ -200,6 +206,7 @@
 <dt class="sig sig-object std" id="envvar-MICROSOFT_AD_LDAP_CONNECTION_TIMEOUT">
 <span class="sig-name descname"><span class="pre">MICROSOFT_AD_LDAP_CONNECTION_TIMEOUT</span></span><a class="headerlink" href="#envvar-MICROSOFT_AD_LDAP_CONNECTION_TIMEOUT" title="Link to this definition"></a></dt>
 <dd><p>The timeout in seconds to wait until the connection is established before failing.</p>
+<p>This option can be set using a Jinja2 template value.</p>
 <p><em>Used by:</em>
 <a class="reference internal" href="microsoft/ad/ldap_inventory.html#ansible-collections-microsoft-ad-ldap-inventory"><span class="std std-ref">microsoft.ad.ldap inventory plugin</span></a></p>
 </dd></dl>
@@ -211,6 +218,7 @@
 <p>Encryption can either be performed using the authentication protocol or through TLS.</p>
 <p>The <em>auth_protocol</em> <code class="docutils literal notranslate"><span class="pre">negotiate</span></code>, <code class="docutils literal notranslate"><span class="pre">kerberos</span></code>, and <code class="docutils literal notranslate"><span class="pre">ntlm</span></code> all support encryption over LDAP whereas <code class="docutils literal notranslate"><span class="pre">simple</span></code> does not.</p>
 <p>If using <code class="docutils literal notranslate"><span class="pre">auth_protocol=simple</span></code> over LDAP without TLS then this must be set to <code class="docutils literal notranslate"><span class="pre">False</span></code>. As no encryption is used, all traffic will be in plaintext and should be avoided.</p>
+<p>This option can be set using a Jinja2 template value.</p>
 <p><em>Used by:</em>
 <a class="reference internal" href="microsoft/ad/ldap_inventory.html#ansible-collections-microsoft-ad-ldap-inventory"><span class="std std-ref">microsoft.ad.ldap inventory plugin</span></a></p>
 </dd></dl>
@@ -221,6 +229,7 @@
 <dd><p>The password to authenticate with.</p>
 <p>If <em>auth_protocol</em> is <code class="docutils literal notranslate"><span class="pre">simple</span></code> and no password is specified, the bind will be performed as an unauthenticated bind.</p>
 <p>If <em>auth_protocol</em> is <code class="docutils literal notranslate"><span class="pre">negotiate</span></code>, <code class="docutils literal notranslate"><span class="pre">kerberos</span></code>, or <code class="docutils literal notranslate"><span class="pre">ntlm</span></code> and no password is specified, it will attempt to use the local cached credential specified by <em>username</em> if available.</p>
+<p>This option can be set using a Jinja2 template value.</p>
 <p><em>Used by:</em>
 <a class="reference internal" href="microsoft/ad/ldap_inventory.html#ansible-collections-microsoft-ad-ldap-inventory"><span class="std std-ref">microsoft.ad.ldap inventory plugin</span></a></p>
 </dd></dl>
@@ -231,6 +240,7 @@
 <dd><p>The LDAP port to use for the connection.</p>
 <p>Port 389 is used for LDAP and port 686 is used for LDAPS.</p>
 <p>Defaults to port <code class="docutils literal notranslate"><span class="pre">636</span></code> if <code class="docutils literal notranslate"><span class="pre">tls_mode=ldaps</span></code> otherwise <code class="docutils literal notranslate"><span class="pre">389</span></code>.</p>
+<p>This option can be set using a Jinja2 template value.</p>
 <p><em>Used by:</em>
 <a class="reference internal" href="microsoft/ad/ldap_inventory.html#ansible-collections-microsoft-ad-ldap-inventory"><span class="std std-ref">microsoft.ad.ldap inventory plugin</span></a></p>
 </dd></dl>
@@ -241,6 +251,7 @@
 <dd><p>The domain controller/server to connect to.</p>
 <p>If not specified the server will be derived from the current krb5.conf <code class="docutils literal notranslate"><span class="pre">default_realm</span></code> setting and with an SRV DNS lookup.</p>
 <p>See <a class="reference internal" href="microsoft/ad/docsite/guide_ldap_connection.html#ansible-collections-microsoft-ad-docsite-guide-ldap-connection-server-lookup"><span class="std std-ref">Server lookup</span></a> for more information.</p>
+<p>This option can be set using a Jinja2 template value.</p>
 <p><em>Used by:</em>
 <a class="reference internal" href="microsoft/ad/ldap_inventory.html#ansible-collections-microsoft-ad-ldap-inventory"><span class="std std-ref">microsoft.ad.ldap inventory plugin</span></a></p>
 </dd></dl>
@@ -253,6 +264,7 @@
 <p><code class="docutils literal notranslate"><span class="pre">ldaps</span></code> will connect over LDAPS (port 636).</p>
 <p><code class="docutils literal notranslate"><span class="pre">start_tls</span></code> will connect over LDAP (port 389) and perform the StartTLS operation before the authentication bind.</p>
 <p>It is recommended to use <code class="docutils literal notranslate"><span class="pre">ldaps</span></code> over <code class="docutils literal notranslate"><span class="pre">start_tls</span></code> if TLS is going to be used.</p>
+<p>This option can be set using a Jinja2 template value.</p>
 <p><em>Used by:</em>
 <a class="reference internal" href="microsoft/ad/ldap_inventory.html#ansible-collections-microsoft-ad-ldap-inventory"><span class="std std-ref">microsoft.ad.ldap inventory plugin</span></a></p>
 </dd></dl>
@@ -263,6 +275,7 @@
 <dd><p>The username to authenticate with.</p>
 <p>If <em>auth_protocol</em> is <code class="docutils literal notranslate"><span class="pre">simple</span></code> and no username is specified, anonymous authentication is used.</p>
 <p>If <em>auth_protocol</em> is <code class="docutils literal notranslate"><span class="pre">negotiate</span></code>, <code class="docutils literal notranslate"><span class="pre">kerberos</span></code>, or <code class="docutils literal notranslate"><span class="pre">ntlm</span></code> and no username is specified, it will attempt to use the local cached credential if available, for example one retrieved by <code class="docutils literal notranslate"><span class="pre">kinit</span></code>.</p>
+<p>This option can be set using a Jinja2 template value.</p>
 <p><em>Used by:</em>
 <a class="reference internal" href="microsoft/ad/ldap_inventory.html#ansible-collections-microsoft-ad-ldap-inventory"><span class="std std-ref">microsoft.ad.ldap inventory plugin</span></a></p>
 </dd></dl>