ansible.windows.win_hostname – Manages local Windows computer name

Note

This plugin is part of the ansible.windows collection (version 1.4.0).

To install it use: ansible-galaxy collection install ansible.windows.

To use it in a playbook, specify: ansible.windows.win_hostname.

Synopsis

• Manages local Windows computer name.

• A reboot is required for the computer name to take effect.

Parameters

Parameter	Choices/Defaults	Comments
name string / required		The hostname to set for the computer.

See Also

See also

ansible.windows.win_dns_client

The official documentation on the ansible.windows.win_dns_client module.

Examples

- 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

Return Values

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

Authors

• Ripon Banik (@riponbanik)