Spec-Zone.ru › Ansible

Модуль fortinet.fortimanager.fmgr_firewall_accessproxy_serverpubkeyauthsettings — параметры аутентификации SSH-сервера с помощью открытого ключа.

Примечание

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

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

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

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

Добавлено в fortinet.fortimanager 2.1.0

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

Краткое описание

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

Параметры

Параметр

Комментарии

access-proxy

string

Устарел, используйте «access_proxy»

access_proxy

string

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

access_token

string

Токен для доступа к FortiManager без использования имени пользователя и пароля.

adom

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

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

bypass_validation

boolean

Устанавливайте значение True только в случае, если схема модуля отличается от структуры API FortiManager. В этом случае модуль продолжит выполнение без проверки параметров.

Варианты:

  • false ← (по умолчанию)
  • true

enable_log

boolean

Включить/отключить ведение журнала для задачи.

Варианты:

  • false ← (по умолчанию)
  • true

firewall_accessproxy_serverpubkeyauthsettings

dictionary

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

auth_ca

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

string

Имя центра сертификации для аутентификации SSH-сервера с помощью открытого ключа.

cert_extension

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

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

Расширение сертификата.

critical

string

Критический параметр.

Варианты:

  • "no"
  • "yes"

data

string

Имя расширения сертификата.

name

string

Имя расширения сертификата.

type

string

Тип расширения сертификата.

Варианты:

  • "fixed"
  • "user"

permit_agent_forwarding

псевдонимы: permit-agent-forwarding

string

Включить/отключить добавление расширения сертификата permit-agent-forwarding.

Варианты:

  • "disable"
  • "enable"

permit_port_forwarding

псевдонимы: permit-port-forwarding

string

Включить/отключить добавление расширения сертификата permit-port-forwarding.

Варианты:

  • "disable"
  • "enable"

permit_pty

псевдонимы: permit-pty

string

Включить/отключить добавление расширения сертификата permit-pty.

Варианты:

  • "disable"
  • "enable"

permit_user_rc

псевдонимы: permit-user-rc

string

Включить/отключить добавление расширения сертификата permit-user-rc.

Варианты:

  • "disable"
  • "enable"

permit_x11_forwarding

псевдонимы: permit-x11-forwarding

string

Включить/отключить добавление расширения сертификата permit-x11-forwarding.

Варианты:

  • "disable"
  • "enable"

source_address

псевдонимы: source-address

string

Включить/отключить добавление критического параметра сертификата source-address.

Варианты:

  • "disable"
  • "enable"

forticloud_access_token

string

Аутентификация клиента Ansible с помощью токена доступа к API forticloud.

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, а также другие области, включая 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: Server SSH public key authentication settings.
      fortinet.fortimanager.fmgr_firewall_accessproxy_serverpubkeyauthsettings:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        access_proxy: <your own value>
        firewall_accessproxy_serverpubkeyauthsettings:
          # auth_ca: <string>
          # cert_extension:
          #   - critical: <value in [no, yes]>
          #     data: <string>
          #     name: <string>
          #     type: <value in [fixed, user]>
          # permit_agent_forwarding: <value in [disable, enable]>
          # permit_port_forwarding: <value in [disable, enable]>
          # permit_pty: <value in [disable, enable]>
          # permit_user_rc: <value in [disable, enable]>
          # permit_x11_forwarding: <value in [disable, enable]>
          # source_address: <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_firewall_accessproxy_serverpubkeyauthsettings_module.html

Spec-Zone.ru

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