fortinet.fortimanager.fmgr_user_pop3 – Настройка записи сервера POP3.
Примечание
Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в книге задач укажите: fortinet.fortimanager.fmgr_user_pop3.
В версии 2.10: модуля fortinet.fortimanager
Описание
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать перед использованием.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| adom строка / обязательно | параметр (adom) в запрошенном URL | ||
| bypass_validation логическое значение |
| устанавливается в True только при расхождениях схемы модуля со структурой API FortiManager; модуль продолжает выполнение без валидации параметров | |
| rc_failed список / элементы=строка | список кодов rc, при которых будут отменены условия для отказа | ||
| rc_succeeded список / элементы=строка | список кодов rc, при которых будут отменены условия для успеха | ||
| state строка / обязательно |
| указание на создание, обновление или удаление объекта | |
| user_pop3 словарь | устанавливаемые параметры верхнего уровня | ||
| name строка | Имя записи сервера POP3. | ||
| port целое число | Номер порта POP3-службы. | ||
| secure строка |
| Подключение SSL. | |
| server строка | {<имя_строки|ip_строки>} доменное имя или IP-адрес сервера. | ||
| ssl-min-proto-version строка |
| Минимальная поддерживаемая версия протокола для SSL/TLS-соединений (по умолчанию используется системное глобальное значение). | |
| workspace_locking_adom строка | Область для блокировки FortiManager, работающего в режиме рабочей области; значение может быть глобальным и др., включая корневой. | ||
| workspace_locking_timeout целое число | По умолчанию: 300 | максимальное время в секундах ожидания, пока другой пользователь не разблокирует рабочую область. | |
Примечания
Примечание
- Работа в режиме блокировки рабочей области поддерживается в этом модуле FortiManager; параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout помогают в этой работе.
- Для создания или обновления объекта используйте состояние present.
- Для удаления объекта используйте состояние 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: POP3 server entry configuration.
fmgr_user_pop3:
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>
state: <value in [present, absent]>
user_pop3:
name: <value of string>
port: <value of integer>
secure: <value in [none, starttls, pop3s]>
server: <value of string>
ssl-min-proto-version: <value in [default, TLSv1, TLSv1-1, ...]>
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие — поля, уникальные для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| 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_user_pop3_module.html
