mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-10-03 23:14:02 -07:00
[PR #10420/14f13daa backport][stable-11] doc style adjustments: modules [jk]* (#10425)
Some checks are pending
EOL CI / EOL Sanity (Ⓐ2.16) (push) Waiting to run
EOL CI / EOL Units (Ⓐ2.16+py2.7) (push) Waiting to run
EOL CI / EOL Units (Ⓐ2.16+py3.11) (push) Waiting to run
EOL CI / EOL Units (Ⓐ2.16+py3.6) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.16+alpine3+py:azp/posix/1/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.16+alpine3+py:azp/posix/2/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.16+alpine3+py:azp/posix/3/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.16+fedora38+py:azp/posix/1/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.16+fedora38+py:azp/posix/2/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.16+fedora38+py:azp/posix/3/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.16+opensuse15+py:azp/posix/1/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.16+opensuse15+py:azp/posix/2/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.16+opensuse15+py:azp/posix/3/) (push) Waiting to run
nox / Run extra sanity tests (push) Waiting to run
Some checks are pending
EOL CI / EOL Sanity (Ⓐ2.16) (push) Waiting to run
EOL CI / EOL Units (Ⓐ2.16+py2.7) (push) Waiting to run
EOL CI / EOL Units (Ⓐ2.16+py3.11) (push) Waiting to run
EOL CI / EOL Units (Ⓐ2.16+py3.6) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.16+alpine3+py:azp/posix/1/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.16+alpine3+py:azp/posix/2/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.16+alpine3+py:azp/posix/3/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.16+fedora38+py:azp/posix/1/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.16+fedora38+py:azp/posix/2/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.16+fedora38+py:azp/posix/3/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.16+opensuse15+py:azp/posix/1/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.16+opensuse15+py:azp/posix/2/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.16+opensuse15+py:azp/posix/3/) (push) Waiting to run
nox / Run extra sanity tests (push) Waiting to run
doc style adjustments: modules [jk]* (#10420)
* doc style adjustments: modules j*
* doc style adjustments: modules k*
* Apply suggestions from code review
* Update plugins/modules/keycloak_realm_key.py
---------
(cherry picked from commit 14f13daa99
)
Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
Co-authored-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
parent
e733b486b8
commit
4999521c11
37 changed files with 311 additions and 217 deletions
|
@ -30,7 +30,7 @@ options:
|
|||
principal:
|
||||
description:
|
||||
- The principal name.
|
||||
- If not set, the user running this module will be used.
|
||||
- If not set, the user running this module is used.
|
||||
type: str
|
||||
state:
|
||||
description:
|
||||
|
@ -50,17 +50,17 @@ options:
|
|||
- Use O(cache_name) as the ticket cache name and location.
|
||||
- If this option is not used, the default cache name and location are used.
|
||||
- The default credentials cache may vary between systems.
|
||||
- If not set the the value of E(KRB5CCNAME) environment variable will be used instead, its value is used to name the
|
||||
default ticket cache.
|
||||
- If not set the the value of E(KRB5CCNAME) environment variable is used instead, its value is used to name the default
|
||||
ticket cache.
|
||||
type: str
|
||||
lifetime:
|
||||
description:
|
||||
- Requests a ticket with the lifetime, if the O(lifetime) is not specified, the default ticket lifetime is used.
|
||||
- Specifying a ticket lifetime longer than the maximum ticket lifetime (configured by each site) will not override the
|
||||
- Specifying a ticket lifetime longer than the maximum ticket lifetime (configured by each site) does not override the
|
||||
configured maximum ticket lifetime.
|
||||
- 'The value for O(lifetime) must be followed by one of the following suffixes: V(s) - seconds, V(m) - minutes, V(h)
|
||||
- hours, V(d) - days.'
|
||||
- You cannot mix units; a value of V(3h30m) will result in an error.
|
||||
- You cannot mix units; a value of V(3h30m) results in an error.
|
||||
- See U(https://web.mit.edu/kerberos/krb5-1.12/doc/basic/date_format.html) for reference.
|
||||
type: str
|
||||
start_time:
|
||||
|
@ -78,7 +78,7 @@ options:
|
|||
- Requests renewable tickets, with a total lifetime equal to O(renewable).
|
||||
- 'The value for O(renewable) must be followed by one of the following delimiters: V(s) - seconds, V(m) - minutes, V(h)
|
||||
- hours, V(d) - days.'
|
||||
- You cannot mix units; a value of V(3h30m) will result in an error.
|
||||
- You cannot mix units; a value of V(3h30m) results in an error.
|
||||
- See U(https://web.mit.edu/kerberos/krb5-1.12/doc/basic/date_format.html) for reference.
|
||||
type: str
|
||||
forwardable:
|
||||
|
@ -119,7 +119,7 @@ options:
|
|||
keytab:
|
||||
description:
|
||||
- Requests a ticket, obtained from a key in the local host's keytab.
|
||||
- If O(keytab_path) is not specified will try to use default client keytab path (C(-i) option).
|
||||
- If O(keytab_path) is not specified it tries to use default client keytab path (C(-i) option).
|
||||
type: bool
|
||||
keytab_path:
|
||||
description:
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue