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

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.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.
Примеры включают все параметры и значения, которые необходимо скорректировать из источников данных перед использованием.

END_OF_DOCUMENT_MARKER

Параметры

Параметр	Комментарии
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
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"`
user_domaincontroller словарь	Установленные параметры верхнего уровня.
ad-mode строка	Устаревшее, пожалуйста, переименуйте на ad_mode. Установка режима Active Directory. Варианты: `"none"` `"ds"` `"lds"`
adlds-dn строка	Устаревшее, пожалуйста, переименуйте на adlds_dn. Имя выделенного домена AD LDS.
adlds-ip-address строка	Устаревшее, пожалуйста, переименуйте на adlds_ip_address. IPv4-адрес AD LDS.
adlds-ip6 строка	Устаревшее, пожалуйста, переименуйте на adlds_ip6. IPv6-адрес AD LDS.
adlds-port целое	Устаревшее, пожалуйста, переименуйте на adlds_port. Номер порта службы AD LDS
change-detection строка	Устаревшее, пожалуйста, переименуйте на change_detection. Включить/выключить обнаружение изменений конфигурации в Active Directo… Варианты: `"disable"` `"enable"`
change-detection-period целое	Устаревшее, пожалуйста, переименуйте на change_detection_period. Минуты для обнаружения изменения конфигурации в Active Directory …
dns-srv-lookup строка	Устаревшее, пожалуйста, переименуйте на dns_srv_lookup. Включить/выключить поиск DNS-служб. Варианты: `"disable"` `"enable"`
domain-name строка	Устаревшее, пожалуйста, переименуйте на domain_name. Имя домена DNS.
extra-server список / элементы=словарь	Устаревшее, пожалуйста, переименуйте на extra_server. Дополнительный сервер.
id целое	Идентификатор сервера.

END_OF_DOCUMENT_MARKER

ip-address string	Устарело, пожалуйста, переименуйте на ip_address. IP-адрес контроллера домена.
port integer	Порт, используемый для связи с контроллером домена
source-ip-address string	Устарело, пожалуйста, переименуйте на source_ip_address. IPv4-адрес FortiGate, используемый для связи с до…
source-port integer	Устарело, пожалуйста, переименуйте на source_port. Исходный порт, используемый для связи с контроллером домена.
hostname string	Имя хоста сервера для подключения.
interface string	Укажите исходящий интерфейс для достижения сервера.
interface-select-method string	Устарело, пожалуйста, переименуйте на interface_select_method. Укажите способ выбора исходящего интерфейса для достижения сервера. Выбор: `"auto"` `"sdwan"` `"specify"`
ip-address string	Устарело, пожалуйста, переименуйте на ip_address. IP-адрес контроллера домена.
ip6 string	IPv6-адрес контроллера домена.
ldap-server any	(список или строка) Устарело, пожалуйста, переименуйте на ldap_server. Имя LDAP-сервера.
name string / обязательно	Имя записи контроллера домена.
password any	(список) Пароль для указанного имени пользователя.
port integer	Порт, используемый для связи с контроллером домена
replication-port integer	Устарело, пожалуйста, переименуйте на replication_port. Порт, используемый для связи с контроллером домена для реп…
source-ip-address string	Устарело, пожалуйста, переименуйте на source_ip_address. IPv4-адрес FortiGate, используемый для связи с домен…
source-ip6 string	Устарело, пожалуйста, переименуйте на source_ip6. IPv6-адрес FortiGate, используемый для связи с контроллером домена.
source-port integer	Устарело, пожалуйста, переименуйте на source_port. Исходный порт, используемый для связи с контроллером домена.
username string	Имя пользователя для входа.
workspace_locking_adom string	ADOM для блокировки рабочего пространства FortiManager, работающего в режиме рабочего пространства, значение может быть глобальным и другими, включая 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 помогают выполнить эту работу.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.
Обычно запуск одного модуля может завершиться ошибкой при возвращении ненулевого rc. Вы также можете переопределить условия для завершения ошибкой или успехом с параметрами rc_failed и rc_succeeded

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure domain controller entries.
      fortinet.fortimanager.fmgr_user_domaincontroller:
        # 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, ...]
        adom: <your own value>
        state: present # <value in [present, absent]>
        user_domaincontroller:
          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>
          name: <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>

Значения возврата

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

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