fortinet.fortimanager.fmgr_user_ldap_dynamicmapping модуль — Настройка записей сервера LDAP.

Примечание

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

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

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

Чтобы использовать его в книге задач, укажите: fortinet.fortimanager.fmgr_user_ldap_dynamicmapping.

Новое в fortinet.fortimanager 2.0.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.
ldap строка / обязательно	Параметр (ldap) в запрошенном URL.
proposed_method строка	Переопределённый метод для основного запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список кодов rc, при которых условия завершения задачи будут переопределены.
rc_succeeded список / элементы=целое число	Список кодов rc, при которых условия успешного выполнения задачи будут переопределены.
state строка / обязательно	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
user_ldap_dynamicmapping словарь	Установленные параметры верхнего уровня.
_scope список / элементы=словарь	Область.
name строка	Имя.
vdom строка	Vdom.
account_key_cert_field строка	Устарело, переименуйте на account_key_cert_field. Определение поля идентификатора субъекта в сертификате для права доступа пользователя… Варианты: `"othername"` `"rfc822name"` `"dnsname"` `"cn"`
account_key_filter строка	Устарело, переименуйте на account_key_filter. Фильтр ключа учетной записи.
account_key_name строка	Устарело, переименуйте на account_key_name. Имя ключа учетной записи.
account_key_processing строка	Устарело, переименуйте на account_key_processing. Обработка ключа учетной записи. Варианты: `"same"` `"strip"`
account_key_upn_san строка	Устарело, переименуйте на account_key_upn_san. Определение SAN в сертификате для соответствия имени принципа пользователя. Варианты: `"othername"` `"rfc822name"` `"dnsname"`
antiphish строка	Включить/выключить бэкенд аутентификации AntiPhishing. Варианты: `"disable"` `"enable"`

END_OF_DOCUMENT_MARKER

ca-cert string	Устарело, переименуйте в ca_cert. Сертификат центра сертификации.
client-cert string	Устарело, переименуйте в client_cert. Имя клиентского сертификата.
client-cert-auth string	Устарело, переименуйте в client_cert_auth. Включить/выключить использование клиентского сертификата для TLS-аутентификации. Choices: `"disable"` `"enable"`
cnid string	Cnid.
dn string	Dn.
filter string	Фильтр.
group string	Группа.
group-filter string	Устарело, переименуйте в group_filter. Фильтр группы.
group-member-check string	Устарело, переименуйте в group_member_check. Проверка принадлежности к группе. Choices: `"user-attr"` `"group-object"` `"posix-group-object"`
group-object-filter string	Устарело, переименуйте в group_object_filter. Фильтр объекта группы.
group-object-search-base string	Устарело, переименуйте в group_object_search_base. Базовая база поиска объекта группы.
group-search-base string	Устарело, переименуйте в group_search_base. Базовая база поиска группы.
interface string	Интерфейс.
interface-select-method string	Устарело, переименуйте в interface_select_method. Метод выбора интерфейса. Choices: `"auto"` `"sdwan"` `"specify"`
max-connections integer	Устарело, переименуйте в max_connections. Максимальное количество подключений.
member-attr string	Устарело, переименуйте в member_attr. Атрибут участника.
obtain-user-info string	Устарело, переименуйте в obtain_user_info. Получить информацию о пользователе. Choices: `"disable"` `"enable"`
password any	(список) Пароль.
password-attr string	Устарело, переименуйте в password_attr. Имя атрибута для получения хэша пароля.
password-expiry-warning string	Устарело, переименуйте в password_expiry_warning. Предупреждение о истечении срока действия пароля. Choices: `"disable"` `"enable"`
password-renewal string	Устарело, переименуйте в password_renewal. Восстановление пароля. Choices: `"disable"` `"enable"`
port integer	Порт.

retrieve-protection-profile string	Устарело, пожалуйста, переименуйте на retrieve_protection_profile. Получить профиль защиты.
search-type list / elements=string	Устарело, пожалуйста, переименуйте на search_type. Тип поиска. Варианты: `"nested"` `"recursive"`
secondary-server string	Устарело, пожалуйста, переименуйте на secondary_server. Вспомогательный сервер.
secure string	Защищённый. Варианты: `"disable"` `"starttls"` `"ldaps"`
server string	Сервер.
server-identity-check string	Устарело, пожалуйста, переименуйте на server_identity_check. Проверка идентификации сервера. Варианты: `"disable"` `"enable"`
source-ip string	Устарело, пожалуйста, переименуйте на source_ip. IP-адрес источника.
source-ip-interface any	(список) Устарело, пожалуйста, переименуйте на source_ip_interface. Сетевой интерфейс для связи с сервером LDAP.
source-port integer	Устарело, пожалуйста, переименуйте на source_port. Порт источника для связи с сервером LDAP.
ssl-min-proto-version string	Устарело, пожалуйста, переименуйте на ssl_min_proto_version. Минимальная версия протокола SSL. Варианты: `"default"` `"TLSv1"` `"TLSv1-1"` `"TLSv1-2"` `"SSLv3"` `"TLSv1-3"`
status-ttl integer	Устарело, пожалуйста, переименуйте на status_ttl. Время кеширования доступности сервера, чтобы при недоступности сервера…
tertiary-server string	Устарело, пожалуйста, переименуйте на tertiary_server. Третичный сервер.
two-factor string	Устарело, пожалуйста, переименуйте на two_factor. Двухфакторная аутентификация. Варианты: `"disable"` `"fortitoken-cloud"`
two-factor-authentication string	Устарело, пожалуйста, переименуйте на two_factor_authentication. Двухфакторная аутентификация. Варианты: `"fortitoken"` `"email"` `"sms"`
two-factor-filter string	Устарело, пожалуйста, переименуйте на two_factor_filter. Фильтр для синхронизации пользователей с FortiToken Cloud.
two-factor-notification string	Устарело, пожалуйста, переименуйте на two_factor_notification. Уведомление о двухфакторной аутентификации. Варианты: `"email"` `"sms"`
type string	Тип. Варианты: `"simple"` `"anonymous"` `"regular"`
user-info-exchange-server string	Устарело, пожалуйста, переименуйте на user_info_exchange_server. Сервер обмена информацией о пользователе.
username string	Имя пользователя.
workspace_locking_adom string	ADOM для блокировки при работе FortiManager в режиме рабочей области. Значение может быть глобальным и другими, включая root.

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_failed и rc_succeeded

Примеры

- name: Example playbook
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure dynamic mappings of LDAP server
      fortinet.fortimanager.fmgr_user_ldap_dynamicmapping:
        bypass_validation: false
        adom: ansible
        ldap: ansible-test-ldap # name
        state: present
        user_ldap_dynamicmapping:
          _scope:
            - name: FGT_AWS # need a valid device name
              vdom: root # need a valid vdom name under the device
          dn: ansible-test-dn
          password: fortinet
          port: 9000
          server: ansible
          username: ansible-test-dyn

- name: Gathering fortimanager facts
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the dynamic mappings of LDAP server
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "user_ldap_dynamicmapping"
          params:
            adom: "ansible"
            ldap: "ansible-test-ldap" # name
            dynamic_mapping: "your_value"

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

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

Ключ	Описание
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_ldap_dynamicmapping_module.html