Ansible02-Ansible Modules模块详解

写在前面

这是Ansible系列第二篇，内容为Ansible Modules的介绍、使用
序号连续上篇笔记 Ansible01-Ansible的概述、实验环境初始化、Inventory

回顾一下Ansible架构：

4. Ansible Modules 模块

Modules，类似于Linux中的命令，如：yum模块->yum命令；file模块；user模块

• Ansible格式：

ansible -i 指定清单 -m 指定模块 -a 指定模块中的选项

• 查看ansible所有模块:

ansible-doc -l

• 查看ansible某模块的参数选项：

 ansible-doc -s 模块名
 #  -s, --snippet         Show playbook snippet for these plugin types: inventory, lookup,module

4.1 Ansible常用模块

4.1.1 Command模块

默认的模块,执行简单命令,不支持特殊符号

• ansible -s command：

[root@manager ~]# ansible all -m command -a 'ip a s ens33'
192.168.100.149 | CHANGED | rc=0 >>
2: ens33: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc fq_codel state UP group default qlen 1000
    link/ether 00:0c:29:e1:55:bb brd ff:ff:ff:ff:ff:ff
    altname enp2s1
    inet 192.168.100.149/24 brd 192.168.100.255 scope global dynamic noprefixroute ens33
       valid_lft 1737sec preferred_lft 1737sec
    inet6 fe80::20c:29ff:fee1:55bb/64 scope link
       valid_lft forever preferred_lft forever

#切换到指定目录
[root@manager ~]# ansible front -m command -a 'chdir=/root ls'
192.168.100.148 | CHANGED | rc=0 >>
anaconda-ks.cfg
test1.log

#creates参数表示如果/etc/passwd文件存在于远程主机中，则不执行对应命令，如果不存在，才执行”touch”命令
[root@manager ~]# ansible websrvs -m command -a 'creates=/etc/passwd touch /opt/passwd' 

#removes参数表示如果/opt/abc文件不存在，就不执行“mv”命令，如果文件存在则执行“mv”命令
[root@manager ~]# ansible websrvs -m command -a 'removes=/opt/abc mv /opt/abc /root/'

4.1.2 shell模块

类似command模块，不过支持特殊符号

[root@manager ~]# ansible all -m shell -a "ip a s ens33 | awk -F'[/ ]+' 'NR==4{print \$3}'"
192.168.100.150 | CHANGED | rc=0 >>
192.168.100.150
192.168.100.148 | CHANGED | rc=0 >>
192.168.100.148
192.168.100.149 | CHANGED | rc=0 >>
192.168.100.149

4.1.3 scrpit模块

用于执行脚本的模块

#编写shell脚本
[root@manager ~]# cat sys_info.sh
#!/bin/bash
#author: tassel
#desc: ansible script modules test shellscript
hostname
hostname -I
ip a s ens33 |awk -F'[ /]+' 'NR==4{print $3}'
uptime
whoami
date +%F
sleep 10 #用于可以ps -ef和pstree查看ansible状态

#测试
[root@manager ~]# ansible all -m script -a '/root/sys_info.sh'
192.168.100.149 | CHANGED => {
    "changed": true,
    "rc": 0,
    "stderr": "Shared connection to 192.168.100.149 closed.\r\n",
    "stderr_lines": [
        "Shared connection to 192.168.100.149 closed."
    ],
    "stdout": "backup\r\n192.168.100.149 \r\n192.168.100.149\r\n 20:05:14 up 24 min,  1 user,  load average: 0.68, 0.58, 0.33\r\nroot\r\n2024-05-26\r\n",
    "stdout_lines": [
        "backup",
        "192.168.100.149 ",
        "192.168.100.149",
        " 20:05:14 up 24 min,  1 user,  load average: 0.68, 0.58, 0.33",
        "root",
        "2024-05-26"
    ]
}

