Модуль fortinet.fortimanager.fmgr_vpnmgr_node — Узел VPN для VPN Manager.

Примечание

Этот модуль входит в состав коллекции fortinet.fortimanager (версия 2.7.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.

Для использования в плейбуке укажите: fortinet.fortimanager.fmgr_vpnmgr_node.

Новое в fortinet.fortimanager 2.0.0

Описание
Параметры
Примечания
Примеры
Возвращаемые значения

Описание

Этот модуль позволяет настроить устройство FortiManager.
Примеры включают все параметры и значения, которые необходимо настроить перед использованием.

Параметры

Параметр	Комментарии
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation булево	Устанавливается в значение True только в случае расхождения схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log булево	Включить/выключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Аутентификация клиента Ansible с помощью токена доступа к API forticloud.
proposed_method строка	Переопределенный метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое	Список кодов rc, с которыми будут переопределены условия завершения работы с ошибкой.
rc_succeeded список / элементы=целое	Список кодов rc, с которыми будут переопределены условия успешного завершения работы.
state строка / обязательно	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
vpnmgr_node словарь	Набор параметров верхнего уровня.
add-route строка	Устарело, пожалуйста, переименуйте на add_route. Добавить маршрут. Варианты: `"disable"` `"enable"`
assign-ip строка	Устарело, пожалуйста, переименуйте на assign_ip. Назначить IP. Варианты: `"disable"` `"enable"`
assign-ip-from строка	Устарело, пожалуйста, переименуйте на assign_ip_from. Назначить IP из. Варианты: `"range"` `"usrgrp"` `"dhcp"` `"name"`
authpasswd любой	(список) Authpasswd.
authusr строка	Authusr.
authusrgrp строка	Authusrgrp.
auto-configuration строка	Устарело, пожалуйста, переименуйте на auto_configuration. Автонастройка. Варианты: `"disable"` `"enable"`
auto-discovery-receiver строка	Устарело, пожалуйста, переименуйте на auto_discovery_receiver. Приемник автоматического обнаружения. Варианты: `"disable"` `"enable"`
auto-discovery-sender строка	Устарело, пожалуйста, переименуйте на auto_discovery_sender. Отправитель автоматического обнаружения. Варианты: `"disable"` `"enable"`
automatic_routing строка	Автоматический маршрут. Варианты: `"disable"` `"enable"`
banner строка	Баннер.

default-gateway string	Устарело, переименуйте в default_gateway. Шлюз по умолчанию.
dhcp-ra-giaddr string	Устарело, переименуйте в dhcp_ra_giaddr. Dhcp ra giaddr.
dhcp-server string	Устарело, переименуйте в dhcp_server. DHCP-сервер. Варианты: `"disable"` `"enable"`
dns-mode string	Устарело, переименуйте в dns_mode. Режим DNS. Варианты: `"auto"` `"manual"`
dns-service string	Устарело, переименуйте в dns_service. Служба DNS. Варианты: `"default"` `"specify"` `"local"`
domain string	Домен.
encapsulation string	Инкапсуляция. Варианты: `"tunnel-mode"` `"transport-mode"`
exchange-interface-ip string	Устарело, переименуйте в exchange_interface_ip. IP-адрес интерфейса обмена. Варианты: `"disable"` `"enable"`
extgw string	Внешний шлюз.
extgw_hubip string	IP-адрес концентратора внешнего шлюза.
extgw_p2_per_net string	Внешний шлюз p2 per net. Варианты: `"disable"` `"enable"`
extgwip string	IP-адрес внешнего шлюза.
hub-public-ip string	Устарело, переименуйте в hub_public_ip. Публичный IP-адрес концентратора.
hub_iface any	(список или строка) Интерфейс концентратора.
id integer / required	Идентификатор.
iface any	(список или строка) Интерфейс.
ip-range list / elements=dictionary	Устарело, переименуйте в ip_range. Диапазон IP-адресов.
end-ip string	Устарело, переименуйте в end_ip. Конечный IP-адрес.
id integer	Идентификатор.
start-ip string	Устарело, переименуйте в start_ip. Начальный IP-адрес.
ipsec-lease-hold integer	Устарело, переименуйте в ipsec_lease_hold. Время аренды IPsec.
ipv4-dns-server1 string	Устарело, переименуйте в ipv4_dns_server1. IPv4 DNS-сервер 1.
ipv4-dns-server2 string	Устарело, переименуйте в ipv4_dns_server2. IPv4 DNS-сервер 2.
ipv4-dns-server3 string	Устарело, переименуйте в ipv4_dns_server3. IPv4 DNS-сервер 3.

ipv4-end-ip string	Устарело, переименуйте в ipv4_end_ip. Конечный IP-адрес IPv4.
ipv4-exclude-range list / elements=dictionary	Устарело, переименуйте в ipv4_exclude_range. Диапазон исключенных IP-адресов IPv4.
end-ip string	Устарело, переименуйте в end_ip. Конечный IP-адрес.
id integer	Идентификатор.
start-ip string	Устарело, переименуйте в start_ip. Начальный IP-адрес.
ipv4-name string	Устарело, переименуйте в ipv4_name. Имя IPv4.
ipv4-netmask string	Устарело, переименуйте в ipv4_netmask. Маска подсети IPv4.
ipv4-split-exclude string	Устарело, переименуйте в ipv4_split_exclude. Исключить разделение IPv4.
ipv4-split-include string	Устарело, переименуйте в ipv4_split_include. Включить разделение IPv4.
ipv4-start-ip string	Устарело, переименуйте в ipv4_start_ip. Начальный IP-адрес IPv4.
ipv4-wins-server1 string	Устарело, переименуйте в ipv4_wins_server1. WINS-сервер IPv4 1.
ipv4-wins-server2 string	Устарело, переименуйте в ipv4_wins_server2. WINS-сервер IPv4 2.
l2tp string	L2tp. Варианты: `"disable"` `"enable"`
local-gw string	Устарело, переименуйте в local_gw. Локальный шлюз.
localid string	Локальный идентификатор.
mode-cfg string	Устарело, переименуйте в mode_cfg. Режим конфигурации. Варианты: `"disable"` `"enable"`
mode-cfg-ip-version string	Устарело, переименуйте в mode_cfg_ip_version. Версия IP для режима конфигурации. Варианты: `"4"` `"6"`
net-device string	Устарело, переименуйте в net_device. Сетевое устройство. Варианты: `"disable"` `"enable"`
network-id integer	Устарело, переименуйте в network_id. Идентификатор сети.
network-overlay string	Устарело, переименуйте в network_overlay. Наложение сети. Варианты: `"enable"` `"disable"`
peer any	(список или строка) Пир.
peergrp string	Группа пиров.
peerid string	Идентификатор пира.
peertype string	Тип пира. Варианты: `"any"` `"one"` `"dialup"` `"peer"` `"peergrp"`

protected_subnet список / элементы=словарь	Защищенная подсеть.
addr любой тип	(список или строка) Адрес.
seq целое число	Последовательность.
protocol целое число	Протокол.
public-ip строка	Устарело, пожалуйста, переименуйте на public_ip. Публичный IP-адрес.
role строка	Роль. Варианты: `"hub"` `"spoke"`
route-overlap строка	Устарело, пожалуйста, переименуйте на route_overlap. Перекрытие маршрутов. Варианты: `"use-old"` `"use-new"` `"allow"`
scope member список / элементы=словарь	Устарело, пожалуйста, переименуйте на scope_member. Член области.
name строка	Имя.
vdom строка	Vdom.
spoke-zone любой тип	(список или строка) Устарело, пожалуйста, переименуйте на spoke_zone. Зона спицы.
summary_addr список / элементы=словарь	Сводный адрес.
addr строка	Адрес.
priority целое число	Приоритет.
seq целое число	Последовательность.
tunnel-search строка	Устарело, пожалуйста, переименуйте на tunnel_search. Поиск туннеля. Варианты: `"selectors"` `"nexthop"`
unity-support строка	Устарело, пожалуйста, переименуйте на unity_support. Поддержка Unity. Варианты: `"disable"` `"enable"`
usrgrp строка	Usrgrp.
vpn-interface-priority целое число	Устарело, пожалуйста, переименуйте на vpn_interface_priority. Приоритет интерфейса VPN.
vpn-zone любой тип	(список или строка) Устарело, пожалуйста, переименуйте на vpn_zone. Зона VPN.
vpntable любой тип	(список или строка) Vpntable.
xauthtype строка	Тип xauth. Варианты: `"disable"` `"client"` `"pap"` `"chap"` `"auto"`
workspace_locking_adom строка	Область, которую нужно заблокировать для FortiManager, работающего в рабочем пространстве. Значение может быть глобальным и другими, включая root.
workspace_locking_timeout целое число	Максимальное время в секундах ожидания, пока другой пользователь не освободит блокировку рабочего пространства. По умолчанию: `300`

Примечания

Примечание

Начиная с версии 2.4.0, все входные аргументы имеют имя с использованием нижнего подчеркивания (snake_case). Пожалуйста, измените аргументы, такие как “var-name”, на “var_name”. Старые имена аргументов все еще доступны, но вы получите предупреждения о устаревании. Вы можете проигнорировать это предупреждение, установив deprecation_warnings=False в ansible.cfg.
В этом модуле FortiManager поддерживается режим блокировки рабочей области. Параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout помогают в этом.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.
Обычно выполнение одного модуля может завершиться ошибкой, когда возвращается ненулевой код возврата. Вы также можете переопределить условия для завершения ошибкой или успехом с параметрами rc_failed и rc_succeeded

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: VPN node for VPN Manager.
      fortinet.fortimanager.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: present # <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: <list or string>
          authusr: <string>
          authusrgrp: <string>
          auto_configuration: <value in [disable, enable]>
          automatic_routing: <value in [disable, enable]>
          banner: <string>
          default_gateway: <string>
          dhcp_server: <value in [disable, enable]>
          dns_mode: <value in [auto, manual]>
          dns_service: <value in [default, specify, local]>
          domain: <string>
          extgw: <string>
          extgw_hubip: <string>
          extgw_p2_per_net: <value in [disable, enable]>
          extgwip: <string>
          hub_iface: <list or string>
          id: <integer>
          iface: <list or string>
          ip_range:
            -
              end_ip: <string>
              id: <integer>
              start_ip: <string>
          ipsec_lease_hold: <integer>
          ipv4_dns_server1: <string>
          ipv4_dns_server2: <string>
          ipv4_dns_server3: <string>
          ipv4_end_ip: <string>
          ipv4_exclude_range:
            -
              end_ip: <string>
              id: <integer>
              start_ip: <string>
          ipv4_netmask: <string>
          ipv4_split_include: <string>
          ipv4_start_ip: <string>
          ipv4_wins_server1: <string>
          ipv4_wins_server2: <string>
          local_gw: <string>
          localid: <string>
          mode_cfg: <value in [disable, enable]>
          mode_cfg_ip_version: <value in [4, 6]>
          net_device: <value in [disable, enable]>
          peer: <list or string>
          peergrp: <string>
          peerid: <string>
          peertype: <value in [any, one, dialup, ...]>
          protected_subnet:
            -
              addr: <list or string>
              seq: <integer>
          public_ip: <string>
          role: <value in [hub, spoke]>
          route_overlap: <value in [use-old, use-new, allow]>
          spoke_zone: <list or string>
          summary_addr:
            -
              addr: <string>
              priority: <integer>
              seq: <integer>
          tunnel_search: <value in [selectors, nexthop]>
          unity_support: <value in [disable, enable]>
          usrgrp: <string>
          vpn_interface_priority: <integer>
          vpn_zone: <list or string>
          vpntable: <list or string>
          xauthtype: <value in [disable, client, pap, ...]>
          exchange_interface_ip: <value in [disable, enable]>
          hub_public_ip: <string>
          ipv4_split_exclude: <string>
          scope_member:
            -
              name: <string>
              vdom: <string>
          dhcp_ra_giaddr: <string>
          encapsulation: <value in [tunnel-mode, transport-mode]>
          ipv4_name: <string>
          l2tp: <value in [disable, enable]>
          auto_discovery_receiver: <value in [disable, enable]>
          auto_discovery_sender: <value in [disable, enable]>
          network_id: <integer>
          network_overlay: <value in [enable, disable]>
          protocol: <integer>

Значения возврата

Общие значения возврата описаны здесь, следующие поля уникальны для этого модуля:

Ключ	Описание
meta словарь	Результат запроса. Возвращается: всегда
request_url строка	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code целое число	Статус запроса API. Возвращается: всегда Пример: `0`
response_data список / элементы=строка	Ответ API. Возвращается: всегда
response_message строка	Дескриптивное сообщение ответа API. Возвращается: всегда Пример: `"OK."`
system_information словарь	Информация о целевой системе. Возвращается: всегда
rc целое число	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning список / элементы=строка	Предупреждение, если параметры, используемые в playbook, не поддерживаются текущей версией FortiManager. Возвращается: сложный

Авторы

Xinwei Du (@dux-fortinet)
Xing Li (@lix-fortinet)
Jie Xue (@JieX19)
Link Zheng (@chillancezen)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

Ссылки на сборку

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_vpnmgr_node_module.html