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

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.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 строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation логическое	Устанавливается в True только при расхождении схемы модуля со структурой API FortiManager; модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log логическое	Включить/выключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Авторизовать Ansible-клиент с помощью токена доступа к API forticloud.
proposed_method строка	Переопределённый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список кодов rc, с помощью которых будут переопределены условия для завершения неудачей.
rc_succeeded список / элементы=целое число	Список кодов rc, с помощью которых будут переопределены условия для завершения успехом.
state строка / обязательно	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
user_exchange словарь	Набор параметров верхнего уровня.
addr_type строка	Устарело, пожалуйста, переименуйте на addr_type. Указывает, является ли IP-адрес сервера IPv4 или IPv6. Варианты: `"ipv4"` `"ipv6"`
auth_level строка	Устарело, пожалуйста, переименуйте на auth_level. Уровень безопасности аутентификации, используемый для уровня протокола RPC. Варианты: `"low"` `"medium"` `"normal"` `"high"` `"connect"` `"call"` `"packet"` `"integrity"` `"privacy"`
auth_type строка	Устарело, пожалуйста, переименуйте на auth_type. Тип безопасности аутентификации, используемый для уровня протокола RPC. Варианты: `"spnego"` `"ntlm"` `"kerberos"`
auto_discover_kdc строка	Устарело, пожалуйста, переименуйте на auto_discover_kdc. Включить/выключить автоматическое обнаружение IP-адресов KDC. Варианты: `"disable"` `"enable"`
connect_protocol строка	Устарело, пожалуйста, переименуйте на connect_protocol. Протокол подключения, используемый для подключения к службе MS Exchange. Варианты: `"rpc-over-tcp"` `"rpc-over-http"` `"rpc-over-https"`
domain_name строка	Устарело, пожалуйста, переименуйте на domain_name. Полное доменное имя сервера MS Exchange.
http_auth_type строка	Устарело, пожалуйста, переименуйте на http_auth_type. Тип безопасности аутентификации, используемый для транспортного уровня HTTP. Варианты: `"ntlm"` `"basic"`
ip строка	IP-адрес сервера IPv4.
ip6 строка	IP-адрес сервера IPv6.
kdc_ip любой	(список) Устарело, пожалуйста, переименуйте на kdc_ip. IP-адреса KDC IPv4 для аутентификации Kerberos.

END_OF_DOCUMENT_MARKER

имя строка / обязательно	Имя записи сервера MS Exchange.
пароль любой	(список) Пароль для указанного имени пользователя.
имя_сервера строка	Устарело, переименуйте на server_name. Имя хоста сервера MS Exchange.
ssl_min_proto_version строка	Устарело, переименуйте на ssl_min_proto_version. Минимальная версия протокола SSL/TLS для HTTPS-транспорта. Варианты: `"default"` `"TLSv1-1"` `"TLSv1-2"` `"SSLv3"` `"TLSv1"` `"TLSv1-3"`
имя_пользователя строка	Имя пользователя для входа на сервер.
workspace_locking_adom строка	Область ADOM, которая должна быть заблокирована для FortiManager, работающего в режиме рабочего пространства; значение может быть глобальным и другими, включая корень.
workspace_locking_timeout целое число	Максимальное время в секундах ожидания освобождения блокировки рабочего пространства другим пользователем. По умолчанию: `300`

Примечания

Примечание

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

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure MS Exchange server entries.
      fortinet.fortimanager.fmgr_user_exchange:
        # 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: present # <value in [present, absent]>
        user_exchange:
          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>
          name: <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]>

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

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

Ключ	Описание
meta словарь	Результат запроса. Возвращается: всегда
request_url строка	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code целое число	Статус запроса API. Возвращается: всегда Пример: `0`
response_data список / элементы=строка	Ответ API. Возвращается: всегда
response_message строка	Описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information словарь	Информация о целевой системе. Возвращается: всегда
rc целое число	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning список / элементы=строка	Предупреждение, если параметры, используемые в плейбуке, не поддерживаются текущей версией 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_user_exchange_module.html