модуль fortinet.fortimanager.fmgr_vpn_ipsec_manualkey — настройка ключей IPsec вручную.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать коллекцию в плейбуке, укажите: fortinet.fortimanager.fmgr_vpn_ipsec_manualkey.
Добавлено в fortinet.fortimanager 2.12.0
Обзор
- Этот модуль предназначен для настройки устройства FortiManager.
- Примеры включают все параметры и значения, которые перед использованием необходимо адаптировать к источникам данных.
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom string / обязательный | Параметр (adom) в запрошенном URL. |
bypass_validation boolean | Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров. Варианты:
|
enable_log boolean | Включить или отключить ведение журнала для задачи. Варианты:
|
forticloud_access_token string | Аутентификация клиента Ansible с помощью токена доступа к API forticloud. |
proposed_method string | Метод, переопределяющий метод базового запроса Json RPC. Варианты:
|
rc_failed list / элементы=integer | Список кодов rc, переопределяющий условия, при которых выполнение считается неудачным. |
rc_succeeded list / элементы=integer | Список кодов rc, переопределяющий условия, при которых выполнение считается успешным. |
revision_note string | Примечание об изменении, которое можно указать при создании или обновлении объекта. |
state string / обязательный | Директива для создания, обновления или удаления объекта. Варианты:
|
vpn_ipsec_manualkey dictionary | Набор параметров верхнего уровня. |
|
authentication string |
Алгоритм аутентификации. Варианты:
|
|
authkey list / элементы=string |
Шестнадцатеричный ключ аутентификации длиной 16 цифр |
|
enckey list / элементы=string |
Шестнадцатеричный ключ шифрования длиной 16 цифр |
|
encryption string |
Алгоритм шифрования. Варианты:
|
|
interface list / элементы=string |
Имя физического, агрегированного интерфейса или интерфейса VLAN. |
|
local_gw псевдонимы: local-gw string |
Локальный шлюз. |
|
localspi string |
Локальный SPI длиной 8 шестнадцатеричных цифр |
|
name string / обязательный |
Имя туннеля IPsec. |
|
npu_offload псевдонимы: npu-offload string |
Включить или отключить разгрузку обработки на NPU. Варианты:
|
|
remote_gw псевдонимы: remote-gw string |
Шлюз узла-пира. |
|
remotespi string |
Удалённый SPI длиной 8 шестнадцатеричных цифр |
workspace_locking_adom string | ADOM, который необходимо заблокировать для FortiManager, работающего в режиме рабочего пространства. В качестве значения можно указать global, root или другое значение. |
workspace_locking_timeout integer | Максимальное время ожидания освобождения блокировки рабочего пространства другим пользователем, в секундах. По умолчанию: |
Примечания
Примечание
- Начиная с версии 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.
- Для создания или обновления объекта используйте директиву state present.
- Для удаления объекта используйте директиву state absent.
Примеры
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
gather_facts: false
tasks:
- name: Configure IPsec manual keys.
fortinet.fortimanager.fmgr_vpn_ipsec_manualkey:
# workspace_locking_adom: <global or your adom name>
adom: <your own value>
state: present # <value in [present, absent]>
vpn_ipsec_manualkey:
name: "your value" # Required variable, string
# authentication: <value in [null, md5, sha1, ...]>
# authkey: <list or string>
# enckey: <list or string>
# encryption: <value in [null, des, 3des, ...]>
# interface: <list or string>
# local_gw: <string>
# localspi: <string>
# npu_offload: <value in [disable, enable]>
# remote_gw: <string>
# remotespi: <string>
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
meta dictionary | Результат запроса. Возвращается: всегда |
|
request_url string |
Полный URL запроса. Возвращается: всегда Пример: |
|
response_code integer |
Статус запроса API. Возвращается: всегда Пример: |
|
response_data list / элементы=string |
Ответ API. Возвращается: всегда |
|
response_message string |
Описание ответа API. Возвращается: всегда Пример: |
|
system_information dictionary |
Информация о целевой системе. Возвращается: всегда |
rc integer | Статус запроса. Возвращается: всегда Пример: |
version_check_warning list / элементы=string | Предупреждение о том, что используемые в плейбуке параметры не поддерживаются текущей версией FortiManager. Возвращается: при сложных условиях |
Ссылки на коллекцию
© 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/fortimanager/fmgr_vpn_ipsec_manualkey_module.html