#ps和pstree查看
ps -ef | grep ansible 
root        2679    1728 55 20:07 pts/0    00:00:01 /usr/bin/python3.11 /usr/bin/ansible all -m script -a /root/sys_info.sh
root        2682    2679  5 20:07 pts/0    00:00:00 /usr/bin/python3.11 /usr/bin/ansible all -m script -a /root/sys_info.sh
root        2683    2679  4 20:07 pts/0    00:00:00 /usr/bin/python3.11 /usr/bin/ansible all -m script -a /root/sys_info.sh
root        2684    2679  4 20:07 pts/0    00:00:00 /usr/bin/python3.11 /usr/bin/ansible all -m script -a /root/sys_info.sh
## 不难发现，使用python运行
#pstree 也可以看到，是ssh执行脚本
─sshd(921)─┬─sshd(1721)───sshd(1726)───bash(1728)
           │           ├─sshd(1725)───sshd(1758)───sftp-server(1759)
           │           ├─sshd(2526)───sshd(2531)───bash(2533)───pstree(2674)
           │           └─sshd(2530)───sshd(2561)───sftp-server(2564)

4.1.4 file模块

file模块管理文件、目录、软连接。
相当于结合了touch、mkdir、rm、ln-s

• 常用参数介绍：

# 创建文件
[root@manager ~]# ansible front -m file -a 'path=/tmp/0526.txt state=touch'
192.168.100.148 | CHANGED => {
    "ansible_facts": {
        "discovered_interpreter_python": "/usr/libexec/platform-python"
    },
    "changed": true,
    "dest": "/tmp/0526.txt",
    "gid": 0,
    "group": "root",
    "mode": "0644",
    "owner": "root",
    "secontext": "unconfined_u:object_r:user_tmp_t:s0",
    "size": 0,
    "state": "file",
    "uid": 0
}

[root@front ~]# ls /tmp
0526.txt                    

#####

#递归创建目录
[root@manager ~]#  ansible front -m file -a 'path=/tmp/a/b/c/d/e state=directory'
192.168.100.148 | CHANGED => {
    "ansible_facts": {
        "discovered_interpreter_python": "/usr/libexec/platform-python"
    },
    "changed": true,
    "gid": 0,
    "group": "root",
    "mode": "0755",
    "owner": "root",
    "path": "/tmp/a/b/c/d/e",
    "secontext": "unconfined_u:object_r:user_tmp_t:s0",
    "size": 6,
    "state": "directory",
    "uid": 0
}

[root@front ~]# tree -F /tmp
/tmp
├── 0526.txt
├── a/
│   └── b/
│       └── c/
│           └── d/
│               └── e/


#####

#创建软连接
[root@manager ~]# ansible front -m file -a 'path=/tmp/hosts_sl src=/etc/hosts state=link'
192.168.100.148 | CHANGED => {
    "ansible_facts": {
        "discovered_interpreter_python": "/usr/libexec/platform-python"
    },
    "changed": true,
    "dest": "/tmp/hosts_sl",
    "gid": 0,
    "group": "root",
    "mode": "0777",
    "owner": "root",
    "secontext": "unconfined_u:object_r:user_tmp_t:s0",
    "size": 10,
    "src": "/etc/hosts",
    "state": "link",
    "uid": 0
}

[root@manager ~]# ansible front -m shell -a 'ls -l /tmp/hosts*'
192.168.100.148 | CHANGED | rc=0 >>
lrwxrwxrwx. 1 root root 10 May 26 20:40 /tmp/hosts_sl -> /etc/hosts

#####

#修改权限
[root@manager ~]# ansible front -m file -a 'path=/tmp/ansible-test mode=700 owner=nobody group=nobody state=directory'
192.168.100.148 | CHANGED => {
    "ansible_facts": {
        "discovered_interpreter_python": "/usr/libexec/platform-python"
    },
    "changed": true,
    "gid": 65534,
    "group": "nobody",
    "mode": "0700",
    "owner": "nobody",
    "path": "/tmp/ansible-test",
    "secontext": "unconfined_u:object_r:user_tmp_t:s0",
    "size": 6,
    "state": "directory",
    "uid": 65534
}

[root@manager ~]# ansible front -m shell -a 'ls -ld /tmp/ansible-test'                         192.168.100.148 | CHANGED | rc=0 >>
drwx------. 2 nobody nobody 6 May 26 20:44 /tmp/ansible-test

#####

# 删除目录（递归，若删除高层目录，其子目录也被删除）
[root@manager ~]# ansible front -m file -a 'path=/tmp/a/b/c/ state=absent'
192.168.100.148 | CHANGED => {
    "ansible_facts": {
        "discovered_interpreter_python": "/usr/libexec/platform-python"
    },
    "changed": true,
    "path": "/tmp/a/b/c/",
    "state": "absent"
}

[root@manager ~]# ansible front -m shell -a 'tree -F /tmp'
192.168.100.148 | CHANGED | rc=0 >>
/tmp
├── 0526.txt
├── a/
│   └── b/

