fortinet.fortios.fortios_vpn_certificate_local – Локальные ключи и сертификаты в FortiOS и FortiGate Fortinet.
Примечание
Этот плагин входит в коллекцию fortinet.fortios (версия 1.1.8).
Для его установки используйте: ansible-galaxy collection install fortinet.fortios.
Чтобы использовать его в книге задач, укажите: fortinet.fortios.fortios_vpn_certificate_local.
Введено в версии 2.9: fortinet.fortios
Описание
- Этот модуль позволяет настроить устройство FortiGate или FortiOS (FOS), позволяя пользователю устанавливать и изменять функцию vpn_certificate и локальную категорию. Примеры включают все параметры и значения, которые необходимо настроить в источниках данных перед использованием. Тестировалось с FOS v6.0.0
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- ansible>=2.9.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| access_token строка | Аутентификация на основе токена. Сгенерировано в интерфейсе Fortigate. | ||
| state строка / обязательно |
| Указывает, нужно ли создать или удалить объект. | |
| vdom строка | Значение по умолчанию: "root" | Виртуальная область, среди ранее определенных. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. | |
| vpn_certificate_local словарь | Локальные ключи и сертификаты. | ||
| auto_regenerate_days целое число | Количество дней ожидания до истечения срока действия обновленного локального сертификата (0 = отключено). | ||
| auto_regenerate_days_warning целое число | Количество дней ожидания до вывода предупреждения об истечении срока действия (0 = отключено). | ||
| ca_identifier строка | Идентификатор CA сервера CA для подписи через SCEP. | ||
| certificate строка | Сертификат в формате PEM. | ||
| cmp_path строка | Путь внутри сервера CMP. | ||
| cmp_regeneration_method строка |
| Метод автоматического восстановления CMP. | |
| cmp_server строка | "ADDRESS:PORT" для сервера CMP. | ||
| cmp_server_cert строка | Сертификат сервера CMP. Источник vpn.certificate.ca.name. | ||
| comments строка | Комментарий. | ||
| csr строка | Запрос на подпись сертификата. | ||
| enroll_protocol строка |
| Протокол регистрации сертификата. | |
| ike_localid строка | Локальный идентификатор, используемый FortiGate для аутентификации в качестве клиента VPN. | ||
| ike_localid_type строка |
| Тип локального идентификатора IKE. | |
| last_updated целое число | Время последнего обновления сертификата. | ||
| name строка / обязательно | Имя. | ||
| name_encoding строка |
| Метод кодирования имени для автоматического восстановления. | |
| password строка | Пароль в виде файла PEM. | ||
| private_key строка | Ключ в формате PEM, зашифрованный паролем. | ||
| range строка |
| IP-адрес диапазон для сертификата (глобальный или VDOM). | |
| scep_password строка | Пароль вызова сервера SCEP для автоматического восстановления. | ||
| scep_url строка | URL сервера SCEP. | ||
| source строка |
| Тип источника сертификата. | |
| source_ip строка | IP-адрес источника для связи с сервером SCEP. | ||
| state строка | Состояние запроса на подпись сертификата. | ||
Примечания
Примечание
- Модуль fortiosapi устарел, httpapi предпочтительнее для запуска книг задач.
Примеры
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Local keys and certificates.
fortios_vpn_certificate_local:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
vpn_certificate_local:
auto_regenerate_days: "3"
auto_regenerate_days_warning: "4"
ca_identifier: "myId_5"
certificate: "<your_own_value>"
cmp_path: "<your_own_value>"
cmp_regeneration_method: "keyupate"
cmp_server: "<your_own_value>"
cmp_server_cert: "<your_own_value> (source vpn.certificate.ca.name)"
comments: "<your_own_value>"
csr: "<your_own_value>"
enroll_protocol: "none"
ike_localid: "<your_own_value>"
ike_localid_type: "asn1dn"
last_updated: "16"
name: "default_name_17"
name_encoding: "printable"
password: "<your_own_value>"
private_key: "<your_own_value>"
range: "global"
scep_password: "<your_own_value>"
scep_url: "<your_own_value>"
source: "factory"
source_ip: "84.230.14.43"
state: "<your_own_value>"
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| build строка | всегда | Номер сборки образа fortigate. Пример: 1547 |
| http_method строка | всегда | Последний метод, используемый для предоставления содержимого в FortiGate. Пример: PUT |
| http_status строка | всегда | Последний результат, предоставленный FortiGate при последней операции. Пример: 200 |
| mkey строка | успех | Главный ключ (id), используемый при последнем запросе к FortiGate. Пример: id |
| name строка | всегда | Имя таблицы, используемой для выполнения запроса. Пример: urlfilter |
| path строка | всегда | Путь таблицы, используемой для выполнения запроса. Пример: webfilter |
| revision строка | всегда | Внутренний номер ревизии. Пример: 17.0.2.10658 |
| serial строка | всегда | Серийный номер устройства. Пример: FGVMEVYYQT3AB5352 |
| status строка | всегда | Указание результата операции. Пример: success |
| vdom строка | всегда | Используемая виртуальная область. Пример: root |
| version строка | всегда | Версия FortiGate. Пример: v5.6.3 |
Авторы
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Hongbin Lu (@fgtdev-hblu)
- Frank Shen (@frankshen01)
- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/fortinet/fortios/fortios_vpn_certificate_local_module.html