登录
目录
当前位置： 首页 > 文档资料 > Ansible 入门 >

Ansible模块Module - 常用几个module的用法

优质
小牛编辑
130浏览
2023-12-01

学习Linux操作系统，如果不能一些基本的命令，那么真的没有办法用Linux。所以学习Ansible也非常有必要了解一些常用的module。

接下来介绍一些会在接下来的章节中用到的module，也是很常用的module。

调试和测试类的module

  • ping - ping一下你的远程主机，如果可以通过ansible成功连接，那么返回pong
  • debug - 用于调试的module，只是简单打印一些消息，有点像linux的echo命令。

文件类的module

  • copy - 从本地拷贝文件到远程节点
  • template - 从本地拷贝文件到远程节点，并进行变量的替换
  • file - 设置文件的属性

linux上常用的操作

  • user - 管理用户账户
  • yum - red hat系linux上的包管理
  • service - 管理服务
  • firewalld - 管理防火墙中的服务和端口

执行Shell命令

  • shell - 在节点上执行shell命令，支持$HOME和”<”, “>”, “|”, “;” and “&”
  • command - 在远程节点上面执行命令，不支持$HOME和”<”, “>”, “|”, “;” and “&”

ping

这个就最常用的测试一个节点有没有配置好ssh连接的module。不过它可不是简单像linux命令中ping一下远程节点，而是首先检查下能不能SSH登陆，然后再检查下远程节点的python版本漫不满足要求，如果都满足则会返回成功pong。

ping不需要传入任何参数。因为ping是测试节点连接是不是通的，所以一般在命令行中使用的时候比在playbook的脚本中多，下面是ping在命令行中的用法：

  1. ansible servers -m ping

debug

打印输出信息，和linux上的echo命令很像

通过参数msg定义打印的字符串

msg中可以嵌入变量,下面的例子中注入了系统变量，ansible在执行playbook之前会收集一些比较常用的系统变量，你在playbook中不需要定义直接就可以使用。

  1. - debug:
  2.     msg: "System {{ inventory_hostname }} has gateway {{ ansible_default_ipv4.gateway }}"

执行结果

  1. TASK [debug] *******************************************************************
  2. ok: [localhost] => {
  3.     "msg": "System localhost has gateway 192.168.50.1"
  4. }

通过参数var定义需要打印的变量

变量可以是系统变量，也可以是动态的执行结果，通过关键字regester注入到变量中。

  • 打印系统的变量

    1. - name: Display all variables/facts known for a host
    2.   debug:
    3.     var: hostvars[inventory_hostname]["ansible_default_ipv4"]["gateway"]

    执行结果：

  1.   TASK [Display part of variables/facts known for a host] ************************
  2.   ok: [localhost] => {
  3.       "hostvars[inventory_hostname]["ansible_default_ipv4"]["gateway"]": "192.168.50.1"
  4.   }
  • 打印动态注入的变量
  1.   - shell: /usr/bin/uptime
  2.     register: result
  4.   - debug:
  5.       var: result

执行结果

  1.   TASK [command] *****************************************************************
  2.   changed: [localhost]
  4.   TASK [debug] *******************************************************************
  5.   ok: [localhost] => {
  6.       "result": {
  7.           "changed": true,
  9.           "cmd": "/usr/bin/uptime",
  10.           "delta": "0:00:00.003212",
  11.           "end": "2017-01-01 21:30:02.817443",
  12.           "rc": 0,
  13.           "start": "2017-01-01 21:30:02.814231",
  14.           "stderr": "",
  15.           "stdout": " 21:30:02 up 12:38,  8 users,  load average: 1.13, 1.31, 1.14",
  16.           "stdout_lines": [
  17.               " 21:30:02 up 12:38,  8 users,  load average: 1.13, 1.31, 1.14"
  18.           ],
  19.           "warnings": []
  20.       }
  21.   }

copy

从当前的机器上copy静态文件到远程节点上，并且设置合理的文件权限。注意，copy module拷贝文件的时候，会先比较下文件的checksum，如果相同则不会拷贝，返回状态OK；如果不同才会拷贝，返回状态为changed。

设置文件权限

利用mode设置权限可以是用数字，当然也可以是符号的形式”u=rw,g=r,o=r”和”u+rw,g-wx,o-rwx”

  1. - copy:
  2.     src: /srv/myfiles/foo.conf
  3.     dest: /etc/foo.conf
  4.     owner: foo
  5.     group: foo
  6.     mode: 0644

备份结点上原来的文件

backup参数为yes的时候，如果发生了拷贝操作，那么会先备份下目标节点山的原文件。当两个文件相同时，不会进行拷贝操作，当然也没有必要备份啦。

  1. - copy:
  2.     src: sudoers
  3.     dest: /tmp
  4.     backup: yes

拷贝后的验证操作

validate参数接需要验证的命令。一般需要验证拷贝后的文件，所以%s可以指代拷贝后的文件。当copy module中加入了validate参数，不仅需要成功拷贝文件，还需要validate命令返回成功的状态，整个module的执行状态才是成功。

visudo -cf /etc/sudoers是验证sudoers文件有没有语法错误的命令。

  1. - copy:
  2.     src: /mine/sudoers
  3.     dest: /etc/sudoers
  4.     validate: 'visudo -cf %s'

template

如果你需要拷贝一个静态的文件，那么用copy module就够用了。但是如果你需要拷贝一个文件，并且根据需要部分内容，那么就需要用到template module啦。

比如安装apache后，你需要给节点拷贝一个测试页面index.html,index.html里面需要显示当前节点的主机名和IP,这时候就需要用到template。

index.html中，你需要指定你想替换的哪个部分，那么这个部分用变量来表示，template使用的是python的j2模版引擎，你不需要了解什么是j2，你只需要知道表量的表示法是{{}}就可以了。

template文件语法

index.html具体应该怎么写呢，既然是tamplate文件，那么我们就加一个后缀提高可读性，index.html.j2。下面文件中使用了两个变量ansible_hostname和ansible_default_ipv4.address。

  1. <html>
  2. <title>Demo</title>
  3. <body>
  4. <div class="block" style="height: 99%;">
  5.     <div class="centered">
  6.         <h1>#46 Demo</h1>
  7.         <p>Served by {{ ansible_hostname }} ({{ ansible_default_ipv4.address }}).</p>
  8.     </div>
  9. </div>
  10. </body>
  11. </html>

使用facts变量的template

在index.html.j2使用的两个变量ansible_hostname和ansible_default_ipv4.address都是facts变量，ansible会替我们搜索，直接可以在playbook中使用，当然也可以直接在template中使用。所以我们在写template语句中无需传入参数。

  1. - name: Write the default index.html file
  2.   template: src=templates/index.html.j2 dest=/var/www/html/index.html

使用普通变量的template

拷贝httpd.conf.j2拷贝到远程节点，根据需求设置默认的http端口，这时我们就需要用到普通的变量。

在httpd.conf.j2模版文件中，所有变量的是用方法都是一样的，都是是用{{}}:

  1. ServerRoot "/etc/httpd"
  2. ...
  3. Listen {{ http_port }}
  4. ...

普通变量不是在调用template的时候传进去，而是通过playbook中vars关键字定义。当然如果在playbook中可以直接使用的变量，都可以在template中，包括后面的章节会提到的定义在inventory中的变量。

  1. - hosts: localhost
  2.   vars:
  3.     http_port: 8080
  4.   remote_user: root
  5.   tasks:
  7.   - name: Write the configuration file
  8.     template: src=templates/httpd.conf.j2 dest=/etc/httpd/conf/httpd.conf

和copy module一样强大的功能

当然copy module不仅可以简单的拷贝文件到远程节点，还可以进行权限设置，文件备份，以及验证功能，那么这些功能，template同样具备。

  1. - template:
  2.     src: etc/ssh/sshd_config.j2
  3.     dest: /etc/ssh/sshd_config.j2
  4.     owner: root
  5.     group: root
  6.     mode: '0600'
  7.     validate: /usr/sbin/sshd -t %s
  8.     backup: yes

file

file module设置远程值机上的文件、软链接（symlinks）和文件夹的权限，也可以用来创建和删除他们。

改变文件的权限

