1. saltstack模块介绍

Module是日常使用SaltStack接触最多的一个组件，其用于管理对象操作，这也是SaltStack通过Push的方式进行管理的入口，比如我们日常简单的执行命令、查看包安装情况、查看服务运行情况等工作都是通过SaltStack Module来实现的。

当安装好Master和Minion包后，系统上会安装很多Module，大家可以通过以下命令查看支持的所有Module列表：

//查看所有module列表
[root@master ~]# salt node1 sys.list_modules
node1:- acl- aliases- alternatives- archive- artifactory- baredoc- beacons- bigip- btrfs- buildout- chroot- cloud- cmd- composer- config- consul- container_resource- cp- cron- cryptdev- data- defaults- devinfo- devmap- disk- django- dnsmasq- dnsutil- drbd- environ- ethtool- event- extfs- file- firewalld- freezer- gem- genesis- glassfish- gnome- google_chat- grafana4- grains- group- hashutil- helm- highstate_doc- hosts- http- hue- incron- ini- inspector- introspect- iosconfig- ip- ipset- iptables- jboss7- jboss7_cli- jinja- k8s- kernelpkg- key- keyboard- kmod- kubeadm- locale- locate- log- logrotate- lowpkg- lvm- mandrill- match- mattermost- mine- minion- modjk- mount- msteams- nagios_rpc- namecheap_domains- namecheap_domains_dns- namecheap_domains_ns- namecheap_ssl- namecheap_users- network- nexus- nftables- nova- nspawn- nxos- nxos_api- nxos_upgrade- openscap- openstack_config- opsgenie- out- pagerduty- pagerduty_util- pam- parallels- partition- peeringdb- pillar- pip- pkg- pkg_resource- ps- publish- pushover- pyenv- random- random_org- rbenv- rest_sample_utils- restartcheck- ret- rvm- s3- s6- salt_proxy- salt_version- saltcheck- saltutil- schedule- scsi- sdb- seed- serverdensity_device- service- shadow- slack- slsutil- smbios- smtp- solrcloud- sqlite3- ssh- state- status- statuspage- supervisord- sys- sysctl- sysfs- syslog_ng- system- telegram- telemetry- temp- test- timezone- tls- travisci- tuned- udev- uptime- user- vault- vbox_guest- virtualenv- vsphere- x509- xfs- xml- zabbix- zenoss
[root@master ~]# 

//查看指定module的所有function
[root@master ~]# salt node1 sys.list_functions cmd
node1:- cmd.exec_code- cmd.exec_code_all- cmd.has_exec- cmd.powershell- cmd.powershell_all- cmd.retcode- cmd.run- cmd.run_all- cmd.run_bg- cmd.run_chroot- cmd.run_stderr- cmd.run_stdout- cmd.script- cmd.script_retcode- cmd.shell- cmd.shell_info- cmd.shells- cmd.tty- cmd.which- cmd.which_bin
[root@master ~]# 

//查看指定module的用法
[root@master ~]# salt node1 sys.doc cmd
'cmd.exec_code:'Pass in two strings, the first naming the executable language, aka -python2, python3, ruby, perl, lua, etc. the second string containingthe code you wish to execute. The stdout will be returned.CLI Example:salt '*' cmd.exec_code ruby 'puts "cheese"' 
...此处省略N行...

//SaltStack默认也支持一次执行多个Module，Module之间通过逗号隔开，默认传参之间也是用逗号分隔，也支持指定传参分隔符号--args-separator=@即可
[root@master ~]# salt node1 test.echo,cmd.run,service.status hello,date,sshd
node1:----------cmd.run:Wed Nov  3 15:04:42 CST 2021service.status:Truetest.echo:hello
[root@master ~]# 

2. saltstack常用模块

2.1 saltstack常用模块之network

2.1.1 network.active_tcp

返回所有活动的tcp连接

[root@master ~]# salt node1 network.active_tcp
node1:----------0:----------local_addr:192.168.8.130local_port:22remote_addr:192.168.8.1remote_port:624161:----------local_addr:192.168.8.130local_port:53590remote_addr:192.168.8.129remote_port:45052:----------local_addr:192.168.8.130local_port:22remote_addr:192.168.8.1remote_port:54122
[root@master ~]# 

2.1.2 network.calc_net

