fortinet.fortimanager.fmgr_fsp_vlan_dynamicmapping_interface module – Fsp vlan dynamic mapping interface

Note

This module is part of the fortinet.fortimanager collection (version 2.7.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install fortinet.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_fsp_vlan_dynamicmapping_interface.

New in fortinet.fortimanager 2.0.0

Synopsis

• This module is able to configure a FortiManager device.

• Examples include all parameters and values which need to be adjusted to data sources before usage.

Parameters

Parameter	Comments
access_token string	The token to access FortiManager without using username and password.
adom string / required	The parameter (adom) in requested url.
bypass_validation boolean	Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices: false ← (default) true
dynamic_mapping string / required	The parameter (dynamic_mapping) in requested url.
enable_log boolean	Enable/Disable logging for task. Choices: false ← (default) true
forticloud_access_token string	Authenticate Ansible client with forticloud API access token.
fsp_vlan_dynamicmapping_interface dictionary	The top level parameters set.
dhcp-relay-agent-option string	Deprecated, please rename it to dhcp_relay_agent_option. Dhcp relay agent option. Choices: "disable" "enable"
dhcp-relay-interface-select-method string	Deprecated, please rename it to dhcp_relay_interface_select_method. Dhcp relay interface select method. Choices: "auto" "sdwan" "specify"
dhcp-relay-ip any	(list) Deprecated, please rename it to dhcp_relay_ip. Dhcp relay ip.
dhcp-relay-service string	Deprecated, please rename it to dhcp_relay_service. Dhcp relay service. Choices: "disable" "enable"
dhcp-relay-type string	Deprecated, please rename it to dhcp_relay_type. Dhcp relay type. Choices: "regular" "ipsec"
ip string	Ip.
ipv6 dictionary	Ipv6.
autoconf string	Autoconf. Choices: "disable" "enable"
cli-conn6-status integer	Deprecated, please rename it to cli_conn6_status. Cli conn6 status.
dhcp6-client-options list / elements=string	Deprecated, please rename it to dhcp6_client_options. Dhcp6 client options. Choices: "rapid" "iapd" "iana" "dns" "dnsname"
dhcp6-information-request string	Deprecated, please rename it to dhcp6_information_request. Dhcp6 information request. Choices: "disable" "enable"
dhcp6-prefix-delegation string	Deprecated, please rename it to dhcp6_prefix_delegation. Dhcp6 prefix delegation. Choices: "disable" "enable"
dhcp6-prefix-hint string	Deprecated, please rename it to dhcp6_prefix_hint. Dhcp6 prefix hint.
dhcp6-prefix-hint-plt integer	Deprecated, please rename it to dhcp6_prefix_hint_plt. Dhcp6 prefix hint plt.
dhcp6-prefix-hint-vlt integer	Deprecated, please rename it to dhcp6_prefix_hint_vlt. Dhcp6 prefix hint vlt.
dhcp6-relay-ip string	Deprecated, please rename it to dhcp6_relay_ip. Dhcp6 relay ip.
dhcp6-relay-service string	Deprecated, please rename it to dhcp6_relay_service. Dhcp6 relay service. Choices: "disable" "enable"
dhcp6-relay-source-interface string	Deprecated, please rename it to dhcp6_relay_source_interface. Enable/disable use of address on this interface as t… Choices: "disable" "enable"
dhcp6-relay-type string	Deprecated, please rename it to dhcp6_relay_type. Dhcp6 relay type. Choices: "regular"
icmp6-send-redirect string	Deprecated, please rename it to icmp6_send_redirect. Enable/disable sending of ICMPv6 redirects. Choices: "disable" "enable"
interface-identifier string	Deprecated, please rename it to interface_identifier. Interface identifier.
ip6-address string	Deprecated, please rename it to ip6_address. Ip6 address.
ip6-allowaccess list / elements=string	Deprecated, please rename it to ip6_allowaccess. Ip6 allowaccess. Choices: "https" "ping" "ssh" "snmp" "http" "telnet" "fgfm" "capwap" "fabric"
ip6-default-life integer	Deprecated, please rename it to ip6_default_life. Ip6 default life.
ip6-delegated-prefix-iaid integer	Deprecated, please rename it to ip6_delegated_prefix_iaid. IAID of obtained delegated-prefix from the upstream int…
ip6-delegated-prefix-list list / elements=dictionary	Deprecated, please rename it to ip6_delegated_prefix_list. Ip6 delegated prefix list.
autonomous-flag string	Deprecated, please rename it to autonomous_flag. Autonomous flag. Choices: "disable" "enable"
delegated-prefix-iaid integer	Deprecated, please rename it to delegated_prefix_iaid. IAID of obtained delegated-prefix from the upstream…
onlink-flag string	Deprecated, please rename it to onlink_flag. Onlink flag. Choices: "disable" "enable"
prefix-id integer	Deprecated, please rename it to prefix_id. Prefix id.
rdnss any	(list) Rdnss.
rdnss-service string	Deprecated, please rename it to rdnss_service. Rdnss service. Choices: "delegated" "default" "specify"
subnet string	Subnet.
upstream-interface string	Deprecated, please rename it to upstream_interface. Upstream interface.
ip6-dns-server-override string	Deprecated, please rename it to ip6_dns_server_override. Ip6 dns server override. Choices: "disable" "enable"
ip6-extra-addr list / elements=dictionary	Deprecated, please rename it to ip6_extra_addr. Ip6 extra addr.
prefix string	Prefix.
ip6-hop-limit integer	Deprecated, please rename it to ip6_hop_limit. Ip6 hop limit.
ip6-link-mtu integer	Deprecated, please rename it to ip6_link_mtu. Ip6 link mtu.
ip6-manage-flag string	Deprecated, please rename it to ip6_manage_flag. Ip6 manage flag. Choices: "disable" "enable"
ip6-max-interval integer	Deprecated, please rename it to ip6_max_interval. Ip6 max interval.
ip6-min-interval integer	Deprecated, please rename it to ip6_min_interval. Ip6 min interval.
ip6-mode string	Deprecated, please rename it to ip6_mode. Ip6 mode. Choices: "static" "dhcp" "pppoe" "delegated"
ip6-other-flag string	Deprecated, please rename it to ip6_other_flag. Ip6 other flag. Choices: "disable" "enable"
ip6-prefix-list list / elements=dictionary	Deprecated, please rename it to ip6_prefix_list. Ip6 prefix list.
autonomous-flag string	Deprecated, please rename it to autonomous_flag. Autonomous flag. Choices: "disable" "enable"
dnssl any	(list) Dnssl.
onlink-flag string	Deprecated, please rename it to onlink_flag. Onlink flag. Choices: "disable" "enable"
preferred-life-time integer	Deprecated, please rename it to preferred_life_time. Preferred life time.
prefix string	Prefix.
rdnss any	(list) Rdnss.
valid-life-time integer	Deprecated, please rename it to valid_life_time. Valid life time.
ip6-prefix-mode string	Deprecated, please rename it to ip6_prefix_mode. Assigning a prefix from DHCP or RA. Choices: "dhcp6" "ra"
ip6-reachable-time integer	Deprecated, please rename it to ip6_reachable_time. Ip6 reachable time.
ip6-retrans-time integer	Deprecated, please rename it to ip6_retrans_time. Ip6 retrans time.
ip6-send-adv string	Deprecated, please rename it to ip6_send_adv. Ip6 send adv. Choices: "disable" "enable"
ip6-subnet string	Deprecated, please rename it to ip6_subnet. Ip6 subnet.
ip6-upstream-interface string	Deprecated, please rename it to ip6_upstream_interface. Ip6 upstream interface.
nd-cert string	Deprecated, please rename it to nd_cert. Nd cert.
nd-cga-modifier string	Deprecated, please rename it to nd_cga_modifier. Nd cga modifier.
nd-mode string	Deprecated, please rename it to nd_mode. Nd mode. Choices: "basic" "SEND-compatible"
nd-security-level integer	Deprecated, please rename it to nd_security_level. Nd security level.
nd-timestamp-delta integer	Deprecated, please rename it to nd_timestamp_delta. Nd timestamp delta.
nd-timestamp-fuzz integer	Deprecated, please rename it to nd_timestamp_fuzz. Nd timestamp fuzz.
ra-send-mtu string	Deprecated, please rename it to ra_send_mtu. Enable/disable sending link MTU in RA packet. Choices: "disable" "enable"
unique-autoconf-addr string	Deprecated, please rename it to unique_autoconf_addr. Unique autoconf addr. Choices: "disable" "enable"
vrip6_link_local string	Vrip6 link local.
vrrp-virtual-mac6 string	Deprecated, please rename it to vrrp_virtual_mac6. Vrrp virtual mac6. Choices: "disable" "enable"
vrrp6 list / elements=dictionary	Vrrp6.
accept-mode string	Deprecated, please rename it to accept_mode. Accept mode. Choices: "disable" "enable"
adv-interval integer	Deprecated, please rename it to adv_interval. Adv interval.
preempt string	Preempt. Choices: "disable" "enable"
priority integer	Priority.
start-time integer	Deprecated, please rename it to start_time. Start time.
status string	Status. Choices: "disable" "enable"
vrdst6 string	Vrdst6.
vrgrp integer	Vrgrp.
vrid integer	Vrid.
vrip6 string	Vrip6.
secondary-IP string	Deprecated, please rename it to secondary_IP. Secondary IP. Choices: "disable" "enable"
secondaryip list / elements=dictionary	Secondaryip.
allowaccess list / elements=string	Allowaccess. Choices: "https" "ping" "ssh" "snmp" "http" "telnet" "fgfm" "auto-ipsec" "radius-acct" "probe-response" "capwap" "dnp" "ftm" "fabric" "speed-test"
detectprotocol list / elements=string	Detectprotocol. Choices: "ping" "tcp-echo" "udp-echo"
detectserver string	Detectserver.
gwdetect string	Gwdetect. Choices: "disable" "enable"
ha-priority integer	Deprecated, please rename it to ha_priority. Ha priority.
id integer	Id.
ip string	Ip.
ping-serv-status integer	Deprecated, please rename it to ping_serv_status. Ping serv status.
secip-relay-ip string	Deprecated, please rename it to secip_relay_ip. DHCP relay IP address.
seq integer	Seq.
vlanid integer	Vlanid.
vrrp list / elements=dictionary	Vrrp.
accept-mode string	Deprecated, please rename it to accept_mode. Enable/disable accept mode. Choices: "disable" "enable"
adv-interval integer	Deprecated, please rename it to adv_interval. Advertisement interval
ignore-default-route string	Deprecated, please rename it to ignore_default_route. Enable/disable ignoring of default route when checking desti… Choices: "disable" "enable"
preempt string	Enable/disable preempt mode. Choices: "disable" "enable"
priority integer	Priority of the virtual router
proxy-arp list / elements=dictionary	Deprecated, please rename it to proxy_arp. Proxy arp.
id integer	ID.
ip string	Set IP addresses of proxy ARP.
start-time integer	Deprecated, please rename it to start_time. Startup time
status string	Enable/disable this VRRP configuration. Choices: "disable" "enable"
version string	VRRP version. Choices: "2" "3"
vrdst any	(list) Monitor the route to this destination.
vrdst-priority integer	Deprecated, please rename it to vrdst_priority. Priority of the virtual router when the virtual router destination…
vrgrp integer	VRRP group ID
vrid integer	Virtual router identifier
vrip string	IP address of the virtual router.
proposed_method string	The overridden method for the underlying Json RPC request. Choices: "update" "set" "add"
rc_failed list / elements=integer	The rc codes list with which the conditions to fail will be overriden.
rc_succeeded list / elements=integer	The rc codes list with which the conditions to succeed will be overriden.
vlan string / required	The parameter (vlan) in requested url.
workspace_locking_adom string	The adom to lock for FortiManager running in workspace mode, the value can be global and others including root.
workspace_locking_timeout integer	The maximum time in seconds to wait for other user to release the workspace lock. Default: 300

Notes

Note

• Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.

• Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.

• Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded

Examples

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

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
meta dictionary	The result of the request. Returned: always
request_url string	The full url requested. Returned: always Sample: "/sys/login/user"
response_code integer	The status of api request. Returned: always Sample: 0
response_data list / elements=string	The api response. Returned: always
response_message string	The descriptive message of the api response. Returned: always Sample: "OK."
system_information dictionary	The information of the target system. Returned: always
rc integer	The status the request. Returned: always Sample: 0
version_check_warning list / elements=string	Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex

Authors

• Xinwei Du (@dux-fortinet)

• Xing Li (@lix-fortinet)

• Jie Xue (@JieX19)

• Link Zheng (@chillancezen)

• Frank Shen (@fshen01)

• Hongbin Lu (@fgtdev-hblu)

Collection links

• Issue Tracker
• Homepage
• Repository (Sources)