Note
This plugin is part of the ansible.windows collection (version 1.7.3).
You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install ansible.windows.
To use it in a playbook, specify: ansible.windows.win_hostname.
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| name string / required | The hostname to set for the computer. |
See also
The official documentation on the ansible.windows.win_dns_client module.
- name: Change the hostname to sample-hostname
ansible.windows.win_hostname:
name: sample-hostname
register: res
- name: Reboot
ansible.windows.win_reboot:
when: res.reboot_required
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| old_name string | always | The original hostname that was set before it was changed. Sample: old_hostname |
| reboot_required boolean | always | Whether a reboot is required to complete the hostname change. Sample: True |
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/ansible/windows/win_hostname_module.html