mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-25 03:41:25 -07:00
eb1214baad
Changes to the metadata format were approved here: https://github.com/ansible/proposals/issues/54 * Update documentation to the new metadata format * Changes to metadata-tool to account for new metadata * Add GPL license header * Add upgrade subcommand to upgrade metadata version * Change default metadata to the new format * Fix exclusion of non-modules from the metadata report * Fix ansible-doc for new module metadata * Exclude metadata version from ansible-doc output * Fix website docs generation for the new metadata * Update metadata schema in valiate-modules test * Update the metadata in all modules to the new version
71 lines
1.7 KiB
Python
71 lines
1.7 KiB
Python
#!/usr/bin/python
|
|
# -*- coding: utf-8 -*-
|
|
|
|
# Copyright 2015, Hans-Joachim Kliemeck <git@kliemeck.de>
|
|
#
|
|
# 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
|
|
|
|
ANSIBLE_METADATA = {'metadata_version': '1.0',
|
|
'status': ['preview'],
|
|
'supported_by': 'core'}
|
|
|
|
|
|
DOCUMENTATION = r'''
|
|
---
|
|
module: win_owner
|
|
version_added: "2.1"
|
|
short_description: Set owner
|
|
description:
|
|
- Set owner of files or directories
|
|
options:
|
|
path:
|
|
description:
|
|
- Path to be used for changing owner
|
|
required: true
|
|
user:
|
|
description:
|
|
- Name to be used for changing owner
|
|
required: true
|
|
recurse:
|
|
description:
|
|
- Indicates if the owner should be changed recursively
|
|
choices:
|
|
- no
|
|
- yes
|
|
default: no
|
|
author: Hans-Joachim Kliemeck (@h0nIg)
|
|
'''
|
|
|
|
EXAMPLES = r'''
|
|
- name: Change owner of Path
|
|
win_owner:
|
|
path: C:\apache
|
|
user: apache
|
|
recurse: True
|
|
|
|
- name: Set the owner of root directory
|
|
win_owner:
|
|
path: C:\apache
|
|
user: SYSTEM
|
|
recurse: False
|
|
'''
|
|
|
|
RETURN = r'''
|
|
|
|
'''
|