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

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: fortinet.fortimanager.fmgr_user_domaincontroller.

Новое в fortinet.fortimanager 2.1.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.
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_domaincontroller dictionary	Набор параметров верхнего уровня.
ad_mode псевдонимы: ad-mode string	Установить режим Active Directory. Варианты: `"none"` `"ds"` `"lds"`
adlds_dn псевдонимы: adlds-dn string	Различающееся имя AD LDS.
adlds_ip6 псевдонимы: adlds-ip6 string	Адрес IPv6 AD LDS.
adlds_ip_address псевдонимы: adlds-ip-address string	Адрес IPv4 AD LDS.
adlds_port псевдонимы: adlds-port integer	Номер порта службы AD LDS
change_detection псевдонимы: change-detection string	Включить или отключить обнаружение изменений конфигурации на сервере Active Directory. Варианты: `"disable"` `"enable"`
change_detection_period псевдонимы: change-detection-period integer	Количество минут для обнаружения изменений конфигурации на сервере Active Directory
dns_srv_lookup псевдонимы: dns-srv-lookup string	Включить или отключить поиск службы DNS. Варианты: `"disable"` `"enable"`
domain_name псевдонимы: domain-name string	Имя домена DNS.
domain_name_src псевдонимы: domain-name-src string	Источник имени домена. Варианты: `"server"` `"client"`
extra_server псевдонимы: extra-server list / элементы=dictionary	Дополнительный сервер.
id integer	Идентификатор сервера.
ip_address псевдонимы: ip-address string	IP-адрес контроллера домена.
port integer	Порт для связи с контроллером домена
source_ip_address псевдонимы: source-ip-address string	IPv4-адрес FortiGate для связи с контроллером домена.
source_port псевдонимы: source-port integer	Исходный порт для связи с контроллером домена.
hostname string	Имя узла сервера, к которому нужно подключиться.
interface string	Укажите исходящий интерфейс для подключения к серверу.
interface_select_method псевдонимы: interface-select-method string	Укажите способ выбора исходящего интерфейса для подключения к серверу. Варианты: `"auto"` `"sdwan"` `"specify"`
ip6 string	IPv6-адрес контроллера домена.
ip_address псевдонимы: ip-address string	IP-адрес контроллера домена.
ldap_server псевдонимы: ldap-server any	(список или строка) Имя сервера LDAP.
name string / обязательный	Имя записи контроллера домена.
password any	(список) Пароль указанного имени пользователя.
port integer	Порт для связи с контроллером домена
replication_port псевдонимы: replication-port integer	Порт для связи с контроллером домена для службы репликации.
source_ip6 псевдонимы: source-ip6 string	IPv6-адрес FortiGate для связи с контроллером домена.
source_ip_address псевдонимы: source-ip-address string	IPv4-адрес FortiGate для связи с контроллером домена.
source_port псевдонимы: source-port integer	Исходный порт для связи с контроллером домена.
username string	Имя пользователя для входа.
workspace_locking_adom string	ADOM, который нужно заблокировать для FortiManager, работающего в режиме workspace. Значением может быть global или другой ADOM, включая 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 (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: Configure domain controller entries.
      fortinet.fortimanager.fmgr_user_domaincontroller:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        state: present # <value in [present, absent]>
        user_domaincontroller:
          name: "your value" # Required variable, string
          # domain_name: <string>
          # extra_server:
          #   - id: <integer>
          #     ip_address: <string>
          #     port: <integer>
          #     source_ip_address: <string>
          #     source_port: <integer>
          # ip_address: <string>
          # ldap_server: <list or string>
          # port: <integer>
          # ad_mode: <value in [none, ds, lds]>
          # adlds_dn: <string>
          # adlds_ip_address: <string>
          # adlds_ip6: <string>
          # adlds_port: <integer>
          # dns_srv_lookup: <value in [disable, enable]>
          # hostname: <string>
          # interface: <string>
          # interface_select_method: <value in [auto, sdwan, specify]>
          # ip6: <string>
          # password: <list or string>
          # replication_port: <integer>
          # source_ip_address: <string>
          # source_ip6: <string>
          # source_port: <integer>
          # username: <string>
          # change_detection: <value in [disable, enable]>
          # change_detection_period: <integer>
          # domain_name_src: <value in [server, client]>

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

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

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