f735fd672a
* Copy in incidental windows tests. * Update incidental test aliases. * Add support plugins. * Update target references. * Update sanity ignores. * Update integration-aliases test. * Add to CI.
70 lines
2.1 KiB
Python
70 lines
2.1 KiB
Python
#!/usr/bin/python
|
|
# -*- coding: utf-8 -*-
|
|
|
|
# Copyright: (c) 2015, Jon Hawkesworth (@jhawkesworth) <figs@unity.demon.co.uk>
|
|
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
|
|
ANSIBLE_METADATA = {'metadata_version': '1.1',
|
|
'status': ['stableinterface'],
|
|
'supported_by': 'core'}
|
|
|
|
DOCUMENTATION = r'''
|
|
---
|
|
module: win_file
|
|
version_added: "1.9.2"
|
|
short_description: Creates, touches or removes files or directories
|
|
description:
|
|
- Creates (empty) files, updates file modification stamps of existing files,
|
|
and can create or remove directories.
|
|
- Unlike M(file), does not modify ownership, permissions or manipulate links.
|
|
- For non-Windows targets, use the M(file) module instead.
|
|
options:
|
|
path:
|
|
description:
|
|
- Path to the file being managed.
|
|
required: yes
|
|
type: path
|
|
aliases: [ dest, name ]
|
|
state:
|
|
description:
|
|
- If C(directory), all immediate subdirectories will be created if they
|
|
do not exist.
|
|
- If C(file), the file will NOT be created if it does not exist, see the M(copy)
|
|
or M(template) module if you want that behavior.
|
|
- If C(absent), directories will be recursively deleted, and files will be removed.
|
|
- If C(touch), an empty file will be created if the C(path) does not
|
|
exist, while an existing file or directory will receive updated file access and
|
|
modification times (similar to the way C(touch) works from the command line).
|
|
type: str
|
|
choices: [ absent, directory, file, touch ]
|
|
seealso:
|
|
- module: file
|
|
- module: win_acl
|
|
- module: win_acl_inheritance
|
|
- module: win_owner
|
|
- module: win_stat
|
|
author:
|
|
- Jon Hawkesworth (@jhawkesworth)
|
|
'''
|
|
|
|
EXAMPLES = r'''
|
|
- name: Touch a file (creates if not present, updates modification time if present)
|
|
win_file:
|
|
path: C:\Temp\foo.conf
|
|
state: touch
|
|
|
|
- name: Remove a file, if present
|
|
win_file:
|
|
path: C:\Temp\foo.conf
|
|
state: absent
|
|
|
|
- name: Create directory structure
|
|
win_file:
|
|
path: C:\Temp\folder\subfolder
|
|
state: directory
|
|
|
|
- name: Remove directory structure
|
|
win_file:
|
|
path: C:\Temp
|
|
state: absent
|
|
'''
|