ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-08-22 14:01:42 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Convert to reduced list of known types (#50010)

Browse source
This commit is contained in:
Dag Wieers 2018-12-18 22:25:30 +01:00 • committed by Jordan Borean
commit 05c6ff79f9
908 changed files with 4822 additions and 4821 deletions
Download patch file Download diff file Expand all files Collapse all files

4
lib/ansible/modules/files/archive.py
View file

@ -107,7 +107,7 @@ state:
If 'compress', then the file source file is in the compressed state.
If 'archive', then the source file or paths are currently archived.
If 'incomplete', then an archive was created, but not all source paths were found.
type: string
type: str
returned: always
missing:
description: Any files that were missing from the source.
@ -119,7 +119,7 @@ archived:
returned: success
arcroot:
description: The archive root.
type: string
type: str
returned: always
expanded_paths:
description: The list of matching paths from paths argument.

18
lib/ansible/modules/files/copy.py
View file

@ -191,27 +191,27 @@ RETURN = r'''
dest:
description: Destination file/path
returned: success
type: string
type: str
sample: /path/to/file.txt
src:
description: Source file used for the copy on the target machine
returned: changed
type: string
type: str
sample: /home/httpd/.ansible/tmp/ansible-tmp-1423796390.97-147729857856000/source
md5sum:
description: MD5 checksum of the file after running copy
returned: when supported
type: string
type: str
sample: 2a5aeecc61dc98c4d780b14b330e3282
checksum:
description: SHA1 checksum of the file after running copy
returned: success
type: string
type: str
sample: 6e642bb8dd5c2e027bf21dd923337cbb4214f827
backup_file:
description: Name of backup file created
returned: changed and if backup=yes
type: string
type: str
sample: /path/to/file.txt.2015-02-12@22:09~
gid:
description: Group id of the file, after execution
@ -221,12 +221,12 @@ gid:
group:
description: Group of the file, after execution
returned: success
type: string
type: str
sample: httpd
owner:
description: Owner of the file, after execution
returned: success
type: string
type: str
sample: httpd
uid:
description: Owner id of the file, after execution
@ -236,7 +236,7 @@ uid:
mode:
description: Permissions of the target, after execution
returned: success
type: string
type: str
sample: 0644
size:
description: Size of the target, after execution
@ -246,7 +246,7 @@ size:
state:
description: State of the target, after execution
returned: success
type: string
type: str
sample: file
'''

4
lib/ansible/modules/files/find.py
View file

@ -191,12 +191,12 @@ files:
matched:
description: number of matches
returned: success
type: string
type: str
sample: 14
examined:
description: number of filesystem objects looked at
returned: success
type: string
type: str
sample: 34
'''

62
lib/ansible/modules/files/stat.py
View file

@ -144,12 +144,12 @@ stat:
exists:
description: if the destination path actually exists or not
returned: success
type: boolean
type: bool
sample: True
path:
description: The full path of the file/object to get the facts of
returned: success and if path exists
type: string
type: str
sample: '/path/to/file'
mode:
description: Unix permissions of the file in octal
@ -159,37 +159,37 @@ stat:
isdir:
description: Tells you if the path is a directory
returned: success, path exists and user can read stats
type: boolean
type: bool
sample: False
ischr:
description: Tells you if the path is a character device
returned: success, path exists and user can read stats
type: boolean
type: bool
sample: False
isblk:
description: Tells you if the path is a block device
returned: success, path exists and user can read stats
type: boolean
type: bool
sample: False
isreg:
description: Tells you if the path is a regular file
returned: success, path exists and user can read stats
type: boolean
type: bool
sample: True
isfifo:
description: Tells you if the path is a named pipe
returned: success, path exists and user can read stats
type: boolean
type: bool
sample: False
islnk:
description: Tells you if the path is a symbolic link
returned: success, path exists and user can read stats
type: boolean
type: bool
sample: False
issock:
description: Tells you if the path is a unix domain socket
returned: success, path exists and user can read stats
type: boolean
type: bool
sample: False
uid:
description: Numeric id representing the file owner
@ -239,67 +239,67 @@ stat:
wusr:
description: Tells you if the owner has write permission
returned: success, path exists and user can read stats
type: boolean
type: bool
sample: True
rusr:
description: Tells you if the owner has read permission
returned: success, path exists and user can read stats
type: boolean
type: bool
sample: True
xusr:
description: Tells you if the owner has execute permission
returned: success, path exists and user can read stats
type: boolean
type: bool
sample: True
wgrp:
description: Tells you if the owner's group has write permission
returned: success, path exists and user can read stats
type: boolean
type: bool
sample: False
rgrp:
description: Tells you if the owner's group has read permission
returned: success, path exists and user can read stats
type: boolean
type: bool
sample: True
xgrp:
description: Tells you if the owner's group has execute permission
returned: success, path exists and user can read stats
type: boolean
type: bool
sample: True
woth:
description: Tells you if others have write permission
returned: success, path exists and user can read stats
type: boolean
type: bool
sample: False
roth:
description: Tells you if others have read permission
returned: success, path exists and user can read stats
type: boolean
type: bool
sample: True
xoth:
description: Tells you if others have execute permission
returned: success, path exists and user can read stats
type: boolean
type: bool
sample: True
isuid:
description: Tells you if the invoking user's id matches the owner's id
returned: success, path exists and user can read stats
type: boolean
type: bool
sample: False
isgid:
description: Tells you if the invoking user's group id matches the owner's group id
returned: success, path exists and user can read stats
type: boolean
type: bool
sample: False
lnk_source:
description: Target of the symlink normalized for the remote filesystem
returned: success, path exists and user can read stats and the path is a symbolic link
type: string
type: str
sample: /home/foobar/21102015-1445431274-908472971
lnk_target:
description: Target of the symlink. Note that relative paths remain relative
returned: success, path exists and user can read stats and the path is a symbolic link
type: string
type: str
sample: ../foobar/21102015-1445431274-908472971
version_added: 2.4
md5:
@ -307,54 +307,54 @@ stat:
favor of the checksum return value
returned: success, path exists and user can read stats and path
supports hashing and md5 is supported
type: string
type: str
sample: f88fa92d8cf2eeecf4c0a50ccc96d0c0
checksum:
description: hash of the path
returned: success, path exists, user can read stats, path supports
hashing and supplied checksum algorithm is available
type: string
type: str
sample: 50ba294cdf28c0d5bcde25708df53346825a429f
pw_name:
description: User name of owner
returned: success, path exists and user can read stats and installed python supports it
type: string
type: str
sample: httpd
gr_name:
description: Group name of owner
returned: success, path exists and user can read stats and installed python supports it
type: string
type: str
sample: www-data
mimetype:
description: file magic data or mime-type
returned: success, path exists and user can read stats and
installed python supports it and the `mime` option was true, will
return 'unknown' on error.
type: string
type: str
sample: application/pdf; charset=binary
charset:
description: file character set or encoding
returned: success, path exists and user can read stats and
installed python supports it and the `mime` option was true, will
return 'unknown' on error.
type: string
type: str
sample: us-ascii
readable:
description: Tells you if the invoking user has the right to read the path
returned: success, path exists and user can read the path
type: boolean
type: bool
sample: False
version_added: 2.2
writeable:
description: Tells you if the invoking user has the right to write the path
returned: success, path exists and user can write the path
type: boolean
type: bool
sample: False
version_added: 2.2
executable:
description: Tells you if the invoking user has the execute the path
returned: success, path exists and user can execute the path
type: boolean
type: bool
sample: False
version_added: 2.2
attributes:

2
lib/ansible/modules/files/tempfile.py
View file

@ -70,7 +70,7 @@ RETURN = '''
path:
description: Path to created file or directory
returned: success
type: string
type: str
sample: "/tmp/ansible.bMlvdk"
'''

4
lib/ansible/modules/files/xml.py
View file

@ -252,11 +252,11 @@ matches:
returned: when parameter 'print_match' is set
msg:
description: A message related to the performed action(s).
type: string
type: str
returned: always
xmlstring:
description: An XML string of the resulting output.
type: string
type: str
returned: when parameter 'xmlstring' is set
'''