fortinet.fortimanager.fmgr_fsp_vlan_dynamicmapping_interface 模块 – Fsp vlan 动态映射接口

注意

此模块是 fortinet.fortimanager 集合(版本 2.8.2)的一部分。

如果您正在使用 ansible 包,则可能已经安装了此集合。 它不包含在 ansible-core 中。 要检查是否已安装,请运行 ansible-galaxy collection list

要安装它,请使用:ansible-galaxy collection install fortinet.fortimanager

要在 playbook 中使用它,请指定:fortinet.fortimanager.fmgr_fsp_vlan_dynamicmapping_interface

fortinet.fortimanager 2.0.0 中的新增功能

概要

  • 此模块能够配置 FortiManager 设备。

  • 示例包括所有参数和值,这些参数和值需要在使用前调整为数据源。

参数

参数

注释

access_token

字符串

用于在不使用用户名和密码的情况下访问 FortiManager 的令牌。

adom

字符串 / 必需

请求 URL 中的参数 (adom)。

bypass_validation

布尔值

仅当模块架构与 FortiManager API 结构不同时,才设置为 True,模块将继续执行而不验证参数。

选项

  • false ← (默认)

  • true

dynamic_mapping

字符串 / 必需

请求 URL 中的参数 (dynamic_mapping)。

enable_log

布尔值

启用/禁用任务的日志记录。

选项

  • false ← (默认)

  • true

forticloud_access_token

字符串

使用 forticloud API 访问令牌验证 Ansible 客户端。

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

任意

(列表)Dhcp 中继 ip。

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"

dhcp6_prefix_hint

别名:dhcp6-prefix-hint

字符串

Dhcp6 前缀提示。

dhcp6_prefix_hint_plt

别名:dhcp6-prefix-hint-plt

整数

Dhcp6 前缀提示 plt。

dhcp6_prefix_hint_vlt

别名:dhcp6-prefix-hint-vlt

整数

Dhcp6 前缀提示 vlt。

dhcp6_relay_ip

别名:dhcp6-relay-ip

字符串

Dhcp6 中继 ip。

dhcp6_relay_service

别名:dhcp6-relay-service

字符串

Dhcp6 中继服务。

选项

  • "disable"

  • "enable"

dhcp6_relay_source_interface

别名:dhcp6-relay-source-interface

字符串

启用/禁用使用此接口上的地址作为中继消息的源地址。

选项

  • "disable"

  • "enable"

dhcp6_relay_type

别名:dhcp6-relay-type

字符串

Dhcp6 中继类型。

选项

  • "regular"

icmp6_send_redirect

别名:icmp6-send-redirect

字符串

启用/禁用发送 ICMPv6 重定向。

选项

  • "disable"

  • "enable"

interface_identifier

别名:interface-identifier

字符串

接口标识符。

ip6_address

别名:ip6-address

字符串

Ip6 地址。

ip6_allowaccess

别名:ip6-allowaccess

列表 / 元素=字符串

Ip6 允许访问。

选项

  • "https"

  • "ping"

  • "ssh"

  • "snmp"

  • "http"

  • "telnet"

  • "fgfm"

  • "capwap"

  • "fabric"

ip6_default_life

别名:ip6-default-life

整数

Ip6 默认生命周期。

ip6_delegated_prefix_iaid

别名:ip6-delegated-prefix-iaid

整数

从上游接口获得的委派前缀的 IAID。

ip6_delegated_prefix_list

别名:ip6-delegated-prefix-list

列表 / 元素=字典

Ip6 委派前缀列表。

autonomous_flag

别名:autonomous-flag

字符串

自治标志。

选项

  • "disable"

  • "enable"

delegated_prefix_iaid

别名:delegated-prefix-iaid

整数

从上游接口获得的委派前缀的 IAID。

onlink_flag

别名: onlink-flag

字符串

Onlink 标志。

选项

  • "disable"

  • "enable"

prefix_id

别名: prefix-id

整数

前缀 ID。

rdnss

任意

(列表) Rdnss。

rdnss_service

别名: rdnss-service

字符串

Rdnss 服务。

选项

  • "delegated"

  • "default"

  • "specify"

subnet

字符串

子网。

upstream_interface

别名: upstream-interface

字符串

上游接口。

ip6_dns_server_override

别名: ip6-dns-server-override

字符串

Ip6 DNS 服务器覆盖。

选项

  • "disable"

  • "enable"

ip6_extra_addr

别名: ip6-extra-addr

列表 / 元素=字典

Ip6 额外地址。

prefix

字符串

前缀。

ip6_hop_limit

别名: ip6-hop-limit

整数

Ip6 跳数限制。

ip6_link_mtu

别名: ip6-link-mtu

整数

Ip6 链路 MTU。

ip6_manage_flag

别名: ip6-manage-flag

字符串

Ip6 管理标志。

选项

  • "disable"

  • "enable"

ip6_max_interval

别名: ip6-max-interval

整数

Ip6 最大间隔。

ip6_min_interval

别名: ip6-min-interval

整数

Ip6 最小间隔。

ip6_mode

别名: ip6-mode

字符串

Ip6 模式。

选项

  • "static"

  • "dhcp"

  • "pppoe"

  • "delegated"

ip6_other_flag

别名: ip6-other-flag

字符串

Ip6 其他标志。

选项

  • "disable"

  • "enable"

ip6_prefix_list

别名: ip6-prefix-list

列表 / 元素=字典

Ip6 前缀列表。

autonomous_flag

别名:autonomous-flag

字符串

自治标志。

选项

  • "disable"

  • "enable"

dnssl

任意

(列表) Dnssl。

onlink_flag

别名: onlink-flag

字符串

Onlink 标志。

选项

  • "disable"

  • "enable"

