使用 Ansible 命令行工具

注意：

让开源更具包容性，Making Open Source More Inclusive

红帽致力于找到和替换掉代码、文档和网络属性中有问题的语言。我们将从以下四个术语开始：master、slave、blacklist 和 whitelist。如果发现我们遗漏的术语，请提交问题或拉取请求。更多详情，请参阅首席技术官 Chris Wright 的致辞。

欢迎阅读 Ansible 命令行工具使用指南。Ansible 提供了一些临时命令及若干实用工具，用于执行各种操作和自动化任务。

临时命令简介

Ansible 临时命令使用 /usr/bin/ansible 命令行工具，在一或多个托管节点上自动执行单个任务。那么为什么要了解临时命令呢？因为临时命令展示了 Ansible 的简单性和强大功能。咱们在这里学到的概念，将直接移植到 playbook 语言。在阅读和执行这些示例之前，请先阅读 “如何构建仓库”。

为何要使用临时命令？

对于那些很少重复的任务来说，临时命令非常有用。例如，如果咱们想在圣诞节假期，关闭实验室里所有机器的电源，咱们就可以在 Ansible 中，执行个快速单行命令，而不用编写个 playbook。临时命令看起来像这样：

ansible [pattern] -m [module] -a "[module options]"

其中的 -a 选项，通过 key=value 语法，或为获得更复杂的选项结构，而以 { 开头、} 结尾的 JSON 字符串接受选项。你可以在其他页面了解更多关于模式和模组的信息。

临时任务用例

临时任务可用于重启服务器、复制文件、管理软件包与用户等。咱们可在某项临时任务中，使用任何的 Ansible 模组。与 playbook 一样，临时任务用到声明式模型，a declarative model，计算并执行达到指定最终状态的所需操作。通过在开始前检查当前状态，并除非在当前状态与指定最终状态不同时执行，从而实现某种形式的幂等性。

ansible 命令行实用工具的默认模组，是 ansible.builtin.command 模组。咱们可使用临时任务，调用该命令模组，重启亚特兰大的所有 web 服务器，每次 10 台。在 Ansible 可执行此任务前，必须将亚特兰大的所有服务器，都列在仓库中名为 [atlanta] 的组中，且该组中的每台机器都必须有可用的 SSH 凭据。重启 [atlanta] 组中的所有服务器：

ansible atlanta -a "/sbin/reboot"

默认情况下，Ansible 只使用五个并发进程。如果主机数量超过了这个分叉数，the fork count，设定值，就会增加 Ansible 与主机通信的时间。以 10 个并行分叉，重启 [atlanta] 服务器：

ansible atlanta -a "/sbin/reboot" -f 10

/usr/bin/ansible 将默认以咱们的用户账户运行。要以其他用户身份连接：

ansible atlanta -a "/sbin/reboot" -f 10 -u username

重启可能需要权限提升。咱们可以使用 become 关键字，以 username 连接服务器并以 root 用户身份运行命令：

ansible atlanta -a "/sbin/reboot" -f 10 -u username --become [--ask-become-pass]

如果添加了 --ask-become-pass 或 -K，Ansible 就会提示咱们，输入用于权限提升（sudo/su/pfexec/doas等）的密码。

注意：

命令模组不支持管道和重定向等扩展 shell 语法（尽管 shell 变量始终有效）。如果咱们的命令需要 shell 特定的语法，就要使用 shell 模组。

到目前为止我们的所有示例，都使用了默认的 command 模组。要使用其他模组，可通过 -m 来指定模组名称。例如，要使用 ansible.builtin.shell 模组：

ansible raleigh -m ansible.builtin.shell -a 'echo $TERM'

使用 Ansible 临时 CLI（与 playbook 相反）运行任何命令时，都要特别注意 shell 的引号规则，以便本地 shell 保留变量并将其传递给 Ansible。例如，如果在上例中使用双引号而非单引号，就会在咱们所在的服务器上，对变量进行求值。

管理文件

临时任务可利用 Ansible 与 SCP 的强大功能，将许多文件，并行传输到多台机器上。将文件直接传输到 [atlanta] 组中所有服务器：

ansible atlanta -m ansible.builtin.copy -a "src=/etc/hosts dest=/tmp/hosts"

如果计划重复执行类似任务，就要 playbook 中，使用 ansible.builtin.template 模组。

