Saltstack常用模块及API(4)

2331

Saltstack提供了非常丰富的功能模块(用python所写)，涉及操作系统的基础功能、常用工具支持等，当然也可以通过sys模块列出当前版本支持的模块#salt '*' sys.list_modules

    接下来抽取常见的模块进行介绍，同时也会列举模块的API使用方法。API的原理是通过调用master client模块，实例化一个LocalClient对象，再调用cmda()方法来实现的。以下是API实现test.ping的示例：
import salt.client
client = salt.client.LocalClient()
ret = client.cmd('*','test.ping')
print ret

结果以一个标准的Python字典形式的字符串返回，可以通过eval()函数转换成Python的字典类型，方便后续的业务逻辑处理，程序运行结果如下：
{'SN2013-08-022':True,'SN2013-08-021':True}

(1)Archive模块
功能:实现系统层面的压缩包调用，支持gunzip、gzip、rar、tar、unrar、unzip等
示例:
salt '*' archive.gunzip /tmp/sourcefile.txt.gz    采用gunzip解压/tmp/sourcefile.txt.gz包
salt '*' archive.gzip /tmp/sourcefile.txt       采用gzip压缩/tmp/sourcefile.txt文件
API调用原理：
client.cmd('*','archive.gunzip',['/tmp/sourcefile.txt.gz'])

(2)cmd模块

功能:实现远程的命令行执行

示例:

salt '*' cmd.run "free -m"           获取所有主机内存情况

salt '*' cmd.script salt://script/test     该命令会做两个动作：首先同步test.sh到minion的cache目录(/var/cache/salt/minion/files/base/script/test.sh);其次运行该脚本

API调用原理：

client.cmd('SN2013-08-021','cmd.run',['free -m'])

(3)cp模块

功能:实现远程文件、目录复制、以及下载URL文件等操作

示例:

salt '*' cp.cache_local_file /etc/hosts     将指定minion的/etc/hosts文件复制到minion主机的本地的salt cache目录(/var/cache/salt/minion/localfiles/)

salt '*' cp.get_dir salt://path/to/dir/ /minion/dest    将master的file_roots指定位置下的目录复制到minion上

salt '*' cp.get_url http://www.slashdot.org /tmp/index.html    下载URL内容到minion的指定位置

API调用原理：

clientcmd('SN2013-08-021', 'cp.get_file',['salt://path/to/file','/minion/dest'])

(4)cron模块

功能:实现minion的crontab操作

示例:

salt 'SN2013-08-022' cron.raw_cron root    查看指定minion、root用户的crontab清单

salt 'SN2013-08-022' cron.set_job root '*' '*' '*' '*' 1 /usr/local/weekly    为指定minion、root用户添加作业任务

salt 'SN2013-08-022' cron.rm_job root /usr/local/weekly    删除minion、root用户的crontab的/usr/local/weekly任务作业

API调用原理：

client.cmd('SN2013-08-022', 'cron.set_job',['root,'*','*','*','*','*','/usr/echo'])

(5)dnsutil模块

功能:实现minion主机通用DNS相关操作

示例:

salt '*' dnsutil.hosts_append /etc/hosts 127.0.0.1 ad1.yuk.com,ad2.yuk.com    添加hosts主机配置项

salt '*' dnsutil.hosts_remove /etc/hosts ad1.yuk.com    删除hosts主机配置项

API调用原理：

client.cmd('*','dnsutil.hosts_append',['/etc/hosts','127.0.0.1','ad1.yuk.com'])

(6)file模块

功能:实现minion主机文件常见操作，包括文件读写，权限，查找，校验等

示例:

salt '*' file.check_hash /etc/fstab md5=3498723948716623dc38328f    检测文件MD5

salt '*' file.get_sum /etc/passwd     校验所有minion主机文件的加密信息，支持md5、sha1、sha224、sha256、sha384、sha512加密算法

salt '*' file.chown /etc/passwd root root    修改文件所属用户

salt '*' file.copy /path/to/src /path/to/dst    复制所有minion的/path/to/src 文件到/path/to/dst

salt '*' file.directory_exists /etc     检测所有minion的/etc目录是否存在，检测文件使用file.file_exists

salt '*' file.stats /etcpasswd     获取所有minion的stats信息

salt '*' file.get_mode /etc/passwd     获取所有minion的/etc/passwd 的权限mode

salt '*' file.set_mode /etc/passwd 0644     修改所有minion的/etc/passwd的权限mode为0644

salt '*' file.mkdir /opt/test 在所有minion上创建目录/opt/test

salt '*' file.sed /etc/httpd/httpd.conf 'LogLevel warn' 'LogLevel info'     将所有minion主机上的httpd.conf文件的LogLevel warn改成info

salt '*' file.append /tmp/test/test.conf "maxclient 100"    将所有minion的/tmp/test/test.conf 文件后面追加maxclient 100

salt '*' file.remove /tmp/foo    删除所有minion的/tmp/foo文件

API调用原理：

client.cmd('*',' file.remove ',['/tmp/foo'])

(7)iptables模块

功能:minion的iptables主持

示例:

salt '*' iptabnles.append filter INPUT rule='-m state --state RELATED,ESTABLISHED -j ACCEPT'    在所有minion主机追加规则

salt '*' iptables.delete filter INPUT position=3    删除所有minion上的指定链编号为3的规则

salt '*' iptables.save /etc/sysconfig/iptables    保存所有minion上的规则

API调用原理：

client.cmd('SN2013-08-022','iptables.append',['filtet','INPUT','rule=\'-p tcp --sport 80 -j ACCEPT\''])

(8)network模块

功能:返回minion的网络信息

示例:

salt 'SN2013-08-022' network.dig www.qq.com

salt 'SN2013-08-022' network.ping www.qq.com

salt 'SN2013-08-022' network.traceroute www.qq.com    在minion上获取dig、ping、traceroute目录域名信息

salt 'SN2013-08-022' network.hwaddr eth0    获取minion的mac地址

salt 'SN2013-08-022' network.in_subnet 10.0.0.0/16    检测minion是否属于10.0.0.0/16这个子网

salt 'SN2013-08-022' network.interfaces    获取minion的网卡配置信息

salt 'SN2013-08-022' network.ip_addrs    获取minion的ip地址信息

salt 'SN2013-08-022' network.subnets    获取minion的子网信息

API调用原理：

client.cmd('SN2013-08-022','network.ip_addrs')

(9)pkg模块

功能:minion程序包管理，如yum、apt-get

示例:

salt '*' pkg.install php    所有minion安装php

salt '*' pkg.remove php    所有minion卸载php

salt '*' pkg.upgrade    升级所有minion上所有的软件包

API调用原理：

client.cmd('*','pkg.remove',['php'])

(10)service模块

功能:管理minion的服务

示例:

salt '*' service.enable nginx

salt '*' service.disable nginx   

开机自启动、禁用nginx

salt '*' service.reload nginx

salt '*' service.restart nginx

salt '*' service.start nginx

salt '*' service.stop nginx

salt '*' service.status nginx

针对nginx服务的reload、restart、start、stop、status操作

API调用原理：

client.cmd('*','service.stop',['nginx'])

(11)其他模块

saltstack还提供了user(系统用户模块)、group(系统组模块)、partition(系统分区模块)、puppet(puppet管理模块)、system(系统重启、关机模块)、timezone(市区管理模块)、nginx(nginx管理模块)、mount(文件系统挂载模块)等等，当然我们也可以通过Python扩展功能来满足需求。