ig_unit_information – Получение информации об устройстве из Ingate SBC

Новая версия 2.8.

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

Обзор

Получение информации об устройстве из Ingate SBC.

Требования

Ниже приведены требования к хосту, на котором выполняется этот модуль.

ingatesdk >= 1.0.6

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
client -			Объект типа dict, содержащий данные подключения.
	address string / обязательно		Имя хоста или IP-адрес устройства.
	password string / обязательно		Пароль пользователя REST API.
	port целое число		Порт HTTP(S) для подключения.
	scheme string / обязательно	Варианты: http https	Протокол HTTP, который необходимо использовать.
	timeout целое число		Таймаут (в секундах) для запросов REST API.
	username string / обязательно		Имя пользователя REST API.
	validate_certs boolean	Варианты: no да ←	Проверить сертификат HTTPS устройства. псевдонимы: verify_ssl
	version string	Варианты: v1 ←	Версия REST API.

Примечания

Примечание

Для работы этого модуля требуется установка Ingate Python SDK на хост. Для установки SDK используйте команду pip из вашей оболочки pip install ingatesdk.

Примеры

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

Возвращаемые значения

Общие возвращаемые значения документированы здесь, ниже приведены поля, уникальные для данного модуля:

Ключ		Возвращаемое значение	Описание
unit-information complex		успех	Информация об устройстве
	installid string	успех	Идентификатор установки Пример: любое значение
	interfaces string	успех	Список имён интерфейсов Пример: eth0 eth1 eth2 eth3 eth4 eth5
	lang string	успех	Язык устройства Пример: en
	lic_email string	успех	Информация о лицензионной почте Пример: example@example.com
	lic_mac string	успех	Информация о лицензионном MAC-адресе Пример: любое значение
	lic_name string	успех	Информация о лицензионном имени Пример: Example Inc
	macaddr string	успех	MAC-адрес первого интерфейса Пример: 52:54:00:4c:e2:07
	mode string	успех	Рабочий режим устройства Пример: Siparator
	modules string	успех	Установленные модули лицензий Пример: failover vpn sip qturn ems qos rsc voipsm
	patches list	успех	Установленные исправления на устройстве
	product string	успех	Название продукта Пример: Программное обеспечение SIParator/Брандмауэр
	serial string	успех	Серийный номер устройства Пример: IG-200-839-2008-0
	systemid string	успех	Идентификатор системы устройства Пример: IG-200-839-2008-0
	unitname string	успех	Имя устройства Пример: Testname
	version string	успех	Версия прошивки Пример: 6.2.0-beta2

Статус

Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

Ingate Systems AB (@ingatesystems)

Подсказка

Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/ig_unit_information_module.html