Spec-Zone.ru › Ansible 2.11

fortinet.fortimanager.fmgr_system_admin_ldap – Настройка записи сервера LDAP.

Примечание

Этот плагин входит в состав коллекции fortinet.fortimanager (версия 2.0.1).

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

Для использования в книге задач укажите: fortinet.fortimanager.fmgr_system_admin_ldap.

Новое в версии 2.10: модуля fortinet.fortimanager

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

Обзор

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

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
bypass_validation
boolean
    Варианты:
  • нет ←
  • да
устанавливается в True только при различиях в схеме модуля и структуре API FortiManager, модуль продолжает выполнение без проверки параметров
rc_failed
список / элементы=строка
список кодов rc, при которых условия завершения с ошибкой будут переопределены
rc_succeeded
список / элементы=строка
список кодов rc, при которых условия завершения успешно будут переопределены
state
строка / обязательный
    Варианты:
  • present
  • absent
директива для создания, обновления или удаления объекта
system_admin_ldap
словарь
параметры верхнего уровня
adom
список / элементы=строка
без описания
adom-name
строка
Имена административных доменов.
adom-attr
строка
Атрибут, используемый для получения adom
attributes
строка
По умолчанию:
"member,uniquemember,memberuid"
Атрибуты, используемые для поиска групп.
ca-cert
строка
Имя сертификата CA.
cnid
строка
По умолчанию:
"cn"
Идентификатор общего имени (по умолчанию = CN).
connect-timeout
целое число
По умолчанию:
500
Таймаут подключения LDAP (мс).
dn
строка
Отличительное имя.
filter
строка
По умолчанию:
"(objectclass=*)"
Фильтр, используемый для поиска групп.
group
строка
Полный базовый DN, используемый для поиска групп.
memberof-attr
строка
Атрибут, используемый для получения memeberof.
name
строка
Имя записи сервера LDAP.
password
строка
без описания
port
целое число
По умолчанию:
389
Номер порта сервера LDAP (по умолчанию = 389).
profile-attr
строка
Атрибут, используемый для получения профиля администратора.
secondary-server
строка
{<имя_строки|ip_строки>} имя домена или IP-адрес вторичного сервера LDAP.
secure
строка
    Варианты:
  • выключено ←
  • starttls
  • ldaps
SSL-соединение.
выключено - Без SSL.
starttls - Использование StartTLS.
ldaps - Использование LDAPS.
server
строка
{<имя_строки|ip_строки>} имя домена или IP-адрес сервера LDAP.
tertiary-server
строка
{<имя_строки|ip_строки>} имя домена или IP-адрес третичного сервера LDAP.
type
строка
    Варианты:
  • простой ←
  • анонимный
  • обычный
Тип связывания LDAP.
простой - Простая аутентификация паролем без поиска.
анонимный - Связывание с использованием анонимного пользователя поиска.
обычный - Связывание с использованием имени пользователя/пароля, а затем поиск.
username
строка
Имя пользователя (полный DN) для начального связывания.
workspace_locking_adom
строка
adom для блокировки FortiManager в режиме рабочего пространства. Значение может быть глобальным и другими, включая root.
workspace_locking_timeout
целое число
По умолчанию:
300
максимальное время в секундах ожидания, пока другой пользователь не разблокирует рабочее пространство.

Примечания

Примечание

  • Поддержка работы в режиме блокировки рабочего пространства в этом модуле FortiManager, параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout помогают в этом.
  • Для создания или обновления объекта используйте директиву state present.
  • Для удаления объекта используйте директиву state absent.
  • Обычно выполнение одного модуля может завершиться ошибкой при возврате ненулевого кода rc. Также можно переопределить условия завершения с ошибкой или успешно с параметрами rc_failed и rc_succeeded

Примеры

- hosts: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: LDAP server entry configuration.
     fmgr_system_admin_ldap:
        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, ...]
        state: <value in [present, absent]>
        system_admin_ldap:
           adom:
             -
                 adom-name: <value of string>
           adom-attr: <value of string>
           attributes: <value of string>
           ca-cert: <value of string>
           cnid: <value of string>
           connect-timeout: <value of integer>
           dn: <value of string>
           filter: <value of string>
           group: <value of string>
           memberof-attr: <value of string>
           name: <value of string>
           password: <value of string>
           port: <value of integer>
           profile-attr: <value of string>
           secondary-server: <value of string>
           secure: <value in [disable, starttls, ldaps]>
           server: <value of string>
           tertiary-server: <value of string>
           type: <value in [simple, anonymous, regular]>
           username: <value of string>

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

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

Ключ Возвращаемое значение Описание
request_url
строка
всегда
Полный запрашиваемый URL

Пример:
/sys/login/user
response_code
целое число
всегда
Статус запроса API

response_message
строка
всегда
Дескриптивное сообщение ответа API

Пример:
OK.


Авторы

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Frank Shen (@fshen01)
  • Hongbin Lu (@fgtdev-hblu)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_system_admin_ldap_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API