通过IP和子网掩码计算出网段

[root@master ~]# salt node1 network.calc_net 192.168.8.130 255.255.255.0
node1:192.168.8.0/24
[root@master ~]# salt node1 network.calc_net 192.168.8.130 255.255.255.240
node1:192.168.8.128/28
[root@master ~]# 

2.1.3 network.connect

测试minion至某一台服务器的网络是否连通

[root@master ~]# salt node1 network.connect baidu.com 80
node1:----------comment:Successfully connected to baidu.com (220.181.38.251) on tcp port 80result:True
[root@master ~]# 

2.1.4 network.default_route

查看默认路由

[root@master ~]# salt node1 network.default_route
node1:|_----------addr_family:inetdestination:0.0.0.0flags:UGgateway:192.168.8.2interface:ens160netmask:0.0.0.0
[root@master ~]# 

2.1.5 network.get_fqdn

查看主机的fqdn(完全限定域名)

[root@master ~]# salt node1 network.get_fqdn
node1:node1
[root@master ~]# 

2.1.6 network.get_hostname

获取主机名

[root@master ~]# salt node1 network.get_hostname
node1:node1
[root@master ~]# 

2.1.7 network.get_route

查询到一个目标网络的路由信息

[root@master ~]# salt node1 network.get_route 192.168.8.130
node1:----------destination:192.168.8.130gateway:Noneinterface:losource:192.168.8.130
[root@master ~]# 

2.1.8 network.hw_addr

返回指定网卡的MAC地址

[root@master ~]# salt node1 network.hw_addr ens160
node1:00:0c:29:29:7f:87
[root@master ~]# 

2.1.9 network.ifacestartswith

从特定CIDR检索接口名称

[root@master ~]# salt node1 network.ifacestartswith 192.168
node1:- ens160
[root@master ~]# 

2.1.10 network.in_subnet

判断当前主机是否在某一个网段内

[root@master ~]# salt node1 network.in_subnet 192.168.8.0/24
node1:True
[root@master ~]# 

2.1.11 network.interface

返回指定网卡的信息

[root@master ~]# salt node1 network.interface ens160
node1:|_----------address:192.168.8.130broadcast:192.168.8.255label:ens160netmask:255.255.255.0
[root@master ~]# 

2.1.12 network.interface_ip

返回指定网卡的IP地址

[root@master ~]# salt node1 network.interface_ip ens160
node1:192.168.8.130
[root@master ~]# 

2.1.13 network.interfaces

返回当前系统中所有的网卡信息

[root@master ~]# salt node1 network.interfaces
node1:----------ens160:----------hwaddr:00:0c:29:29:7f:87inet:|_----------address:192.168.8.130broadcast:192.168.8.255label:ens160netmask:255.255.255.0up:Truelo:----------hwaddr:00:00:00:00:00:00inet:|_----------address:127.0.0.1broadcast:Nonelabel:lonetmask:255.0.0.0inet6:|_----------address:::1prefixlen:128scope:hostup:True
[root@master ~]# 

2.1.14 network.ip_addrs

返回一个IPv4的地址列表
该函数将会忽略掉127.0.0.1的地址

[root@master ~]# salt node1 network.ip_addrs
node1:- 192.168.8.130
[root@master ~]# 

2.1.15 network.netstat

返回所有打开的端口和状态

[root@master ~]# salt node1 network.netstat 
node1:|_----------inode:26469local-address:0.0.0.0:22program:sshdproto:tcprecv-q:0remote-address:0.0.0.0:*send-q:128state:LISTENuser:0|_----------inode:50676local-address:192.168.8.130:22program:sshdproto:tcprecv-q:0remote-address:192.168.8.1:62416send-q:0state:ESTABLISHEDuser:0|_----------inode:47973local-address:192.168.8.130:53590program:salt-minionproto:tcprecv-q:0remote-address:192.168.8.129:4505send-q:0state:ESTABLISHEDuser:0|_----------inode:29106local-address:192.168.8.130:22program:sshdproto:tcprecv-q:0remote-address:192.168.8.1:54122send-q:0state:ESTABLISHEDuser:0|_----------inode:26471local-address:[::]:22program:sshdproto:tcprecv-q:0remote-address:[::]:*send-q:128state:LISTENuser:0
[root@master ~]# 

