модуль fortinet.fortios.fortios_vpn_qkd — настройка сервера распределения квантовых ключей в Fortinet FortiOS и FortiGate.
Примечание
Этот модуль входит в коллекцию fortinet.fortios (версия 2.5.1).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля могут потребоваться дополнительные компоненты; подробности см. в разделе Требования.
Чтобы использовать его в плейбуке, укажите: fortinet.fortios.fortios_vpn_qkd.
Добавлено в fortinet.fortios 2.0.0
Обзор
- Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), задавая и изменяя параметры функции vpn и категории qkd. Примеры содержат все параметры и значения, которые необходимо скорректировать в соответствии с источниками данных перед использованием. Тестировался с FOS v6.0.0
Требования
На узле, выполняющем этот модуль, должны быть установлены перечисленные ниже компоненты.
- ansible>=2.16
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Аутентификация на основе токена. Токен создается в графическом интерфейсе FortiGate. |
enable_log boolean | Включить или отключить ведение журнала для задачи. Варианты:
|
member_path string | Путь к атрибуту элемента, с которым нужно выполнить операцию. Если атрибутов несколько, они разделяются символом косой черты. Параметр с указанием member_path можно использовать для выполнения операции с элементом. |
member_state string | Добавить или удалить элемент по указанному пути к атрибуту. Если задан member_state, параметр state игнорируется. Варианты:
|
state string / обязательный | Указывает, следует ли создать или удалить объект. Варианты:
|
vdom string | Виртуальный домен из числа ранее определенных. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: |
vpn_qkd dictionary | Настройка серверов распределения квантовых ключей |
|
certificate list / элементы=dictionary |
Имена до 4 сертификатов, предлагаемых KME. |
|
name string / обязательный |
Имя сертификата. Источник: vpn.certificate.local.name. |
|
comment string |
Комментарий. |
|
id string |
Идентификатор распределения квантовых ключей, назначенный KME. |
|
name string / обязательный |
Имя конфигурации распределения квантовых ключей. |
|
peer string |
Аутентификация сертификата устройства распределения квантовых ключей с помощью узла или группы узлов. Источник: user.peer.name, user.peergrp.name. |
|
port integer |
Порт для подключения к KME. |
|
server string |
Адрес KME в формате IPv4, IPv6 или DNS. |
Примечания
Примечание
- Устаревший fortiosapi объявлен устаревшим; для запуска плейбуков рекомендуется использовать httpapi
- Модуль поддерживает check_mode.
Примеры
- name: Configure Quantum Key Distribution servers
fortinet.fortios.fortios_vpn_qkd:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
vpn_qkd:
certificate:
-
name: "default_name_4 (source vpn.certificate.local.name)"
comment: "Comment."
id: "6"
name: "default_name_7"
peer: "<your_own_value> (source user.peer.name user.peergrp.name)"
port: "0"
server: "192.168.100.40"
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
build string | Номер сборки образа FortiGate Возвращается: всегда Пример: |
http_method string | Последний метод, использованный для передачи содержимого в FortiGate Возвращается: всегда Пример: |
http_status string | Последний результат, возвращенный FortiGate при последней выполненной операции Возвращается: всегда Пример: |
mkey string | Главный ключ (идентификатор), использованный при последнем обращении к FortiGate Возвращается: при успешном выполнении Пример: |
name string | Имя таблицы, использованной для выполнения запроса Возвращается: всегда Пример: |
path string | Путь к таблице, использованной для выполнения запроса Возвращается: всегда Пример: |
revision string | Внутренний номер редакции Возвращается: всегда Пример: |
serial string | Серийный номер устройства Возвращается: всегда Пример: |
status string | Результат операции Возвращается: всегда Пример: |
vdom string | Используемый виртуальный домен Возвращается: всегда Пример: |
version string | Версия FortiGate Возвращается: всегда Пример: |
Ссылки на коллекцию
© 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/fortios/fortios_vpn_qkd_module.html