Модуль fortinet.fortimanager.fmgr_firewall_accessproxysshclientcert — Настройка сертификата клиента SSH прокси-сервера доступа.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.0).
Эта коллекция может быть уже установлена, если используется пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в playbook укажите: fortinet.fortimanager.fmgr_firewall_accessproxysshclientcert.
Добавлен в fortinet.fortimanager 2.4.0
Обзор
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо настроить перед использованием из источников данных.
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Токен доступа к FortiManager без использования имени пользователя и пароля. |
adom строка / обязательно | Параметр (adom) в запрошенном URL. |
bypass_validation логическое | Устанавливается в True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты:
|
enable_log логическое | Включить/выключить ведение журнала для задачи. Варианты:
|
firewall_accessproxysshclientcert словарь | Установленные параметры верхнего уровня. |
|
auth_ca строка |
Устарело, пожалуйста, переименуйте его в auth_ca. Имя CA проверки подлинности открытого ключа SSH-сервера. |
|
cert_extension список / элементы=словарь |
Устарело, пожалуйста, переименуйте его в cert_extension. Расширение сертификата. |
|
critical строка |
Критический параметр. Варианты:
|
|
data строка |
Данные расширения сертификата. |
|
name строка |
Имя расширения сертификата. |
|
type строка |
Тип расширения сертификата. Варианты:
|
|
name строка / обязательно |
Имя сертификата SSH-клиента. |
|
permit_agent_forwarding строка |
Включить/отключить добавление расширения сертификата permit-agent-forwarding. Варианты:
|
|
permit_port_forwarding строка |
Включить/отключить добавление расширения сертификата permit-port-forwarding. Варианты:
|
|
permit_pty строка |
Включить/отключить добавление расширения сертификата permit-pty. Варианты:
|
|
permit_user_rc строка |
Включить/отключить добавление расширения сертификата permit-user-rc. Варианты:
|
|
permit_x11_forwarding строка |
Включить/отключить добавление расширения сертификата permit-x11-forwarding. Варианты:
|
|
source_address строка |
Включить/отключить добавление критического параметра source-address расширения сертификата. Варианты:
|
forticloud_access_token строка | Аутентификация клиента Ansible с помощью токена доступа к API forticloud. |
proposed_method строка | Переопределённый метод для базового запроса Json RPC. Варианты:
|
rc_failed список / элементы=целое число | Список кодов rc, по которым будут переопределены условия для сбоя. |
rc_succeeded список / элементы=целое число | Список кодов rc, по которым будут переопределены условия для успеха. |
state строка / обязательно | Директива для создания, обновления или удаления объекта. Варианты:
|
workspace_locking_adom строка | ADOM для блокировки при работе FortiManager в режиме рабочего пространства; значение может быть глобальным и другими, включая корневой. |
workspace_locking_timeout целое число | Максимальное время в секундах ожидания, пока другой пользователь не разблокирует рабочее пространство. По умолчанию: |
Примечания
Примечание
- Начиная с версии 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 (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: Configure Access Proxy SSH client certificate.
fortinet.fortimanager.fmgr_firewall_accessproxysshclientcert:
# 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>
state: present # <value in [present, absent]>
firewall_accessproxysshclientcert:
auth_ca: <string>
cert_extension:
-
critical: <value in [no, yes]>
data: <string>
name: <string>
type: <value in [fixed, user]>
name: <string>
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 запроса. Возвращается: всегда Пример: |
|
response_code целое число |
Статус запроса API. Возвращается: всегда Пример: |
|
response_data список / элементы=строка |
Ответ API. Возвращается: всегда |
|
response_message строка |
Дескриптивное сообщение ответа API. Возвращается: всегда Пример: |
|
system_information словарь |
Информация о целевой системе. Возвращается: всегда |
rc целое число | Статус запроса. Возвращается: всегда Пример: |
version_check_warning список / элементы=строка | Предупреждение, если параметры, используемые в книге задач, не поддерживаются текущей версией FortiManager. Возвращается: сложный |
Справочные ссылки коллекции
© 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_accessproxysshclientcert_module.html
