ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-06-09 01:39:10 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

Use semantic markup (modules h-j) (#6677)

Browse source 
* Use semantic markup.

* Use 'ignore:' until a new version of antsibull-docs is released.

* 'ignore:' is no longer needed.

* E() now works better.
This commit is contained in:
Felix Fontein 2023-06-15 15:47:00 +02:00 • committed by GitHub
parent 2ed82e0318
commit 3e0d84bdda
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
30 changed files with 202 additions and 202 deletions
Download patch file Download diff file Expand all files Collapse all files

26
plugins/modules/homectl.py
View file

@ -37,7 +37,7 @@ options:
- Homed requires this value to be in cleartext on user creation and updating a user.
- The module takes the password and generates a password hash in SHA-512 with 10000 rounds of salt generation using crypt.
- See U(https://systemd.io/USER_RECORD/).
- This is required for I(state=present). When an existing user is updated this is checked against the stored hash in homed.
- This is required for O(state=present). When an existing user is updated this is checked against the stored hash in homed.
type: str
state:
description:
@ -55,11 +55,11 @@ options:
disksize:
description:
- The intended home directory disk space.
- Human readable value such as C(10G), C(10M), or C(10B).
- Human readable value such as V(10G), V(10M), or V(10B).
type: str
resize:
description:
- When used with I(disksize) this will attempt to resize the home directory immediately.
- When used with O(disksize) this will attempt to resize the home directory immediately.
default: false
type: bool
realname:
@ -90,7 +90,7 @@ options:
description:
- Path to use as home directory for the user.
- This is the directory the user's home directory is mounted to while the user is logged in.
- This is not where the user's data is actually stored, see I(imagepath) for that.
- This is not where the user's data is actually stored, see O(imagepath) for that.
- Only used when a user is first created.
type: path
imagepath:
@ -102,25 +102,25 @@ options:
uid:
description:
- Sets the UID of the user.
- If using I(gid) homed requires the value to be the same.
- If using O(gid) homed requires the value to be the same.
- Only used when a user is first created.
type: int
gid:
description:
- Sets the gid of the user.
- If using I(uid) homed requires the value to be the same.
- If using O(uid) homed requires the value to be the same.
- Only used when a user is first created.
type: int
mountopts:
description:
- String separated by comma each indicating mount options for a users home directory.
- Valid options are C(nosuid), C(nodev) or C(noexec).
- Homed by default uses C(nodev) and C(nosuid) while C(noexec) is off.
- Valid options are V(nosuid), V(nodev) or V(noexec).
- Homed by default uses V(nodev) and V(nosuid) while V(noexec) is off.
type: str
umask:
description:
- Sets the umask for the user's login sessions
- Value from C(0000) to C(0777).
- Value from V(0000) to V(0777).
type: int
memberof:
description:
@ -132,13 +132,13 @@ options:
description:
- The absolute path to the skeleton directory to populate a new home directory from.
- This is only used when a home directory is first created.
- If not specified homed by default uses C(/etc/skel).
- If not specified homed by default uses V(/etc/skel).
aliases: [ 'skel' ]
type: path
shell:
description:
- Shell binary to use for terminal logins of given user.
- If not specified homed by default uses C(/bin/bash).
- If not specified homed by default uses V(/bin/bash).
type: str
environment:
description:
@ -151,7 +151,7 @@ options:
timezone:
description:
- Preferred timezone to use for the user.
- Should be a tzdata compatible location string such as C(America/New_York).
- Should be a tzdata compatible location string such as V(America/New_York).
type: str
locked:
description:
@ -160,7 +160,7 @@ options:
language:
description:
- The preferred language/locale for the user.
- This should be in a format compatible with the C($LANG) environment variable.
- This should be in a format compatible with the E(LANG) environment variable.
type: str
passwordhint:
description: