fortinet.fortimanager.fmgr_system_sdnconnector_nic_ip – Настройка IP-конфигурации.
Примечание
Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в плейбуке укажите: fortinet.fortimanager.fmgr_system_sdnconnector_nic_ip.
Новое в версии 2.10: модуля fortinet.fortimanager
Обзор
- Этот модуль способен настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать в источниках данных перед использованием.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| adom строка / обязательный | параметр (adom) в запрошенном URL | ||
| bypass_validation логическое значение |
| устанавливается в значение True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров | |
| nic строка / обязательный | параметр (nic) в запрошенном URL | ||
| rc_failed список / элементы=строка | список кодов rc, при которых будут нарушены условия завершения с ошибкой | ||
| rc_succeeded список / элементы=строка | список кодов rc, при которых будут нарушены условия успешного завершения | ||
| sdn-connector строка / обязательный | параметр (sdn-connector) в запрошенном URL | ||
| state строка / обязательный |
| директива для создания, обновления или удаления объекта | |
| system_sdnconnector_nic_ip словарь | установленные параметры верхнего уровня | ||
| name строка | Имя конфигурации IP. | ||
| public-ip строка | Имя публичного IP. | ||
| workspace_locking_adom строка | область, которую нужно заблокировать для FortiManager, работающего в режиме рабочей области; значение может быть глобальным и другими, включая корень | ||
| 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: Configure IP configuration.
fmgr_system_sdnconnector_nic_ip:
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, ...]
adom: <your own value>
sdn-connector: <your own value>
nic: <your own value>
state: <value in [present, absent]>
system_sdnconnector_nic_ip:
name: <value of string>
public-ip: <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_system_sdnconnector_nic_ip_module.html
