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. | |
| timeout целое число | Время ожидания (в секундах) для запросов REST API. | ||
| username string / обязательно | Имя пользователя REST API. | ||
| validate_certs boolean |
| Проверять сертификат HTTPS устройства. Псевдонимы: verify_ssl | |
| version string |
| Версия 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 сложное | успех | Информация об устройстве | |
| installid строка | успех | Идентификатор установки Пример: любое | |
| interfaces строка | успех | Список имён интерфейсов Пример: eth0 eth1 eth2 eth3 eth4 eth5 | |
| lang строка | успех | Язык устройства Пример: en | |
| lic_email строка | успех | Информация о лицензионной электронной почте Пример: example@example.com | |
| lic_mac строка | успех | Информация о лицензионном MAC-адресе Пример: любое | |
| 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 | |
Статус
- Не гарантируется обратная совместимость интерфейса модуля. [превью]
- Этот модуль поддерживается сообществом 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.8/modules/ig_unit_information_module.html
