mirror of https://github.com/ansible/ansible.git
Add documentation for win_user module
parent
53497d90da
commit
0ac996fbaa
@ -0,0 +1,68 @@
|
||||
#!/usr/bin/python
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
# (c) 2014, Matt Martz <matt@sivel.net>, and others
|
||||
#
|
||||
# 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_user
|
||||
version_added: "1.7"
|
||||
short_description: Manages local Windows user accounts
|
||||
description:
|
||||
- Manages local Windows user accounts
|
||||
options:
|
||||
name:
|
||||
description:
|
||||
- Username of the user to manage
|
||||
required: true
|
||||
default: null
|
||||
aliases: []
|
||||
password:
|
||||
description:
|
||||
- Password for the user
|
||||
required: true
|
||||
default: null
|
||||
aliases: []
|
||||
state:
|
||||
description:
|
||||
- Whether to create or delete a user
|
||||
required: false
|
||||
choices:
|
||||
- present
|
||||
- absent
|
||||
default: present
|
||||
aliases: []
|
||||
author: Paul Durivage
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
# Playbook example
|
||||
---
|
||||
- name: Add a user
|
||||
hosts: all
|
||||
gather_facts: false
|
||||
tasks:
|
||||
- name: Add User
|
||||
win_user:
|
||||
name: ansible
|
||||
password: "@ns1bl3"
|
||||
state: present
|
||||
'''
|
Loading…
Reference in New Issue