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

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.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 строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
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"`
system_admin_ldap словарь	Параметры верхнего уровня, заданные в настройках.
adom список / элементы=словарь	Adom.
adom-name строка	Устарело, переименуйте на adom_name. Имена административных доменов.
adom-access строка	Устарело, переименуйте на adom_access. Установить доступ для всех или указать тип доступа к adom. all - Доступ ко всем ADOM. specify - Указать доступ к ADOM. Варианты: `"all"` `"specify"`
adom-attr строка	Устарело, переименуйте на adom_attr. Атрибут, используемый для получения adom.
attributes строка	Атрибуты, используемые для поиска групп.
ca-cert строка	Устарело, переименуйте на ca_cert. Имя сертификата CA.
cnid строка	Идентификатор общего имени.
connect-timeout целое число	Устарело, переименуйте на connect_timeout. Время ожидания подключения LDAP
dn строка	Идентификатор Distinguished Name.
filter строка	Фильтр, используемый для поиска групп.
group строка	Полный базовый DN, используемый для поиска групп.
memberof-attr строка	Устарело, переименуйте на memberof_attr. Атрибут, используемый для получения memberof.
name строка / обязательно	Имя записи сервера LDAP.
password любой	(список) Пароль для первоначального подключения.

END_OF_DOCUMENT_MARKER

порт целое число	Номер порта LDAP-сервера
profile-attr строка	Устарело, пожалуйста, переименуйте на profile_attr. Атрибут, используемый для получения профиля администратора.
secondary-server строка	Устарело, пожалуйста, переименуйте на secondary_server. Без описания
secure строка	SSL-соединение. disable - Без SSL. starttls - Использовать StartTLS. ldaps - Использовать LDAPS. Варианты: `"disable"` `"starttls"` `"ldaps"`
сервер строка	Без описания
tertiary-server строка	Устарело, пожалуйста, переименуйте на tertiary_server. Без описания
тип строка	Тип LDAP-связи. simple - Простая аутентификация паролем без поиска. anonymous - Связь с помощью анонимного пользователя для поиска. regular - Связь с помощью имени пользователя/пароля, а затем поиск. Варианты: `"simple"` `"anonymous"` `"regular"`
имя пользователя строка	Имя пользователя
workspace_locking_adom строка	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. Вы также можете переопределить условия завершения ошибкой или успехом с помощью параметров 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: 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 словарь	Результат запроса. Возвращается: всегда
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_system_admin_ldap_module.html