Модуль fortinet.fortios.fortios_user_pop3 — Настройка записи сервера POP3 в FortiOS и FortiGate Fortinet.
Примечание
Этот модуль является частью коллекции fortinet.fortios (версия 2.3.7).
Эта коллекция может быть уже установлена, если вы используете пакет 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), позволяя пользователю устанавливать и изменять параметры пользователя и категорию POP3. Примеры включают все параметры и значения, которые необходимо скорректировать в источниках данных перед использованием. Тестировалось с FOS v6.0.0
Требования
Ниже приведены требования, необходимые на хосте, на котором выполняется этот модуль.
- ansible>=2.15
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Аутентификация по токену. Сгенерирован из интерфейса Fortigate. |
enable_log булево | Включить/отключить логирование задачи. Варианты:
|
member_path строка | Путь к атрибуту члена для обработки. Разделяется с помощью символа косой черты, если атрибутов несколько. Параметр, помеченный member_path, подходит для выполнения операции member. |
member_state строка | Добавление или удаление члена в указанном пути атрибута. Когда member_state задан, параметр state игнорируется. Варианты:
|
state строка / обязательно | Указывает, нужно ли создать или удалить объект. Варианты:
|
user_pop3 словарь | Настройка записи сервера POP3. |
|
name строка / обязательно |
Имя записи сервера POP3. |
|
port целое число |
Порт службы POP3. |
|
secure строка |
SSL-соединение. Варианты:
|
|
server строка |
Имя домена или IP-адрес сервера. |
|
ssl_min_proto_version строка |
Минимальная поддерживаемая версия протокола для SSL/TLS-соединений. Варианты:
|
vdom строка | Виртуальный домен, среди ранее определенных. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: |
Примечания
Примечание
- Модуль 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 строка | Номер сборки образа fortigate Возвращается: всегда Пример: |
http_method строка | Последний метод, используемый для подготовки контента в FortiGate Возвращается: всегда Пример: |
http_status строка | Последний результат, полученный от FortiGate в последней операции Возвращается: всегда Пример: |
mkey строка | Главный ключ (id), используемый в последнем запросе к FortiGate Возвращается: успешно Пример: |
name строка | Имя таблицы, используемой для выполнения запроса Возвращается: всегда Пример: |
path строка | Путь к таблице, используемой для выполнения запроса Возвращается: всегда Пример: |
revision строка | Внутренний номер версии Возвращается: всегда Пример: |
serial строка | Серийный номер устройства Возвращается: всегда Пример: |
status строка | Указание результата операции Возвращается: всегда Пример: |
vdom строка | Используемый виртуальный домен Возвращается: всегда Пример: |
version строка | Версия FortiGate Возвращается: всегда Пример: |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_user_pop3_module.html
