Spec-Zone.ru › Ansible

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

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.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

string

Токен для доступа к FortiManager без использования имени пользователя и пароля.

adom

string / обязательно

Параметр (adom) в запрашиваемом URL.

bypass_validation

boolean

Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager; модуль продолжит выполнение без проверки параметров.

Варианты:

  • false ← (по умолчанию)
  • true

enable_log

boolean

Включить или отключить ведение журнала для задачи.

Варианты:

  • false ← (по умолчанию)
  • true

forticloud_access_token

string

Аутентификация клиента Ansible с помощью токена доступа к API forticloud.

proposed_method

string

Переопределённый метод для базового запроса Json RPC.

Варианты:

  • "update"
  • "set"
  • "add"

rc_failed

list / elements=integer

Список кодов rc, для которых будут переопределены условия сбоя.

rc_succeeded

list / elements=integer

Список кодов rc, для которых будут переопределены условия успешного выполнения.

revision_note

string

Примечание об изменении, которое можно указать при создании или обновлении объекта.

state

string / обязательно

Указание на создание, обновление или удаление объекта.

Варианты:

  • "present"
  • "absent"

vpnmgr_node

dictionary

Набор параметров верхнего уровня.

add_route

псевдонимы: add-route

string

Добавить маршрут.

Варианты:

  • "disable"
  • "enable"

assign_ip

псевдонимы: assign-ip

string

Назначить IP-адрес.

Варианты:

  • "disable"
  • "enable"

assign_ip_from

псевдонимы: assign-ip-from

string

Источник назначения IP-адреса.

Варианты:

  • "range"
  • "usrgrp"
  • "dhcp"
  • "name"

authpasswd

any

(список) Пароль аутентификации.

authusr

string

Пользователь аутентификации.

authusrgrp

string

Группа пользователей аутентификации.

auto_configuration

псевдонимы: auto-configuration

string

Автоматическая настройка.

Варианты:

  • "disable"
  • "enable"

auto_discovery_receiver

псевдонимы: auto-discovery-receiver

string

Получатель автоматического обнаружения.

Варианты:

  • "disable"
  • "enable"

auto_discovery_sender

псевдонимы: auto-discovery-sender

string

Отправитель автоматического обнаружения.

Варианты:

  • "disable"
  • "enable"

automatic_routing

string

Автоматическая маршрутизация.

Варианты:

  • "disable"
  • "enable"

banner

string

Баннер.

default_gateway

псевдонимы: default-gateway

string

Шлюз по умолчанию.

dhcp_ra_giaddr

псевдонимы: dhcp-ra-giaddr

string

Адрес giaddr для DHCP RA.

dhcp_server

псевдонимы: dhcp-server

string

DHCP-сервер.

Варианты:

  • "disable"
  • "enable"

dns_mode

псевдонимы: dns-mode

string

Режим DNS.

Варианты:

  • "auto"
  • "manual"

dns_service

псевдонимы: dns-service

string

Служба DNS.

Варианты:

  • "default"
  • "specify"
  • "local"

domain

string

Домен.

encapsulation

string

Инкапсуляция.

Варианты:

  • "tunnel-mode"
  • "transport-mode"

exchange_interface_ip

псевдонимы: exchange-interface-ip

string

Обмен IP-адресами интерфейса.

Варианты:

  • "disable"
  • "enable"

extgw

string

Внешний шлюз.

extgw_hubip

string

IP-адрес концентратора внешнего шлюза.

extgw_p2_per_net

string

Внешний шлюз P2 для каждой сети.

Варианты:

  • "disable"
  • "enable"

extgwip

string

IP-адрес внешнего шлюза.

hub_iface

any

(список или строка) Интерфейс концентратора.

hub_public_ip

псевдонимы: hub-public-ip

string

Публичный IP-адрес концентратора.

id

integer / обязательно

Идентификатор.

iface

any

(список или строка) Интерфейс.

ip_range

псевдонимы: ip-range

list / elements=dictionary

Диапазон IP-адресов.

end_ip

псевдонимы: end-ip

string

Конечный IP-адрес.

id

integer

Идентификатор.

start_ip

псевдонимы: start-ip

string

Начальный IP-адрес.

ipsec_lease_hold

псевдонимы: ipsec-lease-hold

integer

Удержание аренды IPsec.

ipv4_dns_server1

псевдонимы: ipv4-dns-server1

string

Первый DNS-сервер IPv4.

ipv4_dns_server2

псевдонимы: ipv4-dns-server2

string

Второй DNS-сервер IPv4.

ipv4_dns_server3

псевдонимы: ipv4-dns-server3

string

Третий DNS-сервер IPv4.

ipv4_end_ip

псевдонимы: ipv4-end-ip

string

Конечный IPv4-адрес.

ipv4_exclude_range

псевдонимы: ipv4-exclude-range

list / elements=dictionary

Исключаемый диапазон IPv4-адресов.

end_ip

псевдонимы: end-ip

string

Конечный IP-адрес.

