• 探索Zabbix API(二):导出主机组及主机信息
    探索Zabbix API:企业监控管理工具
    在上一篇文章《探索Zabbix API(一):企业监控管理工具》中,我们初步了解了Zabbix API的基本使用方法和创建主机。本文将继续探索Zabbix API,看如何利用它来导出主机组及主机信息。
    01
    使用场景

    系统管理员管理数千台主机,当需要导出某个项目用了多少台主机,包含哪些IP,我们就可以从zabbix的主机群组中拿到这些信息。

     

    02
    导出主机组及主机信息
    步骤一:获取API访问令牌

    在使用Zabbix API之前,首先需要获取一个API访问令牌(Authentication Token)。这个令牌将用于对Zabbix API进行身份验证和授权。

    要获取API访问令牌,参考上一篇文章:《探索Zabbix API(一):企业监控管理工具》

    步骤二:编写Python脚本,该脚本主要有三个函数组成

    获取主机ID函数

    💡获取所有主机组ID

    def get_group_name(auth):
        data = {
            'jsonrpc': '2.0',
          
      'method': 'hostgroup.get',
            'params': {
                "output": ["groupid", "name"]
            },
            'auth': auth,
            'id': 2
        }
        response = requests.post(url=ApiUrl, headers=header, json=data)
        result = json.loads(response.content)
        group_names = result["result"]
        return group_names
    函数解析:

    1. ‘method’: ‘hostgroup.get’ :指定了要调用的 Zabbix API 方法,这里是获取主机组信息。
    2. ‘params’: 是方法的参数,这里要求返回主机组的 groupid 和 name。
    3. result = json.loads(response.content):这里将API的响应内容(JSON)加载为Python字典,方便后续处理。
    4. group_names = result[“result”]:从API的响应中提取出了主机组的信息,并将其存储在group_names变量中。
    5. return group_names:最后,将获取到的主机组信息返回给调用者。
    获取主机组信息函数

    💡使用第一个函数拿到的主机组ID,经此函数处理拿到主机组名和主机信息。

    def get_hosts_in_group(group_id, auth):
        data = {
            "jsonrpc": "2.0",
            "method": "host.get",
            "params": {
                "output": ["name", "interfaces"],
                "groupids": group_id,
                "filter": {
                    "status": "0"
                },
                "selectInterfaces": ["ip"],
            },
            "id": 1,
            "auth": auth
        }
        response = requests.post(url=ApiUrl, headers=header, json=data)
        result = json.loads(response.content)
        hosts = result["result"]
        return hosts

    函数解析:

    1. ‘method’: ‘host.get’: 指定要调用的 Zabbix API 方法,这里是获取主机信息。
    2. ‘params’: {…} :表示要返回主机的 name(主机名) 和 interfaces(接口信息)。
    3. ‘groupids’: group_id :指定了要获取的主机所属的主机组,这里使用了传入的 group_id 参数。
    4. ‘filter’: {“status”: “0”} :指定了一个过滤条件,这里要求只返回状态为正常的主机。
    5. ‘selectInterfaces’: [“ip”]: 指定了要返回主机接口的IP地址。
    6. headers=header :可能在代码的其他地方定义了一个包含请求头信息的 header 字典。
    7. json=data :将前面定义的 data 字典转换成了JSON格式,并作为POST请求的内容发送给API。
    8. hosts = result[“result”]:从API的响应中提取出了主机信息,并将其存储在 hosts 变量中。
     

    写入CSV函数

    💡通过第二个函数拿到的主机组信息和主机信息写入到csv表格中:
    def export_host_info(group_names, auth):
        with open('host_info.csv', 'w', newline='', encoding='utf-8-sig') as f:
            writer = csv.DictWriter(f, fieldnames=["Group", "Hostname", "IP"])
            writer.writeheader()
    
            for group in group_names:
                group_id = group['groupid']
                group_name = group['name']
                hosts = get_hosts_in_group(group_id, auth)
    
                for host in hosts:
                    hostname = host['name']
                    ip = host['interfaces'][0]['ip']
                    writer.writerow({"Group": group_name, "Hostname": hostname, "IP": ip})
    函数解析:
    1. with open(‘host_info.csv’, ‘w’, newline=”, encoding=’utf-8-sig’) as f:打开一个名为 host_info.csv 的CSV文件,准备写入数据。
    a: w:表示以写入模式打开文件;
    b: newline=’ ‘: 指定在写入CSV文件时不添加额外的空行;
    c: encoding=’utf-8-sig’ :表示以UTF-8编码写入文件。
    2.writer = csv.DictWriter(f, fieldnames=[“Group”, “Hostname”, “IP”]):创建一个CSV写入器,指定了字段名为 “Group”、”Hostname” 和 “IP”。
    3.writer.writeheader():写入CSV文件的表头(即字段名)。
    4.for group in group_names:遍历传入的主机组信息列表。
    5.group_id = group[‘groupid’] 和 group_name = group[‘name’]:提取出主机组的ID和名称。
    6.hosts = get_hosts_in_group(group_id, auth):调用之前定义的 get_hosts_in_group 函数,获取该主机组内的所有主机信息。
    7.for host in hosts:遍历该主机组内的所有主机信息。
    8.hostname = host[‘name’] 和 ip = host[‘interfaces’][0][‘ip’]:提取出主机的名称和IP地址。这里假设每个主机只有一个接口,因此使用了 [0] 来获取第一个接口的IP地址。
    9.writer.writerow({“Group”: group_name, “Hostname”: hostname, “IP”: ip}):将提取出的信息写入到CSV文件中。
    03
    结论
    通过Zabbix API,我们可以轻松地获取和导出主机组及主机信息,从而实现更高效的系统管理和监控。本文章介绍了如何使用Python编写函数来调用Zabbix API,从而实现主机组及主机信息的导出。下一篇文章我将介绍如何根据主机组和主机信息,自定义导出主机资源使用率,根据这些信息我们能生成日报等内容。

     

    «
    »
以专业成就每一位客户,让企业IT只为效果和安全买单

以专业成就每一位客户,让企业IT只为效果和安全买单