Модуль community.network.ig_unit_information – Получение информации о устройстве с Ingate SBC.

Примечание

Этот модуль является частью коллекции community.network (версия 5.0.3).

Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.network. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробностей.

Для использования в playbook укажите: community.network.ig_unit_information.

Описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Описание

Получение информации о устройстве с 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 используйте команду 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"`

Авторы

Ingate Systems AB (@ingatesystems)

Ссылки на сборку

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/network/ig_unit_information_module.html