mirror of
https://github.com/ansible-collections/community.general.git
synced 2026-05-06 21:32:49 +00:00
Add 'exists' to win_stat return docs (#25146)
* 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:
@@ -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
|
||||
|
||||
Reference in New Issue
Block a user