4.1.5 copy模块

批量分发，类似于scp：1个节点(管理节点)发送文件或压缩包到所有被管理端.
注意：copy是单向的传输。

还有一个fetch 批量拉取

# 传输/etc/hosts到所有主机组的主机
[root@manager ~]# ansible all -m copy -a 'src=/etc/hosts dest=/etc/hosts backup=yes'
192.168.100.150 | CHANGED => {
    "ansible_facts": {
        "discovered_interpreter_python": "/usr/libexec/platform-python"
    },
    "backup_file": "/etc/hosts.4177.2024-05-26@20:53:57~",
    "changed": true,
    "checksum": "54e822ead7405808873d7efeb6ae02f1b58b1962",
    "dest": "/etc/hosts",
    "gid": 0,
    "group": "root",
    "md5sum": "a608fd387bb46d36a21adb75b01490c0",
    "mode": "0644",
    "owner": "root",
    "secontext": "system_u:object_r:net_conf_t:s0",
    "size": 183,
    "src": "/root/.ansible/tmp/ansible-tmp-1716728034.4922798-3386-265280371596300/source",
    "state": "file",
    "uid": 0
}


[root@manager ~]# ansible front -m shell -a 'ls /etc/hosts*'
192.168.100.148 | CHANGED | rc=0 >>
/etc/hosts
/etc/hosts.7761.2024-05-26@20:53:57~

4.1.6 lineinfile模块

修改配置文件使用，类似sed 's///g’和sed ‘cai’

4.1.7 systemd模块

systemd模块类似systemctl命令

service模块，是centos7之前的service命令

