saltstack常用模块

1. SaltStack模块介绍

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

当安装好Master和Minion包后，系统上会安装很多Module

//查看所有module列表
[root@master ~]# salt '*' 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
...省略

//查看指定module的所有function
[root@master ~]# salt '*' sys.list_functions service
node1:
    - service.available
    - service.disable
    - service.disabled
    - service.enable
    - service.enabled
    - service.execs
    - service.firstboot
    - service.force_reload
    - service.get_all
    - service.get_disabled
    - service.get_enabled
    - service.get_running
    - service.get_static
    - service.mask
    - service.masked
    - service.missing
    - service.offline
    - service.reload
    - service.restart
    - service.show
    - service.start
    - service.status
    - service.stop
    - service.systemctl_reload
    - service.unmask

//查看指定module的用法
[root@master ~]# salt '*' sys.doc service
service.available:

    New in version 0.10.4

    Check that the given service is available taking into account template
    units.

    CLI Example:

        salt '*' service.available sshd
...省略

//SaltStack默认也支持一次执行多个Module，Module之间通过逗号隔开，默认传参之间也用逗号分隔，也支持指定传参分隔符号--args-separator=@，module和参数之间空格，当一个参数之间有空格必须用引号(hello world)
[root@master ~]# salt '*' test.echo,cmd.run,service.status "hello world",date,sshd
node1:
    ----------
    cmd.run:
        Thu Nov  4 03:14:18 CST 2021
    service.status:
        True
    test.echo:
        hello world

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.237.170
        local_port:
            22
        remote_addr:
            192.168.237.1
        remote_port:
            52805
    1:
        ----------
        local_addr:
            192.168.237.170
        local_port:
            55986
        remote_addr:
            192.168.237.167
        remote_port:
            4505

2.1.2 network.calc_net

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

[root@master ~]# salt '*' network.calc_net 192.168.237.170 255.255.0.0
node1:
    192.168.0.0/16
[root@master ~]# salt '*' network.calc_net 192.168.237.170 255.255.240.0
node1:
    192.168.224.0/20
[root@master ~]# salt '*' network.calc_net 192.168.237.170 255.255.255.0
node1:
    192.168.237.0/24

2.1.3 network.connect

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

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

2.1.4 network.default_route

查看默认路由

[root@master ~]# salt '*' network.default_route 
node1:
    |_
      ----------
      addr_family:
          inet
      destination:
          0.0.0.0
      flags:
          UG
      gateway:
          192.168.237.2
      interface:
          ens160
      netmask:
          0.0.0.0

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.70.200
node1:
    ----------
    destination:
        192.168.70.200
    gateway:
        192.168.237.2
    interface:
        ens160
    source:
        192.168.237.170

2.1.8 network.hw_addr

返回指定网卡的MAC地址

[root@master ~]# salt '*' network.hw_addr ens160
node1:
    00:0c:29:cd:b3:bb

2.1.9 network.ifacestartswith

从特定CIDR检索接口名称

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

2.1.10 network.in_subnet

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

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

2.1.11 network.interface

返回指定网卡的信息

[root@master ~]# salt '*' network.interface ens160
node1:
    |_
      ----------
      address:
          192.168.237.170
      broadcast:
          192.168.237.255
      label:
          ens160
      netmask:
          255.255.255.0

2.1.12 network.interface_ip

返回指定网卡的IP地址

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

2.1.13 network.interfaces

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

[root@master ~]# salt '*' network.interfaces
node1:
    ----------
    ens160:
        ----------
        hwaddr:
            00:0c:29:cd:b3:bb
        inet:
            |_
              ----------
              address:
                  192.168.237.170
              broadcast:
                  192.168.237.255
              label:
                  ens160
              netmask:
                  255.255.255.0
        inet6:
            |_
              ----------
              address:
                  fe80::cef:1b5b:1107:cf5d
              prefixlen:
                  64
              scope:
                  link
            |_
              ----------
              address:
                  fe80::7220:8af:6655:3c80
              prefixlen:
                  64
              scope:
                  link
        up:
            True
    lo:
        ----------
        hwaddr:
            00:00:00:00:00:00
        inet:
            |_
              ----------
              address:
                  127.0.0.1
              broadcast:
                  None
              label:
                  lo
              netmask:
                  255.0.0.0
        inet6:
            |_
              ----------
              address:
                  ::1
              prefixlen:
                  128
              scope:
                  host
        up:
            True

