win_hostname - Manages local Windows computer name.

New in version 2.6.

Synopsis

Parameters

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

Examples

- name: Change the hostname to sample-hostname
  win_hostname:
    name: sample-hostname
  register: res

- name: Reboot
  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
str
always
The original hostname that was set before it was changed

Sample:
old_hostname
reboot_required
bool
always
Whether a reboot is required to complete the hostname change

Sample:
True


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

  • Ripon Banik (@riponbanik)

Hint

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