1. SaltStack模块介绍

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

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

//查看所有module列表
[root@master ~]# salt  'node1'   sys.list_modules 
node1:- acl- aliases- alternatives- apache- archive- artifactory- at- baredoc- beacons- bigip- btrfs- buildout- chroot- cloud- cmd- composer- config- consul- container_resource- cp- 此处省略N行//查看指定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//查看指定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.All parameters from :mod:`cmd.run_all <salt.modules.cmdmod.run_all>` except python_shell can be used.CLI Example:salt '*' cmd.exec_code ruby 'puts "cheese"'salt '*' cmd.exec_code ruby 'puts "cheese"' args='["arg1", "arg2"]' env='{"FOO": "bar"}'...此处省略N行...//SaltStack默认也支持一次执行多个Module，Module之间通过逗号隔开，默认传参之间也是用逗号分隔，也支持指定传参分隔符号--args-separator=@即可
[root@master ~]# salt  'node1'   test.echo,cmd.run,service.status  welcome,date,salt-minion
node1:----------cmd.run:Wed Nov  3 13:35:58 CST 2021service.status:Truetest.echo:welcome

2. SaltStack常用模块

2.1 SaltStack常用模块之network

2.1.1 network.active_tcp

返回所有活动的tcp连接

[root@master ~]# salt '*' network.active_tcp
node1:----------0:----------local_addr:192.168.153.153local_port:22remote_addr:192.168.153.1remote_port:499651:----------local_addr:192.168.153.153local_port:48428remote_addr:192.168.153.142remote_port:45052:----------local_addr:192.168.153.153local_port:22remote_addr:192.168.153.1remote_port:49962

2.1.2 network.calc_net

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

[root@master ~]# salt '*' network.calc_net 192.168.153.142 255.255.255.0
node1:192.168.153.0/24[root@master ~]# salt '*' network.calc_net 192.168.153.142 255.255.240.0
node1:192.168.144.0/20

2.1.3 network.connect

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

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

2.1.4 network.default_route

查看默认路由

[root@master ~]# salt '*' network.default_route 
node1:|_----------addr_family:inetdestination:0.0.0.0flags:UGgateway:192.168.153.2interface:ens160netmask:0.0.0.0|_----------addr_family:inet6destination:::/0flags:!ngateway:::interface:lonetmask:|_----------addr_family:inet6destination:::/0flags:!ngateway:::interface:lonetmask:

2.1.5 network.get_fqdn

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

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

2.1.6 network.get_hostname

获取主机名

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

2.1.7 network.get_route

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

[root@master ~]# salt '*' network.get_route   192.168.153.1
node1:----------destination:192.168.153.1gateway:Noneinterface:ens160source:192.168.153.153

2.1.8 network.hw_addr

返回指定网卡的MAC地址

[root@master ~]# salt '*' network.hw_addr  ens160
node1:00:0c:29:e9:0e:6b

2.1.9 network.ifacestartswith

从特定CIDR检索接口名称

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

2.1.10 network.in_subnet

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

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

2.1.11 network.interface

返回指定网卡的信息

[root@master ~]# salt '*' network.interface ens32
192.168.69.202:|_----------address:192.168.69.202broadcast:192.168.69.255label:ens32netmask:255.255.255.0

2.1.12 network.interface_ip

返回指定网卡的IP地址

[root@master ~]# salt '*'  network.interface_ip ens160
node1:192.168.153.153

2.1.13 network.interfaces

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

[root@master ~]# salt '*'  network.interface ens160
node1:|_----------address:192.168.153.153broadcast:192.168.153.255label:ens160netmask:255.255.255.0

2.1.14 network.ip_addrs

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

[root@master ~]# salt '*' network.ip_addrs  
node1:- 192.168.122.1- 192.168.153.153

2.1.15 network.netstat

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

