fortinet.fortimanager.fmgr_fmupdate_fdssetting_serveroverride_servlist — Сервер-замена.
Примечание
Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в плейбуке укажите: fortinet.fortimanager.fmgr_fmupdate_fdssetting_serveroverride_servlist.
В версии 2.10: модуля fortinet.fortimanager
Обзор
- Этот модуль может настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать в источниках данных перед использованием.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| bypass_validation логическое значение |
| устанавливается в True только при расхождениях схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров | |
| fmupdate_fdssetting_serveroverride_servlist словарь | параметры верхнего уровня | ||
| id целое число | Значение по умолчанию: 0 | ID сервера-замены (1 - 10). | |
| ip строка | Значение по умолчанию: "0.0.0.0" | IPv4-адрес сервера-замены. | |
| ip6 строка | Значение по умолчанию: "::" | IPv6-адрес сервера-замены. | |
| port целое число | Значение по умолчанию: 443 | Порт для связи с FortiGuard (1 - 65535, по умолчанию = 443). | |
| service-type список / элементы=строка |
| нет описания | |
| rc_failed список / элементы=строка | список кодов rc, при которых условия будут игнорироваться | ||
| rc_succeeded список / элементы=строка | список кодов rc, при которых условия будут игнорироваться | ||
| state строка / обязательно |
| направление для создания, обновления или удаления объекта | |
| 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: Override server.
fmgr_fmupdate_fdssetting_serveroverride_servlist:
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, ...]
state: <value in [present, absent]>
fmupdate_fdssetting_serveroverride_servlist:
id: <value of integer>
ip: <value of string>
ip6: <value of string>
port: <value of integer>
service-type:
- fds
- fct
Возвращаемые значения
Общие возвращаемые значения описаны в этом документе, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| 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_fmupdate_fdssetting_serveroverride_servlist_module.html