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

Примечание

Этот модуль является частью коллекции fortinet.fortimanager (версия 2.7.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 строка	Токен доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation логическое значение	Устанавливается в значение True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполняться без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
dynamic_mapping строка / обязательно	Параметр (dynamic_mapping) в запрошенном URL.
enable_log логическое значение	Включить/выключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Авторизовать Ansible-клиент с помощью токена доступа к forticloud API.
fsp_vlan_dynamicmapping_interface словарь	Настройка параметров верхнего уровня.
dhcp_relay_agent_option строка	Устаревшее, пожалуйста, переименуйте на dhcp_relay_agent_option. Параметр агента реле DHCP. Варианты: `"disable"` `"enable"`
dhcp_relay_interface_select_method строка	Устаревшее, пожалуйста, переименуйте на dhcp_relay_interface_select_method. Метод выбора интерфейса реле DHCP. Варианты: `"auto"` `"sdwan"` `"specify"`
dhcp_relay_ip любой тип	(список) Устаревшее, пожалуйста, переименуйте на dhcp_relay_ip. IP-адрес реле DHCP.
dhcp_relay_service строка	Устаревшее, пожалуйста, переименуйте на dhcp_relay_service. Служба реле DHCP. Варианты: `"disable"` `"enable"`
dhcp_relay_type строка	Устаревшее, пожалуйста, переименуйте на dhcp_relay_type. Тип реле DHCP. Варианты: `"regular"` `"ipsec"`
ip строка	IP-адрес.
ipv6 словарь	IPv6.
autoconf строка	Автоконфигурация. Варианты: `"disable"` `"enable"`
cli_conn6_status целое число	Устаревшее, пожалуйста, переименуйте на cli_conn6_status. Статус подключения CLI conn6.
dhcp6_client_options список / элементы=строка	Устаревшее, пожалуйста, переименуйте на dhcp6_client_options. Параметры клиента DHCP6. Варианты: `"rapid"` `"iapd"` `"iana"` `"dns"` `"dnsname"`
dhcp6_information_request строка	Устаревшее, пожалуйста, переименуйте на dhcp6_information_request. Запрос информации DHCP6. Варианты: `"disable"` `"enable"`
dhcp6_prefix_delegation строка	Устаревшее, пожалуйста, переименуйте на dhcp6_prefix_delegation. Делегирование префикса DHCP6. Варианты: `"disable"` `"enable"`

END_OF_DOCUMENT_MARKER

dhcp6-prefix-hint string	Устарело, переименуйте в dhcp6_prefix_hint. Подсказка префикса Dhcp6.
dhcp6-prefix-hint-plt integer	Устарело, переименуйте в dhcp6_prefix_hint_plt. Подсказка префикса Dhcp6 plt.
dhcp6-prefix-hint-vlt integer	Устарело, переименуйте в dhcp6_prefix_hint_vlt. Подсказка префикса Dhcp6 vlt.
dhcp6-relay-ip string	Устарело, переименуйте в dhcp6_relay_ip. IP-адрес ретранслятора Dhcp6.
dhcp6-relay-service string	Устарело, переименуйте в dhcp6_relay_service. Служба ретрансляции Dhcp6. Варианты: `"disable"` `"enable"`
dhcp6-relay-source-interface string	Устарело, переименуйте в dhcp6_relay_source_interface. Включить/выключить использование адреса на этом интерфейсе в качестве t… Варианты: `"disable"` `"enable"`
dhcp6-relay-type string	Устарело, переименуйте в dhcp6_relay_type. Тип ретранслятора Dhcp6. Варианты: `"regular"`
icmp6-send-redirect string	Устарело, переименуйте в icmp6_send_redirect. Включить/выключить отправку перенаправлений ICMPv6. Варианты: `"disable"` `"enable"`
interface-identifier string	Устарело, переименуйте в interface_identifier. Идентификатор интерфейса.
ip6-address string	Устарело, переименуйте в ip6_address. IP6 адрес.
ip6-allowaccess list / elements=string	Устарело, переименуйте в ip6_allowaccess. Разрешение доступа Ip6. Варианты: `"https"` `"ping"` `"ssh"` `"snmp"` `"http"` `"telnet"` `"fgfm"` `"capwap"` `"fabric"`
ip6-default-life integer	Устарело, переименуйте в ip6_default_life. Время жизни по умолчанию Ip6.
ip6-delegated-prefix-iaid integer	Устарело, переименуйте в ip6_delegated_prefix_iaid. IAID полученного делегированного префикса от вышестоящего int…
ip6-delegated-prefix-list list / elements=dictionary	Устарело, переименуйте в ip6_delegated_prefix_list. Список делегированных префиксов Ip6.
autonomous-flag string	Устарело, переименуйте в autonomous_flag. Автономный флаг. Варианты: `"disable"` `"enable"`
delegated-prefix-iaid integer	Устарело, переименуйте в delegated_prefix_iaid. IAID полученного делегированного префикса от вышестоящего…
onlink-flag string	Устарело, переименуйте в onlink_flag. Флаг onlink. Варианты: `"disable"` `"enable"`
prefix-id integer	Устарело, переименуйте в prefix_id. Идентификатор префикса.
rdnss any	(list) Rdnss.

rdnss-service string	Устарело, переименуйте в rdnss_service. Служба Rdnss. Choices: `"delegated"` `"default"` `"specify"`
subnet string	Подсеть.
upstream-interface string	Устарело, переименуйте в upstream_interface. Входящий интерфейс.
ip6-dns-server-override string	Устарело, переименуйте в ip6_dns_server_override. Переопределение DNS-сервера IPv6. Choices: `"disable"` `"enable"`
ip6-extra-addr list / elements=dictionary	Устарело, переименуйте в ip6_extra_addr. Дополнительный адрес IPv6.
prefix string	Префикс.
ip6-hop-limit integer	Устарело, переименуйте в ip6_hop_limit. Предел переходов IPv6.
ip6-link-mtu integer	Устарело, переименуйте в ip6_link_mtu. MTU канала IPv6.
ip6-manage-flag string	Устарело, переименуйте в ip6_manage_flag. Флаг управления IPv6. Choices: `"disable"` `"enable"`
ip6-max-interval integer	Устарело, переименуйте в ip6_max_interval. Максимальный интервал IPv6.
ip6-min-interval integer	Устарело, переименуйте в ip6_min_interval. Минимальный интервал IPv6.
ip6-mode string	Устарело, переименуйте в ip6_mode. Режим IPv6. Choices: `"static"` `"dhcp"` `"pppoe"` `"delegated"`
ip6-other-flag string	Устарело, переименуйте в ip6_other_flag. Другой флаг IPv6. Choices: `"disable"` `"enable"`
ip6-prefix-list list / elements=dictionary	Устарело, переименуйте в ip6_prefix_list. Список префиксов IPv6.
autonomous-flag string	Устарело, переименуйте в autonomous_flag. Автономный флаг. Choices: `"disable"` `"enable"`
dnssl any	(list) Dnssl.
onlink-flag string	Устарело, переименуйте в onlink_flag. Флаг onlink. Choices: `"disable"` `"enable"`
preferred-life-time integer	Устарело, переименуйте в preferred_life_time. Предпочтительное время жизни.
prefix string	Префикс.
rdnss any	(list) Rdnss.

valid-life-time integer	Устарело, переименуйте в valid_life_time. Время жизни.
ip6-prefix-mode string	Устарело, переименуйте в ip6_prefix_mode. Назначение префикса от DHCP или RA. Choices: `"dhcp6"` `"ra"`
ip6-reachable-time integer	Устарело, переименуйте в ip6_reachable_time. Время достижения ip6.
ip6-retrans-time integer	Устарело, переименуйте в ip6_retrans_time. Время повторной передачи ip6.
ip6-send-adv string	Устарело, переименуйте в ip6_send_adv. Отправка рекламы ip6. Choices: `"disable"` `"enable"`
ip6-subnet string	Устарело, переименуйте в ip6_subnet. Подсеть ip6.
ip6-upstream-interface string	Устарело, переименуйте в ip6_upstream_interface. Входящий интерфейс ip6.
nd-cert string	Устарело, переименуйте в nd_cert. Сертификат nd.
nd-cga-modifier string	Устарело, переименуйте в nd_cga_modifier. Модификатор nd cga.
nd-mode string	Устарело, переименуйте в nd_mode. Режим nd. Choices: `"basic"` `"SEND-compatible"`
nd-security-level integer	Устарело, переименуйте в nd_security_level. Уровень безопасности nd.
nd-timestamp-delta integer	Устарело, переименуйте в nd_timestamp_delta. Разница меток времени nd.
nd-timestamp-fuzz integer	Устарело, переименуйте в nd_timestamp_fuzz. Неопределенность метки времени nd.
ra-send-mtu string	Устарело, переименуйте в ra_send_mtu. Включение/выключение отправки MTU ссылки в пакете RA. Choices: `"disable"` `"enable"`
unique-autoconf-addr string	Устарело, переименуйте в unique_autoconf_addr. Уникальный автоконфигурируемый адрес. Choices: `"disable"` `"enable"`
vrip6_link_local string	Локальный vrip6.
vrrp-virtual-mac6 string	Устарело, переименуйте в vrrp_virtual_mac6. Виртуальный MAC-адрес vrrp6. Choices: `"disable"` `"enable"`
vrrp6 list / elements=dictionary	Vrrp6.
accept-mode string	Устарело, переименуйте в accept_mode. Режим принятия. Choices: `"disable"` `"enable"`
adv-interval integer	Устарело, переименуйте в adv_interval. Интервал рекламы.

preempt string	Прерывание. Варианты: `"disable"` `"enable"`
priority integer	Приоритет.
start-time integer	Устарело, переименуйте в start_time. Время начала.
status string	Статус. Варианты: `"disable"` `"enable"`
vrdst6 string	Vrdst6.
vrgrp integer	Vrgrp.
vrid integer	Vrid.
vrip6 string	Vrip6.
secondary-IP string	Устарело, переименуйте в secondary_IP. Вторичный IP. Варианты: `"disable"` `"enable"`
secondaryip list / elements=dictionary	Secondaryip.
allowaccess list / elements=string	Allowaccess. Варианты: `"https"` `"ping"` `"ssh"` `"snmp"` `"http"` `"telnet"` `"fgfm"` `"auto-ipsec"` `"radius-acct"` `"probe-response"` `"capwap"` `"dnp"` `"ftm"` `"fabric"` `"speed-test"`
detectprotocol list / elements=string	Detectprotocol. Варианты: `"ping"` `"tcp-echo"` `"udp-echo"`
detectserver string	Detectserver.
gwdetect string	Gwdetect. Варианты: `"disable"` `"enable"`
ha-priority integer	Устарело, переименуйте в ha_priority. Приоритет HA.
id integer	Id.
ip string	Ip.
ping-serv-status integer	Устарело, переименуйте в ping_serv_status. Статус ping-сервера.
secip-relay-ip string	Устарело, переименуйте в secip_relay_ip. IP-адрес ретранслятора DHCP.
seq integer	Seq.
vlanid integer	Vlanid.

vrrp list / elements=dictionary	VRRP.
accept-mode string	Устарело, переименуйте в accept_mode. Включить/выключить режим принятия. Choices: `"disable"` `"enable"`
adv-interval integer	Устарело, переименуйте в adv_interval. Интервал объявлений
ignore-default-route string	Устарело, переименуйте в ignore_default_route. Включить/выключить игнорирование маршрута по умолчанию при проверке desti… Choices: `"disable"` `"enable"`
preempt string	Включить/выключить режим прерывания. Choices: `"disable"` `"enable"`
priority integer	Приоритет виртуального маршрутизатора
proxy-arp list / elements=dictionary	Устарело, переименуйте в proxy_arp. Прокси ARP.
id integer	Идентификатор.
ip string	Установить IP-адреса прокси ARP.
start-time integer	Устарело, переименуйте в start_time. Время запуска
status string	Включить/выключить эту конфигурацию VRRP. Choices: `"disable"` `"enable"`
version string	Версия VRRP. Choices: `"2"` `"3"`
vrdst any	(list) Мониторинг маршрута к этому назначению.
vrdst-priority integer	Устарело, переименуйте в vrdst_priority. Приоритет виртуального маршрутизатора, когда назначение виртуального маршрутизатора…
vrgrp integer	Идентификатор группы VRRP
vrid integer	Идентификатор виртуального маршрутизатора
vrip string	IP-адрес виртуального маршрутизатора.
proposed_method string	Переопределенный метод для базового запроса Json RPC. Choices: `"update"` `"set"` `"add"`
rc_failed list / elements=integer	Список кодов rc, с помощью которых будут переопределены условия сбоя.
rc_succeeded list / elements=integer	Список кодов rc, с помощью которых будут переопределены условия успеха.
vlan string / required	Параметр (vlan) в запрошенном URL.

workspace_locking_adom string	ADOM для блокировки в режиме рабочего пространства FortiManager, значение может быть глобальным и другими, включая корневой.
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
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Fsp vlan dynamic mapping interface
      fortinet.fortimanager.fmgr_fsp_vlan_dynamicmapping_interface:
        # 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>
        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 словарь	Результат запроса. Возвращается: всегда
request_url строка	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code целое число	Статус API запроса. Возвращается: всегда Пример: `0`
response_data список / элементы=строка	Ответ API. Возвращается: всегда
response_message строка	Дескриптивное сообщение ответа API. Возвращается: всегда Пример: `"OK."`
system_information словарь	Информация о целевой системе. Возвращается: всегда
rc целое число	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning список / элементы=строка	Предупреждение, если параметры, используемые в плейбуке, не поддерживаются текущей версией 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_fsp_vlan_dynamicmapping_interface_module.html