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

Примечание

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

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

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

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

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

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

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

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

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
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 / elements=integer	Список кодов rc, переопределяющий условия завершения с ошибкой.
rc_succeeded list / elements=integer	Список кодов rc, переопределяющий условия успешного завершения.
state string / обязательный	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
system_admin_ldap dictionary	Набор параметров верхнего уровня.
adom list / elements=dictionary	ADOM.
adom_name псевдонимы: adom-name string	Имена административных доменов.
adom_access псевдонимы: adom-access string	Задайте значение all или укажите тип доступа к ADOM. all — доступ ко всем ADOM. specify — доступ к указанным ADOM. Варианты: `"all"` `"specify"`
adom_attr псевдонимы: adom-attr string	Атрибут, используемый для получения ADOM.
attributes string	Атрибуты, используемые для поиска групп.
ca_cert псевдонимы: ca-cert string	Имя сертификата CA.
cnid string	Идентификатор общего имени
connect_timeout псевдонимы: connect-timeout integer	Время ожидания подключения LDAP
dn string	Различающееся имя.
filter string	Фильтр для поиска групп.
group string	Полный базовый DN для поиска групп.
memberof_attr псевдонимы: memberof-attr string	Атрибут, используемый для получения memberof.
name string / обязательный	Имя записи LDAP-сервера.
password any	(список) Пароль для первоначальной привязки.
port integer	Номер порта LDAP-сервера
profile_attr псевдонимы: profile-attr string	Атрибут, используемый для получения профиля администратора.
secondary_server псевдонимы: secondary-server string	Описание отсутствует
secure string	SSL-подключение. disable — без SSL. starttls — использовать StartTLS. ldaps — использовать LDAPS. Варианты: `"disable"` `"starttls"` `"ldaps"`
server string	Описание отсутствует
ssl_protocol псевдонимы: ssl-protocol string	Задает минимальную версию протокола SSL для подключения к LDAP-серверу. follow-global-ssl-protocol — использовать системные настройки. sslv3 — задать SSLv3 в качестве минимальной версии. tlsv1. tlsv1. tlsv1. tlsv1. Варианты: `"follow-global-ssl-protocol"` `"sslv3"` `"tlsv1.0"` `"tlsv1.1"` `"tlsv1.2"` `"tlsv1.3"`
tertiary_server псевдонимы: tertiary-server string	Описание отсутствует
type string	Тип привязки LDAP. simple — простая аутентификация по паролю без поиска. anonymous — привязка с использованием анонимного поиска пользователя. regular — привязка с использованием имени пользователя и пароля с последующим поиском. Варианты: `"simple"` `"anonymous"` `"regular"`
username string	Имя пользователя
workspace_locking_adom string	ADOM, блокируемый для FortiManager, работающего в режиме workspace; значение может быть global или другим, включая root.
workspace_locking_timeout integer	Максимальное время в секундах ожидания снятия блокировки workspace другим пользователем. По умолчанию: `300`

Примечания

Примечание

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

Примеры

- name: Example playbook
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: LDAP server entry configuration.
      fortinet.fortimanager.fmgr_system_admin_ldap:
        bypass_validation: false
        state: present
        system_admin_ldap:
          adom:
            - adom_name: ansible
          name: ansible-test-ldap
          password: Fortinet
          port: 390
          server: ansible
          type: regular # <value in [simple, anonymous, regular]>
          username: ansible-username

- 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 LDAP servers
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "system_admin_ldap"
          params:
            ldap: "your_value"

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

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

Ключ	Описание
meta dictionary	Результат запроса. Возвращается: всегда
request_url string	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code integer	Статус запроса API. Возвращается: всегда Пример: `0`
response_data list / elements=string	Ответ API. Возвращается: всегда
response_message string	Описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information dictionary	Информация о целевой системе. Возвращается: всегда
rc integer	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning list / elements=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_system_admin_ldap_module.html