fortinet.fortimanager.fmgr_sys_api_sdnconnector – Запрос данных коннектора SDN.
Примечание
Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в книге задач укажите: fortinet.fortimanager.fmgr_sys_api_sdnconnector.
Новое в версии 2.10: модуля fortinet.fortimanager
Описание
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо настроить для источников данных перед использованием.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| bypass_validation boolean |
| устанавливается в True только тогда, когда схема модуля отличается от структуры API FortiManager; модуль продолжает выполнение без проверки параметров | |
| rc_failed список / элементы=строка | список кодов rc, по которым будут задаваться условия для завершения с ошибкой | ||
| rc_succeeded список / элементы=строка | список кодов rc, по которым будут задаваться условия для успешного завершения | ||
| sys_api_sdnconnector словарь | установленные параметры верхнего уровня | ||
| adom строка | Имя ADOM. | ||
| command строка | Только для коннекторов ACI и Nuage, может быть либо egps, либо tenants. | ||
| connector_name строка | Объект коннектора в ADOM, который необходимо запросить. | ||
| workspace_locking_adom строка | adom для блокировки FortiManager, работающего в режиме рабочей области. значение может быть глобальным и другими, включая root. | ||
| workspace_locking_timeout целое число | Значение по умолчанию: 300 | максимальное время в секундах ожидания освобождения блокировки рабочей области другим пользователем | |
Примечания
Примечание
- Поддержка работы в режиме блокировки рабочей области реализована в этом модуле FortiManager, параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout помогают в этом.
- Для создания или обновления объекта используйте директиву state present.
- Для удаления объекта используйте директиву state absent.
- Обычно выполнение одного модуля может завершиться ошибкой, если возвращен ненулевой код rc. Вы также можете переопределить условия для завершения с ошибкой или успешного завершения с помощью параметров rc_failed и rc_succeeded
Примеры
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Query SDN connector data.
fmgr_sys_api_sdnconnector:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
sys_api_sdnconnector:
adom: <value of string>
command: <value of string>
connector_name: <value of string>
Значения возврата
Общие значения возврата описаны в здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| request_url строка | всегда | Полный запрашиваемый URL Пример: /sys/login/user |
| response_code целое число | всегда | Статус запроса API |
| response_message строка | всегда | Дескриптивное сообщение ответа API Пример: OK. |
Авторы
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_sys_api_sdnconnector_module.html
