Модуль fortinet.fortimanager.fmgr_user_fsso_dynamicmapping — настройка единого входа Fortinet

Примечание

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

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

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

Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_user_fsso_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.
fsso string / обязательный	Параметр (fsso) в запрошенном 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_fsso_dynamicmapping dictionary	Набор параметров верхнего уровня.
_gui_meta string	Метаданные графического интерфейса.
_scope list / элементы=dictionary	Область действия.
name string	Имя.
vdom string	VDOM.
group_poll_interval псевдонимы: group-poll-interval integer	Интервал опроса групп.
interface string	Интерфейс.
interface_select_method псевдонимы: interface-select-method string	Способ выбора интерфейса. Варианты: `"auto"` `"sdwan"` `"specify"`
ldap_poll псевдонимы: ldap-poll string	Опрос LDAP. Варианты: `"disable"` `"enable"`
ldap_poll_filter псевдонимы: ldap-poll-filter string	Фильтр опроса LDAP.
ldap_poll_interval псевдонимы: ldap-poll-interval integer	Интервал опроса LDAP.
ldap_server псевдонимы: ldap-server string	Сервер LDAP.
logon_timeout псевдонимы: logon-timeout integer	Интервал в минутах, в течение которого сохраняются сведения о входе после отказа сервера FSSO.
password any	(список) Пароль.
password2 any	(список) Пароль 2.
password3 any	(список) Пароль 3.
password4 any	(список) Пароль 4.
password5 any	(список) Пароль 5.
port integer	Порт.
port2 integer	Порт 2.
port3 integer	Порт 3.
port4 integer	Порт 4.
port5 integer	Порт 5.
server string	Сервер.
server2 string	Сервер 2.
server3 string	Сервер 3.
server4 string	Сервер 4.
server5 string	Сервер 5.
sni string	Индикация имени сервера (SNI).
source_ip псевдонимы: source-ip string	IP-адрес источника.
source_ip6 псевдонимы: source-ip6 string	IPv6-адрес источника.
ssl string	SSL. Варианты: `"disable"` `"enable"`
ssl_server_host_ip_check псевдонимы: ssl-server-host-ip-check string	Включить или отключить проверку имени/IP-адреса узла сервера. Варианты: `"disable"` `"enable"`
ssl_trusted_cert псевдонимы: ssl-trusted-cert string	Доверенный сертификат SSL.
type string	Тип. Варианты: `"default"` `"fortiems"` `"fortinac"` `"fortiems-cloud"`
user_info_server псевдонимы: user-info-server any	(список или строка) Сервер сведений о пользователях.
vrf_select псевдонимы: vrf-select integer	Идентификатор VRF, используемый для подключения к серверу.
workspace_locking_adom string	ADOM для блокировки в FortiManager, работающем в режиме рабочего пространства. Значением может быть global или другое значение, включая 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 Fortinet Single Sign On (FSSO) agent
      fortinet.fortimanager.fmgr_user_fsso_dynamicmapping:
        bypass_validation: false
        adom: ansible
        fsso: ansible-test-fsso # name
        state: present
        user_fsso_dynamicmapping:
          _scope:
            - name: FGT_AWS # need a valid device name
              vdom: root # need a valid vdom name under the device
          password: fortinet
          port: 9000
          server: ansible

- 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 Fortinet Single Sign On (FSSO) agent
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "user_fsso_dynamicmapping"
          params:
            adom: "ansible"
            fsso: "ansible-test-fsso" # 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_fsso_dynamicmapping_module.html