fortinet.fortimanager.fmgr_user_fsso – Настройка агентов Fortinet Single Sign On (FSSO).
Примечание
Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать его в плейбуке, укажите: fortinet.fortimanager.fmgr_user_fsso.
Новое в версии 2.10: модуля fortinet.fortimanager
Обзор
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать в источниках данных перед использованием.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |||
|---|---|---|---|---|---|
| adom строка / обязательно | параметр (adom) в запрошенном URL | ||||
| bypass_validation логическое значение |
| устанавливается в значение True только при расхождениях схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров | |||
| rc_failed список / элементы=строка | список кодов rc, при которых условия будут игнорироваться | ||||
| rc_succeeded список / элементы=строка | список кодов rc, при которых условия будут переопределены | ||||
| state строка / обязательно |
| инструкция для создания, обновления или удаления объекта | |||
| user_fsso словарь | установленные параметры верхнего уровня | ||||
| _gui_meta строка | нет описания | ||||
| dynamic_mapping список / элементы=строка | нет описания | ||||
| _gui_meta строка | нет описания | ||||
| _scope список / элементы=строка | нет описания | ||||
| name строка | нет описания | ||||
| vdom строка | нет описания | ||||
| ldap-server строка | нет описания | ||||
| password строка | нет описания | ||||
| password2 строка | нет описания | ||||
| password3 строка | нет описания | ||||
| password4 строка | нет описания | ||||
| password5 строка | нет описания | ||||
| port целое число | нет описания | ||||
| port2 целое число | нет описания | ||||
| port3 целое число | нет описания | ||||
| port4 целое число | нет описания | ||||
| port5 целое число | нет описания | ||||
| server строка | нет описания | ||||
| server2 строка | нет описания | ||||
| server3 строка | нет описания | ||||
| server4 строка | нет описания | ||||
| server5 строка | нет описания | ||||
| source-ip строка | нет описания | ||||
| source-ip6 строка | нет описания | ||||
| ssl строка |
| нет описания | |||
| ssl-trusted-cert строка | нет описания | ||||
| type строка |
| нет описания | |||
| user-info-server строка | нет описания | ||||
| ldap-server строка | Сервер LDAP для получения информации о группах. | ||||
| name строка | Имя. | ||||
| password строка | нет описания | ||||
| password2 строка | нет описания | ||||
| password3 строка | нет описания | ||||
| password4 строка | нет описания | ||||
| password5 строка | нет описания | ||||
| port целое число | Порт первого агента-коллектора FSSO. | ||||
| port2 целое число | Порт второго агента-коллектора FSSO. | ||||
| port3 целое число | Порт третьего агента-коллектора FSSO. | ||||
| port4 целое число | Порт четвертого агента-коллектора FSSO. | ||||
| port5 целое число | Порт пятого агента-коллектора FSSO. | ||||
| server строка | Доменное имя или IP-адрес первого агента-коллектора FSSO. | ||||
| server2 строка | Доменное имя или IP-адрес второго агента-коллектора FSSO. | ||||
| server3 строка | Доменное имя или IP-адрес третьего агента-коллектора FSSO. | ||||
| server4 строка | Доменное имя или IP-адрес четвертого агента-коллектора FSSO. | ||||
| server5 строка | Доменное имя или IP-адрес пятого агента-коллектора FSSO. | ||||
| source-ip строка | Исходный IP-адрес для связи с агентом FSSO. | ||||
| source-ip6 строка | Исходный IPv6 адрес для связи с агентом FSSO. | ||||
| workspace_locking_adom строка | adom для блокировки FortiManager, работающего в режиме рабочего пространства; значение может быть глобальным и другими, включая корень | ||||
| 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 Fortinet Single Sign On (FSSO) agents.
fmgr_user_fsso:
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_fsso:
_gui_meta: <value of string>
dynamic_mapping:
-
_gui_meta: <value of string>
_scope:
-
name: <value of string>
vdom: <value of string>
ldap-server: <value of string>
password: <value of string>
password2: <value of string>
password3: <value of string>
password4: <value of string>
password5: <value of string>
port: <value of integer>
port2: <value of integer>
port3: <value of integer>
port4: <value of integer>
port5: <value of integer>
server: <value of string>
server2: <value of string>
server3: <value of string>
server4: <value of string>
server5: <value of string>
source-ip: <value of string>
source-ip6: <value of string>
ssl: <value in [disable, enable]>
ssl-trusted-cert: <value of string>
type: <value in [default, fortiems, fortinac]>
user-info-server: <value of string>
ldap-server: <value of string>
name: <value of string>
password: <value of string>
password2: <value of string>
password3: <value of string>
password4: <value of string>
password5: <value of string>
port: <value of integer>
port2: <value of integer>
port3: <value of integer>
port4: <value of integer>
port5: <value of integer>
server: <value of string>
server2: <value of string>
server3: <value of string>
server4: <value of string>
server5: <value of string>
source-ip: <value of string>
source-ip6: <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_fsso_module.html
