Spec-Zone.ru › Ansible

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

Примечание

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

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

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

Для использования в плейбуке укажите: fortinet.fortimanager.fmgr_user_fsso.

Новое в fortinet.fortimanager 2.0.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_fsso

словарь

Настроенные параметры верхнего уровня.

_gui_meta

строка

Метаданные GUI.

dynamic_mapping

список / элементы=словарь

Динамическое отображение.

_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. Сервер информации о пользователях.

group-poll-interval

integer

Устарело, переименуйте в group_poll_interval. Интервал в минутах для получения групп с сервера FSSO, или отменить…

interface

string

Укажите исходящий интерфейс для доступа к серверу.

interface-select-method

string

Устарело, переименуйте в interface_select_method. Укажите, как выбрать исходящий интерфейс для доступа к серверу.

Choices:

  • "auto"
  • "sdwan"
  • "specify"

ldap-poll

string

Устарело, переименуйте в ldap_poll. Включить/выключить автоматический запрос групп с LDAP-сервера.

Choices:

  • "disable"
  • "enable"

ldap-poll-filter

string

Устарело, переименуйте в ldap_poll_filter. Фильтр, используемый для получения групп.

ldap-poll-interval

integer

Устарело, переименуйте в ldap_poll_interval. Интервал в минутах для получения групп с LDAP-сервера.

ldap-server

string

Устарело, переименуйте в ldap_server. LDAP-сервер для получения информации о группах.

logon-timeout

integer

Устарело, переименуйте в logon_timeout. Интервал в минутах для сохранения сеансов после отключения сервера FSSO.

name

string / required

Имя.

password

any

(list) Пароль первого агента сбора FSSO.

password2

any

(list) Пароль второго агента сбора FSSO.

password3

any

(list) Пароль третьего агента сбора FSSO.

password4

any

(list) Пароль четвёртого агента сбора FSSO.

password5

any

(list) Пароль пятого агента сбора FSSO.

port

integer

Порт первого агента сбора FSSO.

port2

integer

Порт второго агента сбора FSSO.

port3

integer

Порт третьего агента сбора FSSO.

port4

integer

Порт четвёртого агента сбора FSSO.

port5

integer

Порт пятого агента сбора FSSO.

server

string

Доменное имя или IP-адрес первого агента сбора FSSO.

server2

string

Доменное имя или IP-адрес второго агента сбора FSSO.

server3

string

Доменное имя или IP-адрес третьего агента сбора FSSO.

server4

string

Доменное имя или IP-адрес четвёртого агента сбора FSSO.

server5

string

Доменное имя или IP-адрес пятого агента сбора FSSO.

sni

string

Указание имени сервера.

source-ip

string

Устарело, переименуйте в source_ip. Исходящий IP для связи с агентом FSSO.

source-ip6

string

Устарело, переименуйте в source_ip6. IPv6-источник для связи с агентом FSSO.

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. Доверенный сертификат сервера или сертификат CA.

type

string

Тип сервера.

Варианты:

  • "default"
  • "fortiems"
  • "fortinac"
  • "fortiems-cloud"

user-info-server

string

Устарело, пожалуйста, переименуйте на user_info_server. LDAP-сервер для получения информации о пользователях.

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
  hosts: fortimanagers
  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.
      fortinet.fortimanager.fmgr_user_fsso:
        bypass_validation: false
        adom: ansible
        state: present
        user_fsso:
          name: ansible-test-fsso
          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 Fortinet Single Sign On (FSSO) agents
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "user_fsso"
          params:
            adom: "ansible"
            fsso: "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_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API