ansible常用模块总结

常用模块帮助文档参考：
https://docs.ansible.com/ansible/2.9/modules/modules_by_category.html
https://docs.ansible.com/ansible/2.9/modules/list_of_all_modules.html

1）Command模块
功能：在远程主机执行命令，此为默认模块，可忽略-m选项
说明：此命令不支持 $VARNAME < > | ; & 等，可用shell模块实现。
说明：此模块不具有幂等性（幂等性：多次执行不影响结果）
#chdir切换工作目录
[root@master tasks]#ansible webservers -m command -a "chdir=/etc cat centos-release"
10.0.0.150 | CHANGED | rc=0 >>
CentOS Linux release 8.3.2011
10.0.0.160 | CHANGED | rc=0 >>
CentOS Linux release 8.3.2011

#不支持，所以输出了hello > /root/hello.log到屏幕，而没有把hello写入到文件中
[root@master ~]#ansible webservers -m command  -a 'echo hello > /root/hello.log'
10.0.0.150 | CHANGED | rc=0 >>
hello > /root/hello.log
10.0.0.160 | CHANGED | rc=0 >>
hello > /root/hello.log

#creates存在则不执行
[root@master ~]#ansible webservers -m command  -a  'chdir=/etc creates=centos-release  cat centos-release'
10.0.0.150 | SUCCESS | rc=0 >>
skipped, since centos-release exists
10.0.0.160 | SUCCESS | rc=0 >>
skipped, since centos-release exists

#creates不存在则执行
[root@master ~]#ansible webservers -m command  -a  'chdir=/etc creates=f1.txt cat centos-release'
10.0.0.150 | CHANGED | rc=0 >>
CentOS Linux release 8.3.2011
10.0.0.160 | CHANGED | rc=0 >>
CentOS Linux release 8.3.2011


#removes存在才执行
[root@master ~]#ansible webservers -m command  -a  'chdir=/etc removes=centos-release  cat centos-release'
10.0.0.150 | CHANGED | rc=0 >>
CentOS Linux release 8.3.2011
10.0.0.160 | CHANGED | rc=0 >>
CentOS Linux release 8.3.2011

#removes不存在不执行
[root@master ~]#ansible webservers -m command  -a  'chdir=/etc removes=centos-rease  cat centos-release'
10.0.0.150 | SUCCESS | rc=0 >>
skipped, since centos-rease does not exist
10.0.0.160 | SUCCESS | rc=0 >>
skipped, since centos-rease does not exist

[root@master ~]#ansible webservers -m command  -a  'service mariadb restart'
[WARNING]: Consider using the service module rather than running 'service'.  If you
need to use command because service is insufficient you can add 'warn: false' to this
command task or set 'command_warnings=False' in ansible.cfg to get rid of this message.
10.0.0.160 | CHANGED | rc=0 >>
Redirecting to /bin/systemctl restart mariadb.service
10.0.0.150 | CHANGED | rc=0 >>
Redirecting to /bin/systemctl restart mariadb.service


2）shell模块
功能：和command相似，用shell执行命令,支持各种符号,比如:*,$, > 
说明：此模块不具有幂等性
说明：调用bash执行命令 类似 cat /tmp/test.md | awk -F'|' '{print $1,$2}' &> /tmp/example.txt 这些
复杂命令，即使使用shell也可能会失败，解决办法：写到脚本时，copy到远程，执行，再把需要的结果
拉回执行命令的机器

[root@master ~]#ansible webservers -m shell -a 'echo $HOSTNAME'
10.0.0.150 | CHANGED | rc=0 >>
master
10.0.0.160 | CHANGED | rc=0 >>
slave1

[root@master ~]#ansible webservers -m shell -a  'echo hello > /root/hello.log'
10.0.0.150 | CHANGED | rc=0 >>

10.0.0.160 | CHANGED | rc=0 >>

[root@master ~]#ansible webservers -m shell -a  'cat /root/hello.log'
10.0.0.150 | CHANGED | rc=0 >>
hello
10.0.0.160 | CHANGED | rc=0 >>
hello