id

integer

Идентификатор.

start_ip

псевдонимы: start-ip

string

Начальный IP-адрес.

ipv4_name

псевдонимы: ipv4-name

string

Имя IPv4.

ipv4_netmask

псевдонимы: ipv4-netmask

string

Маска подсети IPv4.

ipv4_split_exclude

псевдонимы: ipv4-split-exclude

string

Исключение IPv4 из туннеля с раздельной маршрутизацией.

ipv4_split_include

псевдонимы: ipv4-split-include

string

Включение IPv4 в туннель с раздельной маршрутизацией.

ipv4_start_ip

псевдонимы: ipv4-start-ip

string

Начальный IPv4-адрес.

ipv4_wins_server1

псевдонимы: ipv4-wins-server1

string

Первый WINS-сервер IPv4.

ipv4_wins_server2

псевдонимы: ipv4-wins-server2

string

Второй WINS-сервер IPv4.

l2tp

string

L2TP.

Варианты:

  • "disable"
  • "enable"

local_gw

псевдонимы: local-gw

string

Локальный шлюз.

localid

string

Локальный идентификатор.

mode_cfg

псевдонимы: mode-cfg

string

Конфигурация режима.

Варианты:

  • "disable"
  • "enable"

mode_cfg_ip_version

псевдонимы: mode-cfg-ip-version

string

Версия IP для конфигурации режима.

Варианты:

  • "4"
  • "6"

net_device

псевдонимы: net-device

string

Сетевое устройство.

Варианты:

  • "disable"
  • "enable"

network_id

псевдонимы: network-id

integer

Идентификатор сети.

network_overlay

псевдонимы: network-overlay

string

Наложенная сеть.

Варианты:

  • "enable"
  • "disable"

peer

any

(список или строка) Узел-партнер.

peergrp

string

Группа узлов-партнеров.

peerid

string

Идентификатор узла-партнера.

peertype

string

Тип узла-партнера.

Варианты:

  • "any"
  • "one"
  • "dialup"
  • "peer"
  • "peergrp"

protected_subnet

list / elements=dictionary

Защищенная подсеть.

addr

any

(список или строка) Адрес.

seq

integer

Порядковый номер.

protocol

integer

Протокол.

public_ip

псевдонимы: public-ip

string

Публичный IP-адрес.

role

string

Роль.

Варианты:

  • "hub"
  • "spoke"

route_overlap

псевдонимы: route-overlap

string

Перекрытие маршрутов.

Варианты:

  • "use-old"
  • "use-new"
  • "allow"

scope_member

псевдонимы: scope member

list / elements=dictionary

Участник области действия.

name

string

Имя.

vdom

string

VDOM.

spoke_zone

псевдонимы: spoke-zone

any

(список или строка) Зона узла Spoke.

summary_addr

list / elements=dictionary

Сводный адрес.

addr

string

Адрес.

priority

integer

Приоритет.

seq

integer

Порядковый номер.

tunnel_search

псевдонимы: tunnel-search

string

Поиск туннеля.

Варианты:

  • "selectors"
  • "nexthop"

unity_support

псевдонимы: unity-support

string

Поддержка Unity.

Варианты:

  • "disable"
  • "enable"

usrgrp

string

Группа пользователей.

vpn_interface_priority

псевдонимы: vpn-interface-priority

integer

Приоритет интерфейса VPN.

vpn_zone

псевдонимы: vpn-zone

any

(список или строка) Зона VPN.

vpntable

any

(список или строка) Таблица VPN.

xauthtype

string

Тип XAuth.

Варианты:

  • "disable"
  • "client"
  • "pap"
  • "chap"
  • "auto"

workspace_locking_adom

string

ADOM, который нужно заблокировать для FortiManager, работающего в режиме рабочей области; значение может быть global или другим, включая root.

workspace_locking_timeout

integer

Максимальное время в секундах ожидания снятия блокировки рабочей области другим пользователем.

По умолчанию: 300

Примечания

Примечание

  • Начиная с версии 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: VPN node for VPN Manager.
      fortinet.fortimanager.fmgr_vpnmgr_node:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        state: present # <value in [present, absent]>
        vpnmgr_node:
          id: 0 # Required variable, integer
          # 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>
          # 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

dictionary

Результат запроса.

Возвращается: всегда

request_url

string

Полный URL запроса.

Возвращается: всегда

Пример: "/sys/login/user"

response_code

integer

Статус запроса API.

Возвращается: всегда

Пример: 0

response_data

list / elements=string

Ответ API.

Возвращается: всегда

response_message

string

Описание ответа API.

Возвращается: всегда

Пример: "OK."

system_information

dictionary

Информация о целевой системе.

Возвращается: всегда

rc

integer

Статус запроса.

Возвращается: всегда

Пример: 0

version_check_warning

list / elements=string

Предупреждение, если используемые в плейбуке параметры не поддерживаются текущей версией 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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortimanager/fmgr_vpnmgr_node_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API