Documentation

hostname - Manage hostname

New in version 1.4.

Synopsis

  • Set system’s hostname, supports most OSs/Distributions, including those using systemd.
  • Note, this module does NOT modify /etc/hosts. You need to modify it yourself using other modules like template or replace.
  • Windows, HP-UX and AIX are not currently supported.

Requirements

The below requirements are needed on the host that executes this module.

  • hostname

Parameters

Parameter Choices/Defaults Comments
name
required
Name of the host

Examples

- hostname:
    name: web01

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

  • Adrian Likins (@alikins)
  • Hideki Saito (@saito-hideki)

Hint

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