community.network.ig_unit_information 模块 – 从 Ingate SBC 获取单元信息。

注意

此模块是 community.network 集合（版本 5.1.0）的一部分。

如果您正在使用 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install community.network。您需要进一步的要求才能使用此模块，有关详细信息，请参阅要求。

要在 playbook 中使用它，请指定：community.network.ig_unit_information。

注意

community.network 集合已被弃用，将从 Ansible 12 中删除。有关更多信息，请参阅讨论线程。

已弃用

删除于:

版本 6.0.0

原因:

此集合及其中的所有内容均未维护且已弃用。

替代方案:

未知。

概要

  • 从 Ingate SBC 获取单元信息。

别名：network.ingate.ig_unit_information

要求

执行此模块的主机上需要以下要求。

  • ingatesdk >= 1.0.6

参数

参数

注释

客户端

字符串

包含连接详细信息的字典对象。

地址

字符串 / 必填

单元的主机名或 IP 地址。

密码

字符串 / 必填

REST API 用户的密码。

端口

整数

要连接的 HTTP(S) 端口。

协议

字符串 / 必填

要使用的 HTTP 协议。

选择

  • "http"

  • "https"

超时

整数

REST API 请求的超时（以秒为单位）。

用户名

字符串 / 必填

REST API 用户的用户名。

validate_certs

别名：verify_ssl

布尔值

验证单元的 HTTPS 证书。

选择

  • false

  • true ← (默认)

版本

字符串

REST API 版本。

选择

  • "v1" ← (默认)

说明

注意

  • 此模块要求在主机上安装 Ingate Python SDK。要安装 SDK，请从 shell 使用 pip 命令 pip install ingatesdk。

示例

- name: Get unit information
  community.network.ig_unit_information:
    client:
      version: v1
      scheme: http
      address: 192.168.1.1
      username: alice
      password: foobar

返回值

常见返回值在 此处记录，以下是此模块独有的字段

键

描述

单元信息

复杂

有关单元的信息

已返回: 成功

安装 ID

字符串

安装标识符

已返回: 成功

示例: "任何"

接口

字符串

接口名称列表

已返回: 成功

示例: "eth0 eth1 eth2 eth3 eth4 eth5"

语言

字符串

单元的语言

已返回: 成功

示例: "en"

lic_email

字符串

许可证电子邮件信息

已返回: 成功

示例: "[email protected]"

lic_mac

字符串

许可证 MAC 信息

已返回: 成功

示例: "任何"

lic_name

字符串

许可证名称信息

已返回: 成功

示例: "示例 Inc"

macaddr

字符串

第一个接口的 MAC 地址

已返回: 成功

示例: "52:54:00:4c:e2:07"

模式

字符串

单元的操作模式

已返回: 成功

示例: "Siparator"

模块

字符串

已安装的模块许可证

已返回: 成功

示例: "failover vpn sip qturn ems qos rsc voipsm"

补丁

列表 / 元素=字符串

设备上已安装的补丁

已返回: 成功

示例: []

产品

字符串

产品名称

已返回: 成功

示例: "Software SIParator/Firewall"

序列号

字符串

设备的序列号

已返回: 成功

示例: "IG-200-839-2008-0"

系统ID

字符串

设备的系统标识符

已返回: 成功

示例: "IG-200-839-2008-0"

设备名称

字符串

设备的名称

已返回: 成功

示例: "Testname"

版本

字符串

固件版本

已返回: 成功

示例: "6.2.0-beta2"

状态

  • 此模块将在 6.0.0 版本中删除。[已弃用]

  • 有关更多信息，请参阅 已弃用。

作者

  • Ingate Systems AB (@ingatesystems)