ansible.builtin.file 模组，则允许更改文件的所有权与权限。这些选项也可以直接传递给 copy 模组：

ansible webservers -m ansible.builtin.file -a "dest=/srv/foo/a.txt mode=600"
ansible webservers -m ansible.builtin.file -a "dest=/srv/foo/b.txt mode=600 owner=mdehaan group=mdehaan"

file 模组还可以创建目录，类似于 mkdir -p：

ansible webservers -m ansible.builtin.file -a "dest=/path/to/c mode=755 owner=mdehaan group=mdehaan state=directory"

以及删除目录（递归地）与删除文件：

ansible webservers -m ansible.builtin.file -a "dest=/path/to/c state=absent"

管理软件包

咱们还可以使用软件包管理模组（如 yum），在托管节点上安装、更新或移除软件包。软件包管理模组支持安装、移除及一般管理软件包等常用功能。包管理器的某些特定功能，可能不会出现在 Ansible 模组中，因为他们不是通用包管理的一部分。

要确保某个软件包已被安装而不进行更新：

ansible webservers -m ansible.builtin.yum -a "name=nginx state=present"

译注：运行以下命令，使用针对 Debian 12 的模组 ansible.builtin.apt，在远端 Debian 主机上安装 Nginx 也是成功的。

ansible webservers -m ansible.builtin.apt -a "name=nginx state=present" --become -K

要确保安装了特定版本的某个软件包：

$ ansible webservers -m ansible.builtin.yum -a "name=nginx-1.20.1 state=present"

确保软件包是最新版本：

$ ansible webservers -m ansible.builtin.yum -a "name=nginx state=latest"

确保未安装（移除）某个软件包：

$ ansible webservers -m ansible.builtin.yum -a "name=nginx state=absent"

译注：Ansible 返回的输出如下：

nginx_39 | CHANGED => {
    "ansible_facts": {
        "discovered_interpreter_python": "/usr/bin/python3.9"
    },
    "changed": true,
    "msg": "",
    "rc": 0,
    "results": [
        "Removed: nginx-2:1.20.1-20.el9.alma.1.x86_64"
    ]
}

Ansible 有着在许多平台下，用于管理软件包的模组。如果没有用于咱们软件包管理器的模组，咱们可以使用 command 模组安装软件包，或者为咱们的软件包管理器创建个模组。

管理用户与用户组

咱们可以通过临时任务，在托管节点上创建、管理和删除用户账户：

ansible all -m ansible.builtin.user -a "name=foo password=<encrypted password here>"

ansible all -m ansible.builtin.user -a "name=foo state=absent"

请参阅 ansible.builtin.user 模组文档，了解所有可用选项的详情，包括如何操作组和组成员。

管理服务

确保所有 webservers 上启动了某项服务：

ansible webservers -m ansible.builtin.service -a "name=nginx state=started"

或者，重新启动所有 webservers 上的某项服务：

ansible webservers -m ansible.builtin.service -a "name=nginx state=restarted"

确保某项服务已停止：

ansible webservers -m ansible.builtin.service -a "name=nginx state=stopped"

收集事实

所谓事实，facts，表示所发现有关系统的一些变量。咱们可以使用事实，实现任务的有条件执行，也可以直接获取系统的一些信息。要查看所有事实：

ansible all -m ansible.builtin.setup

咱们也可以过滤此输出，而只显示某些事实，详情请查看 ansible.builtin.setup 模组文档。

检查模式

在检查模式下，Ansible 不会对远端系统做任何更改。Ansible 只打印出命令。他不会运行命令。

ansible all -m copy -a "content=foo dest=/root/bar.txt" -C

在上面的命令中启用检查模式（-C 或 --check），意味着 Ansible 不会在任何远端系统上，创建或更新 /root/bar.txt 文件。

模式与临时命令

有关所有可用选项的详细信息，包括如何在临时命令中使用模式加以限制，请参阅模式文档。

现在咱们已经了解了 Ansible 执行的基本要素，就可以学习使用 Ansible Playbooks，自动执行重复性任务了。

使用命令行工具

大多数用户都熟悉 ansible 和 ansible-playbook，但他们并不是 Ansible 提供的仅有实用工具。下面是 Ansible 实用工具的完整列表。每个页面都包含该实用程序的说明，和支持的参数列表。

注意：咱们不应针对相同目标，并行运行大多数 Ansible CLI 工具。

（End）

又一本 Ansible 教程