可以把shell模块设置为默认模块
[root@master ~]#vim ansible.cfg
module_name = shell

Ansible 的配置文件可以放在多个不同地方,优先级从高到低顺序如下
ANSIBLE_CONFIG #环境变量,注意此项用 ansible --version 看不到,但可以生效
./ansible.cfg   #当前目录下的ansible.cfg
~/.ansible.cfg #当前用户家目录下的.ansible.cfg
/etc/ansible/ansible.cfg  #系统默认配置文件

3）script模块
功能：在远程主机上运行ansible服务器上的脚本(无需执行权限)
说明：此模块不具有幂等性
脚本在当前机器上
[root@master ~]#ansible webservers  -m script -a '/root/test.sh'


4)copy模块
功能：从主控端复制文件到远程主机
说明: src=file 如果是没指明路径,则为当前目录或当前目录下的files目录下的file文件
#如目标存在，默认覆盖，此处指定先备份
[root@master ~]#ansible webservers -m copy -a "src=/root/test.sh dest=/tmp/test3.sh owner=mysql  mode=600 backup=yes"

#指定内容，直接生成目标文件    
[root@master ~]#ansible webservers -m copy -a "content='test line1\ntest line2\n' dest=/tmp/test.txt"
[root@master ~]#cat /tmp/test.txt
test line1
test line2

#复制/etc目录自身,注意/etc/后面没有/
ansible webservers -m copy -a "src=/etc dest=/backup"

#复制/etc/下的文件，不包括/etc/目录自身,注意/etc/后面有/
ansible webservers -m copy -a "src=/etc/ dest=/backup"

5)get_url模块
功能: 用于将文件从http、https或ftp下载到被管理机节点上
常用参数：
url: 下载文件的URL,支持HTTP，HTTPS或FTP协议
dest: 下载到目标路径（绝对路径），如果目标是一个目录，就用服务器上面文件的名称，如果目标设置了名称就用目标设置的名称
owner：指定属主
group：指定属组
mode：指定权限
force: 如果yes，dest不是目录，将每次下载文件，如果内容改变，替换文件。如果否，则只有在目标不存在时才会下载该文件
checksum: 对目标文件在下载后计算摘要，以确保其完整性
           示例: checksum="sha256:D98291AC[...]B6DC7B97",
               checksum="sha256:http://example.com/path/sha256sum.txt"
url_username: 用于HTTP基本认证的用户名。 对于允许空密码的站点，此参数可以不使用`url_password'
url_password: 用于HTTP基本认证的密码。 如果未指定`url_username'参数，则不会使用`url_password'参数validate_certs：如果“no”，SSL证书将不会被验证。 适用于自签名证书在私有网站上使用
timeout: URL请求的超时时间,秒为单位

[root@master ~]#ansible webservers -m get_url -a 'url=http://nginx.org/download/nginx-1.18.0.tar.gz dest=/usr/local/src/nginx.tar.gz checksum="md5:b2d33d24d89b8b1f87ff5d251aa27eb8"'
[root@master ~]#ll /usr/local/src/nginx.tar.gz
-rw-r--r-- 1 root root 1039530 Nov 11 17:57 /usr/local/src/nginx.tar.gz


6)fethch模块
功能：从远程主机提取文件至ansible的主控端，copy相反，目前不支持目录
[root@master ~]#ansible webservers -m fetch -a 'src=/root/test.sh dest=.'

[root@master ~]#tree
.
├── 10.0.0.150
│   └── root
│       └── test.sh
├── 10.0.0.160
│   └── root
│       └── test.sh


