Spec-Zone.ru › Ansible

Модуль fortinet.fortimanager.fmgr_pkg_authentication_setting — настройка параметров аутентификации.

Примечание

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

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

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

Чтобы использовать коллекцию в плейбуке, укажите: fortinet.fortimanager.fmgr_pkg_authentication_setting.

Добавлено в fortinet.fortimanager 2.1.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.

pkg

string / обязательный

Параметр (pkg) в запрашиваемом URL.

pkg_authentication_setting

dictionary

Параметры верхнего уровня.

active_auth_scheme

псевдонимы: active-auth-scheme

string

Активный метод аутентификации

auth_https

псевдонимы: auth-https

string

Включить/отключить перенаправление HTTP-аутентификации пользователей на HTTPS.

Варианты:

  • "disable"
  • "enable"

captive_portal

псевдонимы: captive-portal

string

Имя хоста портала авторизации.

captive_portal6

псевдонимы: captive-portal6

string

Имя хоста портала авторизации IPv6.

captive_portal_ip

псевдонимы: captive-portal-ip

string

IP-адрес портала авторизации.

captive_portal_ip6

псевдонимы: captive-portal-ip6

string

IPv6-адрес портала авторизации.

captive_portal_port

псевдонимы: captive-portal-port

integer

Номер порта портала авторизации

captive_portal_ssl_port

псевдонимы: captive-portal-ssl-port

integer

Номер SSL-порта портала авторизации

captive_portal_type

псевдонимы: captive-portal-type

string

Тип портала авторизации.

Варианты:

  • "fqdn"
  • "ip"

cert_auth

псевдонимы: cert-auth

string

Включить/отключить перенаправление аутентификации по сертификату на HTTPS-портал.

Варианты:

  • "disable"
  • "enable"

cert_captive_portal

псевдонимы: cert-captive-portal

string

Имя хоста портала авторизации по сертификату.

cert_captive_portal_ip

псевдонимы: cert-captive-portal-ip

string

IP-адрес портала авторизации по сертификату.

cert_captive_portal_port

псевдонимы: cert-captive-portal-port

integer

Номер порта портала авторизации по сертификату

cookie_max_age

псевдонимы: cookie-max-age

integer

Максимальный срок действия постоянного файла cookie веб-портала в минутах

cookie_refresh_div

псевдонимы: cookie-refresh-div

integer

Делитель частоты обновления постоянного файла cookie веб-портала

dev_range

псевдонимы: dev-range

any

(список или строка) Диапазон адресов для запроса устройства на основе IP-адреса.

ip_auth_cookie

псевдонимы: ip-auth-cookie

string

Включить/отключить постоянный файл cookie при аутентификации на веб-портале по IP-адресу

Варианты:

  • "disable"
  • "enable"

log_auth_request

псевдонимы: log-auth-request

string

Записывать запросы аутентификации в журнал.

Варианты:

  • "disable"
  • "enable"

persistent_cookie

псевдонимы: persistent-cookie

string

Включить/отключить постоянный файл cookie при аутентификации на веб-портале

Варианты:

  • "disable"
  • "enable"

rewrite_https_port

псевдонимы: rewrite-https-port

integer

Перенаправлять на порт HTTPS

sso_auth_scheme

псевдонимы: sso-auth-scheme

string

Метод аутентификации единого входа (SSO)

update_time

псевдонимы: update-time

string

Время последнего обновления.

user_cert_ca

псевдонимы: user-cert-ca

any

(список или строка) Сертификат центра сертификации, используемый для проверки сертификата клиента.

proposed_method

string

Метод, переопределяющий метод базового запроса Json RPC.

Варианты:

  • "update"
  • "set"
  • "add"

rc_failed

list / элементы=integer

Список кодов rc, переопределяющий условия возникновения ошибки.

rc_succeeded

list / элементы=integer

Список кодов rc, переопределяющий условия успешного выполнения.

revision_note

string

Примечание об изменении, которое можно указать при создании или обновлении объекта.

workspace_locking_adom

string

ADOM, который необходимо заблокировать для FortiManager, работающего в режиме рабочей области. Значением может быть global или другой ADOM, включая 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.

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: Configure authentication setting.
      fortinet.fortimanager.fmgr_pkg_authentication_setting:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        pkg: <your own value>
        pkg_authentication_setting:
          # active_auth_scheme: <string>
          # auth_https: <value in [disable, enable]>
          # captive_portal: <string>
          # captive_portal_ip: <string>
          # captive_portal_ip6: <string>
          # captive_portal_port: <integer>
          # captive_portal_ssl_port: <integer>
          # captive_portal_type: <value in [fqdn, ip]>
          # captive_portal6: <string>
          # rewrite_https_port: <integer>
          # sso_auth_scheme: <string>
          # dev_range: <list or string>
          # user_cert_ca: <list or string>
          # cert_auth: <value in [disable, enable]>
          # cert_captive_portal: <string>
          # cert_captive_portal_ip: <string>
          # cert_captive_portal_port: <integer>
          # cookie_max_age: <integer>
          # cookie_refresh_div: <integer>
          # ip_auth_cookie: <value in [disable, enable]>
          # persistent_cookie: <value in [disable, enable]>
          # update_time: <string>
          # log_auth_request: <value in [disable, enable]>

Возвращаемые значения

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

Ключ

Описание

meta

dictionary

Результат запроса.

Возвращается: всегда

request_url

string

Полный URL запроса.

Возвращается: всегда

Пример: "/sys/login/user"

response_code

integer

Статус запроса API.

Возвращается: всегда

Пример: 0

response_data

list / элементы=string

Ответ API.

Возвращается: всегда

response_message

string

Описание сообщения в ответе API.

Возвращается: всегда

Пример: "OK."

system_information

dictionary

Информация о целевой системе.

Возвращается: всегда

rc

integer

Статус запроса.

Возвращается: всегда

Пример: 0

version_check_warning

list / элементы=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_pkg_authentication_setting_module.html

Spec-Zone.ru

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