2.1.16 network.ping

使用ping命令测试到某主机的连通性

[root@master ~]# salt node1 network.ping baidu.com
node1:PING baidu.com (220.181.38.148) 56(84) bytes of data.64 bytes from 220.181.38.148 (220.181.38.148): icmp_seq=1 ttl=128 time=38.3 ms64 bytes from 220.181.38.148 (220.181.38.148): icmp_seq=2 ttl=128 time=40.6 ms64 bytes from 220.181.38.148 (220.181.38.148): icmp_seq=3 ttl=128 time=38.10 ms64 bytes from 220.181.38.148 (220.181.38.148): icmp_seq=4 ttl=128 time=39.3 ms--- baidu.com ping statistics ---4 packets transmitted, 4 received, 0% packet loss, time 8msrtt min/avg/max/mdev = 38.297/39.285/40.593/0.834 ms
[root@master ~]# 

2.1.17 network.reverse_ip

[root@master ~]# salt node1 network.reverse_ip 192.168.8.130
node1:130.8.168.192.in-addr.arpa
[root@master ~]# 

2.2 SaltStack常用模块之service

2.2.1 service.available

判断指定的服务是否可用

[root@master ~]# salt node1 service.available sshd
node1:True
[root@master ~]# salt node1 service.available vsftpd
node1:False
[root@master ~]# 

2.2.2 service.get_all

获取所有正在运行的服务

[root@master ~]# salt node1 service.get_all
node1:- NetworkManager- NetworkManager-dispatcher- NetworkManager-wait-online- auditd- autovt@- basic.target- blk-availability- bluetooth.target- console-getty- container-getty@- cpupower- crond- cryptsetup-pre.target- cryptsetup.target- ctrl-alt-del.target- dbus- dbus-org.freedesktop.hostname1- dbus-org.freedesktop.locale1- dbus-org.freedesktop.login1- dbus-org.freedesktop.nm-dispatcher- dbus-org.freedesktop.portable1- dbus-org.freedesktop.timedate1- dbus.socket- debug-shell- default.target- dev-hugepages.mount
*********此处省略

2.2.3 service.disabled

检查指定服务是否开机不自动启动

[root@master ~]# salt node1 service.disable httpd
node1:False
[root@master ~]# 

2.2.4 service.enabled

检查指定服务是否开机自动启动

[root@master ~]# salt node1 service.enable httpd
node1:True
[root@master ~]# 

2.2.5 service.disable

设置指定服务开机不自动启动

[root@master ~]# salt node1 service.disable httpd
node1:True
[root@master ~]# salt node1 service.enabled httpd
node1:False
[root@master ~]# 

2.2.6 service.enable

设置指定服务开机自动启动

[root@master ~]# salt node1 service.enable httpd
node1:True
[root@master ~]# salt node1 service.enabled httpd
node1:True
[root@master ~]# 

2.2.7 service.reload

重新加载指定服务

[root@master ~]# salt node1 service.reload httpd
node1:True
[root@master ~]#

2.2.8 service.stop

停止指定服务

[root@master ~]# salt node1 service.stop httpd
node1:True
[root@master ~]# 

2.2.9 service.start

启动指定服务

[root@master ~]# salt node1 service.start httpd
node1:True
[root@master ~]# 

2.2.10 service.restart

重启指定服务

[root@master ~]# salt node1 service.restart httpd
node1:True
[root@master ~]# 

2.2.11 service.status

查看指定服务的状态

[root@master ~]# salt node1 service.status httpd
node1:True
[root@master ~]# 

2.3 SaltStack常用模块之pkg

2.3.1 pkg.download

只下载软件包但不安装
此功能将会下载指定的软件包，但是需要在minion端安装yum-utils，可以使用 cmd.run 进行远程安装

[root@master ~]# salt 'node1' pkg.download wget
node1:----------wget:/var/cache/yum/packages/wget-1.19.5-10.el8.x86_64.rpm    //下载好的软件放在这里
[root@master ~]# 

2.3.2 pkg.file_list

列出指定包或系统中已安装的所有包的文件

