Spec-Zone.ru › Ansible

модуль fortinet.fortimanager.fmgr_fsp_vlan_dynamicmapping_interface – интерфейс динамического сопоставления VLAN FSP

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.

Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_fsp_vlan_dynamicmapping_interface.

Добавлено в fortinet.fortimanager 2.0.0

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

Краткое описание

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

Параметры

Параметр

Комментарии

access_token

string

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

adom

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

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

bypass_validation

boolean

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

Варианты:

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

dynamic_mapping

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

Параметр (dynamic_mapping) в запрошенном URL.

enable_log

boolean

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

Варианты:

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

forticloud_access_token

string

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

fsp_vlan_dynamicmapping_interface

dictionary

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

dhcp_relay_agent_option

псевдонимы: dhcp-relay-agent-option

string

Параметр агента ретрансляции DHCP.

Варианты:

  • "disable"
  • "enable"

dhcp_relay_interface_select_method

псевдонимы: dhcp-relay-interface-select-method

string

Метод выбора интерфейса ретрансляции DHCP.

Варианты:

  • "auto"
  • "sdwan"
  • "specify"

dhcp_relay_ip

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

any

(список) IP-адрес ретрансляции DHCP.

dhcp_relay_service

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

string

Служба ретрансляции DHCP.

Варианты:

  • "disable"
  • "enable"

dhcp_relay_type

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

string

Тип ретрансляции DHCP.

Варианты:

  • "regular"
  • "ipsec"

ip

string

IP-адрес.

ipv6

dictionary

IPv6.

autoconf

string

Автонастройка.

Варианты:

  • "disable"
  • "enable"

cli_conn6_status

псевдонимы: cli-conn6-status

integer

Состояние подключения CLI IPv6.

dhcp6_client_options

псевдонимы: dhcp6-client-options

list / elements=string

Параметры клиента DHCPv6.

Варианты:

  • "rapid"
  • "iapd"
  • "iana"
  • "dns"
  • "dnsname"

dhcp6_information_request

псевдонимы: dhcp6-information-request

string

Запрос информации DHCPv6.

Варианты:

  • "disable"
  • "enable"

dhcp6_prefix_delegation

псевдонимы: dhcp6-prefix-delegation

string

Делегирование префикса DHCPv6.

Варианты:

  • "disable"
  • "enable"

dhcp6_prefix_hint

псевдонимы: dhcp6-prefix-hint

string

Подсказка префикса DHCPv6.

dhcp6_prefix_hint_plt

псевдонимы: dhcp6-prefix-hint-plt

integer

PLT подсказки префикса DHCPv6.

dhcp6_prefix_hint_vlt

псевдонимы: dhcp6-prefix-hint-vlt

integer

VLT подсказки префикса DHCPv6.

dhcp6_relay_ip

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

string

IP-адрес ретрансляции DHCPv6.

dhcp6_relay_service

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

string

Служба ретрансляции DHCPv6.

Варианты:

  • "disable"
  • "enable"

dhcp6_relay_source_interface

псевдонимы: dhcp6-relay-source-interface

string

Включить/отключить использование адреса этого интерфейса в качестве исходного адреса сообщения ретрансляции.

Варианты:

  • "disable"
  • "enable"

dhcp6_relay_type

псевдонимы: dhcp6-relay-type

string

Тип ретрансляции DHCPv6.

Варианты:

  • "regular"

icmp6_send_redirect

псевдонимы: icmp6-send-redirect

string

Включить/отключить отправку перенаправлений ICMPv6.

Варианты:

  • "disable"
  • "enable"

interface_identifier

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

string

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

ip6_address

псевдонимы: ip6-address

string

IPv6-адрес.

ip6_allowaccess

псевдонимы: ip6-allowaccess

list / elements=string

Разрешённый доступ IPv6.

Варианты:

  • "https"
  • "ping"
  • "ssh"
  • "snmp"
  • "http"
  • "telnet"
  • "fgfm"
  • "capwap"
  • "fabric"

ip6_default_life

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

integer

Время жизни IPv6 по умолчанию.

ip6_delegated_prefix_iaid

псевдонимы: ip6-delegated-prefix-iaid

integer

IAID полученного делегированного префикса с вышестоящего интерфейса.

ip6_delegated_prefix_list

псевдонимы: ip6-delegated-prefix-list

list / elements=dictionary

Список делегированных префиксов IPv6.

autonomous_flag

псевдонимы: autonomous-flag

string

Флаг автономной конфигурации.

Варианты:

  • "disable"
  • "enable"

delegated_prefix_iaid

псевдонимы: delegated-prefix-iaid

integer

