Ansible常用模块整理

到目前为止，ansible一共有3387个模块，但最常用的模块也就二三十个而已，针对特定业务只用十几个模块。

帮助文档：https://docs.ansible.com/ansible/latest/collections/index_module.html

Command 模块

功能：在远程主机执行命令，此为默认模块，可忽略 -m 选项

注意：此命令不支持 $VARNAME < > | ; & 等，可以用shell模块实现

注意：此模块不具有幂等性

范例：

ansible webservers -a 'chdir=/etc ls'

Shell 模块

功能：和command相似，用shell执行命令,支持各种符号,比如:*,$, >

注意：此模块不具有幂等性

范例：

ansible webservers -m shell -a 'echo $HOSTNAME'
ansible webservers -m shell -a 'echo hello > /data/hello.log'

把默认模块从command修改为shell

vim /etc/ansible/ansible.cfg
module_name = shell

Script 模块

功能：在远程主机上运行ansible服务器上的脚本(无需执行权限)

注意：此模块不具有幂等性

范例：

ansible webservers -m script -a '/root/test.sh'

Copy 模块

功能：从ansible服务器主控端复制文件到远程主机

注意: src=file 如果是没指明路径,则为当前目录或当前目录下的files目录下的file文件

范例：

复制文件

ansible webservers -m copy -a 'src=/root/test.sh dest=/root/test.sh owner=root mode=700 backup=yes'

直接生成内容

ansible webservers -m copy -a 'content="hahahaha" dest=/root/hello.log'

复制目录自身

ansible webservers -m copy -a 'src=/etc/mysql dest=/tmp'

复制目录下所有文件

ansible webservers -m copy -a 'src=/etc/mysql/ dest=/tmp'

Get_url 模块

功能: 用于将文件从http、https或ftp下载到被管理机节点上

范例：

ansible webservers -m get_url -a 'url=https://releases.ansible.com/ansible/ansible-latest.tar.gz dest=/usr/local/src' 

Fetch 模块

功能：从远程主机提取文件至ansible的主控端，copy相反，目前不支持目录

范例：

ansible webservers -m fetch -a 'src=/etc/os-release dest=/root'

File 模块

功能：设置文件属性,创建软链接等

范例：

创建空文件

ansible webservers -m file -a 'path=/tmp/test state=touch' 

删除文件

ansible webservers -m file -a 'path=/tmp/test state=absent'

创建目录

ansible webservers -m file -a 'path=/tmp/dir state=directory'

创建软链接

ansible webservers -m file -a 'src=/usr/bin/python3.8 path=/usr/bin/python state=link'

修改目录属性，不递归子目录

ansible webservers -m file -a 'path=/tmp/dir state=directory owner=mysql group=mysql'

修改目录属性，递归子目录

ansible webservers -m file -a 'path=/tmp/dir state=directory owner=mysql group=mysql recurse=yes'

stat 模块

功能：检查文件或文件系统的状态

注意：对于Windows目标，请改用win_stat模块

范例：

ansible webservers -m stat -a 'path=/etc/passwd'

unarchive 模块

功能：解包解压缩

有两种用法：

1. 将ansible主机上的压缩包传到远程主机后解压缩至特定目录，设置copy=yes,此为默认值,可省略
2. 将远程主机上的某个压缩包解压缩到指定路径下，设置copy=no

范例：

主控端的文件解包到远程主机

ansible webservers -m unarchive -a 'src=/root/testdir.tar.gz dest=/tmp'

解包远程主机的文件

ansible webservers -m unarchive -a 'src=/root/ansible-latest.tar.gz dest=/tmp copy=no'

从网上下载解包到远程主机

ansible webservers -m unarchive -a 'src=https://releases.ansible.com/ansible/ansible-latest.tar.gz dest=/tmp copy=no'
ansible webservers -m unarchive -a 'src=https://releases.ansible.com/ansible/ansible-latest.tar.gz dest=/tmp remote_src=yes'

Archive 模块

功能：打包压缩保存在被管理节点

format：bz2, gz, tar, xz, zip [Default: gz]

范例：

ansible webservers -m archive -a 'path=/var/log dest=/tmp/log.tar.gz'

Hostname 模块

功能：管理主机名

范例：

ansible webservers -m hostname -a 'name=frog448'

Cron 模块

功能：计划任务
支持时间：minute，hour，day，month，weekday

范例：

远程主机的备份脚本/root/mysql_backup.sh

#!/bin/bash
User='root'
Password='123456'
if [ ! -d /backup/sql ];then
  mkdir -p /backup/sql
fi
mysqldump -u${User} -p${Password} -A -F --single-transaction --master-data=2 --default-character-set=utf8mb4| gzip > /backup/sql/all_`date +%F-%T`.sql.gz

创建任务，工作日两点半执行备份任务

ansible webservers -m cron -a 'hour=2 minute=30 weekday=1-5 name="backup mysql" job=/root/mysql_backup.sh'

禁用计划任务（注释掉）