//列出已安装的apache软件包提供的所有文件
[root@master ~]# salt node1 pkg.file_list httpd
node1:----------errors:files:- /etc/httpd/conf- /etc/httpd/conf.d/autoindex.conf- /etc/httpd/conf.d/userdir.conf- /etc/httpd/conf.d/welcome.conf- /etc/httpd/conf.modules.d- /etc/httpd/conf.modules.d/00-base.conf- /etc/httpd/conf.modules.d/00-dav.conf- /etc/httpd/conf.modules.d/00-lua.conf- /etc/httpd/conf.modules.d/00-mpm.conf- /etc/httpd/conf.modules.d/00-optional.conf- /etc/httpd/conf.modules.d/00-proxy.conf- /etc/httpd/conf.modules.d/00-systemd.conf- /etc/httpd/conf.modules.d/01-cgi.conf- /etc/httpd/conf.modules.d/README- /etc/httpd/conf/httpd.conf- /etc/httpd/conf/magic- /etc/httpd/logs- /etc/httpd/modules- /etc/httpd/run- /etc/httpd/state- /etc/logrotate.d/httpd- /etc/sysconfig/htcacheclean- /run/httpd- /run/httpd/htcacheclean- /usr/lib/.build-id- /usr/lib/.build-id/01******此处已省略//当不提供参数时，将会列出当前系统中所有已安装软件的文件列表
[root@master ~]# salt node1 pkg.file_list 
node1:----------errors:files:VALUE_TRIMMED
[root@master ~]# 

2.3.3 pkg.group_info

查看包组的信息

[root@master ~]# salt node1 pkg.group_info 'Development Tools'
node1:----------conditional:default:- asciidoc- byacc- ctags- diffstat- elfutils-libelf-devel- git- intltool- jna- ltrace- patchutils- perl-Fedora-VSP- perl-Sys-Syslog- perl-generators- pesign- source-highlight- systemtap- valgrind- valgrind-develdescription:A basic development environment.group:Development Toolsid:Nonemandatory:- autoconf- automake- binutils- bison- flex- gcc- gcc-c++- gdb- glibc-devel- libtool- make- pkgconf- pkgconf-m4- pkgconf-pkg-config- redhat-rpm-config- rpm-build- rpm-sign- straceoptional:- cmake- expect- rpmdevtools- rpmlinttype:package group
[root@master ~]# 

2.3.4 pkg.group_list

列出系统中所有的包组

[root@master ~]# salt node1 pkg.group_list 
node1:----------available:- Conflicts BaseOS- Dial-up Networking Support- Hardware Monitoring Utilities- Hardware Support- Large Systems Performance- Legacy UNIX Compatibility- Python Web- Server product core- Windows File Server- Additional Development- Anaconda tools- Backup Client- Base- base-x- Conflicts AppStream- Container Management- Debugging Tools- Desktop Debugging and Performance Tools- Development Tools- .NET Core Development- File and Storage Server- Fonts- FTP Server- GNOME Applications- GNOME- Graphical Administration Tools- Graphics Creation Tools- Guest Agents- Guest Desktop Agents- Headless Management- Infiniband Support- Input Methods- Internet Applications- Internet Browser- Java Platform- Legacy X Window System Compatibility- Mail Server- Mainframe Access- Multimedia- Network File System Client- Network Servers- Networking Tools- Common NetworkManager submodules- Office Suite and Productivity- Atomic Host ostree support- Performance Tools- Platform Development- KVM platform specific packages- Hyper-v platform specific packages- Printing Client- Remote Desktop Clients- Remote Management for Linux- RPM Development Tools- Scientific Support- Security Tools- Smart Card Support- Standard- System Tools- TeX formatting system- Virtualization Client- Virtualization Hypervisor- Virtualization Platform- Virtualization Tools- Basic Web Server- Workstation product coreavailable environments:- Server with GUI- Server- Workstation- Custom Operating System- Virtualization Hostavailable languages:----------installed:- Core- VMware platform specific packagesinstalled environments:- Minimal Install
[root@master ~]# 

2.3.5 pkg.install

安装软件

[root@master ~]# salt node1 pkg.install wget
node1:----------wget:----------new:1.19.5-10.el8old:
[root@master ~]# 

2.3.6 pkg.list_downloaded

列出已下载到本地的软件包

[root@master ~]# salt '*' pkg.list_downloaded
node1:----------wget:----------1.14-18.el7:----------creation_date_time:2019-02-22T17:11:52creation_date_time_t:1550826712path:/var/cache/yum/packages/wget-1.14-18.el7.x86_64.rpmsize:560152

