Ansible5：經常使用模塊

   根據zs官方的分類，將模塊按功能分類爲：雲模塊、命令模塊、數據庫模塊、文件模塊、資產模塊、消息模塊、監控模塊、網絡模塊、通知模塊、包管理模塊、源碼控制模塊、系統模塊、單元模塊、web設施模塊、windows模塊 ，具體能夠參看官方頁面。

這裏從官方分類的模塊裏選擇最經常使用的一些模塊進行介紹。

1、ping模塊

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

 ansible test -m ping

2、setup模塊

setup模塊，主要用於獲取主機信息，在playbooks裏常常會用到的一個參數gather_facts就與該模塊相關。setup模塊下常用的一個參數是filter參數，具體使用示例以下：

ansible 10.212.52.252 -m setup -a 'filter=ansible_*_mb'   //查看主機內存信息
ansible 10.212.52.252 -m setup -a 'filter=ansible_eth[0-2]'   //查看地接口爲eth0-2的網卡信息
ansible all -m setup --tree /tmp/facts   //將全部主機的信息輸入到/tmp/facts目錄下，每臺主機的信息輸入到主機名文件中（/etc/ansible/hosts裏的主機名）

3、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"

4、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'"

5、service模塊

用於管理服務
該模塊包含以下選項： 

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

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

• name：必選項，服務名稱 

• pattern：定義一個模式，若是經過status指令來查看服務的狀態時，沒有響應，就會經過ps指令在進程中根據該模式進行查找，若是匹配到，則認爲該服務依然在運行

• runlevel：運行級別

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

• state：對當前服務執行啓動，中止、重啓、從新加載等操做（started,stopped,restarted,reloaded）

使用示例：

    ansible test -m service -a "name=httpd state=started enabled=yes"
    asnible test -m service -a "name=foo pattern=/usr/bin/foo state=started"
    ansible test -m service -a "name=network state=restarted args=eth0"

6、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 test -m cron  -a 'backup="True" name="test" minute="0" hour="5,2" job="ls -alh > /dev/null"'
ansilbe test -m cron -a 'cron_file=ansible_yum-autoupdate state=absent'

7、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'

8、user模塊與group模塊

user模塊是請求的是useradd, userdel, usermod三個指令，goup模塊請求的是groupadd, groupdel, groupmod 三個指令。

一、user模塊

• home：指定用戶的家目錄，須要與createhome配合使用

• groups：指定用戶的屬組

• uid：指定用的uid

• password：指定用戶的密碼

• name：指定用戶名

• createhome：是否建立家目錄 yes|no

• system：是否爲系統用戶

• remove：當state=absent時，remove=yes則表示連同家目錄一塊兒刪除，等價於userdel -r

• state：是建立仍是刪除

• shell：指定用戶的shell環境

使用示例：

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
user: name=test generate_ssh_key=yes ssh_key_bits=2048 ssh_key_file=.ssh/id_rsa    #生成密鑰時，只會生成公鑰文件和私鑰文件，和直接使用ssh-keygen指令效果相同，不會生成authorized_keys文件。

注：指定password參數時，不能使用明文密碼，由於後面這一串密碼會被直接傳送到被管理主機的/etc/shadow文件中，因此須要先將密碼字符串進行加密處理。而後將獲得的字符串放到password中便可。

echo "123456" | openssl passwd -1 -salt $(< /dev/urandom tr -dc '[:alnum:]' | head -c 32) -stdin
$1$4P4PlFuE$ur9ObJiT5iHNrb9QnjaIB0
#使用上面的密碼建立用戶
ansible all -m user -a 'name=foo password="$1$4P4PlFuE$ur9ObJiT5iHNrb9QnjaIB0"'

不一樣的發行版默認使用的加密方式可能會有區別，具體能夠查看/etc/login.defs文件確認，centos 6.5版本使用的是SHA512加密算法。

二、group示例

ansible all -m group -a 'name=somegroup state=present'

9、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

10、filesystem模塊

在塊設備上建立文件系統
選項： 

• dev：目標塊設備

• force：在一個已有文件系統 的設備上強制建立

• fstype：文件系統的類型

• opts：傳遞給mkfs命令的選項

示例：

    ansible test -m filesystem -a 'fstype=ext2 dev=/dev/sdb1 force=yes'

    ansible test -m filesystem -a 'fstype=ext4 dev=/dev/sdb1 opts="-cc"'

11、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'

12、get_url 模塊

該模塊主要用於從http、ftp、https服務器上下載文件（相似於wget），主要有以下選項：

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

• timeout：下載超時時間，默認10s

• url：下載的URL

• url_password、url_username：主要用於須要用戶名密碼進行驗證的狀況

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

示例：

 get_url: url=http://example.com/path/file.conf dest=/etc/foo.conf mode=0440
 get_url: url=http://example.com/path/file.conf dest=/etc/foo.conf sha256sum=b5bb9d8014a0f9b1d61e21e796d78dccdf1352f23cd32812f4850b878ae4944c

十3、unarchive模塊

用於解壓文件，模塊包含以下選項：

• copy：在解壓文件以前，是否先將文件複製到遠程主機，默認爲yes。若爲no，則要求目標主機上壓縮包必須存在。

• creates：指定一個文件名，當該文件存在時，則解壓指令不執行

• dest：遠程主機上的一個路徑，即文件解壓的路徑 

• grop：解壓後的目錄或文件的屬組

• list_files：若是爲yes，則會列出壓縮包裏的文件，默認爲no，2.0版本新增的選項

• mode：解決後文件的權限

• src：若是copy爲yes，則須要指定壓縮文件的源路徑 

• owner：解壓後文件或目錄的屬主

示例以下：

- unarchive: src=foo.tgz dest=/var/lib/foo
- unarchive: src=/tmp/foo.zip dest=/usr/local/bin copy=no
- unarchive: src=https://example.com/example.zip dest=/usr/local/bin copy=no

本文出自 「無名小卒」 博客，請務必保留此出處http://breezey.blog.51cto.com/2400275/1555530