.. Document meta :orphan: .. Anchors .. _ansible_collections.inspur.ispim.edit_ldap_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title inspur.ispim.edit_ldap -- Set ldap information ++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This plugin is part of the `inspur.ispim collection <https://galaxy.ansible.com/inspur/ispim>`_. To install it use: :code:`ansible-galaxy collection install inspur.ispim`. To use it in a playbook, specify: :code:`inspur.ispim.edit_ldap`. .. version_added .. versionadded:: 1.0.0 of inspur.ispim .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Set ldap information on Inspur server. .. Aliases .. Requirements Requirements ------------ The below requirements are needed on the host that executes this module. - Python 3.7+ - inspursmsdk .. Options Parameters ---------- .. raw:: html <table border=0 cellpadding=0 class="documentation-table"> <tr> <th colspan="2">Parameter</th> <th>Choices/<font color="blue">Defaults</font></th> <th width="100%">Comments</th> </tr> <tr> <td colspan="2"> <div class="ansibleOptionAnchor" id="parameter-address"></div> <b>address</b> <a class="ansibleOptionLink" href="#parameter-address" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">string</span> </div> </td> <td> </td> <td> <div>Server Address.</div> </td> </tr> <tr> <td colspan="2"> <div class="ansibleOptionAnchor" id="parameter-attr"></div> <b>attr</b> <a class="ansibleOptionLink" href="#parameter-attr" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">string</span> </div> </td> <td> <ul style="margin: 0; padding: 0"><b>Choices:</b> <li>cn</li> <li>uid</li> </ul> </td> <td> <div>Attribute of User Login.</div> </td> </tr> <tr> <td colspan="2"> <div class="ansibleOptionAnchor" id="parameter-base"></div> <b>base</b> <a class="ansibleOptionLink" href="#parameter-base" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">string</span> </div> </td> <td> </td> <td> <div>Search Base,</div> <div>Search base is a string of 4 to 64 alpha-numeric characters;</div> <div>It must start with an alphabetical character;</div> <div>Special Symbols like dot(.), comma(,), hyphen(-), underscore(_), equal-to(=) are allowed.</div> </td> </tr> <tr> <td colspan="2"> <div class="ansibleOptionAnchor" id="parameter-ca"></div> <b>ca</b> <a class="ansibleOptionLink" href="#parameter-ca" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">string</span> </div> </td> <td> </td> <td> <div>CA certificate file path.</div> <div>Required when <em>encry=StartTLS</em>.</div> </td> </tr> <tr> <td colspan="2"> <div class="ansibleOptionAnchor" id="parameter-ce"></div> <b>ce</b> <a class="ansibleOptionLink" href="#parameter-ce" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">string</span> </div> </td> <td> </td> <td> <div>Certificate file path.</div> <div>Required when <em>encry=StartTLS</em>.</div> </td> </tr> <tr> <td colspan="2"> <div class="ansibleOptionAnchor" id="parameter-cn"></div> <b>cn</b> <a class="ansibleOptionLink" href="#parameter-cn" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">string</span> </div> </td> <td> <ul style="margin: 0; padding: 0"><b>Choices:</b> <li>ip</li> <li>fqdn</li> </ul> </td> <td> <div>Common name type.</div> <div>Required when <em>encry=StartTLS</em>.</div> </td> </tr> <tr> <td colspan="2"> <div class="ansibleOptionAnchor" id="parameter-code"></div> <b>code</b> <a class="ansibleOptionLink" href="#parameter-code" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">string</span> </div> </td> <td> </td> <td> <div>Password.</div> <div>Required when <em>enable=enable</em>.</div> </td> </tr> <tr> <td colspan="2"> <div class="ansibleOptionAnchor" id="parameter-dn"></div> <b>dn</b> <a class="ansibleOptionLink" href="#parameter-dn" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">string</span> </div> </td> <td> </td> <td> <div>Bind DN.</div> <div>Bind DN is a string of 4 to 64 alpha-numeric characters;</div> <div>It must start with an alphabetical character;</div> <div>Special Symbols like dot(.), comma(,), hyphen(-), underscore(_), equal-to(=) are allowed.</div> </td> </tr> <tr> <td colspan="2"> <div class="ansibleOptionAnchor" id="parameter-enable"></div> <b>enable</b> <a class="ansibleOptionLink" href="#parameter-enable" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">string</span> </div> </td> <td> <ul style="margin: 0; padding: 0"><b>Choices:</b> <li>enable</li> <li>disable</li> </ul> </td> <td> <div>LDAP/E-Directory Authentication Status.</div> </td> </tr> <tr> <td colspan="2"> <div class="ansibleOptionAnchor" id="parameter-encry"></div> <b>encry</b> <a class="ansibleOptionLink" href="#parameter-encry" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">string</span> </div> </td> <td> <ul style="margin: 0; padding: 0"><b>Choices:</b> <li>no</li> <li>SSL</li> <li>StartTLS</li> </ul> </td> <td> <div>Encryption Type.</div> </td> </tr> <tr> <td colspan="2"> <div class="ansibleOptionAnchor" id="parameter-host"></div> <b>host</b> <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">string</span> </div> </td> <td> </td> <td> <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> </td> </tr> <tr> <td colspan="2"> <div class="ansibleOptionAnchor" id="parameter-password"></div> <b>password</b> <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">string</span> </div> </td> <td> </td> <td> <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> </td> </tr> <tr> <td colspan="2"> <div class="ansibleOptionAnchor" id="parameter-pk"></div> <b>pk</b> <a class="ansibleOptionLink" href="#parameter-pk" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">string</span> </div> </td> <td> </td> <td> <div>Private Key file path.</div> <div>Required when <em>encry=StartTLS</em>.</div> </td> </tr> <tr> <td colspan="2"> <div class="ansibleOptionAnchor" id="parameter-provider"></div> <b>provider</b> <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">dictionary</span> </div> </td> <td> </td> <td> <div>A dict object containing connection details.</div> </td> </tr> <tr> <td class="elbow-placeholder"></td> <td colspan="1"> <div class="ansibleOptionAnchor" id="parameter-provider/host"></div> <b>host</b> <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">string</span> </div> </td> <td> </td> <td> <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div> </td> </tr> <tr> <td class="elbow-placeholder"></td> <td colspan="1"> <div class="ansibleOptionAnchor" id="parameter-provider/password"></div> <b>password</b> <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">string</span> </div> </td> <td> </td> <td> <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div> </td> </tr> <tr> <td class="elbow-placeholder"></td> <td colspan="1"> <div class="ansibleOptionAnchor" id="parameter-provider/username"></div> <b>username</b> <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">string</span> </div> </td> <td> </td> <td> <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> </td> </tr> <tr> <td colspan="2"> <div class="ansibleOptionAnchor" id="parameter-server_port"></div> <b>server_port</b> <a class="ansibleOptionLink" href="#parameter-server_port" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">integer</span> </div> </td> <td> </td> <td> <div>Server Port.</div> </td> </tr> <tr> <td colspan="2"> <div class="ansibleOptionAnchor" id="parameter-username"></div> <b>username</b> <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">string</span> </div> </td> <td> </td> <td> <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div> </td> </tr> </table> <br/> .. Notes Notes ----- .. note:: - Does not support ``check_mode``. .. Seealso .. Examples Examples -------- .. code-block:: yaml+jinja - name: Ldap test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Set ldap information" inspur.ispim.edit_ldap: enable: "disable" provider: "{{ ism }}" - name: "Set ldap information" inspur.ispim.edit_ldap: enable: "enable" encry: "SSL" address: "100.2.2.2" server_port: 389 dn: "cn=manager,ou=login,dc=domain,dc=com" code: "123456" base: "cn=manager" attr: "uid" provider: "{{ ism }}" .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: .. raw:: html <table border=0 cellpadding=0 class="documentation-table"> <tr> <th colspan="1">Key</th> <th>Returned</th> <th width="100%">Description</th> </tr> <tr> <td colspan="1"> <div class="ansibleOptionAnchor" id="return-changed"></div> <b>changed</b> <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a> <div style="font-size: small"> <span style="color: purple">boolean</span> </div> </td> <td>always</td> <td> <div>Check to see if a change was made on the device.</div> <br/> </td> </tr> <tr> <td colspan="1"> <div class="ansibleOptionAnchor" id="return-message"></div> <b>message</b> <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a> <div style="font-size: small"> <span style="color: purple">string</span> </div> </td> <td>always</td> <td> <div>Messages returned after module execution.</div> <br/> </td> </tr> <tr> <td colspan="1"> <div class="ansibleOptionAnchor" id="return-state"></div> <b>state</b> <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a> <div style="font-size: small"> <span style="color: purple">string</span> </div> </td> <td>always</td> <td> <div>Status after module execution.</div> <br/> </td> </tr> </table> <br/><br/> .. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - WangBaoshan (@ispim) .. Parsing errors