fortinet.fortimanager.fmgr_vpnmgr_node – Узел VPN для VPN-менеджера. Необходимо указать vpntable и scope member.
Примечание
Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в плейбуке, укажите: fortinet.fortimanager.fmgr_vpnmgr_node.
Новое в версии 2.10: коллекции fortinet.fortimanager
Обзор
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо настроить из источников данных перед использованием.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | ||
|---|---|---|---|---|
| adom строка / обязательно | параметр (adom) в запрошенном URL | |||
| bypass_validation булево |
| устанавливается только в случае, если схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров | ||
| rc_failed список / элементы=строка | список кодов rc, с которыми будут переопределены условия для отказа | |||
| rc_succeeded список / элементы=строка | список кодов rc, с которыми будут переопределены условия для успеха | |||
| state строка / обязательно |
| директива для создания, обновления или удаления объекта | ||
| vpnmgr_node словарь | параметры верхнего уровня | |||
| add-route строка |
| нет описания | ||
| assign-ip строка |
| нет описания | ||
| assign-ip-from строка |
| нет описания | ||
| authpasswd строка | нет описания | |||
| authusr строка | нет описания | |||
| authusrgrp строка | нет описания | |||
| auto-configuration строка |
| нет описания | ||
| automatic_routing строка |
| нет описания | ||
| banner строка | нет описания | |||
| default-gateway строка | нет описания | |||
| dhcp-server строка |
| нет описания | ||
| dns-mode строка |
| нет описания | ||
| dns-service строка |
| нет описания | ||
| domain строка | нет описания | |||
| extgw строка | нет описания | |||
| extgw_hubip строка | нет описания | |||
| extgw_p2_per_net строка |
| нет описания | ||
| extgwip строка | нет описания | |||
| hub_iface строка | нет описания | |||
| id целое число | нет описания | |||
| iface строка | нет описания | |||
| ip-range список / элементы=строка | нет описания | |||
| end-ip строка | нет описания | |||
| id целое число | нет описания | |||
| start-ip строка | нет описания | |||
| ipsec-lease-hold целое число | нет описания | |||
| ipv4-dns-server1 строка | нет описания | |||
| ipv4-dns-server2 строка | нет описания | |||
| ipv4-dns-server3 строка | нет описания | |||
| ipv4-end-ip строка | нет описания | |||
| ipv4-exclude-range список / элементы=строка | нет описания | |||
| end-ip строка | нет описания | |||
| id целое число | нет описания | |||
| start-ip строка | нет описания | |||
| ipv4-netmask строка | нет описания | |||
| ipv4-split-include строка | нет описания | |||
| ipv4-start-ip строка | нет описания | |||
| ipv4-wins-server1 строка | нет описания | |||
| ipv4-wins-server2 строка | нет описания | |||
| local-gw строка | нет описания | |||
| localid строка | нет описания | |||
| mode-cfg строка |
| нет описания | ||
| mode-cfg-ip-version строка |
| нет описания | ||
| net-device строка |
| нет описания | ||
| peer строка | нет описания | |||
| peergrp строка | нет описания | |||
| peerid строка | нет описания | |||
| peertype строка |
| нет описания | ||
| protected_subnet список / элементы=строка | нет описания | |||
| addr строка | нет описания | |||
| seq целое число | нет описания | |||
| public-ip строка | нет описания | |||
| role строка |
| нет описания | ||
| route-overlap строка |
| нет описания | ||
| член области список / элементы=строка | нет описания | |||
| имя строка | имя члена области | |||
| vdom строка | vdom члена области | |||
| зона-спицы строка | нет описания | |||
| адрес_резюме список / элементы=строка | нет описания | |||
| адрес строка | нет описания | |||
| приоритет целое число | нет описания | |||
| последовательность целое число | нет описания | |||
| поиск_туннеля строка |
| нет описания | ||
| поддержка_unity строка |
| нет описания | ||
| usrgrp строка | нет описания | |||
| приоритет_интерфейса_vpn целое число | нет описания | |||
| зона_vpn строка | нет описания | |||
| таблица_vpn строка | нет описания | |||
| тип_аутентификации_x строка |
| нет описания | ||
| блокировка_рабочей_площадки_adom строка | adom для блокировки при запуске FortiManager в режиме рабочего пространства, значение может быть глобальным и другими, включая корневой | |||
| таймаут_блокировки_рабочего_пространства целое число | По умолчанию: 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: VPN node for VPN Manager. Must specify vpntable and scope member.
fmgr_vpnmgr_node:
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: <value in [present, absent]>
vpnmgr_node:
add-route: <value in [disable, enable]>
assign-ip: <value in [disable, enable]>
assign-ip-from: <value in [range, usrgrp, dhcp, ...]>
authpasswd: <value of string>
authusr: <value of string>
authusrgrp: <value of string>
auto-configuration: <value in [disable, enable]>
automatic_routing: <value in [disable, enable]>
banner: <value of string>
default-gateway: <value of string>
dhcp-server: <value in [disable, enable]>
dns-mode: <value in [auto, manual]>
dns-service: <value in [default, specify, local]>
domain: <value of string>
extgw: <value of string>
extgw_hubip: <value of string>
extgw_p2_per_net: <value in [disable, enable]>
extgwip: <value of string>
hub_iface: <value of string>
id: <value of integer>
iface: <value of string>
ip-range:
-
end-ip: <value of string>
id: <value of integer>
start-ip: <value of string>
ipsec-lease-hold: <value of integer>
ipv4-dns-server1: <value of string>
ipv4-dns-server2: <value of string>
ipv4-dns-server3: <value of string>
ipv4-end-ip: <value of string>
ipv4-exclude-range:
-
end-ip: <value of string>
id: <value of integer>
start-ip: <value of string>
ipv4-netmask: <value of string>
ipv4-split-include: <value of string>
ipv4-start-ip: <value of string>
ipv4-wins-server1: <value of string>
ipv4-wins-server2: <value of string>
local-gw: <value of string>
localid: <value of string>
mode-cfg: <value in [disable, enable]>
mode-cfg-ip-version: <value in [4, 6]>
net-device: <value in [disable, enable]>
peer: <value of string>
peergrp: <value of string>
peerid: <value of string>
peertype: <value in [any, one, dialup, ...]>
protected_subnet:
-
addr: <value of string>
seq: <value of integer>
public-ip: <value of string>
role: <value in [hub, spoke]>
route-overlap: <value in [use-old, use-new, allow]>
spoke-zone: <value of string>
summary_addr:
-
addr: <value of string>
priority: <value of integer>
seq: <value of integer>
tunnel-search: <value in [selectors, nexthop]>
unity-support: <value in [disable, enable]>
usrgrp: <value of string>
vpn-interface-priority: <value of integer>
vpn-zone: <value of string>
vpntable: <value of string>
xauthtype: <value in [disable, client, pap, ...]>
scope member:
-
name: <value of string>
vdom: <value of string>
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| request_url строка | всегда | Полный запрашиваемый URL Пример: /sys/login/user |
| response_code целое число | всегда | Статус запроса API |
| response_message строка | всегда | Детальное сообщение ответа 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_vpnmgr_node_module.html