Personal/ansible-ldap-modules
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Updates to README.

Browse source
This commit is contained in:
Dhruv Bansal 2016-09-19 07:19:29 +00:00
parent 03bc81122d
commit 5b09a29fed
1 changed files with 8 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
README.md
View file

@ -69,21 +69,9 @@ machine so that `ansible` can find it.
$ git clone https://github.com/unchained-capital/ansible-ldap-modules $ git clone https://github.com/unchained-capital/ansible-ldap-modules
``` ```
Once you have `python-ldap` installed, you'll need to link the Now either set the `ANSIBLE_LIBRARY` environment variable or the
executable files in this repository into Ansible's library path. The `library` entry within the `defaults` section of your `ansible.cfg` to
simplest way to do this is to create a `library` folder at the include this repository's directory.
top-level of your playbook repository and create symlinks within it to
the module files in this repository:
```
$ mkdir -p library
$ ln -s ansible-ldap-modules/ldap_entry library/ldap_entry
$ ln -s ansible-ldap-modules/ldap_attr library/ldap_attr
```
You can also explicitly set the `ANSIBLE_LIBRARY` environment variable
or the `library` entry within the `defaults` section of your
`ansible.cfg` to include this repository's directory.
# Usage # Usage
@ -110,7 +98,7 @@ below):
dn: "ou=People,dc=example,dc=com" dn: "ou=People,dc=example,dc=com"
ou: People ou: People
objectClass: organizationalUnit objectClass: organizationalUnit
description: Getting together and having a good time. description: A bunch of Ansible-lovers.
``` ```
The target host of an LDAP operation is assumed to be the same host as The target host of an LDAP operation is assumed to be the same host as
@ -126,7 +114,7 @@ to LDAP server running on `server0` listenting on port 389. This example:
dn: "ou=People,dc=example,dc=com" dn: "ou=People,dc=example,dc=com"
ou: People ou: People
objectClass: organizationalUnit objectClass: organizationalUnit
description: Getting together and having a good time. description: A bunch of Ansible-lovers.
``` ```
would target an LDAP server at `server1`. would target an LDAP server at `server1`.
@ -150,7 +138,7 @@ Credentials can be specified as well:
dn: "ou=People,dc=example,dc=com" dn: "ou=People,dc=example,dc=com"
ou: People ou: People
objectClass: organizationalUnit objectClass: organizationalUnit
description: Getting together and having a good time. description: A bunch of Ansible-lovers.
``` ```
## Modules ## Modules
@ -173,7 +161,7 @@ Ansible, `ldap_entry` does nothing. You can, however, use
dn: "ou=People,dc=example,dc=com" dn: "ou=People,dc=example,dc=com"
ou: People ou: People
objectClass: organizationalUnit objectClass: organizationalUnit
description: Getting together and having a good time. description: A bunch of Ansible-lovers.
``` ```
If the `ou=People,dc=example,dc=com` entry has its `description` field If the `ou=People,dc=example,dc=com` entry has its `description` field
@ -210,7 +198,7 @@ Here's a simple example.
dn: "ou=People,dc=example,dc=com" dn: "ou=People,dc=example,dc=com"
name: description name: description
state: exact state: exact
values: Getting together and having a good time. values: A bunch of Ansible-lovers.
- name: Ensure members are correct for cn=Admins,ou=Groups - name: Ensure members are correct for cn=Admins,ou=Groups
ldap_attr: ldap_attr: