ansible常用模組簡單介紹

本篇介紹下常用的模組。根據官方的分類，將模組按功能分類為：雲模組、命令模組、資料庫模組、檔案模組、資產模組、訊息模組、監控模組、網路模組、通知模組、包管理模組、原始碼控制模組、系統模組、單元模組、web設施模組、windows模組 ，具體可以參看官方頁面。這裡從官方分類的模組裡選擇最常用的一些模組進行介紹（commands模組上一篇已經介紹，這裡不再提）。

一、ping模組

測試主機是否是通的，用法很簡單，不涉及引數：

[root@361way ~]# ansible 10.212.52.252 -m ping
10.212.52.252 | success >> {
"changed": false,
"ping": "pong"
}

二、setup模組

setup模組，主要用於獲取主機資訊，在playbooks裡經常會用到的一個引數gather_facts就與該模組相關。setup模組下經常使用的一個引數是filter引數，具體使用示例如下（由於輸出結果較多，這裡只列命令不寫結果）：

[root@361way ~]# ansible 10.212.52.252 -m setup -a 'filter=ansible_*_mb' 
//檢視主機記憶體資訊
[root@361way ~]# ansible 10.212.52.252 -m setup -a 'filter=ansible_eth[0-2]' 
//檢視地介面為eth0-2的網絡卡資訊
[root@361way ~]# ansible all -m setup --tree /tmp/facts 
//將所有主機的資訊輸入到/tmp/facts目錄下，每臺主機的資訊輸入到主機名檔案中
（/etc/ansible/hosts裡的主機名）

三、file模組

file模組主要用於遠端主機上的檔案操作，file模組包含如下選項：

force：需要在兩種情況下強制建立軟連結，一種是源檔案不存在但之後會建立的情況下；另一種是標的軟連結已存在,需要先取消之前的軟鏈，然後建立新的軟鏈，有兩個選項：yes|no

• group：定義檔案/目錄的屬組

• mode：定義檔案/目錄的許可權

• owner：定義檔案/目錄的屬主

• path：必選項，定義檔案/目錄的路徑

• recurse：遞迴的設定檔案的屬性，只對目錄有效

• src：要被連結的源檔案的路徑，只應用於state=link的情況

• dest：被連結到的路徑，只應用於state=link的情況

• state：  directory：如果目錄不存在，建立目錄

• file：即使檔案不存在，也不會被建立

• link：建立軟連結

• hard：建立硬連結

• touch：如果檔案不存在，則會建立一個新的檔案，如果檔案或目錄已存在，則更新其最後修改時間

• absent：刪除目錄、檔案或者取消連結檔案

使用示例：

ansible test -m file -a "src=/etc/fstab dest=/tmp/fstab state=link"
ansible test -m file -a "path=/tmp/fstab state=absent"
ansible test -m file -a "path=/tmp/test state=touch"

四、copy模組

複製檔案到遠端主機，copy模組包含如下選項：

• backup：在改寫之前將原檔案備份，備份檔案包含時間資訊。有兩個選項：yes|no

• content：用於替代”src”,可以直接設定指定檔案的值

• dest：必選項。要將源檔案複製到的遠端主機的絕對路徑，如果源檔案是一個目錄，那麼該路徑也必須是個目錄

• directory_mode：遞迴的設定目錄的許可權，預設為系統預設許可權

• force：如果標的主機包含該檔案，但內容不同，如果設定為yes，則強制改寫，如果為no，則只有當標的主機的標的位置不存在該檔案時，才複製。預設為yes

• others：所有的file模組裡的選項都可以在這裡使用

• src：要複製到遠端主機的檔案在本地的地址，可以是絕對路徑，也可以是相對路徑。如果路徑是一個目錄，它將遞迴複製。在這種情況下，如果路徑使用”/”來結尾，則只複製目錄裡的內容，如果沒有使用”/”來結尾，則包含目錄在內的整個內容全部複製，類似於rsync。

• validate ：The validation command to run before copying into place. The path to the file to validate is passed in via ‘%s’ which must be present as in the visudo example below.

示例如下：

ansible test -m copy -a "src=/srv/myfiles/foo.conf dest=/etc/foo.conf owner=foo group=foo mode=0644"
ansible test -m copy -a "src=/mine/ntp.conf dest=/etc/ntp.conf owner=root group=root mode=644 backup=yes"
ansible test -m copy -a "src=/mine/sudoers dest=/etc/sudoers validate='visudo -cf %s'"

五、service模組

用於管理服務
該模組包含如下選項：

• arguments：給命令列提供一些選項

• enabled：是否開機啟動 yes|no

• name：必選項，服務名稱

• pattern：定義一個樣式，如果透過status指令來檢視服務的狀態時，沒有響應，就會透過ps指令在行程中根據該樣式進行查詢，如果匹配到，則認為該服務依然在執行

• runlevel：執行級別

• sleep：如果執行了restarted，在則stop和start之間沉睡幾秒鐘

• state：對當前服務執行啟動，停止、重啟、重新載入等操作（started,stopped,restarted,reloaded）

使用示例：

# Example action to reload service httpd, in all cases
- service: name=httpd state=reloaded
# Example action to enable service httpd, and not touch the running state
- service: name=httpd enabled=yes
# Example action to start service foo, based on running process /usr/bin/foo
- service: name=foo pattern=/usr/bin/foo state=started
# Example action to restart network service for interface eth0
- service: name=network state=restarted args=eth0

六、cron模組

用於管理計劃任務
包含如下選項：

• backup：對遠端主機上的原任務計劃內容修改之前做備份

• cron_file：如果指定該選項，則用該檔案替換遠端主機上的cron.d目錄下的使用者的任務計劃

• day：日（1-31，，/2,……）

• hour：小時（0-23，，/2，……）

• minute：分鐘（0-59，，/2，……）

• month：月（1-12，，/2，……）

• weekday：周（0-7，*，……）

• job：要執行的任務，依賴於state=present

• name：該任務的描述

• special_time：指定什麼時候執行，引數： reboot,yearly,annually,monthly,weekly,daily,hourly

• state：確認該任務計劃是建立還是刪除

• user：以哪個使用者的身份執行

示例：

ansible test -m cron -a 'name="a job for reboot" special_time=reboot job="/some/job.sh"'
ansible test -m cron -a 'name="yum autoupdate" weekday="2" minute=0 hour=12 user="root
ansible 10.212.52.252 -m cron -a 'backup="True" name="test" minute="0" hour="2" job="ls -alh > /dev/null"'
ansilbe test -m cron -a 'cron_file=ansible_yum-autoupdate state=absent'

七、yum模組

使用yum包管理器來管理軟體包，其選項有：

• config_file：yum的配置檔案

• disable_gpg_check：關閉gpg_check

• disablerepo：不啟用某個源

• enablerepo：啟用某個源

• name：要進行操作的軟體包的名字，也可以傳遞一個url或者一個本地的rpm包的路徑

• state：狀態（present，absent，latest）

示例如下：

ansible test -m yum -a 'name=httpd state=latest'
ansible test -m yum -a 'name="@Development tools" state=present'
ansible test -m yum -a 'name=http://nginx.org/packages/centos/6/noarch/RPMS/
nginx-release-centos-6-0.el6.ngx.noarch.rpm state=present'

八、user模組與group模組

user模組是請求的是useradd, userdel, usermod三個指令，goup模組請求的是groupadd, groupdel, groupmod 三個指令，具體引數這裡不再細講，直接上示例。
1、user模組示例：

- user: name=johnd comment="John Doe" uid=1040 group=admin
- user: name=james shell=/bin/bash groups=admins,developers append=yes
- user: name=johnd state=absent remove=yes
- user: name=james18 shell=/bin/zsh groups=developers expires=1422403387
#生成金鑰時，只會生成公鑰檔案和私鑰檔案，和直接使用ssh-keygen指令效果相同，
不會生成authorized_keys檔案。
- user: name=test generate_ssh_key=yes ssh_key_bits=2048 ssh_key_file=.ssh/id_rsa

註：指定password引數時，不能使用後面這一串密碼會被直接傳送到被管理主機的/etc/shadow檔案中，所以需要先將密碼字串進行加密處理。然後將得到的字串放到password中即可。

[root@361way ~]# openssl passwd -1 -salt $(< /dev/urandom tr -dc '[:alnum:]' | head -c 32)
Password:
$1$YngB4z8s$atSVltYKnDxJmWZ3s.4/80
或者
[root@361way ~]# echo "123456" | openssl passwd -1 -salt $(< /dev/urandom tr -dc '[:alnum:]'
 | head -c 32) -stdin
$1$4P4PlFuE$ur9ObJiT5iHNrb9QnjaIB0
#經驗證下麵生成的密碼串也可以正常使用，不過與/etc/shadow的格式不統一，不建議使用
[root@361way ~]# openssl passwd -salt -1 "123456"
-1yEWqqJQLC66
#使用上面的密碼建立使用者
[root@361way ~]#ansible all -m user -a 'name=foo password="$1$4P4PlFuE$ur9ObJiT5iHNrb9QnjaIB0"'

不同的發行版預設使用的加密方式可能會有區別，具體可以檢視/etc/login.defs檔案確認，centos 6.5版本使用的是SHA512加密演演算法，生成密碼可以透過ansible官方給出的示例：

python -c "from passlib.hash import sha512_crypt;
import getpass; 
print sha512_crypt.encrypt
(getpass.getpass())"

2、group示例

- group: name=somegroup state=present

九、synchronize模組

使用rsync同步檔案，其引數如下：

• archive: 歸檔，相當於同時開啟recursive(遞迴)、links、perms、times、owner、group、-D選項都為yes ，預設該項為開啟

• checksum: 跳過檢測sum值，預設關閉

• compress:是否開啟壓縮

• copy_links：複製連結檔案，預設為no ，註意後面還有一個links引數

• delete: 刪除不存在的檔案，預設no

• dest：目錄路徑

• dest_port：預設目錄主機上的埠 ，預設是22，走的ssh協議

• dirs：傳速目錄不進行遞迴，預設為no，即進行目錄遞迴

• rsync_opts：rsync引數部分

• set_remote_user：主要用於/etc/ansible/hosts中定義或預設使用的使用者-與rsync使用的使用者不同的情況

• mode: push或pull 模組，push模的話，一般用於從本機向遠端主機上傳檔案，

• pull 樣式用於從遠端主機上取檔案

另外還有其他引數，這裡不再一一說明。上幾個用法：

src=some/relative/path dest=/some/absolute/path rsync_path="sudo rsync"
src=some/relative/path dest=/some/absolute/path archive=no links=yes
src=some/relative/path dest=/some/absolute/path checksum=yes times=no
src=/tmp/helloworld dest=/var/www/helloword rsync_opts=--no-motd,--exclude=.git mode=pull

十、mount模組

配置掛載點
選項：

• dump

• fstype：必選項，掛載檔案的型別

• name：必選項，掛載點

• opts：傳遞給mount命令的引數

• src：必選項，要掛載的檔案

• state：必選項present：只處理fstab中的配置

• absent：刪除掛載點

• mounted：自動建立掛載點並掛載之’

• umounted：解除安裝

示例：

name=/mnt/dvd src=/dev/sr0 fstype=iso9660 opts=ro state=present
name=/srv/disk src='LABEL=SOME_LABEL' state=present
name=/home src='UUID=b3e48f45-f933-4c8e-a700-22a159ec9077' opts=noatime state=present
ansible test -a 'dd if=/dev/zero of=/disk.img bs=4k count=1024'
ansible test -a 'losetup /dev/loop0 /disk.img'
ansible test -m filesystem 'fstype=ext4 force=yes opts=-F dev=/dev/loop0'
ansible test -m mount 'name=/mnt src=/dev/loop0 fstype=ext4 state=mounted opts=rw'

十一、get_url 模組

該模組主要用於從http、ftp、https伺服器上下載檔案（類似於wget），主要有如下選項：

• sha256sum：下載完成後進行sha256 check；

• timeout：下載超時時間，預設10s

• url：下載的URL

• url_password、url_username：主要用於需要使用者名稱密碼進行驗證的情況

• use_proxy：是事使用代理，代理需事先在環境變更中定義

示例：

- name: download foo.conf
get_url: url=http://example.com/path/file.conf dest=/etc/foo.conf mode=0440
- name: download file with sha256 check
get_url: url=http://example.com/path/file.conf dest=/etc/foo.conf sha256sum=b5bb9d8014a0f9b1d61e21e796d78dccdf1352f23cd32812f4850b878ae4944c

模組部分就先介紹到這裡吧，官方提供的可能用到模組有git、svn版本控制模組，sysctl 、authorized_key_module系統模組，apt、zypper、pip、gem包管理模組，find、template檔案模組，mysql_db、redis資料庫模組，url 網路模組等。具體可以參看官方手冊模組部分;