ansible webservers -m cron -a 'hour=2 minute=30 weekday=1-5 name="backup mysql" job=/root/mysql_backup.sh disabled=yes'

启用计划任务

ansible webservers -m cron -a 'hour=2 minute=30 weekday=1-5 name="backup mysql" job=/root/mysql_backup.sh disabled=no'

删除任务

ansible webservers -m cron -a 'name="backup mysql" state=absent' 

Yum 和 Apt 模块

功能：

yum 管理软件包，只支持RHEL，CentOS，fedora，不支持Ubuntu其它版本

apt 模块管理 Debian 相关版本的软件包

范例：

安装

ansible webservers -m yum -a 'name=httpd state=present'
ansible webservers -m yum -a 'name=sl,cowsay state=present'

升级

ansible webservers -m yum -a 'name=httpd state=latest'

删除

ansible webservers -m yum -a 'name=httpd state=absent'

查看包

ansible webservers -m yum -a 'list=tree'

将 php 和 mariadb 软件包安装到 dev、test 和 prod 主机组中的主机上

---
- hosts: dev,test,prod
  tasks:
    - name: 
      yum: 
        name: 
          - php
          - mariadb
        state: present

将 RPM Development Tools 软件包组安装到 dev主机组中的主机上

并且将 dev 主机组中主机上的所有软件包更新为最新版本

---
- hosts: dev
  tasks: 
    - name:
      yum: 
        name: "@RPM Development Tools" 
        state: present
    - name:
      yum:
        name: '*'
        state: latest  

Service 模块

功能：管理服务

范例：

ansible webservers -m service -a 'name=httpd state=started enabled=yes'

user模块

功能：管理用户

范例：

创建用户

ansible webservers -m user -a 'name=nginx system=yes shell=/sbin/nologin create_home=no' 

删除用户以及家目录

ansible webservers -m user -a 'name=nginx state=absent remove=yes'

Group 模块

功能：管理组

范例：

创建组

ansible webservers -m group -a 'name=nginx gid=88 system=yes'

删除组

ansible webservers -m group -a 'name=nginx state=absent'

Lineinfile 模块

一般在ansible当中去修改某个文件的单行进行替换的时候需要使用 lineinfile 模块

regexp：

使用正则表达式匹配对应的行，当替换文本时，如果有多行文本都能被匹配，则只有最后面被匹配到的那行文本才会被替换。当删除文本时，如果有多行文本都能被匹配，这么这些行都会被删除。如果想进行多行匹配进行替换需要使用replace模块。

功能：相当于sed，可以修改文件内容

范例：

修改httpd端口

ansible webservers -m lineinfile -a 'path=/etc/httpd/conf/httpd.conf regexp="^Listen" line="Listen 8080"'

禁用SELINUX

ansible webservers -m lineinfile -a 'path=/etc/selinux/config regexp="^SELINUX=" line="SELINUX=disabled"'

删除所有注释行并备份

ansible webservers -m lineinfile -a 'path=/etc/fstab state=absent regexp="^#" backup=true'

Replace 模块

该模块有点类似于sed命令，主要也是基于正则进行匹配和替换，建议使用

范例：

加注释

ansible webservers -m replace -a 'path=/etc/fstab regexp="^(UUID.*)" replace="#\1" backup=true'

去除注释

ansible webservers -m replace -a 'path=/etc/fstab regexp="^#(UUID.*)" replace="\1"'

SELinux 模块

该模块管理 SELInux 策略

范例:

ansible webservers -m selinux -a 'state=disabled'

reboot 模块

重启服务器

ansible webservers -m reboot

mount 挂载和卸载

功能: 挂载和卸载文件系统

范例:

临时挂载

ansible webservers -m mount -a 'src="UUID=b3e48f45-f933-4c8e-a700-22a159ec9077" path=/home fstype=xfs opts=noatime state=present'

临时取消挂载

mount webservers -m mount -a 'path=/home fstype=xfs opts=noatime state=unmounted'

永久挂载

ansible webservers -m mount -a 'src=10.0.0.1:/data/wordpress path=/var/www/html/wp-content/uploads opts="_netdev" state=mounted'

永久卸载

ansible webservers -m mount -a 'src=10.0.0.1:/data/wordpress path=/var/www/html/wp-content/uploads state=absent'

Setup 模块

功能： setup 模块来收集主机的系统信息，这些 facts 信息可以直接以变量的形式使用，但是如果主机较多，会影响执行速度。

可以使用gather_facts: no 来禁止 Ansible 收集 facts 信息

范例：

ansible webservers -m setup

查看linux系统发行版

ansible webservers -m setup -a 'filter=ansible_os_family'

debug 模块

此模块可以用于输出信息，并且通过 msg 定制输出的信息内容

注意: msg后面的变量有时需要加 ” ” 引起来

范例：

ansible webservers -m debug

输出变量 debug.yaml

---
- hosts: webservers
  tasks:
    - name: output variables
      debug:
        msg: Host "{{ ansible_nodename }}" Ip "{{ ansible_default_ipv4.address}}"