ansible常用 模块介绍

Ansible 功能

• 批量执行远程命令,可以对远程的多台主机同时进行命令的执行
• 批量安装和配置软件服务，可以对远程的多台主机进行自动化的方式配置和管理各种服务
• 编排高级的企业级复杂的IT架构任务, Ansible的Playbook和role可以轻松实现大型的IT复杂架构
• 提供自动化运维工具的开发API, 有很多运维工具,如jumpserver（堡垒机）就是基于 ansible 实现自动化管理功能

1.2 Ansible 特性

• 模块化：调用特定的模块完成特定任务，支持自定义模块，可使用任何编程语言写模块（账号，软件等）
• Paramiko（python对ssh的实现），PyYAML，Jinja2（模板语言）三个关键模块
• 基于Python语言实现
• 部署简单，基于python和SSH(默认已安装)，agentless，无需代理不依赖PKI（无需ssl）
• 安全，基于OpenSSH
• 幂等性：一个任务执行1遍和执行n遍效果一样，不因重复执行带来意外情况,此特性非绝对
• 支持playbook编排任务，YAML格式，编排任务，支持丰富的数据结构 剧本演员要按照 系统按照你规定的方式去执行命令
• 较强大的多层解决方案 role

官网：www.ansible.com/

官方文档：docs.ansible.com/

Ansible 安装

yum 安装

[root@node1 yum.repos.d]#vim CentOS-Base.repo 
#加入 epel源
[epel]
name=gn
baseurl=https://mirrors.aliyun.com/epel/$releasever/x86_64
        https://mirrors.cloud.tencent.com/epel/$releasever/x86_64
        https://mirrors.huaweicloud.com/epel/$releasever/x86_64
        https://mirrors.tuna.tsinghua.edu.cn/epel/$releasever/x86_64
gpgcheck=0

yum install ansible -y
......................省略..................................
已安装:
  ansible.noarch 0:2.9.25-1.el7                     
yum install epel-release.noarch  -y
yum install ansible -y

编译安装