preferred_life_time

别名: preferred-life-time

整数

首选生存期。

prefix

字符串

前缀。

rdnss

任意

(列表) Rdnss。

valid_life_time

别名: valid-life-time

整数

有效生存期。

ip6_prefix_mode

别名: ip6-prefix-mode

字符串

从 DHCP 或 RA 分配前缀。

选项

  • "dhcp6"

  • "ra"

ip6_reachable_time

别名: ip6-reachable-time

整数

Ip6 可达时间。

ip6_retrans_time

别名: ip6-retrans-time

整数

Ip6 重传时间。

ip6_send_adv

别名: ip6-send-adv

字符串

Ip6 发送 Adv。

选项

  • "disable"

  • "enable"

ip6_subnet

别名: ip6-subnet

字符串

Ip6 子网。

ip6_upstream_interface

别名: ip6-upstream-interface

字符串

Ip6 上游接口。

nd_cert

别名: nd-cert

字符串

Nd 证书。

nd_cga_modifier

别名: nd-cga-modifier

字符串

Nd CGA 修饰符。

nd_mode

别名: nd-mode

字符串

Nd 模式。

选项

  • "basic"

  • "SEND-compatible"

nd_security_level

别名: nd-security-level

整数

Nd 安全级别。

nd_timestamp_delta

别名: nd-timestamp-delta

整数

Nd 时间戳增量。

nd_timestamp_fuzz

别名: nd-timestamp-fuzz

整数

Nd 时间戳模糊度。

ra_send_mtu

别名: ra-send-mtu

字符串

启用/禁用在 RA 数据包中发送链路 MTU。

选项

  • "disable"

  • "enable"

unique_autoconf_addr

别名: unique-autoconf-addr

字符串

唯一的自动配置地址。

选项

  • "disable"

  • "enable"

字符串

Vrip6 链路本地。

vrrp6

列表 / 元素=字典

Vrrp6。

accept_mode

别名: accept-mode

字符串

接受模式。

选项

  • "disable"

  • "enable"

adv_interval

别名: adv-interval

整数

Adv 间隔。

preempt

字符串

抢占。

选项

  • "disable"

  • "enable"

priority

整数

优先级。

start_time

别名: start-time

整数

启动时间。

status

字符串

状态。

选项

  • "disable"

  • "enable"

vrdst6

字符串

Vrdst6。

vrgrp

整数

Vrgrp。

vrid

整数

Vrid。

vrip6

字符串

Vrip6。

vrrp_virtual_mac6

别名: vrrp-virtual-mac6

字符串

Vrrp 虚拟 MAC6。

选项

  • "disable"

  • "enable"

secondary_IP

别名: secondary-IP

字符串

辅助 IP。

选项

  • "disable"

  • "enable"

secondaryip

列表 / 元素=字典

辅助IP。

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

字符串

检测服务器。

gwdetect

字符串

网关检测。

选项

  • "disable"

  • "enable"

ha_priority

别名: ha-priority

整数

HA 优先级。

id

整数

ID。

ip

字符串

Ip。

ping_serv_status

别名: ping-serv-status

整数

Ping 服务状态。

secip_relay_ip

别名: secip-relay-ip

字符串

DHCP 中继 IP 地址。

seq

整数

序列。

vlanid

整数

Vlanid。

vrrp

列表 / 元素=字典

Vrrp。

accept_mode

别名: accept-mode

字符串

启用/禁用接受模式。

选项

  • "disable"

  • "enable"

adv_interval

别名: adv-interval

整数

通告间隔

ignore_default_route

别名: ignore-default-route

字符串

启用/禁用在检查目标时忽略默认路由。

选项

  • "disable"

  • "enable"

preempt

字符串

启用/禁用抢占模式。

选项

  • "disable"

  • "enable"

priority

整数

虚拟路由器的优先级

proxy_arp

别名: proxy-arp

列表 / 元素=字典

代理 ARP。

id

整数

ID。

ip

字符串

设置代理 ARP 的 IP 地址。

start_time

别名: start-time

整数

启动时间

status

字符串

启用/禁用此 VRRP 配置。

选项

  • "disable"

  • "enable"

version

字符串

VRRP 版本。

选项

  • "2"

  • "3"

vrdst

任意

(列表) 监视到此目标的路由。

vrdst_priority

别名: vrdst-priority

整数

当虚拟路由器目标不可达时,虚拟路由器的优先级

vrgrp

整数

VRRP 组 ID

vrid

整数

虚拟路由器标识符

vrip

字符串

虚拟路由器的 IP 地址。

proposed_method

字符串

覆盖底层 Json RPC 请求的方法。

选项

  • "update"

  • "set"

  • "add"

rc_failed

list / elements=integer

将被覆盖为失败条件的 rc 代码列表。

rc_succeeded

list / elements=integer

将被覆盖为成功条件的 rc 代码列表。

vlan

字符串 / 必需

请求 URL 中的参数 (vlan)。

workspace_locking_adom

字符串

在工作区模式下运行的 FortiManager 要锁定的 ADOM,值可以是 global 和其他(包括 root)。

workspace_locking_timeout

整数

等待其他用户释放工作区锁定的最大时间(以秒为单位)。

默认值: 300

说明

注意

  • 从 2.4.0 版本开始,所有输入参数都使用下划线命名约定 (snake_case) 命名。请将诸如 “var-name” 之类的参数更改为 “var_name”。旧的参数名称仍然可用,但您会收到弃用警告。您可以通过在 ansible.cfg 中设置 deprecation_warnings=False 来忽略此警告。

  • 此 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

列表 / 元素=字符串

如果 playbook 中使用的参数不受当前 FortiManager 版本支持,则发出警告。

返回: 复杂

作者

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)