ansible/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
Code Releases Activity

Add 'exists' to win_stat return docs (#25146)

Browse source 
* Add 'exists' to win_stat return docs

Fix 25107 by adding documentation for 'exists' return value in win_stat module

* Added missing filename attribute to RETURN

Also made the path and filename sample values consistent.
This commit is contained in:
jhawkesworth 2017-06-03 09:11:09 +01:00 committed by GitHub
parent 3e02b19b98
commit de8c7c22d2
1 changed files with 12 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
lib/ansible/modules/windows/win_stat.py
View file

@ -130,11 +130,21 @@ stat:
returned: success, path exists
type: float
sample: 1477984205.15
exists:
description: if the path exists or not
returned: success
type: boolean
sample: True
extension:
description: the extension of the file at path
returned: success, path exists, path is a file
type: string
sample: ".ps1"
filename:
description: the name of the file (without path)
returned: success, path exists, path is a file
type: string
sammple: foo.ini
isarchive:
description: if the path is ready for archiving or not
returned: success, path exists
@ -192,9 +202,9 @@ stat:
sample: BUILTIN\Administrators
path:
description: the full absolute path to the file
returned: success, path exists
returned: success, path exists, file exists
type: string
sample: BUILTIN\Administrators
sample: C:\foo.ini
sharename:
description: the name of share if folder is shared
returned: success, path exists, file is a directory and isshared == True