fmgr_fsp_vlan_dynamicmapping – Fsp vlan dynamic mapping.

Added in version 2.0.0.

Warning

Starting in version 3.0.0, all input arguments will be named using the underscore naming convention (snake_case).

  • Argument name before 3.0.0: var-name, var name, var.name

  • New argument name starting in 3.0.0: var_name

FortiManager Ansible v2.4+ supports both previous argument name and new underscore name. You will receive deprecation warnings if you keep using the previous argument name. You can ignore the warning by setting deprecation_warnings=False in ansible.cfg.

Synopsis

  • This module is able to configure a FortiManager device.

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

  • Tested with FortiManager v7.x.

Requirements

The below requirements are needed on the host that executes this module.

  • ansible>=2.15.0

FortiManager Version Compatibility

Supported Version Ranges: v6.0.0 -> latest

Parameters

  • access_token -The token to access FortiManager without using username and password. type: str required: false
  • bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool required: false default: False
  • enable_log - Enable/Disable logging for task. type: bool required: false default: False
  • forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
  • proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
  • rc_succeeded - The rc codes list with which the conditions to succeed will be overriden. type: list required: false
  • rc_failed - The rc codes list with which the conditions to fail will be overriden. type: list required: false
  • state - The directive to create, update or delete an object type: str required: true choices: present, absent
  • workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode. type: str required: false choices: global, custom adom including root
  • workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock. type: integer required: false default: 300
  • adom - The parameter in requested url type: str required: true
  • vlan - The parameter in requested url type: str required: true
  • fsp_vlan_dynamicmapping - Fsp vlan dynamic mapping type: dict
    • _dhcp_status (Alias name: _dhcp-status) Dhcp status. type: str choices: [disable, enable] more...
    • _scope Scope. type: list more...
      • name Name. type: str more...
      • vdom Vdom. type: str more...
    • dhcp_server (Alias name: dhcp-server) Dhcp server. type: dict more...
      • auto_configuration (Alias name: auto-configuration) Enable/disable auto configuration. type: str choices: [disable, enable] more...
      • auto_managed_status (Alias name: auto-managed-status) Enable/disable use of this dhcp server once this interface has been assigned an ip address from fortiipam. type: str choices: [disable, enable] more...
      • conflicted_ip_timeout (Alias name: conflicted-ip-timeout) Time in seconds to wait after a conflicted ip address is removed from the dhcp range before it can be reused. type: int more...
      • ddns_auth (Alias name: ddns-auth) Ddns authentication mode. type: str choices: [disable, tsig] more...
      • ddns_key (Alias name: ddns-key) Ddns update key (base 64 encoding). type: list or str more...
      • ddns_keyname (Alias name: ddns-keyname) Ddns update key name. type: str more...
      • ddns_server_ip (Alias name: ddns-server-ip) Ddns server ip. type: str more...
      • ddns_ttl (Alias name: ddns-ttl) Ttl. type: int more...
      • ddns_update (Alias name: ddns-update) Enable/disable ddns update for dhcp. type: str choices: [disable, enable] more...
      • ddns_update_override (Alias name: ddns-update-override) Enable/disable ddns update override for dhcp. type: str choices: [disable, enable] more...
      • ddns_zone (Alias name: ddns-zone) Zone of your domain name (ex. type: str more...
      • default_gateway (Alias name: default-gateway) Default gateway ip address assigned by the dhcp server. type: str more...
      • dhcp_settings_from_fortiipam (Alias name: dhcp-settings-from-fortiipam) Enable/disable populating of dhcp server settings from fortiipam. type: str choices: [disable, enable] more...
      • dns_server1 (Alias name: dns-server1) Dns server 1. type: str more...
      • dns_server2 (Alias name: dns-server2) Dns server 2. type: str more...
      • dns_server3 (Alias name: dns-server3) Dns server 3. type: str more...
      • dns_server4 (Alias name: dns-server4) Dns server 4. type: str more...
      • dns_service (Alias name: dns-service) Options for assigning dns servers to dhcp clients. type: str choices: [default, specify, local] more...
      • domain Domain name suffix for the ip addresses that the dhcp server assigns to clients. type: str more...
      • enable Enable. type: str choices: [disable, enable] more...
      • exclude_range (Alias name: exclude-range) Exclude range. type: list more...
        • end_ip (Alias name: end-ip) End of ip range. type: str more...
        • id Id. type: int more...
        • start_ip (Alias name: start-ip) Start of ip range. type: str more...
        • vci_match (Alias name: vci-match) Enable/disable vendor class identifier (vci) matching. type: str choices: [disable, enable] more...
        • vci_string (Alias name: vci-string) One or more vci strings in quotes separated by spaces. type: list more...
        • lease_time (Alias name: lease-time) Lease time in seconds, 0 means default lease time. type: int more...
        • uci_match (Alias name: uci-match) Enable/disable user class identifier (uci) matching. type: str choices: [disable, enable] more...
        • uci_string (Alias name: uci-string) One or more uci strings in quotes separated by spaces. type: list more...
      • filename Name of the boot file on the tftp server. type: str more...
      • forticlient_on_net_status (Alias name: forticlient-on-net-status) Enable/disable forticlient-on-net service for this dhcp server. type: str choices: [disable, enable] more...
      • id Id. type: int more...
      • ip_mode (Alias name: ip-mode) Method used to assign client ip. type: str choices: [range, usrgrp] more...
      • ip_range (Alias name: ip-range) Ip range. type: list more...
        • end_ip (Alias name: end-ip) End of ip range. type: str more...
        • id Id. type: int more...
        • start_ip (Alias name: start-ip) Start of ip range. type: str more...
        • vci_match (Alias name: vci-match) Enable/disable vendor class identifier (vci) matching. type: str choices: [disable, enable] more...
        • vci_string (Alias name: vci-string) One or more vci strings in quotes separated by spaces. type: list more...
        • lease_time (Alias name: lease-time) Lease time in seconds, 0 means default lease time. type: int more...
        • uci_match (Alias name: uci-match) Enable/disable user class identifier (uci) matching. type: str choices: [disable, enable] more...
        • uci_string (Alias name: uci-string) One or more uci strings in quotes separated by spaces. type: list more...
      • ipsec_lease_hold (Alias name: ipsec-lease-hold) Dhcp over ipsec leases expire this many seconds after tunnel down (0 to disable forced-expiry). type: int more...
      • lease_time (Alias name: lease-time) Lease time in seconds, 0 means unlimited. type: int more...
      • mac_acl_default_action (Alias name: mac-acl-default-action) Mac access control default action (allow or block assigning ip settings). type: str choices: [assign, block] more...
      • netmask Netmask assigned by the dhcp server. type: str more...
      • next_server (Alias name: next-server) Ip address of a server (for example, a tftp sever) that dhcp clients can download a boot file from. type: str more...
      • ntp_server1 (Alias name: ntp-server1) Ntp server 1. type: str more...
      • ntp_server2 (Alias name: ntp-server2) Ntp server 2. type: str more...
      • ntp_server3 (Alias name: ntp-server3) Ntp server 3. type: str more...
      • ntp_service (Alias name: ntp-service) Options for assigning network time protocol (ntp) servers to dhcp clients. type: str choices: [default, specify, local] more...
      • option1 Option1. type: list more...
      • option2 Option2. type: list more...
      • option3 Option3. type: list more...
      • option4 Option4. type: str more...
      • option5 Option5. type: str more...
      • option6 Option6. type: str more...
      • options Options. type: list more...
        • code Dhcp option code. type: int more...
        • id Id. type: int more...
        • ip Dhcp option ips. type: list more...
        • type Dhcp option type. type: str choices: [hex, string, ip, fqdn] more...
        • value Dhcp option value. type: str more...
        • vci_match (Alias name: vci-match) Enable/disable vendor class identifier (vci) matching. type: str choices: [disable, enable] more...
        • vci_string (Alias name: vci-string) One or more vci strings in quotes separated by spaces. type: list more...
        • uci_match (Alias name: uci-match) Enable/disable user class identifier (uci) matching. type: str choices: [disable, enable] more...
        • uci_string (Alias name: uci-string) One or more uci strings in quotes separated by spaces. type: list more...
      • reserved_address (Alias name: reserved-address) Reserved address. type: list more...
        • action Options for the dhcp server to configure the client with the reserved mac address. type: str choices: [assign, block, reserved] more...
        • circuit_id (Alias name: circuit-id) Option 82 circuit-id of the client that will get the reserved ip address. type: str more...
        • circuit_id_type (Alias name: circuit-id-type) Dhcp option type. type: str choices: [hex, string] more...
        • description Description. type: str more...
        • id Id. type: int more...
        • ip Ip address to be reserved for the mac address. type: str more...
        • mac Mac address of the client that will get the reserved ip address. type: str more...
        • remote_id (Alias name: remote-id) Option 82 remote-id of the client that will get the reserved ip address. type: str more...
        • remote_id_type (Alias name: remote-id-type) Dhcp option type. type: str choices: [hex, string] more...
        • type Dhcp reserved-address type. type: str choices: [mac, option82] more...
      • server_type (Alias name: server-type) Dhcp server can be a normal dhcp server or an ipsec dhcp server. type: str choices: [regular, ipsec] more...
      • status Enable/disable this dhcp configuration. type: str choices: [disable, enable] more...
      • tftp_server (Alias name: tftp-server) One or more hostnames or ip addresses of the tftp servers in quotes separated by spaces. type: list more...
      • timezone Select the time zone to be assigned to dhcp clients. type: str 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] more...
      • timezone_option (Alias name: timezone-option) Options for the dhcp server to set the clients time zone. type: str choices: [disable, default, specify] more...
      • vci_match (Alias name: vci-match) Enable/disable vendor class identifier (vci) matching. type: str choices: [disable, enable] more...
      • vci_string (Alias name: vci-string) One or more vci strings in quotes separated by spaces. type: list more...
      • wifi_ac_service (Alias name: wifi-ac-service) Options for assigning wifi access controllers to dhcp clients type: str choices: [specify, local] more...
      • wifi_ac1 (Alias name: wifi-ac1) Wifi access controller 1 ip address (dhcp option 138, rfc 5417). type: str more...
      • wifi_ac2 (Alias name: wifi-ac2) Wifi access controller 2 ip address (dhcp option 138, rfc 5417). type: str more...
      • wifi_ac3 (Alias name: wifi-ac3) Wifi access controller 3 ip address (dhcp option 138, rfc 5417). type: str more...
      • wins_server1 (Alias name: wins-server1) Wins server 1. type: str more...
      • wins_server2 (Alias name: wins-server2) Wins server 2. type: str more...
      • relay_agent (Alias name: relay-agent) Relay agent ip. type: str more...
      • shared_subnet (Alias name: shared-subnet) Enable/disable shared subnet. type: str choices: [disable, enable] more...
    • interface Interface. type: dict more...
      • dhcp_relay_agent_option (Alias name: dhcp-relay-agent-option) Dhcp relay agent option. type: str choices: [disable, enable] more...
      • dhcp_relay_ip (Alias name: dhcp-relay-ip) Dhcp relay ip. type: list more...
      • dhcp_relay_service (Alias name: dhcp-relay-service) Dhcp relay service. type: str choices: [disable, enable] more...
      • dhcp_relay_type (Alias name: dhcp-relay-type) Dhcp relay type. type: str choices: [regular, ipsec] more...
      • ip Ip. type: str more...
      • ipv6 Ipv6. type: dict more...
        • autoconf Enable/disable address auto config. type: str choices: [disable, enable] more...
        • dhcp6_client_options (Alias name: dhcp6-client-options) Dhcp6 client options. type: list choices: [rapid, iapd, iana, dns, dnsname] more...
        • dhcp6_information_request (Alias name: dhcp6-information-request) Enable/disable dhcpv6 information request. type: str choices: [disable, enable] more...
        • dhcp6_prefix_delegation (Alias name: dhcp6-prefix-delegation) Enable/disable dhcpv6 prefix delegation. type: str choices: [disable, enable] more...
        • dhcp6_prefix_hint (Alias name: dhcp6-prefix-hint) Dhcpv6 prefix that will be used as a hint to the upstream dhcpv6 server. type: str more...
        • dhcp6_prefix_hint_plt (Alias name: dhcp6-prefix-hint-plt) Dhcpv6 prefix hint preferred life time (sec), 0 means unlimited lease time. type: int more...
        • dhcp6_prefix_hint_vlt (Alias name: dhcp6-prefix-hint-vlt) Dhcpv6 prefix hint valid life time (sec). type: int more...
        • dhcp6_relay_ip (Alias name: dhcp6-relay-ip) Dhcpv6 relay ip address. type: str more...
        • dhcp6_relay_service (Alias name: dhcp6-relay-service) Enable/disable dhcpv6 relay. type: str choices: [disable, enable] more...
        • dhcp6_relay_type (Alias name: dhcp6-relay-type) Dhcpv6 relay type. type: str choices: [regular] more...
        • icmp6_send_redirect (Alias name: icmp6-send-redirect) Enable/disable sending of icmpv6 redirects. type: str choices: [disable, enable] more...
        • interface_identifier (Alias name: interface-identifier) Ipv6 interface identifier. type: str more...
        • ip6_address (Alias name: ip6-address) Primary ipv6 address prefix, syntax: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx/xxx type: str more...
        • ip6_allowaccess (Alias name: ip6-allowaccess) Allow management access to the interface. type: list choices: [https, ping, ssh, snmp, http, telnet, fgfm, capwap, fabric] more...
        • ip6_default_life (Alias name: ip6-default-life) Default life (sec). type: int more...
        • ip6_delegated_prefix_list (Alias name: ip6-delegated-prefix-list) Ip6 delegated prefix list. type: list more...
          • autonomous_flag (Alias name: autonomous-flag) Enable/disable the autonomous flag. type: str choices: [disable, enable] more...
          • onlink_flag (Alias name: onlink-flag) Enable/disable the onlink flag. type: str choices: [disable, enable] more...
          • prefix_id (Alias name: prefix-id) Prefix id. type: int more...
          • rdnss Recursive dns server option. type: list more...
          • rdnss_service (Alias name: rdnss-service) Recursive dns service option. type: str choices: [delegated, default, specify] more...
          • subnet Add subnet id to routing prefix. type: str more...
          • upstream_interface (Alias name: upstream-interface) Name of the interface that provides delegated information. type: str more...
          • delegated_prefix_iaid (Alias name: delegated-prefix-iaid) Iaid of obtained delegated-prefix from the upstream interface. type: int more...
        • ip6_dns_server_override (Alias name: ip6-dns-server-override) Enable/disable using the dns server acquired by dhcp. type: str choices: [disable, enable] more...
        • ip6_extra_addr (Alias name: ip6-extra-addr) Ip6 extra addr. type: list more...
          • prefix Ipv6 address prefix. type: str more...
        • ip6_hop_limit (Alias name: ip6-hop-limit) Hop limit (0 means unspecified). type: int more...
        • ip6_link_mtu (Alias name: ip6-link-mtu) Ipv6 link mtu. type: int more...
        • ip6_manage_flag (Alias name: ip6-manage-flag) Enable/disable the managed flag. type: str choices: [disable, enable] more...
        • ip6_max_interval (Alias name: ip6-max-interval) Ipv6 maximum interval (4 to 1800 sec). type: int more...
        • ip6_min_interval (Alias name: ip6-min-interval) Ipv6 minimum interval (3 to 1350 sec). type: int more...
        • ip6_mode (Alias name: ip6-mode) Addressing mode (static, dhcp, delegated). type: str choices: [static, dhcp, pppoe, delegated] more...
        • ip6_other_flag (Alias name: ip6-other-flag) Enable/disable the other ipv6 flag. type: str choices: [disable, enable] more...
        • ip6_prefix_list (Alias name: ip6-prefix-list) Ip6 prefix list. type: list more...
          • autonomous_flag (Alias name: autonomous-flag) Enable/disable the autonomous flag. type: str choices: [disable, enable] more...
          • dnssl Dns search list option. type: list more...
          • onlink_flag (Alias name: onlink-flag) Enable/disable the onlink flag. type: str choices: [disable, enable] more...
          • preferred_life_time (Alias name: preferred-life-time) Preferred life time (sec). type: int more...
          • prefix Ipv6 prefix. type: str more...
          • rdnss Recursive dns server option. type: list more...
          • valid_life_time (Alias name: valid-life-time) Valid life time (sec). type: int more...
        • ip6_reachable_time (Alias name: ip6-reachable-time) Ipv6 reachable time (milliseconds; 0 means unspecified). type: int more...
        • ip6_retrans_time (Alias name: ip6-retrans-time) Ipv6 retransmit time (milliseconds; 0 means unspecified). type: int more...
        • ip6_send_adv (Alias name: ip6-send-adv) Enable/disable sending advertisements about the interface. type: str choices: [disable, enable] more...
        • ip6_subnet (Alias name: ip6-subnet) Subnet to routing prefix, syntax: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx/xxx type: str more...
        • ip6_upstream_interface (Alias name: ip6-upstream-interface) Interface name providing delegated information. type: str more...
        • nd_cert (Alias name: nd-cert) Neighbor discovery certificate. type: str more...
        • nd_cga_modifier (Alias name: nd-cga-modifier) Neighbor discovery cga modifier. type: str more...
        • nd_mode (Alias name: nd-mode) Neighbor discovery mode. type: str choices: [basic, SEND-compatible] more...
        • nd_security_level (Alias name: nd-security-level) Neighbor discovery security level (0 - 7; 0 = least secure, default = 0). type: int more...
        • nd_timestamp_delta (Alias name: nd-timestamp-delta) Neighbor discovery timestamp delta value (1 - 3600 sec; default = 300). type: int more...
        • nd_timestamp_fuzz (Alias name: nd-timestamp-fuzz) Neighbor discovery timestamp fuzz factor (1 - 60 sec; default = 1). type: int more...
        • unique_autoconf_addr (Alias name: unique-autoconf-addr) Enable/disable unique auto config address. type: str choices: [disable, enable] more...
        • vrip6_link_local Link-local ipv6 address of virtual router. type: str more...
        • vrrp_virtual_mac6 (Alias name: vrrp-virtual-mac6) Enable/disable virtual mac for vrrp. type: str choices: [disable, enable] more...
        • vrrp6 Vrrp6. type: list more...
          • accept_mode (Alias name: accept-mode) Enable/disable accept mode. type: str choices: [disable, enable] more...
          • adv_interval (Alias name: adv-interval) Advertisement interval (1 - 255 seconds). type: int more...
          • preempt Enable/disable preempt mode. type: str choices: [disable, enable] more...
          • priority Priority of the virtual router (1 - 255). type: int more...
          • start_time (Alias name: start-time) Startup time (1 - 255 seconds). type: int more...
          • status Enable/disable vrrp. type: str choices: [disable, enable] more...
          • vrdst6 Monitor the route to this destination. type: str more...
          • vrgrp Vrrp group id (1 - 65535). type: int more...
          • vrid Virtual router identifier (1 - 255). type: int more...
          • vrip6 Ipv6 address of the virtual router. type: str more...
          • ignore_default_route (Alias name: ignore-default-route) Enable/disable ignoring of default route when checking destination. type: str choices: [disable, enable] more...
          • vrdst_priority (Alias name: vrdst-priority) Priority of the virtual router when the virtual router destination becomes unreachable (0 - 254). type: int more...
        • cli_conn6_status (Alias name: cli-conn6-status) Cli conn6 status. type: int more...
        • ip6_prefix_mode (Alias name: ip6-prefix-mode) Assigning a prefix from dhcp or ra. type: str choices: [dhcp6, ra] more...
        • ra_send_mtu (Alias name: ra-send-mtu) Enable/disable sending link mtu in ra packet. type: str choices: [disable, enable] more...
        • ip6_delegated_prefix_iaid (Alias name: ip6-delegated-prefix-iaid) Iaid of obtained delegated-prefix from the upstream interface. type: int more...
        • dhcp6_relay_source_interface (Alias name: dhcp6-relay-source-interface) Enable/disable use of address on this interface as the source address of the relay message. type: str choices: [disable, enable] more...
        • dhcp6_relay_interface_id (Alias name: dhcp6-relay-interface-id) Dhcp6 relay interface id. type: str more...
        • dhcp6_relay_source_ip (Alias name: dhcp6-relay-source-ip) Ipv6 address used by the dhcp6 relay as its source ip. type: str more...
      • secondary_IP (Alias name: secondary-IP) Secondary ip. type: str choices: [disable, enable] more...
      • secondaryip Secondaryip. type: list more...
        • allowaccess Management access settings for the secondary ip address. type: list choices: [https, ping, ssh, snmp, http, telnet, fgfm, auto-ipsec, radius-acct, probe-response, capwap, dnp, ftm, fabric, speed-test, icond, scim] more...
        • detectprotocol Protocols used to detect the server. type: list choices: [ping, tcp-echo, udp-echo] more...
        • detectserver Gateways ping server for this ip. type: str more...
        • gwdetect Enable/disable detect gateway alive for first. type: str choices: [disable, enable] more...
        • ha_priority (Alias name: ha-priority) Ha election priority for the ping server. type: int more...
        • id Id. type: int more...
        • ip Secondary ip address of the interface. type: str more...
        • ping_serv_status (Alias name: ping-serv-status) Ping serv status. type: int more...
        • seq Seq. type: int more...
        • secip_relay_ip (Alias name: secip-relay-ip) Dhcp relay ip address. type: str more...
      • vlanid Vlanid. type: int more...
      • dhcp_relay_interface_select_method (Alias name: dhcp-relay-interface-select-method) Dhcp relay interface select method. type: str choices: [auto, sdwan, specify] more...
      • vrrp Vrrp. type: list more...
        • accept_mode (Alias name: accept-mode) Enable/disable accept mode. type: str choices: [disable, enable] more...
        • adv_interval (Alias name: adv-interval) Advertisement interval (1 - 255 seconds). type: int more...
        • ignore_default_route (Alias name: ignore-default-route) Enable/disable ignoring of default route when checking destination. type: str choices: [disable, enable] more...
        • preempt Enable/disable preempt mode. type: str choices: [disable, enable] more...
        • priority Priority of the virtual router (1 - 255). type: int more...
        • proxy_arp (Alias name: proxy-arp) Proxy arp. type: list more...
          • id Id. type: int more...
          • ip Set ip addresses of proxy arp. type: str more...
        • start_time (Alias name: start-time) Startup time (1 - 255 seconds). type: int more...
        • status Enable/disable this vrrp configuration. type: str choices: [disable, enable] more...
        • version Vrrp version. type: str choices: [2, 3] more...
        • vrdst Monitor the route to this destination. type: list more...
        • vrdst_priority (Alias name: vrdst-priority) Priority of the virtual router when the virtual router destination becomes unreachable (0 - 254). type: int more...
        • vrgrp Vrrp group id (1 - 65535). type: int more...
        • vrid Virtual router identifier (1 - 255). type: int more...
        • vrip Ip address of the virtual router. type: str more...

Notes

Note

  • 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: Fsp vlan dynamic mapping
      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]>
                  vrdst_priority: <integer>
              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"
                  - "icond"
                  - "scim"
                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: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:

  • meta - The result of the request.returned: always type: dict
    • request_url - The full url requested. returned: always type: str sample: /sys/login/user
    • response_code - The status of api request. returned: always type: int sample: 0
    • response_data - The data body of the api response. returned: optional type: list or dict
    • response_message - The descriptive message of the api response. returned: always type: str sample: OK
    • system_information - The information of the target system. returned: always type: dict
  • rc - The status the request. returned: always type: int sample: 0
  • version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)