Spec-Zone.ru › Ansible

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

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.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

string

Токен для доступа к FortiManager без использования имени пользователя и пароля.

adom

string / обязательный

Параметр (adom) в запрошенном URL.

bypass_validation

boolean

Установите значение True только в том случае, если схема модуля отличается от структуры API FortiManager; модуль продолжит выполнение без проверки параметров.

Варианты:

  • false ← (по умолчанию)
  • true

enable_log

boolean

Включить или отключить ведение журнала для задачи.

Варианты:

  • false ← (по умолчанию)
  • true

forticloud_access_token

string

Аутентификация клиента Ansible с помощью токена доступа к API forticloud.

ldap

string / обязательный

Параметр (ldap) в запрошенном URL.

proposed_method

string

Переопределяемый метод для базового запроса Json RPC.

Варианты:

  • "update"
  • "set"
  • "add"

rc_failed

list / элементы=integer

Список кодов rc, с помощью которого переопределяются условия сбоя.

rc_succeeded

list / элементы=integer

Список кодов rc, с помощью которого переопределяются условия успеха.

revision_note

string

Примечание об изменении, которое можно указать при создании или обновлении объекта.

state

string / обязательный

Указание создать, обновить или удалить объект.

Варианты:

  • "present"
  • "absent"

user_ldap_dynamicmapping

dictionary

Набор параметров верхнего уровня.

_scope

list / элементы=dictionary

Область действия.

name

string

Имя.

vdom

string

VDOM.

account_key_cert_field

псевдонимы: account-key-cert-field

string

Определяет поле идентификатора субъекта в сертификате для проверки прав доступа пользователя.

Варианты:

  • "othername"
  • "rfc822name"
  • "dnsname"
  • "cn"

account_key_filter

псевдонимы: account-key-filter

string

Фильтр ключа учетной записи.

account_key_name

псевдонимы: account-key-name

string

Имя ключа учетной записи.

account_key_processing

псевдонимы: account-key-processing

string

Обработка ключа учетной записи.

Варианты:

  • "same"
  • "strip"

account_key_upn_san

псевдонимы: account-key-upn-san

string

Определяет SAN в сертификате для сопоставления имени участника-пользователя.

Варианты:

  • "othername"
  • "rfc822name"
  • "dnsname"

antiphish

string

Включить или отключить серверную часть учетных данных AntiPhishing.

Варианты:

  • "disable"
  • "enable"

ca_cert

псевдонимы: ca-cert

string

Сертификат CA.

client_cert

псевдонимы: client-cert

string

Имя сертификата клиента.

client_cert_auth

псевдонимы: client-cert-auth

string

Включить или отключить использование сертификата клиента для аутентификации TLS.

Варианты:

  • "disable"
  • "enable"

cnid

string

CNID.

dn

string

DN.

filter

string

Фильтр.

group

string

Группа.

group_filter

псевдонимы: group-filter

string

Фильтр группы.

group_member_check

псевдонимы: group-member-check

string

Проверка членства в группе.

Варианты:

  • "user-attr"
  • "group-object"
  • "posix-group-object"

group_object_filter

псевдонимы: group-object-filter

string

Фильтр объекта группы.

group_object_search_base

псевдонимы: group-object-search-base

string

База поиска объектов группы.

group_search_base

псевдонимы: group-search-base

string

База поиска групп.

interface

string

Интерфейс.

interface_select_method

псевдонимы: interface-select-method

string

Метод выбора интерфейса.

Варианты:

  • "auto"
  • "sdwan"
  • "specify"

max_connections

псевдонимы: max-connections

integer

Максимальное количество подключений.

member_attr

псевдонимы: member-attr

string

Атрибут участника.

obtain_user_info

псевдонимы: obtain-user-info

string

Получение сведений о пользователе.

Варианты:

  • "disable"
  • "enable"

password

any

(список) Пароль.

password_attr

псевдонимы: password-attr

string

Имя атрибута, из которого извлекается хеш пароля.

password_expiry_warning

псевдонимы: password-expiry-warning

string

Предупреждение об истечении срока действия пароля.

