модуль fortinet.fortimanager.fmgr_user_exchange — настройка записей серверов MS Exchange.

Примечание

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

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

Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.

Чтобы использовать коллекцию в плейбуке, укажите: fortinet.fortimanager.fmgr_user_exchange.

Добавлено в fortinet.fortimanager 2.1.0

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Этот модуль позволяет настраивать устройство FortiManager.
В примерах приведены все параметры и значения, которые необходимо настроить в соответствии с источниками данных перед использованием.

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom string / обязательный	Параметр (adom) в запрашиваемом URL.
bypass_validation boolean	Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log boolean	Включить или отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token string	Аутентификация клиента Ansible с помощью токена доступа к API forticloud.
proposed_method string	Метод, переопределяющий метод базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed list / элементы=integer	Список кодов rc, переопределяющий условия ошибки.
rc_succeeded list / элементы=integer	Список кодов rc, переопределяющий условия успешного выполнения.
revision_note string	Примечание об изменении, которое можно указать при создании или обновлении объекта.
state string / обязательный	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
user_exchange dictionary	Набор параметров верхнего уровня.
addr_type псевдонимы: addr-type string	Указывает, использует ли IP-адрес сервера IPv4 или IPv6. Варианты: `"ipv4"` `"ipv6"`
auth_level псевдонимы: auth-level string	Уровень безопасности аутентификации, используемый на уровне протокола RPC. Варианты: `"low"` `"medium"` `"normal"` `"high"` `"connect"` `"call"` `"packet"` `"integrity"` `"privacy"`
auth_type псевдонимы: auth-type string	Тип безопасности аутентификации, используемый на уровне протокола RPC. Варианты: `"spnego"` `"ntlm"` `"kerberos"`
auto_discover_kdc псевдонимы: auto-discover-kdc string	Включить или отключить автоматическое обнаружение IP-адресов KDC. Варианты: `"disable"` `"enable"`
connect_protocol псевдонимы: connect-protocol string	Протокол подключения к службе MS Exchange. Варианты: `"rpc-over-tcp"` `"rpc-over-http"` `"rpc-over-https"`
domain_name псевдонимы: domain-name string	Полное доменное имя сервера MS Exchange.
http_auth_type псевдонимы: http-auth-type string	Тип безопасности аутентификации, используемый для транспорта HTTP. Варианты: `"ntlm"` `"basic"`
ip string	IPv4-адрес сервера.
ip6 string	IPv6-адрес сервера.
kdc_ip псевдонимы: kdc-ip any	(список) IPv4-адреса KDC для аутентификации Kerberos.
name string / обязательный	Имя записи сервера MS Exchange.
password any	(список) Пароль для указанного имени пользователя.
server_name псевдонимы: server-name string	Имя узла сервера MS Exchange.
ssl_min_proto_version псевдонимы: ssl-min-proto-version string	Минимальная версия протокола SSL/TLS для транспорта HTTPS Варианты: `"default"` `"TLSv1-1"` `"TLSv1-2"` `"SSLv3"` `"TLSv1"` `"TLSv1-3"`
username string	Имя пользователя для входа на сервер.
validate_server_certificate псевдонимы: validate-server-certificate string	Включить или отключить проверку сертификата сервера Exchange. Варианты: `"disable"` `"enable"`
workspace_locking_adom string	ADOM, который нужно заблокировать для FortiManager, работающего в режиме рабочей области. Значением может быть global или другие ADOM, включая root.
workspace_locking_timeout integer	Максимальное время ожидания (в секундах) освобождения блокировки рабочей области другим пользователем. По умолчанию: `300`

Примечания

Примечание

Начиная с версии 2.4.0, все входные аргументы именуются с использованием соглашения об именовании с подчёркиванием (snake_case). Замените аргументы, например «var-name» на «var_name». Старые имена аргументов по-прежнему поддерживаются, но будут выдаваться предупреждения об устаревании. Это предупреждение можно отключить, установив deprecation_warnings=False в ansible.cfg.
Этот модуль FortiManager поддерживает режим блокировки рабочей области; для этого используются параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout.
Обычно выполнение модуля может завершиться ошибкой, если возвращён ненулевой код rc. Условия ошибки или успешного выполнения можно переопределить с помощью параметров rc_failed и rc_succeeded.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: Configure MS Exchange server entries.
      fortinet.fortimanager.fmgr_user_exchange:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        state: present # <value in [present, absent]>
        user_exchange:
          name: "your value" # Required variable, string
          # addr_type: <value in [ipv4, ipv6]>
          # auth_level: <value in [low, medium, normal, ...]>
          # auth_type: <value in [spnego, ntlm, kerberos]>
          # connect_protocol: <value in [rpc-over-tcp, rpc-over-http, rpc-over-https]>
          # domain_name: <string>
          # http_auth_type: <value in [ntlm, basic]>
          # ip: <string>
          # ip6: <string>
          # kdc_ip: <list or string>
          # password: <list or string>
          # server_name: <string>
          # ssl_min_proto_version: <value in [default, TLSv1-1, TLSv1-2, ...]>
          # username: <string>
          # auto_discover_kdc: <value in [disable, enable]>
          # validate_server_certificate: <value in [disable, enable]>

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

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

Ключ	Описание
meta dictionary	Результат запроса. Возвращается: всегда
request_url string	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code integer	Статус запроса API. Возвращается: всегда Пример: `0`
response_data list / элементы=string	Ответ API. Возвращается: всегда
response_message string	Описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information dictionary	Информация о целевой системе. Возвращается: всегда
rc integer	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning list / элементы=string	Предупреждение выводится, если используемые в плейбуке параметры не поддерживаются текущей версией FortiManager. Возвращается: в сложных случаях

Авторы

Xinwei Du (@dux-fortinet)
Xing Li (@lix-fortinet)
Jie Xue (@JieX19)
Link Zheng (@chillancezen)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

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

© 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/fortimanager/fmgr_user_exchange_module.html