2.1.14 network.ip_addrs

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

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

2.1.15 network.netstat

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

[root@master ~]# salt '*' network.netstat 
node1:
    |_
      ----------
      inode:
          27378
      local-address:
          192.168.237.170%ens160:68
      program:
          NetworkManager
      proto:
          udp
      recv-q:
          0
      remote-address:
          192.168.237.254:67
      send-q:
          0
      user:
          0
    |_
      ----------
      inode:
          26986
      local-address:
          0.0.0.0:22
      program:
          sshd
      proto:
          tcp
      recv-q:
          0
      remote-address:
          0.0.0.0:*
      send-q:
          128
      state:
          LISTEN
      user:
          0
    |_
      ----------
      inode:
          27728
      local-address:
          0.0.0.0:80
      program:
          nginx
      proto:
          tcp
      recv-q:
          0
      remote-address:
          0.0.0.0:*
      send-q:
          128
      state:
          LISTEN
      user:
          0
    |_
      ----------
      inode:
          0
      local-address:
          192.168.237.170:33276
      program:
      proto:
          tcp
      recv-q:
          0
      remote-address:
          192.168.237.167:4506
      send-q:
          0
      state:
          TIME-WAIT
      user:
          0
    |_
      ----------
      inode:
          29911
      local-address:
          192.168.237.170:47000
      program:
          salt-minion
      proto:
          tcp
      recv-q:
          0
      remote-address:
          192.168.237.167:4505
      send-q:
          0
      state:
          ESTABLISHED
      user:
          0
    |_
      ----------
      inode:
          0
      local-address:
          192.168.237.170:33274
      program:
      proto:
          tcp
      recv-q:
          0
      remote-address:
          192.168.237.167:4506
      send-q:
          0
      state:
          TIME-WAIT
      user:
          0
    |_
      ----------
      inode:
          29452
      local-address:
          192.168.237.170:22
      program:
          sshd
      proto:
          tcp
      recv-q:
          0
      remote-address:
          192.168.237.1:56747
      send-q:
          0
      state:
          ESTABLISHED
      user:
          0
    |_
      ----------
      inode:
          26988
      local-address:
          [::]:22
      program:
          sshd
      proto:
          tcp
      recv-q:
          0
      remote-address:
          [::]:*
      send-q:
          128
      state:
          LISTEN
      user:
          0
    |_
      ----------
      inode:
          27729
      local-address:
          [::]:80
      program:
          nginx
      proto:
          tcp
      recv-q:
          0
      remote-address:
          [::]:*
      send-q:
          128
      state:
          LISTEN
      user:
          0

2.1.16 network.ping

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

[root@master ~]# salt '*' 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=24.7 ms
    64 bytes from 220.181.38.148 (220.181.38.148): icmp_seq=2 ttl=128 time=60.4 ms
    64 bytes from 220.181.38.148 (220.181.38.148): icmp_seq=3 ttl=128 time=25.1 ms
    64 bytes from 220.181.38.148 (220.181.38.148): icmp_seq=4 ttl=128 time=37.1 ms
    
    --- baidu.com ping statistics ---
    4 packets transmitted, 4 received, 0% packet loss, time 8ms
    rtt min/avg/max/mdev = 24.651/36.806/60.406/14.506 ms

2.1.17 network.reverse_ip

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

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

2.2 SaltStack常用模块之service

2.2.1 service.available

判断指定的服务是否可用

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

2.2.2 service.get_all

获取所有正在运行的服务

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

2.2.3 service.disabled

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

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

2.2.4 service.enabled

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

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

2.2.5 service.disable

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

[root@master ~]# salt '*' service.disable nginx
node1:
    True
[root@master ~]# salt '*' service.disabled nginx
node1:
    True

2.2.6 service.enable

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

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

2.2.7 service.reload

重新加载指定服务(服务必须正在运行)

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

2.2.8 service.stop

停止指定服务

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

2.2.9 service.start

启动指定服务

[root@master ~]# salt '*' service.start