ansible.builtin.hostname 模块 – 管理主机名

注意

此模块是 ansible-core 的一部分，包含在所有 Ansible 安装中。在大多数情况下，您甚至可以在不指定 collections 关键字 的情况下使用简短的模块名称 hostname。但是，我们建议您使用 完全限定的集合名称 (FQCN) ansible.builtin.hostname，以便轻松链接到模块文档并避免与可能具有相同模块名称的其他集合发生冲突。

摘要

  • 设置系统的 hostname。支持大多数操作系统/发行版，包括使用 systemd 的操作系统/发行版。

  • 目前不支持 Windows、HP-UX 和 AIX。

要求

以下要求是在执行此模块的主机上需要的。

  • 主机名

参数

参数

注释

名称

字符串 / 必需

主机名。

如果该值为一个完全限定的域名，而该域名无法从给定主机解析，则会导致该模块挂起几秒钟，等待名称解析尝试超时。

使用

字符串

在 Ansible 2.9 中添加

要用于更新主机名的策略。

如果没有设置，我们将尝试自动检测，但这可能会很麻烦，特别是对于容器，因为它们可能会显示误导性的信息。

请注意，对于 RHEL/EL/CentOS 7+ 应指定 systemd。较旧的发行版应该使用 redhat。

选项

  • "alpine"

  • "debian"

  • "freebsd"

  • "generic"

  • "macos"

  • "macosx"

  • "darwin"

  • "openbsd"

  • "openrc"

  • "redhat"

  • "sles"

  • "solaris"

  • "systemd"

属性

属性

支持

描述

check_mode

支持：完全支持

可以在 check_mode 中运行并返回更改状态预测，而不会修改目标，如果不受支持，则操作将被跳过。

diff_mode

支持：完全支持

将在 diff 模式下返回有关更改内容（或可能需要更改的内容，在 check_mode 中）的详细信息。

facts

支持：完全支持

操作返回一个 ansible_facts 字典，该字典将更新现有的主机 facts。

平台

平台： posix

可以对其执行操作的目标操作系统/系列。

备注

注意

  • 此模块**不会**修改 /etc/hosts。您需要使用其他模块（如 ansible.builtin.template 或 ansible.builtin.replace）自行修改。

  • 在 macOS 上，此模块使用 scutil 来设置 HostName、ComputerName 和 LocalHostName。由于 LocalHostName 不能包含空格或大多数特殊字符，因此此模块将在设置 LocalHostName 时替换字符。

示例

- name: Set a hostname
  ansible.builtin.hostname:
    name: web01

- name: Set a hostname specifying strategy
  ansible.builtin.hostname:
    name: web01
    use: systemd

作者

  • Adrian Likins (@alikins)

  • Hideki Saito (@saito-hideki)