fmgr_fsp_vlan_dynamicmapping¶
New in version 2.0.0.
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 v6.x and v7.x.
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
FortiManager Version Compatibility¶
6.2.0 |
6.2.1 |
6.2.2 |
6.2.3 |
6.2.4 |
6.2.5 |
6.2.6 |
6.2.7 |
6.2.8 |
6.2.9 |
6.2.10 |
6.2.11 |
6.2.12 |
|
| True | True | True | True | None | True | True | True | True | True | True | True | True | |
6.4.0 |
6.4.1 |
6.4.2 |
6.4.3 |
6.4.4 |
6.4.5 |
6.4.6 |
6.4.7 |
6.4.8 |
6.4.9 |
6.4.10 |
6.4.11 |
6.4.12 |
6.4.13 |
| True | True | True | True | True | True | True | True | True | True | True | True | True | True |
7.0.0 |
7.0.1 |
7.0.2 |
7.0.3 |
7.0.4 |
7.0.5 |
7.0.6 |
7.0.7 |
7.0.8 |
7.0.9 |
7.0.10 |
|||
| True | True | True | True | True | True | True | True | True | True | True | |||
7.2.0 |
7.2.1 |
7.2.2 |
7.2.3 |
7.2.4 |
|||||||||
| True | True | True | True | True | |||||||||
7.4.0 |
7.4.1 |
||||||||||||
| True | True |
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 - no description type: dict
- _dhcp-status - No description for the parameter type: str choices: [disable, enable] more...
- _scope - No description for the parameter type: list more...
- dhcp-server type: dict
- auto-configuration - Enable/disable auto configuration. type: str choices: [disable, enable] more...
- 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 - 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 - DDNS authentication mode. type: str choices: [disable, tsig] more...
- ddns-key - DDNS update key (base 64 encoding). type: list or str more...
- ddns-keyname - DDNS update key name. type: str more...
- ddns-server-ip - DDNS server IP. type: str more...
- ddns-ttl - TTL. type: int more...
- ddns-update - Enable/disable DDNS update for DHCP. type: str choices: [disable, enable] more...
- ddns-update-override - Enable/disable DDNS update override for DHCP. type: str choices: [disable, enable] more...
- ddns-zone - Zone of your domain name (ex. type: str more...
- default-gateway - Default gateway IP address assigned by the DHCP server. type: str more...
- dhcp-settings-from-fortiipam - Enable/disable populating of DHCP server settings from FortiIPAM. type: str choices: [disable, enable] more...
- dns-server1 - DNS server 1. type: str more...
- dns-server2 - DNS server 2. type: str more...
- dns-server3 - DNS server 3. type: str more...
- dns-server4 - DNS server 4. type: str more...
- 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 - No description for the parameter type: str choices: [disable, enable] more...
- exclude-range - No description for the parameter type: list
more...
- end-ip - End of IP range. type: str more...
- id - ID. type: int more...
- start-ip - Start of IP range. type: str more...
- vci-match - Enable/disable vendor class identifier (VCI) matching. type: str choices: [disable, enable] more...
- vci-string - No description for the parameter type: list more...
- lease-time - Lease time in seconds, 0 means default lease time. type: int more...
- uci-match - Enable/disable user class identifier (UCI) matching. type: str choices: [disable, enable] more...
- uci-string - No description for the parameter type: list more...
- filename - Name of the boot file on the TFTP server. type: str more...
- 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 - Method used to assign client IP. type: str choices: [range, usrgrp] more...
- ip-range - No description for the parameter type: list
more...
- end-ip - End of IP range. type: str more...
- id - ID. type: int more...
- start-ip - Start of IP range. type: str more...
- vci-match - Enable/disable vendor class identifier (VCI) matching. type: str choices: [disable, enable] more...
- vci-string - No description for the parameter type: list more...
- lease-time - Lease time in seconds, 0 means default lease time. type: int more...
- uci-match - Enable/disable user class identifier (UCI) matching. type: str choices: [disable, enable] more...
- uci-string - No description for the parameter type: list more...
- ipsec-lease-hold - DHCP over IPsec leases expire this many seconds after tunnel down (0 to disable forced-expiry). type: int more...
- lease-time - Lease time in seconds, 0 means unlimited. type: int more...
- 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 - IP address of a server (for example, a TFTP sever) that DHCP clients can download a boot file from. type: str more...
- ntp-server1 - NTP server 1. type: str more...
- ntp-server2 - NTP server 2. type: str more...
- ntp-server3 - NTP server 3. type: str more...
- ntp-service - Options for assigning Network Time Protocol (NTP) servers to DHCP clients. type: str choices: [default, specify, local] more...
- option1 - No description for the parameter type: list more...
- option2 - No description for the parameter type: list more...
- option3 - No description for the parameter type: list more...
- option4 - No description for the parameter type: str more...
- option5 - No description for the parameter type: str more...
- option6 - No description for the parameter type: str more...
- options - No description for the parameter type: list
more...
- code - DHCP option code. type: int more...
- id - ID. type: int more...
- ip - No description for the parameter type: list more...
- type - DHCP option type. type: str choices: [hex, string, ip, fqdn] more...
- value - DHCP option value. type: str more...
- vci-match - Enable/disable vendor class identifier (VCI) matching. type: str choices: [disable, enable] more...
- vci-string - No description for the parameter type: list more...
- uci-match - Enable/disable user class identifier (UCI) matching. type: str choices: [disable, enable] more...
- uci-string - No description for the parameter type: list more...
- reserved-address - No description for the parameter 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 - Option 82 circuit-ID of the client that will get the reserved IP address. type: str more...
- 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 - Option 82 remote-ID of the client that will get the reserved IP address. type: str more...
- 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 - 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 - No description for the parameter 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 - Options for the DHCP server to set the clients time zone. type: str choices: [disable, default, specify] more...
- vci-match - Enable/disable vendor class identifier (VCI) matching. type: str choices: [disable, enable] more...
- vci-string - No description for the parameter type: list more...
- wifi-ac-service - Options for assigning WiFi Access Controllers to DHCP clients type: str choices: [specify, local] more...
- wifi-ac1 - WiFi Access Controller 1 IP address (DHCP option 138, RFC 5417). type: str more...
- wifi-ac2 - WiFi Access Controller 2 IP address (DHCP option 138, RFC 5417). type: str more...
- wifi-ac3 - WiFi Access Controller 3 IP address (DHCP option 138, RFC 5417). type: str more...
- wins-server1 - WINS server 1. type: str more...
- wins-server2 - WINS server 2. type: str more...
- relay-agent - Relay agent IP. type: str more...
- shared-subnet - Enable/disable shared subnet. type: str choices: [disable, enable] more...
- interface type: dict
- dhcp-relay-agent-option - No description for the parameter type: str choices: [disable, enable] more...
- dhcp-relay-ip - No description for the parameter type: list more...
- dhcp-relay-service - No description for the parameter type: str choices: [disable, enable] more...
- dhcp-relay-type - No description for the parameter type: str choices: [regular, ipsec] more...
- ip - No description for the parameter type: str more...
- ipv6 type: dict
- autoconf - Enable/disable address auto config. type: str choices: [disable, enable] more...
- dhcp6-client-options - No description for the parameter type: list choices: [rapid, iapd, iana, dns, dnsname] more...
- dhcp6-information-request - Enable/disable DHCPv6 information request. type: str choices: [disable, enable] more...
- dhcp6-prefix-delegation - Enable/disable DHCPv6 prefix delegation. type: str choices: [disable, enable] more...
- dhcp6-prefix-hint - DHCPv6 prefix that will be used as a hint to the upstream DHCPv6 server. type: str more...
- dhcp6-prefix-hint-plt - DHCPv6 prefix hint preferred life time (sec), 0 means unlimited lease time. type: int more...
- dhcp6-prefix-hint-vlt - DHCPv6 prefix hint valid life time (sec). type: int more...
- dhcp6-relay-ip - DHCPv6 relay IP address. type: str more...
- dhcp6-relay-service - Enable/disable DHCPv6 relay. type: str choices: [disable, enable] more...
- dhcp6-relay-type - DHCPv6 relay type. type: str choices: [regular] more...
- icmp6-send-redirect - Enable/disable sending of ICMPv6 redirects. type: str choices: [disable, enable] more...
- interface-identifier - IPv6 interface identifier. type: str more...
- ip6-address - Primary IPv6 address prefix, syntax: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx/xxx type: str more...
- ip6-allowaccess - No description for the parameter type: list choices: [https, ping, ssh, snmp, http, telnet, fgfm, capwap, fabric] more...
- ip6-default-life - Default life (sec). type: int more...
- ip6-delegated-prefix-list - No description for the parameter type: list
more...
- autonomous-flag - Enable/disable the autonomous flag. type: str choices: [disable, enable] more...
- onlink-flag - Enable/disable the onlink flag. type: str choices: [disable, enable] more...
- prefix-id - Prefix ID. type: int more...
- rdnss - No description for the parameter type: list more...
- 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 - Name of the interface that provides delegated information. type: str more...
- delegated-prefix-iaid - IAID of obtained delegated-prefix from the upstream interface. type: int more...
- ip6-dns-server-override - Enable/disable using the DNS server acquired by DHCP. type: str choices: [disable, enable] more...
- ip6-extra-addr - No description for the parameter type: list
more...
- prefix - IPv6 address prefix. type: str more...
- ip6-hop-limit - Hop limit (0 means unspecified). type: int more...
- ip6-link-mtu - IPv6 link MTU. type: int more...
- ip6-manage-flag - Enable/disable the managed flag. type: str choices: [disable, enable] more...
- ip6-max-interval - IPv6 maximum interval (4 to 1800 sec). type: int more...
- ip6-min-interval - IPv6 minimum interval (3 to 1350 sec). type: int more...
- ip6-mode - Addressing mode (static, DHCP, delegated). type: str choices: [static, dhcp, pppoe, delegated] more...
- ip6-other-flag - Enable/disable the other IPv6 flag. type: str choices: [disable, enable] more...
- ip6-prefix-list - No description for the parameter type: list
more...
- autonomous-flag - Enable/disable the autonomous flag. type: str choices: [disable, enable] more...
- dnssl - No description for the parameter type: list more...
- onlink-flag - Enable/disable the onlink flag. type: str choices: [disable, enable] more...
- preferred-life-time - Preferred life time (sec). type: int more...
- prefix - IPv6 prefix. type: str more...
- rdnss - No description for the parameter type: list more...
- valid-life-time - Valid life time (sec). type: int more...
- ip6-reachable-time - IPv6 reachable time (milliseconds; 0 means unspecified). type: int more...
- ip6-retrans-time - IPv6 retransmit time (milliseconds; 0 means unspecified). type: int more...
- ip6-send-adv - Enable/disable sending advertisements about the interface. type: str choices: [disable, enable] more...
- ip6-subnet - Subnet to routing prefix, syntax: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx/xxx type: str more...
- ip6-upstream-interface - Interface name providing delegated information. type: str more...
- nd-cert - Neighbor discovery certificate. type: str more...
- nd-cga-modifier - Neighbor discovery CGA modifier. type: str more...
- nd-mode - Neighbor discovery mode. type: str choices: [basic, SEND-compatible] more...
- nd-security-level - Neighbor discovery security level (0 - 7; 0 = least secure, default = 0). type: int more...
- nd-timestamp-delta - Neighbor discovery timestamp delta value (1 - 3600 sec; default = 300). type: int more...
- nd-timestamp-fuzz - Neighbor discovery timestamp fuzz factor (1 - 60 sec; default = 1). type: int more...
- 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 - Enable/disable virtual MAC for VRRP. type: str choices: [disable, enable] more...
- vrrp6 - No description for the parameter type: list
more...
- accept-mode - Enable/disable accept mode. type: str choices: [disable, enable] more...
- 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 - 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...
- cli-conn6-status - No description for the parameter type: int more...
- ip6-prefix-mode - Assigning a prefix from DHCP or RA. type: str choices: [dhcp6, ra] more...
- ra-send-mtu - Enable/disable sending link MTU in RA packet. type: str choices: [disable, enable] more...
- ip6-delegated-prefix-iaid - IAID of obtained delegated-prefix from the upstream interface. type: int more...
- 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 - DHCP6 relay interface ID. type: str more...
- dhcp6-relay-source-ip - IPv6 address used by the DHCP6 relay as its source IP. type: str more...
- secondary-IP - No description for the parameter type: str choices: [disable, enable] more...
- secondaryip - No description for the parameter type: list
more...
- allowaccess - No description for the parameter type: list choices: [https, ping, ssh, snmp, http, telnet, fgfm, auto-ipsec, radius-acct, probe-response, capwap, dnp, ftm, fabric, speed-test] more...
- detectprotocol - No description for the parameter 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 - 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 - No description for the parameter type: int more...
- seq - No description for the parameter type: int more...
- secip-relay-ip - DHCP relay IP address. type: str more...
- vlanid - No description for the parameter type: int more...
- dhcp-relay-interface-select-method - No description for the parameter type: str choices: [auto, sdwan, specify] more...
- vrrp - No description for the parameter type: list
more...
- accept-mode - Enable/disable accept mode. type: str choices: [disable, enable] more...
- adv-interval - Advertisement interval (1 - 255 seconds). type: int more...
- 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 - No description for the parameter type: list more...
- 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 - No description for the parameter type: list more...
- 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¶
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: no description
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: <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>
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: 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 0
- version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least on parameter mpt supported by the current FortiManager version type: list 0