Skip to content

Commit

Permalink
module README files: Drop extra module header in Variables section
Browse files Browse the repository at this point in the history 
The Variables and also the Return Variables sections contained an extra
header with the module name. This is only needed if there are more than
one module in the README.
  • Loading branch information
@t-woerner
t-woerner committed Dec 23, 2021
1 parent ec2c0c4 commit 65937ed
Show file tree
Hide file tree
Showing 30 changed files with 0 additions and 101 deletions.
3 changes: 0 additions & 3 deletions README-automember.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -115,9 +115,6 @@ Example playbook to add an inclusive condition to an existing rule
Variables
---------
ipaautomember
-------
Variable | Description | Required
-------- | ----------- | --------
`ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no
Expand Down
3 changes: 0 additions & 3 deletions README-automountlocation.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -97,9 +97,6 @@ Example playbook to ensure absence of an automount location:
Variables
=========
ipaautomountlocation
-------
Variable | Description | Required
-------- | ----------- | --------
`ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no
Expand Down
3 changes: 0 additions & 3 deletions README-config.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -82,9 +82,6 @@ Example playbook to read config options:
Variables
=========
ipauser
-------
**General Variables:**
Variable | Description | Required
Expand Down
3 changes: 0 additions & 3 deletions README-delegation.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -135,9 +135,6 @@ Example playbook to make sure delegation "basic manager attributes" is absent:
Variables
---------
ipadelegation
-------
Variable | Description | Required
-------- | ----------- | --------
`ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no
Expand Down
3 changes: 0 additions & 3 deletions README-dnsconfig.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -119,9 +119,6 @@ Example playbook to disallow synchronization of forward (A, AAAA) and reverse (P
Variables
=========
ipadnsconfig
------------
Variable | Description | Required
-------- | ----------- | --------
`ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no
Expand Down
3 changes: 0 additions & 3 deletions README-dnsforwardzone.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -100,9 +100,6 @@ Example playbook to ensure presence of a forwardzone to ipa DNS:
Variables
=========
ipagroup
-------
Variable | Description | Required
-------- | ----------- | --------
`ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no
Expand Down
3 changes: 0 additions & 3 deletions README-dnsrecord.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -242,9 +242,6 @@ Example playbook to ensure multiple DNS records are absent:
Variables
=========
ipadnsrecord
------------
Variable | Description | Required
-------- | ----------- | --------
`ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no
Expand Down
6 changes: 0 additions & 6 deletions README-dnszone.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -195,9 +195,6 @@ Example playbook to create a zone for reverse DNS lookup, from an IP address, gi
Variables
=========

ipadnszone
----------

Variable | Description | Required
-------- | ----------- | --------
`ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no
Expand Down Expand Up @@ -233,9 +230,6 @@ Variable | Description | Required
Return Values
=============

ipadnszone
----------

Variable | Description | Returned When
-------- | ----------- | -------------
`dnszone` | DNS Zone dict with zone name infered from `name_from_ip`. <br>Options: | If `state` is `present`, `name_from_ip` is used, and a zone was created.
Expand Down
3 changes: 0 additions & 3 deletions README-group.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -147,9 +147,6 @@ Example playbook to remove groups:
Variables
=========

ipagroup
-------

Variable | Description | Required
-------- | ----------- | --------
`ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no
Expand Down
3 changes: 0 additions & 3 deletions README-hbacrule.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -129,9 +129,6 @@ Example playbook to make sure HBAC Rule login is absent:
Variables
=========
ipahbacrule
---------------
Variable | Description | Required
-------- | ----------- | --------
`ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no
Expand Down
3 changes: 0 additions & 3 deletions README-hbacsvc.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -91,9 +91,6 @@ Example playbook to make sure HBAC Services for http and tftp are absent
Variables
=========
ipahbacsvc
----------
Variable | Description | Required
-------- | ----------- | --------
`ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no
Expand Down
3 changes: 0 additions & 3 deletions README-hbacsvcgroup.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -129,9 +129,6 @@ Example playbook to make sure HBAC Service Group login is absent:
Variables
=========
ipahbacsvcgroup
---------------
Variable | Description | Required
-------- | ----------- | --------
`ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no
Expand Down
6 changes: 0 additions & 6 deletions README-host.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -313,9 +313,6 @@ Example playbook to ensure a host is absent:
Variables
=========

ipahost
-------

Variable | Description | Required
-------- | ----------- | --------
`ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no
Expand Down Expand Up @@ -370,9 +367,6 @@ Variable | Description | Required
Return Values
=============

ipahost
-------

There are only return values if one or more random passwords have been generated.

Variable | Description | Returned When
Expand Down
3 changes: 0 additions & 3 deletions README-hostgroup.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -143,9 +143,6 @@ Example playbook to make sure host-group databases is absent:
Variables
=========

ipahostgroup
-------

