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

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.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 строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation булево	Устанавливается в значение True только при различиях в схеме модуля и структуре API FortiManager. Модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log булево	Включить/выключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Аутентификация клиента Ansible с помощью токена доступа к API forticloud.
fsso строка / обязательно	Параметр (fsso) в запрошенном URL.
proposed_method строка	Переопределенный метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое	Список rc кодов, при которых условия будут переопределены для отказа.
rc_succeeded список / элементы=целое	Список rc кодов, при которых условия будут переопределены для успеха.
state строка / обязательно	Направление для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
user_fsso_dynamicmapping словарь	Настройка параметров верхнего уровня.
_gui_meta строка	Метаданные GUI.
_scope список / элементы=словарь	Область.
name строка	Имя.
vdom строка	Vdom.
group_poll_interval целое	Устарело, пожалуйста, переименуйте на group_poll_interval. Интервал опроса группы.
interface строка	Интерфейс.
interface_select_method строка	Устарело, пожалуйста, переименуйте на interface_select_method. Метод выбора интерфейса. Варианты: `"auto"` `"sdwan"` `"specify"`
ldap_poll строка	Устарело, пожалуйста, переименуйте на ldap_poll. Опрос LDAP. Варианты: `"disable"` `"enable"`
ldap_poll_filter строка	Устарело, пожалуйста, переименуйте на ldap_poll_filter. Фильтр опроса LDAP.
ldap_poll_interval целое	Устарело, пожалуйста, переименуйте на ldap_poll_interval. Интервал опроса LDAP.
ldap_server строка	Устарело, пожалуйста, переименуйте на ldap_server. Сервер LDAP.

END_OF_DOCUMENT_MARKER

logon-timeout integer	Устарело, переименуйте в logon_timeout. Интервал в минутах для сохранения сеансов после отключения сервера FSSO.
password any	(list) Пароль.
password2 any	(list) Password2.
password3 any	(list) Password3.
password4 any	(list) Password4.
password5 any	(list) Password5.
port integer	Порт.
port2 integer	Port2.
port3 integer	Port3.
port4 integer	Port4.
port5 integer	Port5.
server string	Сервер.
server2 string	Server2.
server3 string	Server3.
server4 string	Server4.
server5 string	Server5.
sni string	Указание имени сервера.
source-ip string	Устарело, переименуйте в source_ip. Исходный IP-адрес.
source-ip6 string	Устарело, переименуйте в source_ip6. Исходный IPv6-адрес.
ssl string	Ssl. Варианты: `"disable"` `"enable"`
ssl-server-host-ip-check string	Устарело, переименуйте в ssl_server_host_ip_check. Включить/выключить проверку хоста/IP-адреса сервера. Варианты: `"disable"` `"enable"`
ssl-trusted-cert string	Устарело, переименуйте в ssl_trusted_cert. Доверенный SSL-сертификат.
type string	Тип. Варианты: `"default"` `"fortiems"` `"fortinac"` `"fortiems-cloud"`
user-info-server any	(list or str) Устарело, переименуйте в user_info_server. Сервер информации о пользователях.
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 помогают в этой работе.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.
Обычно выполнение одного модуля может завершиться ошибкой, если возвращается ненулевой код rc. Вы также можете переопределить условия завершения успехом или ошибкой с помощью параметров rc_failed и rc_succeeded

Примеры

- name: Example playbook
  hosts: fortimanagers
  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 словарь	Результат запроса. Возвращается: всегда
request_url строка	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code целое число	Статус запроса API. Возвращается: всегда Пример: `0`
response_data список / элементы=строка	Ответ API. Возвращается: всегда
response_message строка	Дескриптивное сообщение ответа API. Возвращается: всегда Пример: `"OK."`
system_information словарь	Информация о целевой системе. Возвращается: всегда
rc целое число	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning список / элементы=строка	Предупреждение, если параметры, используемые в playbook, не поддерживаются текущей версией 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_fsso_dynamicmapping_module.html