SaltStack常用的模块

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- baredoc- beacons- bigip- btrfs- buildout- chroot- cloud- cmd- composer- config- consul- container_resource- cp- cron- cryptdev- data- defaults- devinfo- devmap- disk
..........................//查看指定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 service
service.available:New in version 0.10.4Check that the given service is available taking into account templateunits.CLI Example:salt '*' service.available sshd//SaltStack默认也支持一次执行多个Module，Module之间通过逗号隔开，默认传参之间也是用逗号分隔，也支持指定传参分隔符号--args-separator=@即可
[root@master ~]# salt 'node1' test.echo,cmd.run,service.status hello,hostname,salt-minion
node1:----------cmd.run:node1service.status:Truetest.echo:hello

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.72.139local_port:22remote_addr:192.168.72.1remote_port:565041:----------local_addr:192.168.72.139local_port:22remote_addr:192.168.72.1remote_port:565022:----------local_addr:192.168.72.139local_port:58618remote_addr:192.168.72.141remote_port:4505

2.1.2 network.calc_net

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

[root@master ~]# salt 'node1' network.calc_net 192.168.72.139 255.255.255.0
node1:192.168.72.0/24
[root@master ~]# salt 'node1' network.calc_net 192.168.72.139 255.255.255.240
node1:192.168.72.128/28

2.1.3 network.connect

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

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

2.1.4 network.default_route

查看默认路由

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

2.1.5 network.get_fqdn

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

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

2.1.6 network.get_hostname

获取主机名

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

2.1.7 network.get_route

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

[root@master ~]# salt 'node1' network.get_route 192.168.70.240
node1:----------destination:192.168.70.240gateway:192.168.72.2interface:ens33source:192.168.72.139

2.1.8 network.hw_addr

返回指定网卡的MAC地址

[root@master ~]# salt 'node1' network.hw_addr ens33
node1:00:0c:29:4c:c0:b2

2.1.9 network.ifacestartswith

从特定CIDR检索接口名称

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

2.1.10 network.in_subnet

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

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

2.1.11 network.interface

返回指定网卡的信息

[root@master ~]# salt 'node1' network.interface ens33
node1:|_----------address:192.168.72.139broadcast:192.168.72.255label:ens33netmask:255.255.255.0

2.1.12 network.interface_ip

返回指定网卡的IP地址

[root@master ~]# salt 'node1' network.interface_ip ens33
node1:192.168.72.139

2.1.13 network.interfaces

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

[root@master ~]# salt 'node1' network.interfaces
node1:----------ens33:----------hwaddr:00:0c:29:4c:c0:b2inet:|_----------address:192.168.72.139broadcast:192.168.72.255label:ens33netmask:255.255.255.0inet6:|_----------address:fe80::8c5a:fae4:e5a7:a2b7prefixlen:64scope:linkup:Truelo:----------hwaddr:00:00:00:00:00:00inet:|_----------address:127.0.0.1broadcast:Nonelabel:lonetmask:255.0.0.0inet6:|_----------address:::1prefixlen:128scope:hostup:True

2.1.14 network.ip_addrs

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

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

2.1.15 network.netstat

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

[root@master ~]# salt 'node1' network.netstat
node1:|_----------inode:25399local-address:127.0.0.1:323program:chronydproto:udprecv-q:0remote-address:0.0.0.0:*send-q:0user:0|_----------inode:146716local-address:192.168.72.139%ens33:68program:NetworkManagerproto:udprecv-q:0remote-address:192.168.72.254:67send-q:0user:0|_----------inode:25400local-address:[::1]:323program:chronydproto:udprecv-q:0remote-address:[::]:*send-q:0user:0|_----------inode:28594local-address:0.0.0.0:22program:sshdproto:tcprecv-q:0remote-address:0.0.0.0:*send-q:128state:LISTENuser:0|_----------inode:150157local-address:192.168.72.139:22program:sshdproto:tcprecv-q:0remote-address:192.168.72.1:56504send-q:0state:ESTABLISHEDuser:0|_----------inode:0local-address:192.168.72.139:39688program:proto:tcprecv-q:0remote-address:192.168.72.141:4506send-q:0state:TIME-WAITuser:0|_----------inode:150018local-address:192.168.72.139:22program:sshdproto:tcprecv-q:0remote-address:192.168.72.1:56502send-q:0state:ESTABLISHEDuser:0|_----------inode:49256local-address:192.168.72.139:58618program:salt-minionproto:tcprecv-q:0remote-address:192.168.72.141:4505send-q:0state:ESTABLISHEDuser:0|_----------inode:28596local-address:[::]:22program:sshdproto:tcprecv-q:0remote-address:[::]:*send-q:128state:LISTENuser:0|_----------inode:30729local-address:*:3306program:mysqldproto:tcprecv-q:0remote-address:*:*send-q:80state:LISTENuser:993|_----------inode:74372local-address:*:80program:httpdproto:tcprecv-q:0remote-address:*:*send-q:128state:LISTENuser:0

2.1.16 network.ping

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

[root@master ~]# salt 'node1' network.ping lol.qq.com
node1:PING lol.qq.com.x2.sched.dcloudstc.com (211.162.179.143) 56(84) bytes of data.64 bytes from 211.162.179.143 (211.162.179.143): icmp_seq=1 ttl=128 time=194 ms64 bytes from 211.162.179.143 (211.162.179.143): icmp_seq=2 ttl=128 time=40.0 ms64 bytes from 211.162.179.143 (211.162.179.143): icmp_seq=3 ttl=128 time=28.10 ms64 bytes from 211.162.179.143 (211.162.179.143): icmp_seq=4 ttl=128 time=32.1 ms--- lol.qq.com.x2.sched.dcloudstc.com ping statistics ---4 packets transmitted, 4 received, 0% packet loss, time 3003msrtt min/avg/max/mdev = 28.976/73.818/194.202/69.619 ms

