From 8816ebb3f848d8eacca20f8f7167f118c52f8f02 Mon Sep 17 00:00:00 2001 From: Matt Martz Date: Thu, 19 Jun 2014 15:37:58 -0500 Subject: [PATCH] Add documentation for win_user module --- library/windows/win_user | 68 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 68 insertions(+) create mode 100644 library/windows/win_user diff --git a/library/windows/win_user b/library/windows/win_user new file mode 100644 index 00000000000..c161f8f04fd --- /dev/null +++ b/library/windows/win_user @@ -0,0 +1,68 @@ +#!/usr/bin/python +# -*- coding: utf-8 -*- + +# (c) 2014, Matt Martz , 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 . + +# 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 +'''