[root@master ~]# salt '*' network.netstat
node1:|_----------inode:23724local-address:0.0.0.0:111program:1/systemdproto:tcprecv-q:0remote-address:0.0.0.0:*send-q:0state:LISTENuser:0|_----------inode:35019local-address:192.168.122.1:53program:1656/dnsmasqproto:tcprecv-q:0remote-address:0.0.0.0:*send-q:0state:LISTENuser:0|_----------inode:29303local-address:0.0.0.0:22program:1063/sshdproto:tcprecv-q:0remote-address:0.0.0.0:*send-q:0state:LISTENuser:0|_----------inode:29323local-address:127.0.0.1:631program:1059/cupsdproto:tcprecv-q:0remote-address:0.0.0.0:*send-q:0state:LISTENuser:0|_----------inode:41797local-address:192.168.153.153:22program:2464/sshd:proto:tcprecv-q:0remote-address:192.168.153.1:49965send-q:0state:ESTABLISHEDuser:0|_----------inode:51380local-address:192.168.153.153:48428program:1613/python3.6proto:tcprecv-q:0remote-address:192.168.153.142:4505send-q:0state:ESTABLISHEDuser:0|_----------inode:0local-address:192.168.153.153:51716program:-proto:tcprecv-q:0remote-address:192.168.153.142:4506send-q:0state:TIME_WAITuser:0|_----------inode:0local-address:192.168.153.153:51718program:-proto:tcprecv-q:0remote-address:192.168.153.142:4506send-q:0state:TIME_WAITuser:0|_----------inode:41198local-address:192.168.153.153:22program:2402/sshd:proto:tcprecv-q:0remote-address:192.168.153.1:49962send-q:0state:ESTABLISHEDuser:0|_----------inode:23726local-address::::111program:1/systemdproto:tcp6recv-q:0remote-address::::*send-q:0state:LISTENuser:0|_----------inode:32239local-address::::80program:1221/httpdproto:tcp6recv-q:0remote-address::::*send-q:0state:LISTENuser:0|_----------inode:29312local-address::::22program:1063/sshdproto:tcp6recv-q:0remote-address::::*send-q:0state:LISTENuser:0|_----------inode:29322local-address:::1:631program:1059/cupsdproto:tcp6recv-q:0remote-address::::*send-q:0state:LISTENuser:0|_----------inode:28958local-address:0.0.0.0:54801program:994/avahi-daemon:proto:udprecv-q:0remote-address:0.0.0.0:*send-q:0user:70|_----------inode:35018local-address:192.168.122.1:53program:1656/dnsmasqproto:udprecv-q:0remote-address:0.0.0.0:*send-q:0user:0|_----------inode:35015local-address:0.0.0.0:67program:1656/dnsmasqproto:udprecv-q:0remote-address:0.0.0.0:*send-q:0user:0|_----------inode:0local-address:192.168.153.153:68program:30971proto:udprecv-q:0remote-address:192.168.153.254:67send-q:0user:ESTABLISHED|_----------inode:23725local-address:0.0.0.0:111program:1/systemdproto:udprecv-q:0remote-address:0.0.0.0:*send-q:0user:0|_----------inode:28956local-address:0.0.0.0:5353program:994/avahi-daemon:proto:udprecv-q:0remote-address:0.0.0.0:*send-q:0user:70|_----------inode:28959local-address::::54080program:994/avahi-daemon:proto:udp6recv-q:0remote-address::::*send-q:0user:70|_----------inode:23727local-address::::111program:1/systemdproto:udp6recv-q:0remote-address::::*send-q:0user:0|_----------inode:28957local-address::::5353program:994/avahi-daemon:proto:udp6recv-q:0remote-address::::*send-q:0user:70

2.1.16 network.ping

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

[root@master ~]# salt '*'   network.ping  baidu.com
node1:PING baidu.com (220.181.38.251) 56(84) bytes of data.64 bytes from 220.181.38.251 (220.181.38.251): icmp_seq=1 ttl=128 time=40.5 ms64 bytes from 220.181.38.251 (220.181.38.251): icmp_seq=2 ttl=128 time=40.9 ms64 bytes from 220.181.38.251 (220.181.38.251): icmp_seq=3 ttl=128 time=48.1 ms64 bytes from 220.181.38.251 (220.181.38.251): icmp_seq=4 ttl=128 time=81.3 ms--- baidu.com ping statistics ---4 packets transmitted, 4 received, 0% packet loss, time 8msrtt min/avg/max/mdev = 40.541/52.696/81.313/16.795 ms