7)file模块
功能：设置文件属性,创建软链接等
#创建空文件
[root@master ~]#ansible all -m file  -a 'path=/data/test.txt state=touch'
#删除文件
[root@master ~]#ansible all -m file  -a 'path=/data/test.txt state=absent'
#设置文件权限
[root@master ~]#ansible all -m file -a "path=/root/test.sh owner=wang mode=755"
#创建目录
[root@master ~]#ansible all -m file -a "path=/data/mysql state=directory owner=mysql group=mysql"
#创建软链接，path|dest|name表示三个选一个都行
[root@master ~]#ansible all -m file -a 'src=/data/testfile path|dest|name=/data/testfile-link state=link'
#创建目录
[root@master ~]#ansible all -m file  -a 'path=/data/testdir state=directory'
#递归修改目录属性,但不递归至子目录
[root@master ~]#ansible all -m file -a "path=/data/mysql state=directory owner=mysql group=mysql"
#递归修改目录及子目录的属性
[root@master ~]#ansible all -m file -a "path=/data/mysql state=directory owner=mysql group=mysql recurse=yes"

8)stat模块
功能：检查文件或文件系统的状态
说明：对于Windows目标，请改用win_stat模块
选项：path：文件/对象的完整路径（必须）
常用的返回值判断：
	exists： 判断是否存在
	isuid： 调用用户的ID与所有者ID是否匹配
[root@master data]#ansible 127.0.0.1 -m stat -a 'path=/etc/passwd'
127.0.0.1 | SUCCESS => {
    "changed": false,
    "stat": {
        "atime": 1636603261.996736,
        "attr_flags": "",
        "attributes": [],
        "block_size": 4096,
        "blocks": 8,
        "charset": "us-ascii",
        "checksum": "358721bb9ccdb8b1eaf3a9b97e51d1eee306dd50",
        "ctime": 1636429959.9657238,
        "dev": 2053,
        "device_type": 0,
        "executable": false,
        "exists": true,
        "gid": 0,
        "gr_name": "root",
        "inode": 135872481,
        "isblk": false,
        "ischr": false,
        "isdir": false,
        "isfifo": false,
        "isgid": false,
        "islnk": false,
        "isreg": true,
        "issock": false,
        "isuid": false,
        "mimetype": "text/plain",
        "mode": "0644",
        "mtime": 1636429959.9647236,
        "nlink": 1,
        "path": "/etc/passwd",
        "pw_name": "root",
        "readable": true,
        "rgrp": true,
        "roth": true,
        "rusr": true,
        "size": 2814,
        "uid": 0,
        "version": "4213724205",
        "wgrp": false,
        "woth": false,
        "writeable": true,
        "wusr": true,
        "xgrp": false,
        "xoth": false,
        "xusr": false
    }
}

使用范例一：
- name: install | Check if file is already configured.
 stat: path={{ nginx_file_path }}
 connection: local
 register: nginx_file_result
- name: install | Download nginx file
 get_url: url={{ nginx_file_url }} dest={{ software_files_path }} validate_certs=no
 connection: local
 when:，not. nginx_file_result.stat.exists
使用范例二：
[root@ansible ansible]#cat stat.yml
---
- hosts: websrvs
  
 tasks:
    - name: check file
     stat: path=/data/mysql 
     register: st
    - name: debug
     debug:
       msg: "/data/mysql is not exist"
     when: not st.stat.exists
     
     
9)unarchive模块
功能：解包解压缩
实现有两种用法：
1、将ansible主机上的压缩包传到远程主机后解压缩至特定目录，设置copy=yes,此为默认值,可省略
2、将远程主机上的某个压缩包解压缩到指定路径下，设置copy=no 
常见参数：
copy：默认为yes，当copy=yes，拷贝的文件是从ansible主机复制到远程主机上，如果设置为copy=no，会在远程主机上寻找src源文件
remote_src：和copy功能一样且互斥，yes表示在远程主机，不在ansible主机，no表示文件在ansible主机上
src：源路径，可以是ansible主机上的路径，也可以是远程主机(被管理端或者第三方主机)上的路径，如果是远程主机上的路径，则需要设置copy=no
dest：远程主机上的目标路径
mode：设置解压缩后的文件权限

