mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
101 lines
3.3 KiB
Python
101 lines
3.3 KiB
Python
#!/usr/bin/python
|
|
# -*- coding: utf-8 -*-
|
|
|
|
# (c) 2017, Red Hat, Inc.
|
|
#
|
|
# 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/>.
|
|
|
|
|
|
ANSIBLE_METADATA = {'status': ['preview'],
|
|
'supported_by': 'core',
|
|
'version': '1.0'}
|
|
|
|
DOCUMENTATION='''
|
|
module: win_domain_membership
|
|
short_description: Manage domain/workgroup membership for a Windows host
|
|
version_added: 2.3
|
|
description:
|
|
- Manages domain membership or workgroup membership for a Windows host. Also supports hostname changes. This module may require
|
|
subsequent use of the M(win_reboot) action if changes are made.
|
|
options:
|
|
dns_domain_name:
|
|
description:
|
|
- when C(state) is C(domain), the DNS name of the domain to which the targeted Windows host should be joined
|
|
domain_admin_user:
|
|
description:
|
|
- username of a domain admin for the target domain (required to join or leave the domain)
|
|
required: true
|
|
domain_admin_password:
|
|
description:
|
|
- password for the specified C(domain_admin_user)
|
|
hostname:
|
|
description:
|
|
- the desired hostname for the Windows host
|
|
state:
|
|
description:
|
|
- whether the target host should be a member of a domain or workgroup
|
|
choices:
|
|
- domain
|
|
- workgroup
|
|
workgroup_name:
|
|
description:
|
|
- when C(state) is C(workgroup), the name of the workgroup that the Windows host should be in
|
|
author:
|
|
- Matt Davis (@nitzmahone)
|
|
'''
|
|
|
|
RETURN='''
|
|
reboot_required:
|
|
description: True if changes were made that require a reboot.
|
|
returned: always
|
|
type: boolean
|
|
sample: true
|
|
'''
|
|
|
|
EXAMPLES='''
|
|
|
|
# host should be a member of domain ansible.vagrant; module will ensure the hostname is mydomainclient
|
|
# and will use the passed credentials to join domain if necessary.
|
|
# Ansible connection should use local credentials if possible.
|
|
# If a reboot is required, the second task will trigger one and wait until the host is available.
|
|
- hosts: winclient
|
|
gather_facts: no
|
|
tasks:
|
|
- win_domain_membership:
|
|
dns_domain_name: ansible.vagrant
|
|
hostname: mydomainclient
|
|
domain_admin_user: testguy@ansible.vagrant
|
|
domain_admin_password: password123!
|
|
state: domain
|
|
register: domain_state
|
|
|
|
- win_reboot:
|
|
when: domain_state.reboot_required
|
|
|
|
|
|
|
|
# Host should be in workgroup mywg- module will use the passed credentials to clean-unjoin domain if possible.
|
|
# Ansible connection should use local credentials if possible.
|
|
# The domain admin credentials can be sourced from a vault-encrypted variable
|
|
- hosts: winclient
|
|
gather_facts: no
|
|
tasks:
|
|
- win_domain_membership:
|
|
workgroup_name: mywg
|
|
domain_admin_user: '{{ win_domain_admin_user }}'
|
|
domain_admin_password: '{{ win_domain_admin_password }}'
|
|
state: workgroup
|
|
'''
|