mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-10-04 07:24:00 -07:00
c0c26f83a8
* Change example syntax on nxos_feature module * Change example syntax on nxos_hsrp module * Change example syntax on nxos_igmp module * Change example syntax on nxos_interface module * Change example syntax on nxos_interface_ospf module * Change example syntax on nxos_ip_interface module * Change example syntax on nxos_ping module * Change example syntax on nxos_switchport module * Change example syntax on nxos_vlan module * Change example syntax on nxos_vrf module * Change example syntax on nxos_vrf_interface module * Change example syntax on nxos_vrrp module * Change example syntax on meta module * Change example syntax on set_fact module * Change example syntax on win_copy module * Change example syntax on win_file module * Change example syntax on win_get_url module Remove escaping of \ characeter in Windows paths since it's no longer required for single quoted or unquoted values when using multi-line YAML syntax. * Change example syntax on win_lineinfile module * Change example syntax on win_msi module * Change example syntax on win_stat module * Remove nxos_bgp example from nxos_igmp module * Mark examples as regexp to avoid syntax error * Cleanup win_copy.py examples * Cleanup win_file.py examples * Remove quotes in win_get_url.py examples * Cleanup quotes and languare in win_lineinfile.py * Cleanup examples in win_group.py * Cleanup examples in win_service.py * Don't use : in documentation because it breaks the YAML syntax check * Cleanup win_copy.py examples * Cleanup win_copy.py examples * Minor change to fix test failure * Use single quotes
61 lines
1.7 KiB
Python
61 lines
1.7 KiB
Python
#!/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; both forward and
|
|
back slashes are accepted.
|
|
required: true
|
|
default: null
|
|
aliases: []
|
|
get_md5:
|
|
description:
|
|
- Whether to return the checksum sum of the file. As of Ansible 1.9 this
|
|
is no longer a MD5, but a SHA1 instead.
|
|
required: false
|
|
default: yes
|
|
aliases: []
|
|
get_checksum:
|
|
description:
|
|
- Whether to return a checksum of the file
|
|
(only sha1 currently supported)
|
|
required: false
|
|
default: yes
|
|
version_added: "2.1"
|
|
author: "Chris Church (@cchurch)"
|
|
'''
|
|
|
|
EXAMPLES = '''
|
|
- name: Obtain information about a file
|
|
win_stat:
|
|
path: C:\foo.ini
|
|
register: file_info
|
|
|
|
- debug:
|
|
var: file_info
|
|
'''
|
|
|