[root@master ~]#ansible all -m unarchive -a 'src=/data/foo.tgz dest=/var/lib/foo owner=wang group=bin'
[root@master ~]#ansible all -m unarchive -a 'src=/tmp/foo.zip dest=/data copy=no mode=0777'
[root@master ~]#ansible all -m unarchive -a 'src=https://releases.ansible.com/ansible/ansible-2.1.6.0-0.1.rc1.tar.gz dest=/data copy=no'
[root@master ~]#ansible all -m unarchive -a 'src=https://releases.ansible.com/ansible/ansible-2.1.6.0-0.1.rc1.tar.gz dest=/data/   owner=root remote_src=yes'
[root@master ~]#ansible all -m unarchive -a 'src=http://nginx.org/download/nginx-1.18.0.tar.gz dest=/usr/local/src/ copy=no'


10)archive模块
功能：打包压缩保存在被管理节点

[root@master ~]#ansible all -m archive -a 'path=/root/nginx-1.18.0  dest=/root/ngxin.tar.bz2 format=bz2  mode=0600'


11)hostname模块
功能：管理主机名
[root@master ~]#ansible 10.0.0.150 -m hostname -a 'name=master111'


12)cron模块
功能：计划任务
支持时间：minute，hour，day，month，weekday

[root@master ~]#cat /root/mysql_backup.sh 
#!/bin/bash
mysqldump -A -F --single-transaction --master-data=2 -q -uroot |gzip > 
/data/mysql_`date +%F_%T`.sql.gz
#创建任务
[root@master ~]#ansible 10.0.0.150 -m cron -a 'hour=2 minute=30 weekday=1-5 name="backup mysql" job=/root/mysql_backup.sh'
[root@master ~]#ansible websrvs   -m cron -a "minute=*/5 job='/usr/sbin/ntpdate ntp.aliyun.com &>/dev/null' name=Synctime"
#禁用计划任务
[root@master ~]#ansible websrvs   -m cron -a "minute=*/5 job='/usr/sbin/ntpdate 172.20.0.1 &>/dev/null' name=Synctime disabled=yes"
#启用计划任务
[root@master ~]#ansible websrvs   -m cron -a "minute=*/5 job='/usr/sbin/ntpdate 172.20.0.1 &>/dev/null' name=Synctime disabled=no"
#删除任务
[root@master ~]#ansible websrvs -m cron -a "name='backup mysql' state=absent"
[root@master ~]#ansible websrvs -m cron -a 'state=absent name=Synctime'

13)yum和apt模块
功能：
yum 管理软件包，只支持RHEL，CentOS，fedora，不支持Ubuntu其它版本
apt 模块管理 Debian 相关版本的软件包
[root@master ~]#ansible websrvs -m yum -a 'name=httpd state=present'  #安装
[root@master ~]#ansible websrvs -m yum -a 'name=nginx state=present enablerepo=epel'  #启用epel源进行安装
[root@master ~]#ansible websrvs -m yum -a 'name=* state=lastest exclude=kernel*,foo*' #升级除kernel和foo开头以外的所有包
[root@master ~]#ansible websrvs -m yum -a 'name=httpd state=absent'   #删除
[root@master ~]#ansible websrvs -m yum -a 'name=sl,cowsay'
[root@master ~]#ansible websrvs -m yum -a 
"name=https://mirror.tuna.tsinghua.edu.cn/zabbix/zabbix/5.2/rhel/7/x86_64/zabbixagent-5.2.5-1.el7.x86_64.rpm"
[root@centos8 ~]#ansible websrvs -m apt -a 'name=rsync,psmisc state=absent'
[root@master ~]#ansible localhost -m yum -a "list=tree"

14)yum_repository模块
功能：配置yum仓库
#创建yum仓库
[root@master ~]#ansible localhost -m yum_repository  -a "name=test description='epel yum repo' file=external_repos baseurl=https://download.fedoraproject.org/pub/epel/$releasever/$basearch/ gpgcheck=no"
localhost | CHANGED => {
    "changed": true,
    "repo": "test",
    "state": "present"
}