2.3.7 pkg.list_pkgs

以字典的方式列出当前已安装的软件包

[root@master ~]# salt node1 pkg.list_pkgs
node1:----------GeoIP:1.5.0-11.el7NetworkManager:1:1.8.0-9.el7NetworkManager-libnm:1:1.8.0-9.el7NetworkManager-team:1:1.8.0-9.el7NetworkManager-tui:1:1.8.0-9.el7NetworkManager-wifi:1:1.8.0-9.el7PyYAML:3.11-1.el7...此处省略N行

2.3.8 pkg.owner

列出指定文件是由哪个包提供的

[root@master ~]# salt node1 pkg.owner /usr/sbin/apachectl
node1:httpd
[root@master ~]# salt node1 pkg.owner /usr/sbin/apachectl /etc/httpd/conf/httpd.conf
node1:----------/etc/httpd/conf/httpd.conf:httpd/usr/sbin/apachectl:httpd
[root@master ~]# 

2.3.9 pkg.remove

卸载指定软件

[root@master ~]# salt node1 cmd.run 'rpm -qa|grep wget'
node1:wget-1.19.5-10.el8.x86_64
[root@master ~]# salt node1 pkg.remove wget
node1:----------wget:----------new:old:1.19.5-10.el8
[root@master ~]# 
//若要卸载多个文件，中间需要用逗号隔开

2.3.10 pkg.upgrade

升级系统中所有的软件包或升级指定的软件包

[root@master ~]# salt node1 pkg.upgrade name=openssl
node1:----------openssl:----------new:1:1.1.1g-15.el8_3old:1:1.1.1c-15.el8openssl-libs:----------new:1:1.1.1g-15.el8_3old:1:1.1.1c-15.el8
[root@master ~]# 
//若想升级系统中所有的软件包则把 name 参数去掉即可

2.4 SaltStack常用模块之state

2.4.1 state.show_highstate

显示当前系统中有哪些高级状态

[root@master ~]# salt 'node1' state.show_highstate
node1:----------apache-install:----------__env__:base__sls__:web.apache.installpkg:|_----------name:httpd- installed|_----------order:10000apache-service:----------__env__:base__sls__:web.apache.installservice:|_----------name:httpd|_----------enable:True- running|_----------order:10001

2.4.2 state.highstate

执行高级状态

[root@master ~]# salt 'node1' state.highstate webb.apache.install
node1:
----------ID: apache-installFunction: pkg.installedName: httpdResult: TrueComment: All specified packages are already installedStarted: 23:07:21.929361Duration: 473.81 msChanges:   
----------ID: apache-serviceFunction: service.runningName: httpdResult: TrueComment: The service httpd is already runningStarted: 23:07:22.412620Duration: 34.24 msChanges:   Summary for node1
------------
Succeeded: 2
Failed:    0
------------
Total states run:     2
Total run time: 508.050 ms

2.4.3 state.show_state_usage

显示当前系统中的高级状态执行情况

[root@master ~]# salt 'node1' state.show_state_usage 
node1:----------base:----------count_all:3count_unused:2count_used:1unused:- top- web.mysql.installused:- web.apache.install

2.4.4 state.show_top

返回minion将用于highstate的顶级数据

[root@master ~]# salt 'node1' state.show_top 
node1:----------base:- web.apache.install

2.4.5 state.top

执行指定的top file，而不是默认的

[root@master ~]# salt 'node1' state.top top.sls
node1:
----------ID: apache-installFunction: pkg.installedName: httpdResult: TrueComment: All specified packages are already installedStarted: 23:09:15.869470Duration: 475.13 msChanges:   
----------ID: apache-serviceFunction: service.runningName: httpdResult: TrueComment: The service httpd is already runningStarted: 23:09:16.346327Duration: 35.697 msChanges:   Summary for node1
------------
Succeeded: 2
Failed:    0
------------
Total states run:     2
Total run time: 510.827 ms

2.4.6 state.show_sls

显示 master 上特定sls或sls文件列表中的状态数据

[root@master ~]# salt 'node1' state.show_sls web.apache.install
node1:----------apache-install:----------__env__:base__sls__:web.apache.installpkg:|_----------name:httpd- installed|_----------order:10000apache-service:----------__env__:base__sls__:web.apache.installservice:|_----------name:httpd|_----------enable:True- running|_----------order:10001