IAID полученного делегированного префикса с вышестоящего интерфейса.

onlink_flag

псевдонимы: onlink-flag

string

Флаг Onlink.

Варианты:

  • "disable"
  • "enable"

prefix_id

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

integer

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

rdnss

any

(список) RDNSS.

rdnss_service

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

string

Служба RDNSS.

Варианты:

  • "delegated"
  • "default"
  • "specify"

subnet

string

upstream_interface

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

string

Вышестоящий интерфейс.

ip6_dns_server_override

псевдонимы: ip6-dns-server-override

string

Переопределение DNS-сервера IPv6.

Варианты:

  • "disable"
  • "enable"

ip6_extra_addr

псевдонимы: ip6-extra-addr

list / elements=dictionary

Дополнительный IPv6-адрес.

prefix

string

Префикс.

ip6_hop_limit

псевдонимы: ip6-hop-limit

integer

Лимит переходов IPv6.

ip6_link_mtu

псевдонимы: ip6-link-mtu

integer

MTU канала IPv6.

ip6_manage_flag

псевдонимы: ip6-manage-flag

string

Флаг управления IPv6.

Варианты:

  • "disable"
  • "enable"

ip6_max_interval

псевдонимы: ip6-max-interval

integer

Максимальный интервал IPv6.

ip6_min_interval

aliases: ip6-min-interval

integer

Минимальный интервал IPv6.

ip6_mode

aliases: ip6-mode

string

Режим IPv6.

Возможные значения:

  • "static"
  • "dhcp"
  • "pppoe"
  • "delegated"

ip6_other_flag

aliases: ip6-other-flag

string

Флаг other для IPv6.

Возможные значения:

  • "disable"
  • "enable"

ip6_prefix_list

aliases: ip6-prefix-list

list / elements=dictionary

Список префиксов IPv6.

autonomous_flag

aliases: autonomous-flag

string

Флаг автономной конфигурации.

Возможные значения:

  • "disable"
  • "enable"

dnssl

any

(список) Список поиска DNS.

onlink_flag

aliases: onlink-flag

string

Флаг on-link.

Возможные значения:

  • "disable"
  • "enable"

preferred_life_time

aliases: preferred-life-time

integer

Предпочтительное время жизни.

prefix

string

Префикс.

rdnss

any

(список) Серверы DNS.

valid_life_time

aliases: valid-life-time

integer

Срок действия.

ip6_prefix_mode

aliases: ip6-prefix-mode

string

Назначение префикса через DHCP или RA.

Возможные значения:

  • "dhcp6"
  • "ra"

ip6_reachable_time

aliases: ip6-reachable-time

integer

Время доступности IPv6.

ip6_retrans_time

aliases: ip6-retrans-time

integer

Время повторной передачи IPv6.

ip6_send_adv

aliases: ip6-send-adv

string

Отправка объявлений IPv6.

Возможные значения:

  • "disable"
  • "enable"

ip6_subnet

aliases: ip6-subnet

string

Подсеть IPv6.

ip6_upstream_interface

aliases: ip6-upstream-interface

string

Вышестоящий интерфейс IPv6.

nd_cert

aliases: nd-cert

string

Сертификат ND.

nd_cga_modifier

aliases: nd-cga-modifier

string

Модификатор CGA для ND.

nd_mode

aliases: nd-mode

string

Режим ND.

Возможные значения:

  • "basic"
  • "SEND-compatible"

nd_security_level

aliases: nd-security-level

integer

Уровень безопасности ND.

nd_timestamp_delta

aliases: nd-timestamp-delta

integer

Дельта временной метки ND.

nd_timestamp_fuzz

aliases: nd-timestamp-fuzz

integer

Допуск временной метки ND.

ra_send_mtu

aliases: ra-send-mtu

string

Включить или отключить передачу MTU канала в пакете RA.

Возможные значения:

  • "disable"
  • "enable"

unique_autoconf_addr

aliases: unique-autoconf-addr

string

Уникальный адрес автоконфигурации.

Возможные значения:

  • "disable"
  • "enable"

vrip6_link_local

string

Локальный адрес канала VRIP6.

vrrp6

list / elements=dictionary

Параметры VRRP для IPv6.

accept_mode

aliases: accept-mode

string

Режим принятия.

Возможные значения:

  • "disable"
  • "enable"

adv_interval

aliases: adv-interval

integer

Интервал отправки объявлений.

preempt

string

Перехват приоритета.

Возможные значения:

  • "disable"
  • "enable"

priority

integer

Приоритет.

start_time

aliases: start-time

integer

Время запуска.

status

string

Состояние.

Возможные значения:

  • "disable"
  • "enable"