Variable | Description | Required
-------- | ----------- | --------
`ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no
Expand Down
3 changes: 0 additions & 3 deletions README-location.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -74,9 +74,6 @@ Example playbook to make sure location "my_location1" is absent:
Variables
---------
ipalocation
-------
Variable | Description | Required
-------- | ----------- | --------
`ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no
Expand Down
3 changes: 0 additions & 3 deletions README-permission.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -154,9 +154,6 @@ Example playbook to make sure permission "MyPermission" is renamed to "MyNewPerm
Variables
---------
ipapermission
-------
Variable | Description | Required
-------- | ----------- | --------
`ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no
Expand Down
3 changes: 0 additions & 3 deletions README-privilege.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -126,9 +126,6 @@ Example playbook to make sure privilege "DNS Special Privilege" is absent:
Variables
---------
ipaprivilege
------------
Variable | Description | Required
-------- | ----------- | --------
`ipaadmin_principal` | The admin principal is a string and defaults to `admin`. | no
Expand Down
3 changes: 0 additions & 3 deletions README-pwpolicy.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -91,9 +91,6 @@ Example playbook to ensure maxlife is set to 49 in global policy:
Variables
=========
ipapwpolicy
-------
Variable | Description | Required
-------- | ----------- | --------
`ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no
Expand Down
3 changes: 0 additions & 3 deletions README-role.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -238,9 +238,6 @@ Example playbook to ensure that different members are not associated with a role
Variables
---------
iparole
-------
Variable | Description | Required
-------- | ----------- | --------
`ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no
Expand Down
3 changes: 0 additions & 3 deletions README-selfservice.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -131,9 +131,6 @@ Example playbook to make sure selfservice "Users can manage their own name detai
Variables
---------
ipaselfservice
-------
Variable | Description | Required
-------- | ----------- | --------
`ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no
Expand Down
3 changes: 0 additions & 3 deletions README-server.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -242,9 +242,6 @@ This task will always report a change.
Variables
---------
ipaserver
-------
Variable | Description | Required
-------- | ----------- | --------
`ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no
Expand Down
2 changes: 0 additions & 2 deletions README-service.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -285,8 +285,6 @@ Example playbook to allow users, groups, hosts or hostgroups to retrieve a keyta
Variables
---------
ipaservice
Variable | Description | Required
-------- | ----------- | --------
`ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no
Expand Down
3 changes: 0 additions & 3 deletions README-sudocmd.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -76,9 +76,6 @@ Example playbook to make sure sudocmd is absent:
Variables
=========
ipasudocmd
-------
Variable | Description | Required
-------- | ----------- | --------
`ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no
Expand Down
3 changes: 0 additions & 3 deletions README-sudocmdgroup.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -116,9 +116,6 @@ Example playbook to make sure sudocmdgroup is absent:
Variables
=========

ipasudocmdgroup
-------

Variable | Description | Required
-------- | ----------- | --------
`ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no
Expand Down
3 changes: 0 additions & 3 deletions README-sudorule.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -113,9 +113,6 @@ Example playbook to make sure Sudo Rule is absent:
Variables
=========
ipasudorule
---------------
Variable | Description | Required
-------- | ----------- | --------
`ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no
Expand Down
3 changes: 0 additions & 3 deletions README-trust.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -94,9 +94,6 @@ This will only delete the ipa-side of the trust and it does NOT delete the id-ra
Variables
=========
ipatrust
-------
Variable | Description | Required
-------- | ----------- | --------
`ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no
Expand Down
6 changes: 0 additions & 6 deletions README-user.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -356,9 +356,6 @@ Example playbook to ensure users are absent:
Variables
=========

ipauser
-------

**General Variables:**

Variable | Description | Required
Expand Down Expand Up @@ -432,9 +429,6 @@ Variable | Description | Required
Return Values
=============

ipauser
-------

There are only return values if one or more random passwords have been generated.

Variable | Description | Returned When
Expand Down
6 changes: 0 additions & 6 deletions README-vault.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -210,9 +210,6 @@ Example playbook to make sure vault is absent:
Variables
=========

ipavault
-------

Variable | Description | Required
-------- | ----------- | --------
`ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no
Expand Down Expand Up @@ -250,9 +247,6 @@ Variable | Description | Required
Return Values
=============

ipavault
--------

There is only a return value if `state` is `retrieved`.

Variable | Description | Returned When
Expand Down
3 changes: 0 additions & 3 deletions utils/templates/README-module+member.md.in
View file
Original file line number Diff line number Diff line change
Expand Up @@ -112,9 +112,6 @@ MORE EXAMPLE PLAYBOOKS HERE
Variables
---------

ipa$name
-------

Variable | Description | Required
-------- | ----------- | --------
`ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no
Expand Down
3 changes: 0 additions & 3 deletions utils/templates/README-module.md.in
View file
Original file line number Diff line number Diff line change
Expand Up @@ -77,9 +77,6 @@ MORE EXAMPLE PLAYBOOKS HERE
Variables
---------

ipa$name
-------

Variable | Description | Required
-------- | ----------- | --------
`ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no
Expand Down

0 comments on commit 65937ed

Please sign in to comment.