2.5 SaltStack常用模块之salt-cp

salt-cp能够很方便的把 master 上的文件批量传到 minion上

//拷贝单个文件到目标主机的/usr/src目录下
[root@master ~]# salt 'node1' cmd.run 'ls /usr/src'
node1:debugkernels
[root@master ~]# salt-cp 'node1' /etc/passwd /usr/src
node1:----------/usr/src/passwd:True
[root@master ~]# salt 'node1' cmd.run 'ls /usr/src'
node1:debugkernelspasswd
[root@master ~]# 

2.6 SaltStack常用模块之useradd

语法: salt '*' user.add name <uid> <gid> <groups> <home> <shell>

//创建用户
[root@master ~]# salt node1 user.add pyd
node1:True[root@node1 ~]# id pyd 
uid=1000(pyd) gid=1000(pyd) 组=1000(pyd)

//更改用户名
[root@master ~]# salt 'node1' user.chfullname pyd "tom"
node1:True[root@node1 ~]# cat /etc/passwd | tail -1
pyd:x:1000:1000:tom:/home/pyd:/bin/bash
[root@node1 ~]# 

//更改uid
[root@node1 ~]# id pyd
uid=1000(pyd) gid=1000(pyd) 组=1000(pyd)[root@master ~]# salt node1 user.chuid pyd 2000
node1:True
[root@master ~]# [root@node1 ~]# id pyd
uid=2000(pyd) gid=1000(pyd) 组=1000(pyd)
[root@node1 ~]# //更改gid
root@master ~]# salt node1 user.add ppp   //先创建组
node1:True
[root@master ~]# [root@node1 ~]# id ppp
uid=2001(ppp) gid=2001(ppp) 组=2001(ppp)
[root@node1 ~]# [root@master ~]# salt node1 user.chgid pyd 2001   //修改gid为2001
node1:True
[root@master ~]# 
[root@node1 ~]# id pyd
uid=2000(pyd) gid=2001(ppp) 组=2001(ppp)
[root@node1 ~]# 

//返回用户信息
[root@master ~]# salt node1 user.info pyd
node1:----------fullname:tomgid:2001groups:- ppphome:/home/pydhomephone:name:pydother:passwd:xroomnumber:shell:/bin/bashuid:2000workphone:
[root@master ~]# 

//返回所有系统用户信息的列表
[root@master ~]# salt node1 user.getent
node1:|_----------fullname:rootgid:0groups:- roothome:/roothomephone:name:rootother:passwd:xroomnumber:shell:/bin/bashuid:0workphone:|_----------fullname:bingid:1groups:- binhome:/binhomephone:name:binother:passwd:xroomnumber:shell:/sbin/nologinuid:1workphone:|_----------fullname:daemongid:2groups:- daemonhome:/sbin******略
[root@master ~]# 

//列出指定用户所属组的列表。
[root@master ~]# salt node1 user.list_groups pyd
node1:- ppp
[root@master ~]# 

//返回所有用户的列表
[root@master ~]# salt node1 user.list_users 
node1:- adm- apache- bin- daemon- dbus- ftp- games- halt- lp- mail- nobody- operator- polkitd- ppp- pyd- rngd- root- shutdown- sshd- sssd- sync- systemd-coredump- systemd-resolve- tss- unbound
[root@master ~]# 

//修改指定用户的用户名
[root@node1 ~]# id pyd 
uid=2000(pyd) gid=2001(ppp) 组=2001(ppp)
[root@node1 ~]# [root@master ~]# salt node1 user.rename pyd pyd666
node1:False
[root@master ~]# 
[root@node1 ~]# id pyd
id: “pyd”：无此用户
[root@node1 ~]# id pyd666
uid=2000(pyd666) gid=2001(ppp) 组=2001(ppp)
[root@node1 ~]# 

//删除用户
[root@node1 ~]# id pyd666
uid=2000(pyd666) gid=2001(ppp) 组=2001(ppp)
[root@node1 ~]# [root@master ~]# salt node1 user.delete pyd666
node1:True
[root@master ~]# [root@node1 ~]# id pyd666
id: “pyd666”：无此用户
[root@node1 ~]#