Модуль fortinet.fortimanager.fmgr_system_saml_fabricidp — Авторизованные поставщики удостоверений.

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.

Чтобы использовать её в книге задач, укажите: fortinet.fortimanager.fmgr_system_saml_fabricidp.

Новое в fortinet.fortimanager 2.1.0

Описание
Параметры
Примечания
Примеры
Возвращаемые значения

Описание

Этот модуль позволяет настроить устройство FortiManager.
Примеры включают все параметры и значения, которые необходимо скорректировать, исходя из данных источников, перед использованием.

Параметры

Параметр	Комментарии
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
bypass_validation логическое значение	Устанавливается в значение True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров. Выбоpы: `false` ← (по умолчанию) `true`
enable_log логическое значение	Включить/выключить ведение журнала для задачи. Выбоpы: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Авторизовать клиент Ansible с помощью маркера доступа к API forticloud.
proposed_method строка	Переопределённый метод для базового запроса Json RPC. Выбоpы: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список кодов rc, с которыми будут переопределены условия для отказа.
rc_succeeded список / элементы=целое число	Список кодов rc, с которыми будут переопределены условия для успеха.
state строка / обязательно	Директива для создания, обновления или удаления объекта. Выбоpы: `"present"` `"absent"`
system_saml_fabricidp словарь	Установленные параметры верхнего уровня.
dev_id строка	Устарело, пожалуйста, переименуйте на dev_id. Идентификатор устройства ИДП.
idp_cert строка	Устарело, пожалуйста, переименуйте на idp_cert. Имя сертификата ИДП.
idp_entity_id строка	Устарело, пожалуйста, переименуйте на idp_entity_id. ИД ИДП.
idp_single_logout_url строка	Устарело, пожалуйста, переименуйте на idp_single_logout_url. URL для выхода из системы ИДП.
idp_single_sign_on_url строка	Устарело, пожалуйста, переименуйте на idp_single_sign_on_url. URL для входа в систему ИДП.
idp_status строка	Устарело, пожалуйста, переименуйте на idp_status. Включить/выключить аутентификацию SAML disable — Выключить аутентификацию SAML. enable — Включить аутентификацию SAML. Выбоpы: `"disable"` `"enable"`
workspace_locking_adom строка	Область, которую нужно заблокировать для FortiManager, работающего в режиме рабочего пространства, значение может быть глобальным и другими, включая root.
workspace_locking_timeout целое число	Максимальное время ожидания в секундах, пока другой пользователь не разблокирует рабочее пространство. По умолчанию: `300`

END_OF_DOCUMENT_MARKER

Примечания

Примечание

Начиная с версии 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_failed и rc_succeeded

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Authorized identity providers.
      fortinet.fortimanager.fmgr_system_saml_fabricidp:
        # 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, ...]
        state: present # <value in [present, absent]>
        system_saml_fabricidp:
          dev_id: <string>
          idp_cert: <string>
          idp_entity_id: <string>
          idp_single_logout_url: <string>
          idp_single_sign_on_url: <string>
          idp_status: <value in [disable, enable]>

Значения возврата

Общие значения возврата описаны здесь, следующие поля уникальны для этого модуля:

Ключ	Описание
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 список / элементы=строка	Предупреждение, если параметры, используемые в плейбуке, не поддерживаются текущей версией 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_system_saml_fabricidp_module.html