2.1.17 network.reverse_ip

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

[root@master ~]# salt 'node1' network.reverse_ip 192.168.72.77
node1:77.72.168.192.in-addr.arpa

2.2 SaltStack常用模块之service

2.2.1 service.available

判断指定的服务是否可用

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

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- boot-complete.target- chrony-dnssrv@- chrony-dnssrv@.timer- chrony-wait- chronyd
..................

2.2.3 service.disabled

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

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

2.2.4 service.enabled

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

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

2.2.5 service.disable

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

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

2.2.6 service.enable

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

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

2.2.7 service.reload

重新加载指定服务

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

2.2.8 service.stop

停止指定服务

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

2.2.9 service.start

启动指定服务

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

2.2.10 service.restart

重启指定服务

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

2.2.11 service.status

查看指定服务的状态

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

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@node1 ~]#  ls /var/cache/yum/packages/
wget-1.19.5-10.el8.x86_64.rpm

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

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

2.3.4 pkg.group_list

列出系统中所有的包组

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

2.3.5 pkg.install

安装软件

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

2.3.6 pkg.list_downloaded

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

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

2.3.7 pkg.list_pkgs

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

[root@master ~]# salt 'node1' pkg.list_pkgs
node1:----------NetworkManager:1:1.30.0-0.3.el8NetworkManager-libnm:1:1.30.0-0.3.el8NetworkManager-team:1:1.30.0-0.3.el8NetworkManager-tui:1:1.30.0-0.3.el8abattis-cantarell-fonts:0.0.25-4.el8acl:2.2.53-1.el8adwaita-cursor-theme:3.28.0-2.el8adwaita-icon-theme:3.28.0-2.el8apr:1.6.3-12.el8apr-util:1.6.1-6.el8apr-util-bdb:1.6.1-6.el8apr-util-openssl:1.6.1-6.el8at-spi2-atk:2.26.2-1.el8at-spi2-core:2.28.0-1.el8atk:2.28.1-1.el8audit:3.0-0.17.20191104git1c2f876.el8audit-libs:3.0-0.17.20191104git1c2f876.el8

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

2.3.9 pkg.remove

卸载指定软件

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

2.3.10 pkg.upgrade

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

[root@master ~]# salt 'node1' pkg.upgrade name=openssl
node1:----------

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 web.apache.install
node1:
----------ID: apache-installFunction: pkg.installedName: httpdResult: TrueComment: All specified packages are already installedStarted: 01:24:25.293139Duration: 789.669 msChanges:   
----------ID: apache-serviceFunction: service.runningName: httpdResult: TrueComment: The service httpd is already runningStarted: 01:24:26.089202Duration: 42.269 msChanges:   Summary for node1
------------
Succeeded: 2
Failed:    0
------------
Total states run:     2
Total run time: 831.938 ms

2.4.3 state.show_state_usage

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

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

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: 01:26:38.170942Duration: 760.652 msChanges:   
----------ID: apache-serviceFunction: service.runningName: httpdResult: TrueComment: The service httpd is already runningStarted: 01:26:38.933585Duration: 40.438 msChanges:   Summary for node1
------------
Succeeded: 2
Failed:    0
------------
Total states run:     2
Total run time: 801.090 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//拷贝多个文件到目标主机的/usr/src目录下   
[root@master ~]# salt-cp 'node1' /etc/shadow /etc/group /usr/src
node1:----------/usr/src/group:True/usr/src/shadow:True
[root@master ~]# salt 'node1' cmd.run 'ls /usr/src/'
node1:debuggroupkernelspasswdshadow

2.6 SaltStack常用模块之user

2.6.1 user.add

添加用户到节点

[root@master ~]# salt 'node1' user.add xiongke
node1:True
[root@master ~]# salt 'node1' cmd.run 'tail -1 /etc/passwd'
node1:xiongke:x:1000:1000::/home/xiongke:/bin/bash

2.6.2 user.chfullname

改变用户全名

[root@master ~]# salt 'node1' user.chfullname xiongke "xk"
node1:True

2.6.3 user.chuid

更改用户UID

[root@master ~]# salt 'node1' user.chuid xiongke 1001
node1:True
[root@master ~]# salt 'node1' cmd.run 'tail -1 /etc/passwd'
node1:xiongke:x:1001:1000:xk:/home/xiongke:/bin/bash

2.6.4 user.chgid

更改用户GID

[root@master ~]# salt 'node1' user.chgid xiongke 999
node1:True
[root@master ~]# salt 'node1' cmd.run 'tail -1 /etc/passwd'
node1:xiongke:x:1001:999:xk:/home/xiongke:/bin/bash

2.6.5 user.chgroups

更改用户属组，追加指定用户组

[root@master ~]# salt 'node1' user.chgroups xiongke root true
node1:True
[root@master ~]# salt 'node1' cmd.run 'id xiongke'
node1:uid=1001(xiongke) gid=999(input) groups=999(input),0(root)

2.6.6 user.chhome

更改用户家目录，拷贝原家目录到新家目录

[root@master ~]# salt 'node1' user.chhome xiongke /home/xk 
node1:True
[root@master ~]# salt 'node1' cmd.run 'tail -1 /etc/passwd'
node1:xiongke:x:1001:999:xk:/home/xk:/bin/bash