vrdst6

string

Адрес назначения VRRP для IPv6.

vrgrp

integer

Группа виртуального маршрутизатора.

vrid

integer

Идентификатор виртуального маршрутизатора.

vrip6

string

Виртуальный адрес IPv6.

vrrp_virtual_mac6

aliases: vrrp-virtual-mac6

string

Виртуальный MAC-адрес VRRP для IPv6.

Возможные значения:

  • "disable"
  • "enable"

secondary_IP

aliases: secondary-IP

string

Вторичный IP-адрес.

Возможные значения:

  • "disable"
  • "enable"

secondaryip

list / elements=dictionary

Вторичные IP-адреса.

allowaccess

list / elements=string

Разрешённый доступ.

Возможные значения:

  • "https"
  • "ping"
  • "ssh"
  • "snmp"
  • "http"
  • "telnet"
  • "fgfm"
  • "auto-ipsec"
  • "radius-acct"
  • "probe-response"
  • "capwap"
  • "dnp"
  • "ftm"
  • "fabric"
  • "speed-test"

detectprotocol

list / elements=string

Протокол обнаружения.

Возможные значения:

  • "ping"
  • "tcp-echo"
  • "udp-echo"

detectserver

string

Сервер обнаружения.

gwdetect

string

Обнаружение шлюза.

Возможные значения:

  • "disable"
  • "enable"

ha_priority

aliases: ha-priority

integer

Приоритет высокой доступности.

id

integer

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

ip

string

IP-адрес.

ping_serv_status

aliases: ping-serv-status

integer

Состояние службы ping.

secip_relay_ip

aliases: secip-relay-ip

string

IP-адрес ретранслятора DHCP.

seq

integer

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

vlanid

integer

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

vrrp

list / elements=dictionary

Параметры VRRP.

accept_mode

aliases: accept-mode

string

Включить/выключить режим принятия.

Варианты:

  • "disable"
  • "enable"

adv_interval

aliases: adv-interval

integer

Интервал отправки объявлений

ignore_default_route

aliases: ignore-default-route

string

Включить/выключить игнорирование маршрута по умолчанию при проверке назначения.

Варианты:

  • "disable"
  • "enable"

preempt

string

Включить/выключить режим вытеснения.

Варианты:

  • "disable"
  • "enable"

priority

integer

Приоритет виртуального маршрутизатора

proxy_arp

aliases: proxy-arp

list / elements=dictionary

ARP-прокси.

id

integer

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

ip

string

Задать IP-адреса для ARP-прокси.

start_time

aliases: start-time

integer

Время запуска

status

string

Включить/выключить эту конфигурацию VRRP.

Варианты:

  • "disable"
  • "enable"

version

string

Версия VRRP.

Варианты:

  • "2"
  • "3"

vrdst

any

(список) Отслеживать маршрут к этому назначению.

vrdst_priority

aliases: vrdst-priority

integer

Приоритет виртуального маршрутизатора при недоступности назначения виртуального маршрутизатора

vrgrp

integer

Идентификатор группы VRRP

vrid

integer

Идентификатор виртуального маршрутизатора

vrip

string

IP-адрес виртуального маршрутизатора.

proposed_method

string

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

Варианты:

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

rc_failed

list / elements=integer

Список кодов rc, с помощью которого переопределяются условия неудачного выполнения.

rc_succeeded

list / elements=integer

Список кодов rc, с помощью которого переопределяются условия успешного выполнения.

revision_note

string

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

vlan

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

