fortinet.fortimanager.fmgr_system_certificate_remote – Удалённый сертификат.
Примечание
Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в плейбуке укажите: fortinet.fortimanager.fmgr_system_certificate_remote.
Добавлено в версии 2.10: модуля fortinet.fortimanager
Обзор
- Этот модуль может настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать, прежде чем использовать данные из источников данных.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| bypass_validation boolean |
| Устанавливать в True только в случае расхождений между схемой модуля и структурой API FortiManager, модуль продолжит выполнение без проверки параметров. | |
| rc_failed list / elements=string | Список кодов rc, при которых выполнение будет прервано. | ||
| rc_succeeded list / elements=string | Список кодов rc, при которых выполнение будет успешно завершено. | ||
| state string / required |
| Директива для создания, обновления или удаления объекта. | |
| system_certificate_remote dictionary | Параметры верхнего уровня. | ||
| cert string | Без описания. | ||
| comment string | Комментарий к удалённому сертификату. | ||
| name string | Без описания. | ||
| workspace_locking_adom string | ADOM для блокировки при работе в режиме рабочей области FortiManager, значение может быть глобальным и другими, включая корневой. | ||
| workspace_locking_timeout integer | По умолчанию: 300 | Максимальное время ожидания (в секундах) освобождения блокировки рабочей области другим пользователем. | |
Примечания
Примечание
- В этом модуле FortiManager поддерживается работа с блокировкой рабочей области. Для этого используются параметры workspace_locking_adom и workspace_locking_timeout.
- Для создания или обновления объекта используйте директиву state present.
- Для удаления объекта используйте директиву state absent.
- Обычно, выполнение модуля может завершиться ошибкой при возвращении ненулевого кода rc. Вы также можете настроить условия для обработки ошибок или успешного завершения с помощью параметров rc_failed и rc_succeeded.
Примеры
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Remote certificate.
fmgr_system_certificate_remote:
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: <value in [present, absent]>
system_certificate_remote:
cert: <value of string>
comment: <value of string>
name: <value of string>
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| request_url string | всегда | Полный запрашиваемый URL. Пример: /sys/login/user |
| response_code integer | всегда | Статус запроса API. |
| response_message string | всегда | Детальное сообщение ответа API. Пример: OK. |
Авторы
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_system_certificate_remote_module.html