[root@master ~]#ls /etc/yum.repos.d/external_repos.repo
/etc/yum.repos.d/external_repos.repo

#删除仓库
[root@master ~]#ansible localhost -m yum_repository  -a "name=test  file=external_repos state=absent"                                                                           localhost | CHANGED => {
    "changed": true,
    "repo": "test",
    "state": "absent"
}
[root@master ~]#ls /etc/yum.repos.d/external_repos.repo                                 ls: cannot access '/etc/yum.repos.d/external_repos.repo': No such file or directory

15）service模块
功能：管理服务
[root@master ~]#ansible all -m service -a 'name=httpd state=started enabled=yes'
[root@master ~]#ansible all -m service -a 'name=httpd state=stopped'
[root@master ~]#ansible all -m service -a 'name=httpd state=reloaded'
[root@master ~]#ansible all -m shell -a "sed -i 's/^Listen 80/Listen 8080/' 
/etc/httpd/conf/httpd.conf"
[root@master ~]#ansible all -m service -a 'name=httpd state=restarted'


16）user模块
功能：管理用户
#创建用户
[root@master ~]#ansible all -m user -a 'name=nginx comment=nginx uid=88  groups="root,daemon" shell=/sbin/nologin system=yes create_home=no home=/data/nginx non_unique=yes'

#remove=yes表示删除用户及家目录等数据,默认remove=no
[root@master ~]#ansible all -m user -a 'name=nginx state=absent remove=yes'

#生成123456加密的密码
[root@master ~]#ansible localhost -m debug -a "msg={{ '123456'| 
password_hash('sha512','salt')}}"
localhost | SUCCESS => {
    "msg": "$6$salt$MktMKPZJ6t59GfxcJU20DwcwQzfMvOlHFVZiOVD71w."
}
#用上面创建的密码创建用户
[root@master ~]#ansible websrvs -m user -a 'name=test password="$6$salt$MktMKPZJ6t59GfxcJU20DwcwQzfMvOlHFVZiOVD71w."'

#创建用户test,并生成4096bit的私钥
[root@master ~]#ansible websrvs -m user -a 'name=test generate_ssh_key=yes ssh_key_bits=4096 ssh_key_file=.ssh/id_rsa'

17）group模块
功能：管理组
#创建组
[root@master ~]#ansible websrvs -m group  -a 'name=nginx gid=88 system=yes'
#删除组
[root@master ~]#ansible websrvs -m group  -a 'name=nginx state=absent'


18）lineinfile模块
ansible在使用sed进行替换时，经常会遇到需要转义的问题，而且ansible在遇到特殊符号进行替换时，存在问题，无法正常进行替换 。其实在ansible自身提供了两个模块：lineinfile模块和replace模块，可以方便的进行替换

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

regexp参数 ：使用正则表达式匹配对应的行，当替换文本时，如果有多行文本都能被匹配，则只有最后面被匹配到的那行文本才会被替换，当删除文本时，如果有多行文本都能被匹配，这么这些行都会被删除。

如果想进行多行匹配进行替换需要使用replace模块

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

[root@master ~]#ansible websrvs -m lineinfile -a "path=/etc/httpd/conf/httpd.conf regexp='^Listen' line='Listen 80'"
[root@master ~]#ansible all -m   lineinfile -a "path=/etc/selinux/config regexp='^SELINUX=' line='SELINUX=disabled'"
[root@master ~]#ansible all -m lineinfile  -a 'dest=/etc/fstab state=absent regexp="^#"'

19）replace模块
该模块有点类似于sed命令，主要也是基于正则进行匹配和替换，建议使用
[root@master ~]#ansible all -m replace -a "path=/etc/fstab regexp='^(UUID.*)' replace='#\1'"  
[root@master ~]#ansible all -m replace -a "path=/etc/fstab regexp='^#(UUID.*)' replace='\1'"