#开启并开机自启 nfs
[root@manager ~]# ansible storage -m systemd -a 'name=nfs-server enabled=yes state=started'
192.168.100.150 | CHANGED => {
    "ansible_facts": {
        "discovered_interpreter_python": "/usr/libexec/platform-python"
    },
    "changed": true,
    "enabled": true,
    "name": "nfs-server",
    "state": "started",

# 关闭并开机不自启 firewalld
[root@manager ~]# ansible front -m systemd -a 'name=firewalld enabled=no state=stopped'
192.168.100.148 | SUCCESS => {
    "ansible_facts": {
        "discovered_interpreter_python": "/usr/libexec/platform-python"
    },
    "changed": false,
    "enabled": false,
    "name": "firewalld",
    "state": "stopped",

# 重启nfs
[root@manager ~]# ansible storage -m systemd -a 'name=nfs-utils state=reloaded'
192.168.100.150 | CHANGED => {
    "ansible_facts": {
        "discovered_interpreter_python": "/usr/libexec/platform-python"
    },
    "changed": true,
    "name": "nfs-utils",
    "state": "started",

4.1.8 yum模块

yum安装软件

#安装软件
ansible all -m yum -a 'name=tree,lrzsz,sshpass state=present'
192.168.100.148 | CHANGED => {
    "ansible_facts": {
        "discovered_interpreter_python": "/usr/libexec/platform-python"
    },
    "changed": true,
    "msg": "",
    "rc": 0,
    "results": [
        "Installed: lrzsz-0.12.20-43.el8.x86_64",
        "Installed: sshpass-1.09-4.el8.x86_64"
    ]
}

#更新软件包
ansible all -m yum -a "name=rsync state=latest"

4.1.9 get_url模块

相当于wget命令，需要所有主机均能访问互联网
建议在管理节点下载好软件包后，copy分发

#下载zabbix
https://mirrors.aliyun.com/zabbix/zabbix/6.5/centos/8/x86_64/zabbix-agent-7.0.0-alpha3.release1.el8.x86_64.rpm

[root@manager ~]# ansible all -m get_url -a 'url=https://mirrors.aliyun.com/zabbix/zabbix/6.5/centos/8/x86_64/zabbix-agent-7.0.0-alpha3.release1.el8.x86_64.rpm dest=/tmp/'
192.168.100.148 | CHANGED => {
    "ansible_facts": {
        "discovered_interpreter_python": "/usr/libexec/platform-python"
    },
    "changed": true,
    "checksum_dest": null,
    "checksum_src": "b65b658d3246bac2783436b45e499fa57c68a5ef",
    "dest": "/tmp/zabbix-agent-7.0.0-alpha3.release1.el8.x86_64.rpm",
    "elapsed": 0,
    "gid": 0,
    "group": "root",
    "md5sum": "cba9f70da1ef01574bd2608b43d39b31",
    "mode": "0644",
    "msg": "OK (599492 bytes)",
    "owner": "root",
    "secontext": "unconfined_u:object_r:admin_home_t:s0",
    "size": 599492,
    "src": "/root/.ansible/tmp/ansible-tmp-1716729618.362924-3810-161846721092095/tmpb1f4j0t0",
    "state": "file",
    "status_code": 200,
    "uid": 0,
    "url": "https://mirrors.aliyun.com/zabbix/zabbix/6.5/centos/8/x86_64/zabbix-agent-7.0.0-alpha3.release1.el8.x86_64.rpm"
}

[root@manager ~]# ansible all -m shell -a 'ls /tmp/zabbix*'
192.168.100.148 | CHANGED | rc=0 >>
/tmp/zabbix-agent-7.0.0-alpha3.release1.el8.x86_64.rpm
192.168.100.149 | CHANGED | rc=0 >>
/tmp/zabbix-agent-7.0.0-alpha3.release1.el8.x86_64.rpm
192.168.100.150 | CHANGED | rc=0 >>
/tmp/zabbix-agent-7.0.0-alpha3.release1.el8.x86_64.rpm

#调用yum模块安装
 ansible all -m yum -a 'name=/tmp/zabbix-agent-7.0.0-alpha3.release1.el8.x86_64.rpm state=present'

4.1.10 yum_repository模块

更推荐写好yum配置文件，再copy推送

• yum配置文件与yum-repository对比：

4.1.11 user模块

#创建一个用户，uid2000，nologin
[root@manager ~]# ansible all -m user -a 'name=ans uid=2000 shell=/sbin/nologin create_home=no state=present'
192.168.100.149 | CHANGED => {
    "ansible_facts": {
        "discovered_interpreter_python": "/usr/libexec/platform-python"
    },
    "changed": true,
    "comment": "",
    "create_home": false,
    "group": 2000,
    "home": "/home/ans",
    "name": "ans",
    "shell": "/sbin/nologin",
    "state": "present",
    "system": false,
    "uid": 2000
}


# 更新密码
[root@manager ~]# ansible all -m user -a "name=test password={{'1'|password_hash('sha512','hashsalt')}} state=present"
[DEPRECATION WARNING]: Encryption using the Python crypt module is deprecated. The Python
crypt module is deprecated and will be removed from Python 3.13. Install the passlib library
for continued encryption functionality. This feature will be removed in version 2.17.
Deprecation warnings can be disabled by setting deprecation_warnings=False in ansible.cfg.
192.168.100.148 | CHANGED => {
    "ansible_facts": {
        "discovered_interpreter_python": "/usr/libexec/platform-python"
    },
    "changed": true,
    "comment": "",
    "create_home": true,
    "group": 2001,
    "home": "/home/test",
    "name": "test",
    "password": "NOT_LOGGING_PASSWORD",
    "shell": "/bin/bash",
    "state": "present",
    "system": false,
    "uid": 2001
}

4.1.12 group模块

类比user模块

4.1.13 mount模块

#挂载nfs

#1. 安装nfs
[root@manager ~]# ansible front -m yum -a 'name=nfs-utils state=present'
192.168.100.148 | SUCCESS => {
    "ansible_facts": {
        "discovered_interpreter_python": "/usr/libexec/platform-python"
    },
    "changed": false,
    "msg": "Nothing to do",
    "rc": 0,
    "results": []
}

#2.创建挂载文件夹
[root@manager ~]# ansible front -m file -a 'path=/ans-upload state=directory'
192.168.100.148 | CHANGED => {
    "ansible_facts": {
        "discovered_interpreter_python": "/usr/libexec/platform-python"
    },
    "changed": true,
    "gid": 0,
    "group": "root",
    "mode": "0755",
    "owner": "root",
    "path": "/ans-upload",
    "secontext": "unconfined_u:object_r:default_t:s0",
    "size": 6,
    "state": "directory",
    "uid": 0
}

#3.挂载nfs并检查
[root@manager ~]# ansible front -m mount -a 'src=192.168.100.150:/nfsupload/ path=/ans-upload/ fstype=nfs state=mounted'
192.168.100.148 | CHANGED => {
    "ansible_facts": {
        "discovered_interpreter_python": "/usr/libexec/platform-python"
    },
    "backup_file": "",
    "boot": "yes",
    "changed": true,
    "dump": "0",
    "fstab": "/etc/fstab",
    "fstype": "nfs",
    "name": "/ans-upload/",
    "opts": "defaults",
    "passno": "0",
    "src": "192.168.100.150:/nfsupload/"
}
[root@manager ~]# ansible front -a 'df -h /ans-upload'
192.168.100.148 | CHANGED | rc=0 >>
Filesystem                  Size  Used Avail Use% Mounted on
192.168.100.150:/nfsupload   64G  2.3G   62G   4% /ans-upload
[root@manager ~]# ansible front -a 'grep upload /etc/fstab'
192.168.100.148 | CHANGED | rc=0 >>
192.168.100.150:/nfsupload/ /ans-upload/ nfs defaults 0 0

# 4. 卸载nfs并删除fstab
[root@manager ~]# ansible front -m mount -a 'src=192.168.100.150:/nfsupload/ path=/ans-upload/ fstype=nfs state=absent'
192.168.100.148 | CHANGED => {
    "ansible_facts": {
        "discovered_interpreter_python": "/usr/libexec/platform-python"
    },
    "backup_file": "",
    "boot": "yes",
    "changed": true,
    "dump": "0",
    "fstab": "/etc/fstab",
    "fstype": "nfs",
    "name": "/ans-upload/",
    "opts": "defaults",
    "passno": "0",
    "src": "192.168.100.150:/nfsupload/"
}
[root@manager ~]# ansible front -a 'df -h /ans-upload'                                         192.168.100.148 | FAILED | rc=1 >>
df: /ans-upload: No such file or directorynon-zero return code
[root@manager ~]# ansible front -a 'grep upload /etc/fstab'                                    192.168.100.148 | FAILED | rc=1 >>
non-zero return code

4.1.14 cron模块

管理系统的定时任务

# 设置每3分钟定时同步时间
[root@manager ~]# ansible all -m cron -a 'name="sync time" minute="*/3" job="/sbin/ntpdate ntp1.aliyun.com &> /dev/null" state=present'
192.168.100.149 | CHANGED => {
    "ansible_facts": {
        "discovered_interpreter_python": "/usr/libexec/platform-python"
    },
    "changed": true,
    "envs": [],
    "jobs": [
        "sync time"
    ]
}

[root@manager ~]# ansible all -a 'crontab -l'
192.168.100.149 | CHANGED | rc=0 >>
#Ansible: sync time
*/3 * * * * /sbin/ntpdate ntp1.aliyun.com &> /dev/null


#删除
[root@manager ~]# ansible all -m cron -a 'name="sync time" state=absent'                       192.168.100.149 | CHANGED => {
    "ansible_facts": {
        "discovered_interpreter_python": "/usr/libexec/platform-python"
    },
    "changed": true,
    "envs": [],
    "jobs": []
}

[root@manager ~]# ansible all -a 'crontab -l'
192.168.100.149 | CHANGED | rc=0 >>

4.1.15 setup模块

用于收集远程主机的信息，并将这些信息以facts的形式返回给Ansible控制节点。
这些facts可以包括系统变量（如操作系统类型、架构、网络配置、已安装软件包等），并且在Playbook执行期间可以被其他任务使用。

#查看内存
[root@manager ~]# ansible front -m setup -a "filter='*mem*'"
192.168.100.148 | SUCCESS => {
    "ansible_facts": {
        "ansible_memfree_mb": 3028,
        "ansible_memory_mb": {
            "nocache": {
                "free": 3371,
                "used": 269
            },
            "real": {
                "free": 3028,
                "total": 3640,
                "used": 612
            },
            "swap": {
                "cached": 0,
                "free": 4027,
                "total": 4027,
                "used": 0
            }
        },
        "ansible_memtotal_mb": 3640,
        "discovered_interpreter_python": "/usr/libexec/platform-python"
    },
    "changed": false
}

4.1.16 synchronize模块

使用rsync进行文件和目录同步的功能

#将本地的/tmp同步到front组的/tmp
ansible front -m synchronize -a "src=/tmp/ dest=/tmp/"

#完全同步，类似rsync的完全同步
ansible front -m synchronize  -a 'src=/tmp/ dest=/tmp/ delete=yes'

4.1.x 官网

docs.ansible.com