当然mode参数可以直接赋值数字权限（必须以0开头），也可以赋值，还可以用来增加和删除权限。具体的写法见下面的代码：

  1. - file:
  2.     path: /etc/foo.conf
  3.     owner: foo
  4.     group: foo
  5.     mode: 0644
  6.     #mode: "u=rw,g=r,o=r"
  7.     #mode: "u+rw,g-wx,o-rwx"

创建文件的软链接

注意这里面的src和sest参数的含义是和copy module不一样的，file module里面所操作的文件都是远程节点上的文件。

  1. - file:
  2.     src: /file/to/link/to
  3.     dest: /path/to/symlink
  4.     owner: foo
  5.     group: foo
  6.     state: link

创建一个新文件

像touch命令一样创建一个新文件

  1. - file:
  2.     path: /etc/foo.conf
  3.     state: touch
  4.     mode: "u=rw,g=r,o=r"

创建新的文件夹

  1. # create a directory if it doesn't exist
  2. - file:
  3.     path: /etc/some_directory
  4.     state: directory
  5.     mode: 0755

user

user module可以增、删、改Linux远程节点的用户账户，并为其设置账户的属性。

增加账户

  • 增加账户johnd，并且设置uid为1040，设置用户的primary group为admin

    1. - user:
    2.     name: johnd
    3.     comment: "John Doe"
    4.     uid: 1040
    5.     group: admin

  • 创建账户james，并为james用户额外添加两个group

    1. - user:
    2.     name: james
    3.     shell: /bin/bash
    4.     groups: admins,developers
    5.     append: yes

删除账户

删除账户johnd

  1. - user:
  2.     name: johnd
  3.     state: absent
  4.     remove: yes

修改账户的属性

  • 为账户jsmith撞见一个 2048-bit的SSH key，放在~jsmith/.ssh/id_rsa

    1. - user:
    2.     name: jsmith
    3.     generate_ssh_key: yes
    4.     ssh_key_bits: 2048
    5.     ssh_key_file: .ssh/id_rsa

  • 为用户添加过期时间：

    1. - user:
    2.     name: james18
    3.     shell: /bin/zsh
    4.     groups: developers
    5.     expires: 1422403387

yum

yum module是用来管理red hat系的Linux上的安装包的，包括RHEL，CentOS，和fedora 21一下的版本。fedora从版本22开始就使用dnf，推荐使用dnf module来进行安装包的操作。

从yum源上安装和删除包

  • 安装最新版本的包，如果已经安装了老版本，那么会更新到最新的版本：

    1. - name: install the latest version of Apache
    2.   yum:
    3.     name: httpd
    4.     state: latest

  • 安装指定版本的包

    1. - name: install one specific version of Apache
    2.   yum:
    3.     name: httpd-2.2.29-1.4.amzn1
    4.     state: present

  • 删除httpd包

    1. - name: remove the Apache package
    2.   yum:
    3.     name: httpd
    4.     state: absent

  • 从指定的repo testing中安装包

    1. - name: install the latest version of Apache from the testing repo
    2.   yum:
    3.     name: httpd
    4.     enablerepo: testing
    5.     state: present

从yum源上安装一组包

  1. - name: install the 'Development tools' package group
  2.   yum:
  3.     name: "@Development tools"
  4.     state: present
  6. - name: install the 'Gnome desktop' environment group
  7.   yum:
  8.     name: "@^gnome-desktop-environment"
  9.     state: present

从本地文件中安装包

  1. - name: install nginx rpm from a local file
  2.   yum:
  3.     name: /usr/local/src/nginx-release-centos-6-0.el6.ngx.noarch.rpm
  4.     state: present

从URL中安装包

  1. - name: install the nginx rpm from a remote repo
  2.   yum:
  3.     name: http://nginx.org/packages/centos/6/noarch/RPMS/nginx-release-centos-6-0.el6.ngx.noarch.rpm
  4.     state: present

service

管理远程节点上的服务，什么是服务呢，比如httpd、sshd、nfs、crond等。