2.1.17 network.reverse_ip

返回一个指定的IP地址的反向地址

[root@master ~]# salt '*'   network.reverse_ip  192.168.153.142
node1:142.153.168.192.in-addr.arpa

2.2 SaltStack常用模块之service

2.2.1 service.available

判断指定的服务是否可用

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

2.2.2 service.get_all

获取所有正在运行的服务

[root@master ~]# salt '*' service.get_all
node1:- ModemManager- NetworkManager- NetworkManager-dispatcher- NetworkManager-wait-online- accounts-daemon- alsa-restore- alsa-state- anaconda- anaconda-direct- anaconda-nm-config- anaconda-noshell- anaconda-pre- anaconda-shell@- anaconda-sshd- anaconda-tmux@- anaconda.target- arp-ethers- atd- auditd- auth-rpcgss-module- autovt@- avahi-daemon- avahi-daemon.socket- basic.target- blivet- blk-availability- bluetooth- bluetooth.target- bolt- brltty- btattach-bcm@- canberra-system-bootup- canberra-system-shutdown- 此处省略N行

2.2.3 service.disabled

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

[root@master ~]# salt '*' service.disable htttpd
node1:False

2.2.4 service.enabled

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

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

2.2.5 service.disable

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

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

2.2.6 service.enable

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

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

2.2.7 service.reload

重新加载指定服务

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

2.2.8 service.stop

停止指定服务

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

2.2.9 service.start

启动指定服务

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

2.2.10 service.restart

重启指定服务

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

2.2.11 service.status

查看指定服务的状态

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

2.3 SaltStack常用模块之pkg

2.3.1 pkg.download

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

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

2.3.2 pkg.file_list

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

//列出已安装的apache软件包提供的所有文件
[root@master ~]# salt '*'  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//当不提供参数时，将会列出当前系统中所有已安装软件的文件列表
[root@master ~]# salt '*'  pkg.file_list  
node1:----------errors:files:VALUE_TRIMMED

2.3.3 pkg.group_info

查看包组的信息

[root@master ~]# salt '*' 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

2.3.4 pkg.group_list

列出系统中所有的包组

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

2.3.5 pkg.install

安装软件

[root@master ~]# salt '*' pkg.install vim
node1:----------vim-common:----------new:2:8.0.1763-15.el8old:vim-enhanced:----------new:2:8.0.1763-15.el8old:           

2.3.6 pkg.list_downloaded

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

[root@master ~]# salt '*'  pkg.list_downloaded 
node1:----------
master:----------

2.3.7 pkg.list_pkgs

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

[root@master ~]# salt  '*'   pkg.list_pkgs 
node1:----------GConf2:3.2.6-22.el8ModemManager:1.10.8-2.el8ModemManager-glib:1.10.8-2.el8NetworkManager:1:1.22.8-4.el8NetworkManager-adsl:1:1.22.8-4.el8NetworkManager-bluetooth:1:1.22.8-4.el8NetworkManager-config-server:1:1.22.8-4.el8NetworkManager-libnm:1:1.22.8-4.el8NetworkManager-team:...此处省略N行

2.3.8 pkg.owner

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

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

2.3.9 pkg.remove

卸载指定软件

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

2.3.10 pkg.upgrade

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

[root@master ~]# salt '*' pkg.upgrade name=openssl
node1:----------openssl:----------new:1:1.0.2k-16.el7old:1:1.0.2k-8.el7openssl-libs:----------new:1:1.0.2k-16.el7old:1:1.0.2k-8.el7
//若想升级系统中所有的软件包则把 name 参数去掉即可

2.4 SaltStack常用模块之state

2.4.1 state.show_highstate

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

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

2.4.2 state.highstate

执行高级状态