Варианты:

  • "disable"
  • "enable"

password_renewal

псевдонимы: password-renewal

string

Продление срока действия пароля.

Варианты:

  • "disable"
  • "enable"

port

integer

Порт.

retrieve_protection_profile

псевдонимы: retrieve-protection-profile

string

Получение профиля защиты.

search_type

псевдонимы: search-type

list / элементы=string

Тип поиска.

Варианты:

  • "nested"
  • "recursive"

secondary_server

псевдонимы: secondary-server

string

Вторичный сервер.

secure

string

Безопасное соединение.

Варианты:

  • "disable"
  • "starttls"
  • "ldaps"

server

string

Сервер.

server_identity_check

псевдонимы: server-identity-check

string

Проверка идентификатора сервера.

Варианты:

  • "disable"
  • "enable"

source_ip

псевдонимы: source-ip

string

IP-адрес источника.

source_ip_interface

псевдонимы: source-ip-interface

any

(список) Исходный интерфейс для связи с LDAP-сервером.

source_port

псевдонимы: source-port

integer

Исходный порт для связи с LDAP-сервером.

ssl_max_proto_version

псевдонимы: ssl-max-proto-version

string

Максимальная версия протокола SSL.

Варианты:

  • "TLSv1-1"
  • "TLSv1-2"
  • "SSLv3"
  • "TLSv1"
  • "TLSv1-3"

ssl_min_proto_version

псевдонимы: ssl-min-proto-version

string

Минимальная версия протокола SSL.

Варианты:

  • "default"
  • "TLSv1"
  • "TLSv1-1"
  • "TLSv1-2"
  • "SSLv3"
  • "TLSv1-3"

status_ttl

псевдонимы: status-ttl

integer

Время, в течение которого сохраняется в кэше доступность сервера. Если сервер недоступен, повторные попытки подключения к нему не будут выполняться как минимум в течение этого периода…

tertiary_server

псевдонимы: tertiary-server

string

Третичный сервер.

two_factor

псевдонимы: two-factor

string

Двухфакторная аутентификация.

Варианты:

  • "disable"
  • "fortitoken-cloud"

two_factor_authentication

псевдонимы: two-factor-authentication

string

Двухфакторная аутентификация.

Варианты:

  • "fortitoken"
  • "email"
  • "sms"

two_factor_filter

псевдонимы: two-factor-filter

string

Фильтр для синхронизации пользователей с FortiToken Cloud.

two_factor_notification

псевдонимы: two-factor-notification

string

Уведомление о двухфакторной аутентификации.

Варианты:

  • "email"
  • "sms"

type

string

Тип.

Варианты:

  • "simple"
  • "anonymous"
  • "regular"

user_info_exchange_server

псевдонимы: user-info-exchange-server

string

Сервер обмена информацией о пользователях.

username

string

Имя пользователя.

validate_server_certificate

псевдонимы: validate-server-certificate

string

Проверять сертификат сервера.

Варианты:

  • "disable"
  • "enable"

vrf_select

псевдонимы: vrf-select

integer

Идентификатор VRF, используемый для подключения к серверу.

workspace_locking_adom

string

ADOM, который необходимо заблокировать для FortiManager, работающего в режиме рабочей области. В качестве значения можно указать global или другие ADOM, включая root.

workspace_locking_timeout

integer

Максимальное время в секундах ожидания снятия блокировки рабочей области другим пользователем.

По умолчанию: 300

Примечания

Примечание

  • Начиная с версии 2.4.0, все входные аргументы именуются в соответствии с соглашением об использовании подчеркивания (snake_case). Замените аргументы, например «var-name», на «var_name». Старые имена аргументов по-прежнему доступны, но будут отображаться предупреждения об устаревании. Чтобы отключить эти предупреждения, задайте deprecation_warnings=False в ansible.cfg.
  • Этот модуль FortiManager поддерживает работу в режиме блокировки рабочей области; для этого предназначены параметры верхнего уровня 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: 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

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_user_ldap_dynamicmapping_module.html

Spec-Zone.ru

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