yum -y install python-jinja2 PyYAML python-paramiko python-babel python-crypto
wget https://releases.ansible.com/ansible/ansible-1.5.4.tar.gz
tar xf ansible-1.5.4.tar.gz
cd ansible-1.5.4
python setup.py build
python setup.py install
mkdir /etc/ansible
cp -r examples/* /etc/ansible

ansible 主配置文件

Ansible 的配置文件可以放在多个不同地方,优先级从高到低顺序如下

ANSIBLE_CONFIG #环境变量,注意此项用 ansible --version 看不到,但可以生效
./ansible.cfg   #当前目录下的ansible.cfg
~/.ansible.cfg #当前用户家目录下的.ansible.cfg
/etc/ansible/ansible.cfg  #系统默认配置文件
​
​
​
可以使用 来查看
[root@node1 yum.repos.d]#ansible --version

Ansible 的默认配置文件 /etc/ansible/ansible.cfg ,其中大部分的配置内容无需进行修改

[defaults]
#inventory     = /etc/ansible/hosts 	#主机列表配置文件
#library = /usr/share/my_modules/ 		#库文件存放目录
#remote_tmp = $HOME/.ansible/tmp 		#临时py命令文件存放在远程主机目录
#local_tmp     = $HOME/.ansible/tmp 	#本机的临时命令执行目录
#forks         = 5   					#默认并发数
#sudo_user     = root 					#默认sudo 用户
#ask_sudo_pass = True 					#每次执行ansible命令是否询问ssh密码
#ask_pass     = True   
#remote_port   = 22
#host_key_checking = False     			#检查对应服务器的host_key，建议取消此行注释,实现第一次连接自动信任目标主机
#log_path=/var/log/ansible.log 			#日志文件，建议启用
#module_name = command   		、mod		#默认模块，可以修改为shell模块
[privilege_escalation] 					#普通用户提权配置
#become=True
#become_method=sudo
#become_user=root
#become_ask_pass=False

Ansible相关工具

• /usr/bin/ansible 主程序，临时命令执行工具
• /usr/bin/ansible-doc 查看配置文档，模块功能查看工具,相当于man ansible-doc -l |grep 关键字 具体模块名字
• /usr/bin/ansible-playbook 定制自动化任务，编排剧本工具,相当于脚本
• /usr/bin/ansible-pull 远程执行命令的工具
• /usr/bin/ansible-vault 文件加密工具
• /usr/bin/ansible-console 基于Console界面与用户交互的执行工具
• /usr/bin/ansible-galaxy 下载/上传优秀代码或Roles模块的官网平台

执行临时任务一次性任务

用法

ansible <host-pattern> [-m module_name] [-a args]
命令     主机或者清单中的组 -m 指定模块      -a  执行的任务

选项

--version                   #显示版本
-m module                   #指定模块，默认为command
-v                          #详细过程 -vv -vvv更详细
--list-hosts                #显示主机列表，可简写 --list
-C, --check                 #检查，并不执行
-T, --timeout=TIMEOUT       #执行命令的超时时间，默认10s
-k, --ask-pass              #提示输入ssh连接密码，默认Key验证 
-u, --user=REMOTE_USER      #执行远程执行的用户,默认root
-b, --become                #代替旧版的sudo 切换
--become-user=USERNAME      #指定sudo的runas用户，默认为root  vim /etc/sudoers 用户权限
-K, --ask-become-pass       #提示输入sudo时的口令
-f FORKS, --forks FORKS     #指定并发同时执行ansible任务的主机数

模块

常用模块帮助文档参考

docs.ansible.com/ansible/2.9… docs.ansible.com/ansible/2.9…

docs.ansible.com/ansible/lat… docs.ansible.com/ansible/lat…

Command 模块

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

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

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

shell模块

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

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

修改为默认模块

vim /etc/ansible/
module_name = shell

Script模块

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

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

范例：

[root@node1 ~]#vim test.sh
#!/bin/bash
mkdir kunkun
[root@node1 ~]#ansible web -m script -a '/opt/test.sh'
​

copy模块

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

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

关键字：

src     代表源文件路径
dest    代表文件落地路径
owner   属主
group   属组
mode    代表权限
backup  如果复制时有同名文件会先备份再复制

ansible web -m copy -a "src=/etc/passwd dest=/mnt/ owner=zhangsan mode=700"
#src 是 ansible那台机子的  dest是远程主机的 

ansible web -m copy -a "src=/root/test.sh dest=/mnt/test2.sh   owner=zhangsan  mode=600 backup=yes"
#如目标存在，默认覆盖，此处指定先备份


ansible web -m copy -a "src=/etc dest=/backup"

ansible web -m copy -a "src=/etc/ dest=/backup"


etc  	不加  	/   	连etc  一起复制
etc   	加  		/	   	只复制etc下的文件

Get_url 模块

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

常用参数如下

ansible web -m get_url -a "url=https://nginx.org/download/nginx-1.18.0.tar.gz dest=/opt"
​
wget https://nginx.org/download/nginx-1.18.0.tar.gz
md5sum nginx-1.18.0.tar.gz
ansible web -m get_url -a 'url=https://nginx.org/download/nginx-1.18.0.tar.gz dest=/opt checksum="md5:3ca4a37931e9fa301964b8ce889da8cb"'
​
​
​
url: 下载文件的URL,支持HTTP，HTTPS或FTP协议
dest:下载到目标路径（绝对路径），如果目标是一个目录，就用服务器上面文件的名称，如果目标设置了名称就用目标设置的名称
owner：指定属主
group：指定属组
mode：指定权限
force:如果yes，dest不是目录，将每次下载文件，如果内容改变，替换文件。如果否，则只有在目标不存在时才会下载该文件
​
checksum:对目标文件在下载后计算摘要，以确保其完整性
url_username:用于HTTP基本认证的用户名。对于允许空密码的站点，此参数可以不使用`url_password'
url_password:用于HTTP基本认证的密码。如果未指定`url_username'参数，则不会使用`url_password'参数
validate_certs：如果“no”，SSL证书将不会被验证。适用于自签名证书在私有网站上使用
timeout: URL请求的超时时间,秒为单位
​
​
wget https://nginx.org/download/nginx-1.18.0.tar.gz
​
ansible web -m get_url -a 'url=https://nginx.org/download/nginx-1.18.0.tar.gz dest=/opt'
​
​
​
##可以检测文件是否有问题
[root@node1 ~]#md5sum nginx-1.18.0.tar.gz 
b2d33d24d89b8b1f87ff5d251aa27eb8  nginx-1.8.0.tar.gz
​
​
ansible web -m get_url -a 'url=https://nginx.org/download/nginx-1.18.0.tar.gz dest=/opt checksum="md5:"'
​
#####   checksum 后面不要忘记 加 md5:b2d33d24d89b8b1f87ff5d251aa27eb8  ###
​

2.7.6 Fetch 模块

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

范例：

[root@localhost data]#ansible web -m fetch -a 'src=/etc/passwd dest=/mnt'
# src 是远程的地址  dest 是本机的地址
[root@node1 ~]#ansible web -m fetch -a 'src=/var/log/messages dest=/mnt'
[root@node1 mnt]#tree
.
├── 192.168.91.101
│   └── var
│       └── log
│           └── messages
└── 192.168.91.102
    └── var
        └── log
            └── messages
​
6 directories, 2 files
​

2.7.7 File模块

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

path    指定文件路径
state   文件状态 有：新建(touch) 删除(absent) 文件夹(directory)  连接文件(link)等
src     源文件
mode    权限
owner   属主
group   属组
recurse 递归

范例：

ansible web -m file -a 'path=/mnt/web.txt state=touch owner=zhangsan group=zhangsan mode=755'
#创建空文件
ansible web -m file -a 'path=/mnt/web state=directory'
#新建目录
ansible web -m file -a 'src=/mnt/web path=/opt/web-link state=link'
#新建软连接 path|dest|name   这三个选项都可以使用
ansible web -m file -a 'path=/opt/web-link state=absent'
#删除文件
​
​
ansible all -m file -a "path=/data/mysql state=directory owner=mysql group=mysql"
ansible all -m file -a "path=/data/mysql state=directory owner=mysql group=mysql recurse=yes"
#递归修改目录及子目录的属性

2.7.8 stat模块

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

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

选项

path：文件/对象的完整路径（必须）

常用的返回值判断：

exists： 判断是否存在
isuid： 调用用户的ID与所有者ID是否匹配

ansible web -m stat -a 'path=/mnt/test.txt'
#查看是否存在
192.168.91.102 | SUCCESS => {
    "ansible_facts": {
        "discovered_interpreter_python": "/usr/bin/python"
    }, 
    "changed": false, 
    "gid": 0, 
    "group": "root", 
    "mode": "0755", 
    "owner": "root", 
    "path": "/opt/mysql", 
    "secontext": "unconfined_u:object_r:usr_t:s0", 
    "size": 18, 
    "state": "directory", 
    "uid": 0
}
​

2.7.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：设置解压缩后的文件权限
​
ansible web -m unarchive -a 'src=/data/ky.tar.bz2 dest=/mnt'
​
ansible websrvs -m unarchive -a 'src=https://nginx.org/download/nginx-1.18.0.tar.gz dest=/usr/local/src/ copy=no'
# copy=no  代表压缩文件不是去本机上查找 

Archive模块

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

范例：

ansible web -m archive  -a 'path=/var/log/ dest=/data/log.tar.bz2 format=bz2 owner=wang mode=0600'

Cron 模块

功能：计划任务

支持时间：minute，hour，day，month，weekday

关键字：

name  会生成一行注释，显示标题如下显示
job   执行的命令


ansible 192.168.10.10 -m cron -a 'hour=2 minute=30 weekday=1-5 name="backup mysql" job=/root/mysql_backup.sh'
#创建任务
​
ansible 192.168.10.10 -m cron -a 'hour=2 minute=30 weekday=1-5 name="backup mysql" job=/root/mysql_backup.sh   disabled=yes'
ansible 192.168.10.10 -m cron -a 'hour=2 minute=30 weekday=1-5 name="backup mysql" job=/root/mysql_backup.sh   disabled=no'
​
#删除任务
ansible websrvs -m cron -a "name='backup mysql' state=absent"
ansible websrvs -m cron -a 'state=absent name=Synctime'

Yum和 Apt 模块

功能：yum 管理软件包，只支持RHEL，CentOS，fedora，不支持Ubuntu其它版本apt 模块管理 Debian 相关版本的软件包

关键字：

name参数：                 必须参数，用于指定需要管理的软件包
state参数：                用于指定软件包的状态 ，默认值为。present，表示确保软件包已经安装，除了。present，其他可用值有 installed、                             latest、absent、removed，其中 installed 与present 等效，latest 表示安装 yum 中最新的版本，absent 和                              removed 等效，表示删除对应的软件包。
disable_gpg_check参数：    用于禁用对 rpm 包的公钥 gpg 验证。默认值为 no，表示不禁用验证，设置为 yes 表示禁用验证，即不验证包，直接安装。在                          对应的 yum 源没有开启 gpg 验证的情况下，需要将此参数的值设置为 yes，否则会报错而无法进行安装。
enablerepo参数：           用于指定安装软件包时临时启用的 yum 源。假如你想要从A源中安装软件，但是你不确定A源是否启用了，你可以在安装软件包时                          将此参数的值设置为 yes，即使A源的设置是未启用，也可以在安装软件包时临时启用A源。
disablerepo参数：          用于指定安装软件包时临时禁用的 yum 源。某些场景下需要此参数，比如，当多个 yum 源中同时存在要安装的软件包时，你可                          以使用此参数临时禁用某个源，这样设置后，在安装软件包时则不会从对应的源中选择安装包。
                          enablerepo 参数和 disablerepo 参数可以同时使用
​
​
name             　　所安装的包的名称
state         　　   present--->安装， latest--->安装最新的, absent---> 卸载软件。
update_cache　　     强制更新yum的缓存
conf_file　　        指定远程yum安装时所依赖的配置文件（安装本地已有的包）。
disable_pgp_check　　是否禁止GPG checking，只用于presentor latest。
disablerepo　　      临时禁止使用yum库。 只用于安装或更新时。
enablerepo　　       临时使用的yum库。只用于安装或更新时

范例：

ansible websrvs -m yum -a 'name=httpd state=present'  #安装
ansible websrvs -m yum -a 'name=nginx state=present enablerepo=epel'  #启用epel源
进行安装
ansible websrvs -m yum -a 'name=* state=lastest exclude=kernel*,foo*' #升级除
kernel和foo开头以外的所有包
ansible websrvs -m yum -a 'name=httpd state=absent'   #删除
​
​
​
ansible 192.168.91.101 -m yum -a "name=tree"
​

Service 模块

功能：管理服务

关键字：

name参数：     此参数用于指定需要操作的服务名称，比如 nginx。
state参数：    此参数用于指定服务的状态，比如，我们想要启动远程主机中的 nginx，则可以将 state 的值设置为 started；如果想要停止远程主机中的服务，则可以将 state 的值设置为 stopped。此参数的可用值有 started、stopped、restarted、reloaded。
enabled参数：  此参数用于指定是否将服务设置为开机 启动项，设置为 yes 表示将对应服务设置为开机启动，设置为 no 表示不会开机启动。

管理服务例子：

ansible all -m service -a 'name=httpd state=started enabled=yes'
ansible all -m service -a 'name=httpd state=stopped'
ansible all -m service -a 'name=httpd state=reloaded'
ansible all -m shell -a "sed -i 's/^Listen 80/Listen 8080/' 
/etc/httpd/conf/httpd.conf"
ansible all -m service -a 'name=httpd state=restarted'
​
​
ansible 192.168.10.10 -m service -a 'name=httpd state=started enabled=yes'

mount 挂载和卸载

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

范例

#临时挂载
mount websrvs -m mount -a 'src="UUID=b3e48f45-f933-4c8e-a700-22a159ec9077" path=/home fstype=xfs opts=noatime state=present'
#临时取消挂载
mount websrvs -m mount -a 'path=/home fstype=xfs opts=noatime state=unmounted'
#永久挂载
ansible websrvs -m mount -a 'src=10.0.0.8:/data/wordpress path=/var/www/html/wp-content/uploads opts="_netdev" state=mounted'
#永久卸载
ansible websrvs -m mount -a 'src=10.0.0.8:/data/wordpress path=/var/www/html/wp-content/uploads state=absent'

2.7.17 User 模块

功能：管理用户

comment　　       用户的描述信息
createhome　　    是否创建家目录
force　　         在使用state=absent时, 行为与userdel –force一致.
group　　         指定基本组
groups　　        指定附加组，如果指定为(groups=)表示删除所有组
home　　          指定用户家目录
move_home　　     如果设置为home=时, 试图将用户主目录移动到指定的目录
name　　          指定用户名
non_unique　　    该选项允许改变非唯一的用户ID值
password　　      指定用户密码，使用 SHA512 hash
remove　　        在使用state=absent时, 行为是与userdel –remove一致
shell　　         指定默认shell
state　　         设置帐号状态，不指定为创建，指定值为absent表示删除
system　　        当创建一个用户，设置这个用户是系统用户。这个设置不能更改现有用户
uid　　           指定用户的uid
update_ password 
  always      如果password参数设置的值与用户当前的加密过的密码字符串不一致，则直接更新用户的密码，默认值即为always
  on_create   如果password参数设置的值与用户当前的加密过的密码字符串不一致，则不会更新用户的密码字符串，保持之前的密码设定

范例

#创建用户
ansible all -m user -a 'name=user1 comment="test user" uid=2048 home=/app/user1 group=root‘

2.7.18Group 模块

功能：管理组

范例

#创建组
ansible websrvs -m group  -a 'name=nginx gid=88 system=yes'
#删除组
ansible websrvs -m group  -a 'name=nginx state=absent'

2.7.19reboot模块

[root@ansible ~]#ansible websrvs -m reboot

2.7.20 Lineinfile 模块

ansible在使用sed进行替换时，经常会遇到需要转义的问题，而且ansible在遇到特殊符号进行替换时，存在问题，无法正常进行替换 。其实在ansible自身提供了两个模块：lineinfile模块和replace模块，可以方便的进行替换一般在ansible当中去修改某个文件的单行进行替换的时候需要使用lineinfile模块

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

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

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

关键字：

path            指定要操作的文件
regexp          使用正则表达式匹配对应的行
line            修改为新的内容
insertafter     将文本插入到“指定的行”之后
insertbefore    将文本插入到“指定的行”之前
state           删除对应的文本时，需要state=absent
backrefs        1.支持后向引用、2.当未匹配到内容则不操作文件
backup          是否在修改文件之前对文件进行备份
create          当要操作的文件并不存在时，是否创建对应的文件

范例：

ansible web -m lineinfile -a "path=/etc/httpd/conf/httpd.conf regexp='^Listen' line='Listen 80'"
​
ansible all -m   lineinfile -a "path=/etc/selinux/config regexp='^SELINUX=' line='SELINUX=disabled'"
​
ansible all -m lineinfile  -a 'dest=/etc/fstab state=absent regexp="^#"'

2.7.21replace 模块

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

ansible all -m replace -a "path=/etc/fstab regexp='^(UUID.*)' replace='#\1'"  
​
ansible all -m replace -a "path=/etc/fstab regexp='^#(UUID.*)' replace='\1'"
​
​
ansible web -m replace -a "path=/etc/httpd/conf/httpd.conf regexp='^Listen.*' replace='Listen 80'"

2.7.22 setup模块

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

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

范例：

ansible all -m setup
ansible all -m setup -a "filter=ansible_nodename"
ansible all -m setup -a "filter=ansible_hostname"
ansible all -m setup -a "filter=ansible_domain"
ansible all -m setup -a "filter=ansible_memtotal_mb"
ansible all -m setup -a "filter=ansible_memory_mb"
ansible all -m setup -a "filter=ansible_memfree_mb"
ansible all -m setup -a "filter=ansible_os_family"
ansible all -m setup -a "filter=ansible_distribution_major_version"
ansible all -m setup -a "filter=ansible_distribution_version"
ansible all -m setup -a "filter=ansible_processor_vcpus"
ansible all -m setup -a "filter=ansible_all_ipv4_addresses"
ansible all -m setup -a "filter=ansible_architecture"
ansible all -m setup -a "filter=ansible_uptime_seconds"
ansible all -m setup -a "filter=ansible_processor*"
ansible all -m setup -a 'filter=ansible_env'