开、关、重起、重载服务

  • 开httpd服务

    1. - service:
    2.     name: httpd
    3.     state: started

  • 关服务

    1. - service:
    2.     name: httpd
    3.     state: stopped

  • 重起服务

    1. - service:
    2.     name: httpd
    3.     state: restarted

  • 重载服务

    1. - service:
    2.     name: httpd
    3.     state: reloaded

设置开机启动的服务

  1. - service:
  2.     name: httpd
  3.     enabled: yes

启动网络服务下的接口

  1. - service:
  2.     name: network
  3.     state: restarted
  4.     args: eth0

firewalld

firewalld module为某服务和端口添加firewalld规则。firewalld中有正在运行的规则，和永久的规则，firewalld module都支持。

firewalld要求远程节点上的firewalld版本在0.2.11以上。

为服务添加firewalld规则

  1. - firewalld:
  2.     service: https
  3.     permanent: true
  4.     state: enabled
  1. - firewalld:
  2.     zone: dmz
  3.     service: http
  4.     permanent: true
  5.     state: enabled

为端口号添加firewalld规则

  1. - firewalld:
  2.     port: 8081/tcp
  3.     permanent: true
  4.     state: disabled
  1. - firewalld:
  2.     port: 161-162/udp
  3.     permanent: true
  4.     state: enabled

其它复杂的firewalld规则

  1. - firewalld:
  2.     rich_rule: 'rule service name="ftp" audit limit value="1/m" accept'
  3.     permanent: true
  4.     state: enabled
  1. - firewalld:
  2.     source: 192.0.2.0/24
  3.     zone: internal
  4.     state: enabled
  1. - firewalld:
  2.     zone: trusted
  3.     interface: eth2
  4.     permanent: true
  5.     state: enabled
  1. - firewalld:
  2.     masquerade: yes
  3.     state: enabled
  4.     permanent: true
  5.     zone: dmz

shell

通过/bin/sh在远程节点上执行命令。如果一个操作你可以通过Module yum，copy操作实现，那么你不要使用shell或者command这样通用的命令module。因为通用的命令module不会根据具体操作的特点进行status的判断，所以当没有必要再重新执行的时候，它还是要重新执行一遍。

支持$home，支持$HOME和”<”, “>”, “|”, “;” and “&”。

  • 支持$home
    1. - name: test $home
    2.   shell: echo "Test1" > ~/tmp/test1

  • 支持&&

    1. - shell: service jboss start && chkconfig jboss on

  • 支持>>

    1. - shell: echo foo >> /tmp/testfoo

调用脚本

  • 调用脚本

    1. - shell: somescript.sh >> somelog.txt

  • 执行命令前，改变工作目录

    1. - shell: somescript.sh >> somelog.txt
    2.   args:
    3.     chdir: somedir/

  • 在执行命令钱改变工作目录，并且在文件somelog.txt不存在时执行命令。

    1. - shell: somescript.sh >> somelog.txt
    2.   args:
    3.     chdir: somedir/
    4.     creates: somelog.txt

  • 指定用bash运行命令

    1. - shell: cat < /tmp/*txt
    2.   args:
    3.     executable: /bin/bash

Command

在远程节点上执行命令。和Shell Module类似，不过不支持$HOME and operations like “<”, “>”, “|”, “;” and “&”。

和Shell一样

  • 像Shell一样调用单条命令

    1. - command: /sbin/shutdown -t now

  • 和Shell一样，可以在执行命令钱改变目录，并检查文件database不存在时再执行

    1. - command: /usr/bin/make_database.sh arg1 arg2
    2.   args:
    3.     chdir: somedir/
    4.     creates: /path/to/database

和Shell不一样

  • 与Shell不同，多了一个传参方式：
    1. - command: /usr/bin/make_database.sh arg1 arg2 creates=/path/to/database

  • 不支持&&和>>

    下面的写法，没有办法创建~/tmp/test3和~/tmp/test4的

    1. - name: test $home
    2.   command: echo "test3" > ~/tmp/test3 && echo "test4" > ~/tmp/test4
免责声明： 以上内容版权归原作者所有，如有侵犯您的原创版权请告知，我们将尽快删除相关内容。感谢每一位辛勤著写的作者，感谢每一位的分享。
@小牛知识库 xnip.cn