Модуль fortinet.fortios.fortios_user_pop3 — настройка записи POP3-сервера в Fortinet FortiOS и FortiGate.

Примечание

Этот модуль входит в коллекцию fortinet.fortios (версия 2.5.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.

Чтобы использовать модуль в сценарии, укажите: fortinet.fortios.fortios_user_pop3.

Добавлено в fortinet.fortios 2.0.0

Краткое описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), задавая и изменяя параметры функции user и категории pop3. Примеры содержат все параметры и значения, которые необходимо адаптировать к источникам данных перед использованием. Проверено с FOS v6.0.0

Требования

На узле, на котором выполняется этот модуль, должны быть установлены следующие компоненты.

ansible>=2.16

Параметры

Параметр	Комментарии
access_token string	Аутентификация на основе токена. Создается в графическом интерфейсе FortiGate.
enable_log boolean	Включить или отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
member_path string	Путь к атрибуту элемента, над которым выполняется операция. Если атрибутов несколько, они разделяются символом косой черты. Параметр с пометкой member_path предназначен для выполнения операций с элементами.
member_state string	Добавить или удалить элемент по указанному пути к атрибуту. Если указан member_state, параметр state игнорируется. Варианты: `"present"` `"absent"`
state string / обязательный	Определяет, нужно ли создать или удалить объект. Варианты: `"present"` `"absent"`
user_pop3 dictionary	Настройка записи POP3-сервера.
name string / обязательный	Имя записи POP3-сервера.
port integer	Номер порта службы POP3.
secure string	SSL-соединение. Варианты: `"none"` `"starttls"` `"pop3s"`
server string	Доменное имя или IP-адрес сервера.
ssl_min_proto_version string	Минимальная поддерживаемая версия протокола для SSL/TLS-соединений. Варианты: `"default"` `"SSLv3"` `"TLSv1"` `"TLSv1-1"` `"TLSv1-2"` `"TLSv1-3"`
vdom string	Виртуальный домен из числа ранее определенных. VDOM — это виртуальный экземпляр FortiGate, который можно настраивать и использовать как отдельное устройство. По умолчанию: `"root"`

Примечания

Примечание

Устаревший fortiosapi объявлен нерекомендуемым; предпочтительный способ запуска сценариев — httpapi.
Модуль поддерживает check_mode.

Примеры

- name: POP3 server entry configuration.
  fortinet.fortios.fortios_user_pop3:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      user_pop3:
          name: "default_name_3"
          port: "0"
          secure: "none"
          server: "192.168.100.40"
          ssl_min_proto_version: "default"

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
build string	Номер сборки образа FortiGate Возвращается: всегда Пример: `"1547"`
http_method string	Последний метод, использованный для передачи данных на FortiGate Возвращается: всегда Пример: `"PUT"`
http_status string	Последний результат, возвращенный FortiGate при выполнении последней операции Возвращается: всегда Пример: `"200"`
mkey string	Главный ключ (идентификатор), использованный в последнем вызове FortiGate Возвращается: при успешном выполнении Пример: `"id"`
name string	Имя таблицы, использованной для выполнения запроса Возвращается: всегда Пример: `"urlfilter"`
path string	Путь к таблице, использованной для выполнения запроса Возвращается: всегда Пример: `"webfilter"`
revision string	Внутренний номер ревизии Возвращается: всегда Пример: `"17.0.2.10658"`
serial string	Серийный номер устройства Возвращается: всегда Пример: `"FGVMEVYYQT3AB5352"`
status string	Результат операции Возвращается: всегда Пример: `"success"`
vdom string	Используемый виртуальный домен Возвращается: всегда Пример: `"root"`
version string	Версия FortiGate Возвращается: всегда Пример: `"v5.6.3"`

Авторы

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Hongbin Lu (@fgtdev-hblu)
Frank Shen (@frankshen01)
Miguel Angel Munoz (@mamunozgonzalez)
Nicolas Thomas (@thomnico)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortios/fortios_user_pop3_module.html