[root@master ~]# salt '*'  state.highstate  web.apache.apache
node1:
----------ID: apache-installFunction: pkg.installedName: httpdResult: TrueComment: All specified packages are already installedStarted: 14:46:43.126428Duration: 1215.254 msChanges:   
----------ID: apache-serviceFunction: service.runningName: httpdResult: NoneComment: Service httpd is set to startStarted: 14:46:44.345304Duration: 42.196 msChanges:   Summary for node1
------------
Succeeded: 2 (unchanged=1)
Failed:    0
------------
Total states run:     2
Total run time:   1.257 s

2.4.3 state.show_state_usage

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

[root@master ~]# salt '*' state.show_state_usage
node1:----------base:----------count_all:2count_unused:1count_used:1unused:- topused:- web.apache.apachedev:----------count_all:0count_unused:0count_used:0unused:used:prod:----------count_all:0count_unused:0count_used:0unused:used:test:----------count_all:0count_unused:0count_used:0unused:used:

2.4.4 state.show_top

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

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

2.4.5 state.top

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

[root@master ~]# salt '*'   state.top  test.sls
node1:
----------ID: apache-installFunction: pkg.installedName: httpdResult: TrueComment: All specified packages are already installedStarted: 14:52:15.677734Duration: 1218.272 msChanges:   
----------ID: apache-serviceFunction: service.runningName: httpdResult: TrueComment: The service httpd is already runningStarted: 14:52:16.897131Duration: 35.889 msChanges:   Summary for node1
------------
Succeeded: 2
Failed:    0
------------
Total states run:     2
Total run time:   1.254 s

2.4.6 state.show_sls

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

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

2.5 SaltStack常用模块之user

2.5.1 user.add

创建用户

[root@node1 ~]# id csl
id: “csl”：无此用户[root@master ~]# salt  '*' user.add csl
node1:True[root@node1 ~]# id csl
uid=1001(csl) gid=1001(csl) 组=1001(csl)

2.5.2 user.chuid

更改用户UID

[root@node1 ~]# id csl
uid=1001(csl) gid=1001(csl) 组=1001(csl)[root@master ~]# salt '*' user.chuid  csl 2000
node1:True[root@node1 ~]# id csl
uid=2000(csl) gid=1001(csl) 组=1001(csl)

2.5.3 user.gid

更改用户GID

[root@master ~]# salt '*' user.add  xxx
node1:True[root@node1 ~]# id xxx
uid=2001(xxx) gid=2001(xxx) 组=2001(xxx)[root@master ~]# salt '*' user.chgid  xxx 1000
node1:True[root@node1 ~]# id xxx
uid=2001(xxx) gid=1000(admin) 组=1000(admin)

2.5.4 user.info

返回用户信息

[root@master ~]# salt '*'  user.info csl
node1:----------fullname:gid:1001groups:- cslhome:/home/cslhomephone:name:cslother:passwd:xroomnumber:shell:/bin/bashuid:2000workphone:
后面省略....

2.5.5 user.getent

返回所有系统用户信息的列表

[root@master ~]# salt  '*'   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:1
后面省略....

2.5.6 user.list_groups

列出指定用户所属组的列表

[root@master ~]# salt '*'  user.list_groups  csl
node1:- csl

2.5.7 user.list_users

返回所有用户的列表

[root@master ~]# salt '*' user.list_users 
node1:- adm- admin- apache- avahi- bin- chrony- clevis- cockpit-ws- cockpit-wsinstance- colord- csl- daemon- dbus- dnsmasq- flatpak- ftp
后面省略.......

2.5.8 user.rename

修改指定用户的用户名

[root@node1 ~]# id test
uid=2002(test) gid=2002(test) 组=2002(test)[root@master ~]# salt '*'  user.rename  test example
node1:False[root@node1 ~]# id test
id: “test”：无此用户
[root@node1 ~]# id example 
uid=2002(example) gid=2002(test) 组=2002(test)

2.5.9 user.delete

删除用户

[root@node1 ~]# id example 
uid=2002(example) gid=2002(test) 组=2002(test)[root@master ~]# salt '*'  user.delete  example
node1:True[root@node1 ~]# id example
id: “example”：无此用户