20）SELinux 模块
该模块管理 SELInux 策略
[root@master ~]#ansible all -m selinux -a 'state=disabled'


21）reboot模块
功能：重启服务器
[root@master ~]#ansible websrvs -m reboot


22）mount 挂载和卸载
功能: 挂载和卸载文件系统
#临时挂载
[root@master ~]#mount 10.0.0.150 -m mount -a 'src="UUID=b3e48f45-f933-4c8e-a700-22a159ec9077" path=/home fstype=xfs opts=noatime state=present'
#临时取消挂载
[root@master ~]#mount all -m mount -a 'path=/home fstype=xfs opts=noatime state=unmounted'
#永久挂载
[root@master ~]#ansible all -m mount -a 'src=10.0.0.150:/data/wordpress path=/var/www/html/wp-content/uploads opts="_netdev" state=mounted'
#永久卸载
[root@master ~]#ansible all -m mount -a 'src=10.0.0.150:/data/wordpress path=/var/www/html/wp-content/uploads state=absent'

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

[root@master ~]#ansible all -m setup
[root@master ~]#ansible all -m setup -a "filter=ansible_nodename"
[root@master ~]#ansible all -m setup -a "filter=ansible_hostname"
[root@master ~]#ansible all -m setup -a "filter=ansible_domain"
[root@master ~]#ansible all -m setup -a "filter=ansible_memtotal_mb"
[root@master ~]#ansible all -m setup -a "filter=ansible_memory_mb"
[root@master ~]#ansible all -m setup -a "filter=ansible_memfree_mb"
[root@master ~]#ansible all -m setup -a "filter=ansible_os_family"
[root@master ~]#ansible all -m setup -a "filter=ansible_distribution_major_version"
[root@master ~]#ansible all -m setup -a "filter=ansible_distribution_version"
[root@master ~]#ansible all -m setup -a "filter=ansible_processor_vcpus"
[root@master ~]#ansible all -m setup -a "filter=ansible_all_ipv4_addresses"
[root@master ~]#ansible all -m setup -a "filter=ansible_architecture"
[root@master ~]#ansible all -m setup -a "filter=ansible_uptime_seconds"
[root@master ~]#ansible all -m setup -a "filter=ansible_processor*"
[root@master ~]#ansible all -m setup -a 'filter=ansible_env'
[root@master ~]#ansible all -m setup -a 'filter=ansible_all_ipv4_addresses'
[root@master ~]#ansible all -m setup -a 'filter=ansible_python_version'
[root@master ~]#ansible all -m setup -a 'filter="ansible_default_ipv4"'

24）debug 模块
此模块可以用于输出信息,并且通过 msg 定制输出的信息内容
注意: msg后面的变量有时需要加 " " 引起来

debug 模块默认输出Hello world
[root@master ~]#ansible all -m debug
10.0.0.150 | SUCCESS => {
    "msg": "Hello world!"
}

[root@master ~]#ansible all -m debug -a 'msg="HOSTNAME"'
10.0.0.150 | SUCCESS => {
    "msg": "HOSTNAME"
}

#利用debug模块输出变量
[root@master ~]#cat debug.yaml 
---
- hosts: websrvs
  
 tasks: 
    - name: output variables
     debug:
       msg: Host "{{ ansible_nodename }}" Ip  "{{ ansible_default_ipv4.address }}"

#显示特定字符
# cat debug.yml
- hosts: all
 gather_facts: no
 vars:
   a: "12345"
 tasks:
  - debug:
     msg: "{{a[2]}}"
#定义了一个字符串变量a，如果想要获取a字符串的第3个字符，则可以使用”a[2]”获取，索引从0开始，执行上例playbook，debug的输出信息如下：

[root@master tasks]#ansible-playbook /root/debug.yml

PLAY [all] *****************************************************************************

TASK [debug] ***************************************************************************
ok: [10.0.0.150] => {
    "msg": "3"
}
ok: [10.0.0.160] => {
    "msg": "3"
}