SaltStack常用的模块

一. SaltStack模块介绍

官方文档：https://docs.saltproject.io/
saltstack有执行模块与状态模块两种。

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

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

查看模块的方法有两种：

1、在官方网站上看
2、通过命令行查看（就是下面这种）

建议去官方网站上看，结构更加清晰，一目了然

//查看所有module数量
[root@master ~]# salt 'minion' sys.list_modules|wc -l
171       ## 这里列出有171，但是实际上官网上不止171个，还有很多模块是针对其他系统的，甚至网络设备，例如：路由器、交换机等。

//查看指定module的所有function
[root@master ~]# salt 'minion' sys.list_modules
minion:
    - 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
    - 此处省略N行

//查看test模块的函数
[root@master ~]# salt 'minion' sys.list_functions cmd
minion:
    - 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 'minion' 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 containing
    the 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行...
这种方式去看，找什么东西很麻烦，除非用less查找的功能去查找，可以查找自己想要的模块的用法
[root@master ~]# salt 'minion' sys.doc cmd|less
    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"}'
    

cmd.exec_code_all:

    Pass in two strings, the first naming the executable language, :

// 查看某一个模块里面的某一个函数
[root@master ~]# salt 'minion' sys.doc cmd.run

//SaltStack默认也支持一次执行多个Module，Module之间通过逗号隔开，默认传参之间也是用逗号分隔，也支持指定传参分隔符号--args-separator=@即可
多个模块用逗号隔开（2个以上），模块和参数之前有一个空格，例如service.status "hello world"，所有的参数之间是用逗号隔开的
[root@master ~]# salt '*' test.echo,cmd.run,service.status "hello world".date,sshd       
## test.echo 是一个模块，看输出信息，看hello world；cmd.run是一个模块，是执行命令，执行date，查看日期；service.status是一个模块，查看服务的状态，查看sshd的服务状态。
minion:
    ----------
    cmd.run:
        Wed Nov  3 17:42:22 CST 2021
    service.status:
        True
    test.echo:
        hello world     ## 这个变量里面如果有空格就要用双引号引起来，没有空格就直接用就可以。

二、SaltStack常用模块

1 SaltStack常用模块之network（网络模块）

1.1 network.active_tcp（查看主机建立了哪些连接）

// 在minion端本机上查看已经建立的连接
[root@minion ~]# ss -ant
State  Recv-Q  Send-Q    Local Address:Port      Peer Address:Port  Process                                                             
LISTEN 0       128             0.0.0.0:80             0.0.0.0:*                                                                         
LISTEN 0       128             0.0.0.0:22             0.0.0.0:*                                                                         
ESTAB  0       0        192.168.35.135:56458   192.168.35.136:4505                                                                      
ESTAB  0       0        192.168.35.135:22        192.168.35.1:57933                                                                     
ESTAB  0       36       192.168.35.135:22        192.168.35.1:57931                                                                     
LISTEN 0       128                [::]:80                [::]:*                                                                         
LISTEN 0       128                [::]:22                [::]:*    

// 在master端查看minion端已经建立的连接
[root@master ~]# salt 'minion' network.active_tcp
minion:
    ----------
    0:
        ----------
        local_addr:
            192.168.35.135
        local_port:
            56458
        remote_addr:
            192.168.35.136
        remote_port:
            4505
    1:
        ----------
        local_addr:
            192.168.35.135
        local_port:
            22
        remote_addr:
            192.168.35.1
        remote_port:
            57933
    2:
        ----------
        local_addr:
            192.168.35.135
        local_port:
            22
        remote_addr:
            192.168.35.1
        remote_port:
            57931

1.2 network.calc_net（计算网络）

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

[root@master ~]# salt 'minion' network.calc_net 192.168.1.1 255.255.255.0
minion:
    192.168.1.0/24
[root@master ~]# salt 'minion' network.calc_net 192.168.1.1 255.255.0.0
minion:
    192.168.0.0/16
[root@master ~]# salt 'minion' network.calc_net 192.168.1.1 255.255.248.0
minion:
    192.168.0.0/21

1.3 network.connect

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

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

1.4 network.default_route

查看默认路由

[root@master ~]# salt 'minion' network.default_route
minion:
    |_
      ----------
      addr_family:
          inet
      destination:
          0.0.0.0
      flags:
          UG
      gateway:
          192.168.35.2
      interface:
          ens33
      netmask:
          0.0.0.0
这个查看的是某一个命令的内容，就是route -n的命令的内容，但是在centos8上面没有route命令，如果你想看的话就需要去安装
[root@master ~]# yum -y install net-tools
[root@master ~]# route -n
Kernel IP routing table
Destination     Gateway         Genmask         Flags Metric Ref    Use Iface
0.0.0.0         192.168.35.2    0.0.0.0         UG    100    0        0 ens33
192.168.35.0    0.0.0.0         255.255.255.0   U     100    0        0 ens33

1.5 network.get_fqdn

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

[root@master ~]# salt 'minion' network.get_fqdn      ## 如果名字是比较长的话，fqdn这个命令可以把整个都取出来，而hostname只会取一部分
minion:
    minion

1.6 network.get_hostname

获取主机名

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

1.7 network.get_route（获取路由信息）

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

[root@master ~]# salt 'minion' network.get_route 192.168.180.128
minion:
    ----------
    destination:
        192.168.180.128
    gateway:
        192.168.35.2
    interface:
        ens33
    source:
        192.168.35.135

1.8 network.hw_addr（获取MAC地址）

返回指定网卡的MAC地址（所谓的硬件地址就是mac地址）

[root@master ~]# salt 'minion' network.hw_addr ens33
minion:
    00:0c:29:b1:e1:b3

1.9 network.ifacestartswith

从特定CIDR检索接口名称（通过网络地址来确定它网卡的名字）
一个网卡可能有多个IP，那么想看某一个IP在哪一个网卡里面，就用这个命令

[root@master ~]# salt 'minion' network.ifacestartswith 192
minion:
    - ens33
[root@master ~]# salt 'minion' network.ifacestartswith 127
minion:
    - lo
[root@