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

参数 

参数	注释
client 字符串	包含连接详细信息的字典对象。
address 字符串 / 必需	单元的主机名或 IP 地址。
password 字符串 / 必需	REST API 用户的密码。
port 整数	要连接的 HTTP(S) 端口。
scheme 字符串 / 必需	要使用的 HTTP 协议。选择 `"http"` `"https"`
timeout 整数	REST API 请求的超时时间（以秒为单位）。
username 字符串 / 必需	REST API 用户的用户名。
validate_certs 别名：verify_ssl 布尔值	验证单元的 HTTPS 证书。选择 `false` `true` ← (默认)
version 字符串	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

返回值 

常见的返回值记录在这里，以下是此模块特有的字段

键	描述
unit-information 复杂	有关单元的信息已返回：成功
installid 字符串	安装标识符已返回：成功示例： `"any"`
interfaces 字符串	接口名称列表已返回：成功示例： `"eth0 eth1 eth2 eth3 eth4 eth5"`
lang 字符串	单元的语言已返回：成功示例： `"en"`
lic_email 字符串	许可证电子邮件信息已返回：成功示例： `"example@example.com"`
lic_mac 字符串	许可证 MAC 信息已返回：成功示例： `"any"`
lic_name 字符串	许可证名称信息已返回：成功示例: `"Example Inc"`
macaddr 字符串	第一个接口的 MAC 地址已返回：成功示例: `"52:54:00:4c:e2:07"`
mode 字符串	设备的运行模式已返回：成功示例: `"Siparator"`
modules 字符串	已安装的模块许可证已返回：成功示例: `"failover vpn sip qturn ems qos rsc voipsm"`
patches 列表 / 元素=字符串	设备上已安装的补丁已返回：成功示例: `[]`
product 字符串	产品名称已返回：成功示例: `"Software SIParator/Firewall"`
serial 字符串	设备的序列号已返回：成功示例: `"IG-200-839-2008-0"`
systemid 字符串	设备的系统标识符已返回：成功示例: `"IG-200-839-2008-0"`
unitname 字符串	设备的名称已返回：成功示例: `"Testname"`
version 字符串	固件版本已返回：成功示例: `"6.2.0-beta2"`

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

已弃用 

概要 

要求 

参数 

备注 

示例 

返回值 

状态 

作者

集合链接