fortinet.fortimanager.fmgr_fsp_vlan_dynamicmapping module – no description

Note

This module is part of the fortinet.fortimanager collection (version 2.4.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.

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

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

dictionary

The top level parameters set.

_dhcp-status

string

Deprecated, please rename it to _dhcp_status.

Choices:

  • "disable"

  • "enable"

_scope

list / elements=dictionary

No description.

name

string

No description.

vdom

string

No description.

dhcp-server

dictionary

Deprecated, please rename it to dhcp_server.

auto-configuration

string

Deprecated, please rename it to auto_configuration. Enable/disable auto configuration.

Choices:

  • "disable"

  • "enable"

auto-managed-status

string

Deprecated, please rename it to auto_managed_status. Enable/disable use of this DHCP server once this interface ha…

Choices:

  • "disable"

  • "enable"

conflicted-ip-timeout

integer

Deprecated, please rename it to conflicted_ip_timeout. Time in seconds to wait after a conflicted IP address is re…

ddns-auth

string

Deprecated, please rename it to ddns_auth. DDNS authentication mode.

Choices:

  • "disable"

  • "tsig"

ddns-key

any

(list or str) Deprecated, please rename it to ddns_key. DDNS update key

ddns-keyname

string

Deprecated, please rename it to ddns_keyname. DDNS update key name.

ddns-server-ip

string

Deprecated, please rename it to ddns_server_ip. DDNS server IP.

ddns-ttl

integer

Deprecated, please rename it to ddns_ttl. TTL.

ddns-update

string

Deprecated, please rename it to ddns_update. Enable/disable DDNS update for DHCP.

Choices:

  • "disable"

  • "enable"

ddns-update-override

string

Deprecated, please rename it to ddns_update_override. Enable/disable DDNS update override for DHCP.

Choices:

  • "disable"

  • "enable"

ddns-zone

string

Deprecated, please rename it to ddns_zone. Zone of your domain name

default-gateway

string

Deprecated, please rename it to default_gateway. Default gateway IP address assigned by the DHCP server.

dhcp-settings-from-fortiipam

string

Deprecated, please rename it to dhcp_settings_from_fortiipam. Enable/disable populating of DHCP server settings fr…

Choices:

  • "disable"

  • "enable"

dns-server1

string

Deprecated, please rename it to dns_server1. DNS server 1.

dns-server2

string

Deprecated, please rename it to dns_server2. DNS server 2.

dns-server3

string

Deprecated, please rename it to dns_server3. DNS server 3.

dns-server4

string

Deprecated, please rename it to dns_server4. DNS server 4.

dns-service

string

Deprecated, please rename it to dns_service. Options for assigning DNS servers to DHCP clients.

Choices:

  • "default"

  • "specify"

  • "local"

domain

string

Domain name suffix for the IP addresses that the DHCP server assigns to clients.

enable

string

No description.

Choices:

  • "disable"

  • "enable"

exclude-range

list / elements=dictionary

Deprecated, please rename it to exclude_range.

end-ip

string

Deprecated, please rename it to end_ip. End of IP range.

id

integer

ID.

lease-time

integer

Deprecated, please rename it to lease_time. Lease time in seconds, 0 means default lease time.

start-ip

string

Deprecated, please rename it to start_ip. Start of IP range.

uci-match

string

Deprecated, please rename it to uci_match. Enable/disable user class identifier

Choices:

  • "disable"

  • "enable"

uci-string

any

(list) Deprecated, please rename it to uci_string.

vci-match

string

Deprecated, please rename it to vci_match. Enable/disable vendor class identifier

Choices:

  • "disable"

  • "enable"

vci-string

any

(list) Deprecated, please rename it to vci_string.

filename

string

Name of the boot file on the TFTP server.

forticlient-on-net-status

string

Deprecated, please rename it to forticlient_on_net_status. Enable/disable FortiClient-On-Net service for this DHCP…

Choices:

  • "disable"

  • "enable"

id

integer

ID.

ip-mode

string

Deprecated, please rename it to ip_mode. Method used to assign client IP.

Choices:

  • "range"

  • "usrgrp"

ip-range

list / elements=dictionary

Deprecated, please rename it to ip_range.

end-ip

string

Deprecated, please rename it to end_ip. End of IP range.

id

integer

ID.

lease-time

integer

Deprecated, please rename it to lease_time. Lease time in seconds, 0 means default lease time.

start-ip

string

Deprecated, please rename it to start_ip. Start of IP range.

uci-match

string

Deprecated, please rename it to uci_match. Enable/disable user class identifier

Choices:

  • "disable"

  • "enable"

uci-string

any

(list) Deprecated, please rename it to uci_string.

vci-match

string

Deprecated, please rename it to vci_match. Enable/disable vendor class identifier

Choices:

  • "disable"

  • "enable"

vci-string

any

(list) Deprecated, please rename it to vci_string.

ipsec-lease-hold

integer

Deprecated, please rename it to ipsec_lease_hold. DHCP over IPsec leases expire this many seconds after tunnel down

lease-time

integer

Deprecated, please rename it to lease_time. Lease time in seconds, 0 means unlimited.

mac-acl-default-action

string

Deprecated, please rename it to mac_acl_default_action. MAC access control default action

Choices:

  • "assign"

  • "block"

netmask

string

Netmask assigned by the DHCP server.

next-server

string

Deprecated, please rename it to next_server. IP address of a server

ntp-server1

string

Deprecated, please rename it to ntp_server1. NTP server 1.

ntp-server2

string

Deprecated, please rename it to ntp_server2. NTP server 2.

ntp-server3

string

Deprecated, please rename it to ntp_server3. NTP server 3.

ntp-service

string

Deprecated, please rename it to ntp_service. Options for assigning Network Time Protocol

Choices:

  • "default"

  • "specify"

  • "local"

option1

any

(list) No description.

option2

any

(list) No description.

option3

any

(list) No description.

option4

string

No description.

option5

string

No description.

option6

string

No description.

options

list / elements=dictionary

No description.

code

integer

DHCP option code.

id

integer

ID.

ip

any

(list) No description.

type

string

DHCP option type.

Choices:

  • "hex"

  • "string"

  • "ip"

  • "fqdn"

uci-match

string

Deprecated, please rename it to uci_match. Enable/disable user class identifier

Choices:

  • "disable"

  • "enable"

uci-string

any

(list) Deprecated, please rename it to uci_string.

value

string

DHCP option value.

vci-match

string

Deprecated, please rename it to vci_match. Enable/disable vendor class identifier

Choices:

  • "disable"

  • "enable"

vci-string

any

(list) Deprecated, please rename it to vci_string.

relay-agent

string

Deprecated, please rename it to relay_agent. Relay agent IP.

reserved-address

list / elements=dictionary

Deprecated, please rename it to reserved_address.

action

string

Options for the DHCP server to configure the client with the reserved MAC address.

Choices:

  • "assign"

  • "block"

  • "reserved"

circuit-id

string

Deprecated, please rename it to circuit_id. Option 82 circuit-ID of the client that will get the reserved …

circuit-id-type

string

Deprecated, please rename it to circuit_id_type. DHCP option type.

Choices:

  • "hex"

  • "string"

description

string

Description.

id

integer

ID.

ip

string

IP address to be reserved for the MAC address.

mac

string

MAC address of the client that will get the reserved IP address.

remote-id

string

Deprecated, please rename it to remote_id. Option 82 remote-ID of the client that will get the reserved IP…

remote-id-type

string

Deprecated, please rename it to remote_id_type. DHCP option type.

Choices:

  • "hex"

  • "string"

type

string

DHCP reserved-address type.

Choices:

  • "mac"

  • "option82"

server-type

string

Deprecated, please rename it to server_type. DHCP server can be a normal DHCP server or an IPsec DHCP server.

Choices:

  • "regular"

  • "ipsec"

shared-subnet

string

Deprecated, please rename it to shared_subnet. Enable/disable shared subnet.

Choices:

  • "disable"

  • "enable"

status

string

Enable/disable this DHCP configuration.

Choices:

  • "disable"

  • "enable"

tftp-server

any

(list) Deprecated, please rename it to tftp_server.

timezone

string

Select the time zone to be assigned to DHCP clients.

Choices:

  • "00"

  • "01"

  • "02"

  • "03"

  • "04"

  • "05"

  • "06"

  • "07"

  • "08"

  • "09"

  • "10"

  • "11"

  • "12"

  • "13"

  • "14"

  • "15"

  • "16"

  • "17"

  • "18"

  • "19"

  • "20"

  • "21"

  • "22"

  • "23"

  • "24"

  • "25"

  • "26"

  • "27"

  • "28"

  • "29"

  • "30"

  • "31"

  • "32"

  • "33"

  • "34"

  • "35"

  • "36"

  • "37"

  • "38"

  • "39"

  • "40"

  • "41"

  • "42"

  • "43"

  • "44"

  • "45"

  • "46"

  • "47"

  • "48"

  • "49"

  • "50"

  • "51"

  • "52"

  • "53"

  • "54"

  • "55"

  • "56"

  • "57"

  • "58"

  • "59"

  • "60"

  • "61"

  • "62"

  • "63"

  • "64"

  • "65"

  • "66"

  • "67"

  • "68"

  • "69"

  • "70"

  • "71"

  • "72"

  • "73"

  • "74"

  • "75"

  • "76"

  • "77"

  • "78"

  • "79"

  • "80"

  • "81"

  • "82"

  • "83"

  • "84"

  • "85"

  • "86"

  • "87"

timezone-option

string

Deprecated, please rename it to timezone_option. Options for the DHCP server to set the clients time zone.

Choices:

  • "disable"

  • "default"

  • "specify"

vci-match

string

Deprecated, please rename it to vci_match. Enable/disable vendor class identifier

Choices:

  • "disable"

  • "enable"

vci-string

any

(list) Deprecated, please rename it to vci_string.

wifi-ac-service

string

Deprecated, please rename it to wifi_ac_service. Options for assigning WiFi Access Controllers to DHCP clients

Choices:

  • "specify"

  • "local"

wifi-ac1

string

Deprecated, please rename it to wifi_ac1. WiFi Access Controller 1 IP address

wifi-ac2

string

Deprecated, please rename it to wifi_ac2. WiFi Access Controller 2 IP address

wifi-ac3

string

Deprecated, please rename it to wifi_ac3. WiFi Access Controller 3 IP address

wins-server1

string

Deprecated, please rename it to wins_server1. WINS server 1.

wins-server2

string

Deprecated, please rename it to wins_server2. WINS server 2.

interface

dictionary

No description.

dhcp-relay-agent-option

string

Deprecated, please rename it to dhcp_relay_agent_option.

Choices:

  • "disable"

  • "enable"

dhcp-relay-interface-select-method

string

Deprecated, please rename it to dhcp_relay_interface_select_method.

Choices:

  • "auto"

  • "sdwan"

  • "specify"

dhcp-relay-ip

any

(list) Deprecated, please rename it to dhcp_relay_ip.

dhcp-relay-service

string

Deprecated, please rename it to dhcp_relay_service.

Choices:

  • "disable"

  • "enable"

dhcp-relay-type

string

Deprecated, please rename it to dhcp_relay_type.

Choices:

  • "regular"

  • "ipsec"

ip

string

No description.

ipv6

dictionary

No description.

autoconf

string

Enable/disable address auto config.

Choices:

  • "disable"

  • "enable"

cli-conn6-status

integer

Deprecated, please rename it to cli_conn6_status.

dhcp6-client-options

list / elements=string

Deprecated, please rename it to dhcp6_client_options.

Choices:

  • "rapid"

  • "iapd"

  • "iana"

  • "dns"

  • "dnsname"

dhcp6-information-request

string

Deprecated, please rename it to dhcp6_information_request. Enable/disable DHCPv6 information request.

Choices:

  • "disable"

  • "enable"

dhcp6-prefix-delegation

string

Deprecated, please rename it to dhcp6_prefix_delegation. Enable/disable DHCPv6 prefix delegation.

Choices:

  • "disable"

  • "enable"

dhcp6-prefix-hint

string

Deprecated, please rename it to dhcp6_prefix_hint. DHCPv6 prefix that will be used as a hint to the upstre…

dhcp6-prefix-hint-plt

integer

Deprecated, please rename it to dhcp6_prefix_hint_plt. DHCPv6 prefix hint preferred life time

dhcp6-prefix-hint-vlt

integer

Deprecated, please rename it to dhcp6_prefix_hint_vlt. DHCPv6 prefix hint valid life time

dhcp6-relay-interface-id

string

Deprecated, please rename it to dhcp6_relay_interface_id. DHCP6 relay interface ID.

dhcp6-relay-ip

string

Deprecated, please rename it to dhcp6_relay_ip. DHCPv6 relay IP address.

dhcp6-relay-service

string

Deprecated, please rename it to dhcp6_relay_service. Enable/disable DHCPv6 relay.

Choices:

  • "disable"

  • "enable"

dhcp6-relay-source-interface

string

Deprecated, please rename it to dhcp6_relay_source_interface. Enable/disable use of address on this interf…

Choices:

  • "disable"

  • "enable"

dhcp6-relay-source-ip

string

Deprecated, please rename it to dhcp6_relay_source_ip. IPv6 address used by the DHCP6 relay as its source IP.

dhcp6-relay-type

string

Deprecated, please rename it to dhcp6_relay_type. DHCPv6 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. IPv6 interface identifier.

ip6-address

string

Deprecated, please rename it to ip6_address. Primary IPv6 address prefix, syntax

ip6-allowaccess

list / elements=string

Deprecated, please rename it to ip6_allowaccess.

Choices:

  • "https"

  • "ping"

  • "ssh"

  • "snmp"

  • "http"

  • "telnet"

  • "fgfm"

  • "capwap"

  • "fabric"

ip6-default-life

integer

Deprecated, please rename it to ip6_default_life. Default life

ip6-delegated-prefix-iaid

integer

Deprecated, please rename it to ip6_delegated_prefix_iaid. IAID of obtained delegated-prefix from the upst…

ip6-delegated-prefix-list

list / elements=dictionary

Deprecated, please rename it to ip6_delegated_prefix_list.

autonomous-flag

string

Deprecated, please rename it to autonomous_flag. Enable/disable the autonomous flag.

Choices:

  • "disable"

  • "enable"

delegated-prefix-iaid

integer

Deprecated, please rename it to delegated_prefix_iaid. IAID of obtained delegated-prefix from the …

string

Deprecated, please rename it to onlink_flag. Enable/disable the onlink flag.

Choices:

  • "disable"

  • "enable"

prefix-id

integer

Deprecated, please rename it to prefix_id. Prefix ID.

rdnss

any

(list) No description.

rdnss-service

string

Deprecated, please rename it to rdnss_service. Recursive DNS service option.

Choices:

  • "delegated"

  • "default"

  • "specify"

subnet

string

Add subnet ID to routing prefix.

upstream-interface

string

Deprecated, please rename it to upstream_interface. Name of the interface that provides delegated …

ip6-dns-server-override

string

Deprecated, please rename it to ip6_dns_server_override. Enable/disable using the DNS server acquired by DHCP.

Choices:

  • "disable"

  • "enable"

ip6-extra-addr

list / elements=dictionary

Deprecated, please rename it to ip6_extra_addr.

prefix

string

IPv6 address prefix.

ip6-hop-limit

integer

Deprecated, please rename it to ip6_hop_limit. Hop limit

integer

Deprecated, please rename it to ip6_link_mtu. IPv6 link MTU.

ip6-manage-flag

string

Deprecated, please rename it to ip6_manage_flag. Enable/disable the managed flag.

Choices:

  • "disable"

  • "enable"

ip6-max-interval

integer

Deprecated, please rename it to ip6_max_interval. IPv6 maximum interval

ip6-min-interval

integer

Deprecated, please rename it to ip6_min_interval. IPv6 minimum interval

ip6-mode

string

Deprecated, please rename it to ip6_mode. Addressing mode

Choices:

  • "static"

  • "dhcp"

  • "pppoe"

  • "delegated"

ip6-other-flag

string

Deprecated, please rename it to ip6_other_flag. Enable/disable the other IPv6 flag.

Choices:

  • "disable"

  • "enable"

ip6-prefix-list

list / elements=dictionary

Deprecated, please rename it to ip6_prefix_list.

autonomous-flag

string

Deprecated, please rename it to autonomous_flag. Enable/disable the autonomous flag.

Choices:

  • "disable"

  • "enable"

dnssl

any

(list) No description.

string

Deprecated, please rename it to onlink_flag. Enable/disable the onlink flag.

Choices:

  • "disable"

  • "enable"

preferred-life-time

integer

Deprecated, please rename it to preferred_life_time. Preferred life time

prefix

string

IPv6 prefix.

rdnss

any

(list) No description.

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. IPv6 reachable time

ip6-retrans-time

integer

Deprecated, please rename it to ip6_retrans_time. IPv6 retransmit time

ip6-send-adv

string

Deprecated, please rename it to ip6_send_adv. Enable/disable sending advertisements about the interface.

Choices:

  • "disable"

  • "enable"

ip6-subnet

string

Deprecated, please rename it to ip6_subnet. Subnet to routing prefix, syntax

ip6-upstream-interface

string

Deprecated, please rename it to ip6_upstream_interface. Interface name providing delegated information.

nd-cert

string

Deprecated, please rename it to nd_cert. Neighbor discovery certificate.

nd-cga-modifier

string

Deprecated, please rename it to nd_cga_modifier. Neighbor discovery CGA modifier.

nd-mode

string

Deprecated, please rename it to nd_mode. Neighbor discovery mode.

Choices:

  • "basic"

  • "SEND-compatible"

nd-security-level

integer

Deprecated, please rename it to nd_security_level. Neighbor discovery security level

nd-timestamp-delta

integer

Deprecated, please rename it to nd_timestamp_delta. Neighbor discovery timestamp delta value

nd-timestamp-fuzz

integer

Deprecated, please rename it to nd_timestamp_fuzz. Neighbor discovery timestamp fuzz factor

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. Enable/disable unique auto config address.

Choices:

  • "disable"

  • "enable"

string

Link-local IPv6 address of virtual router.

vrrp-virtual-mac6

string

Deprecated, please rename it to vrrp_virtual_mac6. Enable/disable virtual MAC for VRRP.

Choices:

  • "disable"

  • "enable"

vrrp6

list / elements=dictionary

No description.

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

Choices:

  • "disable"

  • "enable"

preempt

string

Enable/disable preempt mode.

Choices:

  • "disable"

  • "enable"

priority

integer

Priority of the virtual router

start-time

integer

Deprecated, please rename it to start_time. Startup time

status

string

Enable/disable VRRP.

Choices:

  • "disable"

  • "enable"

vrdst6

string

Monitor the route to this destination.

vrgrp

integer

VRRP group ID

vrid

integer

Virtual router identifier

vrip6

string

IPv6 address of the virtual router.

secondary-IP

string

Deprecated, please rename it to secondary_IP.

Choices:

  • "disable"

  • "enable"

secondaryip

list / elements=dictionary

No description.

allowaccess

list / elements=string

No description.

Choices:

  • "https"

  • "ping"

  • "ssh"

  • "snmp"

  • "http"

  • "telnet"

  • "fgfm"

  • "auto-ipsec"

  • "radius-acct"

  • "probe-response"

  • "capwap"

  • "dnp"

  • "ftm"

  • "fabric"

  • "speed-test"

detectprotocol

list / elements=string

No description.

Choices:

  • "ping"

  • "tcp-echo"

  • "udp-echo"

detectserver

string

Gateways ping server for this IP.

gwdetect

string

Enable/disable detect gateway alive for first.

Choices:

  • "disable"

  • "enable"

ha-priority

integer

Deprecated, please rename it to ha_priority. HA election priority for the PING server.

id

integer

ID.

ip

string

Secondary IP address of the interface.

ping-serv-status

integer

Deprecated, please rename it to ping_serv_status.

secip-relay-ip

string

Deprecated, please rename it to secip_relay_ip. DHCP relay IP address.

seq

integer

No description.

vlanid

integer

No description.

vrrp

list / elements=dictionary

No description.

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

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.

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) No description.

