win_hostname - Manages local Windows computer name.
New in version 2.6.
Synopsis
- Manages local Windows computer name.
- A reboot is required for the computer name to take effect.
Parameters
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| name
required
|
The hostname to set for the computer.
|
Examples
- name: Change the hostname to new_hostname
win_hostname:
name: new_hostname
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.
© 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_hostname_module.html