ansible的參數及常用模塊
參數:
查看幫助手冊:ansible-doc -a
查指定模塊的幫助:ansible-doc -s 模塊名
ansible-doc -s setup 查看setup模塊的幫助信息
ansible-doc -l
ansible-doc -s file
Options:
-a, --all Show documentation for all modules 顯示所有模塊
-C, --check don't make any changes; instead, try to predict some
檢測並不發生改變,可以預測一些錯誤用於測試使用
-h, --help show this help message and exit 顯示幫助信息並退出
-l, --list List available modules 列出所有可用模塊列表
-M MODULE_PATH, --module-path=MODULE_PATH
specify path(s) to module library (default=None)
指定模塊庫的路徑(默認值=None)
specify path(s) to module library (default=None)
-s, --snippet Show playbook snippet for specified module(s)
顯示指定模塊的playbook(劇本)代碼段
-v, --verbose verbose mode (-vvv for more, -vvvv to enable
connection debugging)
詳細顯示(-vvv 表示更詳細,-vvvv 啓用連接調試)
--version show program's version number and exit
顯示程序的版本號並退出
常用模塊:
1.setup: 查看遠程主機的基本信息
ansible 主機列表名稱 -m setup
-m 指定使用的模塊
主機列表名稱是卸載 /etc/ansible/hosts 文件中的主機列表名稱
或者
ansible 192.168.13.12 -m setup 查看指定ip的主機狀態信息
2. ping: 測試遠程主機的運行狀態
ansible 主機列表名稱 -m ping ping指定的主機列表名稱中的主機
3.file: 設置文件屬性
ansible 主機列表名稱 -m file -a 'src=/etc/hosts dest=/tmp/hosts state=link'
ansible 主機列表名稱 -m file -a 'path=/tmp/hosts state=absent'
ansible 主機列表名稱 -m file -a 'path=/tmp/test state=touch'
-a 模塊參數相當於命令
測試結果:ansible 主機列表名稱 -m shell -a 'ls /tmp/'
選項:
force:需要在兩種情況下強制創建軟鏈接,一種是源文件不存在,但之後會建立的情況下;另一種是目標軟鏈接已存在,需要先取消之前的軟鏈,然後創建新的軟鏈,有兩個選項:yes|no
group:定義文件/目錄的屬組
mode:定義文件/目錄的權限
owner:定義文件/目錄的屬主
path:必選項,定義文件/目錄的路徑
recurse:遞歸設置文件的屬性,只對目錄有效,有兩個選項:yes|no
src:被鏈接的源文件路徑,只應用於state=link的情況
dest:被鏈接到的路徑,只應用於state=link的情況
state:
directory:如果目錄不存在,就創建目錄
file:即使文件不存在,也不會被創建
link:創建軟鏈接
hard:創建硬鏈接
touch:如果文件不存在,則會創建一個新的文件,如果文件或目錄已存在,則更新其最後修改時間
absent:刪除目錄、文件或者取消鏈接文件
4. copy: 把主控端的文件複製到遠程主機
例:
ansible 主機列表名稱 -m copy -a "src=/etc/hosts dest=/opt/hosts.bak owner=tom group=tom mode=0644"
ansible 主機列表名稱 -m copy -a "src=/mine/ntp.conf dest=/etc/ntp.conf owner=root group=root mode=644 backup=yes"
測試結果:ansible 主機列表名稱 -m shell -a 'ls -l /opt'
選項:
backup:在覆蓋之前,將源文件備份,備份文件包含時間信息。有兩個選項:yes|no
content:用於替代“src”,可以直接設定指定文件的值
dest:必選項。要將源文件複製到的遠程主機的絕對路徑,如果源文件是一個目錄,那麼該路徑也必須是個目錄
directory_mode:遞歸設定目錄的權限,默認爲系統默認權限
force:如果目標主機包含該文件,但內容不同,如果設置爲yes,則強制覆蓋,如果爲no,則只有當目標主機的目標位置不存在該文件時,才複製。默認爲yes
others:所有的file模塊裏的選項都可以在這裏使用
src:被複制到遠程主機的本地文件,可以是絕對路徑,也可以是相對路徑。如果路徑是一個目錄,它將遞歸複製。在這種情況下,如果路徑使用“/”來結尾,則只複製目錄裏的內容,如果沒有使用“/”來結尾,則包含目錄在內的整個內容全部複製,類似於rsync
5.service模塊:用於管理服務
例:
ansible 主機列表名稱 -m service -a "name=httpd state=started enabled=yes"
asnible 主機列表名稱 -m service -a "name=foo pattern=/usr/bin/foo state=started"
ansible 主機列表名稱 -m service -a "name=network state=restarted args=eth0"
選項:
arguments:給命令行提供一些選項
enabled:是否開機啓動 yes|no
name:必選項,服務名稱
pattern:定義一個模式,如果通過status指令來查看服務的狀態時,沒有響應,就會通過ps指令在進程中根據該模式進行查找,如果匹配到,則認爲該服務依然在運行
runlevel:運行級別
sleep:如果執行了restarted,在則stop和start之間沉睡幾秒鐘
state:對當前服務執行啓動,停止、重啓、重新加載等操作(started,stopped,restarted,reloaded)
6.cron模塊:用於管理計劃任務
示例:
ansible 主機列表名稱 -m cron -a 'name="a job for reboot" special_time=reboot job="/some/job.sh"'
ansible 主機列表名稱 -m cron -a 'name="yum autoupdate" weekday="2" minute=0 hour=12 user="root
ansible 主機列表名稱 -m cron -a 'backup="True" name="test" minute="0" hour="5,2" job="ls -alh > /dev/null"'
ansilbe 主機列表名稱 -m cron -a 'cron_file=ansible_yum-autoupdate state=absent'
驗證:ansible 主機列表名稱 -m shell -a 'crontab -l'
選項:
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:確認該任務計劃是創建還是刪除(absent)
user:以哪個用戶的身份執行
7.yum模塊:使用yum包管理器來管理軟件包
例:
ansible 主機列表名稱 -m yum -a 'name=httpd state=latest'
ansible 主機列表名稱 -m yum -a 'name="@Development tools" state=present'
ansible 主機列表名稱 -m yum -a 'name=http://nginx.org/packages/centos/6/noarch/RPMS/nginx-release-centos-6-0.el6.ngx.noarch.rpm state=present'
選項:
config_file:yum的配置文件
disable_gpg_check:關閉gpg_check
disablerepo:不啓用某個源
enablerepo:啓用某個源
name:要進行操作的軟件包的名字,也可以傳遞一個url或者一個本地的rpm包的路徑
state:狀態(present or installed or latest,absent or removed)安裝使用present installed latest 刪除使用absent removed
present和installed安裝套件 latest 安裝最新的版本
8.user模塊與group模塊
user模塊是請求的是useradd, userdel, usermod三個指令,goup模塊請求的是groupadd, groupdel, groupmod 三個指令。
(1)、user模塊
home:指定用戶的家目錄,需要與createhome配合使用
groups:指定用戶的屬組
uid:指定用的uid
password:指定用戶的密碼
name:指定用戶名
createhome:是否創建家目錄 yes|no
system:是否爲系統用戶
remove:當state=absent時,remove=yes則表示連同家目錄一起刪除,等價於userdel -r
state:是創建還是刪除
shell:指定用戶的shell環境
expires參數:此參數用於指定用戶的過期時間例如設置expires=1546185600 時,就是使用命令 date -d 2018-12-31 +%s 獲取到的值
表示用戶的過期時間爲2018年12月31日0點0分,目前此參數只支持在 Linux 和 FreeBSD 系統中使用。
例:
ansible 主機列表名稱 -m user -a 'name=johnd comment="John Doe" uid=1040 group=admin'
ansible 主機列表名稱 -m user -a 'name=james shell=/bin/sh groups=adm,lp append=yes'
ansible 主機列表名稱 -m user -a 'name=johnd state=absent remove=yes'
ansible 主機列表名稱 -m user -a 'name=james18 shell=/bin/zsh groups=developers expires=1422403387'
(2)、group示例
ansible all -m group -a 'name=somegroup state=present'
all 表示列表裏的所有主機
9. shell: shell命令
ansible默認使用的模塊是command,支持多數shell命令,但不支持shell變量及管道,如果要使用需要使用shell模塊
用shell模塊給用戶設置登錄密碼:
ansible all -m shell -a 'echo 01 | passwd --stdin james'