W3cubDocs

/Ansible

ansible.windows.win_hostname module – Manages local Windows computer name

Note

This module is part of the ansible.windows collection (version 2.8.0).

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.

Synopsis

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

Parameters

Parameter

Comments

name

string / required

The hostname to set for the computer.

See Also

See also

ansible.windows.win_dns_client

Configures DNS lookup on Windows hosts.

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

Description

old_name

string

The original hostname that was set before it was changed.

Returned: always

Sample: "old_hostname"

reboot_required

boolean

Whether a reboot is required to complete the hostname change.

Returned: always

Sample: true

Authors

  • Ripon Banik (@riponbanik)

© 2012–2018 Michael DeHaan
© 2018–2025 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