Параметр (vlan) в запрошенном URL.

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.

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: Fsp vlan dynamic mapping interface
      fortinet.fortimanager.fmgr_fsp_vlan_dynamicmapping_interface:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        vlan: <your own value>
        dynamic_mapping: <your own value>
        fsp_vlan_dynamicmapping_interface:
          # ip: <string>
          # vlanid: <integer>
          # dhcp_relay_agent_option: <value in [disable, enable]>
          # dhcp_relay_ip: <list or string>
          # dhcp_relay_service: <value in [disable, enable]>
          # dhcp_relay_type: <value in [regular, ipsec]>
          # ipv6:
          #   autoconf: <value in [disable, enable]>
          #   dhcp6_client_options: ["rapid", "iapd", "iana", "dns", "dnsname"]
          #   dhcp6_information_request: <value in [disable, enable]>
          #   dhcp6_prefix_delegation: <value in [disable, enable]>
          #   dhcp6_prefix_hint: <string>
          #   dhcp6_prefix_hint_plt: <integer>
          #   dhcp6_prefix_hint_vlt: <integer>
          #   dhcp6_relay_ip: <string>
          #   dhcp6_relay_service: <value in [disable, enable]>
          #   dhcp6_relay_type: <value in [regular]>
          #   ip6_address: <string>
          #   ip6_allowaccess: ["https", "ping", "ssh", "snmp", "http", "telnet", "fgfm",
          #                     "capwap", "fabric"]
          #   ip6_default_life: <integer>
          #   ip6_delegated_prefix_list:
          #     - autonomous_flag: <value in [disable, enable]>
          #       onlink_flag: <value in [disable, enable]>
          #       prefix_id: <integer>
          #       rdnss: <list or string>
          #       rdnss_service: <value in [delegated, default, specify]>
          #       subnet: <string>
          #       upstream_interface: <string>
          #       delegated_prefix_iaid: <integer>
          #   ip6_dns_server_override: <value in [disable, enable]>
          #   ip6_extra_addr:
          #     - prefix: <string>
          #   ip6_hop_limit: <integer>
          #   ip6_link_mtu: <integer>
          #   ip6_manage_flag: <value in [disable, enable]>
          #   ip6_max_interval: <integer>
          #   ip6_min_interval: <integer>
          #   ip6_mode: <value in [static, dhcp, pppoe, ...]>
          #   ip6_other_flag: <value in [disable, enable]>
          #   ip6_prefix_list:
          #     - autonomous_flag: <value in [disable, enable]>
          #       dnssl: <list or string>
          #       onlink_flag: <value in [disable, enable]>
          #       preferred_life_time: <integer>
          #       prefix: <string>
          #       rdnss: <list or string>
          #       valid_life_time: <integer>
          #   ip6_reachable_time: <integer>
          #   ip6_retrans_time: <integer>
          #   ip6_send_adv: <value in [disable, enable]>
          #   ip6_subnet: <string>
          #   ip6_upstream_interface: <string>
          #   nd_cert: <string>
          #   nd_cga_modifier: <string>
          #   nd_mode: <value in [basic, SEND-compatible]>
          #   nd_security_level: <integer>
          #   nd_timestamp_delta: <integer>
          #   nd_timestamp_fuzz: <integer>
          #   vrip6_link_local: <string>
          #   vrrp_virtual_mac6: <value in [disable, enable]>
          #   vrrp6:
          #     - accept_mode: <value in [disable, enable]>
          #       adv_interval: <integer>
          #       preempt: <value in [disable, enable]>
          #       priority: <integer>
          #       start_time: <integer>
          #       status: <value in [disable, enable]>
          #       vrdst6: <string>
          #       vrgrp: <integer>
          #       vrid: <integer>
          #       vrip6: <string>
          #   interface_identifier: <string>
          #   unique_autoconf_addr: <value in [disable, enable]>
          #   icmp6_send_redirect: <value in [disable, enable]>
          #   cli_conn6_status: <integer>
          #   ip6_prefix_mode: <value in [dhcp6, ra]>
          #   ra_send_mtu: <value in [disable, enable]>
          #   ip6_delegated_prefix_iaid: <integer>
          #   dhcp6_relay_source_interface: <value in [disable, enable]>
          # secondary_IP: <value in [disable, enable]>
          # secondaryip:
          #   - allowaccess: ["https", "ping", "ssh", "snmp", "http", "telnet", "fgfm",
          #                   "auto-ipsec", "radius-acct", "probe-response", "capwap", "dnp",
          #                   "ftm", "fabric", "speed-test"]
          #     detectprotocol: ["ping", "tcp-echo", "udp-echo"]
          #     detectserver: <string>
          #     gwdetect: <value in [disable, enable]>
          #     ha_priority: <integer>
          #     id: <integer>
          #     ip: <string>
          #     ping_serv_status: <integer>
          #     seq: <integer>
          #     secip_relay_ip: <string>
          # dhcp_relay_interface_select_method: <value in [auto, sdwan, specify]>
          # vrrp:
          #   - accept_mode: <value in [disable, enable]>
          #     adv_interval: <integer>
          #     ignore_default_route: <value in [disable, enable]>
          #     preempt: <value in [disable, enable]>
          #     priority: <integer>
          #     proxy_arp:
          #       - id: <integer>
          #         ip: <string>
          #     start_time: <integer>
          #     status: <value in [disable, enable]>
          #     version: <value in [2, 3]>
          #     vrdst: <list or string>
          #     vrdst_priority: <integer>
          #     vrgrp: <integer>
          #     vrid: <integer>
          #     vrip: <string>

Возвращаемые значения

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

Ключ

Описание

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_fsp_vlan_dynamicmapping_interface_module.html

Spec-Zone.ru

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