vrdst-priority

integer

Deprecated, please rename it to vrdst_priority. Priority of the virtual router when the virtual router des…

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.

state

string / required

The directive to create, update or delete an object.

Choices:

  • "present"

  • "absent"

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.

  • To create or update an object, use state present directive.

  • To delete an object, use state absent directive.

  • 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: No description
      fortinet.fortimanager.fmgr_fsp_vlan_dynamicmapping:
        # 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>
        state: present # <value in [present, absent]>
        fsp_vlan_dynamicmapping:
          _dhcp_status: <value in [disable, enable]>
          _scope:
            -
              name: <string>
              vdom: <string>
          dhcp_server:
            auto_configuration: <value in [disable, enable]>
            auto_managed_status: <value in [disable, enable]>
            conflicted_ip_timeout: <integer>
            ddns_auth: <value in [disable, tsig]>
            ddns_key: <list or string>
            ddns_keyname: <string>
            ddns_server_ip: <string>
            ddns_ttl: <integer>
            ddns_update: <value in [disable, enable]>
            ddns_update_override: <value in [disable, enable]>
            ddns_zone: <string>
            default_gateway: <string>
            dhcp_settings_from_fortiipam: <value in [disable, enable]>
            dns_server1: <string>
            dns_server2: <string>
            dns_server3: <string>
            dns_server4: <string>
            dns_service: <value in [default, specify, local]>
            domain: <string>
            enable: <value in [disable, enable]>
            exclude_range:
              -
                end_ip: <string>
                id: <integer>
                start_ip: <string>
                vci_match: <value in [disable, enable]>
                vci_string: <list or string>
                lease_time: <integer>
                uci_match: <value in [disable, enable]>
                uci_string: <list or string>
            filename: <string>
            forticlient_on_net_status: <value in [disable, enable]>
            id: <integer>
            ip_mode: <value in [range, usrgrp]>
            ip_range:
              -
                end_ip: <string>
                id: <integer>
                start_ip: <string>
                vci_match: <value in [disable, enable]>
                vci_string: <list or string>
                lease_time: <integer>
                uci_match: <value in [disable, enable]>
                uci_string: <list or string>
            ipsec_lease_hold: <integer>
            lease_time: <integer>
            mac_acl_default_action: <value in [assign, block]>
            netmask: <string>
            next_server: <string>
            ntp_server1: <string>
            ntp_server2: <string>
            ntp_server3: <string>
            ntp_service: <value in [default, specify, local]>
            option1: <list or string>
            option2: <list or string>
            option3: <list or string>
            option4: <string>
            option5: <string>
            option6: <string>
            options:
              -
                code: <integer>
                id: <integer>
                ip: <list or string>
                type: <value in [hex, string, ip, ...]>
                value: <string>
                vci_match: <value in [disable, enable]>
                vci_string: <list or string>
                uci_match: <value in [disable, enable]>
                uci_string: <list or string>
            reserved_address:
              -
                action: <value in [assign, block, reserved]>
                circuit_id: <string>
                circuit_id_type: <value in [hex, string]>
                description: <string>
                id: <integer>
                ip: <string>
                mac: <string>
                remote_id: <string>
                remote_id_type: <value in [hex, string]>
                type: <value in [mac, option82]>
            server_type: <value in [regular, ipsec]>
            status: <value in [disable, enable]>
            tftp_server: <list or string>
            timezone: <value in [00, 01, 02, ...]>
            timezone_option: <value in [disable, default, specify]>
            vci_match: <value in [disable, enable]>
            vci_string: <list or string>
            wifi_ac_service: <value in [specify, local]>
            wifi_ac1: <string>
            wifi_ac2: <string>
            wifi_ac3: <string>
            wins_server1: <string>
            wins_server2: <string>
            relay_agent: <string>
            shared_subnet: <value in [disable, enable]>
          interface:
            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]>
            ip: <string>
            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]>
              icmp6_send_redirect: <value in [disable, enable]>
              interface_identifier: <string>
              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>
              unique_autoconf_addr: <value in [disable, enable]>
              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>
                  ignore_default_route: <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]>
              dhcp6_relay_interface_id: <string>
              dhcp6_relay_source_ip: <string>
            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>
            vlanid: <integer>
            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)