fortinet.fortimanager.fmgr_user_fssopolling – Настройка серверов Active Directory FSSO для режима опроса.
Примечание
Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в книге задач укажите: fortinet.fortimanager.fmgr_user_fssopolling.
Новое в версии 2.10: of fortinet.fortimanager
Описание
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать для источников данных перед использованием.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | ||
|---|---|---|---|---|
| adom строка / обязательно | параметр (adom) в запрошенном URL | |||
| bypass_validation логическое |
| устанавливается в True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров | ||
| rc_failed список / элементы=строка | список кодов rc, при которых условия завершения работы будут переопределены | |||
| rc_succeeded список / элементы=строка | список кодов rc, при которых условия успешного выполнения будут переопределены | |||
| state строка / обязательно |
| направление для создания, обновления или удаления объекта | ||
| user_fssopolling словарь | установленные параметры верхнего уровня | |||
| _gui_meta строка | без описания | |||
| adgrp список / элементы=строка | без описания | |||
| name строка | Имя. | |||
| default-domain строка | Домен по умолчанию, управляемый этим сервером Active Directory. | |||
| id целое число | Идентификатор сервера Active Directory. | |||
| ldap-server строка | Имя сервера LDAP, используемое в строках подключения LDAP. | |||
| logon-history целое число | Количество часов истории входа в систему для сохранения, 0 означает сохранение всей истории. | |||
| password строка | без описания | |||
| polling-frequency целое число | Частота опроса (каждые 1–30 секунд). | |||
| port целое число | Порт для связи с этим сервером Active Directory. | |||
| server строка | Имя хоста или IP-адрес сервера Active Directory. | |||
| status строка |
| Включить/выключить опрос состояния этого сервера Active Directory. | ||
| user строка | Имя пользователя, необходимое для входа на этот сервер Active Directory. | |||
| 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: Configure FSSO active directory servers for polling mode.
fmgr_user_fssopolling:
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: <value in [present, absent]>
user_fssopolling:
_gui_meta: <value of string>
adgrp:
-
name: <value of string>
default-domain: <value of string>
id: <value of integer>
ldap-server: <value of string>
logon-history: <value of integer>
password: <value of string>
polling-frequency: <value of integer>
port: <value of integer>
server: <value of string>
status: <value in [disable, enable]>
user: <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_user_fssopolling_module.html