mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
52 lines
1.4 KiB
Text
52 lines
1.4 KiB
Text
|
#!/usr/bin/python
|
||
|
# This file is part of Ansible
|
||
|
#
|
||
|
# Ansible is free software: you can redistribute it and/or modify
|
||
|
# it under the terms of the GNU General Public License as published by
|
||
|
# the Free Software Foundation, either version 3 of the License, or
|
||
|
# (at your option) any later version.
|
||
|
#
|
||
|
# Ansible is distributed in the hope that it will be useful,
|
||
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||
|
# GNU General Public License for more details.
|
||
|
#
|
||
|
# You should have received a copy of the GNU General Public License
|
||
|
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
||
|
|
||
|
# this is a windows documentation stub, actual code lives in the .ps1
|
||
|
# file of the same name
|
||
|
|
||
|
DOCUMENTATION = '''
|
||
|
---
|
||
|
module: win_stat
|
||
|
version_added: "1.7"
|
||
|
short_description: returns information about a Windows file
|
||
|
description:
|
||
|
- Returns information about a Windows file
|
||
|
options:
|
||
|
path:
|
||
|
description:
|
||
|
- The full path of the file/object to get the facts of
|
||
|
required: true
|
||
|
default: null
|
||
|
aliases: []
|
||
|
get_md5:
|
||
|
description:
|
||
|
- Whether to return the md5 sum of the file
|
||
|
required: false
|
||
|
default: yes
|
||
|
aliases: []
|
||
|
author: Chris Church
|
||
|
'''
|
||
|
|
||
|
EXAMPLES = '''
|
||
|
# Obtain information about a file
|
||
|
|
||
|
- win_stat: path=C:\foo.ini
|
||
|
register: file_info
|
||
|
|
||
|
- debug: var=file_info
|
||
|
'''
|
||
|
|