ansible.builtin.hostname – Manage hostname
Note
This module is part of ansible-core
and included in all Ansible
installations. In most cases, you can use the short
module name
hostname
even without specifying the collections:
keyword.
However, we recommend you use the FQCN for easy linking to the
module documentation and to avoid conflicting with other collections that may have
the same module name.
New in version 1.4: of ansible.builtin
Synopsis
Set system’s hostname. Supports most OSs/Distributions including those using
systemd
.Windows, HP-UX, and AIX are not currently supported.
Parameters
Parameter |
Comments |
---|---|
Name of the host. If the value is a fully qualified domain name that does not resolve from the given host, this will cause the module to hang for a few seconds while waiting for the name resolution attempt to timeout. |
|
Which strategy to use to update the hostname. If not set we try to autodetect, but this can be problematic, particularly with containers as they can present misleading information. Note that ‘systemd’ should be specified for RHEL/EL/CentOS 7+. Older distributions should use ‘redhat’. Choices:
|
Notes
Note
This module does NOT modify
/etc/hosts
. You need to modify it yourself using other modules such as ansible.builtin.template or ansible.builtin.replace.On macOS, this module uses
scutil
to setHostName
,ComputerName
, andLocalHostName
. SinceLocalHostName
cannot contain spaces or most special characters, this module will replace characters when settingLocalHostName
.Supports
check_mode
.