Docs4dev
Docs
ansible / 2.6 / modules / win_domain_computer_module.html

win_domain_computer - Manage computers in Active Directory

New in version 2.6.

Synopsis

  • Create, read, update and delete computers in Active Directory using a windows brigde computer to launch New-ADComputer, Get-ADComputer, Set-ADComputer, Remove-ADComputer and Move-ADObject powershell commands.

Parameters

Parameter Choices/Defaults Comments
description Default:
""
Specifies a description of the object. This parameter sets the value of the Description property for the object. The LDAP display name (ldapDisplayName) for this property is description.
dns_hostname
Specifies the fully qualified domain name (FQDN) of the computer. This parameter sets the DNSHostName property for a computer object. The LDAP display name for this property is dNSHostName. Required when state=present.
enabled
bool
    Choices:
  • no
  • yes ←
Specifies if an account is enabled. An enabled account requires a password. This parameter sets the Enabled property for an account object. This parameter also sets the ADS_UF_ACCOUNTDISABLE flag of the Active Directory User Account Control (UAC) attribute.
name
required
Specifies the name of the object. This parameter sets the Name property of the Active Directory object. The LDAP display name (ldapDisplayName) of this property is name.
ou
Specifies the X.500 path of the Organizational Unit (OU) or container where the new object is created. Required when state=present.
sam_account_name
Specifies the Security Account Manager (SAM) account name of the computer. It maximum is 256 characters, 15 is advised for older operating systems compatibility. The LDAP display name (ldapDisplayName) for this property is sAMAccountName. If ommitted the value is the same as name. Note. All computer SAMAccountNames needs to end with a $.
state
    Choices:
  • present ←
  • absent
Specified whether the computer should be present or absent in Active Directory.

Examples

- name: Add linux computer to Active Directory OU using a windows machine
  win_domain_computer:
    name: one_linux_server.my_org.local
    sam_account_name: linux_server
    dns_hostname: one_linux_server.my_org.local
    ou: "OU=servers,DC=my_org,DC=local"
    description: Example of linux server
    enabled: yes
    state: present
  delegate_to: my_windows_bridge.my_org.local

- name: Remove linux computer from Active Directory using a windows machine
  win_domain_computer:
    name: one_linux_server.my_org.local
    state: absent
  delegate_to: my_windows_bridge.my_org.local

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Author

  • Daniel Sánchez Fábregas (@Daniel-Sanchez-Fabregas)

Hint

If you notice any issues in this documentation you can edit this document to improve it.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/win_domain_computer_module.html