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

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.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 строка	Устаревшее, пожалуйста, используйте «access_proxy»
access_proxy строка	Параметр (access-proxy) в запрошенном URL.
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation логическое	Устанавливается в True только в том случае, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров. Выбор: `false` ← (по умолчанию) `true`
enable_log логическое	Включить/выключить ведение журнала для задачи. Выбор: `false` ← (по умолчанию) `true`
firewall_accessproxy_serverpubkeyauthsettings словарь	Настройка параметров верхнего уровня.
auth_ca строка	Устаревшее, пожалуйста, переименуйте в auth_ca. Имя CA для аутентификации по открытому ключу SSH сервера.
cert_extension список / элементы=словарь	Устаревшее, пожалуйста, переименуйте в cert_extension. Расширение сертификата.
critical строка	Критический параметр. Выбор: `"no"` `"yes"`
data строка	Имя расширения сертификата.
name строка	Имя расширения сертификата.
type строка	Тип расширения сертификата. Выбор: `"fixed"` `"user"`
permit_agent_forwarding строка	Включить/отключить добавление расширения сертификата permit-agent-forwarding. Выбор: `"disable"` `"enable"`
permit_port_forwarding строка	Включить/отключить добавление расширения сертификата permit-port-forwarding. Выбор: `"disable"` `"enable"`
permit_pty строка	Включить/отключить добавление расширения сертификата permit-pty. Выбор: `"disable"` `"enable"`
permit_user_rc строка	Включить/отключить добавление расширения сертификата permit-user-rc. Выбор: `"disable"` `"enable"`
permit_x11_forwarding строка	Включить/отключить добавление расширения сертификата permit-x11-forwarding. Выбор: `"disable"` `"enable"`

source-address string	Устаревшее, пожалуйста, переименуйте на source_address. Включить/выключить добавление параметра source-address certificate critical. Варианты: `"disable"` `"enable"`
forticloud_access_token string	Проверка подлинности клиента Ansible с помощью токена доступа к API forticloud.
proposed_method string	Переопределенный метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed list / elements=integer	Список кодов rc, при которых условия будут нарушены.
rc_succeeded list / elements=integer	Список кодов rc, при которых условия будут выполнены.
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 помогут в этом.
Обычно запуск одного модуля может завершиться ошибкой, если возвращается ненулевой rc. Вы также можете переопределить условия для завершения ошибкой или успешного завершения с помощью параметров 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: Server SSH public key authentication settings.
      fortinet.fortimanager.fmgr_firewall_accessproxy_serverpubkeyauthsettings:
        # 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, ...]
        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 словарь	Результат запроса. Возвращается: всегда
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_firewall_accessproxy_serverpubkeyauthsettings_module.html